class CRM_Price_Page_Field extends CRM_Core_Page

Create a page for displaying Price Fields.

Heart of this class is the run method which checks for action type and then displays the appropriate page.

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 boolean $_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 boolean $_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 int $_sid The price set group id of the field.
protected boolean $_isSetReserved The price set is reserved or not.

Methods

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

Class constructor.

run()

Run the page.

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.

static array
actionLinks()

Get the action links for this page.

browse()

Browse all price set fields.

edit(string $action)

Edit price data.

void
preview(int $fid)

Preview price field.

Details

in CRM_Core_Page 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 238
run()

Run the page.

This method is called after the page is created. It checks for the type of action and executes that action.

in CRM_Core_Page at line 245
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 256
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 267
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 278
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 290
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 301
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 308
reset()

Destroy all the session state of this page.

in CRM_Core_Page at line 317
string getTemplateFileName()

Use the form name to create the tpl file name.

Return Value

string

in CRM_Core_Page at line 331
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 343
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 352
setEmbedded(bool $embedded)

Setter for embedded.

Parameters

bool $embedded

in CRM_Core_Page at line 362
bool getEmbedded()

Getter for embedded.

Return Value

bool return the embedded value

in CRM_Core_Page at line 371
setPrint(bool $print)

Setter for print.

Parameters

bool $print

in CRM_Core_Page at line 381
bool getPrint()

Getter for print.

Return Value

bool return the print value

in CRM_Core_Page at line 388
static CRM_Core_Smarty getTemplate()

Return Value

CRM_Core_Smarty

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

Parameters

string $name

Return Value

null

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

Parameters

string $name
$value

in CRM_Core_Page at line 422
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

Get the action links for this page.

Return Value

array array of action links that we need to display for the browse screen

at line 114
browse()

Browse all price set fields.

at line 216
edit(string $action)

Edit price data.

editing would involved modifying existing fields + adding data to new fields.

Parameters

string $action The action to be invoked.

at line 332
void preview(int $fid)

Preview price field.

Parameters

int $fid

Return Value

void