Merge remote-tracking branch 'upstream/4.4' into 4.4-master-2014-06-30-11-58-01
[civicrm-core.git] / CRM / Utils / XML.php
index 98e0b5aca1324c3e83e22c72f11e09229f647275..ab3338b72d7c56bedfa5c39d22a6e161a83cb5b0 100644 (file)
@@ -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) {