4 +--------------------------------------------------------------------+
5 | Copyright CiviCRM LLC. All rights reserved. |
7 | This work is published under the GNU AGPLv3 license with some |
8 | permitted exceptions and without any warranty. For full license |
9 | and copyright information, see https://civicrm.org/licensing |
10 +--------------------------------------------------------------------+
16 * @copyright CiviCRM LLC https://civicrm.org/licensing
25 * Retrieves information about all Api4 entities.
27 * @see \Civi\Api4\Generic\AbstractEntity
31 class Entity
extends Generic\AbstractEntity
{
34 * @return Action\Entity\Get
36 public static function get() {
37 return new Action\Entity\
Get('Entity', __FUNCTION__
);
41 * @return \Civi\Api4\Generic\BasicGetFieldsAction
43 public static function getFields() {
44 return new \Civi\Api4\Generic\
BasicGetFieldsAction('Entity', __FUNCTION__
, function() {
48 'description' => 'Entity name',
52 'description' => 'Localized title',
55 'name' => 'description',
56 'description' => 'Description from docblock',
60 'description' => 'Comments from docblock',
64 'description' => 'crm-i icon class associated with this entity',
68 'description' => 'Class name for dao-based entities',
72 'data_type' => 'Array',
73 'description' => 'Any @see annotations from docblock',
80 * @return Action\Entity\GetLinks
82 public static function getLinks() {
83 return new Action\Entity\
GetLinks('Entity', __FUNCTION__
);
89 public static function permissions() {
91 'default' => ['access CiviCRM'],