CRM/Extension/Container/Collection.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  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_Collection implements CRM_Extension_Container_Interface {
  39
  40   /**
  41    * @var array ($name => CRM_Extension_Container_Interface)
  42    *
  43    * Note: Treat as private. This is only public to facilitate debugging.
  44    */
  45   public $containers;
  46
  47   /**
  48    * @var CRM_Utils_Cache_Interface|NULL
  49    *
  50    * Note: Treat as private. This is only public to facilitate debugging.
  51    */
  52   public $cache;
  53
  54   /**
  55    * @var string the cache key used for any data stored by this container
  56    *
  57    * Note: Treat as private. This is only public to facilitate debugging.
  58    */
  59   public $cacheKey;
  60
  61   /**
  62    * @var array ($key => $containerName)
  63    *
  64    * Note: Treat as private. This is only public to facilitate debugging.
  65    */
  66   public $k2c;
  67
  68   /**
  69    * @param array $containers array($name => CRM_Extension_Container_Interface) in order from highest priority (winners) to lowest priority (losers)
  70    * @param CRM_Utils_Cache_Interface $cache
  71    * @param string $cacheKey unique name for this container
  72    */
  73   public function __construct($containers, CRM_Utils_Cache_Interface $cache = NULL, $cacheKey = NULL) {
  74     $this->containers = $containers;
  75     $this->cache = $cache;
  76     $this->cacheKey = $cacheKey;
  77   }
  78
  79   /**
  80    * {@inheritdoc}
  81    */
  82   public function checkRequirements() {
  83     $errors = array();
  84     foreach ($this->containers as $container) {
  85       $errors = array_merge($errors, $container->checkRequirements());
  86     }
  87     return $errors;
  88   }
  89
  90   /**
  91    * {@inheritdoc}
  92    */
  93   public function getKeys() {
  94     $k2c = $this->getKeysToContainer();
  95     return array_keys($k2c);
  96   }
  97
  98   /**
  99    * {@inheritdoc}
 100    */
 101   public function getPath($key) {
 102     return $this->getContainer($key)->getPath($key);
 103   }
 104
 105   /**
 106    * {@inheritdoc}
 107    */
 108   public function getResUrl($key) {
 109     return $this->getContainer($key)->getResUrl($key);
 110   }
 111
 112   /**
 113    * {@inheritdoc}
 114    */
 115   public function refresh() {
 116     if ($this->cache) {
 117       $this->cache->delete($this->cacheKey);
 118     }
 119     foreach ($this->containers as $container) {
 120       $container->refresh();
 121     }
 122   }
 123
 124   /**
 125    * Get the container which defines a particular key
 126    *
 127    * @param $key
 128    *
 129    * @throws CRM_Extension_Exception_MissingException
 130    * @return CRM_Extension_Container_Interface
 131    */
 132   public function getContainer($key) {
 133     $k2c = $this->getKeysToContainer();
 134     if (isset($k2c[$key]) && isset($this->containers[$k2c[$key]])) {
 135       return $this->containers[$k2c[$key]];
 136     } else {
 137       throw new CRM_Extension_Exception_MissingException("Unknown extension: $key");
 138     }
 139   }
 140
 141   /**
 142    * Get a list of all keys in these containers -- and the
 143    * name of the container which defines each key.
 144    *
 145    * @return array ($key => $containerName)
 146    */
 147   public function getKeysToContainer() {
 148     if ($this->cache) {
 149       $k2c = $this->cache->get($this->cacheKey);
 150     }
 151     if (!is_array($k2c)) {
 152       $k2c = array();
 153       $containerNames = array_reverse(array_keys($this->containers));
 154       foreach ($containerNames as $name) {
 155         $keys = $this->containers[$name]->getKeys();
 156         foreach ($keys as $key) {
 157           $k2c[$key] = $name;
 158         }
 159       }
 160       if ($this->cache) {
 161         $this->cache->set($this->cacheKey, $k2c);
 162       }
 163     }
 164     return $k2c;
 165   }
 166 }