PHP Класс RainLab\Pages\Classes\SnippetManager

Автор: Alexey Bobkov, Samuel Georges
Наследование: use trait October\Rain\Support\Traits\Singleton
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$snippets

Открытые методы

Метод Описание
clearCache ( Cms\Classes\Theme $theme ) Clears front-end run-time cache.
findByCodeOrComponent ( Cms\Classes\Theme $theme, string $code, $componentClass, boolean $allowCaching = false ) : array Finds a snippet by its code.
getPartialSnippetMap ( Cms\Classes\Theme $theme ) : Returns Returns a list of partial-based snippets and corresponding partial names.
listSnippets ( Cms\Classes\Theme $theme ) : array Returns a list of available snippets.

Защищенные методы

Метод Описание
getPartialMapCacheKey ( $theme ) Returns a cache key for this record.
listComponentSnippets ( ) : array Returns a list of snippets created from components.
listThemeSnippets ( Cms\Classes\Theme $theme ) : array Returns a list of snippets in the specified theme.

Описание методов

clearCache() публичный статический Метод

Clears front-end run-time cache.
public static clearCache ( Cms\Classes\Theme $theme )
$theme Cms\Classes\Theme Specifies a parent theme.

findByCodeOrComponent() публичный Метод

This method is used internally by the system.
public findByCodeOrComponent ( Cms\Classes\Theme $theme, string $code, $componentClass, boolean $allowCaching = false ) : array
$theme Cms\Classes\Theme Specifies a parent theme.
$code string Specifies the snippet code.
$allowCaching boolean Specifies whether caching is allowed for the call.
Результат array Returns an array of Snippet objects.

getPartialMapCacheKey() защищенный статический Метод

Returns a cache key for this record.
protected static getPartialMapCacheKey ( $theme )

getPartialSnippetMap() публичный Метод

Returns a list of partial-based snippets and corresponding partial names.
public getPartialSnippetMap ( Cms\Classes\Theme $theme ) : Returns
$theme Cms\Classes\Theme Specifies a parent theme.
Результат Returns an associative array with the snippet code in keys and partial file names in values.

listComponentSnippets() защищенный Метод

Returns a list of snippets created from components.
protected listComponentSnippets ( ) : array
Результат array Returns an array of Snippet objects.

listSnippets() публичный Метод

Returns a list of available snippets.
public listSnippets ( Cms\Classes\Theme $theme ) : array
$theme Cms\Classes\Theme Specifies a parent theme.
Результат array Returns an unsorted array of snippet objects.

listThemeSnippets() защищенный Метод

Returns a list of snippets in the specified theme.
protected listThemeSnippets ( Cms\Classes\Theme $theme ) : array
$theme Cms\Classes\Theme Specifies a parent theme.
Результат array Returns an array of Snippet objects.

Описание свойств

$snippets защищенное свойство

protected $snippets