CRM_Utils_Recent

class CRM_Utils_Recent

Recent items utility class.

Constants

MAX_ITEMS

Store name
STORE_NAME

Store name

Methods

static 
initialize()

Initialize this class and set the static variables.

static array
get()

Return the recently viewed array.

static 
add(string $title, string $url, string $id, $type, int $contactId, string $contactName, array $others = [])

Add an item to the recent stack.

static 
del(array $recentItem)

Delete an item from the recent stack.

static 
delContact(string $id)

Delete an item from the recent stack.

static bool
isProviderEnabled(string $providerName)

Check if a provider is allowed to add stuff.

static array
getProviders()

Gets the list of available providers to civi's recent items stack

Details

at line 61
static initialize()

Initialize this class and set the static variables.

at line 81
static array get()

Return the recently viewed array.

Return Value

array the recently viewed array

at line 100
static add(string $title, string $url, string $id, $type, int $contactId, string $contactName, array $others = [])

Add an item to the recent stack.

Parameters

string $title The title to display.
string $url The link for the above title.
string $id Object id.
$type
int $contactId
string $contactName
array $others

at line 161
static del(array $recentItem)

Delete an item from the recent stack.

Parameters

array $recentItem Array of the recent Item to be removed.

at line 188
static delContact(string $id)

Delete an item from the recent stack.

Parameters

string $id Contact id that had to be removed.

at line 216
static bool isProviderEnabled(string $providerName)

Check if a provider is allowed to add stuff.

If corresponding setting is empty, all are allowed

Parameters

string $providerName

Return Value

bool

at line 239
static array getProviders()

Gets the list of available providers to civi's recent items stack

Return Value

array