blob: e774baca38c7b5969bc4708e7789884d899bddd9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
<?php
namespace Civi\Api4\Generic;
use Civi\API\Exception\NotImplementedException;
/**
* Base class for all api entities.
*
* When adding your own api from an extension, extend this class only
* if your entity does not have an associated DAO. Otherwise extend DAOEntity.
*
* The recommended way to create a non-DAO-based api is to extend this class
* and then add a getFields function and any other actions you wish, e.g.
* - a get() function which returns BasicGetAction using your custom getter callback
* - a create() function which returns BasicCreateAction using your custom setter callback
* - an update() function which returns BasicUpdateAction using your custom setter callback
* - a delete() function which returns BasicBatchAction using your custom delete callback
* - a replace() function which returns BasicReplaceAction (no callback needed but
* depends on the existence of get, create, update & delete actions)
*
* Note that you can use the same setter callback function for update as create -
* that function can distinguish between new & existing records by checking if the
* unique identifier has been set (identifier field defaults to "id" but you can change
* that when constructing BasicUpdateAction)
*/
abstract class AbstractEntity {
/**
* @return \Civi\Api4\Action\GetActions
*/
public static function getActions() {
return new \Civi\Api4\Action\GetActions(self::getEntityName(), __FUNCTION__);
}
/**
* Should return \Civi\Api4\Generic\BasicGetFieldsAction
* @todo make this function abstract when we require php 7.
* @throws \Civi\API\Exception\NotImplementedException
*/
public static function getFields() {
throw new NotImplementedException(self::getEntityName() . ' should implement getFields action.');
}
/**
* Returns a list of permissions needed to access the various actions in this api.
*
* @return array
*/
public static function permissions() {
$permissions = \CRM_Core_Permission::getEntityActionPermissions();
// For legacy reasons the permissions are keyed by lowercase entity name
$lcentity = _civicrm_api_get_entity_name_from_camel(self::getEntityName());
// Merge permissions for this entity with the defaults
return \CRM_Utils_Array::value($lcentity, $permissions, []) + $permissions['default'];
}
/**
* Get entity name from called class
*
* @return string
*/
protected static function getEntityName() {
return substr(static::class, strrpos(static::class, '\\') + 1);
}
/**
* Magic method to return the action object for an api.
*
* @param string $action
* @param null $args
* @return AbstractAction
* @throws NotImplementedException
*/
public static function __callStatic($action, $args) {
$entity = self::getEntityName();
// Find class for this action
$entityAction = "\\Civi\\Api4\\Action\\$entity\\" . ucfirst($action);
if (class_exists($entityAction)) {
$actionObject = new $entityAction($entity, $action);
}
else {
throw new NotImplementedException("Api $entity $action version 4 does not exist.");
}
return $actionObject;
}
}
|
