CRM_Core_QuickForm_Action_Display
extends CRM_Core_QuickForm_Action
in package
Redefine the display action.
Tags
Table of Contents
Properties
- $_errorTemplate : string
- The template to display error messages inline with the form element.
- $_requiredTemplate : string
- The template to display the required "red" asterick.
- $_stateMachine : object
- Reference to the state machine i belong to.
Methods
- __construct() : CRM_Core_QuickForm_Action_Display
- Class constructor.
- _setRenderTemplates() : mixed
- Set the various rendering templates.
- initializeTemplates() : mixed
- Initialize the various templates.
- perform() : object|void
- Processes the request.
- popUserContext() : mixed
- Returns the user to the top of the user context stack.
- renderForm() : mixed
- Render the page using a custom templating system.
Properties
$_errorTemplate
The template to display error messages inline with the form element.
public
static string
$_errorTemplate
= \NULL
$_requiredTemplate
The template to display the required "red" asterick.
public
static string
$_requiredTemplate
= \NULL
$_stateMachine
Reference to the state machine i belong to.
protected
object
$_stateMachine
Methods
__construct()
Class constructor.
public
__construct(object &$stateMachine) : CRM_Core_QuickForm_Action_Display
Parameters
- $stateMachine : object
-
Reference to state machine object.
Return values
CRM_Core_QuickForm_Action_Display_setRenderTemplates()
Set the various rendering templates.
public
_setRenderTemplates(CRM_Core_Form &$page) : mixed
Parameters
- $page : CRM_Core_Form
-
The CRM_Core_Form page.
initializeTemplates()
Initialize the various templates.
public
initializeTemplates() : mixed
perform()
Processes the request.
public
perform(CRM_Core_Form &$page, string $actionName) : object|void
Parameters
- $page : CRM_Core_Form
-
CRM_Core_Form the current form-page.
- $actionName : string
-
Current action name, as one Action object can serve multiple actions.
Return values
object|voidpopUserContext()
Returns the user to the top of the user context stack.
public
popUserContext() : mixed
renderForm()
Render the page using a custom templating system.
public
renderForm(CRM_Core_Form &$page) : mixed
Parameters
- $page : CRM_Core_Form
-
The CRM_Core_Form page.