PHP Class PHPePub\Helpers\StringHelper

Public Methods

Method	Description
createDomFragment ( DOMDocument $dom, string $markup ) : DOMNode	Helper function to create a DOM fragment with given markup.
createUUID ( integer $bookVersion = 4, string $url = null ) : string	Generates an UUID.
decodeHtmlEntities ( string $string ) : string	Remove all non essential html tags and entities.
encodeHtml ( string $string ) : string	Encode html code to use html entities, safeguarding it from potential character encoding problems This function is a bit different from the vanilla htmlentities function in that it does not encode html tags.
fixEncoding ( string $in_str ) : string	Ensure the encoded string is a valid UTF-8 string.
html2text ( string $string ) : string	Simply remove all HTML tags, brute force and no finesse.
removeComments ( $doc ) : string

Helper function to create a DOM fragment with given markup.

Author: Adam Schmalhofer

public static createDomFragment ( DOMDocument $dom, string $markup ) : DOMNode
$dom	DOMDocument
$markup	string
return	DOMNode	fragment in a node.

Default version (4) will generate a random UUID, version 3 will URL based UUID. Added for convenience

public static createUUID ( integer $bookVersion = 4, string $url = null ) : string
$bookVersion	integer	UUID version to retrieve, See lib.uuid.manual.html for details.
$url	string
return	string	The formatted uuid

Remove all non essential html tags and entities.

public static decodeHtmlEntities ( string $string ) : string
$string	string
return	string	with the stripped entities.

The regexp is taken from the PHP Manual discussion, it was written by user "busbyjon". http://www.php.net/manual/en/function.htmlentities.php#90111

public static encodeHtml ( string $string ) : string
$string	string	string to encode.
return	string

Note, that a mb_detect_encoding on the returned string will still return ASCII if the entire string is comprised of characters in the 1-127 range.

public static fixEncoding ( string $in_str ) : string
$in_str	string
return	string	converted string.

Simply remove all HTML tags, brute force and no finesse.

public static html2text ( string $string ) : string
$string	string	html
return	string

public static removeComments ( $doc ) : string
$doc
return	string