Fuman
\

\Fuman_Action_Unique_Abstract

Represents an unique Fuman_Action_Abstract.

The action is different to other actions, because it can added multiple times with various unique names. Its also possible to configures unique actions.

Used Uri Param to route to Fuman_Action_Unique_Abstract : unique_name

Summary

Methods
Properties
Constants
__construct()
getActionDescriptor()
getApp()
getName()
getClassName()
init()
execute()
returnToCallerUri()
acceptsHttpAuth()
requiresDatabaseConnection()
requiresInstalledApplication()
isDaemon()
isAccessValid()
getConfig()
getConfigValue()
hasConfigValue()
getConfigValueOrDefault()
getUniqueName()
setUniqueName()
initConfigByRequest()
prepareConfig()
No public properties found
LAYOUT_PRIORITY
ICON_PATH
_getTemplatePath()
_getRequiredParams()
_isAccessToActionValid()
_isAccessToTableValid()
_isAccessToInputTypeValid()
_isAccessToRecordValid()
_getAclTableActionName()
_isProtectionHashValid()
$_actionDescriptor
$_app
$_name
$_className
$_responseData
$_config
$_uniqueName
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

$_uniqueName

$_uniqueName : string

Type

string

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

Initializes the action

execute()

execute() : void

execute action

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

getConfig()

getConfig() : null|\stdClass

Gets action configuration

Returns

null|\stdClass

getConfigValue()

getConfigValue(string  $key) : null|string

Gets value from config

Parameters

string $key

Returns

null|string

hasConfigValue()

hasConfigValue(string  $key) : string

Returns true when config value is set

Parameters

string $key

Returns

string

getConfigValueOrDefault()

getConfigValueOrDefault(string  $key, mixed|null  $default = null) : mixed

Returns a config value or default

Parameters

string $key
mixed|null $default

Returns

mixed

getUniqueName()

getUniqueName() : string

Gets unique name

Returns

string

setUniqueName()

setUniqueName(string  $uniqueName) : void

Sets unique name

Parameters

string $uniqueName

prepareConfig()

prepareConfig(\Fuman_Form_Model_Basic  $formModel) : void

Gets config component

Parameters

\Fuman_Form_Model_Basic $formModel

_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() : integer

Checks if access to Fuman_Action_Abstract is valid

Returns

integer

_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