CRM_Profile_Page_Listings

class CRM_Profile_Page_Listings extends CRM_Core_Page

This implements the profile page for all contacts. It uses a selector object to do the actual dispay. The fields displayd are controlled by the admin.

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
protected array $_fields All the fields that are listings related.
protected array $_customFields The custom fields for this domain.
protected array $_params The input params from the request.
protected int $_gid The group id that we are editing.
protected int $_search State whether to display search form or not.
protected int $_map Should we display a map.
protected array $_profileIds Store profile ids if multiple profile ids are passed using comma separated.

Methods

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

Class constructor.

from CRM_Core_Page
run()

Run this page (figure out the action needed and perform it).

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.

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

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
preProcess()

Extracts the parameters from the request and constructs information for the selector object to do a query

static array
getProfileContact(int $gid)

Get the list of contacts for a profile.

null|string
checkTemplateFileExists(string $suffix = '')

No description

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 290
run()

Run this page (figure out the action needed and perform it).

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.

at line 498
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

at line 509
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 96
preProcess()

Extracts the parameters from the request and constructs information for the selector object to do a query

at line 416
static array getProfileContact(int $gid)

Get the list of contacts for a profile.

Parameters

int $gid

Return Value

array

at line 473
null|string checkTemplateFileExists(string $suffix = '')

Parameters

string $suffix

Return Value

null|string