CRM_SMS_Page_Provider
class CRM_SMS_Page_Provider extends CRM_Core_Page_Basic
Page for displaying list of Providers
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 | $_action | from CRM_Core_Page_Basic | |
static array | $_links | The action links that we need to display for the browse screen. |
Methods
Class constructor.
Run the 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.
Get BAO Name.
Get action Links.
Get name of edit form.
Get edit form name.
Get user context.
Allow objects to be added based on permission.
Allows the derived class to add some more state variables to the controller. By default does nothing, and hence is abstract
Browse all Providers.
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
Edit this entity.
Details
in CRM_Core_Page_Basic at line 127
CRM_Core_Page
__construct(string $title = NULL, int $mode = NULL)
Class constructor.
at line 101
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 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 54
string
getBAOName()
Get BAO Name.
at line 64
array
links()
Get action Links.
at line 164
string
editForm()
Get name of edit form.
at line 174
string
editName()
Get edit form name.
at line 186
string
userContext(int $mode = NULL)
Get user context.
in CRM_Core_Page_Basic at line 88
string
userContextParams(int $mode = NULL)
Get userContext params.
in CRM_Core_Page_Basic at line 103
string
checkPermission(int $id, int $name)
Allow objects to be added based on permission.
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
in CRM_Core_Page_Basic at line 181
string
superRun()
at line 129
browse(array $action = NULL)
Browse all Providers.
in CRM_Core_Page_Basic at line 285
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
in CRM_Core_Page_Basic at line 365
edit(int $mode, int $id = NULL, bool $imageUpload = FALSE, bool $pushUserContext = TRUE)
Edit this entity.