Civi/Api4/Action/Entity/GetLinks.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\Action\Entity;
  39
  40 use Civi\Api4\Utils\CoreUtil;
  41
  42 /**
  43  * Get a list of FK links between entities
  44  */
  45 class GetLinks extends \Civi\Api4\Generic\BasicGetAction {
  46
  47   public function getRecords() {
  48     $result = [];
  49     /** @var \Civi\Api4\Service\Schema\SchemaMap $schema */
  50     $schema = \Civi::container()->get('schema_map');
  51     foreach ($schema->getTables() as $table) {
  52       $entity = CoreUtil::getApiNameFromTableName($table->getName());
  53       // Since this is an api function, exclude tables that don't have an api
  54       if (class_exists('\Civi\Api4\\' . $entity)) {
  55         $item = [
  56           'entity' => $entity,
  57           'table' => $table->getName(),
  58           'links' => [],
  59         ];
  60         foreach ($table->getTableLinks() as $link) {
  61           $link = $link->toArray();
  62           $link['entity'] = CoreUtil::getApiNameFromTableName($link['targetTable']);
  63           $item['links'][] = $link;
  64         }
  65         $result[] = $item;
  66       }
  67     }
  68     return $result;
  69   }
  70
  71   public function fields() {
  72     return [
  73       [
  74         'name' => 'entity',
  75       ],
  76       [
  77         'name' => 'table',
  78       ],
  79       [
  80         'name' => 'links',
  81         'data_type' => 'Array',
  82       ],
  83     ];
  84   }
  85
  86 }