Debian Codegraph @

codelitephp/resources/cc/tidy.php

raw
1 <?php
2
3 // Start of tidy v.2.0
4
5 class tidy {
6
7 /**
8 * Returns the value of the specified configuration option for the tidy document
9 * @link http://www.php.net/manual/en/tidy.getopt.php
10 * @param option string <p>
11 * You will find a list with each configuration option and their types
12 * at: &url.tidy.conf;.
13 * </p>
14 * @return mixed the value of the specified option.
15 * The return type depends on the type of the specified one.
16 */
17 public function getOpt ($option) {}
18
19 /**
20 * Execute configured cleanup and repair operations on parsed markup
21 * @link http://www.php.net/manual/en/tidy.cleanrepair.php
22 * @return bool Returns true on success, false on failure.
23 */
24 public function cleanRepair () {}
25
26 /**
27 * Parse markup in file or URI
28 * @link http://www.php.net/manual/en/tidy.parsefile.php
29 * @param filename string <p>
30 * If the filename parameter is given, this function
31 * will also read that file and initialize the object with the file,
32 * acting like tidy_parse_file.
33 * </p>
34 * @param config mixed[optional] <p>
35 * The config config can be passed either as an
36 * array or as a string. If a string is passed, it is interpreted as the
37 * name of the configuration file, otherwise, it is interpreted as the
38 * options themselves.
39 * </p>
40 * <p>
41 * For an explanation about each option, see
42 * &url.tidy.conf;.
43 * </p>
44 * @param encoding string[optional] <p>
45 * The encoding parameter sets the encoding for
46 * input/output documents. The possible values for encoding are:
47 * ascii, latin0, latin1,
48 * raw, utf8, iso2022,
49 * mac, win1252, ibm858,
50 * utf16, utf16le, utf16be,
51 * big5, and shiftjis.
52 * </p>
53 * @param use_include_path bool[optional] <p>
54 * Search for the file in the include_path.
55 * </p>
56 * @return bool Returns true on success, false on failure.
57 */
58 public function parseFile ($filename, $config = null, $encoding = null, $use_include_path = null) {}
59
60 /**
61 * Parse a document stored in a string
62 * @link http://www.php.net/manual/en/tidy.parsestring.php
63 * @param input string <p>
64 * The data to be parsed.
65 * </p>
66 * @param config mixed[optional] <p>
67 * The config config can be passed either as an
68 * array or as a string. If a string is passed, it is interpreted as the
69 * name of the configuration file, otherwise, it is interpreted as the
70 * options themselves.
71 * </p>
72 * <p>
73 * For an explanation about each option, visit &url.tidy.conf;.
74 * </p>
75 * @param encoding string[optional] <p>
76 * The encoding parameter sets the encoding for
77 * input/output documents. The possible values for encoding are:
78 * ascii, latin0, latin1,
79 * raw, utf8, iso2022,
80 * mac, win1252, ibm858,
81 * utf16, utf16le, utf16be,
82 * big5, and shiftjis.
83 * </p>
84 * @return bool a new tidy instance.
85 */
86 public function parseString ($input, $config = null, $encoding = null) {}
87
88 /**
89 * Repair a string using an optionally provided configuration file
90 * @link http://www.php.net/manual/en/tidy.repairstring.php
91 * @param data string <p>
92 * The data to be repaired.
93 * </p>
94 * @param config mixed[optional] <p>
95 * The config config can be passed either as an
96 * array or as a string. If a string is passed, it is interpreted as the
97 * name of the configuration file, otherwise, it is interpreted as the
98 * options themselves.
99 * </p>
100 * <p>
101 * Check &url.tidy.conf; for
102 * an explanation about each option.
103 * </p>
104 * @param encoding string[optional] <p>
105 * The encoding parameter sets the encoding for
106 * input/output documents. The possible values for encoding are:
107 * ascii, latin0, latin1,
108 * raw, utf8, iso2022,
109 * mac, win1252, ibm858,
110 * utf16, utf16le, utf16be,
111 * big5, and shiftjis.
112 * </p>
113 * @return string the repaired string.
114 */
115 public function repairString ($data, $config = null, $encoding = null) {}
116
117 /**
118 * Repair a file and return it as a string
119 * @link http://www.php.net/manual/en/tidy.repairfile.php
120 * @param filename string <p>
121 * The file to be repaired.
122 * </p>
123 * @param config mixed[optional] <p>
124 * The config config can be passed either as an
125 * array or as a string. If a string is passed, it is interpreted as the
126 * name of the configuration file, otherwise, it is interpreted as the
127 * options themselves.
128 * </p>
129 * <p>
130 * Check http://tidy.sourceforge.net/docs/quickref.html for an
131 * explanation about each option.
132 * </p>
133 * @param encoding string[optional] <p>
134 * The encoding parameter sets the encoding for
135 * input/output documents. The possible values for encoding are:
136 * ascii, latin0, latin1,
137 * raw, utf8, iso2022,
138 * mac, win1252, ibm858,
139 * utf16, utf16le, utf16be,
140 * big5, and shiftjis.
141 * </p>
142 * @param use_include_path bool[optional] <p>
143 * Search for the file in the include_path.
144 * </p>
145 * @return string the repaired contents as a string.
146 */
147 public function repairFile ($filename, $config = null, $encoding = null, $use_include_path = null) {}
148
149 /**
150 * Run configured diagnostics on parsed and repaired markup
151 * @link http://www.php.net/manual/en/tidy.diagnose.php
152 * @return bool Returns true on success, false on failure.
153 */
154 public function diagnose () {}
155
156 /**
157 * Get release date (version) for Tidy library
158 * @link http://www.php.net/manual/en/tidy.getrelease.php
159 * @return string a string with the release date of the Tidy library.
160 */
161 public function getRelease () {}
162
163 /**
164 * Get current Tidy configuration
165 * @link http://www.php.net/manual/en/tidy.getconfig.php
166 * @return array an array of configuration options.
167 * </p>
168 * <p>
169 * For an explanation about each option, visit &url.tidy.conf;.
170 */
171 public function getConfig () {}
172
173 /**
174 * Get status of specified document
175 * @link http://www.php.net/manual/en/tidy.getstatus.php
176 * @return int 0 if no error/warning was raised, 1 for warnings or accessibility
177 * errors, or 2 for errors.
178 */
179 public function getStatus () {}
180
181 /**
182 * Get the Detected HTML version for the specified document
183 * @link http://www.php.net/manual/en/tidy.gethtmlver.php
184 * @return int the detected HTML version.
185 * </p>
186 *
187 * <p>
188 * This function is not yet implemented in the Tidylib itself, so it always
189 * return 0.
190 */
191 public function getHtmlVer () {}
192
193 /**
194 * Returns the documentation for the given option name
195 * @link http://www.php.net/manual/en/tidy.getoptdoc.php
196 * @param optname string <p>
197 * The option name
198 * </p>
199 * @return string a string if the option exists and has documentation available, or
200 * false otherwise.
201 */
202 public function getOptDoc ($optname) {}
203
204 /**
205 * Indicates if the document is a XHTML document
206 * @link http://www.php.net/manual/en/tidy.isxhtml.php
207 * @return bool This function returns true if the specified tidy
208 * object is a XHTML document, or false otherwise.
209 * </p>
210 *
211 * <p>
212 * This function is not yet implemented in the Tidylib itself, so it always
213 * return false.
214 */
215 public function isXhtml () {}
216
217 /**
218 * Indicates if the document is a generic (non HTML/XHTML) XML document
219 * @link http://www.php.net/manual/en/tidy.isxml.php
220 * @return bool This function returns true if the specified tidy
221 * object is a generic XML document (non HTML/XHTML),
222 * or false otherwise.
223 * </p>
224 *
225 * <p>
226 * This function is not yet implemented in the Tidylib itself, so it always
227 * return false.
228 */
229 public function isXml () {}
230
231 /**
232 * Returns a <classname>tidyNode</classname> object representing the root of the tidy parse tree
233 * @link http://www.php.net/manual/en/tidy.root.php
234 * @return tidyNode the tidyNode object.
235 */
236 public function root () {}
237
238 /**
239 * Returns a <classname>tidyNode</classname> object starting from the &lt;head&gt; tag of the tidy parse tree
240 * @link http://www.php.net/manual/en/tidy.head.php
241 * @return tidyNode the tidyNode object.
242 */
243 public function head () {}
244
245 /**
246 * Returns a <classname>tidyNode</classname> object starting from the &lt;html&gt; tag of the tidy parse tree
247 * @link http://www.php.net/manual/en/tidy.html.php
248 * @return tidyNode the tidyNode object.
249 */
250 public function html () {}
251
252 /**
253 * Returns a <classname>tidyNode</classname> object starting from the &lt;body&gt; tag of the tidy parse tree
254 * @link http://www.php.net/manual/en/tidy.body.php
255 * @return tidyNode a tidyNode object starting from the
256 * tag of the tidy parse tree.
257 */
258 public function body () {}
259
260 /**
261 * Constructs a new <classname>tidy</classname> object
262 * @link http://www.php.net/manual/en/tidy.construct.php
263 */
264 public function __construct () {}
265
266 }
267
268 final class tidyNode {
269
270 /**
271 * Checks if a node has children
272 * @link http://www.php.net/manual/en/tidynode.haschildren.php
273 * @return bool true if the node has children, false otherwise.
274 */
275 public function hasChildren () {}
276
277 /**
278 * Checks if a node has siblings
279 * @link http://www.php.net/manual/en/tidynode.hassiblings.php
280 * @return bool true if the node has siblings, false otherwise.
281 */
282 public function hasSiblings () {}
283
284 /**
285 * Checks if a node represents a comment
286 * @link http://www.php.net/manual/en/tidynode.iscomment.php
287 * @return bool true if the node is a comment, false otherwise.
288 */
289 public function isComment () {}
290
291 /**
292 * Checks if a node is part of a HTML document
293 * @link http://www.php.net/manual/en/tidynode.ishtml.php
294 * @return bool true if the node is part of a HTML document, false otherwise.
295 */
296 public function isHtml () {}
297
298 /**
299 * Checks if a node represents text (no markup)
300 * @link http://www.php.net/manual/en/tidynode.istext.php
301 * @return bool true if the node represent a text, false otherwise.
302 */
303 public function isText () {}
304
305 /**
306 * Checks if this node is JSTE
307 * @link http://www.php.net/manual/en/tidynode.isjste.php
308 * @return bool true if the node is JSTE, false otherwise.
309 */
310 public function isJste () {}
311
312 /**
313 * Checks if this node is ASP
314 * @link http://www.php.net/manual/en/tidynode.isasp.php
315 * @return bool true if the node is ASP, false otherwise.
316 */
317 public function isAsp () {}
318
319 /**
320 * Checks if a node is PHP
321 * @link http://www.php.net/manual/en/tidynode.isphp.php
322 * @return bool true if the current node is PHP code, false otherwise.
323 */
324 public function isPhp () {}
325
326 /**
327 * Returns the parent node of the current node
328 * @link http://www.php.net/manual/en/tidynode.getparent.php
329 * @return tidyNode a tidyNode if the node has a parent, or &null;
330 * otherwise.
331 */
332 public function getParent () {}
333
334 private function __construct () {}
335
336 }
337
338 /**
339 * @param option
340 */
341 function tidy_getopt ($option) {}
342
343 /**
344 * @param input
345 * @param config_options[optional]
346 * @param encoding[optional]
347 */
348 function tidy_parse_string ($input, $config_options, $encoding) {}
349
350 /**
351 * @param file
352 * @param config_options[optional]
353 * @param encoding[optional]
354 * @param use_include_path[optional]
355 */
356 function tidy_parse_file ($file, $config_options, $encoding, $use_include_path) {}
357
358 /**
359 * Return a string representing the parsed tidy markup
360 * @link http://www.php.net/manual/en/function.tidy-get-output.php
361 * @param object tidy <p>
362 * &tidy.object;
363 * </p>
364 * @return string the parsed tidy markup.
365 */
366 function tidy_get_output (tidy $object) {}
367
368 function tidy_get_error_buffer () {}
369
370 function tidy_clean_repair () {}
371
372 /**
373 * @param data
374 * @param config_file[optional]
375 * @param encoding[optional]
376 */
377 function tidy_repair_string ($data, $config_file, $encoding) {}
378
379 /**
380 * @param filename
381 * @param config_file[optional]
382 * @param encoding[optional]
383 * @param use_include_path[optional]
384 */
385 function tidy_repair_file ($filename, $config_file, $encoding, $use_include_path) {}
386
387 function tidy_diagnose () {}
388
389 function tidy_get_release () {}
390
391 function tidy_get_config () {}
392
393 function tidy_get_status () {}
394
395 function tidy_get_html_ver () {}
396
397 function tidy_is_xhtml () {}
398
399 function tidy_is_xml () {}
400
401 /**
402 * Returns the Number of Tidy errors encountered for specified document
403 * @link http://www.php.net/manual/en/function.tidy-error-count.php
404 * @param object tidy <p>
405 * &tidy.object;
406 * </p>
407 * @return int the number of errors.
408 */
409 function tidy_error_count (tidy $object) {}
410
411 /**
412 * Returns the Number of Tidy warnings encountered for specified document
413 * @link http://www.php.net/manual/en/function.tidy-warning-count.php
414 * @param object tidy <p>
415 * &tidy.object;
416 * </p>
417 * @return int the number of warnings.
418 */
419 function tidy_warning_count (tidy $object) {}
420
421 /**
422 * Returns the Number of Tidy accessibility warnings encountered for specified document
423 * @link http://www.php.net/manual/en/function.tidy-access-count.php
424 * @param object tidy <p>
425 * &tidy.object;
426 * </p>
427 * @return int the number of warnings.
428 */
429 function tidy_access_count (tidy $object) {}
430
431 /**
432 * Returns the Number of Tidy configuration errors encountered for specified document
433 * @link http://www.php.net/manual/en/function.tidy-config-count.php
434 * @param object tidy <p>
435 * &tidy.object;
436 * </p>
437 * @return int the number of errors.
438 */
439 function tidy_config_count (tidy $object) {}
440
441 /**
442 * @param resource
443 * @param optname
444 */
445 function tidy_get_opt_doc ($resource, $optname) {}
446
447 function tidy_get_root () {}
448
449 function tidy_get_head () {}
450
451 function tidy_get_html () {}
452
453 /**
454 * @param tidy
455 */
456 function tidy_get_body ($tidy) {}
457
458
459 /**
460 * description
461 * @link http://www.php.net/manual/en/tidy.constants.php
462 */
463 define ('TIDY_TAG_UNKNOWN', 0);
464 define ('TIDY_TAG_A', 1);
465 define ('TIDY_TAG_ABBR', 2);
466 define ('TIDY_TAG_ACRONYM', 3);
467 define ('TIDY_TAG_ADDRESS', 4);
468 define ('TIDY_TAG_ALIGN', 5);
469 define ('TIDY_TAG_APPLET', 6);
470 define ('TIDY_TAG_AREA', 7);
471 define ('TIDY_TAG_B', 8);
472 define ('TIDY_TAG_BASE', 9);
473 define ('TIDY_TAG_BASEFONT', 10);
474 define ('TIDY_TAG_BDO', 11);
475 define ('TIDY_TAG_BGSOUND', 12);
476 define ('TIDY_TAG_BIG', 13);
477 define ('TIDY_TAG_BLINK', 14);
478 define ('TIDY_TAG_BLOCKQUOTE', 15);
479 define ('TIDY_TAG_BODY', 16);
480 define ('TIDY_TAG_BR', 17);
481 define ('TIDY_TAG_BUTTON', 18);
482 define ('TIDY_TAG_CAPTION', 19);
483 define ('TIDY_TAG_CENTER', 20);
484 define ('TIDY_TAG_CITE', 21);
485 define ('TIDY_TAG_CODE', 22);
486 define ('TIDY_TAG_COL', 23);
487 define ('TIDY_TAG_COLGROUP', 24);
488 define ('TIDY_TAG_COMMENT', 25);
489 define ('TIDY_TAG_DD', 26);
490 define ('TIDY_TAG_DEL', 27);
491 define ('TIDY_TAG_DFN', 28);
492 define ('TIDY_TAG_DIR', 29);
493 define ('TIDY_TAG_DIV', 30);
494 define ('TIDY_TAG_DL', 31);
495 define ('TIDY_TAG_DT', 32);
496 define ('TIDY_TAG_EM', 33);
497 define ('TIDY_TAG_EMBED', 34);
498 define ('TIDY_TAG_FIELDSET', 35);
499 define ('TIDY_TAG_FONT', 36);
500 define ('TIDY_TAG_FORM', 37);
501 define ('TIDY_TAG_FRAME', 38);
502 define ('TIDY_TAG_FRAMESET', 39);
503 define ('TIDY_TAG_H1', 40);
504 define ('TIDY_TAG_H2', 41);
505 define ('TIDY_TAG_H3', 42);
506 define ('TIDY_TAG_H4', 43);
507 define ('TIDY_TAG_H5', 44);
508 define ('TIDY_TAG_H6', 45);
509 define ('TIDY_TAG_HEAD', 46);
510 define ('TIDY_TAG_HR', 47);
511 define ('TIDY_TAG_HTML', 48);
512 define ('TIDY_TAG_I', 49);
513 define ('TIDY_TAG_IFRAME', 50);
514 define ('TIDY_TAG_ILAYER', 51);
515 define ('TIDY_TAG_IMG', 52);
516 define ('TIDY_TAG_INPUT', 53);
517 define ('TIDY_TAG_INS', 54);
518 define ('TIDY_TAG_ISINDEX', 55);
519 define ('TIDY_TAG_KBD', 56);
520 define ('TIDY_TAG_KEYGEN', 57);
521 define ('TIDY_TAG_LABEL', 58);
522 define ('TIDY_TAG_LAYER', 59);
523 define ('TIDY_TAG_LEGEND', 60);
524 define ('TIDY_TAG_LI', 61);
525 define ('TIDY_TAG_LINK', 62);
526 define ('TIDY_TAG_LISTING', 63);
527 define ('TIDY_TAG_MAP', 64);
528 define ('TIDY_TAG_MARQUEE', 65);
529 define ('TIDY_TAG_MENU', 66);
530 define ('TIDY_TAG_META', 67);
531 define ('TIDY_TAG_MULTICOL', 68);
532 define ('TIDY_TAG_NOBR', 69);
533 define ('TIDY_TAG_NOEMBED', 70);
534 define ('TIDY_TAG_NOFRAMES', 71);
535 define ('TIDY_TAG_NOLAYER', 72);
536 define ('TIDY_TAG_NOSAVE', 73);
537 define ('TIDY_TAG_NOSCRIPT', 74);
538 define ('TIDY_TAG_OBJECT', 75);
539 define ('TIDY_TAG_OL', 76);
540 define ('TIDY_TAG_OPTGROUP', 77);
541 define ('TIDY_TAG_OPTION', 78);
542 define ('TIDY_TAG_P', 79);
543 define ('TIDY_TAG_PARAM', 80);
544 define ('TIDY_TAG_PLAINTEXT', 81);
545 define ('TIDY_TAG_PRE', 82);
546 define ('TIDY_TAG_Q', 83);
547 define ('TIDY_TAG_RB', 84);
548 define ('TIDY_TAG_RBC', 85);
549 define ('TIDY_TAG_RP', 86);
550 define ('TIDY_TAG_RT', 87);
551 define ('TIDY_TAG_RTC', 88);
552 define ('TIDY_TAG_RUBY', 89);
553 define ('TIDY_TAG_S', 90);
554 define ('TIDY_TAG_SAMP', 91);
555 define ('TIDY_TAG_SCRIPT', 92);
556 define ('TIDY_TAG_SELECT', 93);
557 define ('TIDY_TAG_SERVER', 94);
558 define ('TIDY_TAG_SERVLET', 95);
559 define ('TIDY_TAG_SMALL', 96);
560 define ('TIDY_TAG_SPACER', 97);
561 define ('TIDY_TAG_SPAN', 98);
562 define ('TIDY_TAG_STRIKE', 99);
563 define ('TIDY_TAG_STRONG', 100);
564 define ('TIDY_TAG_STYLE', 101);
565 define ('TIDY_TAG_SUB', 102);
566 define ('TIDY_TAG_SUP', 103);
567 define ('TIDY_TAG_TABLE', 104);
568 define ('TIDY_TAG_TBODY', 105);
569 define ('TIDY_TAG_TD', 106);
570 define ('TIDY_TAG_TEXTAREA', 107);
571 define ('TIDY_TAG_TFOOT', 108);
572 define ('TIDY_TAG_TH', 109);
573 define ('TIDY_TAG_THEAD', 110);
574 define ('TIDY_TAG_TITLE', 111);
575 define ('TIDY_TAG_TR', 112);
576 define ('TIDY_TAG_TT', 113);
577 define ('TIDY_TAG_U', 114);
578 define ('TIDY_TAG_UL', 115);
579 define ('TIDY_TAG_VAR', 116);
580 define ('TIDY_TAG_WBR', 117);
581 define ('TIDY_TAG_XMP', 118);
582
583 /**
584 * root node
585 * @link http://www.php.net/manual/en/tidy.constants.php
586 */
587 define ('TIDY_NODETYPE_ROOT', 0);
588
589 /**
590 * doctype
591 * @link http://www.php.net/manual/en/tidy.constants.php
592 */
593 define ('TIDY_NODETYPE_DOCTYPE', 1);
594
595 /**
596 * HTML comment
597 * @link http://www.php.net/manual/en/tidy.constants.php
598 */
599 define ('TIDY_NODETYPE_COMMENT', 2);
600
601 /**
602 * Processing Instruction
603 * @link http://www.php.net/manual/en/tidy.constants.php
604 */
605 define ('TIDY_NODETYPE_PROCINS', 3);
606
607 /**
608 * Text
609 * @link http://www.php.net/manual/en/tidy.constants.php
610 */
611 define ('TIDY_NODETYPE_TEXT', 4);
612
613 /**
614 * start tag
615 * @link http://www.php.net/manual/en/tidy.constants.php
616 */
617 define ('TIDY_NODETYPE_START', 5);
618
619 /**
620 * end tag
621 * @link http://www.php.net/manual/en/tidy.constants.php
622 */
623 define ('TIDY_NODETYPE_END', 6);
624
625 /**
626 * empty tag
627 * @link http://www.php.net/manual/en/tidy.constants.php
628 */
629 define ('TIDY_NODETYPE_STARTEND', 7);
630
631 /**
632 * CDATA
633 * @link http://www.php.net/manual/en/tidy.constants.php
634 */
635 define ('TIDY_NODETYPE_CDATA', 8);
636
637 /**
638 * XML section
639 * @link http://www.php.net/manual/en/tidy.constants.php
640 */
641 define ('TIDY_NODETYPE_SECTION', 9);
642
643 /**
644 * ASP code
645 * @link http://www.php.net/manual/en/tidy.constants.php
646 */
647 define ('TIDY_NODETYPE_ASP', 10);
648
649 /**
650 * JSTE code
651 * @link http://www.php.net/manual/en/tidy.constants.php
652 */
653 define ('TIDY_NODETYPE_JSTE', 11);
654
655 /**
656 * PHP code
657 * @link http://www.php.net/manual/en/tidy.constants.php
658 */
659 define ('TIDY_NODETYPE_PHP', 12);
660
661 /**
662 * XML declaration
663 * @link http://www.php.net/manual/en/tidy.constants.php
664 */
665 define ('TIDY_NODETYPE_XMLDECL', 13);
666
667 // End of tidy v.2.0
668 ?>