608 lines
29 KiB
XML
608 lines
29 KiB
XML
|
<?xml version="1.0" encoding="utf-8"?>
|
||
|
|
<project version="2.0.0a2" title="PHPLib">
|
||
|
|
<file path="str.php" hash="4ea9dcab6b85b1310b888fcd84f2ceba" package="PHPLib">
|
||
|
|
<docblock line="2">
|
||
|
|
<description><![CDATA[PHPLib]]></description>
|
||
|
|
<long-description><![CDATA[<p>A PHP library to wrap php functions in a standard fashion</p>]]></long-description>
|
||
|
|
<tag line="2" name="package" description="PHPLib"/>
|
||
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
||
|
|
<tag line="2" name="copyright" description="Copyright (c) 2013"/>
|
||
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/PHPLib" link="https://github.com/aviat4ion/PHPLib"/>
|
||
|
|
<tag line="2" name="license" description="MIT"/>
|
||
|
|
</docblock>
|
||
|
|
<class final="false" abstract="false" namespace="PHPUtil" line="21" package="Default">
|
||
|
|
<name>Str</name>
|
||
|
|
<full_name>\PHPUtil\Str</full_name>
|
||
|
|
<extends/>
|
||
|
|
<docblock line="18">
|
||
|
|
<description><![CDATA[Wrapper over php string functions with a consistent argument system]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
<property final="false" static="false" visibility="protected" line="27" package="Default">
|
||
|
|
<name>$original</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="23">
|
||
|
|
<description><![CDATA[Original string to be modified]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="23" name="var" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="PHPUtil" line="35" package="">
|
||
|
|
<name>__construct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="29">
|
||
|
|
<description><![CDATA[Constructor]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="29" name="param" description="" type="string" variable="$string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="29" name="return" description="" type="\PHPUtil\Str">
|
||
|
|
<type by_reference="false">\PHPUtil\Str</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="35">
|
||
|
|
<name>$string</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="PHPUtil" line="46" package="">
|
||
|
|
<name>__invoke</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="40">
|
||
|
|
<description><![CDATA[Enable using the object as a function]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="40" name="param" description="" type="string" variable="$string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="40" name="return" description="" type="\PHPUtil\$this">
|
||
|
|
<type by_reference="false">\PHPUtil\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="46">
|
||
|
|
<name>$string</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="PHPUtil" line="57" package="">
|
||
|
|
<name>__toString</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="52">
|
||
|
|
<description><![CDATA[Output from the last method]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="52" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="PHPUtil" line="69" package="">
|
||
|
|
<name>_</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="64">
|
||
|
|
<description><![CDATA[Return output from the last method]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="64" name="return" description="" type="mixed">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="PHPUtil" line="81" package="">
|
||
|
|
<name>format</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="74">
|
||
|
|
<description><![CDATA[Formats a string according to the pattern passed to the str() function]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="74" name="see" description="\PHPUtil\http://php.net/manual/function.sprintf.php" refers="\PHPUtil\http://php.net/manual/function.sprintf.php"/>
|
||
|
|
<tag line="74" name="param" description="" type="array" variable="$replacements">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="74" name="return" description="" type="\PHPUtil\$this">
|
||
|
|
<type by_reference="false">\PHPUtil\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="81">
|
||
|
|
<name>$replacements</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type>array</type>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="PHPUtil" line="98" package="">
|
||
|
|
<name>match</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="92">
|
||
|
|
<description><![CDATA[Check whether a string matches the provided pattern]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="92" name="param" description="" type="string" variable="$pattern">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="92" name="return" description="" type="bool">
|
||
|
|
<type by_reference="false">bool</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="98">
|
||
|
|
<name>$pattern</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="PHPUtil" line="111" package="">
|
||
|
|
<name>replace</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="103">
|
||
|
|
<description><![CDATA[Do a basic string replacement]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="103" name="see" description="\PHPUtil\http://php.net/manual/function.str-replace.php" refers="\PHPUtil\http://php.net/manual/function.str-replace.php"/>
|
||
|
|
<tag line="103" name="param" description="" type="mixed" variable="$pattern">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="103" name="param" description="" type="mixed" variable="$replacement">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="103" name="return" description="" type="\PHPUtil\$this">
|
||
|
|
<type by_reference="false">\PHPUtil\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="111">
|
||
|
|
<name>$pattern</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="111">
|
||
|
|
<name>$replacement</name>
|
||
|
|
<default><![CDATA[NULL]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="PHPUtil" line="131" package="">
|
||
|
|
<name>reg_replace</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="123">
|
||
|
|
<description><![CDATA[String replacement via a regular expression]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="123" name="see" description="\PHPUtil\http://php.net/manual/function.preg-replace.php" refers="\PHPUtil\http://php.net/manual/function.preg-replace.php"/>
|
||
|
|
<tag line="123" name="param" description="" type="mixed" variable="$pattern">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="123" name="param" description="" type="mixed" variable="$replacement">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="123" name="return" description="" type="\PHPUtil\$this">
|
||
|
|
<type by_reference="false">\PHPUtil\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="131">
|
||
|
|
<name>$pattern</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="131">
|
||
|
|
<name>$replacement</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="arr.php" hash="d015672aba84ee043ac1070d665c39fc" package="PHPLib">
|
||
|
|
<docblock line="2">
|
||
|
|
<description><![CDATA[PHPLib]]></description>
|
||
|
|
<long-description><![CDATA[<p>A PHP library to wrap php functions in a standard fashion</p>]]></long-description>
|
||
|
|
<tag line="2" name="package" description="PHPLib"/>
|
||
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
||
|
|
<tag line="2" name="copyright" description="Copyright (c) 2013"/>
|
||
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/PHPLib" link="https://github.com/aviat4ion/PHPLib"/>
|
||
|
|
<tag line="2" name="license" description="MIT"/>
|
||
|
|
</docblock>
|
||
|
|
<class final="false" abstract="false" namespace="PHPUtil" line="21" package="Default">
|
||
|
|
<name>Arr</name>
|
||
|
|
<full_name>\PHPUtil\Arr</full_name>
|
||
|
|
<extends/>
|
||
|
|
<docblock line="18">
|
||
|
|
<description><![CDATA[Wrapper over array functions with a consistent interface]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
<property final="false" static="false" visibility="protected" line="27" package="Default">
|
||
|
|
<name>$original</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="23">
|
||
|
|
<description><![CDATA[Original array to manipulate]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="23" name="var" description="" type="array">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="PHPUtil" line="35" package="">
|
||
|
|
<name>__construct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="29">
|
||
|
|
<description><![CDATA[Constructor]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="29" name="param" description="" type="array" variable="$arr">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="29" name="return" description="" type="\PHPUtil\Arr">
|
||
|
|
<type by_reference="false">\PHPUtil\Arr</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="35">
|
||
|
|
<name>$arr</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="PHPUtil" line="46" package="">
|
||
|
|
<name>__invoke</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="40">
|
||
|
|
<description><![CDATA[Enable using the object as a function]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="40" name="param" description="" type="string" variable="$arr">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="40" name="return" description="" type="\PHPUtil\$this">
|
||
|
|
<type by_reference="false">\PHPUtil\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="46">
|
||
|
|
<name>$arr</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="PHPUtil" line="60" package="">
|
||
|
|
<name>keys</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="52">
|
||
|
|
<description><![CDATA[Return the keys or a subset of the keys of an array]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="52" name="see" description="\PHPUtil\http://php.net/manual/function.array-keys.php" refers="\PHPUtil\http://php.net/manual/function.array-keys.php"/>
|
||
|
|
<tag line="52" name="param" description="" type="mixed" variable="$search_value">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="52" name="param" description="" type="bool" variable="$strict">
|
||
|
|
<type by_reference="false">bool</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="52" name="return" description="" type="array">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="60">
|
||
|
|
<name>$search_value</name>
|
||
|
|
<default><![CDATA[NULL]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="60">
|
||
|
|
<name>$strict</name>
|
||
|
|
<default><![CDATA[FALSE]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="PHPUtil" line="70" package="">
|
||
|
|
<name>values</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="65">
|
||
|
|
<description><![CDATA[Returns the values from the input array with a numeric index]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="65" name="return" description="" type="array">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="PHPUtil" line="83" package="">
|
||
|
|
<name>grep</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="75">
|
||
|
|
<description><![CDATA[Returns an array of elements from the input array that match the
|
||
|
|
specified pattern]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="75" name="param" description="" type="mixed" variable="$pattern">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="75" name="param" description="" type="mixed" variable="$invert">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="75" name="return" description="" type="array">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="83">
|
||
|
|
<name>$pattern</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="83">
|
||
|
|
<name>$invert</name>
|
||
|
|
<default><![CDATA[FALSE]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="PHPUtil" line="97" package="">
|
||
|
|
<name>replace</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="90">
|
||
|
|
<description><![CDATA[Replace elements in the main array with the values in the passed arrays
|
||
|
|
(Takes a variable number of arguments)]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="90" name="see" description="\PHPUtil\http://php.net/manual/function.array-replace.php" refers="\PHPUtil\http://php.net/manual/function.array-replace.php"/>
|
||
|
|
<tag line="90" name="return" description="" type="array">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="PHPUtil" line="112" package="">
|
||
|
|
<name>merge</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="105">
|
||
|
|
<description><![CDATA[Combine arrays
|
||
|
|
(Takes a variable number of arguments)]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="105" name="see" description="\PHPUtil\http://php.net/manual/function.array-merge.php" refers="\PHPUtil\http://php.net/manual/function.array-merge.php"/>
|
||
|
|
<tag line="105" name="return" description="" type="array">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="PHPUtil" line="127" package="">
|
||
|
|
<name>unique</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="120">
|
||
|
|
<description><![CDATA[Return a new array from the original with duplicate items removed]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="120" name="see" description="\PHPUtil\http://php.net/manual/function.array-unique.php" refers="\PHPUtil\http://php.net/manual/function.array-unique.php"/>
|
||
|
|
<tag line="120" name="param" description="" type="" variable="$sort_flags"/>
|
||
|
|
<tag line="120" name="return" description="" type="array">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="127">
|
||
|
|
<name>$sort_flags</name>
|
||
|
|
<default><![CDATA[SORT_STRING]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="PHPUtil" line="141" package="">
|
||
|
|
<name>fill</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="132">
|
||
|
|
<description><![CDATA[Return an array with elements having the defined values]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="132" name="see" description="\PHPUtil\http://php.net/manual/function.array-fill.php" refers="\PHPUtil\http://php.net/manual/function.array-fill.php"/>
|
||
|
|
<tag line="132" name="param" description="" type="int" variable="$start_index">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="132" name="param" description="" type="int" variable="$num">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="132" name="param" description="" type="mixed" variable="$value">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="132" name="return" description="" type="array">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="141">
|
||
|
|
<name>$start_index</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="141">
|
||
|
|
<name>$num</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="141">
|
||
|
|
<name>$value</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="PHPUtil" line="154" package="">
|
||
|
|
<name>pad</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="146">
|
||
|
|
<description><![CDATA[Lengthen array to $pad_length with $pad_value]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="146" name="see" description="\PHPUtil\http://php.net/manual/function.array-pad.php" refers="\PHPUtil\http://php.net/manual/function.array-pad.php"/>
|
||
|
|
<tag line="146" name="param" description="" type="int" variable="$pad_size">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="146" name="param" description="" type="mixed" variable="$pad_value">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="146" name="return" description="" type="array">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="154">
|
||
|
|
<name>$pad_size</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="154">
|
||
|
|
<name>$pad_value</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="PHPUtil" line="166" package="">
|
||
|
|
<name>count_values</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="159">
|
||
|
|
<description><![CDATA[Return an array with keys that are the values of the input
|
||
|
|
array, and values as the frequency of those values]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="159" name="see" description="\PHPUtil\http://php.net/manual/function.array-count-values.php" refers="\PHPUtil\http://php.net/manual/function.array-count-values.php"/>
|
||
|
|
<tag line="159" name="return" description="" type="array">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="PHPUtil" line="177" package="">
|
||
|
|
<name>flip</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="171">
|
||
|
|
<description><![CDATA[Return an array with keys and values reversed from the input array]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="171" name="see" description="\PHPUtil\http://php.net/manual/function.array-flip.php" refers="\PHPUtil\http://php.net/manual/function.array-flip.php"/>
|
||
|
|
<tag line="171" name="return" description="" type="array">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="PHPUtil" line="188" package="">
|
||
|
|
<name>sum</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="182">
|
||
|
|
<description><![CDATA[Returns the sum of all the values in the array]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="182" name="see" description="\PHPUtil\http://php.net/manual/function.array-sum.php" refers="\PHPUtil\http://php.net/manual/function.array-sum.php"/>
|
||
|
|
<tag line="182" name="return" description="" type="\PHPUtil\number">
|
||
|
|
<type by_reference="false">\PHPUtil\number</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="PHPUtil" line="200" package="">
|
||
|
|
<name>sort</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="193">
|
||
|
|
<description><![CDATA[Return a sorted array]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="193" name="see" description="\PHPUtil\http://php.net/manual/function.asort.php" refers="\PHPUtil\http://php.net/manual/function.asort.php"/>
|
||
|
|
<tag line="193" name="param" description="" type="int" variable="$sort_flags">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="193" name="return" description="" type="array">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="200">
|
||
|
|
<name>$sort_flags</name>
|
||
|
|
<default><![CDATA[SORT_REGULAR]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="PHPUtil" line="213" package="">
|
||
|
|
<name>reverse_sort</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="206">
|
||
|
|
<description><![CDATA[Return a reverse-sorted array]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="206" name="see" description="\PHPUtil\http://php.net/manual/function.asort.php" refers="\PHPUtil\http://php.net/manual/function.asort.php"/>
|
||
|
|
<tag line="206" name="param" description="" type="int" variable="$sort_flags">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="206" name="return" description="" type="array">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="213">
|
||
|
|
<name>$sort_flags</name>
|
||
|
|
<default><![CDATA[SORT_REGULAR]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="PHPUtil" line="226" package="">
|
||
|
|
<name>reverse</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="219">
|
||
|
|
<description><![CDATA[Reverse the order of the array]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="219" name="see" description="\PHPUtil\http://php.net/manual/function.array-reverse.php" refers="\PHPUtil\http://php.net/manual/function.array-reverse.php"/>
|
||
|
|
<tag line="219" name="param" description="" type="bool" variable="$preserve_keys">
|
||
|
|
<type by_reference="false">bool</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="219" name="return" description="" type="array">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="226">
|
||
|
|
<name>$preserve_keys</name>
|
||
|
|
<default><![CDATA[FALSE]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="PHPUtil" line="238" package="">
|
||
|
|
<name>filter</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="231">
|
||
|
|
<description><![CDATA[Filter elements of the input array using a callback function]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="231" name="see" description="\PHPUtil\http://php.net/manual/function.array-filter.php" refers="\PHPUtil\http://php.net/manual/function.array-filter.php"/>
|
||
|
|
<tag line="231" name="param" description="" type="\PHPUtil\callable" variable="$callback">
|
||
|
|
<type by_reference="false">\PHPUtil\callable</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="231" name="return" description="" type="array">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="238">
|
||
|
|
<name>$callback</name>
|
||
|
|
<default><![CDATA[NULL]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="functions.php" hash="58354d23244fb58de2bb734fe094620a" package="PHPLib">
|
||
|
|
<docblock line="2">
|
||
|
|
<description><![CDATA[PHPLib]]></description>
|
||
|
|
<long-description><![CDATA[<p>A PHP library to wrap php functions in a standard fashion</p>]]></long-description>
|
||
|
|
<tag line="2" name="package" description="PHPLib"/>
|
||
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
||
|
|
<tag line="2" name="copyright" description="Copyright (c) 2013"/>
|
||
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/PHPLib" link="https://github.com/aviat4ion/PHPLib"/>
|
||
|
|
<tag line="2" name="license" description="MIT"/>
|
||
|
|
</docblock>
|
||
|
|
<function namespace="default" line="22" package="PHPLib">
|
||
|
|
<name>str</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="16">
|
||
|
|
<description><![CDATA[Access function for string methods]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="16" name="param" description="" type="string" variable="$str">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="16" name="return" description="" type="object">
|
||
|
|
<type by_reference="false">object</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="22">
|
||
|
|
<name>$str</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</function>
|
||
|
|
<function namespace="default" line="42" package="PHPLib">
|
||
|
|
<name>arr</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="36">
|
||
|
|
<description><![CDATA[Access function for array methods]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="36" name="param" description="" type="array" variable="$array">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="36" name="return" description="" type="object">
|
||
|
|
<type by_reference="false">object</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="42">
|
||
|
|
<name>$array</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type>array</type>
|
||
|
|
</argument>
|
||
|
|
</function>
|
||
|
|
</file>
|
||
|
|
<package name="" full_name=""/>
|
||
|
|
<package name="Default" full_name="Default"/>
|
||
|
|
<package name="PHPLib" full_name="PHPLib"/>
|
||
|
|
<namespace name="PHPUtil" full_name="PHPUtil"/>
|
||
|
|
<namespace name="default" full_name="default"/>
|
||
|
|
<marker count="0">todo</marker>
|
||
|
|
<marker count="0">fixme</marker>
|
||
|
|
<deprecated count="0"/>
|
||
|
|
</project>
|