adulau/cakephp2-php8
1
0
Fork 0
mirror of https://github.com/kamilwylegala/cakephp2-php8.git synced 2025-01-19 11:06:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Adding doc comments to Configure and App.

Browse source
This commit is contained in:
mark_story 2010-11-14 18:26:54 -05:00
parent b91566d35f
commit 1631f31460
2 changed files with 33 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
cake/libs/app.php
View file

@ -1,6 +1,6 @@
<?php <?php
/** /**
* Configure class * App class
* *
* PHP 5 * PHP 5
* *
@ -18,7 +18,29 @@
* @license MIT License (http://www.opensource.org/licenses/mit-license.php) * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/ */
/** /**
* Class/file loader and path management. * App is responsible for path managment, class location and class loading.
*
* ### Adding paths
*
* You can add paths to the search indexes App uses to find classes using `App::build()`. Adding
* additional controller paths for example would alter where CakePHP looks for controllers when you
* call App::import('Controller', 'Posts'); This allows you to split your application up across the filesystem.
*
* ### Inspecting loaded paths
*
* You can inspect the currently loaded paths using `App::path('controller')` for example to see loaded
* controller paths.
*
* ### Locating plugins and themes
*
* Plugins and Themes can be located with App as well. Using App::pluginPath('DebugKit') for example, will
* give you the full path to the DebugKit plugin. App::themePath('purple'), would give the full path to the
* `purple` theme.
*
* ### Inspecting known objects
*
* You can find out which objects App knows about using App::objects('controller') for example to find
* which application controllers App knows about.
* *
* @link http://book.cakephp.org/view/933/The-App-Class * @link http://book.cakephp.org/view/933/The-App-Class
* @package cake * @package cake

13
cake/libs/configure.php
View file

@ -19,7 +19,11 @@
*/ */
/** /**
* Configuration class (singleton). Used for managing runtime configuration information. * Configuration class. Used for managing runtime configuration information.
*
* Provides features for reading and writing to the runtime configuration, as well
* as methods for loading additional configuration files or storing runtime configuration
* for future use.
* *
* @package cake * @package cake
* @subpackage cake.cake.libs * @subpackage cake.cake.libs
@ -46,7 +50,7 @@ class Configure {
} }
/** /**
* Used to store a dynamic variable in the Configure instance. * Used to store a dynamic variable in Configure.
* *
* Usage: * Usage:
* {{{ * {{{
@ -126,7 +130,7 @@ class Configure {
} }
/** /**
* Used to read information stored in the Configure instance. Currently its not * Used to read information stored in Configure. Its not
* possible to store `null` values in Configure. * possible to store `null` values in Configure.
* *
* Usage: * Usage:
@ -173,7 +177,7 @@ class Configure {
} }
/** /**
* Used to delete a variable from the Configure instance. * Used to delete a variable from Configure.
* *
* Usage: * Usage:
* {{{ * {{{
@ -197,6 +201,7 @@ class Configure {
/** /**
* Loads a file from app/config/configure_file.php. * Loads a file from app/config/configure_file.php.
*
* Config file variables should be formated like: * Config file variables should be formated like:
* `$config['name'] = 'value';` * `$config['name'] = 'value';`
* These will be used to create dynamic Configure vars. load() is also used to * These will be used to create dynamic Configure vars. load() is also used to