PHP Класс FluidTYPO3\Vhs\ViewHelpers\Menu\AbstractMenuViewHelper

Наследование: extends TYPO3\CMS\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper, use trait FluidTYPO3\Vhs\Traits\PageRecordViewHelperTrait, use trait FluidTYPO3\Vhs\Traits\TagViewHelperTrait
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$pageService FluidTYPO3\Vhs\Service\PageService
$tagName string

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

Метод Описание
backupVariables ( ) Saves copies of all template variables while rendering the menu
getArguments ( ) : array
getMenu ( null | integer $pageUid = null, integer $entryLevel ) : array
getWrappingTagName ( ) : string Returns the wrapping tag to use
initializeArguments ( ) : void Initialize
injectPageService ( PageService $pageService )
isNonWrappingMode ( ) : boolean Returns TRUE for non-wrapping mode which is triggered by setting tagNameChildren to 'a'
parseMenu ( array $pages ) : array
processPagesArgument ( mixed $pages = null ) : array Returns array of page UIDs from provided pages
render ( ) : string
renderContent ( array $menu ) : string Renders the tag's content or if omitted auto renders the menu for the provided arguments
restoreVariables ( ) Restores all saved template variables
setOriginal ( boolean $original )

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

Метод Описание
autoRender ( array $menu, integer $level = 1 ) : string
cleanTemplateVariableContainer ( )
cleanupSubmenuVariables ( )
determineParentPageUid ( null | integer $pageUid = null, integer $entryLevel ) : null | integer
getItemTitle ( array $page ) : string
initalizeSubmenuVariables ( ) Initialize variables used by the submenu instance recycler. Variables set here may be read by the Page / Menu / Sub ViewHelper which then automatically repeats rendering using the exact same arguments but with a new page UID as starting page.
renderItemLink ( array $page ) : string
retrieveReconfiguredParentMenuInstance ( integer $pageUid ) : AbstractMenuViewHelper | null Retrieves a stored, if any, parent instance of a menu. Although only implemented by the Page / Menu / Sub ViewHelper, placing this method in this abstract class instead will allow custom menu ViewHelpers to work as sub menu ViewHelpers without being forced to implement their own variable retrieval or subclass Page / Menu / Sub.
unsetDeferredVariableStorage ( )

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

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

protected autoRender ( array $menu, integer $level = 1 ) : string
$menu array
$level integer
Результат string

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

Saves copies of all template variables while rendering the menu
public backupVariables ( )

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

protected cleanTemplateVariableContainer ( )

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

protected cleanupSubmenuVariables ( )

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

protected determineParentPageUid ( null | integer $pageUid = null, integer $entryLevel ) : null | integer
$pageUid null | integer
$entryLevel integer
Результат null | integer

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

public getArguments ( ) : array
Результат array

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

protected getItemTitle ( array $page ) : string
$page array
Результат string

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

public getMenu ( null | integer $pageUid = null, integer $entryLevel ) : array
$pageUid null | integer
$entryLevel integer
Результат array

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

Returns the wrapping tag to use
public getWrappingTagName ( ) : string
Результат string

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

Note that the submenu VieWHelper is only capable of recycling one type of menu at a time - for example, a List menu nested inside a regular Menu ViewHelper will simply start another menu rendering completely separate from the parent menu.
protected initalizeSubmenuVariables ( )

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

Initialize
public initializeArguments ( ) : void
Результат void

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

public injectPageService ( PageService $pageService )
$pageService FluidTYPO3\Vhs\Service\PageService

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

Returns TRUE for non-wrapping mode which is triggered by setting tagNameChildren to 'a'
public isNonWrappingMode ( ) : boolean
Результат boolean

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

public parseMenu ( array $pages ) : array
$pages array
Результат array

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

Returns array of page UIDs from provided pages
public processPagesArgument ( mixed $pages = null ) : array
$pages mixed
Результат array

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

public render ( ) : string
Результат string

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

Renders the tag's content or if omitted auto renders the menu for the provided arguments
public renderContent ( array $menu ) : string
$menu array
Результат string

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

Restores all saved template variables
public restoreVariables ( )

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

Returns NULL if no parent exists.
protected retrieveReconfiguredParentMenuInstance ( integer $pageUid ) : AbstractMenuViewHelper | null
$pageUid integer UID of page that's the new parent page, overridden in arguments of cloned and recycled menu ViewHelper instance
Результат AbstractMenuViewHelper | null

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

public setOriginal ( boolean $original )
$original boolean

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

protected unsetDeferredVariableStorage ( )

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

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

protected PageService,FluidTYPO3\Vhs\Service $pageService
Результат FluidTYPO3\Vhs\Service\PageService

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

protected string $tagName
Результат string