Fuman
\

\app_core_action_rss

Exports all record of a Fuman_Table as a csv.

Summary

Methods
Properties
Constants
setTable()
getTable()
getConfig()
getConfigValue()
hasConfigValue()
getConfigValueOrDefault()
getTableActionIcon()
__construct()
getActionDescriptor()
getApp()
getName()
getClassName()
init()
execute()
returnToCallerUri()
acceptsHttpAuth()
requiresDatabaseConnection()
requiresInstalledApplication()
isDaemon()
isAccessValid()
process()
prepareConfig()
initConfigByRequest()
No public properties found
LAYOUT_PRIORITY
ICON_PATH
PAGE_SIZE
_getTemplatePath()
_getRequiredParams()
_isAccessToActionValid()
_isAccessToTableValid()
_isAccessToInputTypeValid()
_isAccessToRecordValid()
_getAclTableActionName()
_isProtectionHashValid()
$_table
$_actionDescriptor
$_app
$_name
$_className
$_responseData
$_config
N/A
No private methods found
No private properties found
N/A

Constants

LAYOUT_PRIORITY

LAYOUT_PRIORITY

ICON_PATH

ICON_PATH

PAGE_SIZE

PAGE_SIZE

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

setTable()

setTable(\Fuman_Table  $table) : void

Set table

Parameters

\Fuman_Table $table

getTable()

getTable() : \Fuman_Table

Get table

Returns

\Fuman_Table

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

getTableActionIcon()

getTableActionIcon(\Fuman_Action_Descriptor  $actionDescriptor, \Fuman_Table  $table, \stdClass  $params = null) : \app_core_component_icon

Returns an icon component with uri to the parametrised action

Parameters

\Fuman_Action_Descriptor $actionDescriptor
\Fuman_Table $table
\stdClass $params

Returns

\app_core_component_icon

__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

Sets the csv response.

execute()

execute() : void

Fills the response with data.

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

Accepts httpAuth to create api like access.

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

process()

process(\Fuman_Response_Abstract  $response, integer  $position) : void

Process

Parameters

\Fuman_Response_Abstract $response
integer $position

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