Source for file dom_tester.php

Documentation is available at dom_tester.php

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

Documentation generated on Sun, 31 Oct 2010 16:31:12 -0500 by phpDocumentor 1.4.3