tidy::repairString
tidy_repair_string
(PHP 5, PHP 7, PHP 8, PECL tidy >= 0.7.0)
tidy::repairString -- tidy_repair_string — Repair a string using an optionally provided configuration file
Description
Object-oriented style
$string
, array|string|null $config
= null
, ?string $encoding
= null
): string|falseProcedural style
$string
, array|string|null $config
= null
, ?string $encoding
= null
): string|falseRepairs the given string.
Parameters
-
string
-
The data to be repaired.
-
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.Check » http://api.html-tidy.org/#quick-reference for an explanation about each option.
-
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
Returns the repaired string, or false
on failure.
Changelog
Version | Description |
---|---|
8.0.0 | tidy::repairString() is a static method now. |
8.0.0 |
config and encoding are nullable now.
|
8.0.0 |
This function no longer accepts the useIncludePath parameter.
|
Examples
Example #1 tidy::repairString() example
<?php
ob_start();
?>
<html>
<head>
<title>test</title>
</head>
<body>
<p>error</i>
</body>
</html>
<?php
$buffer = ob_get_clean();
$tidy = new tidy();
$clean = $tidy->repairString($buffer);
echo $clean;
?>
The above example will output:
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN"> <html> <head> <title>test</title> </head> <body> <p>error</p> </body> </html>
See Also
- tidy::parseFile() - Parse markup in file or URI
- tidy::parseString() - Parse a document stored in a string
- tidy::repairFile() - Repair a file and return it as a string