Changeset 3001

Timestamp:

10/08/08 18:28:51 (3 months ago)

Author:

david

Message:

Changed singular/plural handling in AgaviXmlConfigDomElement? convenience methods, closes #878

Location:

branches/1.0

Files:

• CHANGELOG (modified) (1 diff)
• src/config/AgaviConfigHandlersConfigHandler.class.php (modified) (6 diffs)
• src/config/AgaviTestSuitesConfigHandler.class.php (modified) (1 diff)
• src/config/util/dom/AgaviXmlConfigDomElement.class.php (modified) (10 diffs)

branches/1.0/CHANGELOG

@@ -4 +4 @@
 1.0.0 beta 4 (October ??, 2008)
 -------------------------------
+
+CHG: Change singular/plural handling in AgaviXmlConfigDomElement convenience methods (#878) (David)
 
 FIX: XInclude failure leads to corrupt exception error message (#877) (David)

branches/1.0/src/config/AgaviConfigHandlersConfigHandler.class.php

@@ -23 +23 @@
  *
  * @author     Dominik del Bondio <ddb@bitxtender.com>
+ * @author     Noah Fontes <noah.fontes@bitextender.com>
+ * @author     David Zülke <david.zuelke@bitextender.com>
  * @copyright  Authors
  * @copyright  The Agavi Project
@@ -49 +51 @@
    * @author     Dominik del Bondio <ddb@bitxtender.com>
    * @author     Noah Fontes <noah.fontes@bitextender.com>
+   * @author     David Zülke <david.zuelke@bitextender.com>
    * @since      0.11.0
    */
@@ -60 +63 @@
     
     foreach($document->getConfigurationElements() as $configuration) {
-      if(!$configuration->hasChildren('handlers')) {
+      if(!$configuration->has('handlers')) {
         continue;
       }
       
       // let's do our fancy work
-      foreach($configuration->getChildren('handlers') as $handler) {
+      foreach($configuration->get('handlers') as $handler) {
         $pattern = $handler->getAttribute('pattern');
         
@@ -76 +79 @@
           AgaviXmlConfigParser::STAGE_COMPILATION => array(),
         );
-        if($handler->hasChildren('transformations')) {
-          foreach($handler->getChildren('transformations') as $transformation) {
+        if($handler->has('transformations')) {
+          foreach($handler->get('transformations') as $transformation) {
             $path = AgaviToolkit::literalize($transformation->getValue());
             $for = $transformation->getAttribute('for', AgaviXmlConfigParser::STAGE_SINGLE);
@@ -122 +125 @@
           ),
         );
-        if($handler->hasChildren('validations')) {
-          foreach($handler->getChildren('validations') as $validation) {
+        if($handler->has('validations')) {
+          foreach($handler->get('validations') as $validation) {
             $path = AgaviToolkit::literalize($validation->getValue());
             $type = null;
@@ -158 +161 @@
   }
   
-  public function guessValidationType($path)
+  /**
+   * Convenience method to quickly guess the type of a validation file using its
+   * file extension.
+   *
+   * @param      string The path to the file.
+   *
+   * @return     string An AgaviXmlConfigParser::VALIDATION_TYPE_* const value.
+   *
+   * @throws     AgaviException If the type could not be determined.
+   *
+   * @author     David Zülke <david.zuelke@bitextender.com>
+   * @since      1.0.0
+   */
+  protected function guessValidationType($path)
   {
     switch(pathinfo($path, PATHINFO_EXTENSION)) {

branches/1.0/src/config/AgaviTestSuitesConfigHandler.class.php

@@ -58 +58 @@
     // loop over <configuration> elements
     foreach($document->getConfigurationElements() as $configuration) {
-      foreach($configuration->getChildren('suites') as $current) {
+      foreach($configuration->get('suites') as $current) {
         $suite =  array('class' => $current->getAttribute('class', 'AgaviTestSuite'));
         $suite['testfiles'] = array();
-        foreach($current->getChildren('testfiles') as $file) {
+        foreach($current->get('testfiles') as $file) {
           $suite['testfiles'][] = $file->textContent;
         }

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

@@ -3 +3 @@
 class AgaviXmlConfigDomElement extends DOMElement implements IteratorAggregate
 {
-  /**
-   * Overloaded method for accessing child nodes. Does the pluralizing etc, and
-   * provides convenient access through a potentially set default namespace.
-   *
-   * @param      string The child element name.
-   *
-   * @return     mixed A DOMNodeList or an AgaviXmlConfigDomElement.
-   *
-   * @author     David Zülke <dz@bitxtender.com>
-   * @since      1.0.0
-   */
-  public function __get($name) {
-    // TODO: add {namespace}element support
-    // should look into the default ns, IMO. otherwise, you gotta use getChild()
-    // must use singular/plural handling
-  }
-  
-  public function __isset($name) {
-    // TODO: add {namespace}element support
-    // should look into the default ns, IMO. otherwise, you gotta use hasChild()
-  }
-  
   public function __toString()
   {
@@ -72 +50 @@
   
   /**
+   * Convenience method to retrieve child elements of the given name.
+   * Accepts singular or plural forms of the name, and will detect and handle
+   * parent containers with plural names properly.
+   *
+   * @param      string The name of the element(s) to check for.
+   * @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     David Zülke <david.zuelke@bitextender.com>
+   * @since      1.0.0
+   */
+  public function get($name, $namespaceUri = null)
+  {
+    return $this->getChildren($name, $namespaceUri, true);
+  }
+  
+  /**
+   * Convenience method to check if there are child elements of the given name.
+   * Accepts singular or plural forms of the name, and will detect and handle
+   * parent containers with plural names properly.
+   *
+   * @param      string The name of the element(s) to check for.
+   * @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     David Zülke <david.zuelke@bitextender.com>
+   * @since      1.0.0
+   */
+  public function has($name, $namespaceUri = null)
+  {
+    return $this->hasChildren($name, $namespaceUri, true);
+  }
+  
+  /**
    * Count the number of child elements with a given name.
    *
@@ -78 +97 @@
    *                    namespace will be used. If an empty string, no namespace
    *                    will be used.
+   * @param      bool   Whether or not to apply automatic singular/plural
+   *                    handling that skips plural container elements.
    *
    * @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)
-  {
-    // check for child elements(!) using XPath
-    // if arg is true, then only check for elements from our default namespace
+   * @author     David Zülke <david.zuelke@bitextender.com>
+   * @since      1.0.0
+   */
+  public function countChildren($name, $namespaceUri = null, $pluralMagic = false)
+  {
+    // if arg is null, then only check for elements from our default namespace
+    // if namespace uri is null, use default ns. if empty string, use no ns
     $namespaceUri = ($namespaceUri === null ? $this->ownerDocument->getDefaultNamespaceUri() : $namespaceUri);
-    $singularName = $this->singularize($name);
-    
-    $xpath = $this->ownerDocument->getXpath();
-    if($namespaceUri) {
-      return (int)$xpath->evaluate(sprintf('count(child::*[local-name() = "%2$s" and namespace-uri() = "%3$s"]) + count(child::*[local-name() = "%1$s" and namespace-uri() = "%3$s"]/*[local-name() = "%2$s" and namespace-uri() = "%3$s"])', $name, $singularName, $namespaceUri), $this);
+    
+    // init our vars
+    $query = '';
+    $singularName = null;
+    
+    if($pluralMagic) {
+      // we always assume that we either get plural names, or the singular of the singular is not different from the singular :)
+      $singularName = $this->singularize($name);
+      if($namespaceUri) {
+        $query = 'count(child::*[local-name() = "%2$s" and namespace-uri() = "%3$s"]) + count(child::*[local-name() = "%1$s" and namespace-uri() = "%3$s"]/*[local-name() = "%2$s" and namespace-uri() = "%3$s"])';
+      } else {
+        $query = 'count(%1$s/%2$s) + count(%2$s)';
+      }
     } else {
-      return (int)$xpath->evaluate(sprintf('count(%2$s) + count(%1$s/%2$s)', $name, $singularName), $this);
-    }
+      if($namespaceUri) {
+        $query = 'count(child::*[local-name() = "%1$s" and namespace-uri() = "%3$s"])';
+      } else {
+        $query = 'count(%1$s)';
+      }
+    }
+    
+    return (int)$this->ownerDocument->getXpath()->evaluate(sprintf($query, $name, $singularName, $namespaceUri), $this);
   }
   
@@ -107 +143 @@
    *                    namespace will be used. If an empty string, no namespace
    *                    will be used.
+   * @param      bool   Whether or not to apply automatic singular/plural
+   *                    handling that skips plural container elements.
    *
    * @return     bool True if one or more child elements with the given name
@@ -112 +150 @@
    *
    * @author     Noah Fontes <noah.fontes@bitextender.com>
-   * @since      1.0.0
-   */
-  public function hasChildren($name, $namespaceUri = null)
-  {
-    return $this->countChildren($name, $namespaceUri) !== 0;
+   * @author     David Zülke <david.zuelke@bitextender.com>
+   * @since      1.0.0
+   */
+  public function hasChildren($name, $namespaceUri = null, $pluralMagic = false)
+  {
+    return $this->countChildren($name, $namespaceUri, $pluralMagic) !== 0;
   }
   
@@ -126 +165 @@
    *                    namespace will be used. If an empty string, no namespace
    *                    will be used.
+   * @param      string Whether or not to apply pluralization magic in selects.
+   * @param      bool   Whether or not to apply automatic singular/plural
+   *                    handling that skips plural container elements.
    *
    * @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)
-  {
-    // check for child elements(!) using XPath
-    // if arg is true, then only check for elements from our default namespace
+   * @author     David Zülke <david.zuelke@bitextender.com>
+   * @since      1.0.0
+   */
+  public function getChildren($name, $namespaceUri = null, $pluralMagic = false)
+  {
+    // if arg is null, then only check for elements from our default namespace
     // if namespace uri is null, use default ns. if empty string, use no ns
     $namespaceUri = ($namespaceUri === null ? $this->ownerDocument->getDefaultNamespaceUri() : $namespaceUri);
-    $singularName = $this->singularize($name);
-    
-    $xpath = $this->ownerDocument->getXpath();
-    if($namespaceUri) {
-      return $xpath->query(sprintf('child::*[local-name() = "%2$s" and namespace-uri() = "%3$s"] | child::*[local-name() = "%1$s" and namespace-uri() = "%3$s"]/*[local-name() = "%2$s" and namespace-uri() = "%3$s"]', $name, $singularName, $namespaceUri), $this);
+    
+    // init our vars
+    $query = '';
+    $singularName = null;
+    
+    if($pluralMagic) {
+      // we always assume that we either get plural names, or the singular of the singular is not different from the singular :)
+      $singularName = $this->singularize($name);
+      if($namespaceUri) {
+        $query = 'child::*[local-name() = "%2$s" and namespace-uri() = "%3$s"] | child::*[local-name() = "%1$s" and namespace-uri() = "%3$s"]/*[local-name() = "%2$s" and namespace-uri() = "%3$s"]';
+      } else {
+        $query = '%1$s/%2$s | %2$s';
+      }
     } else {
-      return $xpath->query(sprintf('%1$s/%2$s | %2$s', $name, $singularName), $this);
-    }
+      if($namespaceUri) {
+        $query = 'child::*[local-name() = "%1$s" and namespace-uri() = "%3$s"]';
+      } else {
+        $query = '%1$s';
+      }
+    }
+    
+    return $this->ownerDocument->getXpath()->query(sprintf($query, $name, $singularName, $namespaceUri), $this);
   }
   
@@ -166 +222 @@
   public function hasChild($name, $namespaceUri = null)
   {
+    return $this->getChild($name, $namespaceUri) !== null;
+  }
+  
+  /**
+   * Return a single child element with a given name.
+   * Only returns anything if there is exactly one child of this 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     DOMElement The child element, or null if none exists.
+   *
+   * @author     Noah Fontes <noah.fontes@bitextender.com>
+   * @author     David Zülke <david.zuelke@bitextender.com>
+   * @since      1.0.0
+   */
+  public function getChild($name, $namespaceUri = null)
+  {
+    // if arg is null, then only check for elements from our default namespace
     // if namespace uri is null, use default ns. if empty string, use no ns
-    return $this->countChildren($name, $namespaceUri) === 1;
-    
-    // XXX: not necessary for single elements?
-    // remember singular/plural support
-  }
-  
-  /**
-   * Return a single 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     DOMElement The child element, or null if none xists.
-   *
-   * @author     Noah Fontes <noah.fontes@bitextender.com>
-   * @since      1.0.0
-   */
-  public function getChild($name, $namespaceUri = null)
-  {
-    $list = $this->getChildren($name, $namespaceUri);
-    
-    if($list->length > 0) {
-      return $list->item(0);
-    }
-    return null;
+    $namespaceUri = ($namespaceUri === null ? $this->ownerDocument->getDefaultNamespaceUri() : $namespaceUri);
+    
+    if($namespaceUri) {
+      $query = 'self::node()[count(child::*[local-name() = "%1$s" and namespace-uri() = "%2$s"]) = 1]/*[local-name() = "%1$s" and namespace-uri() = "%2$s"]';
+    } else {
+      $query = 'self::node()[count(child::%1$s) = 1]/%1$s';
+    }
+    
+    return $this->ownerDocument->getXpath()->query(sprintf($query, $name, $namespaceUri), $this)->item(0);
   }
   
@@ -264 +323 @@
   {
     if($this->ownerDocument->isAgaviConfiguration()) {
-      return $this->hasChildren('parameters', AgaviXmlConfigParser::NAMESPACE_AGAVI_ENVELOPE_LATEST);
+      return $this->has('parameters', AgaviXmlConfigParser::NAMESPACE_AGAVI_ENVELOPE_LATEST);
     }
     
@@ -281 +340 @@
    *
    * @author     Noah Fontes <noah.fontes@bitextender.com>
+   * @author     David Zülke <david.zuelke@bitextender.com>
    * @since      1.0.0
    */
@@ -289 +349 @@
     
     if($this->ownerDocument->isAgaviConfiguration()) {
-      $elements = $this->getChildren('parameters', AgaviXmlConfigParser::NAMESPACE_AGAVI_ENVELOPE_LATEST);
+      $elements = $this->get('parameters', AgaviXmlConfigParser::NAMESPACE_AGAVI_ENVELOPE_LATEST);
       
       foreach($elements as $element) {