CRM_UF_Page_ProfileEditor
class CRM_UF_Page_ProfileEditor extends CRM_Core_Page
This class is not a real page -- it contains helpers for rendering the profile-selector and profile-editor widgets
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 |
bool | $useLivePageJS | Should crm.livePage.js be added to the page? | from CRM_Core_Page |
Methods
Class constructor.
Run page.
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.
Register profile scripts.
Register entity schemas for use in the editor's palette.
AJAX callback.
Get a list of Backbone-Form models
FIXME: Move to somewhere more useful FIXME: Do real mapping of "types"
Details
in CRM_Core_Page at line 126
CRM_Core_Page
__construct(string $title = NULL, int $mode = NULL)
Class constructor.
at line 15
run()
Run page.
in CRM_Core_Page at line 245
set(string|array $name, mixed $value = NULL)
Store the variable with the value in the form scope.
in CRM_Core_Page at line 256
mixed
get(string $name)
Get the variable from the form scope.
in CRM_Core_Page at line 267
assign(string $var, mixed $value = NULL)
Assign value to name in template.
in CRM_Core_Page at line 278
assign_by_ref(string $var, mixed $value)
Assign value to name in template by reference.
in CRM_Core_Page at line 290
append(array|string $tpl_var, mixed $value = NULL, bool $merge = FALSE)
Appends values to template variables.
in CRM_Core_Page at line 301
array
get_template_vars(string $name = NULL)
Returns an array containing template variables.
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.
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
in CRM_Core_Page at line 352
setEmbedded(bool $embedded)
Setter for embedded.
in CRM_Core_Page at line 362
bool
getEmbedded()
Getter for embedded.
in CRM_Core_Page at line 371
setPrint(bool $print)
Setter for print.
in CRM_Core_Page at line 381
bool
getPrint()
Getter for print.
in CRM_Core_Page at line 388
static CRM_Core_Smarty
getTemplate()
in CRM_Core_Page at line 397
null
getVar(string $name)
in CRM_Core_Page at line 405
setVar(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.
at line 22
static
registerProfileScripts()
Register profile scripts.
at line 88
static
registerSchemas(array $entityTypes)
Register entity schemas for use in the editor's palette.
at line 100
static
getSchemaJSON()
AJAX callback.
at line 116
static array;
getSchema(array $entityTypes)
Get a list of Backbone-Form models
at line 235
static array
convertCiviModelToBackboneModel(string $extends, string $title, array $availableFields)
FIXME: Move to somewhere more useful FIXME: Do real mapping of "types"