Класс yii\base\Widget

public static string $autoIdPrefix = 'w'

public static integer $counter = 0

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

public static yii\base\Widget[] $stack = []

public yii\web\View getView ( )
public void setView ( $view )

public string getViewPath ( )

afterRun() public method (available since version 2.0.11)

Этот метод вызывается сразу после выполнения виджета.

Метод вызовет событие EVENT_AFTER_RUN. Возвращаемое значение метода будет использовано в качестве возвращаемого значения виджета.

Если вы переопределите этот метод, ваш код должен выглядеть следующим образом:

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

public mixed afterRun ( $result )
$result	mixed	Результат выполнения виджета.
return	mixed	Обработанный результат виджета.

beforeRun() public method (available since version 2.0.11)

Этот метод вызывается непосредственно перед выполнением виджета.

Метод вызовет событие EVENT_BEFORE_RUN. Возвращаемое значение метода определит, следует ли продолжить выполнение виджета.

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

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

    // your custom code here

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

public boolean beforeRun ( )
return	boolean	Следует ли продолжить выполнение виджета.

begin() public static method

Начинает работу виджета.

Этот метод создаёт экземпляр вызываемого класса. Он применит конфигурацию к созданному экземпляру. Позже должен быть вызван соответствующий метод end(). Так как некоторые виджеты могут использовать буферизацию вывода, вызов end() должен быть выполнен в том же представлении, чтобы избежать нарушения вложенности буферов вывода.

См. также end().

public static static begin ( $config = [] )
$config	array	Пары «имя-значение», которые будут использованы для инициализации свойств объекта
return	static	Новый созданный экземпляр виджета

end() public static method

Завершает работу виджета.

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

См. также begin().

public static static end ( )
return	static	Экземпляр виджета, который завершается.
throws	yii\base\InvalidCallException	если вызовы begin() и end() не вложены должным образом

getId() public method

Возвращает идентификатор виджета.

public string getId ( $autoGenerate = true )
$autoGenerate	boolean	Следует ли сгенерировать идентификатор, если он ранее не был задан
return	string	Идентификатор виджета.

getView() public method

Возвращает объект представления, который можно использовать для рендеринга представлений или файлов представлений.

Методы render() и renderFile() будут использовать этот объект представления для реализации фактического рендеринга представления. Если не задано, он будет по умолчанию использовать компонент «представление» приложения.

public yii\web\View getView ( )
return	yii\web\View	Объект представления, который можно использовать для рендеринга представлений или файлов представлений.

getViewPath() public method

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

Реализация по умолчанию возвращает поддиректорию «views» в директории, содержащей файл класса виджета.

public string getViewPath ( )
return	string	Директория, содержащая файлы представления для этого виджета.

init() public method

Инициализирует объект.

Этот метод вызывается в конце конструктора. Реализация по умолчанию вызовет событие EVENT_INIT.

public void init ( )

render() public method

Рендерит представление.

Представление, подлежащее рендерингу, может быть указано в одном из следующих форматов:

• Путь алиас (например, "@app/views/site/index");
• Абсолютный путь в приложении (например, "//site/index"): имя представления начинается с двойных слешей. Фактический файл представления будет искаться в пути представления приложения.
• Абсолютный путь в модуле (например, "/site/index"): имя представления начинается с одного слеша. Фактический файл представления будет искаться в пути представления текущего активного модуля.
• Относительный путь (например, "index"): фактический файл представления будет искаться в $viewPath.

Если имя представления не содержит расширения файла, будет использоваться по умолчанию .php.

public string render ( $view, $params = [] )
$view	string	Имя представления.
$params	array	Параметры (пары «имя-значение»), которые должны быть доступны в представлении.
return	string	Результат рендеринга.
throws	yii\base\InvalidParamException	если файл представления не существует.

renderFile() public method

Рендерит файл представления.

public string renderFile ( $file, $params = [] )
$file	string	Файл представления, который нужно рендерить. Это может быть путь к файлу или алиас пути.
$params	array	Параметры (пары «имя-значение»), которые должны быть доступны в представлении.
return	string	Результат рендеринга.
throws	yii\base\InvalidParamException	если файл представления не существует.

run() public method

Выполняет виджет.

public string run ( )
return	string	Результат выполнения виджета, который должен быть выведен.

setId() public method

Устанавливает идентификатор виджета.

public void setId ( $value )
$value	string	Идентификатор виджета.

setView() public method

Устанавливает объект представления, который будет использоваться этим виджетом.

public void setView ( $view )
$view	yii\base\View	Объект представления, который можно использовать для рендеринга представлений или файлов представлений.

widget() public static method

Создаёт экземпляр виджета и выполняет его.

Результат рендеринга виджета возвращается этим методом.

public static string widget ( $config = [] )
$config	array	Пары «имя-значение», которые будут использованы для инициализации свойств объекта
return	string	Результат рендеринга виджета.
throws	Exception