CRM_Admin_Page_PreferencesDate

class CRM_Admin_Page_PreferencesDate extends CRM_Core_Page_Basic

Page for displaying list of location types.

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
$useLivePageJS
protected $_action from CRM_Core_Page_Basic
static array $_links The action links that we need to display for the browse screen.

Methods

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

Class constructor.

from CRM_Core_Page_Basic
run()

Run the page.

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

Store the variable with the value in the form scope.

from CRM_Core_Page
mixed
get(string $name)

Get the variable from the form scope.

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

Assign value to name in template.

from CRM_Core_Page
assign_by_ref(string $var, mixed $value)

Assign value to name in template by reference.

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

Appends values to template variables.

from CRM_Core_Page
array
get_template_vars(string $name = NULL)

Returns an array containing template variables.

from CRM_Core_Page
reset()

Destroy all the session state of this page.

from CRM_Core_Page
string
getTemplateFileName()

Use the form name to create the tpl file name.

from CRM_Core_Page
getHookedTemplateFileName()

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

from CRM_Core_Page
string
overrideExtraTemplateFileName()

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

from CRM_Core_Page
setEmbedded(bool $embedded)

Setter for embedded.

from CRM_Core_Page
bool
getEmbedded()

Getter for embedded.

from CRM_Core_Page
setPrint(bool $print)

Setter for print.

from CRM_Core_Page
bool
getPrint()

Getter for print.

from CRM_Core_Page
static CRM_Core_Smarty
getTemplate()

No description

from CRM_Core_Page
null
getVar(string $name)

No description

from CRM_Core_Page
setVar(string $name, $value)

No description

from CRM_Core_Page
assignFieldMetadataToTemplate(string $entity)

Assign metadata about fields to the template.

from CRM_Core_Page
string
getBAOName()

Get BAO Name.

array
links()

Get action Links.

string
editForm()

Get name of edit form.

string
editName()

Get edit form name.

string
userContext(int $mode = NULL)

Get user context.

string
userContextParams(int $mode = NULL)

Get userContext params.

from CRM_Core_Page_Basic
string
checkPermission(int $id, int $name)

Allow objects to be added based on permission.

from CRM_Core_Page_Basic
addValues(CRM_Core_Controller $controller)

Allows the derived class to add some more state variables to the controller. By default does nothing, and hence is abstract

from CRM_Core_Page_Basic
int
getIdAndAction()

Retrieve the action and ID from the request.

from CRM_Core_Page_Basic
string
superRun()

No description

from CRM_Core_Page_Basic
browse()

Browse all entities.

from CRM_Core_Page_Basic
action(CRM_Core_DAO $object, int $action, array $values, array $links, string $permission, bool $forceAction = FALSE)

Given an object, get the actions that can be associated with this object. Check the is_active and is_required flags to display valid actions

from CRM_Core_Page_Basic
edit(int $mode, int $id = NULL, bool $imageUpload = FALSE, bool $pushUserContext = TRUE)

Edit this entity.

from CRM_Core_Page_Basic

Details

in CRM_Core_Page_Basic at line 127
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 85
run()

Run the page.

This method is called after the page is created. It checks for the type of action and executes that action. Finally it calls the parent's run method.

in CRM_Core_Page 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.

in CRM_Core_Page at line 260
mixed get(string $name)

Get the variable from the form scope.

Parameters

string $name name of the variable

Return Value

mixed

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

Assign value to name in template.

Parameters

string $var
mixed $value Value of variable.

in CRM_Core_Page 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.

in CRM_Core_Page 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

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

Returns an array containing template variables.

Parameters

string $name

Return Value

array

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.

Return Value

string

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

Return Value

string

in CRM_Core_Page at line 356
setEmbedded(bool $embedded)

Setter for embedded.

Parameters

bool $embedded

in CRM_Core_Page at line 366
bool getEmbedded()

Getter for embedded.

Return Value

bool return the embedded value

in CRM_Core_Page at line 375
setPrint(bool $print)

Setter for print.

Parameters

bool $print

in CRM_Core_Page at line 385
bool getPrint()

Getter for print.

Return Value

bool return the print value

in CRM_Core_Page at line 392
static CRM_Core_Smarty getTemplate()

Return Value

CRM_Core_Smarty

in CRM_Core_Page at line 401
null getVar(string $name)

Parameters

string $name

Return Value

null

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

Parameters

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.

Parameters

string $entity The entity being queried.

Exceptions

CiviCRM_API3_Exception

at line 54
string getBAOName()

Get BAO Name.

Return Value

string

Get action Links.

Return Value

array (reference)

at line 97
string editForm()

Get name of edit form.

Return Value

string

at line 107
string editName()

Get edit form name.

Return Value

string

at line 119
string userContext(int $mode = NULL)

Get user context.

Parameters

int $mode Mode that we are in.

Return Value

string

in CRM_Core_Page_Basic at line 88
string userContextParams(int $mode = NULL)

Get userContext params.

Parameters

int $mode Mode that we are in.

Return Value

string

in CRM_Core_Page_Basic at line 103
string checkPermission(int $id, int $name)

Allow objects to be added based on permission.

Parameters

int $id The id of the object.
int $name The name or title of the object.

Return Value

string permission value if permission is granted, else null

in CRM_Core_Page_Basic at line 114
addValues(CRM_Core_Controller $controller)

Allows the derived class to add some more state variables to the controller. By default does nothing, and hence is abstract

Parameters

CRM_Core_Controller $controller The controller object.

in CRM_Core_Page_Basic at line 176
int getIdAndAction()

Retrieve the action and ID from the request.

Action is assigned to the template while we're at it. This is pulled from the run() method above.

Return Value

int The ID if present, or 0.

Exceptions

CRM_Core_Exception

in CRM_Core_Page_Basic at line 199
string superRun()

Return Value

string

in CRM_Core_Page_Basic at line 206
browse()

Browse all entities.

in CRM_Core_Page_Basic at line 303
action(CRM_Core_DAO $object, int $action, array $values, array $links, string $permission, bool $forceAction = FALSE)

Given an object, get the actions that can be associated with this object. Check the is_active and is_required flags to display valid actions

Parameters

CRM_Core_DAO $object The object being considered.
int $action The base set of actions.
array $values The array of values that we send to the template.
array $links The array of links.
string $permission The permission assigned to this object.
bool $forceAction

in CRM_Core_Page_Basic at line 392
edit(int $mode, int $id = NULL, bool $imageUpload = FALSE, bool $pushUserContext = TRUE)

Edit this entity.

Parameters

int $mode What mode for the form ?.
int $id Id of the entity (for update, view operations).
bool $imageUpload
bool $pushUserContext