TYPO3 CMS  TYPO3_7-6
TYPO3\CMS\IndexedSearch\ViewHelpers\PageBrowsingViewHelper Class Reference
Inheritance diagram for TYPO3\CMS\IndexedSearch\ViewHelpers\PageBrowsingViewHelper:
TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper TYPO3\CMS\Fluid\Core\ViewHelper\Facets\CompilableInterface

Public Member Functions

 render ($maximumNumberOfResultPages, $numberOfResults, $resultsPerPage, $currentPage=0, $freeIndexUid=null)
 
- Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
 setArguments (array $arguments)
 
 setRenderingContext (\TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)
 
 injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
 
 injectReflectionService (\TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService)
 
 isEscapingInterceptorEnabled ()
 
 setViewHelperNode (\TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\ViewHelperNode $node)
 
 setRenderChildrenClosure (\Closure $renderChildrenClosure)
 
 initializeArgumentsAndRender ()
 
 initialize ()
 
 renderChildren ()
 
 prepareArguments ()
 
 validateArguments ()
 
 initializeArguments ()
 
 compile ($argumentsVariableName, $renderChildrenClosureVariableName, &$initializationPhpCode, \TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\AbstractNode $syntaxTreeNode, \TYPO3\CMS\Fluid\Core\Compiler\TemplateCompiler $templateCompiler)
 
 resetState ()
 
- Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\Facets\CompilableInterface
 compile ($argumentsVariableName, $renderChildrenClosureVariableName, &$initializationPhpCode, \TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\AbstractNode $syntaxTreeNode, \TYPO3\CMS\Fluid\Core\Compiler\TemplateCompiler $templateCompiler)
 

Static Public Member Functions

static renderStatic (array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
 
- Static Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
static renderStatic (array $arguments, \Closure $renderChildrenClosure, \TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)
 
- Static Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\Facets\CompilableInterface
static renderStatic (array $arguments, \Closure $renderChildrenClosure, \TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)
 

Static Protected Member Functions

static makecurrentPageSelector_link ($str, $p, $freeIndexUid)
 

Static Protected Attributes

static $prefixId = 'tx_indexedsearch'
 

Additional Inherited Members

- Protected Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
 registerArgument ($name, $type, $description, $required=false, $defaultValue=null)
 
 overrideArgument ($name, $type, $description, $required=false, $defaultValue=null)
 
 callRenderMethod ()
 
 getLogger ()
 
 buildRenderChildrenClosure ()
 
 hasArgument ($argumentName)
 
- Protected Attributes inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
 $arguments
 
 $templateVariableContainer
 
 $controllerContext
 
 $renderingContext
 
 $renderChildrenClosure = null
 
 $viewHelperVariableContainer
 
 $objectManager
 
 $escapingInterceptorEnabled = true
 

Detailed Description

Page browser for indexed search, and only useful here, as the regular pagebrowser so this is a cleaner "pi_browsebox" but not a real page browser functionality

Definition at line 31 of file PageBrowsingViewHelper.php.

Member Function Documentation

◆ makecurrentPageSelector_link()

static TYPO3\CMS\IndexedSearch\ViewHelpers\PageBrowsingViewHelper::makecurrentPageSelector_link (   $str,
  $p,
  $freeIndexUid 
)
staticprotected

Used to make the link for the result-browser. Notice how the links must resubmit the form after setting the new currentPage-value in a hidden formfield.

Parameters
string$strString to wrap in tag
int$pcurrentPage value
string$freeIndexUidList of integers pointing to free indexing configurations to search. -1 represents no filtering, 0 represents TYPO3 pages only, any number above zero is a uid of an indexing configuration!
Returns
string Input string wrapped in tag with onclick event attribute set.

Definition at line 137 of file PageBrowsingViewHelper.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue().

◆ render()

TYPO3\CMS\IndexedSearch\ViewHelpers\PageBrowsingViewHelper::render (   $maximumNumberOfResultPages,
  $numberOfResults,
  $resultsPerPage,
  $currentPage = 0,
  $freeIndexUid = null 
)

Main render function

Parameters
int$maximumNumberOfResultPagesThe number of page links shown
int$numberOfResultsTotal number of results
int$resultsPerPageNumber of results per page
int$currentPageThe current page starting with 0
string | NULL$freeIndexUidList of integers pointing to free indexing configurations to search. -1 represents no filtering, 0 represents TYPO3 pages only, any number above zero is a uid of an indexing configuration!
Returns
string The content

Definition at line 48 of file PageBrowsingViewHelper.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\buildRenderChildrenClosure().

◆ renderStatic()

static TYPO3\CMS\IndexedSearch\ViewHelpers\PageBrowsingViewHelper::renderStatic ( array  $arguments,
\Closure  $renderChildrenClosure,
RenderingContextInterface  $renderingContext 
)
static
Parameters
array$arguments
callable$renderChildrenClosure
RenderingContextInterface$renderingContext
Returns
string

Definition at line 70 of file PageBrowsingViewHelper.php.

References $a, TYPO3\CMS\Core\Utility\MathUtility\forceIntegerInRange(), and TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

Member Data Documentation

◆ $prefixId

TYPO3\CMS\IndexedSearch\ViewHelpers\PageBrowsingViewHelper::$prefixId = 'tx_indexedsearch'
staticprotected

Definition at line 36 of file PageBrowsingViewHelper.php.