Arikaim CMS

RoutesStorageInterface
in

Routes storage interface

Table of Contents

Methods

addMiddleware()  : bool
Add route middleware
addRoute()  : bool
Add route
deleteRoute()  : bool
Delete route
deleteRoutes()  : bool
Delete routes
getHomePageRoute()  : array<string|int, mixed>
Get home page route
getRoute()  : array<string|int, mixed>|false
Get route
getRouteDetails()  : array<string|int, mixed>|null
Get route details
getRoutes()  : array<string|int, mixed>
Get extension routes
hasRoute()  : bool
Return true if reoute exists
saveRedirectUrl()  : bool
Save route redirect url
saveRouteOptions()  : bool
Save route options
searchRoutes()  : array<string|int, mixed>
Get routes list for request method
setRoutesStatus()  : bool
Set routes status

Methods

addMiddleware()

Add route middleware

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

addRoute()

Add route

public addRoute(array<string|int, mixed> $details) : bool
Parameters
$details : array<string|int, mixed>
Return values
bool

deleteRoute()

Delete route

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

deleteRoutes()

Delete routes

public deleteRoutes([array<string|int, mixed> $filter = [] ]) : bool
Parameters
$filter : array<string|int, mixed> = []
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

getRouteDetails()

Get route details

public getRouteDetails(string|int $id) : array<string|int, mixed>|null
Parameters
$id : string|int

Route id or uuid

Return values
array<string|int, mixed>|null

getRoutes()

Get extension routes

public getRoutes([array<string|int, mixed> $filter = [] ]) : array<string|int, mixed>
Parameters
$filter : array<string|int, mixed> = []
Return values
array<string|int, mixed>

hasRoute()

Return true if reoute exists

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

saveRedirectUrl()

Save route redirect url

public saveRedirectUrl(string $method, string $pattern, string $url) : bool
Parameters
$method : string
$pattern : string
$url : 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[, int|null $type = null ]) : array<string|int, mixed>
Parameters
$method : string
$type : int|null = null
Return values
array<string|int, mixed>

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