Class yii\base\Widget

This method is invoked right after a widget is executed.

The method will trigger the EVENT_AFTER_RUN event. The return value of the method will be used as the widget return value.

If you override this method, your code should look like the following:

public function afterRun($result)
{
    $result = parent::afterRun($result);
    // your custom code here
    return $result;
}

This method is invoked right before the widget is executed.

The method will trigger the EVENT_BEFORE_RUN event. The return value of the method will determine whether the widget should continue to run.

When overriding this method, make sure you call the parent implementation like the following:

public function beforeRun()
{
    if (!parent::beforeRun()) {
        return false;
    }

    // your custom code here

    return true; // or false to not run the widget
}

Begins a widget.

This method creates an instance of the calling class. It will apply the configuration to the created instance. A matching end() call should be called later. As some widgets may use output buffering, the end() call should be made in the same view to avoid breaking the nesting of output buffers.

See also end().

Ends a widget.

Note that the rendering result of the widget is directly echoed out.

See also begin().

Returns the ID of the widget.

Returns the view object that can be used to render views or view files.

The render() and renderFile() methods will use this view object to implement the actual view rendering. If not set, it will default to the "view" application component.

Returns the directory containing the view files for this widget.

The default implementation returns the 'views' subdirectory under the directory containing the widget class file.

Initializes the object.

This method is called at the end of the constructor. The default implementation will trigger an EVENT_INIT event.

Renders a view.

The view to be rendered can be specified in one of the following formats:

• path alias (e.g. "@app/views/site/index");
• absolute path within application (e.g. "//site/index"): the view name starts with double slashes. The actual view file will be looked for under the yii\base\Application::viewPath of the application.
• absolute path within module (e.g. "/site/index"): the view name starts with a single slash. The actual view file will be looked for under the yii\base\Module::viewPath of the currently active module.
• relative path (e.g. "index"): the actual view file will be looked for under \yii\base\viewPath.

If the view name does not contain a file extension, it will use the default one .php.

Renders a view file.

Executes the widget.

Sets the ID of the widget.

Sets the view object to be used by this widget.

Creates a widget instance and runs it.

The widget rendering result is returned by this method.