Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

yaz_ccl_parse(3) [php man page]

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)

Check Out this Related Man Page

YAZ_SCAN(3)								 1							       YAZ_SCAN(3)

yaz_scan - Prepares for a scan

SYNOPSIS
void yaz_scan (resource $id, string $type, string $startterm, [array $flags]) DESCRIPTION
This function prepares for a Z39.50 Scan Request on the specified connection. To actually transfer the Scan Request to the server and receive the Scan Response, yaz_wait(3) must be called. Upon completion of yaz_wait(3) call yaz_error(3) and yaz_scan_result(3) to handle the response. PARAMETERS
o $id - The connection resource returned by yaz_connect(3). o $type - Currently only type rpn is supported. o $startterm - Starting term point for the scan. The form in which the starting term is specified is given by parameter $type. The syntax this parameter is similar to the RPN query as described in yaz_search(3). It consists of zero or more @attr-operator specifica- tions, then followed by exactly one token. o $flags - This optional parameter specifies additional information to control the behaviour of the scan request. Three indexes are cur- rently read from the flags array: number (number of terms requested), position (preferred position of term) and stepSize (pre- ferred step size). RETURN VALUES
No value is returned. EXAMPLES
Example #1 PHP function that scans titles <?php function scan_titles($id, $startterm) { yaz_scan($id, "rpn", "@attr 1=4 " . $startterm); yaz_wait(); $errno = yaz_errno($id); if ($errno == 0) { $ar = yaz_scan_result($id, $options); echo 'Scan ok; '; foreach ($options as $key => $val) { echo "$key = $val &nbsp;"; } echo '<br /><table>'; while (list($key, list($k, $term, $tcount)) = each($ar)) { if (empty($k)) continue; echo "<tr><td>$term</td><td>$tcount</td></tr>"; } echo '</table>'; } else { echo "Scan failed. Error: " . yaz_error($id) . "<br />"; } } ?> PHP Documentation Group YAZ_SCAN(3)
Man Page