Documentation

Http extends AbstractMatch
in package

Pop router HTTP match class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
4.2.0

Table of Contents

Properties

$basePath  : string|null
Base path
$controllerParams  : array<string|int, mixed>
Controller parameters
$defaultRoute  : array<string|int, mixed>|null
Default route
$dynamicRoute  : mixed
Dynamic route
$dynamicRoutePrefix  : mixed
Dynamic route prefix
$isDynamicRoute  : bool
Flag for dynamic route
$preparedRoutes  : array<string|int, mixed>
Prepared routes
$route  : string|null
Matched route
$routeNames  : array<string|int, mixed>
Route names
$routeParams  : array<string|int, mixed>
Route parameters
$routes  : array<string|int, mixed>
Routes
$routeString  : string|null
Route string
$segments  : array<string|int, mixed>
Segments of route string

Methods

__construct()  : mixed
Constructor
addControllerParams()  : AbstractMatch
Add controller params to be passed into a new controller instance
addRoute()  : AbstractMatch
Add a route
addRoutes()  : AbstractMatch
Add multiple controller routes
appendControllerParams()  : AbstractMatch
Append controller params to be passed into a new controller instance
getAction()  : mixed
Get the action
getBasePath()  : string
Get the base path
getController()  : mixed
Get the controller
getControllerParams()  : mixed
Get the params assigned to the controller
getDefaultRoute()  : array<string|int, mixed>
Get the default route
getDynamicRoute()  : mixed
Get the dynamic route
getDynamicRoutePrefix()  : mixed
Get the dynamic route prefix
getFlattenedRoutes()  : array<string|int, mixed>
Get flattened routes
getOriginalRoute()  : string|null
Get original route string
getPreparedRoutes()  : array<string|int, mixed>
Get prepared routes
getRoute()  : string
Get route regex
getRouteConfig()  : mixed
Get route config
getRouteParams()  : array<string|int, mixed>
Get the params discovered from the route
getRoutes()  : array<string|int, mixed>
Get routes
getRouteString()  : string
Get the route string
getSegment()  : string|null
Get a route string segment
getSegments()  : array<string|int, mixed>
Get the route string segments
getUrl()  : string
Get URL for the named route
hasAction()  : bool
Determine if there is an action
hasController()  : bool
Determine if there is a controller
hasControllerParams()  : bool
Determine if the controller has params
hasDefaultRoute()  : bool
Determine if there is a default route
hasDynamicRoute()  : bool
Determine if there is a dynamic route
hasName()  : bool
Has a route name
hasRoute()  : bool
Determine if the route has been matched
hasRouteConfig()  : bool
Has route config
hasRouteParams()  : bool
Determine if the route has params
isDynamicRoute()  : bool
Determine if it is a dynamic route
match()  : bool
Match the route
name()  : AbstractMatch
Add a route name
noRouteFound()  : void
Method to process if a route was not found
prepare()  : static
Prepare the routes
removeControllerParams()  : AbstractMatch
Remove controller params
flattenRoutes()  : void
Flatten the nested routes
getRouteRegex()  : array<string|int, mixed>
Get the REGEX pattern for the route string
parseRouteParams()  : void
Parse route dispatch parameters

Properties

$basePath

Base path

protected string|null $basePath = null

$controllerParams

Controller parameters

protected array<string|int, mixed> $controllerParams = []

$defaultRoute

Default route

protected array<string|int, mixed>|null $defaultRoute = null

$dynamicRoute

Dynamic route

protected mixed $dynamicRoute = null

$dynamicRoutePrefix

Dynamic route prefix

protected mixed $dynamicRoutePrefix = null

$isDynamicRoute

Flag for dynamic route

protected bool $isDynamicRoute = false

$preparedRoutes

Prepared routes

protected array<string|int, mixed> $preparedRoutes = []

$routeNames

Route names

protected array<string|int, mixed> $routeNames = []

$routeParams

Route parameters

protected array<string|int, mixed> $routeParams = []

$routes

Routes

protected array<string|int, mixed> $routes = []

$routeString

Route string

protected string|null $routeString = null

$segments

Segments of route string

protected array<string|int, mixed> $segments = []

Methods

__construct()

Constructor

public __construct() : mixed

Instantiate the HTTP match object

addControllerParams()

Add controller params to be passed into a new controller instance

public addControllerParams(string $controller, mixed $params) : AbstractMatch
Parameters
$controller : string
$params : mixed
Return values
AbstractMatch

appendControllerParams()

Append controller params to be passed into a new controller instance

public appendControllerParams(string $controller, mixed $params) : AbstractMatch
Parameters
$controller : string
$params : mixed
Return values
AbstractMatch

getBasePath()

Get the base path

public getBasePath() : string
Return values
string

getController()

Get the controller

public getController() : mixed

getControllerParams()

Get the params assigned to the controller

public getControllerParams(string $controller) : mixed
Parameters
$controller : string

getDefaultRoute()

Get the default route

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

getDynamicRoute()

Get the dynamic route

public getDynamicRoute() : mixed

getDynamicRoutePrefix()

Get the dynamic route prefix

public getDynamicRoutePrefix() : mixed

getFlattenedRoutes()

Get flattened routes

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

getOriginalRoute()

Get original route string

public getOriginalRoute() : string|null
Return values
string|null

getPreparedRoutes()

Get prepared routes

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

getRoute()

Get route regex

public getRoute() : string
Return values
string

getRouteConfig()

Get route config

public getRouteConfig([string|null $key = null ]) : mixed
Parameters
$key : string|null = null

getRouteParams()

Get the params discovered from the route

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

getRoutes()

Get routes

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

getRouteString()

Get the route string

public getRouteString() : string
Return values
string

getSegment()

Get a route string segment

public getSegment(int $i) : string|null
Parameters
$i : int
Return values
string|null

getSegments()

Get the route string segments

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

getUrl()

Get URL for the named route

public getUrl(string $routeName[, mixed $params = null ][, bool $fqdn = false ]) : string
Parameters
$routeName : string
$params : mixed = null
$fqdn : bool = false
Return values
string

hasAction()

Determine if there is an action

public hasAction() : bool
Return values
bool

hasController()

Determine if there is a controller

public hasController() : bool
Return values
bool

hasControllerParams()

Determine if the controller has params

public hasControllerParams(string $controller) : bool
Parameters
$controller : string
Return values
bool

hasDefaultRoute()

Determine if there is a default route

public hasDefaultRoute() : bool
Return values
bool

hasDynamicRoute()

Determine if there is a dynamic route

public hasDynamicRoute() : bool
Return values
bool

hasName()

Has a route name

public hasName(string $routeName) : bool
Parameters
$routeName : string
Return values
bool

hasRoute()

Determine if the route has been matched

public hasRoute() : bool
Return values
bool

hasRouteConfig()

Has route config

public hasRouteConfig([string|null $key = null ]) : bool
Parameters
$key : string|null = null
Return values
bool

hasRouteParams()

Determine if the route has params

public hasRouteParams() : bool
Return values
bool

isDynamicRoute()

Determine if it is a dynamic route

public isDynamicRoute() : bool
Return values
bool

match()

Match the route

public match([mixed $forceRoute = null ]) : bool
Parameters
$forceRoute : mixed = null
Return values
bool

noRouteFound()

Method to process if a route was not found

public noRouteFound([bool $exit = true ]) : void
Parameters
$exit : bool = true

prepare()

Prepare the routes

public prepare() : static
Return values
static

flattenRoutes()

Flatten the nested routes

protected flattenRoutes(array<string|int, mixed>|string $route[, mixed $controller = null ]) : void
Parameters
$route : array<string|int, mixed>|string
$controller : mixed = null

getRouteRegex()

Get the REGEX pattern for the route string

protected getRouteRegex(string $route) : array<string|int, mixed>
Parameters
$route : string
Return values
array<string|int, mixed>

parseRouteParams()

Parse route dispatch parameters

protected parseRouteParams() : void 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results