Civi/Api4/Entity.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | Copyright CiviCRM LLC. All rights reserved.                        |
   6  |                                                                    |
   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  +--------------------------------------------------------------------+
  11  */
  12
  13 /**
  14  *
  15  * @package CRM
  16  * @copyright CiviCRM LLC https://civicrm.org/licensing
  17  */
  18
  19
  20 namespace Civi\Api4;
  21
  22 /**
  23  * Retrieves information about all Api4 entities.
  24  *
  25  * @see \Civi\Api4\Generic\AbstractEntity
  26  *
  27  * @package Civi\Api4
  28  */
  29 class Entity extends Generic\AbstractEntity {
  30
  31   /**
  32    * @param bool $checkPermissions
  33    * @return Action\Entity\Get
  34    */
  35   public static function get($checkPermissions = TRUE) {
  36     return (new Action\Entity\Get('Entity', __FUNCTION__))
  37       ->setCheckPermissions($checkPermissions);
  38   }
  39
  40   /**
  41    * @param bool $checkPermissions
  42    * @return Generic\BasicGetFieldsAction
  43    */
  44   public static function getFields($checkPermissions = TRUE) {
  45     return (new Generic\BasicGetFieldsAction('Entity', __FUNCTION__, function() {
  46       return [
  47         [
  48           'name' => 'name',
  49           'description' => 'Entity name',
  50         ],
  51         [
  52           'name' => 'title',
  53           'description' => 'Localized title (singular)',
  54         ],
  55         [
  56           'name' => 'title_plural',
  57           'description' => 'Localized title (plural)',
  58         ],
  59         [
  60           'name' => 'type',
  61           'description' => 'Base class for this entity',
  62           'options' => ['DAOEntity' => 'DAOEntity', 'BasicEntity' => 'BasicEntity', 'BridgeEntity' => 'BridgeEntity', 'AbstractEntity' => 'AbstractEntity'],
  63         ],
  64         [
  65           'name' => 'description',
  66           'description' => 'Description from docblock',
  67         ],
  68         [
  69           'name' => 'comment',
  70           'description' => 'Comments from docblock',
  71         ],
  72         [
  73           'name' => 'icon',
  74           'description' => 'crm-i icon class associated with this entity',
  75         ],
  76         [
  77           'name' => 'dao',
  78           'description' => 'Class name for dao-based entities',
  79         ],
  80         [
  81           'name' => 'paths',
  82           'data_type' => 'Array',
  83           'description' => 'System paths for accessing this entity',
  84         ],
  85         [
  86           'name' => 'see',
  87           'data_type' => 'Array',
  88           'description' => 'Any @see annotations from docblock',
  89         ],
  90       ];
  91     }))->setCheckPermissions($checkPermissions);
  92   }
  93
  94   /**
  95    * @param bool $checkPermissions
  96    * @return Action\Entity\GetLinks
  97    */
  98   public static function getLinks($checkPermissions = TRUE) {
  99     return (new Action\Entity\GetLinks('Entity', __FUNCTION__))
 100       ->setCheckPermissions($checkPermissions);
 101   }
 102
 103   /**
 104    * @return array
 105    */
 106   public static function permissions() {
 107     return [
 108       'default' => ['access CiviCRM'],
 109     ];
 110   }
 111
 112 }