php man page for yaz_ccl_parse

YAZ_CCL_PARSE(3)							 1							  YAZ_CCL_PARSE(3)

yaz_ccl_parse - Invoke CCL Parser

SYNOPSIS
       bool yaz_ccl_parse (resource  $id, string  $query, array  &$result)

DESCRIPTION
	This  function	invokes a CCL parser. It converts a given CCL FIND query to an RPN query which may be passed to the yaz_search(3) function
       to perform a search.

	To define a set of valid CCL fields call yaz_ccl_conf(3) prior to this function.

PARAMETERS
	      o $id
		- The connection resource returned by yaz_connect(3).

	      o $query
		- The CCL FIND query.

	      o $result
		- If the function was executed successfully, this will be an array containing the valid RPN query under the key rpn.   Upon  fail-
		ure, three indexes are set in this array to indicate the cause of failure:

		     o errorcode - the CCL error code (integer)

		     o errorstring - the CCL error string

		     o errorpos - approximate position in query of failure (integer is character position)

RETURN VALUES
	Returns TRUE on success or FALSE on failure.

EXAMPLES
       Example #1

	      CCL Parsing

	       We will try to search using CCL. In the example below, $ccl is a CCL query.

	      <?php

	      yaz_ccl_conf($id, $fields);  // see example for yaz_ccl_conf
	      if (!yaz_ccl_parse($id, $ccl, &$cclresult)) {
		  echo 'Error: ' . $cclresult["errorstring"];
	      } else {
		  $rpn = $cclresult["rpn"];
		  yaz_search($id, "rpn", $rpn);
	      }
	      ?>

PHP Documentation Group 													  YAZ_CCL_PARSE(3)