Arikaim CMS

Paginator extends FastApiController
in package

Paginator Api controller

Table of Contents

Properties

$container  : Container|null
Container
$errors  : array<string|int, mixed>
Errors list
$response  : ResponseInterface|null
Response
$result  : array<string|int, mixed>
Response result

Methods

__construct()  : mixed
Constructor
addError()  : void
Add error
clearResult()  : void
Clear result
field()  : self
Set result field
fields()  : self
Set fields
getPage()  : ResponseInterface
Get current paginator page
getResponse()  : ResponseInterface
Return response
getResponseJson()  : string
Return json
getViewType()  : ResponseInterface
Get paginator view type
hasError()  : bool
Return true if response have error
remove()  : ResponseInterface
Clear paginator session data
setHttpResponse()  : void
Set http response instance
setPage()  : ResponseInterface
Set paginator current page
setPageSize()  : ResponseInterface
Set paginator page size (rows per page)
setResponse()  : mixed
Set response
setResult()  : self
Set response result
setResultField()  : void
Set field to result array
setResultFields()  : void
Set result filelds
setViewType()  : ResponseInterface
Set paginator view type

Properties

$result

Response result

protected array<string|int, mixed> $result

Methods

__construct()

Constructor

public __construct([Container|null $container = null ]) : mixed
Parameters
$container : Container|null = null

addError()

Add error

public addError(string $message) : void
Parameters
$message : string

clearResult()

Clear result

public clearResult() : void

field()

Set result field

public field(string $name, mixed $value) : self
Parameters
$name : string
$value : mixed
Return values
self

fields()

Set fields

public fields(array<string|int, mixed> $data[, string|null $filedName = null ]) : self
Parameters
$data : array<string|int, mixed>
$filedName : string|null = null
Return values
self

getPage()

Get current paginator page

public getPage(ServerRequestInterface $request, ResponseInterface $response, Validator $data) : ResponseInterface
Parameters
$request : ServerRequestInterface
$response : ResponseInterface
$data : Validator
Return values
ResponseInterface

getResponse()

Return response

public getResponse([bool $raw = false ][, ResponseInterface|null $response = null ][, bool $progress = false ]) : ResponseInterface
Parameters
$raw : bool = false
$response : ResponseInterface|null = null
$progress : bool = false
Return values
ResponseInterface

getResponseJson()

Return json

public getResponseJson([bool $raw = false ]) : string
Parameters
$raw : bool = false
Return values
string

getViewType()

Get paginator view type

public getViewType(ServerRequestInterface $request, ResponseInterface $response, Validator $data) : ResponseInterface
Parameters
$request : ServerRequestInterface
$response : ResponseInterface
$data : Validator
Return values
ResponseInterface

hasError()

Return true if response have error

public hasError() : bool
Return values
bool

remove()

Clear paginator session data

public remove(ServerRequestInterface $request, ResponseInterface $response, Validator $data) : ResponseInterface
Parameters
$request : ServerRequestInterface
$response : ResponseInterface
$data : Validator
Return values
ResponseInterface

setHttpResponse()

Set http response instance

public setHttpResponse(ResponseInterface $response) : void
Parameters
$response : ResponseInterface

setPage()

Set paginator current page

public setPage(ServerRequestInterface $request, ResponseInterface $response, Validator $data) : ResponseInterface
Parameters
$request : ServerRequestInterface
$response : ResponseInterface
$data : Validator
Return values
ResponseInterface

setPageSize()

Set paginator page size (rows per page)

public setPageSize(ServerRequestInterface $request, ResponseInterface $response, Validator $data) : ResponseInterface
Parameters
$request : ServerRequestInterface
$response : ResponseInterface
$data : Validator
Return values
ResponseInterface

setResponse()

Set response

public setResponse(mixed $condition, array<string|int, mixed>|string|Closure $data, string|Closure $error) : mixed
Parameters
$condition : mixed
$data : array<string|int, mixed>|string|Closure
$error : string|Closure

setResult()

Set response result

public setResult(mixed $data) : self
Parameters
$data : mixed
Return values
self

setResultField()

Set field to result array

public setResultField(string $name, mixed $value) : void
Parameters
$name : string
$value : mixed

setResultFields()

Set result filelds

public setResultFields(array<string|int, mixed> $values[, string|null $filedName = null ]) : void
Parameters
$values : array<string|int, mixed>
$filedName : string|null = null

setViewType()

Set paginator view type

public setViewType(ServerRequestInterface $request, ResponseInterface $response, Validator $data) : ResponseInterface
Parameters
$request : ServerRequestInterface
$response : ResponseInterface
$data : Validator
Return values
ResponseInterface 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results