class CRM_Core_Component

Component stores all the static and dynamic information of the various CiviCRM components

Constants

COMPONENT_INFO_CLASS

End part (filename) of the component information class'es name that needs to be present in components main directory.

Properties

static array $_contactSubTypes

Methods

static mixed
get(string $name, null $attribute = NULL)

No description

getComponents(bool $force = FALSE)

No description

static array
getComponentIDs()

No description

getEnabledComponents(bool $force = FALSE)

No description

static 
flushEnabledComponents()

No description

static array
getNames(bool $translated = FALSE)

No description

static bool
invoke($args, $type)

No description

static array
xmlMenu()

No description

static array
menu()

No description

static mixed
getComponentID(string $componentName)

No description

static int|null|string
getComponentName(int $componentID)

No description

static array
getQueryFields($checkPermission = TRUE)

No description

static 
alterQuery($query, string $fnName)

No description

static null
from(string $fieldName, $mode, $side)

No description

static null
defaultReturnProperties($mode, bool $includeCustomFields = TRUE)

No description

static 
buildSearchForm(CRM_Core_Form $form)

No description

static 
searchAction($row, int $id)

No description

static array|null
contactSubTypes()

No description

static null
contactSubTypeProperties($subType, $op)

No description

static 
tableNames(array $tables)

Handle table dependencies of components.

static array
getComponentsFromFile(string $crmFolderDir)

Get components info from info file.

Details

at line 79
static mixed get(string $name, null $attribute = NULL)

Parameters

string $name
null $attribute

Return Value

mixed

at line 93
static CRM_Core_Component_Info[] getComponents(bool $force = FALSE)

Parameters

bool $force

Return Value

CRM_Core_Component_Info[]

Exceptions

Exception

at line 122
static array getComponentIDs()

Return Value

array Array(string $name => int $id).

at line 139
static CRM_Core_Component_Info[] getEnabledComponents(bool $force = FALSE)

Parameters

bool $force

Return Value

CRM_Core_Component_Info[]

at line 143
static flushEnabledComponents()

at line 153
static array getNames(bool $translated = FALSE)

Parameters

bool $translated

Return Value

array

at line 174
static bool invoke($args, $type)

Parameters

$args
$type

Return Value

bool

at line 209
static array xmlMenu()

Return Value

array

at line 227
static array menu()

Return Value

array

at line 247
static mixed getComponentID(string $componentName)

Parameters

string $componentName

Return Value

mixed

at line 262
static int|null|string getComponentName(int $componentID)

Parameters

int $componentID

Return Value

int|null|string

at line 279
static array getQueryFields($checkPermission = TRUE)

Parameters

$checkPermission

Return Value

array

at line 296
static alterQuery($query, string $fnName)

Parameters

$query
string $fnName

at line 314
static null from(string $fieldName, $mode, $side)

Parameters

string $fieldName
$mode
$side

Return Value

null

at line 336
static null defaultReturnProperties($mode, bool $includeCustomFields = TRUE)

Parameters

$mode
bool $includeCustomFields

Return Value

null

at line 358
static buildSearchForm(CRM_Core_Form $form)

Parameters

CRM_Core_Form $form

at line 373
static searchAction($row, int $id)

Parameters

$row
int $id

at line 387
static array|null contactSubTypes()

Return Value

array|null

at line 400
static null contactSubTypeProperties($subType, $op)

Parameters

$subType
$op

Return Value

null

at line 417
static tableNames(array $tables)

Handle table dependencies of components.

Parameters

array $tables Array of tables.

at line 435
static array getComponentsFromFile(string $crmFolderDir)

Get components info from info file.

Parameters

string $crmFolderDir

Return Value

array