Changeset 3002

Timestamp:

10/08/08 19:58:55 (3 months ago)

Author:

david

Message:

Added getAttributes() and getAttributesNS() and cleaned up a bit (comments), refs #519

Files:

• branches/1.0/src/config/util/dom/AgaviXmlConfigDomElement.class.php (modified) (8 diffs)

branches/1.0/src/config/util/dom/AgaviXmlConfigDomElement.class.php

@@ -3 +3 @@
 class AgaviXmlConfigDomElement extends DOMElement implements IteratorAggregate
 {
+  /**
+   * __toString() magic method, returns the element value.
+   *
+   * @see        AgaviXmlConfigDomElement::getValue()
+   *
+   * @return     string The element value.
+   *
+   * @author     David Zülke <david.zuelke@bitextender.com>
+   * @since      1.0.0
+   */
   public function __toString()
   {
@@ -8 +18 @@
   }
   
+  /**
+   * Returns the element name.
+   *
+   * @return     string The element name.
+   *
+   * @author     David Zülke <david.zuelke@bitextender.com>
+   * @since      1.0.0
+   */
   public function getName()
   {
@@ -15 +33 @@
   }
   
+  /**
+   * Returns the element value.
+   *
+   * @return     string The element value.
+   *
+   * @author     David Zülke <david.zuelke@bitextender.com>
+   * @since      1.0.0
+   */
   public function getValue()
   {
@@ -28 +54 @@
    * @return     Iterator An iterator.
    *
-   * @author     David Zülke <dz@bitxtender.com>
+   * @author     David Zülke <david.zuelke@bitextender.com>
    * @since      1.0.0
    */
@@ -42 +68 @@
   }
   
+  /**
+   * Retrieve singular form of given element name.
+   * This does special splitting only of the last part of the name if the name
+   * of the element contains hyphens, underscores or dots.
+   *
+   * @param      string The element name to singularize.
+   *
+   * @return     string The singularized element name.
+   *
+   * @author     Noah Fontes <noah.fontes@bitextender.com>
+   * @since      1.0.0
+   */
   protected function singularize($name)
   {
+    // TODO: shouldn't this be static?
     $names = preg_split('#([_\-\.])#', $name, -1, PREG_SPLIT_DELIM_CAPTURE);
     $names[count($names) - 1] = AgaviInflector::singularize(end($names));
@@ -268 +307 @@
    * @see        DOMElement::getAttribute()
    *
-   * @author     David Zülke <dz@bitxtender.com>
+   * @author     David Zülke <david.zuelke@bitextender.com>
    * @since      1.0.0
    */
@@ -298 +337 @@
    * @see        DOMElement::getAttributeNS()
    *
-   * @author     David Zülke <dz@bitxtender.com>
+   * @author     David Zülke <david.zuelke@bitextender.com>
    * @since      1.0.0
    */
@@ -307 +346 @@
     if($retval === null) {
       $retval = $default;
+    }
+    
+    return $retval;
+  }
+  
+  /**
+   * Retrieve all attributes of the element that are in no namespace.
+   *
+   * @return     array An associative array of attribute names and values.
+   *
+   * @author     David Zülke <david.zuelke@bitextender.com>
+   * @since      1.0.0
+   */
+  public function getAttributes()
+  {
+    return $this->getAttributesNS('');
+  }
+  
+  /**
+   * Retrieve all attributes of the element that are in the given namespace.
+   *
+   * @return     array An associative array of attribute names and values.
+   *
+   * @author     David Zülke <david.zuelke@bitextender.com>
+   * @since      1.0.0
+   */
+  public function getAttributesNS($namespaceUri)
+  {
+    $retval = array();
+    
+    foreach($this->ownerDocument->getXpath()->query(sprintf('@*[namespace-uri() = "%s"]', $namespaceUri), $this) as $attribute) {
+      $retval[$attribute->localName] = $attribute->nodeValue;
     }