Delicious Bookmark this on Delicious Share on Facebook SlashdotSlashdot It! Digg! Digg

PHP : Function Reference : YAZ Functions

YAZ Functions


This extension offers a PHP interface to the YAZ toolkit that implements the » Z39.50 Protocol for Information Retrieval. With this extension you can easily implement a Z39.50 origin (client) that searches or scans Z39.50 targets (servers) in parallel.

The module hides most of the complexity of Z39.50 so it should be fairly easy to use. It supports persistent stateless connections very similar to those offered by the various RDB APIs that are available for PHP. This means that sessions are stateless but shared among users, thus saving the connect and initialize phase steps in most cases.

YAZ is available at » You can find news information, example scripts, etc. for this extension at »


This extension has been moved to the » PECL repository and is no longer bundled with PHP as of PHP 5.0.0.


Obtain YAZ (ANSI/NISO Z39.50 support) and install it. YAZ can be fetched in source or in various prebuilt packages from the » YAZ archive. Systems such as Debian GNU/Linux, Suse Linux, FreeBSD also has YAZ as part of their distribution.

For the PHP 4 series, the YAZ extension is bundled (but not YAZ itself) Build PHP with your favorite modules and add option --with-yaz[=DIR].

Example 2671. YAZ compilation for PHP 4 on Unix

gunzip -c php-4.4.X.tar.gz|tar xf -
gunzip -c yaz-2.1.8.tar.gz|tar xf -
cd yaz-2.1.8
./configure --prefix=/usr
sudo make install
cd ../php-4.4.X.
./configure --with-yaz=/usr/bin
sudo make install

For PHP 5, the YAZ extension is in » PECL and is installed as a shared object/dll. If you have pear installed the easiest way to download, configure and install the YAZ extension is by using the pecl command.

Installation of YAZ on Linux

Information for installing this PECL extension may be found in the manual chapter titled Installation of PECL extensions. Additional information such as new releases, downloads, source files, maintainer information, and a CHANGELOG, can be located here: »

Installation on Windows systems

The DLL for this PECL extension may be downloaded from either the » PHP Downloads page or from » php_yaz.dll depends on yaz.dll. The yaz.dll is part of the Win32 ZIP from the PHP site. It is also part of the Windows YAZ install available from the » YAZ WIN32 area.


The PHP 5.0.5 Win32 zip includes a too old version of yaz.dll (version 1.9.1 < required version 2.0.13). If that's the case use the yaz.dll from a newer » YAZ WIN32 install.

On windows, don't forget to add the PHP directory to the PATH, so that the yaz.dll file can be found by the system.

If you are using YAZ as a shared extension, add (or uncomment) the following line in php.ini on Unix:

And for Windows:


The IMAP, recode, YAZ and Cyrus extensions cannot be used in conjuction, because they all share the same internal symbol.


The above problem is solved in version 2.0 of YAZ.

Runtime Configuration

The behaviour of these functions is affected by settings in php.ini.

Table 342. YAZ configuration options

Name Default Changeable Changelog
yaz.max_links "100" PHP_INI_ALL Available since PHP 4.3.0. Removed in PHP 5.0.0.
yaz.log_file NULL PHP_INI_ALL Available since PHP 4.3.0. Removed in PHP 5.0.0.

For further details and definitions of the PHP_INI_* constants, see the Appendix I, php.ini directives.

Resource Types

This extension has no resource types defined.

Predefined Constants

This extension has no constants defined.


PHP/YAZ keeps track of connections with targets (Z-Associations). A resource represents a connection to a target.

The script below demonstrates the parallel searching feature of the API. When invoked with no arguments it prints a query form; else (arguments are supplied) it searches the targets as given in array host.

Example 2672. Parallel searching using Yaz

$num_hosts = count($host);
if (empty(
$query) || count($host) == 0) {
'<form method="get">
   <input type="checkbox"
   name="host[]" value="" />
       GILS test
   <input type="checkbox"
   name="host[]" value="localhost:9999/Default" />
       local test
   <input type="checkbox" checked="checked"
   name="host[]" value="" />
       Library of Congress
   <br />
   RPN Query:
   <input type="text" size="30" name="query" />
   <input type="submit" name="action" value="Search" />
} else {
'You searched for ' . htmlspecialchars($query) . '<br />';
   for (
$i = 0; $i < $num_hosts; $i++) {
$id[] = yaz_connect($host[$i]);
yaz_syntax($id[$i], "usmarc");
yaz_range($id[$i], 1, 10);
yaz_search($id[$i], "rpn", $query);
   for (
$i = 0; $i < $num_hosts; $i++) {
'<hr />' . $host[$i] . ':';
$error = yaz_error($id[$i]);
       if (!empty(
$error)) {
"Error: $error";
       } else {
$hits = yaz_hits($id[$i]);
"Result Count $hits";
       for (
$p = 1; $p <= 10; $p++) {
$rec = yaz_record($id[$i], $p, "string");
           if (empty(
$rec)) continue;

Table of Contents

yaz_addinfo — Returns additional error information
yaz_ccl_conf — Configure CCL parser
yaz_ccl_parse — Invoke CCL Parser
yaz_close — Close YAZ connection
yaz_connect — Prepares for a connection to a Z39.50 server
yaz_database — Specifies the databases within a session
yaz_element — Specifies Element-Set Name for retrieval
yaz_errno — Returns error number
yaz_error — Returns error description
yaz_es_result — Inspects Extended Services Result
yaz_es — Prepares for an Extended Service Request
yaz_get_option — Returns value of option for connection
yaz_hits — Returns number of hits for last search
yaz_itemorder — Prepares for Z39.50 Item Order with an ILL-Request package
yaz_present — Prepares for retrieval (Z39.50 present)
yaz_range — Specifies a range of records to retrieve
yaz_record — Returns a record
yaz_scan_result — Returns Scan Response result
yaz_scan — Prepares for a scan
yaz_schema — Specifies schema for retrieval
yaz_search — Prepares for a search
yaz_set_option — Sets one or more options for connection
yaz_sort — Sets sorting criteria
yaz_syntax — Specifies the preferred record syntax for retrieval
yaz_wait — Wait for Z39.50 requests to complete

Code Examples / Notes » ref.yaz

23-oct-2005 11:00

Straightforward Steps to get PHP Yaz to work on win32:
Download latest verion of php_yaz.dll and copy to your PHP extensions directory
Download latest version of YAZ toolkit and install it
Go to the YAZ toolkit directory
(Most likely C:\Program Files\YAZ\bin)
Copy the 4 DLL files in that folder into your win32 directory
Uncomment the "extention=php_yaz.dll;" line in php.ini
Restart your web server.
Uninstall the YAZ toolkit if you wish.


For those wondering what it is:
"This standard defines a client/server based service and protocol for
Information Retrieval. It specifies procedures and formats for a client to search a
database provided by a server, retrieve database records, and perform related
information retrieval functions. The protocol addresses communication between
information retrieval applications at the client and server; it does not address interaction
between the client and the end-user."

Change Language

Follow Navioo On Twitter
.NET Functions
Apache-specific Functions
Alternative PHP Cache
Advanced PHP debugger
Array Functions
Aspell functions [deprecated]
BBCode Functions
BCMath Arbitrary Precision Mathematics Functions
PHP bytecode Compiler
Bzip2 Compression Functions
Calendar Functions
CCVS API Functions [deprecated]
Class/Object Functions
Classkit Functions
ClibPDF Functions [deprecated]
COM and .Net (Windows)
Crack Functions
Character Type Functions
Cybercash Payment Functions
Credit Mutuel CyberMUT functions
Cyrus IMAP administration Functions
Date and Time Functions
DB++ Functions
Database (dbm-style) Abstraction Layer Functions
dBase Functions
DBM Functions [deprecated]
dbx Functions
Direct IO Functions
Directory Functions
DOM Functions
DOM XML Functions
enchant Functions
Error Handling and Logging Functions
Exif Functions
Expect Functions
File Alteration Monitor Functions
Forms Data Format Functions
Fileinfo Functions
filePro Functions
Filesystem Functions
Filter Functions
Firebird/InterBase Functions
Firebird/Interbase Functions (PDO_FIREBIRD)
FriBiDi Functions
FrontBase Functions
FTP Functions
Function Handling Functions
GeoIP Functions
Gettext Functions
GMP Functions
gnupg Functions
Haru PDF Functions
hash Functions
Hyperwave Functions
Hyperwave API Functions
i18n Functions
IBM Functions (PDO_IBM)
iconv Functions
ID3 Functions
IIS Administration Functions
Image Functions
Imagick Image Library
Informix Functions
Informix Functions (PDO_INFORMIX)
Ingres II Functions
IRC Gateway Functions
PHP / Java Integration
JSON Functions
LDAP Functions
libxml Functions
Lotus Notes Functions
LZF Functions
Mail Functions
Mailparse Functions
Mathematical Functions
MaxDB PHP Extension
MCAL Functions
Mcrypt Encryption Functions
MCVE (Monetra) Payment Functions
Memcache Functions
Mhash Functions
Mimetype Functions
Ming functions for Flash
Miscellaneous Functions
mnoGoSearch Functions
Microsoft SQL Server Functions
Microsoft SQL Server and Sybase Functions (PDO_DBLIB)
Mohawk Software Session Handler Functions
mSQL Functions
Multibyte String Functions
muscat Functions
MySQL Functions
MySQL Functions (PDO_MYSQL)
MySQL Improved Extension
Ncurses Terminal Screen Control Functions
Network Functions
Newt Functions
NSAPI-specific Functions
Object Aggregation/Composition Functions
Object property and method call overloading
Oracle Functions
ODBC Functions (Unified)
ODBC and DB2 Functions (PDO_ODBC)
OpenAL Audio Bindings
OpenSSL Functions
Oracle Functions [deprecated]
Oracle Functions (PDO_OCI)
Output Control Functions
Ovrimos SQL Functions
Paradox File Access
Parsekit Functions
Process Control Functions
Regular Expression Functions (Perl-Compatible)
PDF Functions
PDO Functions
Phar archive stream and classes
PHP Options&Information
POSIX Functions
Regular Expression Functions (POSIX Extended)
PostgreSQL Functions
PostgreSQL Functions (PDO_PGSQL)
Printer Functions
Program Execution Functions
PostScript document creation
Pspell Functions
qtdom Functions
Rar Functions
GNU Readline
GNU Recode Functions
RPM Header Reading Functions
runkit Functions
SAM - Simple Asynchronous Messaging
Satellite CORBA client extension [deprecated]
SCA Functions
SDO Functions
SDO XML Data Access Service Functions
SDO Relational Data Access Service Functions
SESAM Database Functions
PostgreSQL Session Save Handler
Session Handling Functions
Shared Memory Functions
SimpleXML functions
SNMP Functions
SOAP Functions
Socket Functions
Standard PHP Library (SPL) Functions
SQLite Functions
SQLite Functions (PDO_SQLITE)
Secure Shell2 Functions
Statistics Functions
Stream Functions
String Functions
Subversion Functions
Shockwave Flash Functions
Swish Functions
Sybase Functions
TCP Wrappers Functions
Tidy Functions
Tokenizer Functions
Unicode Functions
URL Functions
Variable Handling Functions
Verisign Payflow Pro Functions
vpopmail Functions
W32api Functions
WDDX Functions
win32ps Functions
win32service Functions
xattr Functions
xdiff Functions
XML Parser Functions
XML-RPC Functions
XMLReader functions
XMLWriter Functions
XSL functions
XSLT Functions
YAZ Functions
YP/NIS Functions
Zip File Functions
Zlib Compression Functions
eXTReMe Tracker