php man page for enchant_broker_describe

ENCHANT_BROKER_DESCRIBE(3)						 1						ENCHANT_BROKER_DESCRIBE(3)

enchant_broker_describe - Enumerates the Enchant providers

SYNOPSIS
       array enchant_broker_describe (resource	$broker)

DESCRIPTION
	Enumerates the Enchant providers and tells you some rudimentary information about them. The same info is provided through phpinfo().

PARAMETERS
	      o $broker
		- Broker resource

RETURN VALUES
	Returns TRUE on success or FALSE on failure.

EXAMPLES
       Example #1

	      List the backends provided by the given broker

	      <?php
	      $r = enchant_broker_init();
	      $bprovides = enchant_broker_describe($r);
	      echo "Current broker provides the following backend(s):
";
	      print_r($bprovides);

	      ?>

	      The above example will output something similar to:

	      Current broker provides the following backend(s):
	      Array
	      (
		  [0] => Array
		      (
			  [name] => aspell
			  [desc] => Aspell Provider
			  [file] => /usr/lib/enchant/libenchant_aspell.so
		      )

		  [1] => Array
		      (
			  [name] => hspell
			  [desc] => Hspell Provider
			  [file] => /usr/lib/enchant/libenchant_hspell.so
		      )

		  [2] => Array
		      (
			  [name] => ispell
			  [desc] => Ispell Provider
			  [file] => /usr/lib/enchant/libenchant_ispell.so
		      )

		  [3] => Array
		      (
			  [name] => myspell
			  [desc] => Myspell Provider
			  [file] => /usr/lib/enchant/libenchant_myspell.so
		      )

	      )

PHP Documentation Group 												ENCHANT_BROKER_DESCRIBE(3)