Documentation

CRM_Extension_Manager_Search extends CRM_Extension_Manager_Base
in package

This class stores logic for managing CiviCRM extensions.

Tags
copyright

CiviCRM LLC https://civicrm.org/licensing

Table of Contents

Constants

CUSTOM_SEARCH_GROUP_NAME  = 'custom_search'

Properties

$autoReplace  : bool
Whether to automatically uninstall and install during 'replace'.

Methods

__construct()  : mixed
CRM_Extension_Manager_Search constructor.
getGroupId()  : mixed
onPostDisable()  : mixed
Perform type-specific removal logic (after updating the extension row in the "civicrm_extension" table).
onPostEnable()  : mixed
onPostInstall()  : mixed
Perform type-specific installation logic (after marking the extension as installed but before clearing the caches).
onPostPostInstall()  : mixed
Perform type-specific installation logic (after marking the extension as installed and clearing the caches).
onPostReplace()  : mixed
onPostUninstall()  : mixed
Perform type-specific removal logic (after removing the extension row in the "civicrm_extension" table).
onPreDisable()  : mixed
Perform type-specific removal logic (before updating the extension row in the "civicrm_extension" table).
onPreEnable()  : mixed
onPreInstall()  : bool
Perform type-specific installation logic (before marking the extension as installed or clearing the caches).
onPreReplace()  : mixed
onPreUninstall()  : bool
Perform type-specific removal logic (before removing the extension row in the "civicrm_extension" table).
getCustomSearchesById()  : array<string|int, mixed>
getCustomSearchesByName()  : array<string|int, mixed>

Constants

CUSTOM_SEARCH_GROUP_NAME

public mixed CUSTOM_SEARCH_GROUP_NAME = 'custom_search'

Properties

$autoReplace

Whether to automatically uninstall and install during 'replace'.

public bool $autoReplace

Methods

__construct()

CRM_Extension_Manager_Search constructor.

public __construct() : mixed

getGroupId()

public getGroupId() : mixed

onPostDisable()

Perform type-specific removal logic (after updating the extension row in the "civicrm_extension" table).

public onPostDisable(CRM_Extension_Info $info) : mixed
Parameters
$info : CRM_Extension_Info
Tags
inheritDoc

onPostInstall()

Perform type-specific installation logic (after marking the extension as installed but before clearing the caches).

public onPostInstall(CRM_Extension_Info $info) : mixed
Parameters
$info : CRM_Extension_Info
Tags
inheritDoc

onPostPostInstall()

Perform type-specific installation logic (after marking the extension as installed and clearing the caches).

public onPostPostInstall(CRM_Extension_Info $info) : mixed
Parameters
$info : CRM_Extension_Info
Tags
inheritDoc

onPostUninstall()

Perform type-specific removal logic (after removing the extension row in the "civicrm_extension" table).

public onPostUninstall(CRM_Extension_Info $info) : mixed
Parameters
$info : CRM_Extension_Info
Tags
inheritDoc

onPreDisable()

Perform type-specific removal logic (before updating the extension row in the "civicrm_extension" table).

public onPreDisable(CRM_Extension_Info $info) : mixed
Parameters
$info : CRM_Extension_Info

onPreUninstall()

Perform type-specific removal logic (before removing the extension row in the "civicrm_extension" table).

public onPreUninstall(CRM_Extension_Info $info) : bool
Parameters
$info : CRM_Extension_Info
Tags
throws
Exception
Return values
bool

getCustomSearchesById()

protected getCustomSearchesById() : array<string|int, mixed>
Return values
array<string|int, mixed>

getCustomSearchesByName()

protected getCustomSearchesByName() : array<string|int, mixed>
Return values
array<string|int, mixed>

        
On this page

Search results