REDAXO 5
  • Package
  • Class
  • Tree
  • Deprecated

Packages

  • redaxo
    • backup
    • be-style
    • core
      • backend
      • form
      • login
      • minibar
      • packages
      • sql
    • cronjob
      • article-status
      • optimize-tables
    • media-manager
    • mediapool
    • metainfo
    • phpmailer
    • structure
      • content
        • minibar
      • history
      • version
    • users

Classes

  • rex
  • rex_api_function
  • rex_api_result
  • rex_autoload
  • rex_clang
  • rex_clang_perm
  • rex_clang_service
  • rex_config
  • rex_console_application
  • rex_console_command
  • rex_context
  • rex_csrf_token
  • rex_dir
  • rex_editor
  • rex_error_handler
  • rex_extension
  • rex_extension_point
  • rex_file
  • rex_finder
  • rex_formatter
  • rex_fragment
  • rex_i18n
  • rex_list
  • rex_log_entry
  • rex_log_file
  • rex_logger
  • rex_markdown
  • rex_pager
  • rex_path
  • rex_path_default_provider
  • rex_request
  • rex_response
  • rex_select
  • rex_socket
  • rex_socket_proxy
  • rex_socket_response
  • rex_sortable_iterator
  • rex_stream
  • rex_string
  • rex_system_report
  • rex_system_setting
  • rex_timer
  • rex_type
  • rex_url
  • rex_validator
  • rex_var
  • rex_var_clang
  • rex_var_config
  • rex_var_dumper
  • rex_var_property
  • rex_view

Interfaces

  • rex_context_provider_interface
  • rex_url_provider_interface

Traits

  • rex_factory_trait
  • rex_instance_list_pool_trait
  • rex_instance_pool_trait
  • rex_singleton_trait

Exceptions

  • rex_api_exception
  • rex_exception
  • rex_functional_exception
  • rex_http_exception
  • rex_socket_exception
  • rex_sql_exception
  • rex_yaml_parse_exception

Functions

  • rex_cookie
  • rex_delete_cache
  • rex_env
  • rex_escape
  • rex_files
  • rex_get
  • rex_ini_get
  • rex_post
  • rex_request
  • rex_request_method
  • rex_server
  • rex_session
  • rex_set_session
  • rex_unset_session

Class rex_pager

The rex_pager-class implements all the logic which is necessary to implement some sort of pagination.

Package: redaxo\core
Author: staabm
Located at redaxo/src/core/lib/util/pager.php

Methods summary

public
# __construct( integer $rowsPerPage = 30, string $cursorName = 'start' )

Constructs a rex_pager.

Constructs a rex_pager.

Parameters

$rowsPerPage
The number of rows which should be displayed on one page
$cursorName
The name of the parameter used for pagination
public
# setRowCount( integer $rowCount )

Sets the row count.

Sets the row count.

Parameters

$rowCount
public integer
# getRowCount( )

Returns the number of rows for pagination.

Returns the number of rows for pagination.

Returns

integer
The number of rows
public integer
# getPageCount( )

Returns the number of pages which result from the given number of rows and the rows per page.

Returns the number of pages which result from the given number of rows and the rows per page.

Returns

integer
The number of pages
public integer
# getRowsPerPage( )

Returns the number of rows which will be displayed on a page.

Returns the number of rows which will be displayed on a page.

Returns

integer
The rows displayed on a page
public integer
# getCursor( integer $pageNo = null )

Returns the current pagination position.

Returns the current pagination position.

When the parameter pageNo is given, the cursor for the given page is returned. When no parameter is given, the cursor for active page is returned.

Parameters

$pageNo

Returns

integer
int
public integer
# validateCursor( integer $cursor )

Validates the cursor.

Validates the cursor.

Parameters

$cursor

Returns

integer
int
public string
# getCursorName( )

Returns the name of the parameter which is used for pagination.

Returns the name of the parameter which is used for pagination.

Returns

string
The name of the cursor
public integer
# getFirstPage( )

Returns the first page for pagination.

Returns the first page for pagination.

Returns

integer
The first page number
public integer
# getPrevPage( )

Returns the previous page in respect to the current page.

Returns the previous page in respect to the current page.

Returns

integer
The previous page number
public integer
# getCurrentPage( )

Returns the number of the current page.

Returns the number of the current page.

Returns

integer
The current page number
public integer
# getNextPage( )

Returns the number of the next page in respect to the current page.

Returns the number of the next page in respect to the current page.

Returns

integer
The next page number
public integer
# getLastPage( )

Return the page number of the last page.

Return the page number of the last page.

Returns

integer
the last page number
public boolean
# isActivePage( integer $pageNo )

Checks wheter the given page number is the active/current page.

Checks wheter the given page number is the active/current page.

Parameters

$pageNo

Returns

boolean
True when the given pageNo is the current page, otherwise False
REDAXO 5 API documentation generated by ApiGen 3.0dev