CRM_Core_Page

class CRM_Core_Page

A Page is basically data in a nice pretty format.

Pages should not have any form actions / elements in them. If they do, make sure you use CRM_Core_Form and the related structures. You can embed simple forms in Page and do your own form handling.

Properties

protected string $_name The name of the page (auto generated from class name)
protected object $_title The title associated with this page.
protected int $_mode A page can have multiple modes. (i.e. displays a different set of data based on the input
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)
protected bool $_print Are we in print mode? if so we need to modify the display functionality to do a minimal display :)
static protected CRM_Core_Smarty $_template Cache the smarty template for efficiency reasons
static protected CRM_Core_Session $_session Cache the session for efficiency reasons
array $ajaxResponse What to return to the client if in ajax mode (snippet=json)
array $urlPath Url path used to reach this page
bool $useLivePageJS Should crm.livePage.js be added to the page?

Methods

CRM_Core_Page
__construct(string $title = NULL, int $mode = NULL)

Class constructor.

run()

This function takes care of all the things common to all pages.

set(string|array $name, mixed $value = NULL)

Store the variable with the value in the form scope.

mixed
get(string $name)

Get the variable from the form scope.

assign(string $var, mixed $value = NULL)

Assign value to name in template.

assign_by_ref(string $var, mixed $value)

Assign value to name in template by reference.

append(array|string $tpl_var, mixed $value = NULL, bool $merge = FALSE)

Appends values to template variables.

array
get_template_vars(string $name = NULL)

Returns an array containing template variables.

reset()

Destroy all the session state of this page.

string
getTemplateFileName()

Use the form name to create the tpl file name.

getHookedTemplateFileName()

A wrapper for getTemplateFileName that includes calling the hook to prevent us from having to copy & paste the logic of calling the hook

string
overrideExtraTemplateFileName()

Default extra tpl file basically just replaces .tpl with .extra.tpl i.e. we dont override

setEmbedded(bool $embedded)

Setter for embedded.

bool
getEmbedded()

Getter for embedded.

setPrint(bool $print)

Setter for print.

bool
getPrint()

Getter for print.

static CRM_Core_Smarty
getTemplate()

No description

null
getVar(string $name)

No description

setVar(string $name, $value)

No description

assignFieldMetadataToTemplate(string $entity)

Assign metadata about fields to the template.

Details

at line 126
CRM_Core_Page __construct(string $title = NULL, int $mode = NULL)

Class constructor.

Parameters

string $title Title of the page.
int $mode Mode of the page.

Return Value

CRM_Core_Page

at line 166
run()

This function takes care of all the things common to all pages.

This typically involves assigning the appropriate smarty variables :)

at line 249
set(string|array $name, mixed $value = NULL)

Store the variable with the value in the form scope.

Parameters

string|array $name name of the variable or an assoc array of name/value pairs
mixed $value Value of the variable if string.

at line 260
mixed get(string $name)

Get the variable from the form scope.

Parameters

string $name name of the variable

Return Value

mixed

at line 271
assign(string $var, mixed $value = NULL)

Assign value to name in template.

Parameters

string $var
mixed $value Value of variable.

at line 282
assign_by_ref(string $var, mixed $value)

Assign value to name in template by reference.

Parameters

string $var
mixed $value (reference) value of variable.

at line 294
append(array|string $tpl_var, mixed $value = NULL, bool $merge = FALSE)

Appends values to template variables.

Parameters

array|string $tpl_var the template variable name(s)
mixed $value The value to append.
bool $merge

at line 305
array get_template_vars(string $name = NULL)

Returns an array containing template variables.

Parameters

string $name

Return Value

array

at line 312
reset()

Destroy all the session state of this page.

at line 321
string getTemplateFileName()

Use the form name to create the tpl file name.

Return Value

string

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

at line 347
string overrideExtraTemplateFileName()

Default extra tpl file basically just replaces .tpl with .extra.tpl i.e. we dont override

Return Value

string

at line 356
setEmbedded(bool $embedded)

Setter for embedded.

Parameters

bool $embedded

at line 366
bool getEmbedded()

Getter for embedded.

Return Value

bool return the embedded value

at line 375
setPrint(bool $print)

Setter for print.

Parameters

bool $print

at line 385
bool getPrint()

Getter for print.

Return Value

bool return the print value

at line 392
static CRM_Core_Smarty getTemplate()

Return Value

CRM_Core_Smarty

at line 401
null getVar(string $name)

Parameters

string $name

Return Value

null

at line 409
setVar(string $name, $value)

Parameters

string $name
$value

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.

Parameters

string $entity The entity being queried.

Exceptions

CiviCRM_API3_Exception