1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.yaz-ccl-conf" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>yaz_ccl_conf</refname>
<refpurpose>Configure CCL parser</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>yaz_ccl_conf</methodname>
<methodparam><type>resource</type><parameter>id</parameter></methodparam>
<methodparam><type>array</type><parameter>config</parameter></methodparam>
</methodsynopsis>
<para>
This function configures the CCL query parser for a server with
definitions of access points (CCL qualifiers) and their mapping to RPN.
</para>
<para>
To map a specific CCL query to RPN afterwards call the
<function>yaz_ccl_parse</function> function.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>id</parameter></term>
<listitem>
<para>
The connection resource returned by <function>yaz_connect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>config</parameter></term>
<listitem>
<para>
An array of configuration. Each key of the array is the name of a CCL
field and the corresponding value holds a string that specifies a
mapping to RPN.
</para>
<para>
The mapping is a sequence of attribute-type, attribute-value pairs.
Attribute-type and attribute-value is separated by an equal sign
(<literal>=</literal>). Each pair is separated by white space.
</para>
<para>
Additional information can be found on the <link
xlink:href="&url.yaz-ccl;">CCL</link> page.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
In the example below, the CCL parser is configured to support three CCL
fields: <literal>ti</literal>, <literal>au</literal> and
<literal>isbn</literal>. Each field is mapped to their BIB-1 equivalent.
It is assumed that variable <literal>$id</literal> is the connection ID.
</para>
<example>
<title>CCL configuration</title>
<programlisting role="php">
<![CDATA[
<?php
$fields = array(
"ti" => "1=4",
"au" => "1=1",
"isbn" => "1=7"
);
yaz_ccl_conf($id, $fields);
?>
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>yaz_ccl_parse</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
