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
파일 보기 프로젝트 열기: fluidtypo3/vhs 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$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