CWebModule

Property Details

controllerMap property

public array $controllerMap;

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

controllerNamespace property (available since v1.1.11)

public string $controllerNamespace;

Namespace that should be used when loading controllers. Default is to use global namespace.

controllerPath property

public string getControllerPath()
public void setControllerPath(string $value)

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

defaultController property

public string $defaultController;

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

description property read-only

public string getDescription()

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.

layout property

public mixed $layout;

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.

layoutPath property

public string getLayoutPath()
public void setLayoutPath(string $path)

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

name property read-only

public string getName()

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

version property read-only

public string getVersion()

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

viewPath property

public string getViewPath()
public void setViewPath(string $path)

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

Method Details

afterControllerAction() method

public void afterControllerAction(CController $controller, CAction $action)

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.

beforeControllerAction() method

public boolean beforeControllerAction(CController $controller, CAction $action)

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;

getControllerPath() method

public string getControllerPath()

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

getDescription() method

public string getDescription()

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.

getLayoutPath() method

public string getLayoutPath()

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

getName() method

public string getName()

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.

getVersion() method

public string getVersion()

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.

getViewPath() method

public string getViewPath()

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

setControllerPath() method

public void setControllerPath(string $value)

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

setLayoutPath() method

public void setLayoutPath(string $path)

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

setViewPath() method

public void setViewPath(string $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)));
}