Merge pull request #4029 from joannechester/Relative-date-filters-undeclared-variable...
[civicrm-core.git] / CRM / Utils / XML.php
index 11305820eb7ee9e4e105487f9291e6ab1e9b1bbb..ab3338b72d7c56bedfa5c39d22a6e161a83cb5b0 100644 (file)
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -27,7 +27,7 @@
 
 /**
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  */
 
@@ -36,6 +36,8 @@ class CRM_Utils_XML {
   /**
    * Read a well-formed XML file
    *
+   * @param $file
+   *
    * @return array (0 => SimpleXMLElement|FALSE, 1 => errorMessage|FALSE)
    */
   public static function parseFile($file) {
@@ -64,6 +66,8 @@ class CRM_Utils_XML {
   /**
    * Read a well-formed XML file
    *
+   * @param $string
+   *
    * @return array (0 => SimpleXMLElement|FALSE, 1 => errorMessage|FALSE)
    */
   public static function parseString($string) {
@@ -85,6 +89,11 @@ class CRM_Utils_XML {
     return array($xml, $error);
   }
 
+  /**
+   * @param $errors
+   *
+   * @return string
+   */
   protected static function formatErrors($errors) {
     $messages = array();
 
@@ -111,6 +120,8 @@ class CRM_Utils_XML {
    * Convert an XML element to an array
    *
    * @pararm $obj SimpleXMLElement
+   * @param $obj
+   *
    * @return array
    */
   public static function xmlObjToArray($obj) {