Fuman
\

\Fuman_Uri_AbstractBuilder

Abstract uri implementation

Summary

Methods
Properties
Constants
setName()
getName()
init()
buildFromActionDescriptor()
buildFromActionName()
buildFromObject()
buildFromPath()
getRequestUri()
getRootUri()
getPath()
getUriParams()
createProtectionHash()
No public properties found
SESSION_CONTAINER_NAME
HASH_PROTECTION_URI_PARAM
_buildFromObject()
_prepareParameters()
_parse()
_prepareRequestUri()
_createQueryString()
$_uriRequest
$_uriRoot
$_uriParams
$_isFrontend
$_addLanguage
$_path
$_name
$_PARAM_ORDER
N/A
No private methods found
$_salt
N/A

Constants

SESSION_CONTAINER_NAME

SESSION_CONTAINER_NAME

Session container name

HASH_PROTECTION_URI_PARAM

HASH_PROTECTION_URI_PARAM

Properties

$_uriRequest

$_uriRequest : string

The cleaned request Uri

Type

string

$_uriRoot

$_uriRoot : string

The root uri of the application

Type

string

$_uriParams

$_uriParams :

Type

$_isFrontend

$_isFrontend : boolean

Is this an uri builder for frontend

Type

boolean

$_addLanguage

$_addLanguage :

Type

$_path

$_path :

Type

$_name

$_name :

Type

$_PARAM_ORDER

$_PARAM_ORDER :

Type

$_salt

$_salt :

Type

Methods

setName()

setName(string  $name)

Sets name which was used to register the navigation on application

Parameters

string $name

getName()

getName() : string

Gets name which was used to register the navigation on application

Returns

string

init()

init(string  $rootUri, string  $requestUri, boolean  $isFrontend = false, boolean  $addLanguage = false)

Constructor

Parameters

string $rootUri
string $requestUri
boolean $isFrontend
boolean $addLanguage

buildFromActionDescriptor()

buildFromActionDescriptor(\Fuman_Action_Descriptor  $actionDescriptor, \stdClass|null  $params = null) : string

Build an uri

Parameters

\Fuman_Action_Descriptor $actionDescriptor
\stdClass|null $params

Returns

string

buildFromActionName()

buildFromActionName(string  $appName, string  $actionName, \stdClass|null  $params = null) : string

Build an uri

Parameters

string $appName
string $actionName
\stdClass|null $params

Returns

string

buildFromObject()

buildFromObject(\stdClass  $parameters) : string

Build an uri from an object

Parameters

\stdClass $parameters

Returns

string

buildFromPath()

buildFromPath(string  $path, null|string  $language = null) : string

Builds uri from path

Parameters

string $path
null|string $language

Returns

string

getRequestUri()

getRequestUri() : string

Get request URI

Returns

string

getRootUri()

getRootUri() : string

Gets root URI

Returns

string

getPath()

getPath() : string

Gets path (Uri from request without root and query string)

Returns

string

getUriParams()

getUriParams() : array

Gets uri params

Returns

array

createProtectionHash()

createProtectionHash(string  $appName, string  $actionName, string  $tableUniqueName, string  $id) : string

Gets the protection hash value

Parameters

string $appName
string $actionName
string $tableUniqueName
string $id

Returns

string

_buildFromObject()

_buildFromObject(\stdClass  $parameters) : string

Build an uri from an object

Parameters

\stdClass $parameters

Returns

string

_prepareParameters()

_prepareParameters(\stdClass  $parameters) : \stdClass

Prepare parameters

Parameters

\stdClass $parameters

Returns

\stdClass

_parse()

_parse(string  $rootUri, string  $requestUri) : array

Parses the uri

Parameters

string $rootUri
string $requestUri

Returns

array

_prepareRequestUri()

_prepareRequestUri(string  $requestUri) : string

Prepares request

Parameters

string $requestUri

Returns

string

_createQueryString()

_createQueryString(\stdClass  $queryObject) : string

Creates query string

Parameters

\stdClass $queryObject

Returns

string