Arikaim CMS

RoutesInterface
in

Routes interface

Table of Contents

Constants

ADMIN_API  = 4
API  = 2
HOME_PAGE  = 3
PAGE  = 1
Route type constant

Methods

addApiRoute()  : bool
Add api route
delete()  : bool
Delete route
getHomePageRoute()  : array<string|int, mixed>
Get home page route
getRoute()  : array<string|int, mixed>|false
Get route
has()  : bool
Return true if reoute exists
saveRouteOptions()  : bool
Save route options
searchRoutes()  : array<string|int, mixed>
Get routes list for request method
setRedirectUrl()  : bool
Save route redirect url
setRoutesStatus()  : bool
Set routes status

Constants

Methods

addApiRoute()

Add api route

public addApiRoute(string $method, string $pattern, string $handlerClass, string|null $handlerMethod, string|null $extension[, int|string|null $auth = null ][, int $type = RoutesInterface::API ]) : bool
Parameters
$method : string
$pattern : string
$handlerClass : string
$handlerMethod : string|null
$extension : string|null
$auth : int|string|null = null
$type : int = RoutesInterface::API
Tags
throws
Exception
Return values
bool

delete()

Delete route

public delete(string $method, string $pattern) : bool
Parameters
$method : string
$pattern : string
Return values
bool

getHomePageRoute()

Get home page route

public getHomePageRoute() : array<string|int, mixed>
Return values
array<string|int, mixed>

getRoute()

Get route

public getRoute(string $method, string $pattern) : array<string|int, mixed>|false
Parameters
$method : string
$pattern : string
Return values
array<string|int, mixed>|false

has()

Return true if reoute exists

public has(string $method, string $pattern) : bool
Parameters
$method : string
$pattern : string
Return values
bool

saveRouteOptions()

Save route options

public saveRouteOptions(string $method, string $pattern, array<string|int, mixed> $options) : bool
Parameters
$method : string
$pattern : string
$options : array<string|int, mixed>
Return values
bool

searchRoutes()

Get routes list for request method

public searchRoutes(string $method[, mixed $type = null ]) : array<string|int, mixed>
Parameters
$method : string
$type : mixed = null
Return values
array<string|int, mixed>

setRedirectUrl()

Save route redirect url

public setRedirectUrl(string $method, string $pattern, string $url) : bool
Parameters
$method : string
$pattern : string
$url : string
Return values
bool

setRoutesStatus()

Set routes status

public setRoutesStatus(array<string|int, mixed> $filter, int $status) : bool
Parameters
$filter : array<string|int, mixed>
$status : int
Return values
bool 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results