CustomValue
in package
Provides virtual api entities for every multi-record custom group.
This class is different from other apis in that it is not itself an entity, but allows every multi-record custom group to act like an entity.
Each action takes the name of the custom group as a parameter, or in traditional syntax the entity is prefixed with 'Custom_'
Ex. OOP: \Civi\Api4\CustomValue::get('MyStuff')->addWhere('id', '=', 123);
Non-OOP: civicrm_api4('Custom_MyStuff', 'get', ['where' => [['id', '=', 123]]]);
Note: This class does NOT extend AbstractEntity so it doesn't get mistaken for a "real" entity.
Table of Contents
Methods
- autocomplete() : AutocompleteAction
- checkAccess() : CheckAccessAction
- create() : Create
- delete() : Delete
- get() : Get
- getActions() : GetActions
- getFields() : DAOGetFieldsAction
- getInfo() : array<string|int, mixed>
- getLinks() : GetLinks
- permissions() : array<string|int, mixed>
- replace() : BasicReplaceAction
- save() : Save
- update() : Update
- getDaoName() : CRM_Core_DAO|string|null
Methods
autocomplete()
public
static autocomplete(string $customGroup[, bool $checkPermissions = TRUE ]) : AutocompleteAction
Parameters
- $customGroup : string
- $checkPermissions : bool = TRUE
Return values
AutocompleteActioncheckAccess()
public
static checkAccess(mixed $customGroup) : CheckAccessAction
Parameters
- $customGroup : mixed
Return values
CheckAccessActioncreate()
public
static create(string $customGroup[, bool $checkPermissions = TRUE ]) : Create
Parameters
- $customGroup : string
- $checkPermissions : bool = TRUE
Tags
Return values
Createdelete()
public
static delete(string $customGroup[, bool $checkPermissions = TRUE ]) : Delete
Parameters
- $customGroup : string
- $checkPermissions : bool = TRUE
Tags
Return values
Deleteget()
public
static get(string $customGroup[, bool $checkPermissions = TRUE ]) : Get
Parameters
- $customGroup : string
- $checkPermissions : bool = TRUE
Tags
Return values
GetgetActions()
public
static getActions([string $customGroup = NULL ][, bool $checkPermissions = TRUE ]) : GetActions
Parameters
- $customGroup : string = NULL
- $checkPermissions : bool = TRUE
Tags
Return values
GetActionsgetFields()
public
static getFields([string $customGroup = NULL ][, bool $checkPermissions = TRUE ]) : DAOGetFieldsAction
Parameters
- $customGroup : string = NULL
- $checkPermissions : bool = TRUE
Tags
Return values
DAOGetFieldsActiongetInfo()
public
static getInfo() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getLinks()
public
static getLinks([string $customGroup = NULL ][, bool $checkPermissions = TRUE ]) : GetLinks
Parameters
- $customGroup : string = NULL
- $checkPermissions : bool = TRUE
Return values
GetLinkspermissions()
public
static permissions() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>replace()
public
static replace(string $customGroup[, bool $checkPermissions = TRUE ]) : BasicReplaceAction
Parameters
- $customGroup : string
- $checkPermissions : bool = TRUE
Tags
Return values
BasicReplaceActionsave()
public
static save(string $customGroup[, bool $checkPermissions = TRUE ]) : Save
Parameters
- $customGroup : string
- $checkPermissions : bool = TRUE
Tags
Return values
Saveupdate()
public
static update(string $customGroup[, bool $checkPermissions = TRUE ]) : Update
Parameters
- $customGroup : string
- $checkPermissions : bool = TRUE
Tags
Return values
UpdategetDaoName()
protected
static getDaoName() : CRM_Core_DAO|string|null