ConverterHtmlTidy Class Reference
[Tidy]

Converts plain HTML to tidyed HTML. More...

Inheritance diagram for ConverterHtmlTidy:

List of all members.

Public Member Functions
	decode ($value, $params=false)
	Implemented for compatability, just returns the value passed in.
	encode ($value, $params=false)
	Tidy up $value.

---

Detailed Description

Converts plain HTML to tidyed HTML.

Use either directly or through ConverterFactory like this:

 $tidy = ConverterFactory::encode($html, CONVERTER_TIDY);

Author:

Gerd Riesselmann

Definition at line 14 of file htmltidy.converter.php.

---

Member Function Documentation

ConverterHtmlTidy::decode	(	$	value,
		$	params = false
	)

Implemented for compatability, just returns the value passed in.

Implements IConverter.

Definition at line 63 of file htmltidy.converter.php.

                                                        {
                return $value;          
        }       

ConverterHtmlTidy::encode	(	$	value,
		$	params = false
	)

Tidy up $value.

Attention:

If $value starts with a <script> tag, the value is returned untouched. This is because tidy will strip it, even if in mode 'show-body-only'

Parameters:

	$value	The original html
	$params	Associative array containing tidy config parameters

Returns:

string

Implements IConverter.

Definition at line 26 of file htmltidy.converter.php.

                                                        {
                //TODO this is a hotfix to keep tidy from striping <script>-Only-Content
                if (String::starts_with(trim(String::to_lower($value)), '<script')) {
                        return $value;
                }
                $is_partial_doc = (strpos($value, '<html') === false);
                $predefined_params = array(
                        'bare' => true,
                        'clean' => !$is_partial_doc,            
                        'drop-empty-paras' => true,
                        'drop-font-tags' => true,
                        'drop-proprietary-attributes' => true,
                        'enclose-block-text' => true,
                        'enclose-text' => true,
                        'indent' => true,
                        'join-classes' => false,
                        'join-styles' => false,
                        'logical-emphasis' => true,
                        'output-xhtml' => true,
                        'doctype' => 'loose',
                        'show-body-only' => $is_partial_doc, 
                        'merge-divs' => false,
                        //'merge-spans' => false, // Not widely supported on Debian system
                        'hide-comments' => true,
                        'lower-literals' => true,
                        'char-encoding' => String::plain_ascii(GyroLocale::get_charset(), ''),
                        'wrap' => 0
                );
                $params = array_merge($predefined_params, Arr::force($params, false));
                $tidy = tidy_parse_string($value, $params, String::plain_ascii(GyroLocale::get_charset(), ''));
                $tidy->cleanRepair();
                return tidy_get_output($tidy);
        }

---

The documentation for this class was generated from the following file:

• gyro/modules/tidy/lib/helpers/converters/htmltidy.converter.php