TAction
in package
Structure to encapsulate an action
Tags
Table of Contents
Properties
- $action : mixed
- $param : mixed
- $properties : mixed
- $usePopover : mixed
Methods
- __construct() : mixed
- Class Constructor
- cloneWithParameters() : mixed
- disableState() : mixed
- Disable URL history state register
- getAction() : mixed
- Returns the current calback
- getFieldParameters() : mixed
- Return fields used in parameters
- getParameter() : mixed
- Returns a parameter
- getParameters() : mixed
- Return the Action Parameters
- getProperty() : mixed
- Get property
- isPopover() : mixed
- Return if is using popover
- isStatic() : mixed
- Returns if the action is static
- prepare() : mixed
- Prepare action for use over an object
- preserveRequestParameters() : mixed
- Keep REQUEST parameters
- serialize() : mixed
- Converts the action into an URL
- setParameter() : mixed
- Adds a parameter to the action
- setParameters() : mixed
- Set the parameters for the action
- setProperty() : mixed
- Set property
- toString() : mixed
- Returns the action as a string
- usePopover() : mixed
- Enable popover
- validate() : mixed
- Validate action
- replace() : mixed
- Replace a string with object properties within {pattern}
Properties
$action
protected
mixed
$action
$param
protected
mixed
$param
$properties
protected
mixed
$properties
$usePopover
protected
mixed
$usePopover
Methods
__construct()
Class Constructor
public
__construct(mixed $action[, mixed $parameters = null ]) : mixed
Parameters
- $action : mixed
-
Callback to be executed
- $parameters : mixed = null
-
= array of parameters
cloneWithParameters()
public
cloneWithParameters([mixed $parameters = [] ]) : mixed
Parameters
- $parameters : mixed = []
disableState()
Disable URL history state register
public
disableState() : mixed
getAction()
Returns the current calback
public
getAction() : mixed
getFieldParameters()
Return fields used in parameters
public
getFieldParameters() : mixed
getParameter()
Returns a parameter
public
getParameter(mixed $param) : mixed
Parameters
- $param : mixed
-
= parameter name
getParameters()
Return the Action Parameters
public
getParameters() : mixed
getProperty()
Get property
public
getProperty(mixed $property) : mixed
Parameters
- $property : mixed
isPopover()
Return if is using popover
public
isPopover() : mixed
isStatic()
Returns if the action is static
public
isStatic() : mixed
prepare()
Prepare action for use over an object
public
prepare(mixed $object) : mixed
Parameters
- $object : mixed
-
Data Object
preserveRequestParameters()
Keep REQUEST parameters
public
preserveRequestParameters([mixed $request_parameters = [] ]) : mixed
Parameters
- $request_parameters : mixed = []
serialize()
Converts the action into an URL
public
serialize([mixed $format_action = TRUE ][, mixed $check_permission = FALSE ]) : mixed
Parameters
- $format_action : mixed = TRUE
-
= format action with document or javascript (ajax=no)
- $check_permission : mixed = FALSE
setParameter()
Adds a parameter to the action
public
setParameter(mixed $param, mixed $value) : mixed
Parameters
- $param : mixed
-
= parameter name
- $value : mixed
-
= parameter value
setParameters()
Set the parameters for the action
public
setParameters(mixed $parameters) : mixed
Parameters
- $parameters : mixed
-
= array of parameters
setProperty()
Set property
public
setProperty(mixed $property, mixed $value) : mixed
Parameters
- $property : mixed
- $value : mixed
toString()
Returns the action as a string
public
toString() : mixed
usePopover()
Enable popover
public
usePopover() : mixed
validate()
Validate action
public
validate() : mixed
replace()
Replace a string with object properties within {pattern}
private
replace(mixed $content, mixed $object) : mixed
Parameters
- $content : mixed
-
String with pattern
- $object : mixed
-
Any object