Fuman
\

\app_more_action_proxy

Represents a proxy which can execute a child action by a given url-pattern and table-uniquename.

Usage: Extend the action and create the execute action as follows: public function execute() {

 if (parent::execute() {
     //If parent returns true, the child action has been found and the current action can be skipped
     return;
 }
 if (self::_getProxyState() === self::CHILD_NOT_FOUND) {
     //Child not found
 }

}

If the child action extends the app_more_action_proxy_child_action, the proxy will be set on the action.

Summary

Methods
Properties
Constants
setTemplateData()
getTemplateData()
setTable()
getTable()
setNavigationItem()
preExecute()
init()
execute()
getNavigationItem()
prepareSitemap()
__construct()
getActionDescriptor()
getApp()
getName()
getClassName()
returnToCallerUri()
acceptsHttpAuth()
requiresDatabaseConnection()
requiresInstalledApplication()
isDaemon()
isAccessValid()
createChildLink()
createChildLinkFromItem()
getProxyUri()
setChildPattern()
getChildPattern()
setChildClassName()
getChildClassName()
setChildTableUniqueName()
getChildTableUniqueName()
getInstanceAsUriProviderByModuleConfiguration()
No public properties found
LAYOUT_PRIORITY
ICON_PATH
CHILD_FOUND
CHILD_NOT_FOUND
CHILD_NOT_SET
_isAccessToActionValid()
_getTemplatePath()
_getRequiredParams()
_isAccessToTableValid()
_isAccessToInputTypeValid()
_isAccessToRecordValid()
_getAclTableActionName()
_isProtectionHashValid()
_execute()
_extractChildIdFromUri()
_executeChild()
_setChildValues()
getChildTableTitleUniqueName()
setChildTableTitleUniqueName()
_getProxyState()
$_table
$_templateData
$_navigationItem
$_actionDescriptor
$_app
$_name
$_className
$_responseData
$_config
$_childClassName
$_childTableUniqueName
$_childTableTitleUniqueName
$_childPattern
$_proxyUri
$_proxyState
$_childAction
N/A
No private methods found
No private properties found
N/A

Constants

LAYOUT_PRIORITY

LAYOUT_PRIORITY

ICON_PATH

ICON_PATH

CHILD_FOUND

CHILD_FOUND

CHILD_NOT_FOUND

CHILD_NOT_FOUND

CHILD_NOT_SET

CHILD_NOT_SET

Properties

$_actionDescriptor

$_actionDescriptor :

Type

$_app

$_app : string

Type

string

$_name

$_name : string

Type

string

$_className

$_className : string

Type

string

$_config

$_config : \stdClass

Type

\stdClass

$_childClassName

$_childClassName : string

Type

string

$_childTableUniqueName

$_childTableUniqueName : string

Type

string

$_childTableTitleUniqueName

$_childTableTitleUniqueName :

Type

$_childPattern

$_childPattern : string

Type

string

$_proxyUri

$_proxyUri : string

Type

string

$_proxyState

$_proxyState : integer

Type

integer

Methods

setTemplateData()

setTemplateData(\Fuman_Template_Data  $templateData) : void

Sets frontend data

Parameters

\Fuman_Template_Data $templateData

getTemplateData()

getTemplateData() : \Fuman_Template_Data

Gets frontend data

Returns

\Fuman_Template_Data

setTable()

setTable(\Fuman_Table  $table)

Sets table

Parameters

\Fuman_Table $table

getTable()

getTable() : \Fuman_Table

Gets table

Returns

\Fuman_Table

setNavigationItem()

setNavigationItem(\Fuman_Navigation_Item  $item)

Sets navigation item

Parameters

\Fuman_Navigation_Item $item

preExecute()

preExecute(\Fuman_Navigation_Item  $item) : void

Prepares navigation item

Parameters

\Fuman_Navigation_Item $item

init()

init() : void

Initializes the action

execute()

execute() : void

Execute

getNavigationItem()

getNavigationItem() : \Fuman_Navigation_Item

Gets navigation item

Returns

\Fuman_Navigation_Item

__construct()

__construct()

Constructor

getActionDescriptor()

getActionDescriptor() : \Fuman_Action_Descriptor|null

Gets action descriptor

Returns

\Fuman_Action_Descriptor|null

getApp()

getApp() : string

Returns app string

Returns

string

getName()

getName() : string

Returns action name

Returns

string

getClassName()

getClassName() : string

Gets class name

Returns

string

returnToCallerUri()

returnToCallerUri(boolean  $reroute = false) : null|void

Parses caller and returns it or reroutes to it, depends o first argument

Parameters

boolean $reroute

Returns

null|void

acceptsHttpAuth()

acceptsHttpAuth() : boolean

Does the action accepts Http authentication (Fuman_Auth_Http_Basic)

Returns

boolean

requiresDatabaseConnection()

requiresDatabaseConnection() : boolean

Does action require database access

Returns

boolean

requiresInstalledApplication()

requiresInstalledApplication() : boolean

Does action require an installed application

Returns

boolean

isDaemon()

isDaemon() : boolean

Daemon actions wont affect session last update

Returns

boolean

isAccessValid()

isAccessValid() : integer

Checks if Access to Action is valid

Returns

integer

createChildLink()

createChildLink(string  $uriTitle, integer  $id) : string

Create child link

Parameters

string $uriTitle
integer $id

Returns

string

createChildLinkFromItem()

createChildLinkFromItem(\Fuman_Navigation_Item  $item, string  $uriTitle, integer  $id) : integer

Parameters

\Fuman_Navigation_Item $item
string $uriTitle
integer $id

Returns

integer

getProxyUri()

getProxyUri() : string

Gets proxy uri path

Returns

string

setChildPattern()

setChildPattern(string  $pattern)

Sets child pattern

Parameters

string $pattern

getChildPattern()

getChildPattern() : string

Gets child pattern

Returns

string

setChildClassName()

setChildClassName(string  $className)

Set class name

Parameters

string $className

getChildClassName()

getChildClassName() : string

Gets class name

Returns

string

setChildTableUniqueName()

setChildTableUniqueName(string  $tableUniqueName)

Set child table unique name

Parameters

string $tableUniqueName

getChildTableUniqueName()

getChildTableUniqueName() : string

Gets child table unique name

Returns

string

_isAccessToActionValid()

_isAccessToActionValid() : integer

Checks if access to Fuman_Action_Abstract is valid

Returns

integer

_getTemplatePath()

_getTemplatePath() : null|string

Returns script path of action.

Returns

null|string

_getRequiredParams()

_getRequiredParams() : array

List of params which have to be set on request.

Returns

array

_isAccessToTableValid()

_isAccessToTableValid() : integer

Checks if access to Fuman_Action_Table_Interface is valid

Returns

integer

_isAccessToInputTypeValid()

_isAccessToInputTypeValid() : integer

Checks if access to Fuman_Action_Record_Interface is valid

Returns

integer

_isAccessToRecordValid()

_isAccessToRecordValid() : integer

Checks if access to Fuman_Action_Record_Interface is valid

Returns

integer

_getAclTableActionName()

_getAclTableActionName() : string

Gets the action name for the acl table subset (default: get_class($this))

Returns

string

_isProtectionHashValid()

_isProtectionHashValid(string  $appName, string  $actionName, \Fuman_Table  $table, string  $id) : boolean

Check protection hash

Parameters

string $appName
string $actionName
\Fuman_Table $table
string $id

Returns

boolean

_execute()

_execute() : boolean

Executes internally

Returns

boolean

_extractChildIdFromUri()

_extractChildIdFromUri(integer  $level) : null|integer

Extract child id form uri

Parameters

integer $level

Returns

null|integer

_executeChild()

_executeChild(\Fuman_Template_Data  $data) : void

Execute child

Parameters

\Fuman_Template_Data $data

_setChildValues()

_setChildValues(string  $actionClassName = null, string  $tableUniqueName = null, string  $titleUniqueName = null)

Set child values

Parameters

string $actionClassName
string $tableUniqueName
string $titleUniqueName

getChildTableTitleUniqueName()

getChildTableTitleUniqueName() : string

Gets child table title unique name

Returns

string

setChildTableTitleUniqueName()

setChildTableTitleUniqueName(string  $childTableTitleUniqueName) : void

Set child table title unique name

Parameters

string $childTableTitleUniqueName

_getProxyState()

_getProxyState() : integer

Gets proxy state

Returns

integer