Improve Arr class documentation.

This commit is contained in:
Taylor Otwell 2011-08-09 14:31:57 -05:00
parent 26dcc276fe
commit b6ba0de0bd
1 changed files with 10 additions and 1 deletions

View File

@ -6,7 +6,16 @@ class Arr {
* Get an item from an array.
*
* If the specified key is null, the entire array will be returned. The array may
* also be accessed using JavaScript "dot" style notation.
* also be accessed using JavaScript "dot" style notation. Retrieving items nested
* in multiple arrays is also supported.
*
* <code>
* // Returns "taylor"
* $item = Arr::get(array('name' => 'taylor'), 'name', $default);
*
* // Returns "taylor"
* $item = Arr::get(array('name' => array('is' => 'taylor')), 'name.is');
* </code>
*
* @param array $array
* @param string $key