make sysdoc.php not write WarningThis

Also, while I was in there I made the script not spew anything on the terminal.

@markw65 `array_filter` doesn't match the signature from php.net. Should it?
Esse commit está contido em:
Paul Tarjan
2013-06-21 17:07:55 -07:00
commit de Sara Golemon
commit 23c8e35811
11 arquivos alterados com 115 adições e 97 exclusões
+2 -1
Ver Arquivo
@@ -1047,7 +1047,7 @@ function idx($arr, $idx, $default=null) {
}
function format_doc_desc($arr, $clsname) {
if ($arr['flags'] & HipHopSpecific) {
if (isset($arr['flags']) && $arr['flags'] & HipHopSpecific) {
$desc = "( HipHop specific )\n";
} else {
$clsname = preg_replace('#_#', '-', strtolower($clsname));
@@ -1143,6 +1143,7 @@ function phpnet_clean($text) {
$text = preg_replace('/'/', "'", $text);
$text = trim(html_entity_decode($text));
$text = preg_replace('/[^\t\n -~]/', '', $text);
$text = preg_replace('/WarningThis/', 'Warning: This', $text);
return $text;
}
+8 -1
Ver Arquivo
@@ -44,11 +44,18 @@ for ($i = 0; $i < count($lines) - 1; $i++) {
if (!empty($doc)) {
$info['name'] = $func;
$info['desc'] = isset($doc['desc']) ? $doc['desc'] : '';
$info['ret_desc'] = $doc['ret'];
if (isset($doc['ret'])) {
$info['ret_desc'] = $doc['ret'];
}
$args = array();
if (!empty($argdefs)) {
$index = 0;
foreach ($argdefs as $name) {
if (!isset($doc['params'][$index])) {
print "ERROR: The docs don't have param number $index ".
"(which you named $name) for $class::$func\n";
continue;
}
$args[] = array('name' => preg_replace('/[\&\$]/', '', $name),
'desc' => $doc['params'][$index++],
'ref' => preg_match('/&/', $name));
+61 -60
Ver Arquivo
@@ -16,7 +16,7 @@ interface Reflector {
/**
* ( excerpt from http://php.net/manual/en/reflector.tostring.php )
*
* To string. WarningThis function is currently not documented; only its
* To string. Warning: This function is currently not documented; only its
* argument list is available.
*
*/
@@ -58,7 +58,7 @@ class ReflectionParameter implements Reflector {
* ( excerpt from
* http://php.net/manual/en/reflectionparameter.construct.php )
*
* Constructs a ReflectionParameter class. WarningThis function is
* Constructs a ReflectionParameter class. Warning: This function is
* currently not documented; only its argument list is available.
*
* @func mixed The function to reflect parameters from.
@@ -79,7 +79,7 @@ class ReflectionParameter implements Reflector {
* ( excerpt from http://php.net/manual/en/reflectionparameter.tostring.php
* )
*
* To string. WarningThis function is currently not documented; only its
* To string. Warning: This function is currently not documented; only its
* argument list is available.
*
*/
@@ -92,7 +92,7 @@ class ReflectionParameter implements Reflector {
/**
* ( excerpt from http://php.net/manual/en/reflectionparameter.export.php )
*
* Exports. WarningThis function is currently not documented; only its
* Exports. Warning: This function is currently not documented; only its
* argument list is available.
*
* @func mixed The function name.
@@ -130,8 +130,9 @@ class ReflectionParameter implements Reflector {
* ( excerpt from
* http://php.net/manual/en/reflectionparameter.ispassedbyreference.php )
*
* Checks if the parameter is passed in by reference. WarningThis function
* is currently not documented; only its argument list is available.
* Checks if the parameter is passed in by reference. Warning: This
* function is currently not documented; only its argument list is
* available.
*
* @return mixed TRUE if the parameter is passed in by reference,
* otherwise FALSE
@@ -145,7 +146,7 @@ class ReflectionParameter implements Reflector {
* ( excerpt from
* http://php.net/manual/en/reflectionparameter.getdeclaringclass.php )
*
* Gets the declaring class. WarningThis function is currently not
* Gets the declaring class. Warning: This function is currently not
* documented; only its argument list is available.
*
* @return mixed A ReflectionClass object.
@@ -162,7 +163,7 @@ class ReflectionParameter implements Reflector {
* ( excerpt from
* http://php.net/manual/en/reflectionparameter.getdeclaringfunction.php )
*
* Gets the declaring function. WarningThis function is currently not
* Gets the declaring function. Warning: This function is currently not
* documented; only its argument list is available.
*
* @return mixed A ReflectionFunction object.
@@ -179,7 +180,7 @@ class ReflectionParameter implements Reflector {
* ( excerpt from http://php.net/manual/en/reflectionparameter.getclass.php
* )
*
* Gets a class. WarningThis function is currently not documented; only
* Gets a class. Warning: This function is currently not documented; only
* its argument list is available.
*
* @return mixed A ReflectionClass object.
@@ -242,7 +243,7 @@ class ReflectionParameter implements Reflector {
* ( excerpt from
* http://php.net/manual/en/reflectionparameter.allowsnull.php )
*
* Checks whether the parameter allows NULL. WarningThis function is
* Checks whether the parameter allows NULL. Warning: This function is
* currently not documented; only its argument list is available.
*
* @return mixed TRUE if NULL is allowed, otherwise FALSE
@@ -392,7 +393,7 @@ class ReflectionFunctionAbstract {
* ( excerpt from
* http://php.net/manual/en/reflectionfunctionabstract.getname.php )
*
* Get the name of the function. WarningThis function is currently not
* Get the name of the function. Warning: This function is currently not
* documented; only its argument list is available.
*
* @return mixed The name of the function.
@@ -407,8 +408,8 @@ class ReflectionFunctionAbstract {
* http://php.net/manual/en/reflectionfunctionabstract.isinternal.php )
*
* Checks whether the function is internal, as opposed to user-defined.
* WarningThis function is currently not documented; only its argument list
* is available.
* Warning: This function is currently not documented; only its argument
* list is available.
*
* @return mixed TRUE if it's internal, otherwise FALSE
*/
@@ -425,7 +426,7 @@ class ReflectionFunctionAbstract {
* ( excerpt from
* http://php.net/manual/en/reflectionfunctionabstract.isclosure.php )
*
* Checks whether it's a closure. WarningThis function is currently not
* Checks whether it's a closure. Warning: This function is currently not
* documented; only its argument list is available.
*
* @return mixed TRUE if it's a closure, otherwise FALSE
@@ -439,7 +440,7 @@ class ReflectionFunctionAbstract {
* ( excerpt from
* http://php.net/manual/en/reflectionfunctionabstract.isgenerator.php )
*
* WarningThis function is currently not documented; only its argument
* Warning: This function is currently not documented; only its argument
* list is available.
*
* @return mixed Returns TRUE if the function is generator, FALSE if
@@ -455,8 +456,8 @@ class ReflectionFunctionAbstract {
* http://php.net/manual/en/reflectionfunctionabstract.isuserdefined.php )
*
* Checks whether the function is user-defined, as opposed to internal.
* WarningThis function is currently not documented; only its argument list
* is available.
* Warning: This function is currently not documented; only its argument
* list is available.
*
* @return mixed TRUE if it's user-defined, otherwise false;
*/
@@ -469,7 +470,7 @@ class ReflectionFunctionAbstract {
* ( excerpt from
* http://php.net/manual/en/reflectionfunctionabstract.getfilename.php )
*
* Gets the file name from a user-defined function. WarningThis function
* Gets the file name from a user-defined function. Warning: This function
* is currently not documented; only its argument list is available.
*
* @return mixed The file name.
@@ -483,8 +484,8 @@ class ReflectionFunctionAbstract {
* ( excerpt from
* http://php.net/manual/en/reflectionfunctionabstract.getstartline.php )
*
* Gets the starting line number of the function. WarningThis function is
* currently not documented; only its argument list is available.
* Gets the starting line number of the function. Warning: This function
* is currently not documented; only its argument list is available.
*
* @return mixed The starting line number.
*/
@@ -497,7 +498,7 @@ class ReflectionFunctionAbstract {
* ( excerpt from
* http://php.net/manual/en/reflectionfunctionabstract.getendline.php )
*
* Get the ending line number. WarningThis function is currently not
* Get the ending line number. Warning: This function is currently not
* documented; only its argument list is available.
*
* @return mixed The ending line number of the user defined function,
@@ -512,7 +513,7 @@ class ReflectionFunctionAbstract {
* ( excerpt from
* http://php.net/manual/en/reflectionfunctionabstract.getdoccomment.php )
*
* Get a Doc comment from a function. WarningThis function is currently
* Get a Doc comment from a function. Warning: This function is currently
* not documented; only its argument list is available.
*
* @return mixed The doc comment if it exists, otherwise FALSE
@@ -527,7 +528,7 @@ class ReflectionFunctionAbstract {
* http://php.net/manual/en/reflectionfunctionabstract.getstaticvariables.php
* )
*
* Get the static variables. WarningThis function is currently not
* Get the static variables. Warning: This function is currently not
* documented; only its argument list is available.
*
* @return mixed An array of static variables.
@@ -542,7 +543,7 @@ class ReflectionFunctionAbstract {
* http://php.net/manual/en/reflectionfunctionabstract.returnsreference.php
* )
*
* Checks whether the function returns a reference. WarningThis function
* Checks whether the function returns a reference. Warning: This function
* is currently not documented; only its argument list is available.
*
* @return mixed TRUE if it returns a reference, otherwise FALSE
@@ -556,7 +557,7 @@ class ReflectionFunctionAbstract {
* ( excerpt from
* http://php.net/manual/en/reflectionfunctionabstract.getparameters.php )
*
* Get the parameters as an array of ReflectionParameter. WarningThis
* Get the parameters as an array of ReflectionParameter. Warning: This
* function is currently not documented; only its argument list is
* available.
*
@@ -580,7 +581,7 @@ class ReflectionFunctionAbstract {
* )
*
* Get the number of parameters that a function defines, both optional and
* required. WarningThis function is currently not documented; only its
* required. Warning: This function is currently not documented; only its
* argument list is available.
*
* @return mixed The number of parameters.
@@ -595,9 +596,9 @@ class ReflectionFunctionAbstract {
* http://php.net/manual/en/reflectionfunctionabstract.getnumberofrequiredparameters.php
* )
*
* Get the number of required parameters that a function defines.
* WarningThis function is currently not documented; only its argument list
* is available.
* Get the number of required parameters that a function defines. Warning:
* This function is currently not documented; only its argument list is
* available.
*
* @return mixed The number of required parameters.
*/
@@ -777,7 +778,7 @@ class ReflectionClass implements Reflector {
/**
* ( excerpt from http://php.net/manual/en/reflectionclass.construct.php )
*
* Constructs a new ReflectionClass object. WarningThis function is
* Constructs a new ReflectionClass object. Warning: This function is
* currently not documented; only its argument list is available.
*
* @name mixed Either a string containing the name of the class to
@@ -892,8 +893,8 @@ class ReflectionClass implements Reflector {
/**
* ( excerpt from http://php.net/manual/en/reflectionclass.getname.php )
*
* Gets the class name. WarningThis function is currently not documented;
* only its argument list is available.
* Gets the class name. Warning: This function is currently not
* documented; only its argument list is available.
*
* @return mixed The class name.
*/
@@ -1004,7 +1005,7 @@ class ReflectionClass implements Reflector {
* ( excerpt from http://php.net/manual/en/reflectionclass.getstartline.php
* )
*
* Get the starting line number. WarningThis function is currently not
* Get the starting line number. Warning: This function is currently not
* documented; only its argument list is available.
*
* @return mixed The starting line number, as an integer.
@@ -1031,7 +1032,7 @@ class ReflectionClass implements Reflector {
* ( excerpt from
* http://php.net/manual/en/reflectionclass.getdoccomment.php )
*
* Gets doc comments from a class. WarningThis function is currently not
* Gets doc comments from a class. Warning: This function is currently not
* documented; only its argument list is available.
*
* @return mixed The doc comment if it exists, otherwise FALSE
@@ -1184,8 +1185,8 @@ class ReflectionClass implements Reflector {
* ( excerpt from http://php.net/manual/en/reflectionclass.getconstants.php
* )
*
* Gets defined constants from a class. WarningThis function is currently
* not documented; only its argument list is available.
* Gets defined constants from a class. Warning: This function is
* currently not documented; only its argument list is available.
*
* @return mixed An array of constants. Constant name in key,
* constant value in value.
@@ -1199,7 +1200,7 @@ class ReflectionClass implements Reflector {
* ( excerpt from http://php.net/manual/en/reflectionclass.getconstant.php
* )
*
* Gets the defined constant. WarningThis function is currently not
* Gets the defined constant. Warning: This function is currently not
* documented; only its argument list is available.
*
* @name mixed Name of the constant.
@@ -1241,7 +1242,7 @@ class ReflectionClass implements Reflector {
/**
* ( excerpt from http://php.net/manual/en/reflectionclass.gettraits.php )
*
* WarningThis function is currently not documented; only its argument
* Warning: This function is currently not documented; only its argument
* list is available.
*
* @return mixed Returns an array with trait names in keys and
@@ -1285,7 +1286,7 @@ class ReflectionClass implements Reflector {
* ( excerpt from
* http://php.net/manual/en/reflectionclass.gettraitnames.php )
*
* WarningThis function is currently not documented; only its argument
* Warning: This function is currently not documented; only its argument
* list is available.
*
* @return mixed Returns an array with trait names in values. Returns
@@ -1307,7 +1308,7 @@ class ReflectionClass implements Reflector {
* ( excerpt from
* http://php.net/manual/en/reflectionclass.gettraitaliases.php )
*
* WarningThis function is currently not documented; only its argument
* Warning: This function is currently not documented; only its argument
* list is available.
*
* @return mixed Returns an array with new method names in keys and
@@ -1363,7 +1364,7 @@ class ReflectionClass implements Reflector {
/**
* ( excerpt from http://php.net/manual/en/reflectionclass.istrait.php )
*
* WarningThis function is currently not documented; only its argument
* Warning: This function is currently not documented; only its argument
* list is available.
*
* @return mixed Returns TRUE if this is a trait, FALSE otherwise.
@@ -1449,7 +1450,7 @@ class ReflectionClass implements Reflector {
* ( excerpt from
* http://php.net/manual/en/reflectionclass.getparentclass.php )
*
* WarningThis function is currently not documented; only its argument
* Warning: This function is currently not documented; only its argument
* list is available.
*
* @return mixed A ReflectionClass.
@@ -1498,7 +1499,7 @@ class ReflectionClass implements Reflector {
* ( excerpt from
* http://php.net/manual/en/reflectionclass.getstaticproperties.php )
*
* Get the static properties. WarningThis function is currently not
* Get the static properties. Warning: This function is currently not
* documented; only its argument list is available.
*
* @return mixed The static properties, as an array.
@@ -1539,7 +1540,7 @@ class ReflectionClass implements Reflector {
* ( excerpt from
* http://php.net/manual/en/reflectionclass.setstaticpropertyvalue.php )
*
* Sets static property value. WarningThis function is currently not
* Sets static property value. Warning: This function is currently not
* documented; only its argument list is available.
*
* @name mixed Property name.
@@ -1685,7 +1686,7 @@ class ReflectionClass implements Reflector {
* ( excerpt from
* http://php.net/manual/en/reflectionclass.getnamespacename.php )
*
* Gets the namespace name. WarningThis function is currently not
* Gets the namespace name. Warning: This function is currently not
* documented; only its argument list is available.
*
* @return mixed The namespace name.
@@ -1732,8 +1733,8 @@ class ReflectionObject extends ReflectionClass {
/**
* ( excerpt from http://php.net/manual/en/reflectionobject.export.php )
*
* Exports a reflection. WarningThis function is currently not documented;
* only its argument list is available.
* Exports a reflection. Warning: This function is currently not
* documented; only its argument list is available.
*
* @obj mixed The reflection to export.
* @ret mixed Setting to TRUE will return the export, as opposed
@@ -1780,7 +1781,7 @@ class ReflectionProperty implements Reflector {
* ( excerpt from http://php.net/manual/en/reflectionproperty.construct.php
* )
*
* WarningThis function is currently not documented; only its argument
* Warning: This function is currently not documented; only its argument
* list is available.
*
* @cls mixed The class name, that contains the property.
@@ -1809,7 +1810,7 @@ class ReflectionProperty implements Reflector {
* ( excerpt from http://php.net/manual/en/reflectionproperty.tostring.php
* )
*
* To string. WarningThis function is currently not documented; only its
* To string. Warning: This function is currently not documented; only its
* argument list is available.
*
*/
@@ -1821,8 +1822,8 @@ class ReflectionProperty implements Reflector {
/**
* ( excerpt from http://php.net/manual/en/reflectionproperty.export.php )
*
* Exports a reflection. WarningThis function is currently not documented;
* only its argument list is available.
* Exports a reflection. Warning: This function is currently not
* documented; only its argument list is available.
*
* @cls mixed The reflection to export.
* @name mixed The property name.
@@ -1848,7 +1849,7 @@ class ReflectionProperty implements Reflector {
/**
* ( excerpt from http://php.net/manual/en/reflectionproperty.getname.php )
*
* Gets the properties name. WarningThis function is currently not
* Gets the properties name. Warning: This function is currently not
* documented; only its argument list is available.
*
* @return mixed The name of the reflected property.
@@ -1944,7 +1945,7 @@ class ReflectionProperty implements Reflector {
* ( excerpt from
* http://php.net/manual/en/reflectionproperty.getmodifiers.php )
*
* Gets the modifiers. WarningThis function is currently not documented;
* Gets the modifiers. Warning: This function is currently not documented;
* only its argument list is available.
*
* @return mixed A numeric representation of the modifiers.
@@ -2010,7 +2011,7 @@ class ReflectionProperty implements Reflector {
* ( excerpt from
* http://php.net/manual/en/reflectionproperty.getdeclaringclass.php )
*
* Gets the declaring class. WarningThis function is currently not
* Gets the declaring class. Warning: This function is currently not
* documented; only its argument list is available.
*
* @return mixed A ReflectionClass object.
@@ -2027,8 +2028,8 @@ class ReflectionProperty implements Reflector {
* ( excerpt from
* http://php.net/manual/en/reflectionproperty.getdoccomment.php )
*
* Gets the doc comment. WarningThis function is currently not documented;
* only its argument list is available.
* Gets the doc comment. Warning: This function is currently not
* documented; only its argument list is available.
*
* @return mixed The doc comment.
*/
@@ -2116,7 +2117,7 @@ implements Reflector {
/**
* ( excerpt from http://php.net/manual/en/reflectionmethod.export.php )
*
* Exports a ReflectionMethod. WarningThis function is currently not
* Exports a ReflectionMethod. Warning: This function is currently not
* documented; only its argument list is available.
*
* @cls mixed The class name.
@@ -2221,8 +2222,8 @@ implements Reflector {
/**
* ( excerpt from http://php.net/manual/en/reflectionmethod.isprivate.php )
*
* Checks if the method is private. WarningThis function is currently not
* documented; only its argument list is available.
* Checks if the method is private. Warning: This function is currently
* not documented; only its argument list is available.
*
* @return mixed TRUE if the method is private, otherwise FALSE
*/
@@ -2302,7 +2303,7 @@ implements Reflector {
* ( excerpt from http://php.net/manual/en/reflectionmethod.getclosure.php
* )
*
* WarningThis function is currently not documented; only its argument
* Warning: This function is currently not documented; only its argument
* list is available.
*
* @return mixed Returns Closure. Returns NULL in case of an error.
@@ -1,5 +1,14 @@
<?php
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from
* http://php.net/manual/en/function.session-register-shutdown.php )
*
* Registers session_write_close() as a shutdown function.
*
* @return mixed No value is returned.
*/
function session_register_shutdown() {
register_shutdown_function('session_write_close');
}
+3 -3
Ver Arquivo
@@ -103,7 +103,7 @@ class OverflowException extends RuntimeException {}
/**
* ( excerpt from http://php.net/manual/en/class.rangeexception.php )
*
* exception thrown to indicate range errors during program execution.
* Exception thrown to indicate range errors during program execution.
* Normally this means there was an arithmetic error other than
* under/overflow. This is the runtime version of DomainException.
*
@@ -114,7 +114,7 @@ class RangeException extends RuntimeException {}
/**
* ( excerpt from http://php.net/manual/en/class.underflowexception.php )
*
* exception thrown when performing an invalid operation on an empty
* Exception thrown when performing an invalid operation on an empty
* container, such as removing an element.
*
*/
@@ -125,7 +125,7 @@ class UnderflowException extends RuntimeException {}
* ( excerpt from
* http://php.net/manual/en/class.unexpectedvalueexception.php )
*
* exception thrown if a value does not match with a set of values.
* Exception thrown if a value does not match with a set of values.
* Typically this happens when a function calls another function and
* expects the return value to be of a certain type or value not including
* arithmetic or buffer related errors.
@@ -91,12 +91,12 @@ class SplFileObject extends SplFileInfo
* Gets a character from the file.
*
* @return mixed Returns a string containing a single character read
* from the file or FALSE on EOF. WarningThis function
* may return Boolean FALSE, but may also return a
* non-Boolean value which evaluates to FALSE. Please
* read the section on Booleans for more information.
* Use the === operator for testing the return value of
* this function.
* from the file or FALSE on EOF. Warning: This
* function may return Boolean FALSE, but may also
* return a non-Boolean value which evaluates to FALSE.
* Please read the section on Booleans for more
* information. Use the === operator for testing the
* return value of this function.
*/
public function fgetc() {
return fgetc($this->rsrc);
+19 -19
Ver Arquivo
@@ -24,7 +24,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable {
/**
* ( excerpt from http://php.net/manual/en/arrayiterator.construct.php )
*
* Constructs an ArrayIterator object. WarningThis function is currently
* Constructs an ArrayIterator object. Warning: This function is currently
* not documented; only its argument list is available.
*
* @array mixed The array or object to be iterated on.
@@ -41,7 +41,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable {
/**
* ( excerpt from http://php.net/manual/en/arrayiterator.append.php )
*
* Appends value as the last element. WarningThis function is currently
* Appends value as the last element. Warning: This function is currently
* not documented; only its argument list is available.
*
* @value mixed The value to append.
@@ -56,7 +56,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable {
/**
* ( excerpt from http://php.net/manual/en/arrayiterator.asort.php )
*
* Sorts an array by values. WarningThis function is currently not
* Sorts an array by values. Warning: This function is currently not
* documented; only its argument list is available.
*
* @return mixed No value is returned.
@@ -70,7 +70,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable {
* ( excerpt from http://php.net/manual/en/arrayiterator.count.php )
*
* Gets the number of elements in the array, or the number of public
* properties in the object. WarningThis function is currently not
* properties in the object. Warning: This function is currently not
* documented; only its argument list is available.
*
* @return mixed The number of elements or public properties in the
@@ -96,7 +96,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable {
/**
* ( excerpt from http://php.net/manual/en/arrayiterator.getarraycopy.php )
*
* Get a copy of an array. WarningThis function is currently not
* Get a copy of an array. Warning: This function is currently not
* documented; only its argument list is available.
*
* @return mixed A copy of the array, or array of public properties
@@ -110,7 +110,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable {
/**
* ( excerpt from http://php.net/manual/en/arrayiterator.getflags.php )
*
* Get the current flags. WarningThis function is currently not
* Get the current flags. Warning: This function is currently not
* documented; only its argument list is available.
*
* @return mixed The current flags.
@@ -135,7 +135,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable {
/**
* ( excerpt from http://php.net/manual/en/arrayiterator.ksort.php )
*
* Sorts an array by the keys. WarningThis function is currently not
* Sorts an array by the keys. Warning: This function is currently not
* documented; only its argument list is available.
*
* @return mixed No value is returned.
@@ -149,7 +149,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable {
* ( excerpt from http://php.net/manual/en/arrayiterator.natcasesort.php )
*
* Sort the entries by values using a case insensitive "natural order"
* algorithm. WarningThis function is currently not documented; only its
* algorithm. Warning: This function is currently not documented; only its
* argument list is available.
*
* @return mixed No value is returned.
@@ -162,8 +162,8 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable {
/**
* ( excerpt from http://php.net/manual/en/arrayiterator.natsort.php )
*
* Sort the entries by values using "natural order" algorithm. WarningThis
* function is currently not documented; only its argument list is
* Sort the entries by values using "natural order" algorithm. Warning:
* This function is currently not documented; only its argument list is
* available.
*
* @return mixed No value is returned.
@@ -188,7 +188,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable {
/**
* ( excerpt from http://php.net/manual/en/arrayiterator.offsetexists.php )
*
* Checks if the offset exists. WarningThis function is currently not
* Checks if the offset exists. Warning: This function is currently not
* documented; only its argument list is available.
*
* @index mixed The offset being checked.
@@ -203,7 +203,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable {
/**
* ( excerpt from http://php.net/manual/en/arrayiterator.offsetget.php )
*
* Gets the value from the provided offset. WarningThis function is
* Gets the value from the provided offset. Warning: This function is
* currently not documented; only its argument list is available.
*
* @index mixed The offset to get the value from.
@@ -218,8 +218,8 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable {
/**
* ( excerpt from http://php.net/manual/en/arrayiterator.offsetset.php )
*
* Sets a value for a given offset. WarningThis function is currently not
* documented; only its argument list is available.
* Sets a value for a given offset. Warning: This function is currently
* not documented; only its argument list is available.
*
* @index mixed The index to set for.
* @newval mixed The new value to store at the index.
@@ -234,7 +234,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable {
/**
* ( excerpt from http://php.net/manual/en/arrayiterator.offsetunset.php )
*
* Unsets a value for an offset. WarningThis function is currently not
* Unsets a value for an offset. Warning: This function is currently not
* documented; only its argument list is available.
*
* @index mixed The offset to unset.
@@ -279,8 +279,8 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable {
/**
* ( excerpt from http://php.net/manual/en/arrayiterator.setflags.php )
*
* Sets behaviour flags. WarningThis function is currently not documented;
* only its argument list is available.
* Sets behaviour flags. Warning: This function is currently not
* documented; only its argument list is available.
*
* @flags mixed A bitmask as follows: 0 = Properties of the object
* have their normal functionality when accessed as
@@ -297,7 +297,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable {
/**
* ( excerpt from http://php.net/manual/en/arrayiterator.uasort.php )
*
* Sort the entries by values using user defined function. WarningThis
* Sort the entries by values using user defined function. Warning: This
* function is currently not documented; only its argument list is
* available.
*
@@ -314,7 +314,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable {
/**
* ( excerpt from http://php.net/manual/en/arrayiterator.uksort.php )
*
* Sort the entries by key using user defined function. WarningThis
* Sort the entries by key using user defined function. Warning: This
* function is currently not documented; only its argument list is
* available.
*
@@ -17,7 +17,7 @@ abstract class FilterIterator extends IteratorIterator {
* ( excerpt from http://php.net/manual/en/filteriterator.construct.php )
*
* Constructs a new FilterIterator, which consists of a passed in iterator
* with filters applied to it. WarningThis function is currently not
* with filters applied to it. Warning: This function is currently not
* documented; only its argument list is available.
*
* @it mixed The iterator that is being filtered.
@@ -89,7 +89,7 @@ class RecursiveDirectoryIterator extends FilesystemIterator
* ( excerpt from
* http://php.net/manual/en/recursivedirectoryiterator.getsubpath.php )
*
* Gets the sub path. WarningThis function is currently not documented;
* Gets the sub path. Warning: This function is currently not documented;
* only its argument list is available.
*
* @return mixed The sub path (sub directory).
@@ -103,7 +103,7 @@ class RecursiveDirectoryIterator extends FilesystemIterator
* ( excerpt from
* http://php.net/manual/en/recursivedirectoryiterator.getsubpathname.php )
*
* Gets the sub path and filename. WarningThis function is currently not
* Gets the sub path and filename. Warning: This function is currently not
* documented; only its argument list is available.
*
* @return mixed The sub path (sub directory) and filename.
@@ -59,8 +59,8 @@ class RecursiveIteratorIterator implements OuterIterator, Traversable {
* http://php.net/manual/en/recursiveiteratoriterator.getinneriterator.php
* )
*
* Gets the current active sub iterator. WarningThis function is currently
* not documented; only its argument list is available.
* Gets the current active sub iterator. Warning: This function is
* currently not documented; only its argument list is available.
*
* @return mixed The current active sub iterator.
*/
@@ -291,7 +291,7 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess,
/**
* ( excerpt from http://php.net/manual/en/arrayobject.serialize.php )
*
* Serializes an ArrayObject. WarningThis function is currently not
* Serializes an ArrayObject. Warning: This function is currently not
* documented; only its argument list is available.
*
* @return mixed The serialized representation of the ArrayObject.
@@ -397,7 +397,7 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess,
/**
* ( excerpt from http://php.net/manual/en/arrayobject.unserialize.php )
*
* Unserializes a serialized ArrayObject. WarningThis function is
* Unserializes a serialized ArrayObject. Warning: This function is
* currently not documented; only its argument list is available.
*
* @serialized mixed The serialized ArrayObject.