CRM/Extension/Container/Interface.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  31  * $Id$
  32  */
  33
  34 /**
  35  * An extension container is a locally-accessible source tree which can be
  36  * scanned for extensions.
  37  */
  38 interface CRM_Extension_Container_Interface {
  39
  40   /**
  41    * Determine if any unmet requirements prevent use of this container.
  42    *
  43    * @return array
  44    *   List of error messages; empty if OK.
  45    */
  46   public function checkRequirements();
  47
  48   /**
  49    * Get a list of extensions available in this container.
  50    *
  51    * @return array
  52    *   List of keys (strings).
  53    */
  54   public function getKeys();
  55
  56   /**
  57    * Determine the main .php file for an extension
  58    *
  59    * @param string $key
  60    *   Fully-qualified extension name.
  61    * @return string
  62    *   Local path to the extension's main .php file.
  63    * @throws Exception
  64    */
  65   public function getPath($key);
  66
  67   /**
  68    * Determine the base URL for resources provided by the extension.
  69    *
  70    * @param string $key
  71    *   Fully-qualified extension name.
  72    * @return string
  73    *   Public URL.
  74    * @throws Exception
  75    */
  76   public function getResUrl($key);
  77
  78   /**
  79    * Scan the container for available extensions.
  80    */
  81   public function refresh();
  82
  83 }