Класс yii\widgets\Spaceless
| Наследование | yii\widgets\Spaceless » yii\base\Widget » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable, yii\base\ViewContextInterface |
| Доступна с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/widgets/Spaceless.php |
Виджет Spaceless удаляет символы пробелов между HTML-тегами. Пробелы внутри HTML-тегов или в простом тексте всегда остаются без изменений.
Пример использования:
<body>
<?php Spaceless::begin(); ?>
<div class="nav-bar">
<!-- tags -->
</div>
<div class="content">
<!-- tags -->
</div>
<?php Spaceless::end(); ?>
</body>
Этот пример сгенерирует следующий HTML:
<body>
<div class="nav-bar"><!-- tags --></div><div class="content"><!-- tags --></div></body>
Этот метод не предназначен для сжатия содержимого (для этого следует использовать gzip сжатие вывода). Основная цель — удалить дополнительные символы пробелов между HTML-тегами, чтобы избежать проблем с рендерингом браузером в некоторых случаях (например, переводы строки между элементами inline-block).
Обратите внимание, что никогда не используйте этот метод с pre или textarea тегами. Работа с такими тегами нетривиальна, как может показаться на первый взгляд. В этом случае следует рассмотреть использование HTML Tidy Project.
См. также http://tidy.sourceforge.net/.
Публичные свойства
| Свойство | Тип | Описание | Определено |
|---|---|---|---|
| $autoIdPrefix | string | Префикс для автоматически сгенерированных идентификаторов виджета. | yii\base\Widget |
| $behaviors | yii\base\Behavior[] | Список присоединенных к этому компоненту поведений. | yii\base\Component |
| $counter | integer | Счетчик, используемый для генерации $id для виджетов. | yii\base\Widget |
| $id | string | Идентификатор виджета. | yii\base\Widget |
| $stack | yii\base\Widget[] | Виджеты, которые в данный момент отрисовываются (не завершены). | yii\base\Widget |
| $view | yii\web\View | Объект представления, который можно использовать для рендеринга представлений или файлов представлений. | yii\base\Widget |
| $viewPath | string | Директория, содержащая файлы представления для этого виджета. | yii\base\Widget |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает метод по имени, который не является методом класса. | yii\base\Object |
| __clone() | Этот метод вызывается после создания объекта путём клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| afterRun() | Этот метод вызывается сразу после выполнения виджета. | yii\base\Widget |
| attachBehavior() | Присоединяет поведение к этому компоненту. | yii\base\Component |
| attachBehaviors() | Присоединяет список поведений к компоненту. | yii\base\Component |
| beforeRun() | Этот метод вызывается непосредственно перед выполнением виджета. | yii\base\Widget |
| begin() | Начинает работу виджета. | yii\base\Widget |
| behaviors() | Возвращает список поведений, по которым должен действовать этот компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, можно ли прочитать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| end() | Завершает работу виджета. | yii\base\Widget |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. | yii\base\Component |
| getBehavior() | Возвращает объект поведения по имени. | yii\base\Component |
| getBehaviors() | Возвращает все присоединённые к этому компоненту поведения. | yii\base\Component |
| getId() | Возвращает идентификатор виджета. | yii\base\Widget |
| getView() | Возвращает объект представления, который можно использовать для рендеринга представлений или файлов представлений. | yii\base\Widget |
| getViewPath() | Возвращает директорию, содержащую файлы представлений для этого виджета. | yii\base\Widget |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчик, присоединённый к событию по имени. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Начинает захват вывода, чтобы очистить пробелы между HTML-тегами. | yii\widgets\Spaceless |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| render() | Рендерит представление. | yii\base\Widget |
| renderFile() | Рендерит файл представления. | yii\base\Widget |
| run() | Помечает конец содержимого, которое нужно очистить от пробелов между HTML-тегами. | yii\widgets\Spaceless |
| setId() | Устанавливает идентификатор виджета. | yii\base\Widget |
| setView() | Устанавливает объект представления, который будет использоваться этим виджетом. | yii\base\Widget |
| trigger() | Вызывает событие. | yii\base\Component |
| widget() | Создаёт экземпляр виджета и запускает его. | yii\base\Widget |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| EVENT_AFTER_RUN | yii\base\WidgetEvent | Событие, генерируемое сразу после выполнения виджета. (доступно с версии 2.0.11) | yii\base\Widget |
| EVENT_BEFORE_RUN | yii\base\WidgetEvent | Событие, генерируемое сразу перед выполнением виджета. (доступно с версии 2.0.11) | yii\base\Widget |
| EVENT_INIT | yii\base\Event | Событие, которое генерируется при инициализации виджета через init(). (доступно с версии 2.0.11) | yii\base\Widget |
Подробное описание методов
init() общедоступный метод
Начинает захват вывода, чтобы очистить пробелы между HTML-тегами.
| общедоступный void init ( ) |
|---|
run() общедоступный метод
Помечает конец содержимого, которое нужно очистить от пробелов между HTML-тегами.
Останавливает захват вывода и выводит очищенный результат.
| общедоступный void run ( ) |
|---|
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-widgets-spaceless.html
