Spec-Zone.ru › Laravel 5.3

Factory

class Factory implements Factory (View source)

Свойства

protected EngineResolver $engines Реализация движка.
protected ViewFinderInterface $finder Реализация поиска представлений.
protected Dispatcher $events Экземпляр диспетчера событий.
protected Container $container Экземпляр контейнера IoC.
protected array $shared Данные, которые должны быть доступны для всех шаблонов.
protected array $aliases Массив зарегистрированных псевдонимов имен представлений.
protected array $names Все зарегистрированные имена представлений.
protected array $extensions Связывание расширений с движками.
protected array $composers События композера представлений.
protected array $sections Все завершенные, захваченные разделы.
protected array $sectionStack Стек активных разделов.
protected array $loopsStack Стек активных циклов.
protected array $pushes Все завершенные, захваченные разделы push.
protected array $pushStack Стек активных разделов push.
protected int $renderCount Количество активных операций рендеринга.

Методы

void __construct(EngineResolver $engines, ViewFinderInterface $finder, Dispatcher $events)

Создать новый экземпляр фабрики представлений.

View file(string $path, array $data = [], array $mergeData = [])

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

View make(string $view, array $data = [], array $mergeData = [])

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

string normalizeName(string $name)

Нормализовать имя представления.

array parseData(mixed $data)

Разбор заданных данных в обычный массив.

View of(string $view, mixed $data = [])

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

void name(string $view, string $name)

Зарегистрировать именованное представление.

void alias(string $view, string $alias)

Добавить псевдоним для представления.

bool exists(string $view)

Определить, существует ли заданное представление.

string renderEach(string $view, array $data, string $iterator, string $empty = 'raw|')

Получить отрендеренное содержимое части из цикла.

EngineInterface getEngineFromPath(string $path)

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

string getExtension(string $path)

Получить расширение, используемое файлом представления.

mixed share(array|string $key, mixed $value = null)

Добавить данные общего доступа к среде.

array creator(array|string $views, Closure|string $callback)

Зарегистрировать событие создания представления.

array composers(array $composers)

Зарегистрировать несколько композиторов представлений через массив.

array composer(array|string $views, Closure|string $callback, int|null $priority = null)

Зарегистрировать событие композитора представления.

Closure|null addViewEvent(string $view, Closure|string $callback, string $prefix = 'composing: ', int|null $priority = null)

Добавить событие для данного представления.

Closure addClassEvent(string $view, string $class, string $prefix, int|null $priority = null)

Зарегистрировать композитор представления на основе класса.

void addEventListener(string $name, Closure $callback, int|null $priority = null)

Добавить слушателя к диспетчеру событий.

Closure buildClassEventCallback(string $class, string $prefix)

Создать лямбда-функцию обратного вызова контейнера на основе класса.

array parseClassEvent(string $class, string $prefix)

Разбор имени композитора на основе класса.

void callComposer(View $view)

Вызвать композитор для заданного представления.

void callCreator(View $view)

Вызвать создателя для заданного представления.

void startSection(string $section, string $content = '')

Начать вставку содержимого в секцию.

void inject(string $section, string $content)

Вставить содержимое в секцию.

string yieldSection()

Остановить вставку содержимого в секцию и вернуть её содержимое.

string stopSection(bool $overwrite = false)

Остановить вставку содержимого в секцию.

string appendSection()

Остановить вставку содержимого в секцию и добавить его в конец.

void extendSection(string $section, string $content)

Добавить содержимое к заданной секции.

string yieldContent(string $section, string $default = '')

Получить строковое содержимое секции.

void startPush(string $section, string $content = '')

Начать вставку содержимого в секцию push.

string stopPush()

Остановить вставку содержимого в секцию push.

void extendPush(string $section, string $content)

Добавить содержимое к заданной секции push.

string yieldPushContent(string $section, string $default = '')

Получить строковое содержимое секции push.

void flushSections()

Очистить все содержимое секций.

void flushSectionsIfDoneRendering()

Очистить все содержимое секций, если рендеринг завершен.

void incrementRender()

Увеличить счётчик рендеринга.

void decrementRender()

Уменьшить счётчик рендеринга.

bool doneRendering()

Проверить, нет ли активных операций рендеринга.

void addLoop(Countable|array $data)

Добавить новый цикл в стек.

void incrementLoopIndices()

Увеличить индексы верхнего цикла.

void popLoop()

Извлечь цикл из вершины стека циклов.

array getFirstLoop()

Получить экземпляр первого цикла в стеке.

array getLoopStack()

Получить весь стек циклов.

void addLocation(string $location)

Добавить расположение в массив расположений представления.

void addNamespace(string $namespace, string|array $hints)

Добавить новый namespace в загрузчик.

void prependNamespace(string $namespace, string|array $hints)

Добавить новый namespace в начало загрузчика.

void addExtension(string $extension, string $engine, Closure $resolver = null)

Зарегистрировать допустимое расширение представления и его движок.

array getExtensions()

Получить привязки расширения к движку.

EngineResolver getEngineResolver()

Получить экземпляр решателя движков.

ViewFinderInterface getFinder()

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

void setFinder(ViewFinderInterface $finder)

Установить экземпляр нахождения представлений.

Dispatcher getDispatcher()

Получить экземпляр диспетчера событий.

void setDispatcher(Dispatcher $events)

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

Container getContainer()

Получить экземпляр контейнера IoC.

void setContainer(Container $container)

Установить экземпляр контейнера IoC.

mixed shared(string $key, mixed $default = null)

Получить элемент из общих данных.

array getShared()

Получить все общие данные для среды.

bool hasSection(string $name)

Проверить, существует ли раздел.

array getSections()

Получить весь массив разделов.

array getNames()

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

Подробности

void __construct(EngineResolver $engines, ViewFinderInterface $finder, Dispatcher $events)

Создать новый экземпляр фабрики представлений.

Параметры

EngineResolver $engines
ViewFinderInterface $finder
Dispatcher $events

Возвращаемое значение

void

View file(string $path, array $data = [], array $mergeData = [])

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

Параметры

string $path
array $data
array $mergeData

Возвращаемое значение

View

View make(string $view, array $data = [], array $mergeData = [])

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

Параметры

string $view
array $data
array $mergeData

Возвращаемое значение

View

protected string normalizeName(string $name)

Нормализовать имя представления.

Параметры

string $name

Возвращаемое значение

string

protected array parseData(mixed $data)

Разбирать заданные данные в массив в сыром виде.

Параметры

mixed $data

Возвращаемое значение

array

View of(string $view, mixed $data = [])

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

Параметры

string $view
mixed $data

Возвращаемое значение

View

void name(string $view, string $name)

Зарегистрировать именованное представление.

Параметры

string $view
string $name

Возвращаемое значение

void

void alias(string $view, string $alias)

Добавить псевдоним для представления.

Параметры

string $view
string $alias

Возвращаемое значение

void

bool exists(string $view)

Определить, существует ли заданное представление.

Параметры

string $view

Возвращаемое значение

bool

string renderEach(string $view, array $data, string $iterator, string $empty = 'raw|')

Получить отрендеренное содержимое частичного представления из цикла.

Параметры

string $view
array $data
string $iterator
string $empty

Возвращаемое значение

string

EngineInterface getEngineFromPath(string $path)

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

Параметры

string $path

Возвращаемое значение

EngineInterface

Исключения

InvalidArgumentException

protected string getExtension(string $path)

Получить расширение, используемое файлом представления.

Параметры

string $path

Возвращаемое значение

string

mixed share(array|string $key, mixed $value = null)

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

Параметры

array|string $key
mixed $value

Возвращаемое значение

mixed

array creator(array|string $views, Closure|string $callback)

Зарегистрировать событие создателя представления.

Параметры

array|string $views
Closure|string $callback

Возвращаемое значение

array

array composers(array $composers)

Зарегистрировать несколько композеров представлений через массив.

Параметры

array $composers

Возвращаемое значение

array

array composer(array|string $views, Closure|string $callback, int|null $priority = null)

Зарегистрировать событие композера представлений.

Параметры

array|string $views
Closure|string $callback
int|null $priority

Возвращаемое значение

array

protected Closure|null addViewEvent(string $view, Closure|string $callback, string $prefix = 'composing: ', int|null $priority = null)

Добавить событие для заданного представления.

Параметры

string $view
Closure|string $callback
string $prefix
int|null $priority

Возвращаемое значение

Closure|null

protected Closure addClassEvent(string $view, string $class, string $prefix, int|null $priority = null)

Зарегистрировать композера представлений на основе класса.

Параметры

string $view
string $class
string $prefix
int|null $priority

Возвращаемое значение

Closure

protected void addEventListener(string $name, Closure $callback, int|null $priority = null)

Добавить обработчик в диспетчер событий.

Параметры

string $name
Closure $callback
int|null $priority

Возвращаемое значение

void

protected Closure buildClassEventCallback(string $class, string $prefix)

Создать Closure-обработчик контейнера на основе класса.

Параметры

string $class
string $prefix

Возвращаемое значение

Closure

protected array parseClassEvent(string $class, string $prefix)

Обработать имя композера на основе класса.

Параметры

string $class
string $prefix

Возвращаемое значение

array

void callComposer(View $view)

Вызвать композера для заданного представления.

Параметры

View $view

Возвращаемое значение

void

void callCreator(View $view)

Вызвать создателя для заданного представления.

Параметры

View $view

Возвращаемое значение

void

void startSection(string $section, string $content = '')

Начать вставку содержимого в секцию.

Параметры

string $section
string $content

Возвращаемое значение

void

void inject(string $section, string $content)

Вставить содержимое в секцию.

Параметры

string $section
string $content

Возвращаемое значение

void

string yieldSection()

Прекратить вставку содержимого в секцию и вернуть его содержимое.

Возвращаемое значение

string

string stopSection(bool $overwrite = false)

Прекратить вставку содержимого в секцию.

Параметры

bool $overwrite

Возвращаемое значение

string

Исключения

InvalidArgumentException

string appendSection()

Прекратить вставку содержимого в секцию и добавить его.

Возвращаемое значение

string

Исключения

InvalidArgumentException

protected void extendSection(string $section, string $content)

Добавить контент к заданному разделу.

Parameters

string $section
string $content

Return Value

void

string yieldContent(string $section, string $default = '')

Получить строковое содержимое раздела.

Parameters

string $section
string $default

Return Value

string

void startPush(string $section, string $content = '')

Начать вставку содержимого в раздел push.

Parameters

string $section
string $content

Return Value

void

string stopPush()

Остановить вставку содержимого в раздел push.

Return Value

string

Exceptions

InvalidArgumentException

protected void extendPush(string $section, string $content)

Добавить контент к заданному разделу push.

Parameters

string $section
string $content

Return Value

void

string yieldPushContent(string $section, string $default = '')

Получить строковое содержимое раздела push.

Parameters

string $section
string $default

Return Value

string

void flushSections()

Очистить все содержимое разделов.

Return Value

void

void flushSectionsIfDoneRendering()

Очистить все содержимое разделов, если рендеринг завершён.

Return Value

void

void incrementRender()

Увеличить счётчик рендеринга.

Return Value

void

void decrementRender()

Уменьшить счётчик рендеринга.

Return Value

void

bool doneRendering()

Проверить, нет ли активных операций рендеринга.

Return Value

bool

void addLoop(Countable|array $data)

Добавить новый цикл в стек.

Parameters

Countable|array $data

Return Value

void

void incrementLoopIndices()

Увеличить индексы верхнего цикла.

Return Value

void

void popLoop()

Извлечь цикл из вершины стека циклов.

Return Value

void

array getFirstLoop()

Получить экземпляр первого цикла в стеке.

Return Value

array

array getLoopStack()

Получить весь стек циклов.

Return Value

array

void addLocation(string $location)

Добавить расположение в массив расположений представления.

Parameters

string $location

Return Value

void

void addNamespace(string $namespace, string|array $hints)

Добавить новый пространство имён в загрузчик.

Parameters

string $namespace
string|array $hints

Return Value

void

void prependNamespace(string $namespace, string|array $hints)

Добавить новое пространство имён в загрузчик в начало.

Parameters

string $namespace
string|array $hints

Return Value

void

void addExtension(string $extension, string $engine, Closure $resolver = null)

Зарегистрировать допустимое расширение представления и его движок.

Parameters

string $extension
string $engine
Closure $resolver

Return Value

void

array getExtensions()

Получить привязки расширения к движку.

Return Value

array

EngineResolver getEngineResolver()

Получить экземпляр решателя движков.

Return Value

EngineResolver

ViewFinderInterface getFinder()

Получить экземпляр поиска представлений.

Return Value

ViewFinderInterface

void setFinder(ViewFinderInterface $finder)

Установите экземпляр поиска представлений.

Параметры

ViewFinderInterface $finder

Значение возврата

void

Dispatcher getDispatcher()

Получить экземпляр диспетчера событий.

Значение возврата

Dispatcher

void setDispatcher(Dispatcher $events)

Установите экземпляр диспетчера событий.

Параметры

Dispatcher $events

Значение возврата

void

Container getContainer()

Получить экземпляр контейнера IoC.

Значение возврата

Container

void setContainer(Container $container)

Установите экземпляр контейнера IoC.

Параметры

Container $container

Значение возврата

void

mixed shared(string $key, mixed $default = null)

Получить элемент из общих данных.

Параметры

string $key
mixed $default

Значение возврата

mixed

array getShared()

Получить все общие данные для среды.

Значение возврата

array

bool hasSection(string $name)

Проверить, существует ли раздел.

Параметры

string $name

Значение возврата

bool

array getSections()

Получить весь массив разделов.

Значение возврата

array

array getNames()

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

Значение возврата

array

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/View/Factory.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API