From ed171866b7a7aab62f87bf9d7745442b435374e9 Mon Sep 17 00:00:00 2001 From: Paul Tarjan Date: Thu, 23 May 2013 17:00:52 -0700 Subject: [PATCH] update docs --- bin/systemlib.php | 1568 ++++++++++++++------- hphp/idl/base.php | 2 +- hphp/idl/sysdoc.php | 3 +- hphp/system/classes/arrayaccess.php | 10 +- hphp/system/classes/arrayobject.php | 96 +- hphp/system/classes/directory.php | 8 + hphp/system/classes/directoryiterator.php | 75 +- hphp/system/classes/exception.php | 150 +- hphp/system/classes/iterator.php | 366 +++-- hphp/system/classes/reflection.php | 655 ++++++--- hphp/system/classes/soapfault.php | 15 + hphp/system/classes/splfile.php | 168 ++- hphp/system/classes/splobjectstorage.php | 22 +- 13 files changed, 2176 insertions(+), 962 deletions(-) diff --git a/bin/systemlib.php b/bin/systemlib.php index a486287a9..e1a6b3b29 100644 --- a/bin/systemlib.php +++ b/bin/systemlib.php @@ -11,7 +11,7 @@ class __PHP_Incomplete_Class { public $__PHP_Incomplete_Class_Name; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.exception.php ) * @@ -43,13 +43,24 @@ class Exception { $this->inited = true; } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/exception.construct.php ) + * + * Constructs the Exception. + * + * @message mixed The Exception message to throw. + * @code mixed The Exception code. + * @previous mixed The previous exception used for the exception + * chaining. + */ function __construct($message = '', $code = 0, Exception $previous = null) { $this->message = $message; $this->code = $code; $this->previous = $previous; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/exception.getmessage.php ) * @@ -61,13 +72,15 @@ class Exception { return $this->message; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/exception.getprevious.php ) * - * Returns the previous Exception. + * Returns previous Exception (the third parameter of + * Exception::__construct()). * - * @return mixed Returns the previous Exception if available or NULL otherwise. + * @return mixed Returns the previous Exception if available or NULL + * otherwise. */ final function getPrevious() { return $this->previous; @@ -87,45 +100,47 @@ class Exception { $cur->setPrevious($previous); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/exception.getcode.php ) * * Returns the Exception code. * - * @return mixed Returns the Exception code as a integer. + * @return mixed Returns the exception code as integer in Exception + * but possibly as other type in Exception descendants + * (for example as string in PDOException). */ function getCode() { return $this->code; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/exception.getfile.php ) * - * Get the name of the file the exception was thrown from. + * Get the name of the file the exception was created. * * @return mixed Returns the filename in which the exception was - * thrown. + * created. */ final function getFile() { return $this->file; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/exception.getline.php ) * - * Returns line number where the exception was thrown. + * Get line number where the exception was created. * * @return mixed Returns the line number where the exception was - * thrown. + * created. */ final function getLine() { return $this->line; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/exception.gettrace.php ) * @@ -137,7 +152,7 @@ class Exception { return $this->trace; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/exception.gettraceasstring.php ) * @@ -163,6 +178,14 @@ class Exception { /* Overrideable */ // formated string for display +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/exception.tostring.php ) + * + * Returns the string representation of the exception. + * + * @return mixed Returns the string representation of the exception. + */ function __toString() { return "exception '" . get_class($this) . "' with message '" . $this->getMessage() . "' in " . $this->getFile() . ":" . @@ -198,122 +221,130 @@ class Exception { } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.logicexception.php ) * - * Exception thrown if a logic expression is invalid + * Exception that represents error in the program logic. This kind of + * exceptions should directly lead to a fix in your code. * */ class LogicException extends Exception {} -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/class.badfunctioncallexception.php ) * * Exception thrown if a callback refers to an undefined function or if - * some arguments are missing + * some arguments are missing. * */ class BadFunctionCallException extends LogicException {} -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.badmethodcallexception.php * ) * * Exception thrown if a callback refers to an undefined method or if some - * arguments are missing + * arguments are missing. * */ class BadMethodCallException extends BadFunctionCallException {} -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.domainexception.php ) * * Exception thrown if a value does not adhere to a defined valid data - * domain + * domain. * */ class DomainException extends LogicException {} -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/class.invalidargumentexception.php ) * - * Exception thrown if an argument does not match with the expected value + * Exception thrown if an argument does not match with the expected value. * */ class InvalidArgumentException extends LogicException {} -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.lengthexception.php ) * - * Exception thrown if a length is invalid + * Exception thrown if a length is invalid. * */ class LengthException extends LogicException {} -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.outofrangeexception.php ) * - * Exception thrown when a value does not match with a range + * Exception thrown when an illegal index was requested. This represents + * errors that should be detected at compile time. * */ class OutOfRangeException extends LogicException {} -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.runtimeexception.php ) * - * Exception thrown if an error which can only be found on runtime occurs + * Exception thrown if an error which can only be found on runtime occurs. * */ class RuntimeException extends Exception {} -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.outofboundsexception.php ) * - * Exception thrown if a value is not a valid key + * Exception thrown if a value is not a valid key. This represents errors + * that cannot be detected at compile time. * */ class OutOfBoundsException extends RuntimeException {} -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.overflowexception.php ) * - * Exception thrown when you add an element into a full container + * Exception thrown when adding an element to a full container. * */ class OverflowException extends RuntimeException {} -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.rangeexception.php ) * - * Exception thrown when an invalid range is given. + * 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. * */ class RangeException extends RuntimeException {} -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.underflowexception.php ) * - * Exception thrown when you try to remove an element of an empty - * container + * Exception thrown when performing an invalid operation on an empty + * container, such as removing an element. * */ class UnderflowException extends RuntimeException {} -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( 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. * */ class UnexpectedValueException extends RuntimeException {} class InvalidOperationException extends RuntimeException {} -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.errorexception.php ) * @@ -322,6 +353,18 @@ class RuntimeException extends Exception {} */ class ErrorException extends Exception { protected $severity; +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/errorexception.construct.php ) + * + * Constructs the Exception. + * + * @message mixed The Exception message to throw. + * @code mixed The Exception code. + * @severity mixed The severity level of the exception. + * @filename mixed The filename where the exception is thrown. + * @lineno mixed The line number where the exception is thrown. + */ public function __construct($message = "", $code = 0, $severity = 0, $filename = null, $lineno = null) { parent::__construct($message, $code); @@ -334,7 +377,7 @@ class ErrorException extends Exception { } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/errorexception.getseverity.php ) * @@ -345,19 +388,38 @@ class ErrorException extends Exception { final public function getSeverity() { return $this->severity; } } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/class.domexception.php ) + * + * DOM operations raise exceptions under particular circumstances, i.e., + * when an operation is impossible to perform for logical reasons. + * + * See also Exceptions. + * + */ class DOMException extends Exception { public function __construct($message, $code) { parent::__construct($message, $code); } } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/class.pdoexception.php ) + * + * Represents an error raised by PDO. You should not throw a PDOException + * from your own code. See Exceptions for more information about Exceptions + * in PHP. + * + */ class PDOException extends Exception { public function __construct() { } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.arrayaccess.php ) * @@ -365,7 +427,7 @@ class PDOException extends Exception { * */ interface ArrayAccess { -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayaccess.offsetexists.php ) * @@ -385,7 +447,7 @@ interface ArrayAccess { * non-boolean was returned. */ public function offsetExists($index); -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayaccess.offsetget.php ) * @@ -398,7 +460,7 @@ interface ArrayAccess { * @return mixed Can return all value types. */ public function offsetGet($index); -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayaccess.offsetset.php ) * @@ -410,7 +472,7 @@ interface ArrayAccess { * @return mixed No value is returned. */ public function offsetSet($index, $newvalue); -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayaccess.offsetunset.php ) * @@ -425,7 +487,7 @@ interface ArrayAccess { public function offsetUnset($index); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.countable.php ) * @@ -433,7 +495,7 @@ interface ArrayAccess { * */ interface Countable { -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/countable.count.php ) * @@ -447,7 +509,7 @@ interface Countable { public function count(); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.serializable.php ) * @@ -463,7 +525,7 @@ interface Countable { * */ interface Serializable { -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/serializable.serialize.php ) * @@ -476,7 +538,7 @@ interface Serializable { * NULL */ public function serialize(); -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/serializable.unserialize.php ) * @@ -487,28 +549,36 @@ interface Serializable { * * @serialized mixed The string representation of the object. * - * @return mixed Returns the original value unserialized. + * @return mixed The return value from this method is ignored. */ public function unserialize($serialized); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.jsonserializable.php ) * + * Objects implementing JsonSerializable can customize their JSON + * representation when encoded with json_encode(). + * */ interface JsonSerializable { -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * ( excerpt from http://php.net/manual/en/jsonserializable.jsonserialize.php ) + * ( excerpt from + * http://php.net/manual/en/jsonserializable.jsonserialize.php ) * - * Specify data which should be serialized to JSON + * Serializes the object to a value that can be serialized natively by + * json_encode(). * + * @return mixed Returns data which can be serialized by + * json_encode(), which is a value of any type other + * than a resource. */ public function jsonSerialize(); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.traversable.php ) * @@ -522,7 +592,9 @@ interface JsonSerializable { * Iterator. * * This is an internal engine interface which cannot be implemented in PHP - * scripts. Either IteratorAggregate or Iterator must be used instead. + * scripts. Either IteratorAggregate or Iterator must be used instead. When + * implementing an interface which extends Traversable, make sure to list + * IteratorAggregate or Iterator before its name in the implements clause. * */ interface Traversable { @@ -531,7 +603,7 @@ interface Traversable { interface KeyedTraversable extends Traversable { } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.iterator.php ) * @@ -540,7 +612,7 @@ interface KeyedTraversable extends Traversable { * */ interface Iterator extends Traversable { -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/iterator.current.php ) * @@ -549,7 +621,7 @@ interface Iterator extends Traversable { * @return mixed Can return any type. */ public function current(); -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/iterator.key.php ) * @@ -558,7 +630,7 @@ interface Iterator extends Traversable { * @return mixed Returns scalar on success, or NULL on failure. */ public function key(); -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/iterator.next.php ) * @@ -569,7 +641,7 @@ interface Iterator extends Traversable { * @return mixed Any returned value is ignored. */ public function next(); -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/iterator.rewind.php ) * @@ -581,7 +653,7 @@ interface Iterator extends Traversable { * @return mixed Any returned value is ignored. */ public function rewind(); -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/iterator.valid.php ) * @@ -598,7 +670,7 @@ interface Iterator extends Traversable { interface KeyedIterator extends Iterator, KeyedTraversable { } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.seekableiterator.php ) * @@ -606,7 +678,7 @@ interface KeyedIterator extends Iterator, KeyedTraversable { * */ interface SeekableIterator extends Iterator { -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/seekableiterator.seek.php ) * @@ -619,7 +691,7 @@ interface SeekableIterator extends Iterator { public function seek($position); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.outeriterator.php ) * @@ -628,10 +700,19 @@ interface SeekableIterator extends Iterator { * */ interface OuterIterator extends Iterator { +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from + * http://php.net/manual/en/outeriterator.getinneriterator.php ) + * + * Returns the inner iterator for the current iterator entry. + * + * @return mixed The inner iterator for the current entry. + */ public function getInnerIterator(); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.recursiveiterator.php ) * @@ -640,7 +721,7 @@ interface OuterIterator extends Iterator { * */ interface RecursiveIterator extends Iterator { -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/recursiveiterator.getchildren.php ) @@ -650,12 +731,12 @@ interface RecursiveIterator extends Iterator { * @return mixed An iterator for the current entry. */ public function getChildren(); -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/recursiveiterator.haschildren.php ) * - * Returns if an iterator can be created fot the current entry. + * Returns if an iterator can be created for the current entry. * RecursiveIterator::getChildren(). * * @return mixed Returns TRUE if the current entry can be iterated @@ -664,7 +745,7 @@ interface RecursiveIterator extends Iterator { public function hasChildren(); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/class.recursiveiteratoriterator.php ) @@ -681,12 +762,36 @@ class RecursiveIteratorIterator implements OuterIterator, Traversable { const CHILD_FIRST = 2; const CATCH_GET_CHILD = 16; +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from + * http://php.net/manual/en/recursiveiteratoriterator.construct.php ) + * + * Creates a RecursiveIteratorIterator from a RecursiveIterator. + * + * @iterator mixed The iterator being constructed from. Either a + * RecursiveIterator or IteratorAggregate. + * @mode mixed Optional mode. Possible values are + * RecursiveIteratorIterator::LEAVES_ONLY - The + * default. Lists only leaves in iteration. + * RecursiveIteratorIterator::SELF_FIRST - Lists leaves + * and parents in iteration with parents coming first. + * RecursiveIteratorIterator::CHILD_FIRST - Lists + * leaves and parents in iteration with leaves coming + * first. + * @flags mixed Optional flag. Possible values are + * RecursiveIteratorIterator::CATCH_GET_CHILD which + * will then ignore exceptions thrown in calls to + * RecursiveIteratorIterator::getChildren(). + * + * @return mixed No value is returned. + */ public function __construct($iterator, $mode = RecursiveIteratorIterator::LEAVES_ONLY, $flags = 0) { hphp_recursiveiteratoriterator___construct($this, $iterator, $mode, $flags); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/recursiveiteratoriterator.getinneriterator.php @@ -700,7 +805,7 @@ class RecursiveIteratorIterator implements OuterIterator, Traversable { public function getInnerIterator() { return hphp_recursiveiteratoriterator_getinneriterator($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/recursiveiteratoriterator.current.php ) @@ -711,7 +816,7 @@ class RecursiveIteratorIterator implements OuterIterator, Traversable { public function current() { return hphp_recursiveiteratoriterator_current($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/recursiveiteratoriterator.key.php ) @@ -722,7 +827,7 @@ class RecursiveIteratorIterator implements OuterIterator, Traversable { public function key() { return hphp_recursiveiteratoriterator_key($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/recursiveiteratoriterator.next.php ) @@ -733,7 +838,7 @@ class RecursiveIteratorIterator implements OuterIterator, Traversable { public function next() { hphp_recursiveiteratoriterator_next($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/recursiveiteratoriterator.rewind.php ) @@ -744,7 +849,7 @@ class RecursiveIteratorIterator implements OuterIterator, Traversable { public function rewind() { hphp_recursiveiteratoriterator_rewind($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/recursiveiteratoriterator.valid.php ) @@ -760,7 +865,7 @@ class RecursiveIteratorIterator implements OuterIterator, Traversable { /////////////////////////////////////////////////////////////////////////////// -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.arrayiterator.php ) * @@ -780,13 +885,24 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { const STD_PROP_LIST = 1; const ARRAY_AS_PROPS = 2; +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/arrayiterator.construct.php ) + * + * Constructs an ArrayIterator object. WarningThis function is currently + * not documented; only its argument list is available. + * + * @array mixed The array or object to be iterated on. + * + * @return mixed An ArrayIterator object. + */ public function __construct($array = array(), $flags = 0) { $this->arr = (array) $array; $this->flags = $flags; reset($this->arr); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.append.php ) * @@ -801,7 +917,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { $this->arr[] = $value; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.asort.php ) * @@ -814,7 +930,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { return asort($this->arr); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.count.php ) * @@ -822,13 +938,14 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { * properties in the object. WarningThis function is currently not * documented; only its argument list is available. * - * @return mixed The number. + * @return mixed The number of elements or public properties in the + * associated array or object, respectively. */ public function count() { return count($this->arr); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.current.php ) * @@ -840,7 +957,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { return current($this->arr); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.getarraycopy.php ) * @@ -854,7 +971,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { return $this->arr; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.getflags.php ) * @@ -867,7 +984,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { return $this->flags; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.key.php ) * @@ -879,7 +996,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { return key($this->arr); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.ksort.php ) * @@ -892,7 +1009,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { return ksort($this->arr); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.natcasesort.php ) * @@ -906,7 +1023,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { return natcasesort($this->arr); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.natsort.php ) * @@ -920,7 +1037,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { return natsort($this->arr); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.next.php ) * @@ -932,7 +1049,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { next($this->arr); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.offsetexists.php ) * @@ -947,7 +1064,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { return isset($this->arr[$index]); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.offsetget.php ) * @@ -962,7 +1079,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { return $this->arr[$index]; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.offsetset.php ) * @@ -978,7 +1095,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { $this->arr[$index] = $newval; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.offsetunset.php ) * @@ -993,7 +1110,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { unset($this->arr[$index]); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.rewind.php ) * @@ -1005,7 +1122,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { reset($this->arr); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.seek.php ) * @@ -1023,7 +1140,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.setflags.php ) * @@ -1041,7 +1158,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { $this->flags = $flags; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.uasort.php ) * @@ -1058,7 +1175,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { return uasort($this->arr, $cmp_function); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.uksort.php ) * @@ -1075,7 +1192,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { return uksort($this->arr, $cmp_function); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.valid.php ) * @@ -1088,10 +1205,30 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { } } -// http://www.php.net/~helly/php/ext/spl/iteratoriterator_8inc-source.html +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/class.iteratoriterator.php ) + * + * This iterator wrapper allows the conversion of anything that is + * Traversable into an Iterator. It is important to understand that most + * classes that do not implement Iterators have reasons as most likely they + * do not allow the full Iterator feature set. If so, techniques should be + * provided to prevent misuse, otherwise expect exceptions or fatal errors. + * + */ class IteratorIterator implements OuterIterator { private $iterator; +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/iteratoriterator.construct.php ) + * + * Creates an iterator from anything that is traversable. + * + * @iterator mixed The traversable iterator. + * + * @return mixed No value is returned. + */ public function __construct(Traversable $iterator) { if ($iterator instanceof IteratorAggregate) { $iterator = $iterator->getIterator(); @@ -1104,26 +1241,77 @@ class IteratorIterator implements OuterIterator { } } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from + * http://php.net/manual/en/iteratoriterator.getinneriterator.php ) + * + * Get the inner iterator. + * + * @return mixed The inner iterator as passed to + * IteratorIterator::__construct(). + */ public function getInnerIterator() { return $this->iterator; } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/iteratoriterator.valid.php ) + * + * Checks if the iterator is valid. + * + * @return mixed Returns TRUE if the iterator is valid, otherwise + * FALSE + */ public function valid() { return $this->iterator->valid(); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/iteratoriterator.key.php ) + * + * Get the key of the current element. + * + * @return mixed The key of the current element. + */ public function key() { return $this->iterator->key(); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/iteratoriterator.current.php ) + * + * Get the value of the current element. + * + * @return mixed The value of the current element. + */ public function current() { return $this->iterator->current(); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/iteratoriterator.next.php ) + * + * Forward to the next element. + * + * @return mixed No value is returned. + */ public function next() { return $this->iterator->next(); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/iteratoriterator.rewind.php ) + * + * Rewinds to the first element. + * + * @return mixed No value is returned. + */ public function rewind() { return $this->iterator->rewind(); } @@ -1133,8 +1321,7 @@ class IteratorIterator implements OuterIterator { } } -// http://www.php.net/~helly/php/ext/spl/filteriterator_8inc-source.html -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.filteriterator.php ) * @@ -1146,15 +1333,44 @@ class IteratorIterator implements OuterIterator { abstract class FilterIterator extends IteratorIterator { private $it; +// This doc comment block generated by idl/sysdoc.php +/** + * ( 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 + * documented; only its argument list is available. + * + * @it mixed The iterator that is being filtered. + * + * @return mixed The FilterIterator. + */ public function __construct(Iterator $it) { $this->it = $it; } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/filteriterator.rewind.php ) + * + * + * @return mixed No value is returned. + */ public function rewind() { $this->it->rewind(); $this->fetch(); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/filteriterator.accept.php ) + * + * Returns whether the current element of the iterator is acceptable + * through this filter. + * + * @return mixed TRUE if the current element is acceptable, otherwise + * FALSE. + */ abstract function accept(); private function fetch() { @@ -1166,19 +1382,48 @@ abstract class FilterIterator extends IteratorIterator { } } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/filteriterator.next.php ) + * + * + * @return mixed No value is returned. + */ public function next() { $this->it->next(); $this->fetch(); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/filteriterator.valid.php ) + * + * + * @return mixed TRUE if the current element is valid, otherwise + * FALSE + */ public function valid() { return $this->it->valid(); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/filteriterator.key.php ) + * + * + * @return mixed The current key. + */ public function key() { return $this->it->key(); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/filteriterator.current.php ) + * + * + * @return mixed The current element value. + */ public function current() { return $this->it->current(); } @@ -1187,6 +1432,14 @@ abstract class FilterIterator extends IteratorIterator { // disallow clone } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from + * http://php.net/manual/en/filteriterator.getinneriterator.php ) + * + * + * @return mixed The inner iterator. + */ public function getInnerIterator() { return $this->it; } @@ -1196,7 +1449,7 @@ abstract class FilterIterator extends IteratorIterator { } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.iteratoraggregate.php ) * @@ -1204,7 +1457,7 @@ abstract class FilterIterator extends IteratorIterator { * */ interface IteratorAggregate extends Traversable { -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/iteratoraggregate.getiterator.php ) @@ -1223,10 +1476,7 @@ interface Iterable extends IteratorAggregate { interface KeyedIterable extends Iterable, KeyedTraversable { } -/////////////////////////////////////////////////////////////////////////////// -// http://www.php.net/~helly/php/ext/spl/appenditerator_8inc-source.html - -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.appenditerator.php ) * @@ -1236,16 +1486,23 @@ interface KeyedIterable extends Iterable, KeyedTraversable { class AppendIterator implements OuterIterator { private $iterators; +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/appenditerator.construct.php ) + * + * Constructs an AppendIterator. + * + * @return mixed No value is returned. + */ function __construct() { $this->iterators = new ArrayIterator(array()); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/appenditerator.append.php ) * - * Appends an iterator. WarningThis function is currently not documented; - * only its argument list is available. + * Appends an iterator. * * @it mixed The iterator to append. * @@ -1255,27 +1512,25 @@ class AppendIterator implements OuterIterator { $this->iterators->append($it); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/appenditerator.getinneriterator.php ) * - * Get an inner iterator WarningThis function is currently not documented; - * only its argument list is available. + * This method returns the current inner iterator. * - * @return mixed The current inner Iterator. + * @return mixed The current inner iterator, or NULL if there is not + * one. */ function getInnerIterator() { return $this->iterators->current(); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/appenditerator.rewind.php ) * - * Rewind to the first element of the first inner Iterator. WarningThis - * function is currently not documented; only its argument list is - * available. + * Rewind to the first element of the first inner Iterator. * * @return mixed No value is returned. */ @@ -1286,25 +1541,24 @@ class AppendIterator implements OuterIterator { } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/appenditerator.valid.php ) * - * Checks validity of the current element. WarningThis function is - * currently not documented; only its argument list is available. + * Checks validity of the current element. * - * @return mixed Returns TRUE on success or FALSE on failure. + * @return mixed Returns TRUE if the current iteration is valid, + * FALSE otherwise. */ function valid() { return $this->iterators->valid() && $this->getInnerIterator()->valid(); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/appenditerator.current.php ) * - * Gets the current value. WarningThis function is currently not - * documented; only its argument list is available. + * Gets the current value. * * @return mixed The current value if it is valid or NULL otherwise. */ @@ -1317,12 +1571,11 @@ class AppendIterator implements OuterIterator { $this->getInnerIterator()->current() : NULL; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/appenditerator.key.php ) * - * Get the current key WarningThis function is currently not documented; - * only its argument list is available. + * Get the current key. * * @return mixed The current key if it is valid or NULL otherwise. */ @@ -1330,13 +1583,12 @@ class AppendIterator implements OuterIterator { return $this->iterators->valid() ? $this->getInnerIterator()->key() : NULL; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/appenditerator.next.php ) * * Moves to the next element. If this means to another Iterator then it - * rewinds that Iterator. WarningThis function is currently not documented; - * only its argument list is available. + * rewinds that Iterator. * * @return mixed No value is returned. */ @@ -1365,7 +1617,7 @@ class AppendIterator implements OuterIterator { } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.splfileinfo.php ) * @@ -1376,11 +1628,20 @@ class AppendIterator implements OuterIterator { class SplFileInfo { private $rsrc; +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/splfileinfo.construct.php ) + * + * Creates a new SplFileInfo object for the file_name specified. The file + * does not need to exist, or be readable. + * + * @file_name mixed Path to the file. + */ public function __construct($file_name) { hphp_splfileinfo___construct($this, $file_name); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileinfo.getpath.php ) * @@ -1393,7 +1654,7 @@ class SplFileInfo { return hphp_splfileinfo_getpath($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileinfo.getfilename.php ) * @@ -1405,7 +1666,7 @@ class SplFileInfo { return hphp_splfileinfo_getfilename($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileinfo.getfileinfo.php ) * @@ -1419,7 +1680,7 @@ class SplFileInfo { return hphp_splfileinfo_getfileinfo($this, $class_name); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileinfo.getbasename.php ) * @@ -1434,7 +1695,7 @@ class SplFileInfo { return hphp_splfileinfo_getbasename($this, $suffix); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileinfo.getpathname.php ) * @@ -1446,7 +1707,7 @@ class SplFileInfo { return hphp_splfileinfo_getpathname($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileinfo.getpathinfo.php ) * @@ -1461,7 +1722,7 @@ class SplFileInfo { return hphp_splfileinfo_getpathinfo($this, $class_name); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileinfo.getperms.php ) * @@ -1473,7 +1734,7 @@ class SplFileInfo { return hphp_splfileinfo_getperms($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileinfo.getinode.php ) * @@ -1485,7 +1746,7 @@ class SplFileInfo { return hphp_splfileinfo_getinode($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileinfo.getsize.php ) * @@ -1497,7 +1758,7 @@ class SplFileInfo { return hphp_splfileinfo_getsize($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileinfo.getowner.php ) * @@ -1509,7 +1770,7 @@ class SplFileInfo { return hphp_splfileinfo_getowner($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileinfo.getgroup.php ) * @@ -1521,7 +1782,7 @@ class SplFileInfo { return hphp_splfileinfo_getgroup($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileinfo.getatime.php ) * @@ -1533,7 +1794,7 @@ class SplFileInfo { return hphp_splfileinfo_getatime($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileinfo.getmtime.php ) * @@ -1547,7 +1808,7 @@ class SplFileInfo { return hphp_splfileinfo_getmtime($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileinfo.getctime.php ) * @@ -1560,7 +1821,7 @@ class SplFileInfo { return hphp_splfileinfo_getctime($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileinfo.gettype.php ) * @@ -1573,7 +1834,7 @@ class SplFileInfo { return hphp_splfileinfo_gettype($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileinfo.iswritable.php ) * @@ -1585,7 +1846,7 @@ class SplFileInfo { return hphp_splfileinfo_iswritable($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileinfo.isreadable.php ) * @@ -1597,7 +1858,7 @@ class SplFileInfo { return hphp_splfileinfo_isreadable($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileinfo.isexecutable.php ) * @@ -1609,7 +1870,7 @@ class SplFileInfo { return hphp_splfileinfo_isexecutable($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileinfo.isfile.php ) * @@ -1623,7 +1884,7 @@ class SplFileInfo { return hphp_splfileinfo_isfile($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileinfo.isdir.php ) * @@ -1635,7 +1896,7 @@ class SplFileInfo { return hphp_splfileinfo_isdir($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileinfo.islink.php ) * @@ -1648,7 +1909,7 @@ class SplFileInfo { return hphp_splfileinfo_islink($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileinfo.getlinktarget.php ) * @@ -1663,7 +1924,7 @@ class SplFileInfo { return hphp_splfileinfo_getlinktarget($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileinfo.getrealpath.php ) * @@ -1676,11 +1937,19 @@ class SplFileInfo { return hphp_splfileinfo_getrealpath($this); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/splfileinfo.tostring.php ) + * + * This method will return the file name of the referenced file. + * + * @return mixed Returns the path to the file. + */ public function __toString() { return hphp_splfileinfo___tostring($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileinfo.openfile.php ) * @@ -1706,7 +1975,7 @@ class SplFileInfo { $use_include_path, $context); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileinfo.setfileclass.php ) * @@ -1722,7 +1991,7 @@ class SplFileInfo { hphp_splfileinfo_setfileclass($this, $class_name); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileinfo.setinfoclass.php ) * @@ -1739,7 +2008,7 @@ class SplFileInfo { } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.splfileobject.php ) * @@ -1754,6 +2023,29 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, const SKIP_EMPTY = 6; const READ_CSV = 8; +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/splfileobject.construct.php ) + * + * Construct a new file object. + * + * @filename mixed The file to read. TipA URL can be used as a filename + * with this function if the fopen wrappers have been + * enabled. See fopen() for more details on how to + * specify the filename. See the Supported Protocols + * and Wrappers for links to information about what + * abilities the various wrappers have, notes on their + * usage, and information on any predefined variables + * they may provide. + * @open_mode mixed The mode in which to open the file. See fopen() for + * a list of allowed modes. + * @use_include_path + * mixed Whether to search in the include_path for filename. + * @context mixed A valid context resource created with + * stream_context_create(). + * + * @return mixed No value is returned. + */ public function __construct($filename, $open_mode = 'r', $use_include_path = false, $context = null) { @@ -1761,7 +2053,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, $use_include_path, $context); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.current.php ) * @@ -1776,7 +2068,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, return hphp_splfileobject_current($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.eof.php ) * @@ -1788,7 +2080,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, return hphp_splfileobject_eof($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.fflush.php ) * @@ -1800,7 +2092,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, return hphp_splfileobject_fflush($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.fgetc.php ) * @@ -1809,16 +2101,16 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, * @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, such as - * 0 or "". Please read the section on Booleans for - * more information. Use the === operator for testing - * the return value of this function. + * 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 hphp_splfileobject_fgetc($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.fgetcsv.php ) * @@ -1850,7 +2142,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, $enclosure, $escape); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.fgets.php ) * @@ -1863,7 +2155,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, return hphp_splfileobject_fgets($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.fgetss.php ) * @@ -1872,8 +2164,8 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, * text it reads. * * @allowable_tags - * mixed You can use the optional third parameter to specify - * tags which should not be stripped. + * mixed Optional parameter to specify tags which should not + * be stripped. * * @return mixed Returns a string containing the next line of the * file with HTML and PHP code stripped, or FALSE on @@ -1883,7 +2175,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, return hphp_splfileobject_fgetss($this, $allowable_tags); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.flock.php ) * @@ -1903,7 +2195,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, return hphp_splfileobject_flock($this, $wouldblock); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.fpassthru.php ) * @@ -1921,7 +2213,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, return hphp_splfileobject_fpassthru($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.fscanf.php ) * @@ -1935,8 +2227,8 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, * @format mixed The specified format as described in the sprintf() * documentation. * - * @return mixed If only two parameters were passed to this method, - * the values parsed will be returned as an array. + * @return mixed If only one parameter is passed to this method, the + * values parsed will be returned as an array. * Otherwise, if optional parameters are passed, the * function will return the number of assigned values. * The optional parameters must be passed by reference. @@ -1947,7 +2239,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, return hphp_splfileobject_fscanf($argc, $this, $format, $argv); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.fseek.php ) * @@ -1973,7 +2265,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, return hphp_splfileobject_fseek($this, $offset, $whence); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.fstat.php ) * @@ -1987,7 +2279,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, return hphp_splfileobject_fstat($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.ftell.php ) * @@ -2001,7 +2293,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, return hphp_splfileobject_ftell($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.ftruncate.php ) * @@ -2021,7 +2313,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, return hphp_splfileobject_ftruncate($this, $size); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.fwrite.php ) * @@ -2039,7 +2331,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, return hphp_splfileobject_fwrite($this, $str, $length); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.getchildren.php ) * @@ -2051,7 +2343,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, return null; // An SplFileOjbect does not have children } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.getcsvcontrol.php * ) @@ -2065,7 +2357,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, return hphp_splfileobject_getcvscontrol($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.getflags.php ) * @@ -2077,7 +2369,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, return hphp_splfileobject_getflags($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.getmaxlinelen.php * ) @@ -2091,7 +2383,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, return hphp_splfileobject_getmaxlinelen($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.haschildren.php ) * @@ -2104,7 +2396,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, return false; // An SplFileOjbect does not have children } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.key.php ) * @@ -2120,7 +2412,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, return hphp_splfileobject_key($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.next.php ) * @@ -2132,7 +2424,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, hphp_splfileobject_next($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.rewind.php ) * @@ -2144,7 +2436,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, hphp_splfileobject_rewind($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.seek.php ) * @@ -2158,7 +2450,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, hphp_splfileobject_seek($this, $line_pos); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.setcsvcontrol.php * ) @@ -2176,7 +2468,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, hphp_splfileobject_setcsvcontrol($this, $delimiter, $enclosure, $escape); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.setflags.php ) * @@ -2191,7 +2483,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, hphp_splfileobject_setflags($this, $flags); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.setmaxlinelen.php * ) @@ -2206,7 +2498,7 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, hphp_splfileobject_setmaxlinelen($this, $max_len); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splfileobject.valid.php ) * @@ -2219,6 +2511,14 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, } } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/class.directory.php ) + * + * Instances of Directory are created by calling the dir() function, not + * by the new operator. + * + */ class Directory { public $path; public $handle; @@ -2241,6 +2541,13 @@ class Directory { } } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/class.soapfault.php ) + * + * Represents a SOAP fault. + * + */ class SoapFault extends Exception { public $faultcode; public $faultcodens; @@ -2311,13 +2618,21 @@ class SoapFault extends Exception { } } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/soapfault.tostring.php ) + * + * Returns a string representation of the SoapFault. + * + * @return mixed A string describing the SoapFault. + */ public function __toString() { return "SoapFault exception: [" . $this->faultcode . "] " . $this->faultstring; } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.splobjectstorage.php ) * @@ -2330,7 +2645,7 @@ class SplObjectStorage implements Iterator, Countable { private $storage = array(); private $index = 0; -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splobjectstorage.rewind.php ) * @@ -2342,7 +2657,7 @@ class SplObjectStorage implements Iterator, Countable { rewind($this->storage); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splobjectstorage.valid.php ) * @@ -2355,7 +2670,7 @@ class SplObjectStorage implements Iterator, Countable { return key($this->storage) !== false; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splobjectstorage.key.php ) * @@ -2368,7 +2683,7 @@ class SplObjectStorage implements Iterator, Countable { return $this->index; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splobjectstorage.current.php ) * @@ -2380,7 +2695,7 @@ class SplObjectStorage implements Iterator, Countable { return current($this->storage); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splobjectstorage.next.php ) * @@ -2393,7 +2708,7 @@ class SplObjectStorage implements Iterator, Countable { $this->index++; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splobjectstorage.count.php ) * @@ -2405,7 +2720,7 @@ class SplObjectStorage implements Iterator, Countable { return count($this->storage); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splobjectstorage.contains.php ) * @@ -2427,11 +2742,11 @@ class SplObjectStorage implements Iterator, Countable { return false; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splobjectstorage.attach.php ) * - * Adds an object inside the storage, and optionaly associate it to some + * Adds an object inside the storage, and optionally associate it to some * data. * * @obj mixed The object to add. @@ -2444,7 +2759,7 @@ class SplObjectStorage implements Iterator, Countable { } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splobjectstorage.detach.php ) * @@ -2510,7 +2825,7 @@ interface DebuggerCommand { public function onServer($proxy); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.directoryiterator.php ) * @@ -2521,6 +2836,15 @@ interface DebuggerCommand { class DirectoryIterator extends SplFileInfo implements Traversable, SeekableIterator { +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/directoryiterator.construct.php + * ) + * + * Constructs a new directory iterator from a path. + * + * @path mixed The path of the directory to traverse. + */ public function __construct($path) { if (!hphp_directoryiterator___construct($this, $path)) { throw new UnexpectedValueException( @@ -2528,7 +2852,7 @@ class DirectoryIterator extends SplFileInfo implements Traversable, } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/directoryiterator.current.php ) * @@ -2540,7 +2864,7 @@ class DirectoryIterator extends SplFileInfo implements Traversable, return hphp_directoryiterator_current($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/directoryiterator.key.php ) * @@ -2552,7 +2876,7 @@ class DirectoryIterator extends SplFileInfo implements Traversable, return hphp_directoryiterator_key($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/directoryiterator.next.php ) * @@ -2564,7 +2888,7 @@ class DirectoryIterator extends SplFileInfo implements Traversable, hphp_directoryiterator_next($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/directoryiterator.rewind.php ) * @@ -2576,7 +2900,7 @@ class DirectoryIterator extends SplFileInfo implements Traversable, hphp_directoryiterator_rewind($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/directoryiterator.seek.php ) * @@ -2590,11 +2914,20 @@ class DirectoryIterator extends SplFileInfo implements Traversable, hphp_directoryiterator_seek($this, $position); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/directoryiterator.tostring.php ) + * + * Get the file name of the current DirectoryIterator item. + * + * @return mixed Returns the file name of the current + * DirectoryIterator item. + */ public function __toString() { return hphp_directoryiterator___tostring($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/directoryiterator.valid.php ) * @@ -2607,7 +2940,7 @@ class DirectoryIterator extends SplFileInfo implements Traversable, return hphp_directoryiterator_valid($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/directoryiterator.isdot.php ) * @@ -2621,12 +2954,13 @@ class DirectoryIterator extends SplFileInfo implements Traversable, } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/class.recursivedirectoryiterator.php ) * - * ... + * The RecursiveDirectoryIterator provides an interface for iterating + * recursively over filesystem directories. * */ class RecursiveDirectoryIterator extends DirectoryIterator @@ -2639,6 +2973,23 @@ class RecursiveDirectoryIterator extends DirectoryIterator const KEY_AS_FILENAME = 0x00000100; const NEW_CURRENT_AND_KEY = 0x00000110; +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from + * http://php.net/manual/en/recursivedirectoryiterator.construct.php ) + * + * Constructs a RecursiveDirectoryIterator() for the provided path. + * + * @path mixed The path of the directory to be iterated over. + * @flags mixed Flags may be provided which will affect the behavior + * of some methods. A list of the flags can found under + * FilesystemIterator predefined constants. They can + * also be set later with + * FilesystemIterator::setFlags(). + * + * @return mixed Returns the newly created + * RecursiveDirectoryIterator. + */ function __construct($path, $flags = RecursiveDirectoryIterator::CURRENT_AS_FILEINFO) { if (!hphp_recursivedirectoryiterator___construct($this, $path, $flags)) { @@ -2651,7 +3002,7 @@ class RecursiveDirectoryIterator extends DirectoryIterator return hphp_recursivedirectoryiterator_current($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/recursivedirectoryiterator.key.php ) @@ -2663,7 +3014,7 @@ class RecursiveDirectoryIterator extends DirectoryIterator return hphp_recursivedirectoryiterator_key($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/recursivedirectoryiterator.next.php ) @@ -2675,7 +3026,7 @@ class RecursiveDirectoryIterator extends DirectoryIterator hphp_recursivedirectoryiterator_next($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/recursivedirectoryiterator.rewind.php ) @@ -2699,7 +3050,7 @@ class RecursiveDirectoryIterator extends DirectoryIterator return hphp_recursivedirectoryiterator_valid($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/recursivedirectoryiterator.haschildren.php ) @@ -2712,20 +3063,21 @@ class RecursiveDirectoryIterator extends DirectoryIterator return hphp_recursivedirectoryiterator_haschildren($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/recursivedirectoryiterator.getchildren.php ) * * - * @return mixed An iterator for the current entry, if it is a - * directory. + * @return mixed The filename, file information, or $this depending + * on the set flags. See the FilesystemIterator + * constants. */ function getChildren() { return hphp_recursivedirectoryiterator_getchildren($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/recursivedirectoryiterator.getsubpath.php ) @@ -2739,7 +3091,7 @@ class RecursiveDirectoryIterator extends DirectoryIterator return hphp_recursivedirectoryiterator_getsubpath($this); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/recursivedirectoryiterator.getsubpathname.php ) @@ -2758,7 +3110,7 @@ class RecursiveDirectoryIterator extends DirectoryIterator /////////////////////////////////////////////////////////////////////////////// // helpers -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.reflector.php ) * @@ -2767,21 +3119,36 @@ class RecursiveDirectoryIterator extends DirectoryIterator * */ interface Reflector { +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflector.tostring.php ) + * + * To string. WarningThis function is currently not documented; only its + * argument list is available. + * + */ public function __toString(); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/class.reflectionexception.php ) + * + * The ReflectionException class. + * + */ class ReflectionException extends Exception { } /////////////////////////////////////////////////////////////////////////////// // parameter -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.reflectionparameter.php ) * - * The ReflectionParameter class retrieves information about a function's - * or method's parameters. + * The ReflectionParameter class retrieves information about function's or + * method's parameters. * * To introspect function parameters, first create an instance of the * ReflectionFunction or ReflectionMethod classes and then use their @@ -2791,20 +3158,44 @@ class ReflectionException extends Exception { */ class ReflectionParameter implements Reflector { public $info; + public $name; +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from + * http://php.net/manual/en/reflectionparameter.construct.php ) + * + * Constructs a ReflectionParameter class. WarningThis function is + * currently not documented; only its argument list is available. + * + * @func mixed The function to reflect parameters from. + * @param mixed The parameter. + * + * @return mixed No value is returned. + */ public function __construct($func, $param) { if ($func && $param) { $params = $func->getParameters(); $this->info = $params[$param]->info; + $this->name = $this->info['name']; } } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflectionparameter.tostring.php + * ) + * + * To string. WarningThis function is currently not documented; only its + * argument list is available. + * + */ public function __toString() { // TODO return ""; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionparameter.export.php ) * @@ -2828,7 +3219,7 @@ class ReflectionParameter implements Reflector { print $str; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionparameter.getname.php * ) @@ -2841,7 +3232,7 @@ class ReflectionParameter implements Reflector { return $this->info['name']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionparameter.ispassedbyreference.php ) @@ -2856,7 +3247,7 @@ class ReflectionParameter implements Reflector { return isset($this->info['ref']); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionparameter.getdeclaringclass.php ) @@ -2873,6 +3264,16 @@ class ReflectionParameter implements Reflector { return new ReflectionClass($this->info['class']); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from + * http://php.net/manual/en/reflectionparameter.getdeclaringfunction.php ) + * + * Gets the declaring function. WarningThis function is currently not + * documented; only its argument list is available. + * + * @return mixed A ReflectionFunction object. + */ public function getDeclaringFunction() { if (empty($this->info['class'])) { return new ReflectionFunction($this->info['function']); @@ -2880,7 +3281,7 @@ class ReflectionParameter implements Reflector { return new ReflectionMethod($this->info['class'], $this->info['function']); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionparameter.getclass.php * ) @@ -2930,7 +3331,7 @@ class ReflectionParameter implements Reflector { return ''; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionparameter.isarray.php * ) @@ -2943,7 +3344,7 @@ class ReflectionParameter implements Reflector { return $this->info['type'] == 'array'; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionparameter.allowsnull.php ) @@ -2957,7 +3358,7 @@ class ReflectionParameter implements Reflector { return isset($this->info['nullable']); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionparameter.isoptional.php ) @@ -2970,7 +3371,7 @@ class ReflectionParameter implements Reflector { return array_key_exists('default', $this->info); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionparameter.isdefaultvalueavailable.php @@ -2985,7 +3386,7 @@ class ReflectionParameter implements Reflector { return array_key_exists('default', $this->info); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionparameter.getdefaultvalue.php ) @@ -3018,7 +3419,7 @@ class ReflectionParameter implements Reflector { return ''; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionparameter.getposition.php ) @@ -3082,7 +3483,7 @@ class ReflectionParameter implements Reflector { /////////////////////////////////////////////////////////////////////////////// -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/class.reflectionfunctionabstract.php ) @@ -3093,7 +3494,7 @@ class ReflectionParameter implements Reflector { class ReflectionFunctionAbstract { public $info; -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionfunctionabstract.getname.php ) @@ -3107,7 +3508,7 @@ class ReflectionFunctionAbstract { return $this->info['name']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionfunctionabstract.isinternal.php ) @@ -3126,15 +3527,36 @@ class ReflectionFunctionAbstract { return $this->info['closure']; } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from + * http://php.net/manual/en/reflectionfunctionabstract.isclosure.php ) + * + * Checks whether it's a closure. WarningThis function is currently not + * documented; only its argument list is available. + * + * @return mixed TRUE if it's a closure, otherwise FALSE + */ public function isClosure() { return !empty($this->info['is_closure']); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from + * http://php.net/manual/en/reflectionfunctionabstract.isgenerator.php ) + * + * WarningThis function is currently not documented; only its argument + * list is available. + * + * @return mixed Returns TRUE if the function is generator, FALSE if + * it is not or NULL on failure. + */ public function isGenerator() { return !empty($this->info['is_generator']); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionfunctionabstract.isuserdefined.php ) @@ -3149,7 +3571,7 @@ class ReflectionFunctionAbstract { return !isset($this->info['internal']); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionfunctionabstract.getfilename.php ) @@ -3163,7 +3585,7 @@ class ReflectionFunctionAbstract { return $this->info['file']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionfunctionabstract.getstartline.php ) @@ -3177,7 +3599,7 @@ class ReflectionFunctionAbstract { return $this->info['line1']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionfunctionabstract.getendline.php ) @@ -3185,14 +3607,14 @@ class ReflectionFunctionAbstract { * Get the ending line number. WarningThis function is currently not * documented; only its argument list is available. * - * @return mixed The ending line number of the user defined class, or - * FALSE if unknown. + * @return mixed The ending line number of the user defined function, + * or FALSE if unknown. */ public function getEndLine() { return $this->info['line2']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionfunctionabstract.getdoccomment.php ) @@ -3206,7 +3628,7 @@ class ReflectionFunctionAbstract { return $this->info['doc']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionfunctionabstract.getstaticvariables.php @@ -3221,7 +3643,7 @@ class ReflectionFunctionAbstract { return $this->info['static_variables']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionfunctionabstract.returnsreference.php @@ -3236,7 +3658,7 @@ class ReflectionFunctionAbstract { return isset($this->info['ref']); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionfunctionabstract.getparameters.php ) @@ -3252,12 +3674,13 @@ class ReflectionFunctionAbstract { foreach ($this->info['params'] as $name => $info) { $param = new ReflectionParameter(null, null); $param->info = $info; + $param->name = $info['name']; $ret[] = $param; } return $ret; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionfunctionabstract.getnumberofparameters.php @@ -3273,7 +3696,7 @@ class ReflectionFunctionAbstract { return count($this->info['params']); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionfunctionabstract.getnumberofrequiredparameters.php @@ -3308,20 +3731,28 @@ class ReflectionFunctionAbstract { /////////////////////////////////////////////////////////////////////////////// // function -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.reflectionfunction.php ) * * The ReflectionFunction class reports information about a function. * - * Parent class ReflectionFunctionAbstract has the same methods except - * invoke(), invokeArgs(), export() and isDisabled(). - * */ class ReflectionFunction extends ReflectionFunctionAbstract implements Reflector { const IS_DEPRECATED = 262144; +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflectionfunction.construct.php + * ) + * + * Constructs a ReflectionFunction object. + * + * @name mixed The name of the function to reflect or a closure. + * + * @return mixed No value is returned. + */ public function __construct($name) { if ($name instanceof Closure) { $this->info = hphp_get_closure_info($name); @@ -3333,17 +3764,26 @@ implements Reflector { } } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflectionfunction.tostring.php + * ) + * + * To string. + * + * @return mixed Returns ReflectionFunction::export()-like output for + * the function. + */ public function __toString() { //TODO return ""; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionfunction.export.php ) * - * Exports a Reflected function. WarningThis function is currently not - * documented; only its argument list is available. + * Exports a Reflected function. * * @name mixed The reflection to export. * @ret mixed Setting to TRUE will return the export, as opposed @@ -3363,12 +3803,13 @@ implements Reflector { print $str; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionfunction.invoke.php ) * * Invokes a reflected function. * + * @return mixed Returns the result of the invoked function call. */ public function invoke() { $args = func_get_args(); @@ -3380,15 +3821,17 @@ implements Reflector { return hphp_invoke($this->info['name'], $args); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionfunction.invokeargs.php ) * - * Invokes args. WarningThis function is currently not documented; only - * its argument list is available. + * Invokes the function and pass its arguments as array. * - * @args mixed The args to invoke. + * @args mixed The passed arguments to the function as an array, + * much like call_user_func_array() works. + * + * @return mixed Returns the result of the invoked function */ public function invokeArgs($args) { if (isset($this->info['closureobj'])) { @@ -3421,7 +3864,7 @@ implements Reflector { /////////////////////////////////////////////////////////////////////////////// // class -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.reflectionclass.php ) * @@ -3437,6 +3880,18 @@ class ReflectionClass implements Reflector { private $info = null; private static $fetched = array(); +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflectionclass.construct.php ) + * + * Constructs a new ReflectionClass object. WarningThis function is + * currently not documented; only its argument list is available. + * + * @name mixed Either a string containing the name of the class to + * reflect, or an object. + * + * @return mixed No value is returned. + */ public function __construct($name) { if (is_object($name)) { $name = get_class($name); @@ -3503,16 +3958,24 @@ class ReflectionClass implements Reflector { return $v && isset($v[$name]); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflectionclass.tostring.php ) + * + * Returns the string representation of the ReflectionClass object. + * + * @return mixed A string representation of this ReflectionClass + * instance. + */ public function __toString() { return ""; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.export.php ) * - * Exports a reflected class. WarningThis function is currently not - * documented; only its argument list is available. + * Exports a reflected class. * * @name mixed The reflection to export. * @ret mixed Setting to TRUE will return the export, as opposed @@ -3532,7 +3995,7 @@ class ReflectionClass implements Reflector { print $str; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.getname.php ) * @@ -3545,13 +4008,12 @@ class ReflectionClass implements Reflector { return $this->name; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.isinternal.php ) * - * Checks whether the class is internal, as opposed to user-defined. - * WarningThis function is currently not documented; only its argument list - * is available. + * Checks if the class is defined internally by an extension, or the core, + * as opposed to user-defined. * * @return mixed Returns TRUE on success or FALSE on failure. */ @@ -3559,7 +4021,7 @@ class ReflectionClass implements Reflector { return $this->check('internal'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.isuserdefined.php ) @@ -3572,13 +4034,12 @@ class ReflectionClass implements Reflector { return !$this->check('internal'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.isinstantiable.php ) * - * Checks if the class is instanciable. WarningThis function is currently - * not documented; only its argument list is available. + * Checks if the class is instantiable. * * @return mixed Returns TRUE on success or FALSE on failure. */ @@ -3586,7 +4047,7 @@ class ReflectionClass implements Reflector { return !$this->check('abstract'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.hasconstant.php * ) @@ -3601,7 +4062,7 @@ class ReflectionClass implements Reflector { return $this->test('constants', $name); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.hasmethod.php ) * @@ -3615,7 +4076,7 @@ class ReflectionClass implements Reflector { return $this->test('methods', strtolower($name)); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.hasproperty.php * ) @@ -3630,7 +4091,7 @@ class ReflectionClass implements Reflector { return $this->test('properties', $name); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.getfilename.php * ) @@ -3645,7 +4106,7 @@ class ReflectionClass implements Reflector { return $this->fetch('file'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.getstartline.php * ) @@ -3659,7 +4120,7 @@ class ReflectionClass implements Reflector { return $this->fetch('line1'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.getendline.php ) * @@ -3672,7 +4133,7 @@ class ReflectionClass implements Reflector { return $this->fetch('line2'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.getdoccomment.php ) @@ -3686,15 +4147,16 @@ class ReflectionClass implements Reflector { return $this->fetch('doc'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.getconstructor.php ) * - * Gets the constructor from a class. WarningThis function is currently - * not documented; only its argument list is available. + * Gets the constructor of the reflected class. * - * @return mixed A ReflectionMethod object. + * @return mixed A ReflectionMethod object reflecting the class' + * constructor, or NULL if the class has no + * constructor. */ public function getConstructor() { if ($this->hasMethod('__construct')) { @@ -3706,12 +4168,11 @@ class ReflectionClass implements Reflector { return null; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.getmethod.php ) * - * Gets a ReflectionMethod about a method. WarningThis function is - * currently not documented; only its argument list is available. + * Gets a ReflectionMethod for a class method. * * @name mixed The method name to reflect. * @@ -3737,21 +4198,24 @@ class ReflectionClass implements Reflector { return $ret; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.getmethods.php ) * - * Gets a list of methods. WarningThis function is currently not - * documented; only its argument list is available. + * Gets an array of methods for the class. * - * @filter mixed Any combination of ReflectionMethod::IS_STATIC, + * @filter mixed Filter the results to include only methods with + * certain attributes. Defaults to no filtering. + * + * Any combination of ReflectionMethod::IS_STATIC, * ReflectionMethod::IS_PUBLIC, * ReflectionMethod::IS_PROTECTED, * ReflectionMethod::IS_PRIVATE, * ReflectionMethod::IS_ABSTRACT, * ReflectionMethod::IS_FINAL. * - * @return mixed An array of methods. + * @return mixed An array of ReflectionMethod objects reflecting each + * method. */ public function getMethods($filter = 0xFFFF) { $ret = array(); @@ -3770,13 +4234,12 @@ class ReflectionClass implements Reflector { return $ret; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.getproperty.php * ) * - * Gets a property. WarningThis function is currently not documented; only - * its argument list is available. + * Gets a ReflectionProperty for a class's property. * * @name mixed The property name. * @@ -3796,13 +4259,17 @@ class ReflectionClass implements Reflector { return $ret; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.getproperties.php ) * * Retrieves reflected properties. * + * @filter mixed The optional filter, for filtering desired property + * types. It's configured using the ReflectionProperty + * constants, and defaults to all property types. + * * @return mixed An array of ReflectionProperty objects. */ public function getProperties($filter = 0xFFFF) { @@ -3819,7 +4286,7 @@ class ReflectionClass implements Reflector { return $ret; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.getconstants.php * ) @@ -3827,21 +4294,24 @@ class ReflectionClass implements Reflector { * Gets defined constants from a class. WarningThis function is currently * not documented; only its argument list is available. * - * @return mixed An array of constants. + * @return mixed An array of constants. Constant name in key, + * constant value in value. */ public function getConstants() { return $this->fetch('constants'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.getconstant.php * ) * - * Gets the defined constants. WarningThis function is currently not + * Gets the defined constant. WarningThis function is currently not * documented; only its argument list is available. * - * @name mixed + * @name mixed Name of the constant. + * + * @return mixed Value of the constant. */ public function getConstant($name) { $constants = $this->fetch('constants'); @@ -3852,7 +4322,7 @@ class ReflectionClass implements Reflector { return $constants[$name]; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.getinterfaces.php ) @@ -3874,6 +4344,17 @@ class ReflectionClass implements Reflector { return $ret; } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflectionclass.gettraits.php ) + * + * WarningThis function is currently not documented; only its argument + * list is available. + * + * @return mixed Returns an array with trait names in keys and + * instances of trait's ReflectionClass in values. + * Returns NULL in case of an error. + */ public function getTraits() { $ret = array(); foreach ($this->fetch('traits') as $name => $_) { @@ -3885,7 +4366,7 @@ class ReflectionClass implements Reflector { return $ret; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.getinterfacenames.php ) @@ -3906,6 +4387,17 @@ class ReflectionClass implements Reflector { return $ret; } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from + * http://php.net/manual/en/reflectionclass.gettraitnames.php ) + * + * WarningThis function is currently not documented; only its argument + * list is available. + * + * @return mixed Returns an array with trait names in values. Returns + * NULL in case of an error. + */ public function getTraitNames() { $ret = array(); foreach ($this->fetch('traits') as $name => $_) { @@ -3917,6 +4409,18 @@ class ReflectionClass implements Reflector { return $ret; } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from + * http://php.net/manual/en/reflectionclass.gettraitaliases.php ) + * + * WarningThis function is currently not documented; only its argument + * list is available. + * + * @return mixed Returns an array with new method names in keys and + * original names (in the format "TraitName::original") + * in values. Returns NULL in case of an error. + */ public function getTraitAliases() { $ret = array(); foreach ($this->fetch('trait_aliases') as $old_name => $new_name) { @@ -3925,13 +4429,12 @@ class ReflectionClass implements Reflector { return $ret; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.isinterface.php * ) * - * Checks whether the class is an interface. WarningThis function is - * currently not documented; only its argument list is available. + * Checks whether the class is an interface. * * @return mixed Returns TRUE on success or FALSE on failure. */ @@ -3939,7 +4442,7 @@ class ReflectionClass implements Reflector { return $this->check('interface'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.isabstract.php ) * @@ -3951,7 +4454,7 @@ class ReflectionClass implements Reflector { return $this->check('abstract'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.isfinal.php ) * @@ -3963,24 +4466,34 @@ class ReflectionClass implements Reflector { return $this->check('final'); } - public function isTrait() { - return $this->check('trait'); - } - -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * ( excerpt from http://php.net/manual/en/reflectionclass.getmodifiers.php - * ) + * ( excerpt from http://php.net/manual/en/reflectionclass.istrait.php ) * * WarningThis function is currently not documented; only its argument * list is available. * + * @return mixed Returns TRUE if this is a trait, FALSE otherwise. + * Returns NULL in case of an error. + */ + public function isTrait() { + return $this->check('trait'); + } + +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflectionclass.getmodifiers.php + * ) + * + * Returns a bitfield of the access modifiers for this class. + * + * @return mixed Returns bitmask of modifier constants. */ public function getModifiers() { return $this->fetch('modifiers'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.isinstance.php ) * @@ -3994,13 +4507,13 @@ class ReflectionClass implements Reflector { return hphp_instanceof($obj, $this->name); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.newinstance.php * ) * - * Creates a new cass instance of the class, the given arguments are - * passed to the class constructor. + * Creates a new instance of the class. The given arguments are passed to + * the class constructor. * */ public function newInstance() { @@ -4008,14 +4521,13 @@ class ReflectionClass implements Reflector { return hphp_create_object($this->name, $args); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.newinstanceargs.php ) * - * Creates a new cass instance of the class, the given arguments are - * passed to the class constructor. WarningThis function is currently not - * documented; only its argument list is available. + * Creates a new instance of the class, the given arguments are passed to + * the class constructor. * * @args mixed The parameters to be passed to the class constructor * as an array. @@ -4026,20 +4538,20 @@ class ReflectionClass implements Reflector { return hphp_create_object($this->name, array_values($args)); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from - * http://php.net/manual/en/reflectionclass.newinstancewithoutconstructor.php ) + * http://php.net/manual/en/reflectionclass.newinstancewithoutconstructor.php + * ) * * Creates a new instance of the class without invoking the constructor. * - * @return mixed Returns a new instance of the class. */ public function newInstanceWithoutConstructor() { return hphp_create_object_without_constructor($this->name); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.getparentclass.php ) @@ -4057,12 +4569,13 @@ class ReflectionClass implements Reflector { return new ReflectionClass($parent); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.issubclassof.php * ) * - * Checks if the class is a subclass of a specified class. + * Checks if the class is a subclass of a specified class or implements a + * specified interface. * * @cls mixed The class name being checked against. * @@ -4087,7 +4600,7 @@ class ReflectionClass implements Reflector { return $this->getParentClass()->isSubclassOf($cls); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.getstaticproperties.php ) @@ -4107,16 +4620,18 @@ class ReflectionClass implements Reflector { return $ret; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.getstaticpropertyvalue.php ) * - * Gets the static property values. WarningThis function is currently not - * documented; only its argument list is available. + * Gets the value of a static property on this class. * - * @name mixed + * @name mixed The name of the static property for which to return + * a value. * @default mixed + * + * @return mixed The value of the static property. */ public function getStaticPropertyValue($name, $default = null) { if ($this->hasProperty($name) && @@ -4126,7 +4641,7 @@ class ReflectionClass implements Reflector { return $default; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.setstaticpropertyvalue.php ) @@ -4143,15 +4658,24 @@ class ReflectionClass implements Reflector { hphp_set_static_property($this->name, $name, $value); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.getdefaultproperties.php ) * - * Gets default properties from a class. WarningThis function is currently - * not documented; only its argument list is available. + * Gets default properties from a class (including inherited properties). * - * @return mixed An array of default properties. + * This method only works for static properties when used on internal + * classes. The default value of a static class property can not be tracked + * when using this method on user defined classes. + * + * @return mixed An array of default properties, with the key being + * the name of the property and the value being the + * default value of the property or NULL if the + * property doesn't have a default value. The function + * does not distinguish between static and non static + * properties and does not take visibility modifiers + * into account. */ public function getDefaultProperties() { $ret = array(); @@ -4163,7 +4687,7 @@ class ReflectionClass implements Reflector { return $ret; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.isiterateable.php ) @@ -4176,7 +4700,7 @@ class ReflectionClass implements Reflector { return $this->isSubclassOf('ArrayAccess'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.implementsinterface.php ) @@ -4202,29 +4726,31 @@ class ReflectionClass implements Reflector { return false; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.getextension.php * ) * - * Gets an extensions ReflectionExtension object. WarningThis function is - * currently not documented; only its argument list is available. + * Gets a ReflectionExtension object for the extension which defined the + * class. * - * @return mixed A ReflectionExtension object. + * @return mixed A ReflectionExtension object representing the + * extension which defined the class, or NULL for + * user-defined classes. */ public function getExtension() { return $this->fetch('extension'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.getextensionname.php ) * - * Gets an extensions name. WarningThis function is currently not - * documented; only its argument list is available. + * Gets the name of the extension which defined the class. * - * @return mixed The extensions name. + * @return mixed The name of the extension which defined the class, + * or FALSE for user-defined classes. */ public function getExtensionName() { return $this->fetch('extension')->getName(); @@ -4248,25 +4774,28 @@ class ReflectionClass implements Reflector { return $this->fetch('attributes_rec'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * ( excerpt from http://www.php.net/manual/en/reflectionclass.innamespace.php ) + * ( excerpt from http://php.net/manual/en/reflectionclass.innamespace.php + * ) * - * Checks if in namespace + * Checks if this class is defined in a namespace. * - * @return bool Returns TRUE on success or FALSE on failure. + * @return mixed Returns TRUE on success or FALSE on failure. */ public function inNamespace() { return strrpos($this->getName(), '\\') !== false; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * ( excerpt from http://php.net/manual/en/reflectionclass.getnamespacename.php ) + * ( excerpt from + * http://php.net/manual/en/reflectionclass.getnamespacename.php ) * - * Gets namespace name + * Gets the namespace name. WarningThis function is currently not + * documented; only its argument list is available. * - * @return string The namespace name. + * @return mixed The namespace name. */ public function getNamespaceName() { $pos = strrpos($this->getName(), '\\'); @@ -4276,13 +4805,14 @@ class ReflectionClass implements Reflector { return substr($this->getName(), 0, $pos); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * ( excerpt from http://www.php.net/manual/en/reflectionclass.getshortname.php ) + * ( excerpt from http://php.net/manual/en/reflectionclass.getshortname.php + * ) * - * Gets short name + * Gets the short name of the class, the part without the namespace. * - * @return string The class short name. + * @return mixed The class short name. */ public function getShortName() { $pos = strrpos($this->getName(), '\\'); @@ -4297,7 +4827,7 @@ class ReflectionClass implements Reflector { /////////////////////////////////////////////////////////////////////////////// // object -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.reflectionobject.php ) * @@ -4305,7 +4835,7 @@ class ReflectionClass implements Reflector { * */ class ReflectionObject extends ReflectionClass { -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionobject.export.php ) * @@ -4334,11 +4864,11 @@ class ReflectionObject extends ReflectionClass { /////////////////////////////////////////////////////////////////////////////// // property -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.reflectionproperty.php ) * - * The ReflectionProperty class reports information about a classes + * The ReflectionProperty class reports information about classes * properties. * */ @@ -4352,6 +4882,19 @@ class ReflectionProperty implements Reflector { public $name; public $class; +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflectionproperty.construct.php + * ) + * + * WarningThis function is currently not documented; only its argument + * list is available. + * + * @cls mixed The class name, that contains the property. + * @name mixed The name of the property being reflected. + * + * @return mixed No value is returned. + */ public function __construct($cls, $name) { if ($cls && $name) { if (!is_object($cls)) { @@ -4368,11 +4911,20 @@ class ReflectionProperty implements Reflector { } } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflectionproperty.tostring.php + * ) + * + * To string. WarningThis function is currently not documented; only its + * argument list is available. + * + */ public function __toString() { return ""; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionproperty.export.php ) * @@ -4399,7 +4951,7 @@ class ReflectionProperty implements Reflector { print $str; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionproperty.getname.php ) * @@ -4412,7 +4964,7 @@ class ReflectionProperty implements Reflector { return $this->info['name']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionproperty.ispublic.php * ) @@ -4425,7 +4977,7 @@ class ReflectionProperty implements Reflector { return $this->info['access'] == 'public'; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionproperty.isprivate.php * ) @@ -4438,7 +4990,7 @@ class ReflectionProperty implements Reflector { return $this->info['access'] == 'private'; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionproperty.isprotected.php ) @@ -4451,7 +5003,7 @@ class ReflectionProperty implements Reflector { return $this->info['access'] == 'protected'; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionproperty.isstatic.php * ) @@ -4464,7 +5016,7 @@ class ReflectionProperty implements Reflector { return isset($this->info['static']); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionproperty.isdefault.php * ) @@ -4478,7 +5030,7 @@ class ReflectionProperty implements Reflector { return $this->info['default']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionproperty.setaccessible.php ) @@ -4486,13 +5038,15 @@ class ReflectionProperty implements Reflector { * Sets a property to be accessible. For example, it may allow protected * and private properties to be accessed. * + * @accessible mixed TRUE to allow accessibility, or FALSE. + * * @return mixed No value is returned. */ public function setAccessible($accessible) { throw new ReflectionException(__METHOD__." is not supported"); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionproperty.getmodifiers.php ) @@ -4506,15 +5060,18 @@ class ReflectionProperty implements Reflector { return $this->info['modifiers']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionproperty.getvalue.php * ) * - * Gets the properties value. WarningThis function is currently not - * documented; only its argument list is available. + * Gets the properties value. * - * @obj mixed The object being reflected. + * @obj mixed If the property is non-static an object must be + * provided to fetch the property from. If you want to + * fetch the default property without providing an + * object use ReflectionClass::getDefaultProperties() + * instead. * * @return mixed The current value of the property. */ @@ -4530,15 +5087,17 @@ class ReflectionProperty implements Reflector { return null; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionproperty.setvalue.php * ) * - * Sets (changes) a properties value. WarningThis function is currently - * not documented; only its argument list is available. + * Sets (changes) the property's value. * - * @obj mixed The object name. + * @obj mixed If the property is non-static an object must be + * provided to change the property on. If the property + * is static this parameter is left out and only value + * needs to be provided. * @value mixed The new value. * * @return mixed No value is returned. @@ -4553,7 +5112,7 @@ class ReflectionProperty implements Reflector { } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionproperty.getdeclaringclass.php ) @@ -4570,7 +5129,7 @@ class ReflectionProperty implements Reflector { return new ReflectionClass($this->info['class']); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionproperty.getdoccomment.php ) @@ -4595,7 +5154,7 @@ class ReflectionProperty implements Reflector { /////////////////////////////////////////////////////////////////////////////// // method -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.reflectionmethod.php ) * @@ -4614,6 +5173,18 @@ implements Reflector { public $name; public $class; +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflectionmethod.construct.php ) + * + * Constructs a new ReflectionMethod. + * + * @cls mixed Classname or object (instance of the class) that + * contains the method. + * @name mixed Name of the method. + * + * @return mixed No value is returned. + */ public function __construct($cls, $name = '') { if (!$name && is_string($cls)) { $arr = explode('::', $cls); @@ -4634,12 +5205,21 @@ implements Reflector { } } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflectionmethod.tostring.php ) + * + * Returns the string representation of the Reflection method object. + * + * @return mixed A string representation of this ReflectionMethod + * instance. + */ public function __toString() { //TODO return ""; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionmethod.export.php ) * @@ -4670,14 +5250,14 @@ implements Reflector { print $str; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionmethod.invoke.php ) * * Invokes a reflected method. * - * @obj mixed The object to invoke the method on. In case of - * static methods, you can pass null to this parameter. + * @obj mixed The object to invoke the method on. For static + * methods, pass null to this parameter. * * @return mixed Returns the method result. */ @@ -4688,12 +5268,12 @@ implements Reflector { $args); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionmethod.invokeargs.php * ) * - * Invoke arguments. + * Invokes the reflected method and pass its arguments as array. * * @obj mixed The object to invoke the method on. In case of * static methods, you can pass null to this parameter. @@ -4707,7 +5287,7 @@ implements Reflector { array_values($args)); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionmethod.isfinal.php ) * @@ -4719,7 +5299,7 @@ implements Reflector { return isset($this->info['final']); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionmethod.isabstract.php * ) @@ -4732,7 +5312,7 @@ implements Reflector { return isset($this->info['abstract']); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionmethod.ispublic.php ) * @@ -4744,7 +5324,7 @@ implements Reflector { return $this->info['access'] == "public"; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionmethod.isprivate.php ) * @@ -4757,7 +5337,7 @@ implements Reflector { return $this->info['access'] == "private"; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionmethod.isprotected.php * ) @@ -4770,7 +5350,7 @@ implements Reflector { return $this->info['access'] == "protected"; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionmethod.isstatic.php ) * @@ -4782,7 +5362,7 @@ implements Reflector { return isset($this->info['static']); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionmethod.isconstructor.php ) @@ -4795,7 +5375,7 @@ implements Reflector { return isset($this->info['constructor']); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionmethod.isdestructor.php ) @@ -4808,33 +5388,37 @@ implements Reflector { return $this->getName() == '__destruct'; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionmethod.getmodifiers.php ) * - * Gets the method modifiers. + * Returns a bitfield of the access modifiers for this method. * * @return mixed A numeric representation of the modifiers. The * modifiers are listed below. The actual meanings of * these modifiers are described in the predefined - * constants. ReflectionMethod modifiers value constant - * 1 ReflectionMethod::IS_STATIC 2 - * ReflectionMethod::IS_ABSTRACT 4 - * ReflectionMethod::IS_FINAL 256 - * ReflectionMethod::IS_PUBLIC 512 - * ReflectionMethod::IS_PROTECTED 1024 - * ReflectionMethod::IS_PRIVATE + * constants. */ public function getModifiers() { return $this->info['modifiers']; } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflectionmethod.getclosure.php + * ) + * + * WarningThis function is currently not documented; only its argument + * list is available. + * + * @return mixed Returns Closure. Returns NULL in case of an error. + */ public function getClosure() { return $this->info['closure']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionmethod.getdeclaringclass.php ) @@ -4892,7 +5476,7 @@ implements Reflector { /////////////////////////////////////////////////////////////////////////////// // extension -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.reflectionextension.php ) * @@ -4903,15 +5487,37 @@ class ReflectionExtension implements Reflector { private $name; private $info; +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from + * http://php.net/manual/en/reflectionextension.construct.php ) + * + * Construct a ReflectionExtension object. + * + * @name mixed Name of the extension. + * + * @return mixed A ReflectionExtension object. + */ public function __construct($name) { $this->info = hphp_get_extension_info($name); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflectionextension.tostring.php + * ) + * + * Exports a reflected extension and returns it as a string. This is the + * same as the ReflectionExtension::export() with the return set to TRUE. + * + * @return mixed Returns the exported extension as a string, in the + * same way as the ReflectionExtension::export(). + */ public function __toString() { return ""; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionextension.export.php ) * @@ -4936,7 +5542,7 @@ class ReflectionExtension implements Reflector { print $str; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionextension.getname.php * ) @@ -4949,7 +5555,7 @@ class ReflectionExtension implements Reflector { return $this->info['name']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionextension.getversion.php ) @@ -4962,7 +5568,7 @@ class ReflectionExtension implements Reflector { return $this->info['version']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionextension.getfunctions.php ) @@ -4978,7 +5584,7 @@ class ReflectionExtension implements Reflector { return $this->info['functions']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionextension.getconstants.php ) @@ -4991,7 +5597,7 @@ class ReflectionExtension implements Reflector { return $this->info['constants']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionextension.getinientries.php ) @@ -5005,7 +5611,7 @@ class ReflectionExtension implements Reflector { return $this->info['ini']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionextension.getclasses.php ) @@ -5020,7 +5626,7 @@ class ReflectionExtension implements Reflector { return $this->info['classes']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionextension.getclassnames.php ) @@ -5039,11 +5645,11 @@ class ReflectionExtension implements Reflector { return $ret; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionextension.info.php ) * - * Gets information about an extension. + * Prints out the " phpinfo()" snippet for the given extension. * * @return mixed Information about the extension. */ @@ -6181,7 +6787,7 @@ interface Awaitable { public function getWaitHandle(); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.arrayobject.php ) * @@ -6198,7 +6804,7 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, private $flags; private $iteratorClass; -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayobject.construct.php ) * @@ -6213,19 +6819,22 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, * * @return mixed Returns an ArrayObject object on success. */ - public function __construct($input = array(), + public function __construct($input = null, int $flags = 0, string $iterator_class = "ArrayIterator") { + if (!$input) { + $input = array(); + } $this->storage = $input; $this->flags = $flags; $this->iteratorClass = $iterator_class; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayobject.append.php ) * - * Appends a new value as the last element. Note: + * Appends a new value as the last element. * * This method cannot be called when the ArrayObject was constructed from * an object. Use ArrayObject::offsetSet() instead. @@ -6244,9 +6853,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, $this->storage[] = $value; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.asort.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.asort.php ) * * Sorts the entries such that the keys maintain their correlation with * the entries they are associated with. This is used mainly when sorting @@ -6258,14 +6867,13 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, return asort($this->storage); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.count.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.count.php ) * * Get the number of public properties in the ArrayObject. * * @return mixed The number of public properties in the ArrayObject. - * Note: * * When the ArrayObject is constructed from an array * all properties are public. @@ -6274,9 +6882,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, return count($this->storage); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.exchangearray.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.exchangearray.php ) * * Exchange the current array with another array or object. * @@ -6291,9 +6899,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, return $old; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.getarraycopy.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.getarraycopy.php ) * * Exports the ArrayObject to an array. * @@ -6305,9 +6913,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, return (array) $this->storage; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.getflags.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.getflags.php ) * * Gets the behavior flags of the ArrayObject. See the * ArrayObject::setFlags method for a list of the available flags. @@ -6318,9 +6926,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, return $this->flags; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.getiterator.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.getiterator.php ) * * Create a new iterator from an ArrayObject instance. * @@ -6331,9 +6939,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, return new $class($this->storage, $this->flags); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.getiteratorclass.php + * ( excerpt from http://php.net/manual/en/arrayobject.getiteratorclass.php * ) * * Gets the class name of the array iterator that is used by @@ -6346,9 +6954,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, return $this->iteratorClass; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.ksort.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.ksort.php ) * * Sorts the entries by key, maintaining key to entry correlations. This * is useful mainly for associative arrays. @@ -6359,9 +6967,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, return ksort($this->storage); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.natcasesort.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.natcasesort.php ) * * This method is a case insensitive version of ArrayObject::natsort. * @@ -6375,15 +6983,15 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, return natcasesort($this->storage); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.natsort.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.natsort.php ) * * This method implements a sort algorithm that orders alphanumeric * strings in the way a human being would while maintaining key/value * associations. This is described as a "natural ordering". An example of * the difference between this algorithm and the regular computer string - * sorting algorithms(used in ArrayObject::asort) method can be seen in + * sorting algorithms (used in ArrayObject::asort) method can be seen in * the example below. * * @return mixed No value is returned. @@ -6392,9 +7000,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, return natsort($this->storage); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.offsetexists.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.offsetexists.php ) * * * @index mixed The index being checked. @@ -6409,9 +7017,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.offsetget.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.offsetget.php ) * * * @index mixed The index with the value. @@ -6427,9 +7035,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.offsetset.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.offsetset.php ) * * Sets the value at the specified index to newval. * @@ -6447,9 +7055,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.offsetunset.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.offsetunset.php ) * * Unsets the value at the specified index. * @@ -6466,9 +7074,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.serialize.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.serialize.php ) * * Serializes an ArrayObject. WarningThis function is currently not * documented; only its argument list is available. @@ -6483,9 +7091,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, )); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.setflags.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.setflags.php ) * * Set the flags that change the behavior of the ArrayObject. * @@ -6506,9 +7114,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, $this->flags = $flags; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.setiteratorclass.php + * ( excerpt from http://php.net/manual/en/arrayobject.setiteratorclass.php * ) * * Sets the classname of the array iterator that is used by @@ -6524,9 +7132,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, $this->iteratorClass = $iterator_class; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.uasort.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.uasort.php ) * * This function sorts the entries such that keys maintain their * correlation with the entry that they are associated with, using a @@ -6549,9 +7157,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, uasort($this->storage, $cmp_function); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.uksort.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.uksort.php ) * * This function sorts the keys of the entries using a user-supplied * comparison function. The key to entry correlations will be maintained. @@ -6572,9 +7180,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, uksort($this->storage, $cmp_function); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.unserialize.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.unserialize.php ) * * Unserializes a serialized ArrayObject. WarningThis function is * currently not documented; only its argument list is available. diff --git a/hphp/idl/base.php b/hphp/idl/base.php index 08d6fd1d4..6278fb078 100644 --- a/hphp/idl/base.php +++ b/hphp/idl/base.php @@ -1166,7 +1166,7 @@ function phpnet_get_function_info($name, $clsname = 'function') { if (preg_match('#
]*>(.*?)'. '
(.*?)#s', $desc, $m)) { + if (preg_match_all('#(.*?)#s', $desc, $m)) { foreach ($m[1] as $param) { $ret['param_names'][] = phpnet_clean($param); } diff --git a/hphp/idl/sysdoc.php b/hphp/idl/sysdoc.php index 71b63fdd7..e8f48efa3 100644 --- a/hphp/idl/sysdoc.php +++ b/hphp/idl/sysdoc.php @@ -19,7 +19,8 @@ for ($i = 0; $i < count($lines) - 1; $i++) { $line = $lines[++$i]; } - if (preg_match('/^\s*(?:class|interface)\s+(\w+)/', $line, $m)) { + if (preg_match('/^\s*(?:abstract\s+)?(?:class|interface)\s+(\w+)/', + $line, $m)) { $class = $m[1]; $info['name'] = $class; $doc = phpnet_get_class_desc($class); diff --git a/hphp/system/classes/arrayaccess.php b/hphp/system/classes/arrayaccess.php index 27df3a9bb..43095d84a 100644 --- a/hphp/system/classes/arrayaccess.php +++ b/hphp/system/classes/arrayaccess.php @@ -1,6 +1,6 @@ storage = $input; $this->flags = $flags; $this->iteratorClass = $iterator_class; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayobject.append.php ) * - * Appends a new value as the last element. Note: + * Appends a new value as the last element. * * This method cannot be called when the ArrayObject was constructed from * an object. Use ArrayObject::offsetSet() instead. @@ -63,9 +66,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, $this->storage[] = $value; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.asort.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.asort.php ) * * Sorts the entries such that the keys maintain their correlation with * the entries they are associated with. This is used mainly when sorting @@ -77,14 +80,13 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, return asort($this->storage); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.count.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.count.php ) * * Get the number of public properties in the ArrayObject. * * @return mixed The number of public properties in the ArrayObject. - * Note: * * When the ArrayObject is constructed from an array * all properties are public. @@ -93,9 +95,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, return count($this->storage); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.exchangearray.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.exchangearray.php ) * * Exchange the current array with another array or object. * @@ -110,9 +112,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, return $old; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.getarraycopy.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.getarraycopy.php ) * * Exports the ArrayObject to an array. * @@ -124,9 +126,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, return (array) $this->storage; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.getflags.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.getflags.php ) * * Gets the behavior flags of the ArrayObject. See the * ArrayObject::setFlags method for a list of the available flags. @@ -137,9 +139,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, return $this->flags; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.getiterator.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.getiterator.php ) * * Create a new iterator from an ArrayObject instance. * @@ -150,9 +152,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, return new $class($this->storage, $this->flags); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.getiteratorclass.php + * ( excerpt from http://php.net/manual/en/arrayobject.getiteratorclass.php * ) * * Gets the class name of the array iterator that is used by @@ -165,9 +167,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, return $this->iteratorClass; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.ksort.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.ksort.php ) * * Sorts the entries by key, maintaining key to entry correlations. This * is useful mainly for associative arrays. @@ -178,9 +180,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, return ksort($this->storage); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.natcasesort.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.natcasesort.php ) * * This method is a case insensitive version of ArrayObject::natsort. * @@ -194,15 +196,15 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, return natcasesort($this->storage); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.natsort.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.natsort.php ) * * This method implements a sort algorithm that orders alphanumeric * strings in the way a human being would while maintaining key/value * associations. This is described as a "natural ordering". An example of * the difference between this algorithm and the regular computer string - * sorting algorithms(used in ArrayObject::asort) method can be seen in + * sorting algorithms (used in ArrayObject::asort) method can be seen in * the example below. * * @return mixed No value is returned. @@ -211,9 +213,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, return natsort($this->storage); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.offsetexists.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.offsetexists.php ) * * * @index mixed The index being checked. @@ -228,9 +230,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.offsetget.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.offsetget.php ) * * * @index mixed The index with the value. @@ -246,9 +248,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.offsetset.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.offsetset.php ) * * Sets the value at the specified index to newval. * @@ -266,9 +268,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.offsetunset.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.offsetunset.php ) * * Unsets the value at the specified index. * @@ -285,9 +287,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.serialize.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.serialize.php ) * * Serializes an ArrayObject. WarningThis function is currently not * documented; only its argument list is available. @@ -302,9 +304,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, )); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.setflags.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.setflags.php ) * * Set the flags that change the behavior of the ArrayObject. * @@ -325,9 +327,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, $this->flags = $flags; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.setiteratorclass.php + * ( excerpt from http://php.net/manual/en/arrayobject.setiteratorclass.php * ) * * Sets the classname of the array iterator that is used by @@ -343,9 +345,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, $this->iteratorClass = $iterator_class; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.uasort.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.uasort.php ) * * This function sorts the entries such that keys maintain their * correlation with the entry that they are associated with, using a @@ -368,9 +370,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, uasort($this->storage, $cmp_function); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.uksort.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.uksort.php ) * * This function sorts the keys of the entries using a user-supplied * comparison function. The key to entry correlations will be maintained. @@ -391,9 +393,9 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, uksort($this->storage, $cmp_function); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * * excerpt from http://php.net/manual/en/arrayobject.unserialize.php ) + * ( excerpt from http://php.net/manual/en/arrayobject.unserialize.php ) * * Unserializes a serialized ArrayObject. WarningThis function is * currently not documented; only its argument list is available. diff --git a/hphp/system/classes/directory.php b/hphp/system/classes/directory.php index 15a37b650..8130cb771 100644 --- a/hphp/system/classes/directory.php +++ b/hphp/system/classes/directory.php @@ -1,5 +1,13 @@ inited = true; } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/exception.construct.php ) + * + * Constructs the Exception. + * + * @message mixed The Exception message to throw. + * @code mixed The Exception code. + * @previous mixed The previous exception used for the exception + * chaining. + */ function __construct($message = '', $code = 0, Exception $previous = null) { $this->message = $message; $this->code = $code; $this->previous = $previous; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/exception.getmessage.php ) * @@ -50,13 +61,15 @@ class Exception { return $this->message; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/exception.getprevious.php ) * - * Returns the previous Exception. + * Returns previous Exception (the third parameter of + * Exception::__construct()). * - * @return mixed Returns the previous Exception if available or NULL otherwise. + * @return mixed Returns the previous Exception if available or NULL + * otherwise. */ final function getPrevious() { return $this->previous; @@ -76,45 +89,47 @@ class Exception { $cur->setPrevious($previous); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/exception.getcode.php ) * * Returns the Exception code. * - * @return mixed Returns the Exception code as a integer. + * @return mixed Returns the exception code as integer in Exception + * but possibly as other type in Exception descendants + * (for example as string in PDOException). */ function getCode() { return $this->code; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/exception.getfile.php ) * - * Get the name of the file the exception was thrown from. + * Get the name of the file the exception was created. * * @return mixed Returns the filename in which the exception was - * thrown. + * created. */ final function getFile() { return $this->file; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/exception.getline.php ) * - * Returns line number where the exception was thrown. + * Get line number where the exception was created. * * @return mixed Returns the line number where the exception was - * thrown. + * created. */ final function getLine() { return $this->line; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/exception.gettrace.php ) * @@ -126,7 +141,7 @@ class Exception { return $this->trace; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/exception.gettraceasstring.php ) * @@ -152,6 +167,14 @@ class Exception { /* Overrideable */ // formated string for display +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/exception.tostring.php ) + * + * Returns the string representation of the exception. + * + * @return mixed Returns the string representation of the exception. + */ function __toString() { return "exception '" . get_class($this) . "' with message '" . $this->getMessage() . "' in " . $this->getFile() . ":" . @@ -187,122 +210,130 @@ class Exception { } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.logicexception.php ) * - * Exception thrown if a logic expression is invalid + * Exception that represents error in the program logic. This kind of + * exceptions should directly lead to a fix in your code. * */ class LogicException extends Exception {} -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/class.badfunctioncallexception.php ) * * Exception thrown if a callback refers to an undefined function or if - * some arguments are missing + * some arguments are missing. * */ class BadFunctionCallException extends LogicException {} -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.badmethodcallexception.php * ) * * Exception thrown if a callback refers to an undefined method or if some - * arguments are missing + * arguments are missing. * */ class BadMethodCallException extends BadFunctionCallException {} -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.domainexception.php ) * * Exception thrown if a value does not adhere to a defined valid data - * domain + * domain. * */ class DomainException extends LogicException {} -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/class.invalidargumentexception.php ) * - * Exception thrown if an argument does not match with the expected value + * Exception thrown if an argument does not match with the expected value. * */ class InvalidArgumentException extends LogicException {} -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.lengthexception.php ) * - * Exception thrown if a length is invalid + * Exception thrown if a length is invalid. * */ class LengthException extends LogicException {} -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.outofrangeexception.php ) * - * Exception thrown when a value does not match with a range + * Exception thrown when an illegal index was requested. This represents + * errors that should be detected at compile time. * */ class OutOfRangeException extends LogicException {} -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.runtimeexception.php ) * - * Exception thrown if an error which can only be found on runtime occurs + * Exception thrown if an error which can only be found on runtime occurs. * */ class RuntimeException extends Exception {} -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.outofboundsexception.php ) * - * Exception thrown if a value is not a valid key + * Exception thrown if a value is not a valid key. This represents errors + * that cannot be detected at compile time. * */ class OutOfBoundsException extends RuntimeException {} -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.overflowexception.php ) * - * Exception thrown when you add an element into a full container + * Exception thrown when adding an element to a full container. * */ class OverflowException extends RuntimeException {} -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.rangeexception.php ) * - * Exception thrown when an invalid range is given. + * 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. * */ class RangeException extends RuntimeException {} -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.underflowexception.php ) * - * Exception thrown when you try to remove an element of an empty - * container + * Exception thrown when performing an invalid operation on an empty + * container, such as removing an element. * */ class UnderflowException extends RuntimeException {} -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( 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. * */ class UnexpectedValueException extends RuntimeException {} class InvalidOperationException extends RuntimeException {} -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.errorexception.php ) * @@ -311,6 +342,18 @@ class RuntimeException extends Exception {} */ class ErrorException extends Exception { protected $severity; +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/errorexception.construct.php ) + * + * Constructs the Exception. + * + * @message mixed The Exception message to throw. + * @code mixed The Exception code. + * @severity mixed The severity level of the exception. + * @filename mixed The filename where the exception is thrown. + * @lineno mixed The line number where the exception is thrown. + */ public function __construct($message = "", $code = 0, $severity = 0, $filename = null, $lineno = null) { parent::__construct($message, $code); @@ -323,7 +366,7 @@ class ErrorException extends Exception { } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/errorexception.getseverity.php ) * @@ -334,12 +377,31 @@ class ErrorException extends Exception { final public function getSeverity() { return $this->severity; } } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/class.domexception.php ) + * + * DOM operations raise exceptions under particular circumstances, i.e., + * when an operation is impossible to perform for logical reasons. + * + * See also Exceptions. + * + */ class DOMException extends Exception { public function __construct($message, $code) { parent::__construct($message, $code); } } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/class.pdoexception.php ) + * + * Represents an error raised by PDO. You should not throw a PDOException + * from your own code. See Exceptions for more information about Exceptions + * in PHP. + * + */ class PDOException extends Exception { public function __construct() { } diff --git a/hphp/system/classes/iterator.php b/hphp/system/classes/iterator.php index 9cee45eb6..f5013c783 100644 --- a/hphp/system/classes/iterator.php +++ b/hphp/system/classes/iterator.php @@ -1,6 +1,6 @@ arr = (array) $array; $this->flags = $flags; reset($this->arr); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.append.php ) * @@ -376,7 +430,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { $this->arr[] = $value; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.asort.php ) * @@ -389,7 +443,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { return asort($this->arr); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.count.php ) * @@ -397,13 +451,14 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { * properties in the object. WarningThis function is currently not * documented; only its argument list is available. * - * @return mixed The number. + * @return mixed The number of elements or public properties in the + * associated array or object, respectively. */ public function count() { return count($this->arr); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.current.php ) * @@ -415,7 +470,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { return current($this->arr); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.getarraycopy.php ) * @@ -429,7 +484,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { return $this->arr; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.getflags.php ) * @@ -442,7 +497,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { return $this->flags; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.key.php ) * @@ -454,7 +509,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { return key($this->arr); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.ksort.php ) * @@ -467,7 +522,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { return ksort($this->arr); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.natcasesort.php ) * @@ -481,7 +536,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { return natcasesort($this->arr); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.natsort.php ) * @@ -495,7 +550,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { return natsort($this->arr); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.next.php ) * @@ -507,7 +562,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { next($this->arr); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.offsetexists.php ) * @@ -522,7 +577,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { return isset($this->arr[$index]); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.offsetget.php ) * @@ -537,7 +592,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { return $this->arr[$index]; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.offsetset.php ) * @@ -553,7 +608,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { $this->arr[$index] = $newval; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.offsetunset.php ) * @@ -568,7 +623,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { unset($this->arr[$index]); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.rewind.php ) * @@ -580,7 +635,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { reset($this->arr); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.seek.php ) * @@ -598,7 +653,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.setflags.php ) * @@ -616,7 +671,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { $this->flags = $flags; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.uasort.php ) * @@ -633,7 +688,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { return uasort($this->arr, $cmp_function); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.uksort.php ) * @@ -650,7 +705,7 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { return uksort($this->arr, $cmp_function); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/arrayiterator.valid.php ) * @@ -663,10 +718,30 @@ class ArrayIterator implements ArrayAccess, SeekableIterator, Countable { } } -// http://www.php.net/~helly/php/ext/spl/iteratoriterator_8inc-source.html +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/class.iteratoriterator.php ) + * + * This iterator wrapper allows the conversion of anything that is + * Traversable into an Iterator. It is important to understand that most + * classes that do not implement Iterators have reasons as most likely they + * do not allow the full Iterator feature set. If so, techniques should be + * provided to prevent misuse, otherwise expect exceptions or fatal errors. + * + */ class IteratorIterator implements OuterIterator { private $iterator; +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/iteratoriterator.construct.php ) + * + * Creates an iterator from anything that is traversable. + * + * @iterator mixed The traversable iterator. + * + * @return mixed No value is returned. + */ public function __construct(Traversable $iterator) { if ($iterator instanceof IteratorAggregate) { $iterator = $iterator->getIterator(); @@ -679,26 +754,77 @@ class IteratorIterator implements OuterIterator { } } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from + * http://php.net/manual/en/iteratoriterator.getinneriterator.php ) + * + * Get the inner iterator. + * + * @return mixed The inner iterator as passed to + * IteratorIterator::__construct(). + */ public function getInnerIterator() { return $this->iterator; } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/iteratoriterator.valid.php ) + * + * Checks if the iterator is valid. + * + * @return mixed Returns TRUE if the iterator is valid, otherwise + * FALSE + */ public function valid() { return $this->iterator->valid(); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/iteratoriterator.key.php ) + * + * Get the key of the current element. + * + * @return mixed The key of the current element. + */ public function key() { return $this->iterator->key(); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/iteratoriterator.current.php ) + * + * Get the value of the current element. + * + * @return mixed The value of the current element. + */ public function current() { return $this->iterator->current(); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/iteratoriterator.next.php ) + * + * Forward to the next element. + * + * @return mixed No value is returned. + */ public function next() { return $this->iterator->next(); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/iteratoriterator.rewind.php ) + * + * Rewinds to the first element. + * + * @return mixed No value is returned. + */ public function rewind() { return $this->iterator->rewind(); } @@ -708,8 +834,7 @@ class IteratorIterator implements OuterIterator { } } -// http://www.php.net/~helly/php/ext/spl/filteriterator_8inc-source.html -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.filteriterator.php ) * @@ -721,15 +846,44 @@ class IteratorIterator implements OuterIterator { abstract class FilterIterator extends IteratorIterator { private $it; +// This doc comment block generated by idl/sysdoc.php +/** + * ( 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 + * documented; only its argument list is available. + * + * @it mixed The iterator that is being filtered. + * + * @return mixed The FilterIterator. + */ public function __construct(Iterator $it) { $this->it = $it; } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/filteriterator.rewind.php ) + * + * + * @return mixed No value is returned. + */ public function rewind() { $this->it->rewind(); $this->fetch(); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/filteriterator.accept.php ) + * + * Returns whether the current element of the iterator is acceptable + * through this filter. + * + * @return mixed TRUE if the current element is acceptable, otherwise + * FALSE. + */ abstract function accept(); private function fetch() { @@ -741,19 +895,48 @@ abstract class FilterIterator extends IteratorIterator { } } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/filteriterator.next.php ) + * + * + * @return mixed No value is returned. + */ public function next() { $this->it->next(); $this->fetch(); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/filteriterator.valid.php ) + * + * + * @return mixed TRUE if the current element is valid, otherwise + * FALSE + */ public function valid() { return $this->it->valid(); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/filteriterator.key.php ) + * + * + * @return mixed The current key. + */ public function key() { return $this->it->key(); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/filteriterator.current.php ) + * + * + * @return mixed The current element value. + */ public function current() { return $this->it->current(); } @@ -762,6 +945,14 @@ abstract class FilterIterator extends IteratorIterator { // disallow clone } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from + * http://php.net/manual/en/filteriterator.getinneriterator.php ) + * + * + * @return mixed The inner iterator. + */ public function getInnerIterator() { return $this->it; } @@ -771,7 +962,7 @@ abstract class FilterIterator extends IteratorIterator { } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.iteratoraggregate.php ) * @@ -779,7 +970,7 @@ abstract class FilterIterator extends IteratorIterator { * */ interface IteratorAggregate extends Traversable { -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/iteratoraggregate.getiterator.php ) @@ -798,10 +989,7 @@ interface Iterable extends IteratorAggregate { interface KeyedIterable extends Iterable, KeyedTraversable { } -/////////////////////////////////////////////////////////////////////////////// -// http://www.php.net/~helly/php/ext/spl/appenditerator_8inc-source.html - -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.appenditerator.php ) * @@ -811,16 +999,23 @@ interface KeyedIterable extends Iterable, KeyedTraversable { class AppendIterator implements OuterIterator { private $iterators; +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/appenditerator.construct.php ) + * + * Constructs an AppendIterator. + * + * @return mixed No value is returned. + */ function __construct() { $this->iterators = new ArrayIterator(array()); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/appenditerator.append.php ) * - * Appends an iterator. WarningThis function is currently not documented; - * only its argument list is available. + * Appends an iterator. * * @it mixed The iterator to append. * @@ -830,27 +1025,25 @@ class AppendIterator implements OuterIterator { $this->iterators->append($it); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/appenditerator.getinneriterator.php ) * - * Get an inner iterator WarningThis function is currently not documented; - * only its argument list is available. + * This method returns the current inner iterator. * - * @return mixed The current inner Iterator. + * @return mixed The current inner iterator, or NULL if there is not + * one. */ function getInnerIterator() { return $this->iterators->current(); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/appenditerator.rewind.php ) * - * Rewind to the first element of the first inner Iterator. WarningThis - * function is currently not documented; only its argument list is - * available. + * Rewind to the first element of the first inner Iterator. * * @return mixed No value is returned. */ @@ -861,25 +1054,24 @@ class AppendIterator implements OuterIterator { } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/appenditerator.valid.php ) * - * Checks validity of the current element. WarningThis function is - * currently not documented; only its argument list is available. + * Checks validity of the current element. * - * @return mixed Returns TRUE on success or FALSE on failure. + * @return mixed Returns TRUE if the current iteration is valid, + * FALSE otherwise. */ function valid() { return $this->iterators->valid() && $this->getInnerIterator()->valid(); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/appenditerator.current.php ) * - * Gets the current value. WarningThis function is currently not - * documented; only its argument list is available. + * Gets the current value. * * @return mixed The current value if it is valid or NULL otherwise. */ @@ -892,12 +1084,11 @@ class AppendIterator implements OuterIterator { $this->getInnerIterator()->current() : NULL; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/appenditerator.key.php ) * - * Get the current key WarningThis function is currently not documented; - * only its argument list is available. + * Get the current key. * * @return mixed The current key if it is valid or NULL otherwise. */ @@ -905,13 +1096,12 @@ class AppendIterator implements OuterIterator { return $this->iterators->valid() ? $this->getInnerIterator()->key() : NULL; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/appenditerator.next.php ) * * Moves to the next element. If this means to another Iterator then it - * rewinds that Iterator. WarningThis function is currently not documented; - * only its argument list is available. + * rewinds that Iterator. * * @return mixed No value is returned. */ diff --git a/hphp/system/classes/reflection.php b/hphp/system/classes/reflection.php index ed36d5985..aeab7403e 100644 --- a/hphp/system/classes/reflection.php +++ b/hphp/system/classes/reflection.php @@ -3,7 +3,7 @@ /////////////////////////////////////////////////////////////////////////////// // helpers -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.reflector.php ) * @@ -12,21 +12,36 @@ * */ interface Reflector { +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflector.tostring.php ) + * + * To string. WarningThis function is currently not documented; only its + * argument list is available. + * + */ public function __toString(); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/class.reflectionexception.php ) + * + * The ReflectionException class. + * + */ class ReflectionException extends Exception { } /////////////////////////////////////////////////////////////////////////////// // parameter -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.reflectionparameter.php ) * - * The ReflectionParameter class retrieves information about a function's - * or method's parameters. + * The ReflectionParameter class retrieves information about function's or + * method's parameters. * * To introspect function parameters, first create an instance of the * ReflectionFunction or ReflectionMethod classes and then use their @@ -38,6 +53,19 @@ class ReflectionParameter implements Reflector { public $info; public $name; +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from + * http://php.net/manual/en/reflectionparameter.construct.php ) + * + * Constructs a ReflectionParameter class. WarningThis function is + * currently not documented; only its argument list is available. + * + * @func mixed The function to reflect parameters from. + * @param mixed The parameter. + * + * @return mixed No value is returned. + */ public function __construct($func, $param) { if ($func && $param) { $params = $func->getParameters(); @@ -46,12 +74,21 @@ class ReflectionParameter implements Reflector { } } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflectionparameter.tostring.php + * ) + * + * To string. WarningThis function is currently not documented; only its + * argument list is available. + * + */ public function __toString() { // TODO return ""; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionparameter.export.php ) * @@ -75,7 +112,7 @@ class ReflectionParameter implements Reflector { print $str; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionparameter.getname.php * ) @@ -88,7 +125,7 @@ class ReflectionParameter implements Reflector { return $this->info['name']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionparameter.ispassedbyreference.php ) @@ -103,7 +140,7 @@ class ReflectionParameter implements Reflector { return isset($this->info['ref']); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionparameter.getdeclaringclass.php ) @@ -120,6 +157,16 @@ class ReflectionParameter implements Reflector { return new ReflectionClass($this->info['class']); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from + * http://php.net/manual/en/reflectionparameter.getdeclaringfunction.php ) + * + * Gets the declaring function. WarningThis function is currently not + * documented; only its argument list is available. + * + * @return mixed A ReflectionFunction object. + */ public function getDeclaringFunction() { if (empty($this->info['class'])) { return new ReflectionFunction($this->info['function']); @@ -127,7 +174,7 @@ class ReflectionParameter implements Reflector { return new ReflectionMethod($this->info['class'], $this->info['function']); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionparameter.getclass.php * ) @@ -177,7 +224,7 @@ class ReflectionParameter implements Reflector { return ''; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionparameter.isarray.php * ) @@ -190,7 +237,7 @@ class ReflectionParameter implements Reflector { return $this->info['type'] == 'array'; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionparameter.allowsnull.php ) @@ -204,7 +251,7 @@ class ReflectionParameter implements Reflector { return isset($this->info['nullable']); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionparameter.isoptional.php ) @@ -217,7 +264,7 @@ class ReflectionParameter implements Reflector { return array_key_exists('default', $this->info); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionparameter.isdefaultvalueavailable.php @@ -232,7 +279,7 @@ class ReflectionParameter implements Reflector { return array_key_exists('default', $this->info); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionparameter.getdefaultvalue.php ) @@ -265,7 +312,7 @@ class ReflectionParameter implements Reflector { return ''; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionparameter.getposition.php ) @@ -329,7 +376,7 @@ class ReflectionParameter implements Reflector { /////////////////////////////////////////////////////////////////////////////// -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/class.reflectionfunctionabstract.php ) @@ -340,7 +387,7 @@ class ReflectionParameter implements Reflector { class ReflectionFunctionAbstract { public $info; -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionfunctionabstract.getname.php ) @@ -354,7 +401,7 @@ class ReflectionFunctionAbstract { return $this->info['name']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionfunctionabstract.isinternal.php ) @@ -373,15 +420,36 @@ class ReflectionFunctionAbstract { return $this->info['closure']; } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from + * http://php.net/manual/en/reflectionfunctionabstract.isclosure.php ) + * + * Checks whether it's a closure. WarningThis function is currently not + * documented; only its argument list is available. + * + * @return mixed TRUE if it's a closure, otherwise FALSE + */ public function isClosure() { return !empty($this->info['is_closure']); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from + * http://php.net/manual/en/reflectionfunctionabstract.isgenerator.php ) + * + * WarningThis function is currently not documented; only its argument + * list is available. + * + * @return mixed Returns TRUE if the function is generator, FALSE if + * it is not or NULL on failure. + */ public function isGenerator() { return !empty($this->info['is_generator']); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionfunctionabstract.isuserdefined.php ) @@ -396,7 +464,7 @@ class ReflectionFunctionAbstract { return !isset($this->info['internal']); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionfunctionabstract.getfilename.php ) @@ -410,7 +478,7 @@ class ReflectionFunctionAbstract { return $this->info['file']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionfunctionabstract.getstartline.php ) @@ -424,7 +492,7 @@ class ReflectionFunctionAbstract { return $this->info['line1']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionfunctionabstract.getendline.php ) @@ -432,14 +500,14 @@ class ReflectionFunctionAbstract { * Get the ending line number. WarningThis function is currently not * documented; only its argument list is available. * - * @return mixed The ending line number of the user defined class, or - * FALSE if unknown. + * @return mixed The ending line number of the user defined function, + * or FALSE if unknown. */ public function getEndLine() { return $this->info['line2']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionfunctionabstract.getdoccomment.php ) @@ -453,7 +521,7 @@ class ReflectionFunctionAbstract { return $this->info['doc']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionfunctionabstract.getstaticvariables.php @@ -468,7 +536,7 @@ class ReflectionFunctionAbstract { return $this->info['static_variables']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionfunctionabstract.returnsreference.php @@ -483,7 +551,7 @@ class ReflectionFunctionAbstract { return isset($this->info['ref']); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionfunctionabstract.getparameters.php ) @@ -505,7 +573,7 @@ class ReflectionFunctionAbstract { return $ret; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionfunctionabstract.getnumberofparameters.php @@ -521,7 +589,7 @@ class ReflectionFunctionAbstract { return count($this->info['params']); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionfunctionabstract.getnumberofrequiredparameters.php @@ -556,20 +624,28 @@ class ReflectionFunctionAbstract { /////////////////////////////////////////////////////////////////////////////// // function -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.reflectionfunction.php ) * * The ReflectionFunction class reports information about a function. * - * Parent class ReflectionFunctionAbstract has the same methods except - * invoke(), invokeArgs(), export() and isDisabled(). - * */ class ReflectionFunction extends ReflectionFunctionAbstract implements Reflector { const IS_DEPRECATED = 262144; +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflectionfunction.construct.php + * ) + * + * Constructs a ReflectionFunction object. + * + * @name mixed The name of the function to reflect or a closure. + * + * @return mixed No value is returned. + */ public function __construct($name) { if ($name instanceof Closure) { $this->info = hphp_get_closure_info($name); @@ -581,17 +657,26 @@ implements Reflector { } } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflectionfunction.tostring.php + * ) + * + * To string. + * + * @return mixed Returns ReflectionFunction::export()-like output for + * the function. + */ public function __toString() { //TODO return ""; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionfunction.export.php ) * - * Exports a Reflected function. WarningThis function is currently not - * documented; only its argument list is available. + * Exports a Reflected function. * * @name mixed The reflection to export. * @ret mixed Setting to TRUE will return the export, as opposed @@ -611,12 +696,13 @@ implements Reflector { print $str; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionfunction.invoke.php ) * * Invokes a reflected function. * + * @return mixed Returns the result of the invoked function call. */ public function invoke() { $args = func_get_args(); @@ -628,15 +714,17 @@ implements Reflector { return hphp_invoke($this->info['name'], $args); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionfunction.invokeargs.php ) * - * Invokes args. WarningThis function is currently not documented; only - * its argument list is available. + * Invokes the function and pass its arguments as array. * - * @args mixed The args to invoke. + * @args mixed The passed arguments to the function as an array, + * much like call_user_func_array() works. + * + * @return mixed Returns the result of the invoked function */ public function invokeArgs($args) { if (isset($this->info['closureobj'])) { @@ -669,7 +757,7 @@ implements Reflector { /////////////////////////////////////////////////////////////////////////////// // class -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.reflectionclass.php ) * @@ -685,6 +773,18 @@ class ReflectionClass implements Reflector { private $info = null; private static $fetched = array(); +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflectionclass.construct.php ) + * + * Constructs a new ReflectionClass object. WarningThis function is + * currently not documented; only its argument list is available. + * + * @name mixed Either a string containing the name of the class to + * reflect, or an object. + * + * @return mixed No value is returned. + */ public function __construct($name) { if (is_object($name)) { $name = get_class($name); @@ -751,16 +851,24 @@ class ReflectionClass implements Reflector { return $v && isset($v[$name]); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflectionclass.tostring.php ) + * + * Returns the string representation of the ReflectionClass object. + * + * @return mixed A string representation of this ReflectionClass + * instance. + */ public function __toString() { return ""; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.export.php ) * - * Exports a reflected class. WarningThis function is currently not - * documented; only its argument list is available. + * Exports a reflected class. * * @name mixed The reflection to export. * @ret mixed Setting to TRUE will return the export, as opposed @@ -780,7 +888,7 @@ class ReflectionClass implements Reflector { print $str; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.getname.php ) * @@ -793,13 +901,12 @@ class ReflectionClass implements Reflector { return $this->name; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.isinternal.php ) * - * Checks whether the class is internal, as opposed to user-defined. - * WarningThis function is currently not documented; only its argument list - * is available. + * Checks if the class is defined internally by an extension, or the core, + * as opposed to user-defined. * * @return mixed Returns TRUE on success or FALSE on failure. */ @@ -807,7 +914,7 @@ class ReflectionClass implements Reflector { return $this->check('internal'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.isuserdefined.php ) @@ -820,13 +927,12 @@ class ReflectionClass implements Reflector { return !$this->check('internal'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.isinstantiable.php ) * - * Checks if the class is instanciable. WarningThis function is currently - * not documented; only its argument list is available. + * Checks if the class is instantiable. * * @return mixed Returns TRUE on success or FALSE on failure. */ @@ -834,7 +940,7 @@ class ReflectionClass implements Reflector { return !$this->check('abstract'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.hasconstant.php * ) @@ -849,7 +955,7 @@ class ReflectionClass implements Reflector { return $this->test('constants', $name); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.hasmethod.php ) * @@ -863,7 +969,7 @@ class ReflectionClass implements Reflector { return $this->test('methods', strtolower($name)); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.hasproperty.php * ) @@ -878,7 +984,7 @@ class ReflectionClass implements Reflector { return $this->test('properties', $name); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.getfilename.php * ) @@ -893,7 +999,7 @@ class ReflectionClass implements Reflector { return $this->fetch('file'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.getstartline.php * ) @@ -907,7 +1013,7 @@ class ReflectionClass implements Reflector { return $this->fetch('line1'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.getendline.php ) * @@ -920,7 +1026,7 @@ class ReflectionClass implements Reflector { return $this->fetch('line2'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.getdoccomment.php ) @@ -934,15 +1040,16 @@ class ReflectionClass implements Reflector { return $this->fetch('doc'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.getconstructor.php ) * - * Gets the constructor from a class. WarningThis function is currently - * not documented; only its argument list is available. + * Gets the constructor of the reflected class. * - * @return mixed A ReflectionMethod object. + * @return mixed A ReflectionMethod object reflecting the class' + * constructor, or NULL if the class has no + * constructor. */ public function getConstructor() { if ($this->hasMethod('__construct')) { @@ -954,12 +1061,11 @@ class ReflectionClass implements Reflector { return null; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.getmethod.php ) * - * Gets a ReflectionMethod about a method. WarningThis function is - * currently not documented; only its argument list is available. + * Gets a ReflectionMethod for a class method. * * @name mixed The method name to reflect. * @@ -985,21 +1091,24 @@ class ReflectionClass implements Reflector { return $ret; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.getmethods.php ) * - * Gets a list of methods. WarningThis function is currently not - * documented; only its argument list is available. + * Gets an array of methods for the class. * - * @filter mixed Any combination of ReflectionMethod::IS_STATIC, + * @filter mixed Filter the results to include only methods with + * certain attributes. Defaults to no filtering. + * + * Any combination of ReflectionMethod::IS_STATIC, * ReflectionMethod::IS_PUBLIC, * ReflectionMethod::IS_PROTECTED, * ReflectionMethod::IS_PRIVATE, * ReflectionMethod::IS_ABSTRACT, * ReflectionMethod::IS_FINAL. * - * @return mixed An array of methods. + * @return mixed An array of ReflectionMethod objects reflecting each + * method. */ public function getMethods($filter = 0xFFFF) { $ret = array(); @@ -1018,13 +1127,12 @@ class ReflectionClass implements Reflector { return $ret; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.getproperty.php * ) * - * Gets a property. WarningThis function is currently not documented; only - * its argument list is available. + * Gets a ReflectionProperty for a class's property. * * @name mixed The property name. * @@ -1044,13 +1152,17 @@ class ReflectionClass implements Reflector { return $ret; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.getproperties.php ) * * Retrieves reflected properties. * + * @filter mixed The optional filter, for filtering desired property + * types. It's configured using the ReflectionProperty + * constants, and defaults to all property types. + * * @return mixed An array of ReflectionProperty objects. */ public function getProperties($filter = 0xFFFF) { @@ -1067,7 +1179,7 @@ class ReflectionClass implements Reflector { return $ret; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.getconstants.php * ) @@ -1075,21 +1187,24 @@ class ReflectionClass implements Reflector { * Gets defined constants from a class. WarningThis function is currently * not documented; only its argument list is available. * - * @return mixed An array of constants. + * @return mixed An array of constants. Constant name in key, + * constant value in value. */ public function getConstants() { return $this->fetch('constants'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.getconstant.php * ) * - * Gets the defined constants. WarningThis function is currently not + * Gets the defined constant. WarningThis function is currently not * documented; only its argument list is available. * - * @name mixed + * @name mixed Name of the constant. + * + * @return mixed Value of the constant. */ public function getConstant($name) { $constants = $this->fetch('constants'); @@ -1100,7 +1215,7 @@ class ReflectionClass implements Reflector { return $constants[$name]; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.getinterfaces.php ) @@ -1122,6 +1237,17 @@ class ReflectionClass implements Reflector { return $ret; } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflectionclass.gettraits.php ) + * + * WarningThis function is currently not documented; only its argument + * list is available. + * + * @return mixed Returns an array with trait names in keys and + * instances of trait's ReflectionClass in values. + * Returns NULL in case of an error. + */ public function getTraits() { $ret = array(); foreach ($this->fetch('traits') as $name => $_) { @@ -1133,7 +1259,7 @@ class ReflectionClass implements Reflector { return $ret; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.getinterfacenames.php ) @@ -1154,6 +1280,17 @@ class ReflectionClass implements Reflector { return $ret; } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from + * http://php.net/manual/en/reflectionclass.gettraitnames.php ) + * + * WarningThis function is currently not documented; only its argument + * list is available. + * + * @return mixed Returns an array with trait names in values. Returns + * NULL in case of an error. + */ public function getTraitNames() { $ret = array(); foreach ($this->fetch('traits') as $name => $_) { @@ -1165,6 +1302,18 @@ class ReflectionClass implements Reflector { return $ret; } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from + * http://php.net/manual/en/reflectionclass.gettraitaliases.php ) + * + * WarningThis function is currently not documented; only its argument + * list is available. + * + * @return mixed Returns an array with new method names in keys and + * original names (in the format "TraitName::original") + * in values. Returns NULL in case of an error. + */ public function getTraitAliases() { $ret = array(); foreach ($this->fetch('trait_aliases') as $old_name => $new_name) { @@ -1173,13 +1322,12 @@ class ReflectionClass implements Reflector { return $ret; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.isinterface.php * ) * - * Checks whether the class is an interface. WarningThis function is - * currently not documented; only its argument list is available. + * Checks whether the class is an interface. * * @return mixed Returns TRUE on success or FALSE on failure. */ @@ -1187,7 +1335,7 @@ class ReflectionClass implements Reflector { return $this->check('interface'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.isabstract.php ) * @@ -1199,7 +1347,7 @@ class ReflectionClass implements Reflector { return $this->check('abstract'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.isfinal.php ) * @@ -1211,24 +1359,34 @@ class ReflectionClass implements Reflector { return $this->check('final'); } - public function isTrait() { - return $this->check('trait'); - } - -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * ( excerpt from http://php.net/manual/en/reflectionclass.getmodifiers.php - * ) + * ( excerpt from http://php.net/manual/en/reflectionclass.istrait.php ) * * WarningThis function is currently not documented; only its argument * list is available. * + * @return mixed Returns TRUE if this is a trait, FALSE otherwise. + * Returns NULL in case of an error. + */ + public function isTrait() { + return $this->check('trait'); + } + +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflectionclass.getmodifiers.php + * ) + * + * Returns a bitfield of the access modifiers for this class. + * + * @return mixed Returns bitmask of modifier constants. */ public function getModifiers() { return $this->fetch('modifiers'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.isinstance.php ) * @@ -1242,13 +1400,13 @@ class ReflectionClass implements Reflector { return hphp_instanceof($obj, $this->name); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.newinstance.php * ) * - * Creates a new cass instance of the class, the given arguments are - * passed to the class constructor. + * Creates a new instance of the class. The given arguments are passed to + * the class constructor. * */ public function newInstance() { @@ -1256,14 +1414,13 @@ class ReflectionClass implements Reflector { return hphp_create_object($this->name, $args); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.newinstanceargs.php ) * - * Creates a new cass instance of the class, the given arguments are - * passed to the class constructor. WarningThis function is currently not - * documented; only its argument list is available. + * Creates a new instance of the class, the given arguments are passed to + * the class constructor. * * @args mixed The parameters to be passed to the class constructor * as an array. @@ -1274,20 +1431,20 @@ class ReflectionClass implements Reflector { return hphp_create_object($this->name, array_values($args)); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from - * http://php.net/manual/en/reflectionclass.newinstancewithoutconstructor.php ) + * http://php.net/manual/en/reflectionclass.newinstancewithoutconstructor.php + * ) * * Creates a new instance of the class without invoking the constructor. * - * @return mixed Returns a new instance of the class. */ public function newInstanceWithoutConstructor() { return hphp_create_object_without_constructor($this->name); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.getparentclass.php ) @@ -1305,12 +1462,13 @@ class ReflectionClass implements Reflector { return new ReflectionClass($parent); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.issubclassof.php * ) * - * Checks if the class is a subclass of a specified class. + * Checks if the class is a subclass of a specified class or implements a + * specified interface. * * @cls mixed The class name being checked against. * @@ -1335,7 +1493,7 @@ class ReflectionClass implements Reflector { return $this->getParentClass()->isSubclassOf($cls); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.getstaticproperties.php ) @@ -1355,16 +1513,18 @@ class ReflectionClass implements Reflector { return $ret; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.getstaticpropertyvalue.php ) * - * Gets the static property values. WarningThis function is currently not - * documented; only its argument list is available. + * Gets the value of a static property on this class. * - * @name mixed + * @name mixed The name of the static property for which to return + * a value. * @default mixed + * + * @return mixed The value of the static property. */ public function getStaticPropertyValue($name, $default = null) { if ($this->hasProperty($name) && @@ -1374,7 +1534,7 @@ class ReflectionClass implements Reflector { return $default; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.setstaticpropertyvalue.php ) @@ -1391,15 +1551,24 @@ class ReflectionClass implements Reflector { hphp_set_static_property($this->name, $name, $value); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.getdefaultproperties.php ) * - * Gets default properties from a class. WarningThis function is currently - * not documented; only its argument list is available. + * Gets default properties from a class (including inherited properties). * - * @return mixed An array of default properties. + * This method only works for static properties when used on internal + * classes. The default value of a static class property can not be tracked + * when using this method on user defined classes. + * + * @return mixed An array of default properties, with the key being + * the name of the property and the value being the + * default value of the property or NULL if the + * property doesn't have a default value. The function + * does not distinguish between static and non static + * properties and does not take visibility modifiers + * into account. */ public function getDefaultProperties() { $ret = array(); @@ -1411,7 +1580,7 @@ class ReflectionClass implements Reflector { return $ret; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.isiterateable.php ) @@ -1424,7 +1593,7 @@ class ReflectionClass implements Reflector { return $this->isSubclassOf('ArrayAccess'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.implementsinterface.php ) @@ -1450,29 +1619,31 @@ class ReflectionClass implements Reflector { return false; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionclass.getextension.php * ) * - * Gets an extensions ReflectionExtension object. WarningThis function is - * currently not documented; only its argument list is available. + * Gets a ReflectionExtension object for the extension which defined the + * class. * - * @return mixed A ReflectionExtension object. + * @return mixed A ReflectionExtension object representing the + * extension which defined the class, or NULL for + * user-defined classes. */ public function getExtension() { return $this->fetch('extension'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionclass.getextensionname.php ) * - * Gets an extensions name. WarningThis function is currently not - * documented; only its argument list is available. + * Gets the name of the extension which defined the class. * - * @return mixed The extensions name. + * @return mixed The name of the extension which defined the class, + * or FALSE for user-defined classes. */ public function getExtensionName() { return $this->fetch('extension')->getName(); @@ -1496,25 +1667,28 @@ class ReflectionClass implements Reflector { return $this->fetch('attributes_rec'); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * ( excerpt from http://www.php.net/manual/en/reflectionclass.innamespace.php ) + * ( excerpt from http://php.net/manual/en/reflectionclass.innamespace.php + * ) * - * Checks if in namespace + * Checks if this class is defined in a namespace. * - * @return bool Returns TRUE on success or FALSE on failure. + * @return mixed Returns TRUE on success or FALSE on failure. */ public function inNamespace() { return strrpos($this->getName(), '\\') !== false; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * ( excerpt from http://php.net/manual/en/reflectionclass.getnamespacename.php ) + * ( excerpt from + * http://php.net/manual/en/reflectionclass.getnamespacename.php ) * - * Gets namespace name + * Gets the namespace name. WarningThis function is currently not + * documented; only its argument list is available. * - * @return string The namespace name. + * @return mixed The namespace name. */ public function getNamespaceName() { $pos = strrpos($this->getName(), '\\'); @@ -1524,13 +1698,14 @@ class ReflectionClass implements Reflector { return substr($this->getName(), 0, $pos); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** - * ( excerpt from http://www.php.net/manual/en/reflectionclass.getshortname.php ) + * ( excerpt from http://php.net/manual/en/reflectionclass.getshortname.php + * ) * - * Gets short name + * Gets the short name of the class, the part without the namespace. * - * @return string The class short name. + * @return mixed The class short name. */ public function getShortName() { $pos = strrpos($this->getName(), '\\'); @@ -1545,7 +1720,7 @@ class ReflectionClass implements Reflector { /////////////////////////////////////////////////////////////////////////////// // object -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.reflectionobject.php ) * @@ -1553,7 +1728,7 @@ class ReflectionClass implements Reflector { * */ class ReflectionObject extends ReflectionClass { -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionobject.export.php ) * @@ -1582,11 +1757,11 @@ class ReflectionObject extends ReflectionClass { /////////////////////////////////////////////////////////////////////////////// // property -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.reflectionproperty.php ) * - * The ReflectionProperty class reports information about a classes + * The ReflectionProperty class reports information about classes * properties. * */ @@ -1600,6 +1775,19 @@ class ReflectionProperty implements Reflector { public $name; public $class; +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflectionproperty.construct.php + * ) + * + * WarningThis function is currently not documented; only its argument + * list is available. + * + * @cls mixed The class name, that contains the property. + * @name mixed The name of the property being reflected. + * + * @return mixed No value is returned. + */ public function __construct($cls, $name) { if ($cls && $name) { if (!is_object($cls)) { @@ -1616,11 +1804,20 @@ class ReflectionProperty implements Reflector { } } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflectionproperty.tostring.php + * ) + * + * To string. WarningThis function is currently not documented; only its + * argument list is available. + * + */ public function __toString() { return ""; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionproperty.export.php ) * @@ -1647,7 +1844,7 @@ class ReflectionProperty implements Reflector { print $str; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionproperty.getname.php ) * @@ -1660,7 +1857,7 @@ class ReflectionProperty implements Reflector { return $this->info['name']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionproperty.ispublic.php * ) @@ -1673,7 +1870,7 @@ class ReflectionProperty implements Reflector { return $this->info['access'] == 'public'; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionproperty.isprivate.php * ) @@ -1686,7 +1883,7 @@ class ReflectionProperty implements Reflector { return $this->info['access'] == 'private'; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionproperty.isprotected.php ) @@ -1699,7 +1896,7 @@ class ReflectionProperty implements Reflector { return $this->info['access'] == 'protected'; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionproperty.isstatic.php * ) @@ -1712,7 +1909,7 @@ class ReflectionProperty implements Reflector { return isset($this->info['static']); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionproperty.isdefault.php * ) @@ -1726,7 +1923,7 @@ class ReflectionProperty implements Reflector { return $this->info['default']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionproperty.setaccessible.php ) @@ -1734,13 +1931,15 @@ class ReflectionProperty implements Reflector { * Sets a property to be accessible. For example, it may allow protected * and private properties to be accessed. * + * @accessible mixed TRUE to allow accessibility, or FALSE. + * * @return mixed No value is returned. */ public function setAccessible($accessible) { throw new ReflectionException(__METHOD__." is not supported"); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionproperty.getmodifiers.php ) @@ -1754,15 +1953,18 @@ class ReflectionProperty implements Reflector { return $this->info['modifiers']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionproperty.getvalue.php * ) * - * Gets the properties value. WarningThis function is currently not - * documented; only its argument list is available. + * Gets the properties value. * - * @obj mixed The object being reflected. + * @obj mixed If the property is non-static an object must be + * provided to fetch the property from. If you want to + * fetch the default property without providing an + * object use ReflectionClass::getDefaultProperties() + * instead. * * @return mixed The current value of the property. */ @@ -1778,15 +1980,17 @@ class ReflectionProperty implements Reflector { return null; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionproperty.setvalue.php * ) * - * Sets (changes) a properties value. WarningThis function is currently - * not documented; only its argument list is available. + * Sets (changes) the property's value. * - * @obj mixed The object name. + * @obj mixed If the property is non-static an object must be + * provided to change the property on. If the property + * is static this parameter is left out and only value + * needs to be provided. * @value mixed The new value. * * @return mixed No value is returned. @@ -1801,7 +2005,7 @@ class ReflectionProperty implements Reflector { } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionproperty.getdeclaringclass.php ) @@ -1818,7 +2022,7 @@ class ReflectionProperty implements Reflector { return new ReflectionClass($this->info['class']); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionproperty.getdoccomment.php ) @@ -1843,7 +2047,7 @@ class ReflectionProperty implements Reflector { /////////////////////////////////////////////////////////////////////////////// // method -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.reflectionmethod.php ) * @@ -1862,6 +2066,18 @@ implements Reflector { public $name; public $class; +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflectionmethod.construct.php ) + * + * Constructs a new ReflectionMethod. + * + * @cls mixed Classname or object (instance of the class) that + * contains the method. + * @name mixed Name of the method. + * + * @return mixed No value is returned. + */ public function __construct($cls, $name = '') { if (!$name && is_string($cls)) { $arr = explode('::', $cls); @@ -1882,12 +2098,21 @@ implements Reflector { } } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflectionmethod.tostring.php ) + * + * Returns the string representation of the Reflection method object. + * + * @return mixed A string representation of this ReflectionMethod + * instance. + */ public function __toString() { //TODO return ""; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionmethod.export.php ) * @@ -1918,14 +2143,14 @@ implements Reflector { print $str; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionmethod.invoke.php ) * * Invokes a reflected method. * - * @obj mixed The object to invoke the method on. In case of - * static methods, you can pass null to this parameter. + * @obj mixed The object to invoke the method on. For static + * methods, pass null to this parameter. * * @return mixed Returns the method result. */ @@ -1936,12 +2161,12 @@ implements Reflector { $args); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionmethod.invokeargs.php * ) * - * Invoke arguments. + * Invokes the reflected method and pass its arguments as array. * * @obj mixed The object to invoke the method on. In case of * static methods, you can pass null to this parameter. @@ -1955,7 +2180,7 @@ implements Reflector { array_values($args)); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionmethod.isfinal.php ) * @@ -1967,7 +2192,7 @@ implements Reflector { return isset($this->info['final']); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionmethod.isabstract.php * ) @@ -1980,7 +2205,7 @@ implements Reflector { return isset($this->info['abstract']); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionmethod.ispublic.php ) * @@ -1992,7 +2217,7 @@ implements Reflector { return $this->info['access'] == "public"; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionmethod.isprivate.php ) * @@ -2005,7 +2230,7 @@ implements Reflector { return $this->info['access'] == "private"; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionmethod.isprotected.php * ) @@ -2018,7 +2243,7 @@ implements Reflector { return $this->info['access'] == "protected"; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionmethod.isstatic.php ) * @@ -2030,7 +2255,7 @@ implements Reflector { return isset($this->info['static']); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionmethod.isconstructor.php ) @@ -2043,7 +2268,7 @@ implements Reflector { return isset($this->info['constructor']); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionmethod.isdestructor.php ) @@ -2056,33 +2281,37 @@ implements Reflector { return $this->getName() == '__destruct'; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionmethod.getmodifiers.php ) * - * Gets the method modifiers. + * Returns a bitfield of the access modifiers for this method. * * @return mixed A numeric representation of the modifiers. The * modifiers are listed below. The actual meanings of * these modifiers are described in the predefined - * constants. ReflectionMethod modifiers value constant - * 1 ReflectionMethod::IS_STATIC 2 - * ReflectionMethod::IS_ABSTRACT 4 - * ReflectionMethod::IS_FINAL 256 - * ReflectionMethod::IS_PUBLIC 512 - * ReflectionMethod::IS_PROTECTED 1024 - * ReflectionMethod::IS_PRIVATE + * constants. */ public function getModifiers() { return $this->info['modifiers']; } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflectionmethod.getclosure.php + * ) + * + * WarningThis function is currently not documented; only its argument + * list is available. + * + * @return mixed Returns Closure. Returns NULL in case of an error. + */ public function getClosure() { return $this->info['closure']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionmethod.getdeclaringclass.php ) @@ -2140,7 +2369,7 @@ implements Reflector { /////////////////////////////////////////////////////////////////////////////// // extension -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/class.reflectionextension.php ) * @@ -2151,15 +2380,37 @@ class ReflectionExtension implements Reflector { private $name; private $info; +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from + * http://php.net/manual/en/reflectionextension.construct.php ) + * + * Construct a ReflectionExtension object. + * + * @name mixed Name of the extension. + * + * @return mixed A ReflectionExtension object. + */ public function __construct($name) { $this->info = hphp_get_extension_info($name); } +// This doc comment block generated by idl/sysdoc.php +/** + * ( excerpt from http://php.net/manual/en/reflectionextension.tostring.php + * ) + * + * Exports a reflected extension and returns it as a string. This is the + * same as the ReflectionExtension::export() with the return set to TRUE. + * + * @return mixed Returns the exported extension as a string, in the + * same way as the ReflectionExtension::export(). + */ public function __toString() { return ""; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionextension.export.php ) * @@ -2184,7 +2435,7 @@ class ReflectionExtension implements Reflector { print $str; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionextension.getname.php * ) @@ -2197,7 +2448,7 @@ class ReflectionExtension implements Reflector { return $this->info['name']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionextension.getversion.php ) @@ -2210,7 +2461,7 @@ class ReflectionExtension implements Reflector { return $this->info['version']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionextension.getfunctions.php ) @@ -2226,7 +2477,7 @@ class ReflectionExtension implements Reflector { return $this->info['functions']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionextension.getconstants.php ) @@ -2239,7 +2490,7 @@ class ReflectionExtension implements Reflector { return $this->info['constants']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionextension.getinientries.php ) @@ -2253,7 +2504,7 @@ class ReflectionExtension implements Reflector { return $this->info['ini']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionextension.getclasses.php ) @@ -2268,7 +2519,7 @@ class ReflectionExtension implements Reflector { return $this->info['classes']; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from * http://php.net/manual/en/reflectionextension.getclassnames.php ) @@ -2287,11 +2538,11 @@ class ReflectionExtension implements Reflector { return $ret; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/reflectionextension.info.php ) * - * Gets information about an extension. + * Prints out the " phpinfo()" snippet for the given extension. * * @return mixed Information about the extension. */ diff --git a/hphp/system/classes/soapfault.php b/hphp/system/classes/soapfault.php index c665be3fe..ff03dcd5c 100644 --- a/hphp/system/classes/soapfault.php +++ b/hphp/system/classes/soapfault.php @@ -1,5 +1,12 @@ faultcode . "] " . $this->faultstring; diff --git a/hphp/system/classes/splfile.php b/hphp/system/classes/splfile.php index 7a50fdca1..e580f7783 100644 --- a/hphp/system/classes/splfile.php +++ b/hphp/system/classes/splfile.php @@ -1,6 +1,6 @@ storage); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splobjectstorage.valid.php ) * @@ -38,7 +38,7 @@ class SplObjectStorage implements Iterator, Countable { return key($this->storage) !== false; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splobjectstorage.key.php ) * @@ -51,7 +51,7 @@ class SplObjectStorage implements Iterator, Countable { return $this->index; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splobjectstorage.current.php ) * @@ -63,7 +63,7 @@ class SplObjectStorage implements Iterator, Countable { return current($this->storage); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splobjectstorage.next.php ) * @@ -76,7 +76,7 @@ class SplObjectStorage implements Iterator, Countable { $this->index++; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splobjectstorage.count.php ) * @@ -88,7 +88,7 @@ class SplObjectStorage implements Iterator, Countable { return count($this->storage); } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splobjectstorage.contains.php ) * @@ -110,11 +110,11 @@ class SplObjectStorage implements Iterator, Countable { return false; } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splobjectstorage.attach.php ) * - * Adds an object inside the storage, and optionaly associate it to some + * Adds an object inside the storage, and optionally associate it to some * data. * * @obj mixed The object to add. @@ -127,7 +127,7 @@ class SplObjectStorage implements Iterator, Countable { } } -// Do NOT modifiy this doc comment block generated by idl/sysdoc.php +// This doc comment block generated by idl/sysdoc.php /** * ( excerpt from http://php.net/manual/en/splobjectstorage.detach.php ) *