CRM_Admin_Page_CKEditorConfig

class CRM_Admin_Page_CKEditorConfig extends CRM_Core_Page

Page for configuring CKEditor options.

Note that while this is implemented as a CRM_Core_Page, it is actually a form. Because the form needs to be submitted and refreshed via javascript, it seemed like Quickform and CRM_Core_Form/Controller might get in the way.

Constants

CONFIG_FILEPATH

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
array $blackList Settings that cannot be configured in "advanced options"
$preset

Methods

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

Class constructor.

from CRM_Core_Page
run()

Run 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
save(array $params)

Generate the config js file based on posted data.

static array|null|string
getConfigUrl(string $preset = NULL)

No description

static null|string
getConfigFile(string $preset = 'default')

No description

static 
saveConfigFile($preset, $contents)

No description

static 
deleteConfigFile($preset)

Delete config file.

static 
setConfigDefault()

Create default config file if it doesn't exist

static string
fileHeader()

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 71
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.

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

at line 125
save(array $params)

Generate the config js file based on posted data.

Parameters

array $params

at line 224
static array|null|string getConfigUrl(string $preset = NULL)

Parameters

string $preset Omit to get an array of all presets

Return Value

array|null|string

at line 240
static null|string getConfigFile(string $preset = 'default')

Parameters

string $preset

Return Value

null|string

at line 248
static saveConfigFile($preset, $contents)

Parameters

$preset
$contents

at line 256
static deleteConfigFile($preset)

Delete config file.

Parameters

$preset

at line 266
static setConfigDefault()

Create default config file if it doesn't exist

at line 281
static string fileHeader()

Return Value

string