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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
<?php
namespace Civi\Api4\Action\Entity;
use Civi\Api4\CustomGroup;
use Civi\Api4\Utils\ReflectionUtils;
/**
* Get entities
*
* @method $this setIncludeCustom(bool $value)
* @method bool getIncludeCustom()
*/
class Get extends \Civi\Api4\Generic\BasicGetAction {
/**
* Include custom-field-based pseudo-entities?
*
* @var bool
*/
protected $includeCustom = TRUE;
/**
* Scan all api directories to discover entities
*/
protected function getRecords() {
$entities = [];
foreach (explode(PATH_SEPARATOR, get_include_path()) as $path) {
$dir = \CRM_Utils_File::addTrailingSlash($path) . 'Civi/Api4';
if (is_dir($dir)) {
foreach (glob("$dir/*.php") as $file) {
$matches = [];
preg_match('/(\w*).php/', $file, $matches);
$entity = ['name' => $matches[1]];
if ($this->_isFieldSelected('description') || $this->_isFieldSelected('comment')) {
$this->addDocs($entity);
}
$entities[$matches[1]] = $entity;
}
}
}
unset($entities['CustomValue']);
if ($this->includeCustom) {
$this->addCustomEntities($entities);
}
ksort($entities);
return $entities;
}
/**
* Add custom-field pseudo-entities
*
* @param $entities
* @throws \API_Exception
*/
private function addCustomEntities(&$entities) {
$customEntities = CustomGroup::get()
->addWhere('is_multiple', '=', 1)
->addWhere('is_active', '=', 1)
->setSelect(['name', 'title', 'help_pre', 'help_post', 'extends'])
->setCheckPermissions(FALSE)
->execute();
foreach ($customEntities as $customEntity) {
$fieldName = 'Custom_' . $customEntity['name'];
$entities[$fieldName] = [
'name' => $fieldName,
'description' => $customEntity['title'] . ' custom group - extends ' . $customEntity['extends'],
];
if (!empty($customEntity['help_pre'])) {
$entities[$fieldName]['comment'] = $this->plainTextify($customEntity['help_pre']);
}
if (!empty($customEntity['help_post'])) {
$pre = empty($entities[$fieldName]['comment']) ? '' : $entities[$fieldName]['comment'] . "\n\n";
$entities[$fieldName]['comment'] = $pre . $this->plainTextify($customEntity['help_post']);
}
}
}
/**
* Convert html to plain text.
*
* @param $input
* @return mixed
*/
private function plainTextify($input) {
return html_entity_decode(strip_tags($input), ENT_QUOTES | ENT_HTML5, 'UTF-8');
}
/**
* Add info from code docblock.
*
* @param $entity
*/
private function addDocs(&$entity) {
$reflection = new \ReflectionClass("\\Civi\\Api4\\" . $entity['name']);
$entity += ReflectionUtils::getCodeDocs($reflection);
unset($entity['package'], $entity['method']);
}
}
|
