mirror of
https://github.com/yiisoft/yii.git
synced 2026-03-15 04:26:52 +01:00
merge from 1.0
This commit is contained in:
qiang.xue
@@ -21,16 +21,12 @@
|
||||
* @package system.web
|
||||
* @since 1.0.3
|
||||
*/
|
||||
class CWebModule extends CComponent
|
||||
class CWebModule extends CModule
|
||||
{
|
||||
/**
|
||||
* @var string the ID of the default controller for this module. Defaults to 'default'.
|
||||
*/
|
||||
public $defaultController='default';
|
||||
/**
|
||||
* @var array the IDs of the module components that should be preloaded.
|
||||
*/
|
||||
public $preload=array();
|
||||
/**
|
||||
* @var mixed the layout that is shared by the controllers inside this module.
|
||||
* If a controller has explicitly declared its own {@link CController::layout layout},
|
||||
@@ -44,94 +40,11 @@ class CWebModule extends CComponent
|
||||
* Pleaser refer to {@link CWebApplication::controllerMap} for more details.
|
||||
*/
|
||||
public $controllerMap=array();
|
||||
/**
|
||||
* @var array the behaviors that should be attached to the module.
|
||||
* The behaviors will be attached to the application when {@link init} is called.
|
||||
* Please refer to {@link CModel::behaviors} on how to specify the value of this property.
|
||||
*/
|
||||
public $behaviors=array();
|
||||
|
||||
private $_id;
|
||||
private $_parentModule;
|
||||
private $_params;
|
||||
private $_basePath;
|
||||
private $_moduleConfig=array();
|
||||
private $_modules=array();
|
||||
private $_components=array();
|
||||
private $_componentConfig=array();
|
||||
private $_controllerPath;
|
||||
private $_viewPath;
|
||||
private $_layoutPath;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
* @param string the ID of this module
|
||||
* @param CWebModule the parent module (if any)
|
||||
*/
|
||||
public function __construct($id, $parent=null)
|
||||
{
|
||||
$this->_id=$id;
|
||||
$this->_parentModule=$parent;
|
||||
}
|
||||
|
||||
/**
|
||||
* Getter magic method.
|
||||
* This method is overridden to support accessing module components
|
||||
* like reading module properties.
|
||||
* @param string module component or property name
|
||||
* @return mixed the named property value
|
||||
*/
|
||||
public function __get($name)
|
||||
{
|
||||
if($this->hasComponent($name))
|
||||
return $this->getComponent($name);
|
||||
else
|
||||
return parent::__get($name);
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if a property value is null.
|
||||
* This method overrides the parent implementation by checking
|
||||
* if the named module component is loaded.
|
||||
* @param string the property name or the event name
|
||||
* @return boolean whether the property value is null
|
||||
* @since 1.0.1
|
||||
*/
|
||||
public function __isset($name)
|
||||
{
|
||||
if($this->hasComponent($name))
|
||||
return $this->getComponent($name)!==null;
|
||||
else
|
||||
return parent::__isset($name);
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes this module.
|
||||
* This method is invoked automatically when the module is initially created.
|
||||
* You may override this method to customize the module or the application.
|
||||
* Make sure you call the parent implementation so that the module gets configured.
|
||||
* @param mixed the configuration array or a PHP script returning the configuration array.
|
||||
* The configuration will be applied to this module.
|
||||
*/
|
||||
public function init($config)
|
||||
{
|
||||
$this->configure($config);
|
||||
$this->attachBehaviors($this->behaviors);
|
||||
$this->preloadComponents();
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string the module ID.
|
||||
*/
|
||||
public function getId()
|
||||
{
|
||||
return $this->_id;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return CWebModule the parent module. Null if this module does not have parent.
|
||||
*/
|
||||
public function getParentModule()
|
||||
{
|
||||
return $this->_parentModule;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the name of this module.
|
||||
@@ -141,7 +54,7 @@ class CWebModule extends CComponent
|
||||
*/
|
||||
public function getName()
|
||||
{
|
||||
return basename($this->_id);
|
||||
return basename($this->getId());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -167,260 +80,108 @@ class CWebModule extends CComponent
|
||||
}
|
||||
|
||||
/**
|
||||
* @return CAttributeCollection the list of module parameters
|
||||
*/
|
||||
public function getParams()
|
||||
{
|
||||
if($this->_params!==null)
|
||||
return $this->_params;
|
||||
else
|
||||
return $this->_params=new CAttributeCollection;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array module parameters. This should be in name-value pairs.
|
||||
*/
|
||||
public function setParams($value)
|
||||
{
|
||||
$params=$this->getParams();
|
||||
foreach($value as $k=>$v)
|
||||
$params->add($k,$v);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string the root directory of the module. Defaults to the directory containing the module class.
|
||||
*/
|
||||
public function getBasePath()
|
||||
{
|
||||
if($this->_basePath===null)
|
||||
{
|
||||
$class=new ReflectionClass(get_class($this));
|
||||
$this->_basePath=dirname($class->getFileName());
|
||||
}
|
||||
return $this->_basePath;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string the directory that contains the controller classes. Defaults to the "controllers" sub-directory of {@link basePath}.
|
||||
* @return string the directory that contains the controller classes. Defaults to 'protected/controllers'.
|
||||
*/
|
||||
public function getControllerPath()
|
||||
{
|
||||
return $this->getBasePath().DIRECTORY_SEPARATOR.'controllers';
|
||||
if($this->_controllerPath!==null)
|
||||
return $this->_controllerPath;
|
||||
else
|
||||
return $this->_controllerPath=$this->getBasePath().DIRECTORY_SEPARATOR.'controllers';
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string the directory that contains the modules. Defaults to the "modules" sub-directory of {@link basePath}.
|
||||
* @param string the directory that contains the controller classes.
|
||||
* @throws CException if the directory is invalid
|
||||
*/
|
||||
public function getModulePath()
|
||||
public function setControllerPath($value)
|
||||
{
|
||||
return $this->getBasePath().DIRECTORY_SEPARATOR.'modules';
|
||||
if(($this->_controllerPath=realpath($value))===false || !is_dir($this->_controllerPath))
|
||||
throw new CException(Yii::t('yii','The controller path "{path}" is not a valid directory.',
|
||||
array('{path}'=>$value)));
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string the root directory of view files. Defaults to the "views" sub-directory of {@link basePath}.
|
||||
* @return string the root directory of view files. Defaults to 'protected/views'.
|
||||
*/
|
||||
public function getViewPath()
|
||||
{
|
||||
return $this->getBasePath().DIRECTORY_SEPARATOR.'views';
|
||||
if($this->_viewPath!==null)
|
||||
return $this->_viewPath;
|
||||
else
|
||||
return $this->_viewPath=$this->getBasePath().DIRECTORY_SEPARATOR.'views';
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string the root directory of layout files. Defaults to the "layouts" sub-directory of {@link viewPath}.
|
||||
* @param string the root directory of view files.
|
||||
* @throws CException if the directory does not exist.
|
||||
*/
|
||||
public function setViewPath($path)
|
||||
{
|
||||
if(($this->_viewPath=realpath($path))===false || !is_dir($this->_viewPath))
|
||||
throw new CException(Yii::t('yii','The view path "{path}" is not a valid directory.',
|
||||
array('{path}'=>$path)));
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string the root directory of layout files. Defaults to 'protected/views/layouts'.
|
||||
*/
|
||||
public function getLayoutPath()
|
||||
{
|
||||
return $this->getViewPath().DIRECTORY_SEPARATOR.'layouts';
|
||||
if($this->_layoutPath!==null)
|
||||
return $this->_layoutPath;
|
||||
else
|
||||
return $this->_layoutPath=$this->getViewPath().DIRECTORY_SEPARATOR.'layouts';
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the named application module.
|
||||
* @param string application module ID (case-sensitive)
|
||||
* @return CWebModule the application module instance, null if the application module is disabled or does not exist.
|
||||
* @param string the root directory of layout files.
|
||||
* @throws CException if the directory does not exist.
|
||||
*/
|
||||
public function getModule($id)
|
||||
public function setLayoutPath($path)
|
||||
{
|
||||
if(isset($this->_modules[$id]))
|
||||
return $this->_modules[$id];
|
||||
else if(isset($this->_moduleConfig[$id]))
|
||||
{
|
||||
$config=$this->_moduleConfig[$id];
|
||||
unset($this->_moduleConfig[$id]);
|
||||
if(($module=Yii::app()->createModule($id,$config,$this))!==null)
|
||||
return $this->_modules[$id]=$module;
|
||||
}
|
||||
if(($this->_layoutPath=realpath($path))===false || !is_dir($this->_layoutPath))
|
||||
throw new CException(Yii::t('yii','The layout path "{path}" is not a valid directory.',
|
||||
array('{path}'=>$path)));
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array the currently loaded application modules (indexed by their IDs)
|
||||
*/
|
||||
public function getModules()
|
||||
{
|
||||
return $this->_modules;
|
||||
}
|
||||
|
||||
/**
|
||||
* Configures the modules belonging to this module.
|
||||
*
|
||||
* Call this method to declare sub-modules and configure them with their initial property values.
|
||||
* The parameter should be an array of module configurations. Each array element represents a single module,
|
||||
* which can be either a string representing the module ID or an ID-config pair representing
|
||||
* a module with the specified ID and the initial property values.
|
||||
*
|
||||
* For example, the following array declares two modules:
|
||||
* The pre-filter for controller actions.
|
||||
* This method is invoked before the currently requested controller action and all its filters
|
||||
* are executed. You may override this method in the following way:
|
||||
* <pre>
|
||||
* array(
|
||||
* 'admin',
|
||||
* 'payment'=>array(
|
||||
* 'server'=>'paymentserver.com',
|
||||
* ),
|
||||
* )
|
||||
* if(parent::beforeControllerAction($controller,$action))
|
||||
* {
|
||||
* // your code
|
||||
* return true;
|
||||
* }
|
||||
* else
|
||||
* return false;
|
||||
* </pre>
|
||||
*
|
||||
* By default, the module class is determined using the expression <code>ucfirst($moduleID).'Module'</code>.
|
||||
* And the class file is located under <code>modules/$moduleID</code>.
|
||||
* You may override this default by explicitly specifying the 'class' option in the configuration.
|
||||
*
|
||||
* You may also enable or disable a module by specifying the 'enabled' option in the configuration.
|
||||
*
|
||||
* @param array application module configuration.
|
||||
* @param CController the controller
|
||||
* @param CAction the action
|
||||
* @return boolean whether the action should be executed.
|
||||
* @since 1.0.4
|
||||
*/
|
||||
public function setModules($modules)
|
||||
public function beforeControllerAction($controller,$action)
|
||||
{
|
||||
foreach($modules as $id=>$module)
|
||||
{
|
||||
if(is_int($id))
|
||||
{
|
||||
$id=$module;
|
||||
$module=array();
|
||||
}
|
||||
if(!isset($module['class']))
|
||||
$module['classFile']=$this->getModulePath().DIRECTORY_SEPARATOR.$id.DIRECTORY_SEPARATOR.ucfirst($id).'Module.php';
|
||||
|
||||
if(isset($this->_moduleConfig[$id]))
|
||||
$this->_moduleConfig[$id]=CMap::mergeArray($this->_moduleConfig[$id],$module);
|
||||
else
|
||||
$this->_moduleConfig[$id]=$module;
|
||||
}
|
||||
if(($parent=$this->getParentModule())===null)
|
||||
$parent=Yii::app();
|
||||
return $parent->beforeControllerAction($controller,$action);
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads static module components.
|
||||
* The post-filter for controller actions.
|
||||
* This method is invoked after the currently requested controller action and all its filters
|
||||
* are executed. If you override this method, make sure you call the parent implementation at the end.
|
||||
* @param CController the controller
|
||||
* @param CAction the action
|
||||
* @since 1.0.4
|
||||
*/
|
||||
protected function preloadComponents()
|
||||
public function afterControllerAction($controller,$action)
|
||||
{
|
||||
foreach($this->preload as $id)
|
||||
$this->getComponent($id);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string module component ID
|
||||
* @return boolean whether the named module component exists (including both loaded and disabled.)
|
||||
*/
|
||||
public function hasComponent($id)
|
||||
{
|
||||
return isset($this->_components[$id]) || isset($this->_componentConfig[$id]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the named module component.
|
||||
* @param string application component ID (case-sensitive)
|
||||
* @return IApplicationComponent the module component instance, null if the module component is disabled or does not exist.
|
||||
* @see hasComponent
|
||||
*/
|
||||
public function getComponent($id)
|
||||
{
|
||||
if(isset($this->_components[$id]))
|
||||
return $this->_components[$id];
|
||||
else if(isset($this->_componentConfig[$id]))
|
||||
{
|
||||
$config=$this->_componentConfig[$id];
|
||||
unset($this->_componentConfig[$id]);
|
||||
if(!isset($config['enabled']) || $config['enabled'])
|
||||
{
|
||||
Yii::trace("Loading \"$id\" module component",'system.web.CWebModule');
|
||||
unset($config['enabled']);
|
||||
$component=Yii::createComponent($config);
|
||||
$component->init();
|
||||
return $this->_components[$id]=$component;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Puts a component under the management of the module.
|
||||
* The component will be initialized (by calling its {@link CApplicationComponent::init() init()}
|
||||
* method if it has not done so.
|
||||
* @param string component ID
|
||||
* @param IApplicationComponent the component
|
||||
*/
|
||||
public function setComponent($id,$component)
|
||||
{
|
||||
$this->_components[$id]=$component;
|
||||
if(!$component->getIsInitialized())
|
||||
$component->init();
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array the currently loaded components (indexed by their IDs)
|
||||
*/
|
||||
public function getComponents()
|
||||
{
|
||||
return $this->_components;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the module components.
|
||||
*
|
||||
* When a configuration is used to specify a component, it should consist of
|
||||
* the component's initial property values (name-value pairs). Additionally,
|
||||
* a component can be enabled (default) or disabled by specifying the 'enabled' value
|
||||
* in the configuration.
|
||||
*
|
||||
* If a configuration is specified with an ID that is the same as an existing
|
||||
* component or configuration, the existing one will be replaced silently.
|
||||
*
|
||||
* The following is the configuration for two components:
|
||||
* <pre>
|
||||
* array(
|
||||
* 'db'=>array(
|
||||
* 'class'=>'CDbConnection',
|
||||
* 'connectionString'=>'sqlite:path/to/file.db',
|
||||
* ),
|
||||
* 'cache'=>array(
|
||||
* 'class'=>'CDbCache',
|
||||
* 'connectionID'=>'db',
|
||||
* 'enabled'=>!YII_DEBUG, // enable caching in non-debug mode
|
||||
* ),
|
||||
* )
|
||||
* </pre>
|
||||
*
|
||||
* @param array module components(id=>component configuration or instances)
|
||||
*/
|
||||
public function setComponents($components)
|
||||
{
|
||||
foreach($components as $id=>$component)
|
||||
{
|
||||
if($component instanceof IApplicationComponent)
|
||||
$this->setComponent($id,$component);
|
||||
else if(isset($this->_componentConfig[$id]))
|
||||
$this->_componentConfig[$id]=CMap::mergeArray($this->_componentConfig[$id],$component);
|
||||
else
|
||||
$this->_componentConfig[$id]=$component;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Configures the module with the specified configuration.
|
||||
* @param mixed the configuration array or a PHP script returning the configuration array.
|
||||
*/
|
||||
public function configure($config)
|
||||
{
|
||||
if(is_string($config))
|
||||
$config=require($config);
|
||||
if(is_array($config))
|
||||
{
|
||||
foreach($config as $key=>$value)
|
||||
$this->$key=$value;
|
||||
}
|
||||
if(($parent=$this->getParentModule())===null)
|
||||
$parent=Yii::app();
|
||||
$parent->afterControllerAction($controller,$action);
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user