CWebModule

属性详细

mapping from controller ID to controller configurations. Pleaser refer to CWebApplication::controllerMap for more details.

the directory that contains the controller classes. Defaults to 'moduleDir/controllers' where moduleDir is the directory containing the module class.

the ID of the default controller for this module. Defaults to 'default'.

Returns the description of this module. The default implementation returns an empty string. You may override this method to customize the description of this module.

the layout that is shared by the controllers inside this module. If a controller has explicitly declared its own layout, this property will be ignored. If this is null (default), the application's layout or the parent module's layout (if available) will be used. If this is false, then no layout will be used.

the root directory of layout files. Defaults to 'moduleDir/views/layouts' where moduleDir is the directory containing the module class.

Returns the name of this module. The default implementation simply returns id. You may override this method to customize the name of this module.

Returns the version of this module. The default implementation returns '1.0'. You may override this method to customize the version of this module.

the root directory of view files. Defaults to 'moduleDir/views' where moduleDir is the directory containing the module class.

方法详细

public function afterControllerAction($controller,$action)
{
    if(($parent=$this->getParentModule())===null)
        $parent=Yii::app();
    $parent->afterControllerAction($controller,$action);
}

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.

public function beforeControllerAction($controller,$action)
{
    if(($parent=$this->getParentModule())===null)
        $parent=Yii::app();
    return $parent->beforeControllerAction($controller,$action);
}

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:

if(parent::beforeControllerAction($controller,$action))
{
    // your code
    return true;
}
else
    return false;

public function getControllerPath()
{
    if($this->_controllerPath!==null)
        return $this->_controllerPath;
    else
        return $this->_controllerPath=$this->getBasePath().DIRECTORY_SEPARATOR.'controllers';
}

public function getDescription()
{
    return '';
}

Returns the description of this module. The default implementation returns an empty string. You may override this method to customize the description of this module.

public function getLayoutPath()
{
    if($this->_layoutPath!==null)
        return $this->_layoutPath;
    else
        return $this->_layoutPath=$this->getViewPath().DIRECTORY_SEPARATOR.'layouts';
}

public function getName()
{
    return basename($this->getId());
}

Returns the name of this module. The default implementation simply returns id. You may override this method to customize the name of this module.

public function getVersion()
{
    return '1.0';
}

Returns the version of this module. The default implementation returns '1.0'. You may override this method to customize the version of this module.

public function getViewPath()
{
    if($this->_viewPath!==null)
        return $this->_viewPath;
    else
        return $this->_viewPath=$this->getBasePath().DIRECTORY_SEPARATOR.'views';
}

public function setControllerPath($value)
{
    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)));
}

public function setLayoutPath($path)
{
    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)));
}

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)));
}