From 247e4f4cabb14efe1a71c2ae5b0a644c758862e7 Mon Sep 17 00:00:00 2001 From: Philip Olson Date: Wed, 13 Jul 2011 04:42:29 +0000 Subject: [PATCH] Reverted r313182 (fixing build) git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@313190 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/spl/callbackfilteriterator.xml | 45 +++--- .../spl/callbackfilteriterator/accept.xml | 20 +-- .../spl/callbackfilteriterator/construct.xml | 35 ++--- .../spl/callbackfilteriterator/examples.xml | 130 ------------------ .../spl/recursivecallbackfilteriterator.xml | 53 ++++--- .../construct.xml | 33 ++--- .../getchildren.xml | 21 +-- .../haschildren.xml | 48 +------ reference/spl/versions.xml | 10 -- 9 files changed, 79 insertions(+), 316 deletions(-) delete mode 100644 reference/spl/callbackfilteriterator/examples.xml diff --git a/reference/spl/callbackfilteriterator.xml b/reference/spl/callbackfilteriterator.xml index e05e738e27..c2e714f51a 100644 --- a/reference/spl/callbackfilteriterator.xml +++ b/reference/spl/callbackfilteriterator.xml @@ -12,9 +12,7 @@
&reftitle.intro; - The CallbackFilterIterator is a concrete - FilterIterator which uses a callback - for filtering. +
@@ -31,32 +29,31 @@ CallbackFilterIterator - - - extends - FilterIterator + + + extends + FilterIterator - - - Iterator - - - - Traversable - - - - OuterIterator + + + Iterator + + + + Traversable + + + + OuterIterator - - &Methods; - + + &Methods; - - &InheritedMethods; - + + &InheritedMethods; + diff --git a/reference/spl/callbackfilteriterator/accept.xml b/reference/spl/callbackfilteriterator/accept.xml index befadc4aa9..9e5cfb863f 100644 --- a/reference/spl/callbackfilteriterator/accept.xml +++ b/reference/spl/callbackfilteriterator/accept.xml @@ -14,14 +14,11 @@ - This method calls the callback with the current value, current key - and the inner iterator. - - - The callback is expected to return &true; if the current item is - to be accepted, or &false; otherwise. + + &warn.undocumented.func; + @@ -32,19 +29,10 @@ &reftitle.returnvalues; - Returns &true; to accept the current item, or &false; otherwise. + - - &reftitle.seealso; - - - CallbackFilterIterator Examples - CallbackFilterIterator::__construct - - - diff --git a/reference/spl/callbackfilteriterator/construct.xml b/reference/spl/callbackfilteriterator/construct.xml index 217bdf5bec..cc37f96055 100644 --- a/reference/spl/callbackfilteriterator/construct.xml +++ b/reference/spl/callbackfilteriterator/construct.xml @@ -4,21 +4,22 @@ CallbackFilterIterator::__construct - Create a filtered iterator from another iterator + Create an Iterator from another iterator &reftitle.description; - - public + CallbackFilterIterator::__construct Iteratoriterator - callbackcallback - + stringcallback + - Creates a filtered iterator using the callback to - determine which items are accepted or rejected. + + + &warn.undocumented.func; + @@ -28,7 +29,7 @@ iterator - The iterator to be filtered. + @@ -36,12 +37,7 @@ callback - The callback, which should return &true; to accept the current item - or &false; otherwise. - See Examples. - - - May be any valid callback value. + @@ -51,19 +47,10 @@ &reftitle.returnvalues; - &return.void; + - - &reftitle.seealso; - - - CallbackFilterIterator Examples - CallbackFilterIterator::accept - - - diff --git a/reference/spl/callbackfilteriterator/examples.xml b/reference/spl/callbackfilteriterator/examples.xml deleted file mode 100644 index a4abd79209..0000000000 --- a/reference/spl/callbackfilteriterator/examples.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - CallbackFilterIterator & RecursiveCallbackFilterIterator Examples - - The main purpose of the CallbackFilterIterator and - RecursiveCallbackFilterIterator classes is to - filter the contents of an iterator using a callback rather than having - to go to the trouble of creating a bespoke class extending - the abstract FilterIterator. - - - - The callback should accept up to three arguments: - the current item, the current key and the iterator, respectively. - - - - Available callback arguments - - -]]> - - - - - Any callback may be used; such as a string containing a - function name, an array for a method, or an anonymous - function. - - - - Callback basic examples - - 100MB) -function is_large_file($current) { - return $current->isFile() && $current->getSize() > 104857600; -} -$large_files = new CallbackFilterIterator($dir, 'is_large_file'); - -// Filter directories -$files = new CallbackFilterIterator($dir, function ($current, $key, $iterator) { - return $current->isDir() && ! $iterator->isDot(); -}); - -?> -]]> - - - - - Filtering a recursive iterator generally involves two conditions. - The first is that, to allow recursion, the callback function should return &true; - if the current iterator item has children. - The second is the normal filter condition, such as a file size or extension check as - in the example below. - - - - Recursive callback basic examples - - 100MB) -$files = new CallbackFilterIterator($dir, function ($current, $key, $iterator) { - // Allow recursion - if ($iterator->hasChildren()) { - return TRUE; - } - // Check for large file - if ($current->isFile() && $current->getSize() > 104857600) { - return TRUE; - } - return FALSE; -}); - -foreach (new RecursiveIteratorIterator($files) as $file) { - echo $file->getPathname() . PHP_EOL; -} - -?> -]]> - - - - - - diff --git a/reference/spl/recursivecallbackfilteriterator.xml b/reference/spl/recursivecallbackfilteriterator.xml index 6ab67cecb4..dc66d1251f 100644 --- a/reference/spl/recursivecallbackfilteriterator.xml +++ b/reference/spl/recursivecallbackfilteriterator.xml @@ -12,9 +12,7 @@
&reftitle.intro; - The RecursiveCallbackFilterIterator is a concrete - RecursiveFilterIterator which uses a callback - for filtering. +
@@ -31,36 +29,35 @@ RecursiveCallbackFilterIterator - - - extends - CallbackFilterIterator + + + extends + CallbackFilterIterator - - - OuterIterator - - - - Traversable - - - - Iterator - - - - RecursiveIterator + + + OuterIterator + + + + Traversable + + + + Iterator + + + + RecursiveIterator - - &Methods; - + + &Methods; - - &InheritedMethods; - + + &InheritedMethods; + diff --git a/reference/spl/recursivecallbackfilteriterator/construct.xml b/reference/spl/recursivecallbackfilteriterator/construct.xml index 61feae5460..d9540eb5be 100644 --- a/reference/spl/recursivecallbackfilteriterator/construct.xml +++ b/reference/spl/recursivecallbackfilteriterator/construct.xml @@ -9,17 +9,17 @@ &reftitle.description; - - public + RecursiveCallbackFilterIterator::__construct RecursiveIteratoriterator stringcallback - + - Creates a filtered iterator from a RecursiveIterator - using the callback to determine which - items are accepted or rejected. + + + &warn.undocumented.func; + @@ -29,7 +29,7 @@ iterator - The recursive iterator to be filtered. + @@ -37,12 +37,7 @@ callback - The callback, which should return &true; to accept the current item - or &false; otherwise. - See Examples. - - - May be any valid callback value. + @@ -52,20 +47,10 @@ &reftitle.returnvalues; - &return.void; + - - &reftitle.seealso; - - - RecursiveCallbackFilterIterator Examples - RecursiveCallbackFilterIterator::getChildren - RecursiveCallbackFilteriterator::hasChildren - - - diff --git a/reference/spl/recursivecallbackfilteriterator/getchildren.xml b/reference/spl/recursivecallbackfilteriterator/getchildren.xml index 645e4f7427..de40a38739 100644 --- a/reference/spl/recursivecallbackfilteriterator/getchildren.xml +++ b/reference/spl/recursivecallbackfilteriterator/getchildren.xml @@ -14,12 +14,11 @@ - Fetches the filtered children of the inner iterator. - - - RecursiveCallbackFilterIterator::hasChildren should be used - to determine if there are children to be fetched. + + + &warn.undocumented.func; + @@ -30,19 +29,7 @@ &reftitle.returnvalues; - Returns a RecursiveCallbackFilterIterator containing - the children. - - - - &reftitle.seealso; - - - RecursiveCallbackFilterIterator Examples - RecursiveCallbackFilterIterator::__construct - RecursiveCallbackFilteriterator::hasChildren - diff --git a/reference/spl/recursivecallbackfilteriterator/haschildren.xml b/reference/spl/recursivecallbackfilteriterator/haschildren.xml index a9b70cef99..906fa3c8ea 100644 --- a/reference/spl/recursivecallbackfilteriterator/haschildren.xml +++ b/reference/spl/recursivecallbackfilteriterator/haschildren.xml @@ -14,8 +14,11 @@ - Returns &true; if the current element has children, &false; otherwise. + + + &warn.undocumented.func; + @@ -26,51 +29,10 @@ &reftitle.returnvalues; - Returns &true; if the current element has children, &false; otherwise. + - - &reftitle.examples; - - - <methodname>RecursiveCallbackFilterIterator::hasChildren</methodname> basic usage - -hasChildren()) { - return TRUE; - } - // Check for XML file - if (!strcasecmp($current->getExtension(), 'xml')) { - return TRUE; - } - return false; -}); - -?> -]]> - - - - - - - &reftitle.seealso; - - - RecursiveCallbackFilterIterator Examples - RecursiveCallbackFilterIterator::__construct - RecursiveCallbackFilteriterator::getChildren - - - diff --git a/reference/spl/versions.xml b/reference/spl/versions.xml index 8c94c179be..71224d1bec 100644 --- a/reference/spl/versions.xml +++ b/reference/spl/versions.xml @@ -1020,16 +1020,6 @@ - - - - - - - - - -