ConverterHtmlEx Class Reference
[Lib]

Converts plain text to HTML (encode) or HTML to plain text (decode). More...

Inheritance diagram for ConverterHtmlEx:

List of all members.

Public Member Functions
	decode ($value, $params=false)
	Smarter decoding og html into plain text than done by HTML Converter.
Protected Member Functions
	decode_anchors ($value, $link_format)
	Decode a HTML tag into plain text.
	process_paragraph ($text, $params)
	Process a single paragraph.
	relative_to_absolute ($text, $base)
	Helper.

---

Detailed Description

Converts plain text to HTML (encode) or HTML to plain text (decode).

Treats short paragraphs as headings

Author:

Gerd Riesselmann

Definition at line 12 of file htmlex.converter.php.

---

Member Function Documentation

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

Smarter decoding og html into plain text than done by HTML Converter.

Keeps Links

The following parameters are supported:

Parameters:

array

$params Associative array supporting the following featurs: p: Text after paragraph. Default is "\n" br: Text after a tag. Default is "\n" a: Format to decode tags. Supports $title$ and $url$ placeholders. Default is "$title$: $url$"

Reimplemented from ConverterHtml.

Definition at line 42 of file htmlex.converter.php.

                                                        {
                // If there is no HTML, decoding would do more harm than good
                if (!preg_match('@<\w+.*?>@', $value)) {
                        return $value;
                }
                
                // Turn <a href="xxx">Text</a> into e.g. Text: xxx
                $value = $this->decode_anchors($value, Arr::get_item($params, 'a', '$title$: $url$'));
                
                // Remove paragraphs
                $value = str_replace("\r", "\n", $value);
                $value = String::preg_replace('|\n+|', " ", $value);
                
                // Replace <p> and <br>
                $value = preg_replace('@\s*<p>\s*@', "<p>", $value);
                $after_p = Arr::get_item($params, 'p', "\n");
                $value = preg_replace('@\s*</p>\s*@', "</p>$after_p", $value);
                $after_br = Arr::get_item($params, 'br', "\n");
                $value = preg_replace('@<br.*?>\s*@', $after_br, $value);
                
                // Strip HTML
                $value = strip_tags($value);
                $value = String::unescape($value);
                $value = String::preg_replace('| +|', ' ', $value);
                
                return $value;          
        }

ConverterHtmlEx::decode_anchors	(	$	value,
		$	link_format
	)			[protected]

Decode a HTML tag into plain text.

Parameters:

	string	$value
	string	$link_format Supports placeholders $title$ and $url$

Definition at line 76 of file htmlex.converter.php.

                                                                {
                $value = $this->relative_to_absolute($value, Config::get_url(Config::URL_BASEURL));
                $link_format = str_replace('$title$', '$2', $link_format);
                $link_format = str_replace('$url$', '$1', $link_format);
                return String::preg_replace('|<a.*?href="(.*?)".*?>(.*?)</a>|', $link_format, $value);
        }

ConverterHtmlEx::process_paragraph	(	$	text,
		$	params
	)			[protected]

Process a single paragraph.

Parameters:

string

$text

Returns:

string

Reimplemented from ConverterHtml.

Definition at line 19 of file htmlex.converter.php.

                                                             {
                if (String::length($text) <= 70 && String::right($text, 1) != '.') {
                        $level = intval(Arr::get_item($params, 'h', 2));
                        return html::tag('h' . $level, $text);  
                }
                else {
                        return parent::process_paragraph($text, $params);
                }
        }

ConverterHtmlEx::relative_to_absolute	(	$	text,
		$	base
	)			[protected]

Helper.

Turn relative URLs in text to an absolute one

Parameters:

	string	$text Text containing URLs
	string	$base baseurl

Definition at line 89 of file htmlex.converter.php.

                                                              {
                if (empty($base)) {
                        return $text;
                }
                        
                if (substr($base, -1, 1) != "/") { $base .= "/"; }
                $domain = Url::create($base)->clear_query()->set_path('')->build(Url::ABSOLUTE);
                
                // Replace href="/abc" with domain
                $pattern =      '|<a(.*?) href="/(.*?)"|';
                $replace = '<a$1 href="' . $domain . '$2"';
                $text = preg_replace($pattern, $replace, $text);
                
                // Replace href="abc" with base
                $pattern =      '|<a(.*?) href="(?!\w+://)(.*?)"|';
                $replace = '<a$1 href="' . $base . '$2"';
                $text = preg_replace($pattern, $replace, $text);
                
                return $text;
        }       

---

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

• gyro/core/lib/helpers/converters/htmlex.converter.php