/ide/eclipse/jaggery/org.eclipse.php.core/Resources/language/php5.3/tidy.php
PHP | 707 lines | 193 code | 76 blank | 438 comment | 0 complexity | e6247d2b8e855ee84a805d1f1004c138 MD5 | raw file
Possible License(s): 0BSD
- <?php
- // Start of tidy v.2.0
- class tidy {
- /**
- * Returns the value of the specified configuration option for the tidy document
- * @link http://www.php.net/manual/en/tidy.getopt.php
- * @param option string <p>
- * You will find a list with each configuration option and their types
- * at: &url.tidy.conf;.
- * </p>
- * @return mixed the value of the specified option.
- * The return type depends on the type of the specified one.
- */
- public function getOpt ($option) {}
- /**
- * Execute configured cleanup and repair operations on parsed markup
- * @link http://www.php.net/manual/en/tidy.cleanrepair.php
- * @return bool Returns true on success or false on failure.
- */
- public function cleanRepair () {}
- /**
- * Parse markup in file or URI
- * @link http://www.php.net/manual/en/tidy.parsefile.php
- * @param filename string <p>
- * 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.
- * </p>
- * @param config mixed[optional] <p>
- * 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.
- * </p>
- * <p>
- * For an explanation about each option, see
- * &url.tidy.conf;.
- * </p>
- * @param encoding string[optional] <p>
- * 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.
- * </p>
- * @param use_include_path bool[optional] <p>
- * Search for the file in the include_path.
- * </p>
- * @return bool Returns true on success or false on failure.
- */
- public function parseFile ($filename, $config = null, $encoding = null, $use_include_path = null) {}
- /**
- * Parse a document stored in a string
- * @link http://www.php.net/manual/en/tidy.parsestring.php
- * @param input string <p>
- * The data to be parsed.
- * </p>
- * @param config mixed[optional] <p>
- * 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.
- * </p>
- * <p>
- * For an explanation about each option, visit &url.tidy.conf;.
- * </p>
- * @param encoding string[optional] <p>
- * 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.
- * </p>
- * @return bool a new tidy instance.
- */
- public function parseString ($input, $config = null, $encoding = null) {}
- /**
- * Repair a string using an optionally provided configuration file
- * @link http://www.php.net/manual/en/tidy.repairstring.php
- * @param data string <p>
- * The data to be repaired.
- * </p>
- * @param config mixed[optional] <p>
- * 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.
- * </p>
- * <p>
- * Check &url.tidy.conf; for
- * an explanation about each option.
- * </p>
- * @param encoding string[optional] <p>
- * 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.
- * </p>
- * @return string the repaired string.
- */
- public function repairString ($data, $config = null, $encoding = null) {}
- /**
- * Repair a file and return it as a string
- * @link http://www.php.net/manual/en/tidy.repairfile.php
- * @param filename string <p>
- * The file to be repaired.
- * </p>
- * @param config mixed[optional] <p>
- * 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.
- * </p>
- * <p>
- * Check http://tidy.sourceforge.net/docs/quickref.html for an
- * explanation about each option.
- * </p>
- * @param encoding string[optional] <p>
- * 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.
- * </p>
- * @param use_include_path bool[optional] <p>
- * Search for the file in the include_path.
- * </p>
- * @return string the repaired contents as a string.
- */
- public function repairFile ($filename, $config = null, $encoding = null, $use_include_path = null) {}
- /**
- * Run configured diagnostics on parsed and repaired markup
- * @link http://www.php.net/manual/en/function.tidy-diagnose.php
- * @return bool Returns true on success or false on failure.
- */
- public function diagnose () {}
- /**
- * Get release date (version) for Tidy library
- * @link http://www.php.net/manual/en/tidy.getrelease.php
- * @return string a string with the release date of the Tidy library.
- */
- public function getRelease () {}
- /**
- * Get current Tidy configuration
- * @link http://www.php.net/manual/en/tidy.getconfig.php
- * @return array an array of configuration options.
- * </p>
- * <p>
- * For an explanation about each option, visit &url.tidy.conf;.
- */
- public function getConfig () {}
- /**
- * Get status of specified document
- * @link http://www.php.net/manual/en/tidy.getstatus.php
- * @return int 0 if no error/warning was raised, 1 for warnings or accessibility
- * errors, or 2 for errors.
- */
- public function getStatus () {}
- public function getHtmlVer () {}
- /**
- * Returns the documentation for the given option name
- * @link http://www.php.net/manual/en/tidy.getoptdoc.php
- * @param optname string <p>
- * The option name
- * </p>
- * @return string a string if the option exists and has documentation available, or
- * false otherwise.
- */
- public function getOptDoc ($optname) {}
- /**
- * Indicates if the document is a XHTML document
- * @link http://www.php.net/manual/en/tidy.isxhtml.php
- * @return bool This function returns true if the specified tidy
- * object is a XHTML document, or false otherwise.
- * </p>
- * <p>
- * This function is not yet implemented in the Tidylib itself, so it always
- * return false.
- */
- public function isXhtml () {}
- /**
- * Indicates if the document is a generic (non HTML/XHTML) XML document
- * @link http://www.php.net/manual/en/tidy.isxml.php
- * @return bool This function returns true if the specified tidy
- * object is a generic XML document (non HTML/XHTML),
- * or false otherwise.
- * </p>
- * <p>
- * This function is not yet implemented in the Tidylib itself, so it always
- * return false.
- */
- public function isXml () {}
- /**
- * Returns a <classname>tidyNode</classname> object representing the root of the tidy parse tree
- * @link http://www.php.net/manual/en/tidy.root.php
- * @return tidyNode the tidyNode object.
- */
- public function root () {}
- /**
- * Returns a <classname>tidyNode</classname> object starting from the <head> tag of the tidy parse tree
- * @link http://www.php.net/manual/en/tidy.head.php
- * @return tidyNode the tidyNode object.
- */
- public function head () {}
- /**
- * Returns a <classname>tidyNode</classname> object starting from the <html> tag of the tidy parse tree
- * @link http://www.php.net/manual/en/tidy.html.php
- * @return tidyNode the tidyNode object.
- */
- public function html () {}
- /**
- * Returns a <classname>tidyNode</classname> object starting from the <body> tag of the tidy parse tree
- * @link http://www.php.net/manual/en/tidy.body.php
- * @return tidyNode the detected HTML version.
- * </p>
- * <p>
- * This function is not yet implemented in the Tidylib itself, so it always
- * return 0.
- */
- public function body () {}
- /**
- * Constructs a new <classname>tidy</classname> object
- * @link http://www.php.net/manual/en/tidy.construct.php
- * @param filename string[optional] <p>
- * 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.
- * </p>
- * @param config mixed[optional] <p>
- * 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.
- * </p>
- * <p>
- * For an explanation about each option, visit &url.tidy.conf;.
- * </p>
- * @param encoding string[optional] <p>
- * 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.
- * </p>
- * @param use_include_path bool[optional] <p>
- * Search for the file in the include_path.
- * </p>
- * @return tidy the new tidy instance.
- */
- public function __construct ($filename = null, $config = null, $encoding = null, $use_include_path = null) {}
- }
- final class tidyNode {
- /**
- * Checks if a node has children
- * @link http://www.php.net/manual/en/tidynode.haschildren.php
- * @return bool true if the node has children, false otherwise.
- */
- public function hasChildren () {}
- /**
- * Checks if a node has siblings
- * @link http://www.php.net/manual/en/tidynode.hassiblings.php
- * @return bool true if the node has siblings, false otherwise.
- */
- public function hasSiblings () {}
- /**
- * Checks if a node represents a comment
- * @link http://www.php.net/manual/en/tidynode.iscomment.php
- * @return bool true if the node is a comment, false otherwise.
- */
- public function isComment () {}
- /**
- * Checks if a node is part of a HTML document
- * @link http://www.php.net/manual/en/tidynode.ishtml.php
- * @return bool true if the node is part of a HTML document, false otherwise.
- */
- public function isHtml () {}
- /**
- * Checks if a node represents text (no markup)
- * @link http://www.php.net/manual/en/tidynode.istext.php
- * @return bool true if the node represent a text, false otherwise.
- */
- public function isText () {}
- /**
- * Checks if this node is JSTE
- * @link http://www.php.net/manual/en/tidynode.isjste.php
- * @return bool true if the node is JSTE, false otherwise.
- */
- public function isJste () {}
- /**
- * Checks if this node is ASP
- * @link http://www.php.net/manual/en/tidynode.isasp.php
- * @return bool true if the node is ASP, false otherwise.
- */
- public function isAsp () {}
- /**
- * Checks if a node is PHP
- * @link http://www.php.net/manual/en/tidynode.isphp.php
- * @return bool true if the current node is PHP code, false otherwise.
- */
- public function isPhp () {}
- /**
- * Returns the parent node of the current node
- * @link http://www.php.net/manual/en/tidynode.getparent.php
- * @return tidyNode a tidyNode if the node has a parent, or &null;
- * otherwise.
- */
- public function getParent () {}
- private function __construct () {}
- }
- /**
- * @param option
- */
- function tidy_getopt ($option) {}
- /**
- * @param input
- * @param config_options[optional]
- * @param encoding[optional]
- */
- function tidy_parse_string ($input, $config_options, $encoding) {}
- /**
- * @param file
- * @param config_options[optional]
- * @param encoding[optional]
- * @param use_include_path[optional]
- */
- function tidy_parse_file ($file, $config_options, $encoding, $use_include_path) {}
- /**
- * Return a string representing the parsed tidy markup
- * @link http://www.php.net/manual/en/function.tidy-get-output.php
- * @param object tidy <p>
- * &tidy.object;
- * </p>
- * @return string the parsed tidy markup.
- */
- function tidy_get_output (tidy $object) {}
- /**
- * Return warnings and errors which occurred parsing the specified document
- * @link http://www.php.net/manual/en/function.tidy-get-error-buffer.php
- * @param object tidy <p>
- * &tidy.object;
- * </p>
- * @return string the error buffer as a string.
- */
- function tidy_get_error_buffer (tidy $object) {}
- function tidy_clean_repair () {}
- /**
- * @param data
- * @param config_file[optional]
- * @param encoding[optional]
- */
- function tidy_repair_string ($data, $config_file, $encoding) {}
- /**
- * @param filename
- * @param config_file[optional]
- * @param encoding[optional]
- * @param use_include_path[optional]
- */
- function tidy_repair_file ($filename, $config_file, $encoding, $use_include_path) {}
- function tidy_diagnose () {}
- function tidy_get_release () {}
- function tidy_get_config () {}
- function tidy_get_status () {}
- function tidy_get_html_ver () {}
- function tidy_is_xhtml () {}
- function tidy_is_xml () {}
- /**
- * Returns the Number of Tidy errors encountered for specified document
- * @link http://www.php.net/manual/en/function.tidy-error-count.php
- * @param object tidy <p>
- * &tidy.object;
- * </p>
- * @return int the number of errors.
- */
- function tidy_error_count (tidy $object) {}
- /**
- * Returns the Number of Tidy warnings encountered for specified document
- * @link http://www.php.net/manual/en/function.tidy-warning-count.php
- * @param object tidy <p>
- * &tidy.object;
- * </p>
- * @return int the number of warnings.
- */
- function tidy_warning_count (tidy $object) {}
- /**
- * Returns the Number of Tidy accessibility warnings encountered for specified document
- * @link http://www.php.net/manual/en/function.tidy-access-count.php
- * @param object tidy <p>
- * &tidy.object;
- * </p>
- * @return int the number of warnings.
- */
- function tidy_access_count (tidy $object) {}
- /**
- * Returns the Number of Tidy configuration errors encountered for specified document
- * @link http://www.php.net/manual/en/function.tidy-config-count.php
- * @param object tidy <p>
- * &tidy.object;
- * </p>
- * @return int the number of errors.
- */
- function tidy_config_count (tidy $object) {}
- /**
- * @param resource
- * @param optname
- */
- function tidy_get_opt_doc ($resource, $optname) {}
- function tidy_get_root () {}
- function tidy_get_head () {}
- function tidy_get_html () {}
- /**
- * @param tidy
- */
- function tidy_get_body ($tidy) {}
- /**
- * ob_start callback function to repair the buffer
- * @link http://www.php.net/manual/en/function.ob-tidyhandler.php
- * @param input string <p>
- * The buffer.
- * </p>
- * @param mode int[optional] <p>
- * The buffer mode.
- * </p>
- * @return string the modified buffer.
- */
- function ob_tidyhandler ($input, $mode = null) {}
- /**
- * description
- * @link http://www.php.net/manual/en/tidy.constants.php
- */
- define ('TIDY_TAG_UNKNOWN', 0);
- define ('TIDY_TAG_A', 1);
- define ('TIDY_TAG_ABBR', 2);
- define ('TIDY_TAG_ACRONYM', 3);
- define ('TIDY_TAG_ADDRESS', 4);
- define ('TIDY_TAG_ALIGN', 5);
- define ('TIDY_TAG_APPLET', 6);
- define ('TIDY_TAG_AREA', 7);
- define ('TIDY_TAG_B', 8);
- define ('TIDY_TAG_BASE', 9);
- define ('TIDY_TAG_BASEFONT', 10);
- define ('TIDY_TAG_BDO', 11);
- define ('TIDY_TAG_BGSOUND', 12);
- define ('TIDY_TAG_BIG', 13);
- define ('TIDY_TAG_BLINK', 14);
- define ('TIDY_TAG_BLOCKQUOTE', 15);
- define ('TIDY_TAG_BODY', 16);
- define ('TIDY_TAG_BR', 17);
- define ('TIDY_TAG_BUTTON', 18);
- define ('TIDY_TAG_CAPTION', 19);
- define ('TIDY_TAG_CENTER', 20);
- define ('TIDY_TAG_CITE', 21);
- define ('TIDY_TAG_CODE', 22);
- define ('TIDY_TAG_COL', 23);
- define ('TIDY_TAG_COLGROUP', 24);
- define ('TIDY_TAG_COMMENT', 25);
- define ('TIDY_TAG_DD', 26);
- define ('TIDY_TAG_DEL', 27);
- define ('TIDY_TAG_DFN', 28);
- define ('TIDY_TAG_DIR', 29);
- define ('TIDY_TAG_DIV', 30);
- define ('TIDY_TAG_DL', 31);
- define ('TIDY_TAG_DT', 32);
- define ('TIDY_TAG_EM', 33);
- define ('TIDY_TAG_EMBED', 34);
- define ('TIDY_TAG_FIELDSET', 35);
- define ('TIDY_TAG_FONT', 36);
- define ('TIDY_TAG_FORM', 37);
- define ('TIDY_TAG_FRAME', 38);
- define ('TIDY_TAG_FRAMESET', 39);
- define ('TIDY_TAG_H1', 40);
- define ('TIDY_TAG_H2', 41);
- define ('TIDY_TAG_H3', 42);
- define ('TIDY_TAG_H4', 43);
- define ('TIDY_TAG_H5', 44);
- define ('TIDY_TAG_H6', 45);
- define ('TIDY_TAG_HEAD', 46);
- define ('TIDY_TAG_HR', 47);
- define ('TIDY_TAG_HTML', 48);
- define ('TIDY_TAG_I', 49);
- define ('TIDY_TAG_IFRAME', 50);
- define ('TIDY_TAG_ILAYER', 51);
- define ('TIDY_TAG_IMG', 52);
- define ('TIDY_TAG_INPUT', 53);
- define ('TIDY_TAG_INS', 54);
- define ('TIDY_TAG_ISINDEX', 55);
- define ('TIDY_TAG_KBD', 56);
- define ('TIDY_TAG_KEYGEN', 57);
- define ('TIDY_TAG_LABEL', 58);
- define ('TIDY_TAG_LAYER', 59);
- define ('TIDY_TAG_LEGEND', 60);
- define ('TIDY_TAG_LI', 61);
- define ('TIDY_TAG_LINK', 62);
- define ('TIDY_TAG_LISTING', 63);
- define ('TIDY_TAG_MAP', 64);
- define ('TIDY_TAG_MARQUEE', 65);
- define ('TIDY_TAG_MENU', 66);
- define ('TIDY_TAG_META', 67);
- define ('TIDY_TAG_MULTICOL', 68);
- define ('TIDY_TAG_NOBR', 69);
- define ('TIDY_TAG_NOEMBED', 70);
- define ('TIDY_TAG_NOFRAMES', 71);
- define ('TIDY_TAG_NOLAYER', 72);
- define ('TIDY_TAG_NOSAVE', 73);
- define ('TIDY_TAG_NOSCRIPT', 74);
- define ('TIDY_TAG_OBJECT', 75);
- define ('TIDY_TAG_OL', 76);
- define ('TIDY_TAG_OPTGROUP', 77);
- define ('TIDY_TAG_OPTION', 78);
- define ('TIDY_TAG_P', 79);
- define ('TIDY_TAG_PARAM', 80);
- define ('TIDY_TAG_PLAINTEXT', 81);
- define ('TIDY_TAG_PRE', 82);
- define ('TIDY_TAG_Q', 83);
- define ('TIDY_TAG_RB', 84);
- define ('TIDY_TAG_RBC', 85);
- define ('TIDY_TAG_RP', 86);
- define ('TIDY_TAG_RT', 87);
- define ('TIDY_TAG_RTC', 88);
- define ('TIDY_TAG_RUBY', 89);
- define ('TIDY_TAG_S', 90);
- define ('TIDY_TAG_SAMP', 91);
- define ('TIDY_TAG_SCRIPT', 92);
- define ('TIDY_TAG_SELECT', 93);
- define ('TIDY_TAG_SERVER', 94);
- define ('TIDY_TAG_SERVLET', 95);
- define ('TIDY_TAG_SMALL', 96);
- define ('TIDY_TAG_SPACER', 97);
- define ('TIDY_TAG_SPAN', 98);
- define ('TIDY_TAG_STRIKE', 99);
- define ('TIDY_TAG_STRONG', 100);
- define ('TIDY_TAG_STYLE', 101);
- define ('TIDY_TAG_SUB', 102);
- define ('TIDY_TAG_SUP', 103);
- define ('TIDY_TAG_TABLE', 104);
- define ('TIDY_TAG_TBODY', 105);
- define ('TIDY_TAG_TD', 106);
- define ('TIDY_TAG_TEXTAREA', 107);
- define ('TIDY_TAG_TFOOT', 108);
- define ('TIDY_TAG_TH', 109);
- define ('TIDY_TAG_THEAD', 110);
- define ('TIDY_TAG_TITLE', 111);
- define ('TIDY_TAG_TR', 112);
- define ('TIDY_TAG_TT', 113);
- define ('TIDY_TAG_U', 114);
- define ('TIDY_TAG_UL', 115);
- define ('TIDY_TAG_VAR', 116);
- define ('TIDY_TAG_WBR', 117);
- define ('TIDY_TAG_XMP', 118);
- /**
- * root node
- * @link http://www.php.net/manual/en/tidy.constants.php
- */
- define ('TIDY_NODETYPE_ROOT', 0);
- /**
- * doctype
- * @link http://www.php.net/manual/en/tidy.constants.php
- */
- define ('TIDY_NODETYPE_DOCTYPE', 1);
- /**
- * HTML comment
- * @link http://www.php.net/manual/en/tidy.constants.php
- */
- define ('TIDY_NODETYPE_COMMENT', 2);
- /**
- * Processing Instruction
- * @link http://www.php.net/manual/en/tidy.constants.php
- */
- define ('TIDY_NODETYPE_PROCINS', 3);
- /**
- * Text
- * @link http://www.php.net/manual/en/tidy.constants.php
- */
- define ('TIDY_NODETYPE_TEXT', 4);
- /**
- * start tag
- * @link http://www.php.net/manual/en/tidy.constants.php
- */
- define ('TIDY_NODETYPE_START', 5);
- /**
- * end tag
- * @link http://www.php.net/manual/en/tidy.constants.php
- */
- define ('TIDY_NODETYPE_END', 6);
- /**
- * empty tag
- * @link http://www.php.net/manual/en/tidy.constants.php
- */
- define ('TIDY_NODETYPE_STARTEND', 7);
- /**
- * CDATA
- * @link http://www.php.net/manual/en/tidy.constants.php
- */
- define ('TIDY_NODETYPE_CDATA', 8);
- /**
- * XML section
- * @link http://www.php.net/manual/en/tidy.constants.php
- */
- define ('TIDY_NODETYPE_SECTION', 9);
- /**
- * ASP code
- * @link http://www.php.net/manual/en/tidy.constants.php
- */
- define ('TIDY_NODETYPE_ASP', 10);
- /**
- * JSTE code
- * @link http://www.php.net/manual/en/tidy.constants.php
- */
- define ('TIDY_NODETYPE_JSTE', 11);
- /**
- * PHP code
- * @link http://www.php.net/manual/en/tidy.constants.php
- */
- define ('TIDY_NODETYPE_PHP', 12);
- /**
- * XML declaration
- * @link http://www.php.net/manual/en/tidy.constants.php
- */
- define ('TIDY_NODETYPE_XMLDECL', 13);
- // End of tidy v.2.0
- ?>