Annajwaszahro
/
MIF_E31222691
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fixing API comments.

This commit is contained in:
Taylor Otwell 2011-08-13 21:43:33 -05:00
parent ee373db59c
commit 3ac2287329
3 changed files with 31 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
system/arr.php
View File

@ -10,11 +10,11 @@ class Arr {
* in multiple arrays is also supported. * in multiple arrays is also supported.
* *
* <code> * <code>
* // Returns "taylor" * // Returns "taylor"
* $item = Arr::get(array('name' => 'taylor'), 'name', $default); * $item = Arr::get(array('name' => 'taylor'), 'name', $default);
* *
* // Returns "taylor" * // Returns "taylor"
* $item = Arr::get(array('name' => array('is' => 'taylor')), 'name.is'); * $item = Arr::get(array('name' => array('is' => 'taylor')), 'name.is');
* </code> * </code>
* *
* @param array $array * @param array $array

37
system/asset.php
View File

@ -21,14 +21,14 @@ class Asset {
* expressive code and a clean API. * expressive code and a clean API.
* *
* <code> * <code>
* // Get the default asset container * // Get the default asset container
* $container = Asset::container(); * $container = Asset::container();
* *
* // Get the "footer" asset contanier * // Get the "footer" asset contanier
* $container = Asset::container('footer'); * $container = Asset::container('footer');
* *
* // Add an asset to the "footer" container * // Add an asset to the "footer" container
* Asset::container('footer')->add('jquery', 'js/jquery.js'); * Asset::container('footer')->add('jquery', 'js/jquery.js');
* </code> * </code>
* *
* @param string $container * @param string $container
@ -46,14 +46,13 @@ public static function container($container = 'default')
/** /**
* Magic Method for calling methods on the default Asset container. * Magic Method for calling methods on the default Asset container.
* This allows a convenient API for working with the default container.
* *
* <code> * <code>
* // Add jQuery to the default container * // Add jQuery to the default container
* Asset::script('jquery', 'js/jquery.js'); * Asset::script('jquery', 'js/jquery.js');
* *
* // Equivalent call using the container method * // Equivalent call using the container method
* Asset::container()->script('jquery', 'js/jquery.js'); * Asset::container()->script('jquery', 'js/jquery.js');
* </code> * </code>
*/ */
public static function __callStatic($method, $parameters) public static function __callStatic($method, $parameters)
@ -98,8 +97,8 @@ public function __construct($name)
* extension, you may use the style or script methods to register assets. * extension, you may use the style or script methods to register assets.
* *
* <code> * <code>
* // Register a jQuery asset * // Register a jQuery asset
* Asset::add('jquery', 'js/jquery.js'); * Asset::add('jquery', 'js/jquery.js');
* </code> * </code>
* *
* You may also specify asset dependencies. This will instruct the class to * You may also specify asset dependencies. This will instruct the class to
@ -107,11 +106,11 @@ public function __construct($name)
* For example, you may wish to make jQuery UI dependent on jQuery. * For example, you may wish to make jQuery UI dependent on jQuery.
* *
* <code> * <code>
* // Register jQuery UI as dependent on jQuery * // Register jQuery UI as dependent on jQuery
* Asset::add('jquery-ui', 'js/jquery-ui.js', 'jquery'); * Asset::add('jquery-ui', 'js/jquery-ui.js', 'jquery');
* *
* // Register jQuery UI with multiple dependencies * // Register jQuery UI with multiple dependencies
* Asset::add('jquery-ui', 'js/jquery-ui.js', array('jquery', 'fader')); * Asset::add('jquery-ui', 'js/jquery-ui.js', array('jquery', 'fader'));
* </code> * </code>
* *
* @param string $name * @param string $name
@ -227,7 +226,7 @@ private function get_group($group)
* Get the link to a single registered CSS asset. * Get the link to a single registered CSS asset.
* *
* <code> * <code>
* echo $container->get_style('common'); * echo $container->get_style('common');
* </code> * </code>
* *
* @param string $name * @param string $name
@ -242,7 +241,7 @@ public function get_style($name)
* Get the link to a single registered JavaScript asset. * Get the link to a single registered JavaScript asset.
* *
* <code> * <code>
* echo $container->get_script('jquery'); * echo $container->get_script('jquery');
* </code> * </code>
* *
* @param string $name * @param string $name

18
system/auth.php
View File

@ -31,10 +31,10 @@ class Auth {
* Determine if the current user of the application is authenticated. * Determine if the current user of the application is authenticated.
* *
* <code> * <code>
* if (Auth::check()) * if (Auth::check())
* { * {
* // The user is logged in... * // The user is logged in...
* } * }
* </code> * </code>
* *
* @return bool * @return bool
@ -53,7 +53,7 @@ public static function check()
* of the closure will be cached and returned. * of the closure will be cached and returned.
* *
* <code> * <code>
* $email = Auth::user()->email; * $email = Auth::user()->email;
* </code> * </code>
* *
* @return object * @return object
@ -79,10 +79,10 @@ public static function user()
* by the Hash class when authenticating. * by the Hash class when authenticating.
* *
* <code> * <code>
* if (Auth::login('test@gmail.com', 'secret')) * if (Auth::login('test@gmail.com', 'secret'))
* { * {
* // The credentials are valid... * // The credentials are valid...
* } * }
* </code> * </code>
* *
* @param string $username * @param string $username