TYPO3 CMS  TYPO3_6-2
TYPO3\CMS\IndexedSearch\ViewHelpers\PageBrowsingViewHelper Class Reference
Inheritance diagram for TYPO3\CMS\IndexedSearch\ViewHelpers\PageBrowsingViewHelper:
TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper Tx_IndexedSearch_ViewHelpers_PageBrowsingViewHelper

Public Member Functions

 render ($maximumNumberOfResultPages, $numberOfResults, $resultsPerPage, $currentPage=0, $freeIndexUid=NULL)
 
 makecurrentPageSelector_link ($str, $p, $freeIndexUid)
 
- Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
 setArguments (array $arguments)
 
 setRenderingContext (\TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)
 
 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 ()
 

Protected Attributes

 $prefixId = 'tx_indexedsearch'
 
- Protected Attributes inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
 $arguments
 
 $templateVariableContainer
 
 $controllerContext
 
 $renderingContext
 
 $renderChildrenClosure = NULL
 
 $viewHelperVariableContainer
 
 $objectManager
 
 $escapingInterceptorEnabled = TRUE
 

Additional Inherited Members

- 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)
 
- 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 ()
 
 buildRenderChildrenClosure ()
 
 hasArgument ($argumentName)
 

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! 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

Author
Benjamin Mack benni.nosp@m.@typ.nosp@m.o3.or.nosp@m.g

Definition at line 24 of file PageBrowsingViewHelper.php.

Member Function Documentation

◆ makecurrentPageSelector_link()

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

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
integer$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.
Todo:
Define visibility

Definition at line 102 of file PageBrowsingViewHelper.php.

Referenced by TYPO3\CMS\IndexedSearch\ViewHelpers\PageBrowsingViewHelper\render().

◆ render()

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

Main render function

Parameters
integer$maximumNumberOfResultPagesThe number of page links shown
integer$numberOfResultsTotal number of results
integer$resultsPerPageNumber of results per page
integer$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 41 of file PageBrowsingViewHelper.php.

References TYPO3\CMS\Core\Utility\MathUtility\forceIntegerInRange(), TYPO3\CMS\IndexedSearch\ViewHelpers\PageBrowsingViewHelper\makecurrentPageSelector_link(), and TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

Member Data Documentation

◆ $prefixId

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

Definition at line 29 of file PageBrowsingViewHelper.php.