From d197a97aac3637d90c5afaefc0f8b44553272faa Mon Sep 17 00:00:00 2001 From: Taylor Otwell Date: Sun, 14 Aug 2011 19:40:52 -0500 Subject: [PATCH] remove comment bloat. --- system/arr.php | 8 -------- system/asset.php | 40 ---------------------------------------- system/auth.php | 18 ------------------ system/cache.php | 24 ------------------------ system/config.php | 16 ---------------- 5 files changed, 106 deletions(-) diff --git a/system/arr.php b/system/arr.php index d3b59d2e..0b65a831 100644 --- a/system/arr.php +++ b/system/arr.php @@ -9,14 +9,6 @@ class Arr { * also be accessed using JavaScript "dot" style notation. Retrieving items nested * in multiple arrays is also supported. * - * - * // Returns "taylor" - * $item = Arr::get(array('name' => 'taylor'), 'name', $default); - * - * // Returns "taylor" - * $item = Arr::get(array('name' => array('is' => 'taylor')), 'name.is'); - * - * * @param array $array * @param string $key * @param mixed $default diff --git a/system/asset.php b/system/asset.php index dacf8694..0b9ece27 100644 --- a/system/asset.php +++ b/system/asset.php @@ -21,17 +21,6 @@ class Asset { * Containers provide a convenient method of grouping assets while maintaining * expressive code and a clean API. * - * - * // Get the default asset container - * $container = Asset::container(); - * - * // Get the "footer" asset contanier - * $container = Asset::container('footer'); - * - * // Add an asset to the "footer" container - * Asset::container('footer')->add('jquery', 'js/jquery.js'); - * - * * @param string $container * @return Asset_Container */ @@ -47,14 +36,6 @@ public static function container($container = 'default') /** * Magic Method for calling methods on the default Asset container. - * - * - * // Add jQuery to the default container - * Asset::script('jquery', 'js/jquery.js'); - * - * // Equivalent call using the container method - * Asset::container()->script('jquery', 'js/jquery.js'); - * */ public static function __callStatic($method, $parameters) { @@ -97,23 +78,10 @@ public function __construct($name) * asset being registered (CSS or JavaScript). If you are using a non-standard * extension, you may use the style or script methods to register assets. * - * - * // Register a jQuery asset - * Asset::add('jquery', 'js/jquery.js'); - * - * * You may also specify asset dependencies. This will instruct the class to * only link to the registered asset after its dependencies have been linked. * For example, you may wish to make jQuery UI dependent on jQuery. * - * - * // Register jQuery UI as dependent on jQuery - * Asset::add('jquery-ui', 'js/jquery-ui.js', 'jquery'); - * - * // Register jQuery UI with multiple dependencies - * Asset::add('jquery-ui', 'js/jquery-ui.js', array('jquery', 'fader')); - * - * * @param string $name * @param string $source * @param array $dependencies @@ -226,10 +194,6 @@ private function get_group($group) /** * Get the link to a single registered CSS asset. * - * - * echo $container->get_style('common'); - * - * * @param string $name * @return string */ @@ -241,10 +205,6 @@ public function get_style($name) /** * Get the link to a single registered JavaScript asset. * - * - * echo $container->get_script('jquery'); - * - * * @param string $name * @return string */ diff --git a/system/auth.php b/system/auth.php index 8c2ff3ab..3671b957 100644 --- a/system/auth.php +++ b/system/auth.php @@ -30,13 +30,6 @@ class Auth { /** * Determine if the current user of the application is authenticated. * - * - * if (Auth::check()) - * { - * // The user is logged in... - * } - * - * * @return bool * @see login */ @@ -52,10 +45,6 @@ public static function check() * the "by_id" closure in the authentication configuration file. The result * of the closure will be cached and returned. * - * - * $email = Auth::user()->email; - * - * * @return object * @see $user */ @@ -78,13 +67,6 @@ public static function user() * The password passed to the method should be plain text, as it will be hashed * by the Hash class when authenticating. * - * - * if (Auth::login('test@gmail.com', 'secret')) - * { - * // The credentials are valid... - * } - * - * * @param string $username * @param string $password * @return bool diff --git a/system/cache.php b/system/cache.php index 140d8b08..615e706b 100644 --- a/system/cache.php +++ b/system/cache.php @@ -47,22 +47,6 @@ public static function driver($driver = null) /** * Get an item from the cache. * - * If the cached item doesn't exist, the specified default value will be returned. - * - * - * // Get the "name" item from the cache - * $name = Cache::get('name'); - * - * // Get the "name" item, but return "Fred" if it doesn't exist - * $name = Cache::get('name', 'Fred'); - * - * - * The driver may also be specified: - * - * - * $name = Cache::get('name', null, 'memcached'); - * - * * @param string $key * @param mixed $default * @param string $driver @@ -82,14 +66,6 @@ public static function get($key, $default = null, $driver = null) * Get an item from the cache. If the item doesn't exist in the cache, store * the default value in the cache and return it. * - * - * // Get the name item. If it doesn't exist, store "Fred" for 30 minutes - * $name = Cache::remember('name', 'Fred', 30); - * - * // Closures may also be used as default values - * $name = Cache::remember('votes', function() {return Vote::count();}, 30); - * - * * @param string $key * @param mixed $default * @param int $minutes diff --git a/system/config.php b/system/config.php index 3a48a10f..7580a821 100644 --- a/system/config.php +++ b/system/config.php @@ -32,14 +32,6 @@ public static function has($key) * If the name of a configuration file is passed without specifying an item, the * entire configuration array will be returned. * - * - * // Get the application timezone - * $timezone = Config::get('application.timezone'); - * - * // Get the application configuration array - * $application = Config::get('application'); - * - * * @param string $key * @param string $default * @return array @@ -63,14 +55,6 @@ public static function get($key, $default = null) * * If a configuration item is not specified, the entire configuration array will be set. * - * - * // Set the application timezone - * Config::set('application.timezone', 'America/Chicago'); - * - * // Set the application configuration array - * Config::set('application', array()); - * - * * @param string $key * @param mixed $value * @return void