Fuman
\

\Fuman_Frontend_Sitemap_Action

Superclass of all actions which are used in a frontend application.

Summary

Methods
Properties
Constants
prepareSitemap()
__construct()
getActionDescriptor()
getApp()
getName()
getClassName()
init()
execute()
returnToCallerUri()
acceptsHttpAuth()
requiresDatabaseConnection()
requiresInstalledApplication()
isDaemon()
isAccessValid()
setTemplateData()
getTemplateData()
setTable()
getTable()
setNavigationItem()
preExecute()
getNavigationItem()
No public properties found
LAYOUT_PRIORITY
ICON_PATH
_getTemplatePath()
_getRequiredParams()
_isAccessToActionValid()
_isAccessToTableValid()
_isAccessToInputTypeValid()
_isAccessToRecordValid()
_getAclTableActionName()
_isProtectionHashValid()
$_actionDescriptor
$_app
$_name
$_className
$_responseData
$_config
$_table
$_templateData
$_navigationItem
N/A
No private methods found
No private properties found
N/A

Constants

LAYOUT_PRIORITY

LAYOUT_PRIORITY

ICON_PATH

ICON_PATH

Properties

$_actionDescriptor

$_actionDescriptor :

Type

$_app

$_app : string

Type

string

$_name

$_name : string

Type

string

$_className

$_className : string

Type

string

$_config

$_config : \stdClass

Type

\stdClass

Methods

__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

init()

init() : void

Handles about

execute()

execute()

Execute

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

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

getNavigationItem()

getNavigationItem() : \Fuman_Navigation_Item

Gets navigation item

Returns

\Fuman_Navigation_Item

_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

_isAccessToActionValid()

_isAccessToActionValid() : boolean

Is access to action valid

Returns

boolean

_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