CRM/Extension/Container/Static.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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-2018
  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    * @param array $exts
  40    *   Array(string $key => array $spec) List of extensions.
  41    */
  42   public function __construct($exts) {
  43     $this->exts = $exts;
  44   }
  45
  46   /**
  47    * @inheritDoc
  48    */
  49   public function checkRequirements() {
  50     return array();
  51   }
  52
  53   /**
  54    * @inheritDoc
  55    */
  56   public function getName() {
  57     return $this->name;
  58   }
  59
  60   /**
  61    * @inheritDoc
  62    */
  63   public function getKeys() {
  64     return array_keys($this->exts);
  65   }
  66
  67   /**
  68    * @inheritDoc
  69    */
  70   public function getPath($key) {
  71     $e = $this->getExt($key);
  72     return $e['path'];
  73   }
  74
  75   /**
  76    * @inheritDoc
  77    */
  78   public function getResUrl($key) {
  79     $e = $this->getExt($key);
  80     return $e['resUrl'];
  81   }
  82
  83   /**
  84    * @inheritDoc
  85    */
  86   public function refresh() {
  87   }
  88
  89   /**
  90    * @param string $key
  91    *   Extension name.
  92    *
  93    * @throws CRM_Extension_Exception_MissingException
  94    */
  95   protected function getExt($key) {
  96     if (isset($this->exts[$key])) {
  97       return $this->exts[$key];
  98     }
  99     else {
 100       throw new CRM_Extension_Exception_MissingException("Missing extension: $key");
 101     }
 102   }
 103
 104 }