CWidget

Property Details

actionPrefix property

public string $actionPrefix;

the prefix to the IDs of the actions. When a widget is declared an action provider in CController::actions, a prefix can be specified to differentiate its action IDs from others. The same prefix should then also be used to configure this property when the widget is used in a view of the controller.

controller property read-only

public CController getController()

Returns the controller that this widget belongs to.

id property

public string getId(boolean $autoGenerate=true)
public void setId(string $value)

Returns the ID of the widget or generates a new one if requested.

owner property read-only

public CBaseController getOwner()

Returns the owner/creator of this widget.

skin property (available since v1.1)

public mixed $skin;

the name of the skin to be used by this widget. Defaults to 'default'. If this is set as false, no skin will be applied to this widget.

viewPath property read-only

public string getViewPath(boolean $checkTheme=false)

Returns the directory containing the view files for this widget. The default implementation returns the 'views' subdirectory of the directory containing the widget class file. If $checkTheme is set true, the directory "ThemeID/views/ClassName" will be returned when it exists.

Method Details

__construct() method

public void __construct(CBaseController $owner=NULL)

public function __construct($owner=null)
{
    $this->_owner=$owner===null?Yii::app()->getController():$owner;
}

Constructor.

actions() method

public static array actions()

public static function actions()
{
    return array();
}

Returns a list of actions that are used by this widget. The structure of this method's return value is similar to that returned by CController::actions.

When a widget uses several actions, you can declare these actions using this method. The widget will then become an action provider, and the actions can be easily imported into a controller.

Note, when creating URLs referring to the actions listed in this method, make sure the action IDs are prefixed with actionPrefix.

getController() method

public CController getController()

public function getController()
{
    if($this->_owner instanceof CController)
        return $this->_owner;
    else
        return Yii::app()->getController();
}

Returns the controller that this widget belongs to.

getId() method

public string getId(boolean $autoGenerate=true)

public function getId($autoGenerate=true)
{
    if($this->_id!==null)
        return $this->_id;
    elseif($autoGenerate)
        return $this->_id='yw'.self::$_counter++;
}

Returns the ID of the widget or generates a new one if requested.

getOwner() method

public CBaseController getOwner()

public function getOwner()
{
    return $this->_owner;
}

Returns the owner/creator of this widget.

getViewFile() method

public string getViewFile(string $viewName)

public function getViewFile($viewName)
{
    if(($renderer=Yii::app()->getViewRenderer())!==null)
        $extension=$renderer->fileExtension;
    else
        $extension='.php';
    if(strpos($viewName,'.')) // a path alias
        $viewFile=Yii::getPathOfAlias($viewName);
    else
    {
        $viewFile=$this->getViewPath(true).DIRECTORY_SEPARATOR.$viewName;
        if(is_file($viewFile.$extension))
            return Yii::app()->findLocalizedFile($viewFile.$extension);
        elseif($extension!=='.php' && is_file($viewFile.'.php'))
            return Yii::app()->findLocalizedFile($viewFile.'.php');
        $viewFile=$this->getViewPath(false).DIRECTORY_SEPARATOR.$viewName;
    }

    if(is_file($viewFile.$extension))
        return Yii::app()->findLocalizedFile($viewFile.$extension);
    elseif($extension!=='.php' && is_file($viewFile.'.php'))
        return Yii::app()->findLocalizedFile($viewFile.'.php');
    else
        return false;
}

Looks for the view script file according to the view name. This method will look for the view under the widget's viewPath. The view script file is named as "ViewName.php". A localized view file may be returned if internationalization is needed. See CApplication::findLocalizedFile for more details. The view name can also refer to a path alias if it contains dot characters.

getViewPath() method

public string getViewPath(boolean $checkTheme=false)

public function getViewPath($checkTheme=false)
{
    $className=get_class($this);
    $scope=$checkTheme?'theme':'local';
    if(isset(self::$_viewPaths[$className][$scope]))
        return self::$_viewPaths[$className][$scope];
    else
    {
        if($checkTheme && ($theme=Yii::app()->getTheme())!==null)
        {
            $path=$theme->getViewPath().DIRECTORY_SEPARATOR;
            if(strpos($className,'\\')!==false) // namespaced class
                $path.=str_replace('\\','_',ltrim($className,'\\'));
            else
                $path.=$className;
            if(is_dir($path))
                return self::$_viewPaths[$className]['theme']=$path;
        }

        $class=new ReflectionClass($className);
        return self::$_viewPaths[$className]['local']=dirname($class->getFileName()).DIRECTORY_SEPARATOR.'views';
    }
}

Returns the directory containing the view files for this widget. The default implementation returns the 'views' subdirectory of the directory containing the widget class file. If $checkTheme is set true, the directory "ThemeID/views/ClassName" will be returned when it exists.

init() method

public void init()

public function init()
{
}

Initializes the widget. This method is called by CBaseController::createWidget and CBaseController::beginWidget after the widget's properties have been initialized.

render() method

public string render(string $view, array $data=NULL, boolean $return=false)

public function render($view,$data=null,$return=false)
{
    if(($viewFile=$this->getViewFile($view))!==false)
        return $this->renderFile($viewFile,$data,$return);
    else
        throw new CException(Yii::t('yii','{widget} cannot find the view "{view}".',
            array('{widget}'=>get_class($this), '{view}'=>$view)));
}

Renders a view.

The named view refers to a PHP script (resolved via getViewFile) that is included by this method. If $data is an associative array, it will be extracted as PHP variables and made available to the script.

run() method

public void run()

public function run()
{
}

Executes the widget. This method is called by CBaseController::endWidget.

setId() method

public void setId(string $value)

public function setId($value)
{
    $this->_id=$value;
}

Sets the ID of the widget.