From 731f2adea5bcc31c94759d2ee3f45858004882ac Mon Sep 17 00:00:00 2001 From: Philip Olson Date: Fri, 25 Sep 2009 06:22:54 +0000 Subject: [PATCH] added doc skeletons for missing arrayiterator methods git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288719 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/spl/arrayiterator/offsetget.xml | 78 ++++++++++++++++++ reference/spl/arrayiterator/offsetset.xml | 87 +++++++++++++++++++++ reference/spl/arrayiterator/offsetunset.xml | 78 ++++++++++++++++++ reference/spl/arrayiterator/serialize.xml | 66 ++++++++++++++++ reference/spl/arrayiterator/setflags.xml | 86 ++++++++++++++++++++ reference/spl/arrayiterator/uasort.xml | 78 ++++++++++++++++++ reference/spl/arrayiterator/uksort.xml | 78 ++++++++++++++++++ reference/spl/arrayiterator/unserialize.xml | 77 ++++++++++++++++++ 8 files changed, 628 insertions(+) create mode 100644 reference/spl/arrayiterator/offsetget.xml create mode 100644 reference/spl/arrayiterator/offsetset.xml create mode 100644 reference/spl/arrayiterator/offsetunset.xml create mode 100644 reference/spl/arrayiterator/serialize.xml create mode 100644 reference/spl/arrayiterator/setflags.xml create mode 100644 reference/spl/arrayiterator/uasort.xml create mode 100644 reference/spl/arrayiterator/uksort.xml create mode 100644 reference/spl/arrayiterator/unserialize.xml diff --git a/reference/spl/arrayiterator/offsetget.xml b/reference/spl/arrayiterator/offsetget.xml new file mode 100644 index 0000000000..1287fd8a65 --- /dev/null +++ b/reference/spl/arrayiterator/offsetget.xml @@ -0,0 +1,78 @@ + + + + + + ArrayIterator::offsetGet + Get value for an offset + + + + &reftitle.description; + + public mixedArrayIterator::offsetGet + stringindex + + + Gets the value from the provided offset. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + + index + + + The offset to get the value from. + + + + + + + + + &reftitle.returnvalues; + + The value at offset index. + + + + + &reftitle.seealso; + + + ArrayIterator::offSetSet + ArrayIterator::offUnSet + + + + + + + diff --git a/reference/spl/arrayiterator/offsetset.xml b/reference/spl/arrayiterator/offsetset.xml new file mode 100644 index 0000000000..bafdcb3e20 --- /dev/null +++ b/reference/spl/arrayiterator/offsetset.xml @@ -0,0 +1,87 @@ + + + + + + ArrayIterator::offsetSet + Set value for an offset + + + + &reftitle.description; + + public voidArrayIterator::offsetSet + stringindex + stringnewval + + + Sets a value for a given offset. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + + index + + + The index to set for. + + + + + newval + + + The new value to store at the index. + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + + &reftitle.seealso; + + + ArrayIterator::offSetGet + ArrayIterator::offSetUnset + + + + + + + diff --git a/reference/spl/arrayiterator/offsetunset.xml b/reference/spl/arrayiterator/offsetunset.xml new file mode 100644 index 0000000000..aa82fd1e98 --- /dev/null +++ b/reference/spl/arrayiterator/offsetunset.xml @@ -0,0 +1,78 @@ + + + + + + ArrayIterator::offsetUnset + Unset value for an offset + + + + &reftitle.description; + + public voidArrayIterator::offsetUnset + stringindex + + + Unsets a value for an offset. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + + index + + + The offset to unset. + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + + &reftitle.seealso; + + + ArrayIterator::offSetGet + ArrayIterator::offSetSet + + + + + + + diff --git a/reference/spl/arrayiterator/serialize.xml b/reference/spl/arrayiterator/serialize.xml new file mode 100644 index 0000000000..8ba5046eea --- /dev/null +++ b/reference/spl/arrayiterator/serialize.xml @@ -0,0 +1,66 @@ + + + + + + ArrayIterator::serialize + Serialize + + + + &reftitle.description; + + public stringArrayIterator::serialize + + + + Serialize. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The serialized ArrayIterator. + + + + + &reftitle.seealso; + + + ArrayIterator::unserialize + + + + + + + diff --git a/reference/spl/arrayiterator/setflags.xml b/reference/spl/arrayiterator/setflags.xml new file mode 100644 index 0000000000..cbd69ca8f7 --- /dev/null +++ b/reference/spl/arrayiterator/setflags.xml @@ -0,0 +1,86 @@ + + + + + + ArrayIterator::setFlags + Set behaviour flags + + + + &reftitle.description; + + public voidArrayIterator::setFlags + stringflags + + + Sets behaviour flags. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + + flags + + + A bitmask as follows: + + + 0 = Properties of the object have their normal functionality + when accessed as list (var_dump, foreach, etc.). + + + 1 = Array indices can be accessed as properties in read/write. + + + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + + &reftitle.seealso; + + + ArrayIterator::getFlags + + + + + + + diff --git a/reference/spl/arrayiterator/uasort.xml b/reference/spl/arrayiterator/uasort.xml new file mode 100644 index 0000000000..c4bbc95337 --- /dev/null +++ b/reference/spl/arrayiterator/uasort.xml @@ -0,0 +1,78 @@ + + + + + + ArrayIterator::uasort + User defined sort + + + + &reftitle.description; + + public voidArrayIterator::uasort + stringcmp_function + + + Sort the entries by values using user defined function. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + + cmp_function + + + The compare function used for the sort. + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + + &reftitle.seealso; + + + ArrayIterator::uksort + usort + + + + + + + diff --git a/reference/spl/arrayiterator/uksort.xml b/reference/spl/arrayiterator/uksort.xml new file mode 100644 index 0000000000..bb5bd6e61b --- /dev/null +++ b/reference/spl/arrayiterator/uksort.xml @@ -0,0 +1,78 @@ + + + + + + ArrayIterator::uksort + User defined sort + + + + &reftitle.description; + + public voidArrayIterator::uksort + stringcmp_function + + + Sort the entries by key using user defined function. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + + cmp_function + + + The compare function used for the sort. + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + + &reftitle.seealso; + + + ArrayIterator::uasort + uksort + + + + + + + diff --git a/reference/spl/arrayiterator/unserialize.xml b/reference/spl/arrayiterator/unserialize.xml new file mode 100644 index 0000000000..14dd1f9867 --- /dev/null +++ b/reference/spl/arrayiterator/unserialize.xml @@ -0,0 +1,77 @@ + + + + + + ArrayIterator::unserialize + Unserialize + + + + &reftitle.description; + + public stringArrayIterator::unserialize + stringserialized + + + Unserialize. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + + serialized + + + The serialized ArrayIterator object to be unserialized. + + + + + + + + + &reftitle.returnvalues; + + The ArrayIterator. + + + + + &reftitle.seealso; + + + ArrayIterator::serialize + + + + + + +