YiiFoundation
  • Namespace
  • Class
  • Tree

Namespaces

  • foundation
    • enum
    • exception
    • helpers
    • widgets
      • base
  • PHP

Classes

  • Alert
  • Breadcrumbs
  • Clearing
  • Dropdown
  • FlexVideo
  • Interchange
  • JoyRide
  • Magellan
  • Orbit
  • Pager
  • Reveal
  • Section
  • SwitchButton
  • Tooltip
  • TopBar

Class Pager

Pager renders a Foundation pagination component.

CLinkPager
Extended by foundation\widgets\Pager
Namespace: foundation\widgets
Package: foundation\widgets
Author: Antonio Ramirez <amigo.cobos@gmail.com>
See: http://foundation.zurb.com/docs/components/pagination.html
Located at widgets/Pager.php

Methods summary

public
# init( )

Initializes the widget.

Initializes the widget.

public
# run( )

Runs the widget.

Runs the widget.

public static
# registerCssFile( string $url = null )

Registers the needed CSS file.

Registers the needed CSS file.

Parameters

$url
string
$url the CSS URL. If null, a default CSS URL will be used.
public static string
# display( array $config = array() )

Ported from Yii2 widget's function. Creates a widget instance and runs it. We cannot use 'widget' name as it conflicts with CBaseController component.

Ported from Yii2 widget's function. Creates a widget instance and runs it. We cannot use 'widget' name as it conflicts with CBaseController component.

The widget rendering result is returned by this method.

Parameters

$config
array
$config name-value pairs that will be used to initialize the object properties

Returns

string
the rendering result of the widget.

Magic methods summary

Constants summary

string CSS_FIRST_PAGE 'arrow'
#
string CSS_LAST_PAGE 'arrow'
#
string CSS_PREVIOUS_PAGE 'arrow'
#
string CSS_NEXT_PAGE 'arrow'
#
string CSS_HIDDEN_PAGE 'hide-for-landscape hide-for-portrait'
#
string CSS_SELECTED_PAGE 'current'
#
string CSS_INTERNAL_PAGE 'page'
#

Properties summary

public string $nextPageLabel
#

the text label for the next page button.

the text label for the next page button.

public string $prevPageLabel
#

the text label for the previous page button.

the text label for the previous page button.

public string $firstPageLabel
#

the text label for the first page button.

the text label for the first page button.

public string $lastPageLabel
#

the text label for the last page button.

the text label for the last page button.

public boolean $hideFirstAndLast
#

whether the "first" and "last" buttons should be hidden. Defaults to false.

whether the "first" and "last" buttons should be hidden. Defaults to false.

public boolean $centered
#

whether to center the pager or not

whether to center the pager or not

YiiFoundation API documentation generated by ApiGen 2.8.0