Changeset 2640

Timestamp:

08/01/08 11:00:37 (5 months ago)

Author:

impl

Message:

branches/david-xml_only_config_system (refs #519): fix AgaviXmlConfigDomElement::getAgaviParameters() and add documentation

Files:

• branches/david-xml_only_config_system/src/config/util/dom/AgaviXmlConfigDomElement.class.php (modified) (6 diffs)

branches/david-xml_only_config_system/src/config/util/dom/AgaviXmlConfigDomElement.class.php

@@ -71 +71 @@
   }
   
+  /**
+   * Count the number of child elements with a given name.
+   *
+   * @param      string The name of the element.
+   * @param      string The namespace URI. If null, the document default
+   *                    namespace will be used. If an empty string, no namespace
+   *                    will be used.
+   *
+   * @return     int The number of child elements with the given name.
+   *
+   * @author     Noah Fontes <noah.fontes@bitextender.com>
+   * @since      1.0.0
+   */
   public function countChildren($name, $namespaceUri = null)
   {
@@ -86 +99 @@
   }
   
+  /**
+   * Determine whether there is at least one instance of a child element with a
+   * given name.
+   *
+   * @param      string The name of the element.
+   * @param      string The namespace URI. If null, the document default
+   *                    namespace will be used. If an empty string, no namespace
+   *                    will be used.
+   *
+   * @return     bool True if one or more child elements with the given name
+   *                  exist, false otherwise.
+   *
+   * @author     Noah Fontes <noah.fontes@bitextender.com>
+   * @since      1.0.0
+   */
   public function hasChildren($name, $namespaceUri = null)
   {
@@ -91 +119 @@
   }
   
+  /**
+   * Retrieve all children with the given element name.
+   *
+   * @param      string The name of the element.
+   * @param      string The namespace URI. If null, the document default
+   *                    namespace will be used. If an empty string, no namespace
+   *                    will be used.
+   *
+   * @return     DOMNodeList A list of the child elements.
+   *
+   * @author     Noah Fontes <noah.fontes@bitextender.com>
+   * @since      1.0.0
+   */
   public function getChildren($name, $namespaceUri = null)
   {
@@ -107 +148 @@
   }
   
+  /**
+   * Determine whether this element has a particular child element. This method
+   * succeeds only when there is exactly one child element with the given name.
+   *
+   * @param      string The name of the element.
+   * @param      string The namespace URI. If null, the document default
+   *                    namespace will be used. If an empty string, no namespace
+   *                    will be used.
+   *
+   * @return     bool True if there is exactly one instance of an element with
+   *                  the given name; false otherwise.
+   *
+   * @author     Noah Fontes <noah.fontes@bitextender.com>
+   * @since      1.0.0
+   */
   public function hasChild($name, $namespaceUri = null)
   {
@@ -117 +173 @@
   
   /**
-   * Returns a single child element with a given name.
+   * Return a single child element with a given name.
    *
    * @param      string The name of the element.
@@ -194 +250 @@
   }
   
-  public function getAgaviParameters(array $existing = array())
-  {
+  /**
+   * Retrieve all of the Agavi parameter elements associated with this
+   * element.
+   *
+   * @param      array An array of existing parameters.
+   * @param      bool  Whether or not input values should be literalized once
+   *                   they are read.
+   *
+   * @return     array The complete array of parameters.
+   *
+   * @author     Noah Fontes <noah.fontes@bitextender.com>
+   * @since      1.0.0
+   */
+  public function getAgaviParameters(array $existing = array(), $literalize = true)
+  {
+    $result = $existing;
+    
     if($this->ownerDocument->isAgaviConfiguration()) {
       $elements = $this->getChildren('parameters', AgaviXmlConfigParser::AGAVI_ENVELOPE_NAMESPACE_LATEST);
-      $result = array();
       
       foreach($elements as $element) {
+        $key = null;
+        if(!$element->hasAttribute('name')) {
+          $result[] = null;
+          end($result);
+          $key = key($result);
+        } else {
+          $key = $element->getAttribute('name');
+        }
+        
         if($element->hasChildren('parameters', AgaviXmlConfigParser::AGAVI_ENVELOPE_NAMESPACE_LATEST)) {
-          $result[$element->getAttribute('name')] = $element->getAgaviParameters();
+          $result[$key] = isset($result[$key]) && is_array($result[$key]) ? $result[$key] : array();
+          $result[$key] = $element->getAgaviParameters($result[$key], $literalize);
         } else {
-          $result[$element->getAttribute('name')] = $element->getValue();
+          $result[$key] = $literalize ? AgaviToolkit::literalize($element->getValue()) : $element->getValue();
         }
       }
-      
-      return array_merge($existing, $result);
-    } else {
-      return $existing;
-    }
+    }
+    
+    return $result;
   }
 }