Updated test cases and examples and cleaned up the new OO code so it will

be easier to maintain.

Author: John Coggeshall

ext/tidy/README

@@ -1,7 +1,7 @@
 
 README FOR ext/tidy by John Coggeshall <john@php.net>
 
-Tidy Version: 0.5b
+Tidy Version: 0.7b
 
 Tidy is an extension based on Libtidy (http://tidy.sf.net/) and allows a PHP developer
 to clean, repair, and traverse HTML, XHTML, and XML documents -- including ones with
@@ -19,55 +19,55 @@ then recompile libtidy.
 The Tidy extension has two separate APIs, one for general parsing, cleaning, and
 repairing and another for document traversal. The general API is provided below:
 
-  tidy_create()                     Initialize and return a tidy document resource
-  tidy_parse_file($tidy, $file)     Parse the document stored in $file
-  tidy_parse_string($tidy, $str)    Parse the string stored in $str
+  tidy_create()                     Reinitialize the tidy engine
+  tidy_parse_file($file)	    Parse the document stored in $file
+  tidy_parse_string($str)    	    Parse the string stored in $str
 
-  tidy_clean_repair($tidy)          Clean and repair the document
-  tidy_diagnose($tidy)              Diagnose a parsed document
+  tidy_clean_repair()               Clean and repair the document
+  tidy_diagnose()	            Diagnose a parsed document
 
-  tidy_setopt($tidy, $opt, $val)    Set a configuration option $opt to $val
-  tidy_getopt($tidy, $opt)          Retrieve a configuration option
+  tidy_setopt($opt, $val)           Set a configuration option $opt to $val
+  tidy_getopt($opt)                Retrieve a configuration option
 
-    ** note: $opt is a string representing the option. Right now the only
-    source of these options is the LibTidy source.. eventually I'll document
-    them offically -- see the src/config.c file in the tidy source **
+    ** note: $opt is a string representing the option. Although no formal
+    documentation yet exists for PHP, you can find a description of many
+    of them at http://www.w3.org/People/Raggett/tidy/ and a list of supported
+    options in the phpinfo(); output**
 
-  tidy_get_output($tidy)            Return the cleaned tidy HTML as a string
-  tidy_get_error_buffer($tidy)      Return a log of the errors and warnings
+  tidy_get_output()                 Return the cleaned tidy HTML as a string
+  tidy_get_error_buffer()           Return a log of the errors and warnings
                                     returned by tidy
 
   tidy_get_release()                Return the Libtidy release date
-  tidy_get_status($tidy)            Return the status of the document
-  tidy_get_html_ver($tidy)          Return the major HTML version detected for
+  tidy_get_status()                 Return the status of the document
+  tidy_get_html_ver()               Return the major HTML version detected for
                                     the document;
 
-  tidy_is_xhtml($tidy)              Determines if the document is XHTML
-  tidy_is_xml($tidy)                Determines if the document is a generic XML
+  tidy_is_xhtml()                   Determines if the document is XHTML
+  tidy_is_xml()                     Determines if the document is a generic XML
 
-  tidy_error_count($tidy)           Returns the number of errors in the document
-  tidy_warning_count($tidy)         Returns the number of warnings in the document
-  tidy_access_count($tidy)          Returns the number of accessibility-related
+  tidy_error_count()                Returns the number of errors in the document
+  tidy_warning_count()              Returns the number of warnings in the document
+  tidy_access_count()               Returns the number of accessibility-related
                                     warnings in the document.
-  tidy_config_count($tidy)          Returns the number of configuration errors found
+  tidy_config_count()               Returns the number of configuration errors found
 
-  tidy_load_config($tidy, $file)    Loads the specified configuration file
-  tidY_load_config_enc($tidy,
-                       $file,
+  tidy_load_config($file)           Loads the specified configuration file
+  tidY_load_config_enc($file,
                        $enc)        Loads the specified config file using the specified
                                     character encoding
-  tidy_set_encoding($tidy, $enc)    Sets the current character encoding for the document
-  tidy_save_config($tidy, $file)    Saves the current config to $file
+  tidy_set_encoding($enc)           Sets the current character encoding for the document
+  tidy_save_config($file)           Saves the current config to $file
 
 
 Beyond these general-purpose API functions, Tidy also supports the following
 functions which are used to retrieve an object for document traversal:
 
-  tidy_get_root($tidy)              Returns an object starting at the root of the
+  tidy_get_root()              Returns an object starting at the root of the
                                     document
-  tidy_get_head($tidy)              Returns an object starting at the <HEAD> tag
-  tidy_get_html($tidy)              Returns an object starting at the <HTML> tag
-  tidy_get_body($tidy)              Returns an object starting at the <BODY> tag
+  tidy_get_head()              Returns an object starting at the <HEAD> tag
+  tidy_get_html()              Returns an object starting at the <HTML> tag
+  tidy_get_body()              Returns an object starting at the <BODY> tag
 
 All Navigation of the specified document is done via the PHP5 object constructs.
 There are two types of objects which Tidy can create. The first is TidyNode, which
@@ -82,18 +82,12 @@ class TidyNode {
     public $type;               // type of node (text, php, asp, etc.)
     public $id;                 // id of node (i.e. TIDY_TAG_HEAD)
 
-    public $line;               // line # of node in source
-    public $column;             // column # of node in source
-    
-    public $html_ver;           // HTML version (0,1,2,3,4)
-    
-    public $attribs;            // an array of attributes (see TidyAttr)
-    public $children;           // an array of child nodes
+    public function attributes();            // an array of attributes (see TidyAttr)
+    public function children();           // an array of child nodes
 
     function has_siblings();    // any sibling nodes?
     function has_children();    // any child nodes?
-    function has_parent();      // have a parent?
-    
+       
     function is_comment();      // is node a comment?
     function is_xhtml();        // is document XHTML?
     function is_xml();          // is document generic XML (not HTML/XHTML)
@@ -106,45 +100,12 @@ class TidyNode {
 
     function next();            // returns next node
     function prev();            // returns prev node
-    function parent();          // returns parent node
-    function child();           // returns first child node
-    
+        
     /* Searches for a particular attribute in the current node based
        on node ID. If found returns a TidyAttr object for it */
-    function get_attr_type($attr_id);
+    function get_attr($attr_id);
 
     /*
-
-    NOT YET IMPLEMENTED
-
-    Recursively traverses the tree from the current node and returns
-    an array of attributes matching the node ID/attr ID pair
-
-    Useful for pulling out things like links:
-        foreach($body->fetch_attrs(TIDY_TAG_A, TIDY_ATTR_HREF) as $link) {
-            echo "Link : {$link->value}\n";
-        }
-    */
-      
-    function fetch_attrs($node_id, $attr_id);
-    
-    /*
-
-    NOT YET IMPLEMENTED
-
-    Recursively traverses the tree from the current node and returns
-    an array of nodes matching the node ID
-
-    Useful for pulling out tables, etc (echos the HTML for every
-    <TABLE> block)
-
-        foreach($body->fetch_nodes(TIDY_TAG_TABLE) as $table) {
-
-            echo $table->value;
-
-        }
-    */
-    function fetch_nodes($node_id)
 }
 
 class TidyAttr {
@@ -153,11 +114,9 @@ class TidyAttr {
     public $value;          // attribute value
     public $id;             // attribute id i.e. TIDY_ATTR_HREF
 
-    function next();        // returns next attribute in tag
-    function tag();         // returns the tag node associated with attribute
 }
 
 Examples of using these objects to navigate the tree can be found in the examples/
 directory (I suggest looking at urlgrab.php and dumpit.php)
 
-E-mail thoughts, suggestions, patches, etc. to <john@php.net>
+E-mail thoughts, suggestions, patches, etc. to <john@php.net>

ext/tidy/TODO

@@ -1,5 +1,3 @@
 TODO
 
-    - Implement fetch_attr(), fetch_node() methods
-    - Fix any memleaks 
-    - Fix Win32 crashes
+    - Implement get_nodes() method

ext/tidy/examples/cleanhtml.php

@@ -12,26 +12,24 @@
      *
      */
 
-    $tidy = tidy_create();
-    
     if(!isset($_SERVER['argv'][1])) {
       $data = file_get_contents("php://stdin");
-      tidy_parse_string($tidy, $data);
+      tidy_parse_string($data);
     } else {
-       tidy_parse_file($tidy, $_SERVER['argv'][1]);
+       tidy_parse_file($_SERVER['argv'][1]);
     }
 
-    tidy_clean_repair($tidy);
+    tidy_clean_repair();
 
-    if(tidy_warning_count($tidy) ||
-       tidy_error_count($tidy)) {
+    if(tidy_warning_count() ||
+       tidy_error_count()) {
 
         echo "\n\nThe following errors or warnings occured:\n";
-        echo tidy_get_error_buffer($tidy);
+        echo tidy_get_error_buffer();
         echo "\n";
     }
 
-    echo tidy_get_output($tidy);
+    echo tidy_get_output();
 
 ?>
 

ext/tidy/examples/dumpit.php

@@ -10,15 +10,13 @@
      * Usage; php dumpit.php <filename>
      */
 
-    
-    $tidy = tidy_create();
-    tidy_parse_file($tidy, $_SERVER['argv'][1]);
+    tidy_parse_file($_SERVER['argv'][1]);
 
     /* Optionally you can do this here if you want to fix up the document */
 
-    /* tidy_clean_repair($tidy); */
+    /* tidy_clean_repair(); */
 
-    $tree = tidy_get_root($tidy);
+    $tree = tidy_get_root();
     dump_tree($tree);
     echo "\n";
 
@@ -70,20 +68,20 @@ function dump_tree($node, $indent = 0) {
             }
 
             /* Any attributes on this node? */
-            if(count($node->attribs)) {
+            if(count($node->attributes())) {
                 do_leaf(" |\n", $indent);
                 do_leaf(" +---- Attributes\n", $indent);
 
                 /* Cycle through the attributes and display them and their values. */
-                foreach($node->attribs as $attrib) {
+                foreach($node->attributes() as $attrib) {
                     do_leaf("             +--{$attrib->name}\n", $indent);
                     do_leaf("             |    +-- Value: {$attrib->value}\n", $indent);
                 }
             }
 
             /* Recurse along the children to generate the remaining nodes */
             if($node->has_children()) {
-                foreach($node->children as $child) {
+                foreach($node->children() as $child) {
                     dump_tree($child, $indent + 3);
                 }
             }

ext/tidy/examples/urlgrab.php

@@ -11,18 +11,15 @@
      * Usage: php urlgrab.php <file>
      *
      */
-     
-    /* Create a Tidy Resource */
-    $tidy = tidy_create();
-    
+         
     /* Parse the document */
-    tidy_parse_file($tidy, $_SERVER['argv'][1]);
+    tidy_parse_file($_SERVER['argv'][1]);
 
     /* Fix up the document */
-    tidy_clean_repair($tidy);
+    tidy_clean_repair();
 
     /* Get an object representing everything from the <HTML> tag in */
-    $html = tidy_get_html($tidy);
+    $html = tidy_get_html();
 
     /* Traverse the document tree */
     print_r(get_links($html));
@@ -33,7 +30,7 @@ function get_links($node) {
         /* Check to see if we are on an <A> tag or not */
         if($node->id == TIDY_TAG_A) {
             /* If we are, find the HREF attribute */
-            $attrib = $node->get_attr_type(TIDY_ATTR_HREF);
+            $attrib = $node->get_attr(TIDY_ATTR_HREF);
             if($attrib) {
                 /* Add the value of the HREF attrib to $urls */
                 $urls[] = $attrib->value;
@@ -45,7 +42,7 @@ function get_links($node) {
         if($node->has_children()) {
 
             /* Traverse down each child recursively */
-            foreach($node->children as $child) {
+            foreach($node->children() as $child) {
 
                 /* Append the results from recursion to $urls */
                 foreach(get_links($child) as $url) {

ext/tidy/php_tidy.h

@@ -95,6 +95,33 @@ extern zend_module_entry tidy_module_entry;
         obj = (PHPTidyObj *)zend_object_store_get_object(object TSRMLS_CC); \
     }
 
+#define INSTANCIATE_NODE(_zval, _container, _node) \
+	tidy_instanciate(tidy_ce_node, _zval TSRMLS_CC); \
+	_container = (PHPTidyObj *) zend_object_store_get_object(_zval TSRMLS_CC); \
+	_container->node = _node; \
+	_container->attr = NULL; \
+	_container->type = is_node; \
+	tidy_add_default_properities(_container, is_node TSRMLS_CC);
+
+#define INSTANCIATE_ATTR(_zval, _container, _attr) \
+	tidy_instanciate(tidy_ce_attr, _zval TSRMLS_CC); \
+	_container = (PHPTidyObj *) zend_object_store_get_object(_zval TSRMLS_CC); \
+	_container->node = NULL; \
+	_container->attr = _attr; \
+	_container->type = is_attr; \
+	tidy_add_default_properities(_container, is_attr TSRMLS_CC);
+
+#define PHP_NODE_METHOD_IS_TYPE(_type, _const) \
+PHP_NODE_METHOD(is_ ##_type) \
+{ \
+	GET_THIS_CONTAINER(); \
+	if(tidyNodeGetType(obj->node) == _const) {\
+		RETURN_TRUE; \
+	} else { \
+		RETURN_FALSE; \
+	} \
+}
+
 typedef enum {
     is_node,
     is_attr

ext/tidy/tests/002.phpt

@@ -7,12 +7,9 @@ tidy_parse_string()
 --INI--
 --FILE--
 <?php 
-
-    $tidy = tidy_create();
-    
-    tidy_parse_string($tidy, "<HTML></HTML>");
+    tidy_parse_string("<HTML></HTML>");
 
-    echo tidy_get_output($tidy);
+    echo tidy_get_output();
 
 ?>
 --EXPECT--

ext/tidy/tests/003.phpt

@@ -8,12 +8,10 @@ tidy_clean_repair()
 --FILE--
 <?php 
 
-    $tidy = tidy_create();
-    
-    tidy_parse_string($tidy, "<HTML></HTML>");
-    tidy_clean_repair($tidy);
+    tidy_parse_string("<HTML></HTML>");
+    tidy_clean_repair();
 
-    echo tidy_get_output($tidy);
+    echo tidy_get_output();
 
 ?>
 --EXPECT--

ext/tidy/tests/004.phpt

@@ -7,12 +7,9 @@ tidy_diagnose()
 --INI--
 --FILE--
 <?php 
-
-    $tidy = tidy_create();
-    
-    tidy_parse_string($tidy, "<HTML></HTML>");
-    tidy_diagnose($tidy);
-    echo tidy_get_error_buffer($tidy);
+    tidy_parse_string("<HTML></HTML>");
+    tidy_diagnose();
+    echo tidy_get_error_buffer();
 
 ?>
 --EXPECT--

ext/tidy/tests/005.phpt

@@ -8,11 +8,9 @@ tidy_parse_file()
 --FILE--
 <?php 
 
-    $tidy = tidy_create();
+    tidy_parse_file("ext/tidy/tests/005.html");
 
-    tidy_parse_file($tidy, "ext/tidy/tests/005.html");
-    
-    echo tidy_get_output($tidy);
+    echo tidy_get_output();
 
 ?>
 --EXPECT--