| 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 | * Metadata for an extension (e.g. the extension's "info.xml" file) |
| 30 | */ |
| 31 | class CRM_Extension_Info { |
| 32 | |
| 33 | /** |
| 34 | * Extension info file name. |
| 35 | */ |
| 36 | const FILENAME = 'info.xml'; |
| 37 | |
| 38 | public $key = NULL; |
| 39 | public $type = NULL; |
| 40 | public $name = NULL; |
| 41 | public $label = NULL; |
| 42 | public $file = NULL; |
| 43 | |
| 44 | /** |
| 45 | * Load extension info an XML file. |
| 46 | * |
| 47 | * @param $file |
| 48 | * |
| 49 | * @throws CRM_Extension_Exception_ParseException |
| 50 | * @return CRM_Extension_Info |
| 51 | */ |
| 52 | public static function loadFromFile($file) { |
| 53 | list ($xml, $error) = CRM_Utils_XML::parseFile($file); |
| 54 | if ($xml === FALSE) { |
| 55 | throw new CRM_Extension_Exception_ParseException("Failed to parse info XML: $error"); |
| 56 | } |
| 57 | |
| 58 | $instance = new CRM_Extension_Info(); |
| 59 | $instance->parse($xml); |
| 60 | return $instance; |
| 61 | } |
| 62 | |
| 63 | /** |
| 64 | * Load extension info a string. |
| 65 | * |
| 66 | * @param string $string |
| 67 | * XML content. |
| 68 | * |
| 69 | * @throws CRM_Extension_Exception_ParseException |
| 70 | * @return CRM_Extension_Info |
| 71 | */ |
| 72 | public static function loadFromString($string) { |
| 73 | list ($xml, $error) = CRM_Utils_XML::parseString($string); |
| 74 | if ($xml === FALSE) { |
| 75 | throw new CRM_Extension_Exception_ParseException("Failed to parse info XML: $string"); |
| 76 | } |
| 77 | |
| 78 | $instance = new CRM_Extension_Info(); |
| 79 | $instance->parse($xml); |
| 80 | return $instance; |
| 81 | } |
| 82 | |
| 83 | /** |
| 84 | * @param null $key |
| 85 | * @param null $type |
| 86 | * @param null $name |
| 87 | * @param null $label |
| 88 | * @param null $file |
| 89 | */ |
| 90 | public function __construct($key = NULL, $type = NULL, $name = NULL, $label = NULL, $file = NULL) { |
| 91 | $this->key = $key; |
| 92 | $this->type = $type; |
| 93 | $this->name = $name; |
| 94 | $this->label = $label; |
| 95 | $this->file = $file; |
| 96 | } |
| 97 | |
| 98 | /** |
| 99 | * Copy attributes from an XML document to $this |
| 100 | * |
| 101 | * @param SimpleXMLElement $info |
| 102 | * @return void |
| 103 | */ |
| 104 | public function parse($info) { |
| 105 | $this->key = (string) $info->attributes()->key; |
| 106 | $this->type = (string) $info->attributes()->type; |
| 107 | $this->file = (string) $info->file; |
| 108 | $this->label = (string) $info->name; |
| 109 | |
| 110 | // Convert first level variables to CRM_Core_Extension properties |
| 111 | // and deeper into arrays. An exception for URLS section, since |
| 112 | // we want them in special format. |
| 113 | foreach ($info as $attr => $val) { |
| 114 | if (count($val->children()) == 0) { |
| 115 | $this->$attr = (string) $val; |
| 116 | } |
| 117 | elseif ($attr === 'urls') { |
| 118 | $this->urls = array(); |
| 119 | foreach ($val->url as $url) { |
| 120 | $urlAttr = (string) $url->attributes()->desc; |
| 121 | $this->urls[$urlAttr] = (string) $url; |
| 122 | } |
| 123 | ksort($this->urls); |
| 124 | } |
| 125 | else { |
| 126 | $this->$attr = CRM_Utils_XML::xmlObjToArray($val); |
| 127 | } |
| 128 | } |
| 129 | } |
| 130 | |
| 131 | } |