Civi/Api4/Entity.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 5                                                  |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2019                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27  */
  28
  29 /**
  30  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2019
  33  * $Id$
  34  *
  35  */
  36
  37
  38 namespace Civi\Api4;
  39
  40 /**
  41  * Retrieves information about all Api4 entities.
  42  *
  43  * @package Civi\Api4
  44  */
  45 class Entity extends Generic\AbstractEntity {
  46
  47   /**
  48    * @return Action\Entity\Get
  49    */
  50   public static function get() {
  51     return new Action\Entity\Get('Entity', __FUNCTION__);
  52   }
  53
  54   /**
  55    * @return \Civi\Api4\Generic\BasicGetFieldsAction
  56    */
  57   public static function getFields() {
  58     return new \Civi\Api4\Generic\BasicGetFieldsAction('Entity', __FUNCTION__, function() {
  59       return [
  60         ['name' => 'name'],
  61         ['name' => 'description'],
  62         ['name' => 'comment'],
  63       ];
  64     });
  65   }
  66
  67   /**
  68    * @return Action\Entity\GetLinks
  69    */
  70   public static function getLinks() {
  71     return new Action\Entity\GetLinks('Entity', __FUNCTION__);
  72   }
  73
  74   /**
  75    * @return array
  76    */
  77   public static function permissions() {
  78     return [
  79       'default' => ['access CiviCRM'],
  80     ];
  81   }
  82
  83 }