Campaign
extends DAOEntity
in package
uses
ManagedEntity, HierarchicalEntity
Campaign entity.
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
- export() : ExportAction
- get() : Get
- getActions() : GetActions
- getEntityName() : string
- Get entity name from called class
- getFields() : DAOGetFieldsAction
- getInfo() : array<string|int, mixed>
- Automatically adds "parent_field" info, if it hasn't already been declared via `@parentField` annotation.
- getLinks() : GetLinks
- permissions() : array<string|int, mixed>
- Returns a list of permissions needed to access the various actions in this api.
- replace() : BasicReplaceAction
- revert() : BasicBatchAction
- 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
DAODeleteActionexport()
public
static export([bool $checkPermissions = true ]) : ExportAction
Parameters
- $checkPermissions : bool = true
Return values
ExportActionget()
public
static get([bool $checkPermissions = true ]) : Get
Parameters
- $checkPermissions : bool = true
Return values
GetgetActions()
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()
Automatically adds "parent_field" info, if it hasn't already been declared via `@parentField` annotation.
public
static getInfo() : array<string|int, mixed>
Return values
array<string|int, mixed>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
BasicReplaceActionrevert()
public
static revert([bool $checkPermissions = true ]) : BasicBatchAction
Parameters
- $checkPermissions : bool = true
Return values
BasicBatchActionsave()
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.