PHP Trait FluidTYPO3\Vhs\Traits\SlideViewHelperTrait

Trait implemented by ViewHelpers that wants some kind of records to be optionally looked up and/or collected from the current page and pages up the rootline. ViewHelpers must implement the getSlideRecordsFromPage method which looks up resources for a single page. Has the following main responsibilities: - register arguments common for sliding - method to get records with sliding according to the ViewHelper arguments

Mostra file Open project: fluidtypo3/vhs

Public Methods

Method	Description
initializeArguments ( ) : void	Default initialisation of arguments - will be used if the implementing ViewHelper does not itself define this method.

Protected Methods

Method	Description
getPageService ( ) : PageService
getSlideRecords ( integer $pageUid, integer $limit = null ) : array	Get records, optionally sliding up the page rootline
getSlideRecordsFromPage ( integer $pageUid, integer $limit )	Get a number of records from a page for sliding
registerSlideArguments ( ) : void	Register the "limit", "slide", "slideCollect" and "slideCollectReverse" arguments which are consumed by getSlideRecords.

Method Details

getPageService() protected method

protected getPageService ( ) : PageService
return	FluidTYPO3\Vhs\Service\PageService

getSlideRecords() protected method

Get records, optionally sliding up the page rootline

protected getSlideRecords ( integer $pageUid, integer $limit = null ) : array
$pageUid	integer
$limit	integer
return	array

getSlideRecordsFromPage() abstract protected method

Get a number of records from a page for sliding

abstract protected getSlideRecordsFromPage ( integer $pageUid, integer $limit )
$pageUid	integer	PID to get the records from
$limit	integer	number of records to get at maximum

initializeArguments() public method

Default initialisation of arguments - will be used if the implementing ViewHelper does not itself define this method.

public initializeArguments ( ) : void
return	void

registerSlideArguments() protected method

Should be used inside registerArguments().

protected registerSlideArguments ( ) : void
return	void