tidy::parseString

tidy_parse_string

Parse a document stored in a string

&reftitle.description;

&style.oop;

public `bool` `tidy::parseString` `string` `string` ``array``string``null```config`&null; ``string``null```encoding`&null;

&style.procedural;

``tidy``false```tidy_parse_string` `string` `string` ``array``string``null```config`&null; ``string``null```encoding`&null;

Parses a document stored in a string.

&reftitle.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 &url.tidy.conf;.

`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`, and `shiftjis`.

&reftitle.returnvalues;

`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.

&reftitle.changelog;

&Version; | &Description;
8.0.0 | `config` and `encoding` are nullable now.

&reftitle.examples;

### `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;
    ?>

&example.outputs;

    <!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>

&reftitle.seealso;

- `tidy::parseFile`
- `tidy::repairFile`
- `tidy::repairString`