3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
30 * @copyright CiviCRM LLC (c) 2004-2014
35 * An extension container is a locally-accessible source tree which can be
36 * scanned for extensions.
38 interface CRM_Extension_Container_Interface
{
41 * Determine if any unmet requirements prevent use of this container.
43 * @return array list of error messages; empty if OK
45 public function checkRequirements();
48 * Get a list of extensions available in this container
50 * @return array list of keys (strings)
52 public function getKeys();
55 * Determine the main .php file for an extension
57 * @param string $key fully-qualified extension name
58 * @return string local path to the extension's main .php file
61 public function getPath($key);
64 * Determine the base URL for resources provided by the extension
66 * @param string $key fully-qualified extension name
67 * @return string public URL
70 public function getResUrl($key);
72 public function refresh();