class CRM_Contribute_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 Stores component information. from CRM_Core_Component_Info
protected $keyword

Methods

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

No description

array
getAngularModules()

EXPERIMENTAL: Get a list of AngularJS modules

array
getInfo()

No description

array
getManagedEntities()

Get a list of entities to register via API.

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

array|null
getUserDashboardElement()

No description

array|null
registerTab()

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.

mixed
getMenuObject()

Provides component's menu definition object.

mixed
getInvokeObject()

Provides component's invocation object.

mixed
getBAOQueryObject()

Provides component's BAO Query object.

buildAdvancedSearchPaneForm(CRM_Core_Form $form)

Builds advanced search form's component specific pane.

mixed
getUserDashboardObject()

Provides component's user dashboard page object.

mixed
getTabObject()

Provides component's contact record tab object.

string
getAdvancedSearchPaneTemplatePath()

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

bool
usesSearch()

Provides information whether given component uses system wide search.

array
menuFiles()

Provides the xml menu files.

string
getKeyword()

Simple "keyword" getter.

creatNewShortcut($shortCuts, $newCredit)

add shortcut to Create New.

Details

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

Parameters

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

array getAngularModules()

EXPERIMENTAL: Get a list of AngularJS modules

Return Value

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

See also

CRM_Utils_Hook::angularModules

at line 56
array getInfo()

Return Value

array collection of required component settings

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

at line 120
array getAnonymousPermissionWarnings()

Return Value

array list of permissions

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

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 138
array|null getUserDashboardElement()

Return Value

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

at line 159
array|null registerTab()

Return Value

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

at line 179
array|null registerAdvancedSearchPane()

Return Value

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

at line 199
array|null getActivityTypes()

Return Value

array|null collection of activity types

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

mixed getMenuObject()

Provides component's menu definition object.

Return Value

mixed component's menu definition object

mixed getInvokeObject()

Provides component's invocation object.

Return Value

mixed component's invocation object

mixed getBAOQueryObject()

Provides component's BAO Query object.

Return Value

mixed component's BAO Query object

buildAdvancedSearchPaneForm(CRM_Core_Form $form)

Builds advanced search form's component specific pane.

Parameters

CRM_Core_Form $form

mixed getUserDashboardObject()

Provides component's user dashboard page object.

Return Value

mixed component's User Dashboard applet object

mixed getTabObject()

Provides component's contact record tab object.

Return Value

mixed component's contact record tab object

string getAdvancedSearchPaneTemplatePath()

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

Return Value

string component's advanced search pane's template path

bool usesSearch()

Provides information whether given component uses system wide search.

Return Value

bool true if component needs search integration

array menuFiles()

Provides the xml menu files.

Return Value

array array of menu files

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 208
creatNewShortcut($shortCuts, $newCredit)

add shortcut to Create New.

Parameters

$shortCuts
$newCredit