CRM_Mailing_Info

class CRM_Mailing_Info extends CRM_Core_Component_Info

This class introduces component to the system and provides all the information about it. It needs to extend CRM_Core_Component_Info abstract class.

Constants

COMPONENT_INVOKE_CLASS

Name of the class (minus component namespace path) of the component invocation class'es name.
COMPONENT_BAO_QUERY_CLASS

Name of the class (minus component namespace path) of the component BAO Query class'es name.
COMPONENT_USERDASHBOARD_CLASS

Name of the class (minus component namespace path) of the component user dashboard plugin.
COMPONENT_TAB_CLASS

Name of the class (minus component namespace path) of the component tab offered to contact record view.
COMPONENT_ADVSEARCHPANE_CLASS

Name of the class (minus component namespace path) of the component tab offered to contact record view.
COMPONENT_XML_RESOURCES

Name of the directory (assumed in component directory) where xml resources used by this component live.
COMPONENT_MENU_XML

Name of the directory (assumed in xml resources path) containing component menu definition XML file names.

Properties

array $info Component settings as key/value pairs. from CRM_Core_Component_Info
protected string $keyword

Methods

__construct(string $name, string $namespace, int $componentID)

No description

from CRM_Core_Component_Info
array
getAngularModules()

Get AngularJS modules and their dependencies.

array
getInfo()

No description

array
getManagedEntities()

Get a list of entities to register via API.

from CRM_Core_Component_Info
array
getAnonymousPermissionWarnings()

Provides permissions that are unwise for Anonymous Roles to have.

from CRM_Core_Component_Info
array|null
getPermissions(bool $getAllUnconditionally = FALSE, bool $descriptions = FALSE)

No description

array
getReferenceCounts(CRM_Core_DAO $dao)

Determine how many other records refer to a given record.

from CRM_Core_Component_Info
array|null
getUserDashboardElement()

No description

array|null
registerTab()

No description

string
getIcon()

No description

array|null
registerAdvancedSearchPane()

No description

array|null
getActivityTypes()

No description

bool
isEnabled()

Provides information whether given component is currently marked as enabled in configuration.

from CRM_Core_Component_Info
mixed
getMenuObject()

Provides component's menu definition object.

from CRM_Core_Component_Info
mixed
getInvokeObject()

Provides component's invocation object.

from CRM_Core_Component_Info
mixed
getBAOQueryObject()

Provides component's BAO Query object.

from CRM_Core_Component_Info
buildAdvancedSearchPaneForm(CRM_Core_Form $form)

Builds advanced search form's component specific pane.

from CRM_Core_Component_Info
mixed
getUserDashboardObject()

No description

mixed
getTabObject()

Provides component's contact record tab object.

from CRM_Core_Component_Info
string
getAdvancedSearchPaneTemplatePath()

Provides component's advanced search pane's template path.

from CRM_Core_Component_Info
bool
usesSearch()

Provides information whether given component uses system wide search.

from CRM_Core_Component_Info
array
menuFiles()

Provides the xml menu files.

from CRM_Core_Component_Info
string
getKeyword()

Simple "keyword" getter.

from CRM_Core_Component_Info
static bool
workflowEnabled()

No description

creatNewShortcut($shortCuts)

add shortcut to Create New.

Details

in CRM_Core_Component_Info at line 100
__construct(string $name, string $namespace, int $componentID)

Parameters

string $name Name of the component.
string $namespace Namespace prefix for component's files.
int $componentID

at line 65
array getAngularModules()

Get AngularJS modules and their dependencies.

Return Value

array list of modules; same format as CRM_Utils_Hook::angularModules(&$angularModules)

See also

CRM_Utils_Hook::angularModules

at line 48
array getInfo()

Return Value

array collection of required component settings

in CRM_Core_Component_Info at line 136
array getManagedEntities()

Get a list of entities to register via API.

Return Value

array list of entities; same format as CRM_Utils_Hook::managedEntities(&$entities)

See also

CRM_Utils_Hook::managedEntities

in CRM_Core_Component_Info at line 147
array getAnonymousPermissionWarnings()

Provides permissions that are unwise for Anonymous Roles to have.

Return Value

array list of permissions

See also

CRM_Component_Info::getPermissions

at line 210
array|null getPermissions(bool $getAllUnconditionally = FALSE, bool $descriptions = FALSE)

Parameters

bool $getAllUnconditionally
bool $descriptions Whether to return permission descriptions

Return Value

array|null collection of permissions, null if none

in CRM_Core_Component_Info at line 177
array getReferenceCounts(CRM_Core_DAO $dao)

Determine how many other records refer to a given record.

Parameters

CRM_Core_DAO $dao The item for which we want a reference count.

Return Value

array each item in the array is an array with keys: - name: string, eg "sql:civicrm_email:contact_id" - type: string, eg "sql" - count: int, eg "5" if there are 5 email addresses that refer to $dao

at line 253
array|null getUserDashboardElement()

Return Value

array|null collection of required dashboard settings, null if no element offered

at line 270
array|null registerTab()

Return Value

array|null collection of required dashboard settings, null if no element offered

at line 283
string getIcon()

Return Value

string

at line 291
array|null registerAdvancedSearchPane()

Return Value

array|null collection of required pane settings, null if no element offered

at line 302
array|null getActivityTypes()

Return Value

array|null collection of activity types

in CRM_Core_Component_Info at line 238
bool isEnabled()

Provides information whether given component is currently marked as enabled in configuration.

Return Value

bool true if component is enabled, false if not

in CRM_Core_Component_Info at line 252
mixed getMenuObject()

Provides component's menu definition object.

Return Value

mixed component's menu definition object

in CRM_Core_Component_Info at line 262
mixed getInvokeObject()

Provides component's invocation object.

Return Value

mixed component's invocation object

in CRM_Core_Component_Info at line 272
mixed getBAOQueryObject()

Provides component's BAO Query object.

Return Value

mixed component's BAO Query object

in CRM_Core_Component_Info at line 281
buildAdvancedSearchPaneForm(CRM_Core_Form $form)

Builds advanced search form's component specific pane.

Parameters

CRM_Core_Form $form

at line 261
mixed getUserDashboardObject()

Return Value

mixed component's User Dashboard applet object

in CRM_Core_Component_Info at line 302
mixed getTabObject()

Provides component's contact record tab object.

Return Value

mixed component's contact record tab object

in CRM_Core_Component_Info at line 312
string getAdvancedSearchPaneTemplatePath()

Provides component's advanced search pane's template path.

Return Value

string component's advanced search pane's template path

in CRM_Core_Component_Info at line 323
bool usesSearch()

Provides information whether given component uses system wide search.

Return Value

bool true if component needs search integration

in CRM_Core_Component_Info at line 333
array menuFiles()

Provides the xml menu files.

Return Value

array array of menu files

in CRM_Core_Component_Info at line 345
string getKeyword()

Simple "keyword" getter.

FIXME: It should be protected so the keyword is not FIXME: accessed from beyond component infrastructure.

Return Value

string component keyword

at line 181
static bool workflowEnabled()

Return Value

bool

at line 310
creatNewShortcut($shortCuts)

add shortcut to Create New.

Parameters

$shortCuts