Source for file dom_tester.php

Documentation is available at dom_tester.php

  1. <?php
  2.  
  3. /**
  4.  *    @package    SimpleTest
  5.  *    @subpackage    DomTestCase
  6.  *  @author     Perrick Penet <perrick@noparking.net>
  7.  *    @version    $Id: dom_tester.php 1637 2008-01-20 20:18:54Z pp11 $
  8.  */
  9.  
  10. /**#@+
  11.  * include SimpleTest files
  12.  */
  13. require_once dirname(__FILE__).'/../web_tester.php';
  14. require_once dirname(__FILE__).'/dom_tester/css_selector.php';
  15. /**#@-*/
  16.  
  17.  * CssSelectorExpectation
  18.  * 
  19.  * Create a CSS Selector expectation
  20.  * 
  21.  * @param DomDocument $_dom 
  22.  * @param string $_selector 
  23.  * @param array $_value 
  24.  * 
  25.  */
  26.  
  27. class CssSelectorExpectation extends SimpleExpectation {
  28.     var $_dom;
  29.     var $_selector;
  30.     var $_value;
  31.     
  32.     /**
  33.      *    Sets the dom tree and the css selector to compare against
  34.      *    @param mixed $dom          Dom tree to search into.
  35.      *    @param string $selector    Css selector to match element.
  36.      *    @param string $message     Customised message on failure.
  37.      *    @access public
  38.      */
  39.     function CssSelectorExpectation($dom, $selector, $message = '%s') {
  40.         $this->SimpleExpectation($message);
  41.         $this->_dom = $dom;
  42.         $this->_selector = $this->_normalizeSelector($selector);
  43.         
  44.         $css_selector = new CssSelector($this->_dom);
  45.         $this->_value = $css_selector->getTexts($this->_selector);
  46.     }
  47.  
  48.     /**
  49.      *    Normalizes the selector. In particular, replaces single-quotes with
  50.      *    double-quotes.
  51.      *    @param string $selector     Css selector to match element.
  52.      *    @return string              Normalized Css selector.
  53.      *    @access public
  54.      */
  55.     function _normalizeSelector($selector) {
  56.         return str_replace("'", '"', $selector);
  57.     }    
  58.  
  59.     /**
  60.      *    Tests the expectation. True if it matches the
  61.      *    held value.
  62.      *    @param mixed $compare        Comparison value.
  63.      *    @return boolean              True if correct.
  64.      *    @access public
  65.      */
  66.     function test($compare) {
  67.             return (($this->_value == $compare) && ($compare == $this->_value));
  68.     }
  69.     
  70.     /**
  71.      *    Returns a human readable test message.
  72.      *    @param mixed $compare      Comparison value.
  73.      *    @return string             Description of success
  74.      *                                or failure.
  75.      *    @access public
  76.      */
  77.     function testMessage($compare) {
  78.         $dumper = &$this->_getDumper();
  79.         if (is_array($compare)) {
  80.             sort($compare);
  81.         }
  82.         if ($this->test($compare)) {
  83.             return "CSS selector expectation [" . $dumper->describeValue($this->_value) . "]".
  84.                     " using [" . $dumper->describeValue($this->_selector) . "]";
  85.         } else {
  86.             return "CSS selector expectation [" . $dumper->describeValue($this->_value) . "]".
  87.                     " using [" . $dumper->describeValue($this->_selector) . "]".
  88.                     " fails with [" .
  89.                     $dumper->describeValue($compare) . "] " .
  90.                     $dumper->describeDifference($this->_value, $compare);
  91.         }
  92.     }
  93. }
  94.  
  95. /**
  96.  * DomTestCase
  97.  * 
  98.  * Extend Web test case with DOM related assertions,
  99.  * CSS selectors in particular
  100.  * 
  101.  * @category Testing
  102.  * @package DomTestCase
  103.  * 
  104.  * @param DomDocument $dom 
  105.  * 
  106.  */
  107. class DomTestCase extends WebTestCase {
  108.     var $dom;
  109.  
  110.     function assertElementsBySelector($selector, $elements, $message = '%s') {
  111.         $this->dom = new DomDocument('1.0', 'utf-8');
  112.         $this->dom->validateOnParse = true;
  113.         $this->dom->loadHTML($this->_browser->getContent());
  114.  
  115.         return $this->assert(
  116.                 new CssSelectorExpectation($this->dom, $selector),
  117.                 $elements,
  118.                 $message);
  119.     }
  120. }
  121.  
  122. ?>

Documentation generated on Sun, 04 May 2008 09:21:26 -0500 by phpDocumentor 1.3.0