mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-21 03:18:55 +00:00
0e37a18b5f
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@189155 c90b9560-bf6c-de11-be94-00142212c4b1
117 lines
3.1 KiB
XML
117 lines
3.1 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.10 $ -->
|
|
<refentry id="function.yaz-ccl-conf">
|
|
<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 <ulink
|
|
url="&url.yaz-ccl;">CCL</ulink> 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:"../../../../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
|
|
-->
|