tidy::parseString
tidy_parse_string
(PHP 5, PHP 7, PHP 8, PECL tidy >= 0.5.2)
tidy::parseString -- tidy_parse_string — Parse a document stored in a string
Description
Object-oriented style
$string
, array|string|null $config
= null
, ?string $encoding
= null
): boolProcedural style
$string
, array|string|null $config
= null
, ?string $encoding
= null
): tidy|falseParses a document stored in a string.
Parameters
-
string
-
The data to be parsed.
-
config
-
The config
config
can be passed either as an array or as a string. If a string is passed, it is interpreted as the name of the configuration file, otherwise, it is interpreted as the options themselves.For an explanation about each option, visit » http://api.html-tidy.org/#quick-reference.
-
encoding
-
The
encoding
parameter sets the encoding for input/output documents. The possible values for encoding are:ascii
,latin0
,latin1
,raw
,utf8
,iso2022
,mac
,win1252
,ibm858
,utf16
,utf16le
,utf16be
,big5
, andshiftjis
.
Return Values
tidy::parseString() returns true
on success.
tidy_parse_string() returns a new tidy
instance on success.
Both, the method and the function return false
on failure.
Changelog
Version | Description |
---|---|
8.0.0 |
config and encoding are nullable now.
|
Examples
Example #1 tidy::parseString() example
<?php
ob_start();
?>
<html>
<head>
<title>test</title>
</head>
<body>
<p>error<br>another line</i>
</body>
</html>
<?php
$buffer = ob_get_clean();
$config = array('indent' => TRUE,
'output-xhtml' => TRUE,
'wrap' => 200);
$tidy = tidy_parse_string($buffer, $config, 'UTF8');
$tidy->cleanRepair();
echo $tidy;
?>
The above example will output:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title> test </title> </head> <body> <p> error<br /> another line </p> </body> </html>
See Also
- tidy::parseFile() - Parse markup in file or URI
- tidy::repairFile() - Repair a file and return it as a string
- tidy::repairString() - Repair a string using an optionally provided configuration file