Код: Выделить всё
<?php
/**
* The tidy Class
*
* An HTML node in an HTML file, as detected by tidy.
*
* @see http://www.php.net/manual/en/class.tidy.php
*/
class tidy
{
/**
* @var string The last warnings and errors from TidyLib
*/
public $errorBuffer;
/**
* Returns the value of the specified configuration option for the tidy document
*
* Returns the value of the specified option for the
* specified tidy object.
*
* @param string $option You will find a list with each configuration option and their types at: » http://tidy.sourceforge.net/docs/quickref.html.
*
* @return mixed Returns the value of the specified option. The return type depends on the type of the specified one.
*
* @see http://www.php.net/manual/en/tidy.getopt.php
*/
public function getOpt($option) {}
/**
* Execute configured cleanup and repair operations on parsed markup
*
* This function cleans and repairs the given tidy
* object.
*
* @return boolean Returns TRUE on success or FALSE on failure.
*
* @see http://www.php.net/manual/en/tidy.cleanrepair.php
*/
public function cleanRepair() {}
/**
* Parse markup in file or URI
*
* Parses the given file.
*
* @param string $filename If the filename parameter is given, this function will also read that file and initialize the object with the file, acting like tidy_parse_file().
* @param mixed $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, see » http://tidy.sourceforge.net/docs/quickref.html.
* @param string $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.
* @param boolean $use_include_path Search for the file in the include_path.
*
* @return boolean Returns TRUE on success or FALSE on failure.
*
* @see http://www.php.net/manual/en/tidy.parsefile.php
*/
public function parseFile($filename, $config = null, $encoding = null, $use_include_path = false) {}
/**
* Parse a document stored in a string
*
* Parses a document stored in a string.
*
* @param string $input The data to be parsed.
* @param mixed $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://tidy.sourceforge.net/docs/quickref.html.
* @param string $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.
*
* @return boolean Returns a new tidy instance.
*
* @see http://www.php.net/manual/en/tidy.parsestring.php
*/
public function parseString($input, $config = null, $encoding = null) {}
/**
* Repair a string using an optionally provided configuration file
*
* Repairs the given string.
*
* @param string $data The data to be repaired.
* @param mixed $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://tidy.sourceforge.net/docs/quickref.html for an explanation about each option.
* @param string $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.
*
* @return string Returns the repaired string.
*
* @see http://www.php.net/manual/en/tidy.repairstring.php
*/
public function repairString($data, $config = null, $encoding = null) {}
/**
* Repair a file and return it as a string
*
* Repairs the given file and returns it as a string.
*
* @param string $filename The file to be repaired.
* @param mixed $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://tidy.sourceforge.net/docs/quickref.html for an explanation about each option.
* @param string $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.
* @param boolean $use_include_path Search for the file in the include_path.
*
* @return string Returns the repaired contents as a string.
*
* @see http://www.php.net/manual/en/tidy.repairfile.php
*/
public function repairFile($filename, $config = null, $encoding = null, $use_include_path = false) {}
/**
* Run configured diagnostics on parsed and repaired markup
*
* Runs diagnostic tests on the given tidy object,
* adding some more information about the document in the error buffer.
*
* @return boolean Returns TRUE on success or FALSE on failure.
*
* @see http://www.php.net/manual/en/function.tidy-diagnose.php
*/
public function diagnose() {}
/**
* Get release date (version) for Tidy library
*
* Gets the release date of the Tidy library.
*
* @return string Returns a string with the release date of the Tidy library.
*
* @see http://www.php.net/manual/en/tidy.getrelease.php
*/
public function getRelease() {}
/**
* Get current Tidy configuration
*
* Gets the list of the configuration options in use by the given tidy
* object.
*
* @return array Returns an array of configuration options.
*
* @see http://www.php.net/manual/en/tidy.getconfig.php
*/
public function getConfig() {}
/**
* Get status of specified document
*
* Returns the status for the specified tidy object.
*
* @return integer Returns 0 if no error/warning was raised, 1 for warnings or accessibility errors, or 2 for errors.
*
* @see http://www.php.net/manual/en/tidy.getstatus.php
*/
public function getStatus() {}
/**
* Get the Detected HTML version for the specified document
*
* Returns the detected HTML version for the specified tidy
* object.
*
* @return integer Returns the detected HTML version.
*
* @see http://www.php.net/manual/en/tidy.gethtmlver.php
*/
public function getHtmlVer() {}
/**
* Indicates if the document is a XHTML document
*
* Tells if the document is a XHTML document.
*
* @return boolean This function returns TRUE if the specified tidy object is a XHTML document, or FALSE otherwise.
*
* @see http://www.php.net/manual/en/tidy.isxhtml.php
*/
public function isXhtml() {}
/**
* Indicates if the document is a generic (non HTML/XHTML) XML document
*
* Tells if the document is a generic (non HTML/XHTML) XML document.
*
* @return boolean This function returns TRUE if the specified tidy object is a generic XML document (non HTML/XHTML), or FALSE otherwise.
*
* @see http://www.php.net/manual/en/tidy.isxml.php
*/
public function isXml() {}
/**
* Returns a tidyNode object representing the root of the tidy parse tree
*
* Returns a {@link tidyNode} object representing the
* root of the tidy parse tree.
*
* @return tidyNode Returns the tidyNode object.
*
* @see http://www.php.net/manual/en/tidy.root.php
*/
public function root() {}
/**
* Returns a tidyNode object starting from the <head> tag of the tidy parse tree
*
* Returns a {@link tidyNode} object starting from
* the <head> tag of the tidy parse tree.
*
* @return tidyNode Returns the tidyNode object.
*
* @see http://www.php.net/manual/en/tidy.head.php
*/
public function head() {}
/**
* Returns a tidyNode object starting from the <html> tag of the tidy parse tree
*
* Returns a {@link tidyNode} object starting
* from the <html> tag of the tidy parse tree.
*
* @return tidyNode Returns the tidyNode object.
*
* @see http://www.php.net/manual/en/tidy.html.php
*/
public function html() {}
/**
* Returns a tidyNode object starting from the <body> tag of the tidy parse tree
*
* Returns a {@link tidyNode} object starting from the
* <body> tag of the tidy parse tree.
*
* @return tidyNode Returns the detected HTML version.
*
* @see http://www.php.net/manual/en/tidy.body.php
*/
public function body() {}
/**
* Constructs a new tidy object
*
* Constructs a new {@link tidy} object.
*
* @param string $filename If the filename parameter is given, this function will also read that file and initialize the object with the file, acting like tidy_parse_file().
* @param mixed $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://tidy.sourceforge.net/docs/quickref.html.
* @param string $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.
* @param boolean $use_include_path Search for the file in the include_path.
*
* @return tidy Returns the new tidy instance.
*
* @see http://www.php.net/manual/en/tidy.construct.php
*/
public function __construct($filename = null, $config = null, $encoding = null, $use_include_path = false) {}
}