CRM/Extension/Container/Static.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2020                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * @package CRM
  30  * @copyright CiviCRM LLC (c) 2004-2020
  31  */
  32
  33 /**
  34  * An extension container is a locally-accessible source tree which can be
  35  * scanned for extensions.
  36  */
  37 class CRM_Extension_Container_Static implements CRM_Extension_Container_Interface {
  38
  39   /**
  40    * @param array $exts
  41    *   Array(string $key => array $spec) List of extensions.
  42    */
  43   public function __construct($exts) {
  44     $this->exts = $exts;
  45   }
  46
  47   /**
  48    * @inheritDoc
  49    */
  50   public function checkRequirements() {
  51     return [];
  52   }
  53
  54   /**
  55    * @inheritDoc
  56    */
  57   public function getName() {
  58     return $this->name;
  59   }
  60
  61   /**
  62    * @inheritDoc
  63    */
  64   public function getKeys() {
  65     return array_keys($this->exts);
  66   }
  67
  68   /**
  69    * @inheritDoc
  70    */
  71   public function getPath($key) {
  72     $e = $this->getExt($key);
  73     return $e['path'];
  74   }
  75
  76   /**
  77    * @inheritDoc
  78    */
  79   public function getResUrl($key) {
  80     $e = $this->getExt($key);
  81     return $e['resUrl'];
  82   }
  83
  84   /**
  85    * @inheritDoc
  86    */
  87   public function refresh() {
  88   }
  89
  90   /**
  91    * @param string $key
  92    *   Extension name.
  93    *
  94    * @throws CRM_Extension_Exception_MissingException
  95    */
  96   protected function getExt($key) {
  97     if (isset($this->exts[$key])) {
  98       return $this->exts[$key];
  99     }
 100     else {
 101       throw new CRM_Extension_Exception_MissingException("Missing extension: $key");
 102     }
 103   }
 104
 105 }