CRM/Extension/Container/Static.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  31  * $Id$
  32  */
  33
  34 /**
  35  * An extension container is a locally-accessible source tree which can be
  36  * scanned for extensions.
  37  */
  38 class CRM_Extension_Container_Static implements CRM_Extension_Container_Interface {
  39   public function __construct($exts) {
  40     $this->exts = $exts;
  41   }
  42
  43   /**
  44    * {@inheritdoc}
  45    */
  46   public function getName() {
  47     return $this->name;
  48   }
  49
  50   /**
  51    * {@inheritdoc}
  52    */
  53   public function getKeys() {
  54     return array_keys($this->exts);
  55   }
  56
  57   /**
  58    * {@inheritdoc}
  59    */
  60   public function getPath($key) {
  61     $e = $this->getExt($key);
  62     return $e['path'];
  63   }
  64
  65   /**
  66    * {@inheritdoc}
  67    */
  68   public function getResUrl($key) {
  69     $e = $this->getExt($key);
  70     return $e['resUrl'];
  71   }
  72
  73   /**
  74    * {@inheritdoc}
  75    */
  76   public function refresh() {
  77   }
  78
  79   protected function getExt($key) {
  80     if (isset($this->exts[$key])) {
  81       return $this->exts[$key];
  82     } else {
  83       throw new CRM_Extension_Exception_MissingException("Missing extension: $key");
  84     }
  85   }
  86 }