Activity
extends DAOEntity
in package
Activity entity.
This entity adds record of any scheduled or completed interaction with one or more contacts. Each activity record is tightly linked to other CiviCRM constituents. With this API you can manually create an activity of desired type for your organisation or any other contact.
Creating a new Activity requires at minimum a activity_type_id, entity ID and object_table
An activity is a record of some type of interaction with one or more contacts.
Tags
Table of Contents
Methods
- __callStatic() : AbstractAction
- Magic method to return the action object for an api.
- autocomplete() : AutocompleteAction
- checkAccess() : CheckAccessAction
- create() : DAOCreateAction
- delete() : DAODeleteAction
- get() : DAOGetAction
- getActions() : GetActions
- getEntityName() : string
- Get entity name from called class
- getFields() : DAOGetFieldsAction
- getInfo() : array{name: string, title: string, description: string, title_plural: string, type: string, paths: array, class: string, primary_key: array, searchable: string, dao: string, label_field: string, icon: string}
- Reflection function called by Entity::get()
- getLinks() : GetLinks
- permissions() : array<string|int, mixed>
- Returns a list of permissions needed to access the various actions in this api.
- replace() : BasicReplaceAction
- save() : DAOSaveAction
- update() : DAOUpdateAction
- getDaoName() : CRM_Core_DAO|string|null
- getEntityTitle() : string
- Overridable function to return a localized title for this entity.
Methods
__callStatic()
Magic method to return the action object for an api.
public
static __callStatic(string $action, array<string|int, mixed> $args) : AbstractAction
Parameters
- $action : string
- $args : array<string|int, mixed>
Tags
Return values
AbstractActionautocomplete()
public
static autocomplete([bool $checkPermissions = TRUE ]) : AutocompleteAction
Parameters
- $checkPermissions : bool = TRUE
Return values
AutocompleteActioncheckAccess()
public
static checkAccess() : CheckAccessAction
Return values
CheckAccessActioncreate()
public
static create([bool $checkPermissions = TRUE ]) : DAOCreateAction
Parameters
- $checkPermissions : bool = TRUE
Return values
DAOCreateActiondelete()
public
static delete([bool $checkPermissions = TRUE ]) : DAODeleteAction
Parameters
- $checkPermissions : bool = TRUE
Return values
DAODeleteActionget()
public
static get([bool $checkPermissions = TRUE ]) : DAOGetAction
Parameters
- $checkPermissions : bool = TRUE
Return values
DAOGetActiongetActions()
public
static getActions([bool $checkPermissions = TRUE ]) : GetActions
Parameters
- $checkPermissions : bool = TRUE
Return values
GetActionsgetEntityName()
Get entity name from called class
public
static getEntityName() : string
Return values
stringgetFields()
public
static getFields([bool $checkPermissions = TRUE ]) : DAOGetFieldsAction
Parameters
- $checkPermissions : bool = TRUE
Return values
DAOGetFieldsActiongetInfo()
Reflection function called by Entity::get()
public
static getInfo() : array{name: string, title: string, description: string, title_plural: string, type: string, paths: array, class: string, primary_key: array, searchable: string, dao: string, label_field: string, icon: string}
Tags
Return values
array{name: string, title: string, description: string, title_plural: string, type: string, paths: array, class: string, primary_key: array, searchable: string, dao: string, label_field: string, icon: string}getLinks()
public
static getLinks([bool $checkPermissions = TRUE ]) : GetLinks
Parameters
- $checkPermissions : bool = TRUE
Return values
GetLinkspermissions()
Returns a list of permissions needed to access the various actions in this api.
public
static permissions() : array<string|int, mixed>
Return values
array<string|int, mixed>replace()
public
static replace([bool $checkPermissions = TRUE ]) : BasicReplaceAction
Parameters
- $checkPermissions : bool = TRUE
Return values
BasicReplaceActionsave()
public
static save([bool $checkPermissions = TRUE ]) : DAOSaveAction
Parameters
- $checkPermissions : bool = TRUE
Return values
DAOSaveActionupdate()
public
static update([bool $checkPermissions = TRUE ]) : DAOUpdateAction
Parameters
- $checkPermissions : bool = TRUE
Return values
DAOUpdateActiongetDaoName()
protected
static getDaoName() : CRM_Core_DAO|string|null
Return values
CRM_Core_DAO|string|nullgetEntityTitle()
Overridable function to return a localized title for this entity.
protected
static getEntityTitle([bool $plural = FALSE ]) : string
Parameters
- $plural : bool = FALSE
-
Whether to return a plural title.