php man page for enchant_dict_quick_check

ENCHANT_DICT_QUICK_CHECK(3)						 1					       ENCHANT_DICT_QUICK_CHECK(3)

enchant_dict_quick_check - Check the word is correctly spelled and provide suggestions

SYNOPSIS
       bool enchant_dict_quick_check (resource	$dict, string  $word, [array  &$suggestions])

DESCRIPTION
	If  the word is correctly spelled return TRUE, otherwise return FALSE, if suggestions variable is provided, fill it with spelling alterna-
       tives.

PARAMETERS
	      o $dict
		- Dictionary resource

	      o $word
		- The word to check

	      o $suggestions
		- If the word is not correctly spelled, this variable will contain an array of suggestions.

RETURN VALUES
	Returns TRUE if the word is correctly spelled or FALSE

EXAMPLES
       Example #1

	      A enchant_dict_quick_check(3) example

	      <?php
	      $tag = 'en_US';
	      $r = enchant_broker_init();

	      if (enchant_broker_dict_exists($r,$tag)) {
		  $d = enchant_broker_request_dict($r, $tag);
		  enchant_dict_quick_check($d, 'soong', $suggs);
		  print_r($suggs);
	      }
	      ?>

	      The above example will output something similar to:

	      Array
	      (
		  [0] => song
		  [1] => snog
		  [2] => soon
		  [3] => Sang
		  [4] => Sung
		  [5] => sang
		  [6] => sung
		  [7] => sponge
		  [8] => spongy
		  [9] => snag
		  [10] => snug
		  [11] => sonic
		  [12] => sing
		  [13] => songs
		  [14] => Son
		  [15] => Sonja
		  [16] => Synge
		  [17] => son
		  [18] => Sejong
		  [19] => sarong
		  [20] => sooner
		  [21] => Sony
		  [22] => sown
		  [23] => scone
		  [24] => song's
	      )

SEE ALSO
       enchant_dict_check(3), enchant_dict_suggest(3).

PHP Documentation Group 											       ENCHANT_DICT_QUICK_CHECK(3)