Arikaim CMS

SessionPaginator
in package

Paginator session helper

Table of Contents

Methods

clearPaginator()  : void
Clear paginator data
create()  : array<string|int, mixed>
Create paginator
getCurrentPage()  : int
Return current page
getPaginator()  : array<string|int, mixed>|null
Read paginator data from session
getRowsPerPage()  : int
Get rows per page
getViewType()  : string
Return view type
savePaginator()  : void
Save paginator array in session
setCurrentPage()  : void
Set current page
setRowsPerPage()  : void
Set rows per page value
setViewType()  : void
Set view type

Methods

clearPaginator()

Clear paginator data

public static clearPaginator(string|null $namespace) : void
Parameters
$namespace : string|null

create()

Create paginator

public static create(object|array<string|int, mixed>|json $source[, string|null $namespace = null ][, int|null $pageSize = null ][, int|null $currentPage = null ]) : array<string|int, mixed>
Parameters
$source : object|array<string|int, mixed>|json
$namespace : string|null = null
$pageSize : int|null = null
$currentPage : int|null = null
Return values
array<string|int, mixed>

getCurrentPage()

Return current page

public static getCurrentPage([string|null $namespace = null ]) : int
Parameters
$namespace : string|null = null
Return values
int

getPaginator()

Read paginator data from session

public static getPaginator(string|null $namespace) : array<string|int, mixed>|null
Parameters
$namespace : string|null
Return values
array<string|int, mixed>|null

getRowsPerPage()

Get rows per page

public static getRowsPerPage([string|null $namespace = null ]) : int
Parameters
$namespace : string|null = null
Return values
int

getViewType()

Return view type

public static getViewType([string|null $namespace = null ][, string|null $default = Paginator::TABLE_VIEW ]) : string
Parameters
$namespace : string|null = null
$default : string|null = Paginator::TABLE_VIEW
Return values
string

savePaginator()

Save paginator array in session

public static savePaginator(string|null $namespace, array<string|int, mixed> $data) : void
Parameters
$namespace : string|null
$data : array<string|int, mixed>

setCurrentPage()

Set current page

public static setCurrentPage(int $page[, string|null $namespace = null ]) : void
Parameters
$page : int
$namespace : string|null = null

setRowsPerPage()

Set rows per page value

public static setRowsPerPage(int $rows[, string|null $namespace = null ]) : void
Parameters
$rows : int
$namespace : string|null = null

setViewType()

Set view type

public static setViewType(string $type[, string|null $namespace = null ]) : void
Parameters
$type : string
$namespace : string|null = null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results