php tidy_getopt man page on unix.com

Php Man Pages All Man Pages Latest Topics Forum Categories

Query: tidy_getopt

OS: php

Section: 3

Format: Original Unix Latex Style Formatted with HTML and a Horizontal Scroll Bar

TIDY_GETOPT(3)								 1							    TIDY_GETOPT(3)

tidy::getOpt - Returns the value of the specified configuration option for the tidy document

       Object oriented style

SYNOPSIS
       mixed tidy::getOpt (string  $option)

DESCRIPTION
       Procedural style
       mixed tidy_getopt (tidy	$object, string  $option)

	Returns the value of the specified $option for the specified tidy $object.

PARAMETERS
	      o $object
		- The Tidy object.

	      o $option
		- You will find a list with each configuration option and their types at: http://tidy.sourceforge.net/docs/quickref.html.

RETURN VALUES
	Returns the value of the specified $option. The return type depends on the type of the specified one.

EXAMPLES
       Example #1

	      tidy_getopt(3) example

	      <?php

	      $html ='<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
	      <html><head><title>Title</title></head>
	      <body>

	      <p><img src="img.png"></p>

	      </body></html>';

	      $config = array('accessibility-check' => 3,
			      'alt-text' => 'some text');

	      $tidy = new tidy();
	      $tidy->parseString($html, $config);

	      var_dump($tidy->getOpt('accessibility-check')); //integer
	      var_dump($tidy->getOpt('lower-literals')); //boolean
	      var_dump($tidy->getOpt('alt-text')); //string

	      ?>

	      The above example will output:

	      int(3)
	      bool(true)
	      string(9) "some text"

PHP Documentation Group 													    TIDY_GETOPT(3)

php man page for tidy_getopt