CRM_Campaign_Page_Vote
class CRM_Campaign_Page_Vote extends CRM_Core_Page
Page for voting tab interface.
Properties
| protected string | $_name | The name of the page (auto generated from class name) | from CRM_Core_Page |
| protected object | $_title | The title associated with this page. | from CRM_Core_Page |
| protected int | $_mode | A page can have multiple modes. (i.e. displays a different set of data based on the input | from CRM_Core_Page |
| protected bool | $_embedded | Is this object being embedded in another object. If so the display routine needs to not do any work. (The parent object takes care of the display) | from CRM_Core_Page |
| protected bool | $_print | Are we in print mode? if so we need to modify the display functionality to do a minimal display :) | from CRM_Core_Page |
| static protected CRM_Core_Smarty | $_template | Cache the smarty template for efficiency reasons | from CRM_Core_Page |
| static protected CRM_Core_Session | $_session | Cache the session for efficiency reasons | from CRM_Core_Page |
| array | $ajaxResponse | What to return to the client if in ajax mode (snippet=json) | from CRM_Core_Page |
| array | $urlPath | Url path used to reach this page | from CRM_Core_Page |
| bool | $useLivePageJS | Should crm.livePage.js be added to the page? | from CRM_Core_Page |
Methods
Class constructor.
No description
Store the variable with the value in the form scope.
Assign value to name in template by reference.
Appends values to template variables.
Returns an array containing template variables.
A wrapper for getTemplateFileName that includes calling the hook to prevent us from having to copy & paste the logic of calling the hook
Default extra tpl file basically just replaces .tpl with .extra.tpl i.e. we dont override
Assign metadata about fields to the template.
No description
No description
No description
No description
Details
in CRM_Core_Page at line 126
CRM_Core_Page
__construct(string $title = NULL, int $mode = NULL)
Class constructor.
at line 106
run()
in CRM_Core_Page at line 249
set(string|array $name, mixed $value = NULL)
Store the variable with the value in the form scope.
in CRM_Core_Page at line 260
mixed
get(string $name)
Get the variable from the form scope.
in CRM_Core_Page at line 271
assign(string $var, mixed $value = NULL)
Assign value to name in template.
in CRM_Core_Page at line 282
assign_by_ref(string $var, mixed $value)
Assign value to name in template by reference.
in CRM_Core_Page at line 294
append(array|string $tpl_var, mixed $value = NULL, bool $merge = FALSE)
Appends values to template variables.
in CRM_Core_Page at line 305
array
get_template_vars(string $name = NULL)
Returns an array containing template variables.
in CRM_Core_Page at line 312
reset()
Destroy all the session state of this page.
in CRM_Core_Page at line 321
string
getTemplateFileName()
Use the form name to create the tpl file name.
in CRM_Core_Page at line 335
getHookedTemplateFileName()
A wrapper for getTemplateFileName that includes calling the hook to prevent us from having to copy & paste the logic of calling the hook
in CRM_Core_Page at line 347
string
overrideExtraTemplateFileName()
Default extra tpl file basically just replaces .tpl with .extra.tpl i.e. we dont override
in CRM_Core_Page at line 356
setEmbedded(bool $embedded)
Setter for embedded.
in CRM_Core_Page at line 366
bool
getEmbedded()
Getter for embedded.
in CRM_Core_Page at line 375
setPrint(bool $print)
Setter for print.
in CRM_Core_Page at line 385
bool
getPrint()
Getter for print.
in CRM_Core_Page at line 392
static CRM_Core_Smarty
getTemplate()
in CRM_Core_Page at line 401
null
getVar(string $name)
in CRM_Core_Page at line 409
setVar(string $name, $value)
in CRM_Core_Page at line 426
protected
assignFieldMetadataToTemplate(string $entity)
Assign metadata about fields to the template.
In order to allow the template to format fields we assign information about them to the template.
At this stage only date field metadata is assigned as that is the only use-case in play and we don't want to assign a lot of unneeded data.