Mirrors/yii
2
0
Fork 0
mirror of https://github.com/yiisoft/yii.git synced 2026-03-11 18:46:59 +01:00
Code Issues Packages Projects Releases Wiki Activity

Documented component accessors with @property for significantly better IDE autocomplete

Browse Source
This commit is contained in:
alexander.makarow
2011-10-25 00:01:09 +00:00
parent fe3a175e91
commit 646cbb2b9a
86 changed files with 473 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
framework/base/CModule.php
View File

@@ -13,18 +13,29 @@
*
* CModule mainly manages application components and sub-modules.
*
* @property string $id The module ID.
* @property string $basePath The root directory of the module. Defaults to the directory containing the module class.
* @property CAttributeCollection $params The list of user-defined parameters.
* @property string $modulePath The directory that contains the application modules. Defaults to the 'modules' subdirectory of {@link basePath}.
* @property CModule $parentModule The parent module. Null if this module does not have a parent.
* @property array $modules The configuration of the currently installed modules (module ID => configuration).
* @property array $components The application components (indexed by their IDs).
* @property array $import List of aliases to be imported.
* @property array $aliases List of aliases to be defined. The array keys are root aliases,
* while the array values are paths or aliases corresponding to the root aliases.
* For example,
* <pre>
* array(
* 'models'=>'application.models', // an existing alias
* 'extensions'=>'application.extensions', // an existing alias
* 'backend'=>dirname(__FILE__).'/../backend', // a directory
* )
* </pre>.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @version $Id$
* @package system.base
* @since 1.0.4
*
* @property string $basePath Returns the root directory of the module.
* @property array $components Returns the application components.
* @property string $id Returns the module ID.
* @property string $modulePath Returns the directory that contains the application modules.
* @property array $modules Returns the configuration of the currently installed modules.
* @property CAttributeCollection $params Returns user-defined parameters.
* @property CModule $parentModule Returns the parent module.
*/
abstract class CModule extends CComponent
{