3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
14 * Retrieves information about all Api4 entities.
16 * @see \Civi\Api4\Generic\AbstractEntity
22 class Entity
extends Generic\AbstractEntity
{
25 * @param bool $checkPermissions
26 * @return Action\Entity\Get
28 public static function get($checkPermissions = TRUE) {
29 return (new Action\Entity\
Get('Entity', __FUNCTION__
))
30 ->setCheckPermissions($checkPermissions);
34 * @param bool $checkPermissions
35 * @return Generic\BasicGetFieldsAction
37 public static function getFields($checkPermissions = TRUE) {
38 return (new Generic\
BasicGetFieldsAction('Entity', __FUNCTION__
, function() {
42 'description' => 'Entity name',
46 'description' => 'Localized title (singular)',
49 'name' => 'title_plural',
50 'description' => 'Localized title (plural)',
54 'data_type' => 'Array',
55 'description' => 'Base class for this entity',
57 'AbstractEntity' => 'AbstractEntity',
58 'DAOEntity' => 'DAOEntity',
59 'CustomValue' => 'CustomValue',
60 'BasicEntity' => 'BasicEntity',
61 'ManagedEntity' => 'ManagedEntity',
62 'EntityBridge' => 'EntityBridge',
63 'OptionList' => 'OptionList',
67 'name' => 'description',
68 'description' => 'Description from docblock',
72 'description' => 'Comments from docblock',
76 'description' => 'crm-i icon class associated with this entity',
80 'description' => 'Class name for dao-based entities',
83 'name' => 'primary_key',
85 'description' => 'Name of unique identifier field(s) (e.g. [id])',
88 'name' => 'label_field',
89 'description' => 'Field to show when displaying a record',
92 'name' => 'searchable',
93 'description' => 'How should this entity be presented in search UIs',
95 'primary' => ts('Primary'),
96 'secondary' => ts('Secondary'),
97 'bridge' => ts('Bridge'),
103 'data_type' => 'Array',
104 'description' => 'System paths for accessing this entity',
108 'data_type' => 'Array',
109 'description' => 'Any @see annotations from docblock',
113 'data_type' => 'String',
114 'description' => 'Version this API entity was added',
118 'data_type' => 'String',
119 'description' => 'PHP class name',
123 'data_type' => 'Array',
124 'description' => 'Connecting fields for EntityBridge types',
127 'name' => 'ui_join_filters',
128 'data_type' => 'Array',
129 'description' => 'When joining entities in the UI, which fields should be presented by default in the ON clause',
132 }))->setCheckPermissions($checkPermissions);
136 * @param bool $checkPermissions
138 * @return Action\Entity\GetLinks
140 public static function getLinks($checkPermissions = TRUE) {
141 return (new Action\Entity\
GetLinks('Entity', __FUNCTION__
))
142 ->setCheckPermissions($checkPermissions);
148 public static function permissions() {
150 'default' => ['access CiviCRM'],