CWebModule

Подробное описание свойств

controllerMap свойство

public array $controllerMap;

отображение ID контроллера на конфигурации контроллера. Для получения более подробной информации обратитесь к CWebApplication::controllerMap.

controllerNamespace свойство (доступно начиная с v1.1.11)

public string $controllerNamespace;

Пространство имён, которое должно быть использовано при загрузке контроллеров. По умолчанию используется глобальное пространство имён.

controllerPath свойство

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

каталог, содержащий классы контроллеров. По умолчанию 'moduleDir/controllers', где moduleDir — каталог, содержащий класс модуля.

defaultController свойство

public string $defaultController;

ID контроллера по умолчанию для этого модуля. По умолчанию 'default'.

description свойство только для чтения

public string getDescription()

Возвращает описание этого модуля. По умолчанию возвращает пустую строку. Вы можете переопределить этот метод для настройки описания модуля.

layout свойство

public mixed $layout;

макет, используемый контроллерами внутри этого модуля. Если контроллер явно указал свой макет, это свойство будет проигнорировано. Если это null (по умолчанию), будет использован макет приложения или родительского модуля (если доступен). Если это false, макет не будет использован.

layoutPath свойство

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

корневой каталог файлов макетов. По умолчанию 'moduleDir/views/layouts', где moduleDir — каталог, содержащий класс модуля.

name свойство только для чтения

public string getName()

Возвращает имя этого модуля. По умолчанию возвращает id. Вы можете переопределить этот метод для настройки имени модуля.

version свойство только для чтения

public string getVersion()

Возвращает версию этого модуля. По умолчанию возвращает '1.0'. Вы можете переопределить этот метод для настройки версии модуля.

viewPath свойство

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

корневой каталог файлов представлений. По умолчанию 'moduleDir/views', где moduleDir — каталог, содержащий класс модуля.

Подробное описание методов

afterControllerAction() метод

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

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

Постобработчик для действий контроллера. Этот метод вызывается после выполнения действия текущего контроллера и всех его фильтров. Если вы переопределяете этот метод, убедитесь, что вы вызываете родительскую реализацию в конце.

beforeControllerAction() метод

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

Предфильтр для действий контроллера. Этот метод вызывается перед выполнением действия текущего контроллера и всех его фильтров. Вы можете переопределить этот метод следующим образом:

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

getControllerPath() метод

public string getControllerPath()

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

getDescription() метод

public string getDescription()

public function getDescription()
{
    return '';
}

Возвращает описание этого модуля. По умолчанию возвращает пустую строку. Вы можете переопределить этот метод для настройки описания модуля.

getLayoutPath() метод

public string getLayoutPath()

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

getName() метод

public string getName()

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

Возвращает имя этого модуля. По умолчанию возвращает id. Вы можете переопределить этот метод для настройки имени модуля.

getVersion() метод

public string getVersion()

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

Возвращает версию этого модуля. По умолчанию возвращает '1.0'. Вы можете переопределить этот метод для настройки версии модуля.

getViewPath() метод

public string getViewPath()

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

setControllerPath() метод

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() метод

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() метод

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