indent function docblocks

Esse commit está contido em:
Paul Tarjan
2013-05-25 16:36:50 -07:00
commit de Sara Golemon
commit 7930598d18
14 arquivos alterados com 7866 adições e 7506 exclusões
+3632 -3276
Ver Arquivo
Diferenças do arquivo suprimidas por serem muito extensas Carregar Diff
+6 -5
Ver Arquivo
@@ -1089,14 +1089,15 @@ function format_doc_arg($name, $type, $desc) {
return $ret;
}
function format_doc_comment($text) {
function format_doc_comment($text, $indent_spaces = 0) {
$lines = explode("\n", $text);
$ret = "/**\n";
$indent = str_repeat(' ', $indent_spaces);
$ret = "$indent/**\n";
for ($i = 0; $i < count($lines) - 1; $i++) {
$line = $lines[$i];
$ret .= rtrim(" * $line")."\n";
$ret .= rtrim("$indent * $line")."\n";
}
$ret .= " */";
$ret .= "$indent */";
return $ret;
}
@@ -1120,7 +1121,7 @@ function get_function_doc_comments($func, $clsname) {
$text .= format_doc_arg('return', $func['return'], $func['ret_desc']);
}
return format_doc_comment($text);
return format_doc_comment($text, empty($clsname) ? 0 : 2);
}
function get_class_doc_comments($class) {
+4 -1
Ver Arquivo
@@ -13,7 +13,7 @@ for ($i = 0; $i < count($lines) - 1; $i++) {
$line = $lines[$i];
if (preg_match("#$sig#", $line)) {
while (!preg_match('#^ \*/$#', $line)) {
while (!preg_match('#^ +\*/$#', $line)) {
$line = $lines[++$i];
}
$line = $lines[++$i];
@@ -56,6 +56,9 @@ for ($i = 0; $i < count($lines) - 1; $i++) {
}
$info['args'] = $args;
$info['return'] = null;
if ($class) {
$file .= ' ';
}
$file .= "$sig\n";
$file .= get_function_doc_comments($info, $class)."\n";
}
Diferenças do arquivo suprimidas por serem muito extensas Carregar Diff
+54 -54
Ver Arquivo
@@ -8,62 +8,62 @@
*
*/
interface ArrayAccess {
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayaccess.offsetexists.php )
*
* Whether or not an offset exists.
*
* This method is executed when using isset() or empty() on objects
* implementing ArrayAccess.
*
* When using empty() ArrayAccess::offsetGet() will be called and checked
* if empty only if ArrayAccess::offsetExists() returns TRUE.
*
* @index mixed An offset to check for.
*
* @return mixed Returns TRUE on success or FALSE on failure.
*
* The return value will be casted to boolean if
* non-boolean was returned.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayaccess.offsetexists.php )
*
* Whether or not an offset exists.
*
* This method is executed when using isset() or empty() on objects
* implementing ArrayAccess.
*
* When using empty() ArrayAccess::offsetGet() will be called and checked
* if empty only if ArrayAccess::offsetExists() returns TRUE.
*
* @index mixed An offset to check for.
*
* @return mixed Returns TRUE on success or FALSE on failure.
*
* The return value will be casted to boolean if
* non-boolean was returned.
*/
public function offsetExists($index);
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayaccess.offsetget.php )
*
* Returns the value at specified offset.
*
* This method is executed when checking if offset is empty().
*
* @index mixed The offset to retrieve.
*
* @return mixed Can return all value types.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayaccess.offsetget.php )
*
* Returns the value at specified offset.
*
* This method is executed when checking if offset is empty().
*
* @index mixed The offset to retrieve.
*
* @return mixed Can return all value types.
*/
public function offsetGet($index);
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayaccess.offsetset.php )
*
* Assigns a value to the specified offset.
*
* @index mixed The offset to assign the value to.
* @newvalue mixed The value to set.
*
* @return mixed No value is returned.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayaccess.offsetset.php )
*
* Assigns a value to the specified offset.
*
* @index mixed The offset to assign the value to.
* @newvalue mixed The value to set.
*
* @return mixed No value is returned.
*/
public function offsetSet($index, $newvalue);
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayaccess.offsetunset.php )
*
* Unsets an offset.
*
* This method will not be called when type-casting to (unset)
*
* @index mixed The offset to unset.
*
* @return mixed No value is returned.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayaccess.offsetunset.php )
*
* Unsets an offset.
*
* This method will not be called when type-casting to (unset)
*
* @index mixed The offset to unset.
*
* @return mixed No value is returned.
*/
public function offsetUnset($index);
}
+264 -264
Ver Arquivo
@@ -17,21 +17,21 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess,
private $flags;
private $iteratorClass;
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayobject.construct.php )
*
* This constructs a new array object.
*
* @input mixed The input parameter accepts an array or an Object.
* @flags mixed Flags to control the behaviour of the ArrayObject
* object. See ArrayObject::setFlags().
* @iterator_class
* mixed Specify the class that will be used for iteration of
* the ArrayObject object.
*
* @return mixed Returns an ArrayObject object on success.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayobject.construct.php )
*
* This constructs a new array object.
*
* @input mixed The input parameter accepts an array or an Object.
* @flags mixed Flags to control the behaviour of the ArrayObject
* object. See ArrayObject::setFlags().
* @iterator_class
* mixed Specify the class that will be used for iteration of
* the ArrayObject object.
*
* @return mixed Returns an ArrayObject object on success.
*/
public function __construct($input = null,
int $flags = 0,
string $iterator_class = "ArrayIterator") {
@@ -43,19 +43,19 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess,
$this->iteratorClass = $iterator_class;
}
// 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.
*
* This method cannot be called when the ArrayObject was constructed from
* an object. Use ArrayObject::offsetSet() instead.
*
* @value mixed The value being appended.
*
* @return mixed No value is returned.
*/
// 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.
*
* This method cannot be called when the ArrayObject was constructed from
* an object. Use ArrayObject::offsetSet() instead.
*
* @value mixed The value being appended.
*
* @return mixed No value is returned.
*/
public function append($value) {
if (!$this->isArray()) {
throw new Exception(
@@ -66,162 +66,162 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess,
$this->storage[] = $value;
}
// This doc comment block generated by idl/sysdoc.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
* associative arrays where the actual element order is significant.
*
* @return mixed No value is returned.
*/
// This doc comment block generated by idl/sysdoc.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
* associative arrays where the actual element order is significant.
*
* @return mixed No value is returned.
*/
public function asort() {
return asort($this->storage);
}
// This doc comment block generated by idl/sysdoc.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.
*
* When the ArrayObject is constructed from an array
* all properties are public.
*/
// This doc comment block generated by idl/sysdoc.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.
*
* When the ArrayObject is constructed from an array
* all properties are public.
*/
public function count() {
return count($this->storage);
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayobject.exchangearray.php )
*
* Exchange the current array with another array or object.
*
* @input mixed The new array or object to exchange with the current
* array.
*
* @return mixed Returns the old array.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayobject.exchangearray.php )
*
* Exchange the current array with another array or object.
*
* @input mixed The new array or object to exchange with the current
* array.
*
* @return mixed Returns the old array.
*/
public function exchangeArray($input) {
$old = $this->storage;
$this->storage = $input;
return $old;
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayobject.getarraycopy.php )
*
* Exports the ArrayObject to an array.
*
* @return mixed Returns a copy of the array. When the ArrayObject
* refers to an object an array of the public
* properties of that object will be returned.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayobject.getarraycopy.php )
*
* Exports the ArrayObject to an array.
*
* @return mixed Returns a copy of the array. When the ArrayObject
* refers to an object an array of the public
* properties of that object will be returned.
*/
public function getArrayCopy() {
return (array) $this->storage;
}
// This doc comment block generated by idl/sysdoc.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.
*
* @return mixed Returns the behavior flags of the ArrayObject.
*/
// This doc comment block generated by idl/sysdoc.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.
*
* @return mixed Returns the behavior flags of the ArrayObject.
*/
public function getFlags() {
return $this->flags;
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayobject.getiterator.php )
*
* Create a new iterator from an ArrayObject instance.
*
* @return mixed An iterator from an ArrayObject.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayobject.getiterator.php )
*
* Create a new iterator from an ArrayObject instance.
*
* @return mixed An iterator from an ArrayObject.
*/
public function getIterator() {
$class = $this->iteratorClass;
return new $class($this->storage, $this->flags);
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayobject.getiteratorclass.php
* )
*
* Gets the class name of the array iterator that is used by
* ArrayObject::getIterator().
*
* @return mixed Returns the iterator class name that is used to
* iterate over this object.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayobject.getiteratorclass.php
* )
*
* Gets the class name of the array iterator that is used by
* ArrayObject::getIterator().
*
* @return mixed Returns the iterator class name that is used to
* iterate over this object.
*/
public function getIteratorClass() {
return $this->iteratorClass;
}
// This doc comment block generated by idl/sysdoc.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.
*
* @return mixed No value is returned.
*/
// This doc comment block generated by idl/sysdoc.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.
*
* @return mixed No value is returned.
*/
public function ksort() {
return ksort($this->storage);
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayobject.natcasesort.php )
*
* This method is a case insensitive version of ArrayObject::natsort.
*
* 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".
*
* @return mixed No value is returned.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayobject.natcasesort.php )
*
* This method is a case insensitive version of ArrayObject::natsort.
*
* 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".
*
* @return mixed No value is returned.
*/
public function natcasesort() {
return natcasesort($this->storage);
}
// This doc comment block generated by idl/sysdoc.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
* the example below.
*
* @return mixed No value is returned.
*/
// This doc comment block generated by idl/sysdoc.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
* the example below.
*
* @return mixed No value is returned.
*/
public function natsort() {
return natsort($this->storage);
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayobject.offsetexists.php )
*
*
* @index mixed The index being checked.
*
* @return mixed TRUE if the requested index exists, otherwise FALSE
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayobject.offsetexists.php )
*
*
* @index mixed The index being checked.
*
* @return mixed TRUE if the requested index exists, otherwise FALSE
*/
public function offsetExists($index) {
if ($this->isArray()) {
return isset($this->storage[$index]);
@@ -230,15 +230,15 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess,
}
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayobject.offsetget.php )
*
*
* @index mixed The index with the value.
*
* @return mixed The value at the specified index or NULL.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayobject.offsetget.php )
*
*
* @index mixed The index with the value.
*
* @return mixed The value at the specified index or NULL.
*/
public function offsetGet($index) {
if ($this->isArray()) {
return $this->storage[$index];
@@ -248,17 +248,17 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess,
}
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayobject.offsetset.php )
*
* Sets the value at the specified index to newval.
*
* @index mixed The index being set.
* @newval mixed The new value for the index.
*
* @return mixed No value is returned.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayobject.offsetset.php )
*
* Sets the value at the specified index to newval.
*
* @index mixed The index being set.
* @newval mixed The new value for the index.
*
* @return mixed No value is returned.
*/
public function offsetSet($index, $newval) {
if ($this->isArray()) {
$this->storage[$index] = $newval;
@@ -268,16 +268,16 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess,
}
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayobject.offsetunset.php )
*
* Unsets the value at the specified index.
*
* @index mixed The index being unset.
*
* @return mixed No value is returned.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayobject.offsetunset.php )
*
* Unsets the value at the specified index.
*
* @index mixed The index being unset.
*
* @return mixed No value is returned.
*/
public function offsetUnset($index) {
if ($this->isArray()) {
unset($this->storage[$index]);
@@ -287,15 +287,15 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess,
}
}
// This doc comment block generated by idl/sysdoc.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.
*
* @return mixed The serialized representation of the ArrayObject.
*/
// This doc comment block generated by idl/sysdoc.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.
*
* @return mixed The serialized representation of the ArrayObject.
*/
public function serialize() {
return serialize(array(
'storage' => $this->storage,
@@ -304,106 +304,106 @@ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess,
));
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayobject.setflags.php )
*
* Set the flags that change the behavior of the ArrayObject.
*
* @flags mixed The new ArrayObject behavior. It takes on either a
* bitmask, or named constants. Using named constants
* is strongly encouraged to ensure compatibility for
* future versions.
*
* The available behavior flags are listed below. The
* actual meanings of these flags are described in the
* predefined constants. ArrayObject behavior flags
* value constant 1 ArrayObject::STD_PROP_LIST 2
* ArrayObject::ARRAY_AS_PROPS
*
* @return mixed No value is returned.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayobject.setflags.php )
*
* Set the flags that change the behavior of the ArrayObject.
*
* @flags mixed The new ArrayObject behavior. It takes on either a
* bitmask, or named constants. Using named constants
* is strongly encouraged to ensure compatibility for
* future versions.
*
* The available behavior flags are listed below. The
* actual meanings of these flags are described in the
* predefined constants. ArrayObject behavior flags
* value constant 1 ArrayObject::STD_PROP_LIST 2
* ArrayObject::ARRAY_AS_PROPS
*
* @return mixed No value is returned.
*/
public function setFlags(int $flags) {
$this->flags = $flags;
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayobject.setiteratorclass.php
* )
*
* Sets the classname of the array iterator that is used by
* ArrayObject::getIterator().
*
* @iterator_class
* mixed The classname of the array iterator to use when
* iterating over this object.
*
* @return mixed No value is returned.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/arrayobject.setiteratorclass.php
* )
*
* Sets the classname of the array iterator that is used by
* ArrayObject::getIterator().
*
* @iterator_class
* mixed The classname of the array iterator to use when
* iterating over this object.
*
* @return mixed No value is returned.
*/
public function setIteratorClass(string $iterator_class) {
$this->iteratorClass = $iterator_class;
}
// This doc comment block generated by idl/sysdoc.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
* user-defined comparison function.
*
* This is used mainly when sorting associative arrays where the actual
* element order is significant.
*
* @cmp_function
* mixed Function cmp_function should accept two parameters
* which will be filled by pairs of entries. The
* comparison function must return an integer less
* than, equal to, or greater than zero if the first
* argument is considered to be respectively less than,
* equal to, or greater than the second.
*
* @return mixed No value is returned.
*/
// This doc comment block generated by idl/sysdoc.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
* user-defined comparison function.
*
* This is used mainly when sorting associative arrays where the actual
* element order is significant.
*
* @cmp_function
* mixed Function cmp_function should accept two parameters
* which will be filled by pairs of entries. The
* comparison function must return an integer less
* than, equal to, or greater than zero if the first
* argument is considered to be respectively less than,
* equal to, or greater than the second.
*
* @return mixed No value is returned.
*/
public function uasort($cmp_function) {
uasort($this->storage, $cmp_function);
}
// This doc comment block generated by idl/sysdoc.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.
*
* @cmp_function
* mixed The callback comparison function.
*
* Function cmp_function should accept two parameters
* which will be filled by pairs of entry keys. The
* comparison function must return an integer less
* than, equal to, or greater than zero if the first
* argument is considered to be respectively less than,
* equal to, or greater than the second.
*
* @return mixed No value is returned.
*/
// This doc comment block generated by idl/sysdoc.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.
*
* @cmp_function
* mixed The callback comparison function.
*
* Function cmp_function should accept two parameters
* which will be filled by pairs of entry keys. The
* comparison function must return an integer less
* than, equal to, or greater than zero if the first
* argument is considered to be respectively less than,
* equal to, or greater than the second.
*
* @return mixed No value is returned.
*/
public function uksort($cmp_function) {
uksort($this->storage, $cmp_function);
}
// This doc comment block generated by idl/sysdoc.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.
*
* @serialized mixed The serialized ArrayObject.
*
* @return mixed The unserialized ArrayObject.
*/
// This doc comment block generated by idl/sysdoc.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.
*
* @serialized mixed The serialized ArrayObject.
*
* @return mixed The unserialized ArrayObject.
*/
public function unserialize($serialized) {
if (empty($serialized)) {
throw new UnexpectedValueException(
+158 -158
Ver Arquivo
@@ -11,15 +11,15 @@
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.
*/
// 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(
@@ -27,103 +27,103 @@ class DirectoryIterator extends SplFileInfo implements Traversable,
}
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/directoryiterator.current.php )
*
* Get the current DirectoryIterator item.
*
* @return mixed The current DirectoryIterator item.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/directoryiterator.current.php )
*
* Get the current DirectoryIterator item.
*
* @return mixed The current DirectoryIterator item.
*/
public function current() {
return hphp_directoryiterator_current($this);
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/directoryiterator.key.php )
*
* Get the key for the current DirectoryIterator item.
*
* @return mixed The key for the current DirectoryIterator item.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/directoryiterator.key.php )
*
* Get the key for the current DirectoryIterator item.
*
* @return mixed The key for the current DirectoryIterator item.
*/
public function key() {
return hphp_directoryiterator_key($this);
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/directoryiterator.next.php )
*
* Move forward to the next DirectoryIterator item.
*
* @return mixed No value is returned.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/directoryiterator.next.php )
*
* Move forward to the next DirectoryIterator item.
*
* @return mixed No value is returned.
*/
public function next() {
hphp_directoryiterator_next($this);
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/directoryiterator.rewind.php )
*
* Rewind the DirectoryIterator back to the start.
*
* @return mixed No value is returned.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/directoryiterator.rewind.php )
*
* Rewind the DirectoryIterator back to the start.
*
* @return mixed No value is returned.
*/
public function rewind() {
hphp_directoryiterator_rewind($this);
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/directoryiterator.seek.php )
*
* Seek to a given position in the DirectoryIterator.
*
* @position mixed The zero-based numeric position to seek to.
*
* @return mixed No value is returned.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/directoryiterator.seek.php )
*
* Seek to a given position in the DirectoryIterator.
*
* @position mixed The zero-based numeric position to seek to.
*
* @return mixed No value is returned.
*/
public function seek($position) {
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.
*/
// 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);
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/directoryiterator.valid.php )
*
* Check whether current DirectoryIterator position is a valid file.
*
* @return mixed Returns TRUE if the position is valid, otherwise
* FALSE
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/directoryiterator.valid.php )
*
* Check whether current DirectoryIterator position is a valid file.
*
* @return mixed Returns TRUE if the position is valid, otherwise
* FALSE
*/
public function valid() {
return hphp_directoryiterator_valid($this);
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/directoryiterator.isdot.php )
*
* Determines if the current DirectoryIterator item is a directory and
* either . or ...
*
* @return mixed TRUE if the entry is . or .., otherwise FALSE
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/directoryiterator.isdot.php )
*
* Determines if the current DirectoryIterator item is a directory and
* either . or ...
*
* @return mixed TRUE if the entry is . or .., otherwise FALSE
*/
public function isDot() {
return hphp_directoryiterator_isdot($this);
}
@@ -148,23 +148,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.
*/
// 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)) {
@@ -177,38 +177,38 @@ class RecursiveDirectoryIterator extends DirectoryIterator
return hphp_recursivedirectoryiterator_current($this);
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from
* http://php.net/manual/en/recursivedirectoryiterator.key.php )
*
*
* @return mixed The path and filename of the current dir entry.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from
* http://php.net/manual/en/recursivedirectoryiterator.key.php )
*
*
* @return mixed The path and filename of the current dir entry.
*/
function key() {
return hphp_recursivedirectoryiterator_key($this);
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from
* http://php.net/manual/en/recursivedirectoryiterator.next.php )
*
*
* @return mixed No value is returned.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from
* http://php.net/manual/en/recursivedirectoryiterator.next.php )
*
*
* @return mixed No value is returned.
*/
public function next() {
hphp_recursivedirectoryiterator_next($this);
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from
* http://php.net/manual/en/recursivedirectoryiterator.rewind.php )
*
*
* @return mixed No value is returned.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from
* http://php.net/manual/en/recursivedirectoryiterator.rewind.php )
*
*
* @return mixed No value is returned.
*/
public function rewind() {
hphp_recursivedirectoryiterator_rewind($this);
}
@@ -225,57 +225,57 @@ class RecursiveDirectoryIterator extends DirectoryIterator
return hphp_recursivedirectoryiterator_valid($this);
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from
* http://php.net/manual/en/recursivedirectoryiterator.haschildren.php )
*
*
* @return mixed Returns whether the current entry is a directory,
* but not '.' or '..'
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from
* http://php.net/manual/en/recursivedirectoryiterator.haschildren.php )
*
*
* @return mixed Returns whether the current entry is a directory,
* but not '.' or '..'
*/
function hasChildren() {
return hphp_recursivedirectoryiterator_haschildren($this);
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from
* http://php.net/manual/en/recursivedirectoryiterator.getchildren.php )
*
*
* @return mixed The filename, file information, or $this depending
* on the set flags. See the FilesystemIterator
* constants.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from
* http://php.net/manual/en/recursivedirectoryiterator.getchildren.php )
*
*
* @return mixed The filename, file information, or $this depending
* on the set flags. See the FilesystemIterator
* constants.
*/
function getChildren() {
return hphp_recursivedirectoryiterator_getchildren($this);
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from
* http://php.net/manual/en/recursivedirectoryiterator.getsubpath.php )
*
* Gets the sub path. WarningThis function is currently not documented;
* only its argument list is available.
*
* @return mixed The sub path (sub directory).
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from
* http://php.net/manual/en/recursivedirectoryiterator.getsubpath.php )
*
* Gets the sub path. WarningThis function is currently not documented;
* only its argument list is available.
*
* @return mixed The sub path (sub directory).
*/
function getSubPath() {
return hphp_recursivedirectoryiterator_getsubpath($this);
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from
* http://php.net/manual/en/recursivedirectoryiterator.getsubpathname.php )
*
* Gets the sub path and filename. WarningThis function is currently not
* documented; only its argument list is available.
*
* @return mixed The sub path (sub directory) and filename.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from
* http://php.net/manual/en/recursivedirectoryiterator.getsubpathname.php )
*
* Gets the sub path and filename. WarningThis function is currently not
* documented; only its argument list is available.
*
* @return mixed The sub path (sub directory) and filename.
*/
function getSubPathname() {
return hphp_recursivedirectoryiterator_getsubpathname($this);
}
+101 -101
Ver Arquivo
@@ -32,45 +32,45 @@ 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.
*/
// 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;
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/exception.getmessage.php )
*
* Returns the Exception message.
*
* @return mixed Returns the Exception message as a string.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/exception.getmessage.php )
*
* Returns the Exception message.
*
* @return mixed Returns the Exception message as a string.
*/
function getMessage() {
return $this->message;
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/exception.getprevious.php )
*
* Returns previous Exception (the third parameter of
* Exception::__construct()).
*
* @return mixed Returns the previous Exception if available or NULL
* otherwise.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/exception.getprevious.php )
*
* Returns previous Exception (the third parameter of
* Exception::__construct()).
*
* @return mixed Returns the previous Exception if available or NULL
* otherwise.
*/
final function getPrevious() {
return $this->previous;
}
@@ -89,66 +89,66 @@ class Exception {
$cur->setPrevious($previous);
}
// 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 integer in Exception
* but possibly as other type in Exception descendants
* (for example as string in PDOException).
*/
// 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 integer in Exception
* but possibly as other type in Exception descendants
* (for example as string in PDOException).
*/
function getCode() {
return $this->code;
}
// 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 created.
*
* @return mixed Returns the filename in which the exception was
* created.
*/
// 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 created.
*
* @return mixed Returns the filename in which the exception was
* created.
*/
final function getFile() {
return $this->file;
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/exception.getline.php )
*
* Get line number where the exception was created.
*
* @return mixed Returns the line number where the exception was
* created.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/exception.getline.php )
*
* Get line number where the exception was created.
*
* @return mixed Returns the line number where the exception was
* created.
*/
final function getLine() {
return $this->line;
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/exception.gettrace.php )
*
* Returns the Exception stack trace.
*
* @return mixed Returns the Exception stack trace as an array.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/exception.gettrace.php )
*
* Returns the Exception stack trace.
*
* @return mixed Returns the Exception stack trace as an array.
*/
final function getTrace() {
return $this->trace;
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/exception.gettraceasstring.php )
*
* Returns the Exception stack trace as a string.
*
* @return mixed Returns the Exception stack trace as a string.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/exception.gettraceasstring.php )
*
* Returns the Exception stack trace as a string.
*
* @return mixed Returns the Exception stack trace as a string.
*/
final function getTraceAsString() {
$i = 0;
$s = "";
@@ -167,14 +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.
*/
// 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() . ":" .
@@ -342,18 +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.
*/
// 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);
@@ -366,14 +366,14 @@ class ErrorException extends Exception {
}
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/errorexception.getseverity.php )
*
* Returns the severity of the exception.
*
* @return mixed Returns the severity level of the exception.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/errorexception.getseverity.php )
*
* Returns the severity of the exception.
*
* @return mixed Returns the severity level of the exception.
*/
final public function getSeverity() { return $this->severity; }
}
Diferenças do arquivo suprimidas por serem muito extensas Carregar Diff
Diferenças do arquivo suprimidas por serem muito extensas Carregar Diff
+8 -8
Ver Arquivo
@@ -77,14 +77,14 @@ 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.
*/
// 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;
Diferenças do arquivo suprimidas por serem muito extensas Carregar Diff
+153 -153
Ver Arquivo
@@ -15,47 +15,47 @@ abstract class SplHeap implements Iterator, Countable {
private $isCorrupted = false;
private $heap = array();
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splheap.construct.php )
*
* This constructs a new empty heap.
*
* @return mixed No value is returned.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splheap.construct.php )
*
* This constructs a new empty heap.
*
* @return mixed No value is returned.
*/
public function __construct() {}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splheap.compare.php )
*
* Compare value1 with value2. Warning
*
* Throwing exceptions in SplHeap::compare() can corrupt the Heap and
* place it in a blocked state. You can unblock it by calling
* SplHeap::recoverFromCorruption(). However, some elements might not be
* placed correctly and it may hence break the heap-property.
*
* @value1 mixed The value of the first node being compared.
* @value2 mixed The value of the second node being compared.
*
* @return mixed Result of the comparison, positive integer if value1
* is greater than value2, 0 if they are equal,
* negative integer otherwise.
*
* Having multiple elements with the same value in a
* Heap is not recommended. They will end up in an
* arbitrary relative position.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splheap.compare.php )
*
* Compare value1 with value2. Warning
*
* Throwing exceptions in SplHeap::compare() can corrupt the Heap and
* place it in a blocked state. You can unblock it by calling
* SplHeap::recoverFromCorruption(). However, some elements might not be
* placed correctly and it may hence break the heap-property.
*
* @value1 mixed The value of the first node being compared.
* @value2 mixed The value of the second node being compared.
*
* @return mixed Result of the comparison, positive integer if value1
* is greater than value2, 0 if they are equal,
* negative integer otherwise.
*
* Having multiple elements with the same value in a
* Heap is not recommended. They will end up in an
* arbitrary relative position.
*/
abstract public function compare($value1, $value2);
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splheap.extract.php )
*
*
* @return mixed The value of the extracted node.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splheap.extract.php )
*
*
* @return mixed The value of the extracted node.
*/
public function extract() {
$this->checkNotCorrupted();
if ($this->isEmpty()) {
@@ -78,16 +78,16 @@ abstract class SplHeap implements Iterator, Countable {
return $result;
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splheap.insert.php )
*
* Insert value in the heap.
*
* @value mixed The value to insert.
*
* @return mixed No value is returned.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splheap.insert.php )
*
* Insert value in the heap.
*
* @value mixed The value to insert.
*
* @return mixed No value is returned.
*/
public function insert($value) {
$this->checkNotCorrupted();
$index = $this->lowestFreeIndex();
@@ -101,72 +101,72 @@ abstract class SplHeap implements Iterator, Countable {
}
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splheap.isempty.php )
*
*
* @return mixed Returns whether the heap is empty.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splheap.isempty.php )
*
*
* @return mixed Returns whether the heap is empty.
*/
public function isEmpty() {
return $this->count() == 0;
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from
* http://php.net/manual/en/splheap.recoverfromcorruption.php )
*
*
* @return mixed No value is returned.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from
* http://php.net/manual/en/splheap.recoverfromcorruption.php )
*
*
* @return mixed No value is returned.
*/
public function recoverFromCorruption() {
$this->isCorrupted = false;
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splheap.count.php )
*
*
* @return mixed Returns the number of elements in the heap.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splheap.count.php )
*
*
* @return mixed Returns the number of elements in the heap.
*/
public function count() {
return count($this->heap);
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splheap.current.php )
*
* Get the current datastructure node.
*
* @return mixed The current node value.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splheap.current.php )
*
* Get the current datastructure node.
*
* @return mixed The current node value.
*/
public function current() {
return $this->isEmpty() ? null : $this->top();
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splheap.key.php )
*
* This function returns the current node index
*
* @return mixed The current node index.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splheap.key.php )
*
* This function returns the current node index
*
* @return mixed The current node index.
*/
public function key() {
return $this->highestUsedIndex();
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splheap.next.php )
*
* Move to the next node.
*
* @return mixed No value is returned.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splheap.next.php )
*
* Move to the next node.
*
* @return mixed No value is returned.
*/
public function next() {
if ($this->isEmpty()) {
// don't error, just silently stop
@@ -175,27 +175,27 @@ abstract class SplHeap implements Iterator, Countable {
$this->extract();
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splheap.rewind.php )
*
* This rewinds the iterator to the beginning. This is a no-op for heaps
* as the iterator is virtual and in fact never moves from the top of the
* heap.
*
* @return mixed No value is returned.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splheap.rewind.php )
*
* This rewinds the iterator to the beginning. This is a no-op for heaps
* as the iterator is virtual and in fact never moves from the top of the
* heap.
*
* @return mixed No value is returned.
*/
public function rewind() {
// Do nothing, the iterator always points to the top element
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splheap.top.php )
*
*
* @return mixed The value of the node on the top.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splheap.top.php )
*
*
* @return mixed The value of the node on the top.
*/
public function top() {
$this->checkNotCorrupted();
if ($this->isEmpty()) {
@@ -207,15 +207,15 @@ abstract class SplHeap implements Iterator, Countable {
return $this->heap[0];
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splheap.valid.php )
*
* Checks if the heap contains any more nodes.
*
* @return mixed Returns TRUE if the heap contains any more nodes,
* FALSE otherwise.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splheap.valid.php )
*
* Checks if the heap contains any more nodes.
*
* @return mixed Returns TRUE if the heap contains any more nodes,
* FALSE otherwise.
*/
public function valid() {
return !$this->isEmpty();
}
@@ -303,23 +303,23 @@ abstract class SplHeap implements Iterator, Countable {
*
*/
class SplMaxHeap extends SplHeap implements Iterator, Countable {
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splmaxheap.compare.php )
*
* Compare value1 with value2.
*
* @value1 mixed The value of the first node being compared.
* @value2 mixed The value of the second node being compared.
*
* @return mixed Result of the comparison, positive integer if value1
* is greater than value2, 0 if they are equal,
* negative integer otherwise.
*
* Having multiple elements with the same value in a
* Heap is not recommended. They will end up in an
* arbitrary relative position.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splmaxheap.compare.php )
*
* Compare value1 with value2.
*
* @value1 mixed The value of the first node being compared.
* @value2 mixed The value of the second node being compared.
*
* @return mixed Result of the comparison, positive integer if value1
* is greater than value2, 0 if they are equal,
* negative integer otherwise.
*
* Having multiple elements with the same value in a
* Heap is not recommended. They will end up in an
* arbitrary relative position.
*/
function compare($value1, $value2) {
return $value1 - $value2;
}
@@ -334,23 +334,23 @@ class SplMaxHeap extends SplHeap implements Iterator, Countable {
*
*/
class SplMinHeap extends SplHeap implements Iterator, Countable {
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splminheap.compare.php )
*
* Compare value1 with value2.
*
* @value1 mixed The value of the first node being compared.
* @value2 mixed The value of the second node being compared.
*
* @return mixed Result of the comparison, positive integer if value1
* is lower than value2, 0 if they are equal, negative
* integer otherwise.
*
* Having multiple elements with the same value in a
* Heap is not recommended. They will end up in an
* arbitrary relative position.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splminheap.compare.php )
*
* Compare value1 with value2.
*
* @value1 mixed The value of the first node being compared.
* @value2 mixed The value of the second node being compared.
*
* @return mixed Result of the comparison, positive integer if value1
* is lower than value2, 0 if they are equal, negative
* integer otherwise.
*
* Having multiple elements with the same value in a
* Heap is not recommended. They will end up in an
* arbitrary relative position.
*/
function compare($value1, $value2) {
return $value2 - $value1;
}
+82 -82
Ver Arquivo
@@ -13,92 +13,92 @@ class SplObjectStorage implements Iterator, Countable {
private $storage = array();
private $index = 0;
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splobjectstorage.rewind.php )
*
* Rewind the iterator to the first storage element.
*
* @return mixed No value is returned.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splobjectstorage.rewind.php )
*
* Rewind the iterator to the first storage element.
*
* @return mixed No value is returned.
*/
function rewind() {
rewind($this->storage);
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splobjectstorage.valid.php )
*
* Returns if the current iterator entry is valid.
*
* @return mixed Returns TRUE if the iterator entry is valid, FALSE
* otherwise.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splobjectstorage.valid.php )
*
* Returns if the current iterator entry is valid.
*
* @return mixed Returns TRUE if the iterator entry is valid, FALSE
* otherwise.
*/
function valid() {
return key($this->storage) !== false;
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splobjectstorage.key.php )
*
* Returns the index at which the iterator currently is.
*
* @return mixed The index corresponding to the position of the
* iterator.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splobjectstorage.key.php )
*
* Returns the index at which the iterator currently is.
*
* @return mixed The index corresponding to the position of the
* iterator.
*/
function key() {
return $this->index;
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splobjectstorage.current.php )
*
* Returns the current storage entry.
*
* @return mixed The object at the current iterator position.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splobjectstorage.current.php )
*
* Returns the current storage entry.
*
* @return mixed The object at the current iterator position.
*/
function current() {
return current($this->storage);
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splobjectstorage.next.php )
*
* Moves the iterator to the next object in the storage.
*
* @return mixed No value is returned.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splobjectstorage.next.php )
*
* Moves the iterator to the next object in the storage.
*
* @return mixed No value is returned.
*/
function next() {
next($this->storage);
$this->index++;
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splobjectstorage.count.php )
*
* Counts the number of objects in the storage.
*
* @return mixed The number of objects in the storage.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splobjectstorage.count.php )
*
* Counts the number of objects in the storage.
*
* @return mixed The number of objects in the storage.
*/
function count() {
return count($this->storage);
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splobjectstorage.contains.php )
*
* Checks if the storage contains the object provided.
*
* @obj mixed The object to look for.
*
* @return mixed Returns TRUE if the object is in the storage, FALSE
* otherwise.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splobjectstorage.contains.php )
*
* Checks if the storage contains the object provided.
*
* @obj mixed The object to look for.
*
* @return mixed Returns TRUE if the object is in the storage, FALSE
* otherwise.
*/
function contains($obj) {
if (is_object($obj)) {
foreach($this->storage as $object) {
@@ -110,33 +110,33 @@ class SplObjectStorage implements Iterator, Countable {
return false;
}
// 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 optionally associate it to some
* data.
*
* @obj mixed The object to add.
*
* @return mixed No value is returned.
*/
// 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 optionally associate it to some
* data.
*
* @obj mixed The object to add.
*
* @return mixed No value is returned.
*/
function attach($obj) {
if (is_object($obj) && !$this->contains($obj)) {
$this->storage[] = $obj;
}
}
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splobjectstorage.detach.php )
*
* Removes the object from the storage.
*
* @obj mixed The object to remove.
*
* @return mixed No value is returned.
*/
// This doc comment block generated by idl/sysdoc.php
/**
* ( excerpt from http://php.net/manual/en/splobjectstorage.detach.php )
*
* Removes the object from the storage.
*
* @obj mixed The object to remove.
*
* @return mixed No value is returned.
*/
function detach($obj) {
if (is_object($obj)) {
foreach($this->storage as $idx => $object) {