PHP Class Phalcon\Paginator\Pager\Layout

Pager base layout.
Datei anzeigen Open project: phalcon/incubator Class Usage Examples

Protected Properties

Property Type Description
$maskReplacements array
$pager Phalcon\Paginator\Pager Pager object.
$range Range Ranges generator.
$selectedTemplate string
$separatorTemplate string
$template string
$urlMask string

Public Methods

Method Description
__construct ( Pager $pager, Range $range, string $urlMask ) Class constructor.
__toString ( ) Simply calls display, and returns the output.
addMaskReplacement ( string $oldMask, string $newMask, boolean $asValue = false ) : void
getRendered ( array $options = [] ) : string Displays the pager on screen based on templates and options defined.
removeMaskReplacement ( string $oldMask ) : void
setSelectedTemplate ( string $selectedTemplate ) : void
setSeparatorTemplate ( string $separatorTemplate ) : void
setTemplate ( string $template ) : void

Protected Methods

Method Description
parseMaskReplacements ( string $str ) : string
parseReplacementsTemplate ( array $options = [] ) : string
parseTemplate ( array $options = [] ) : string
parseUrl ( array $options = [] ) : string
parseUrlTemplate ( array $options = [] ) : string
processPage ( array $options = [] ) : string

Method Details

__construct() public method

Class constructor.
public __construct ( Pager $pager, Range $range, string $urlMask )
$pager Phalcon\Paginator\Pager
$range Range
$urlMask string

__toString() public method

Simply calls display, and returns the output.
public __toString ( )

addMaskReplacement() public method

public addMaskReplacement ( string $oldMask, string $newMask, boolean $asValue = false ) : void
$oldMask string
$newMask string
$asValue boolean
return void

getRendered() public method

Displays the pager on screen based on templates and options defined.
public getRendered ( array $options = [] ) : string
$options array
return string

parseMaskReplacements() protected method

protected parseMaskReplacements ( string $str ) : string
$str string
return string

parseReplacementsTemplate() protected method

protected parseReplacementsTemplate ( array $options = [] ) : string
$options array
return string

parseTemplate() protected method

protected parseTemplate ( array $options = [] ) : string
$options array
return string

parseUrl() protected method

protected parseUrl ( array $options = [] ) : string
$options array
return string

parseUrlTemplate() protected method

protected parseUrlTemplate ( array $options = [] ) : string
$options array
return string

processPage() protected method

protected processPage ( array $options = [] ) : string
$options array
return string

removeMaskReplacement() public method

public removeMaskReplacement ( string $oldMask ) : void
$oldMask string
return void

setSelectedTemplate() public method

public setSelectedTemplate ( string $selectedTemplate ) : void
$selectedTemplate string
return void

setSeparatorTemplate() public method

public setSeparatorTemplate ( string $separatorTemplate ) : void
$separatorTemplate string
return void

setTemplate() public method

public setTemplate ( string $template ) : void
$template string
return void

Property Details

$maskReplacements protected_oe property

protected array $maskReplacements
return array

$pager protected_oe property

Pager object.
protected Pager,Phalcon\Paginator $pager
return Phalcon\Paginator\Pager

$range protected_oe property

Ranges generator.
protected Range,Phalcon\Paginator\Pager $range
return Range

$selectedTemplate protected_oe property

protected string $selectedTemplate
return string

$separatorTemplate protected_oe property

protected string $separatorTemplate
return string

$template protected_oe property

protected string $template
return string

$urlMask protected_oe property

protected string $urlMask
return string