Ref/yaz-Phpdoc专题

yaz_addinfo

Returns additional error information

说明

string yaz_addinfo ( resource $id )

Returns additional error information for the last request on the server.

With some servers, this function may return the same string as yaz_error.

参数

id
The connection resource returned by yaz_connect.

返回值

A string containing additional error information or an empty string if the last operation was successful or if no additional information was provided by the server.

参见

yaz_error
yaz_errno

yaz_ccl_conf

Configure CCL parser

说明

void yaz_ccl_conf ( resource $id , array $config )

This function configures the CCL query parser for a server with definitions of access points (CCL qualifiers) and their mapping to RPN.

To map a specific CCL query to RPN afterwards call the yaz_ccl_parse function.

参数

id
The connection resource returned by yaz_connect.

config
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.

The mapping is a sequence of attribute-type, attribute-value pairs. Attribute-type and attribute-value is separated by an equal sign (=). Each pair is separated by white space.

Additional information can be found on the » CCL page.

返回值

没有返回值。

范例

In the example below, the CCL parser is configured to support three CCL fields: ti, au and isbn. Each field is mapped to their BIB-1 equivalent. It is assumed that variable $id is the connection ID.

示例 #1 CCL configuration

<?php
$fields = array(
  "ti" => "1=4",
  "au"   => "1=1",
  "isbn" => "1=7"
);
yaz_ccl_conf($id, $fields);
?>

参见

yaz_ccl_parse

yaz_ccl_parse

Invoke CCL Parser

说明

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

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 function to perform a search.

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

参数

id
The connection resource returned by yaz_connect.

query
The CCL FIND query.

result
If the function was executed successfully, this will be an array containing the valid RPN query under the key rpn.

Upon failure, three indexes are set in this array to indicate the cause of failure:

errorcode - the CCL error code (integer)
errorstring - the CCL error string
errorpos - approximate position in query of failure (integer is character position)

返回值

成功时返回 true，或者在失败时返回 false。

范例

示例 #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);
}
?>

yaz_close

Close YAZ connection

说明

bool yaz_close ( resource $id )

Closes the connection given by parameter id.

Note:

This function will only close a non-persistent connection opened by setting the persistent option to false with yaz_connect.

参数

id
The connection resource returned by yaz_connect.

返回值

成功时返回 true，或者在失败时返回 false。

参见

yaz_connect

yaz_connect

Prepares for a connection to a Z39.50 server

说明

mixed yaz_connect ( string $zurl [, mixed $options ] )

This function returns a connection resource on success, zero on failure.

yaz_connect prepares for a connection to a Z39.50 server. This function is non-blocking and does not attempt to establish a connection - it merely prepares a connect to be performed later when yaz_wait is called.

Note:

The » YAZ proxy is a freely available Z39.50 proxy.

参数

zurl
A string that takes the form host[:port][/database]. If port is omitted, port 210 is used. If database is omitted Default is used.

options
If given as a string, it is treated as the Z39.50 V2 authentication string (OpenAuth).

If given as an array, the contents of the array serves as options.

user
Username for authentication.

group
Group for authentication.

password
Password for authentication.

cookie
Cookie for session (YAZ proxy).

proxy
Proxy for connection (YAZ proxy).

persistent
A boolean. If true the connection is persistent; If false the connection is not persistent. By default connections are persistent.

Note:

If you open a persistent connection, you won't be able to close it later with yaz_close.

piggyback
A boolean. If true piggyback is enabled for searches; If false piggyback is disabled. By default piggyback is enabled.

Enabling piggyback is more efficient and usually saves a network-round-trip for first time fetches of records. However, a few Z39.50 servers do not support piggyback or they ignore element set names. For those, piggyback should be disabled.

charset
A string that specifies character set to be used in Z39.50 language and character set negotiation. Use strings such as: ISO-8859-1, UTF-8, UTF-16.

Most Z39.50 servers do not support this feature (and thus, this is ignored). Many servers use the ISO-8859-1 encoding for queries and messages. MARC21/USMARC records are not affected by this setting.

preferredMessageSize
An integer that specifies the maximum byte size of all records to be returned by a target during retrieval. See the » Z39.50 standard for more information.

Note:

This option is supported in PECL YAZ 1.0.5 or later.

maximumRecordSize
An integer that specifies the maximum byte size of a single record to be returned by a target during retrieval. This entity is referred to as Exceptional-record-size in the » Z39.50 standard.

Note:

This option is supported in PECL YAZ 1.0.5 or later.

返回值

A connection resource on success, false on error.

更新日志

版本	说明
4.1.0	The parameter `options` was added.

参见

yaz_close

yaz_database

Specifies the databases within a session

说明

bool yaz_database ( resource $id , string $databases )

This function allows you to change databases within a session by specifying one or more databases to be used in search, retrieval, etc. - overriding databases specified in call to yaz_connect.

参数

id
The connection resource returned by yaz_connect.

databases
A string containing one or more databases. Multiple databases are separated by a plus sign +.

返回值

成功时返回 true，或者在失败时返回 false。

yaz_element

Specifies Element-Set Name for retrieval

说明

bool yaz_element ( resource $id , string $elementset )

This function sets the element set name for retrieval.

Call this function before yaz_search or yaz_present to specify the element set name for records to be retrieved.

Note:

If this function appears to have no effect, see the description of the piggybacking option in yaz_connect.

参数

id
The connection resource returned by yaz_connect.

elementset
Most servers support F (for full records) and B (for brief records).

返回值

成功时返回 true，或者在失败时返回 false。

yaz_errno

Returns error number

说明

int yaz_errno ( resource $id )

Returns an error number for the server (last request) identified by id.

yaz_errno should be called after network activity for each server - (after yaz_wait returns) to determine the success or failure of the last operation (e.g. search).

参数

id
The connection resource returned by yaz_connect.

返回值

Returns an error code. The error code is either a Z39.50 diagnostic code (usually a Bib-1 diagnostic) or a client side error code which is generated by PHP/YAZ itself, such as "Connect failed", "Init Rejected", etc.

参见

yaz_error
yaz_addinfo

yaz_error

Returns error description

说明

string yaz_error ( resource $id )

yaz_error returns an English text message corresponding to the last error number as returned by yaz_errno.

参数

id
The connection resource returned by yaz_connect.

返回值

Returns an error text message for server (last request), identified by parameter id. An empty string is returned if the last operation was successful.

参见

yaz_errno
yaz_addinfo

yaz_es_result

Inspects Extended Services Result

说明

array yaz_es_result ( resource $id )

This function inspects the last returned Extended Service result from a server. An Extended Service is initiated by either yaz_item_order or yaz_es.

参数

id
The connection resource returned by yaz_connect.

返回值

Returns array with element targetReference for the reference for the extended service operation (generated and returned from the server).

参见

yaz_es

yaz_es

Prepares for an Extended Service Request

说明

void yaz_es ( resource $id , string $type , array $args )

This function prepares for an Extended Service Request. Extended Services is family of various Z39.50 facilities, such as Record Update, Item Order, Database administration etc.

Note:

Many Z39.50 Servers do not support Extended Services.

The yaz_es creates an Extended Service Request packages and puts it into a queue of operations. Use yaz_wait to send the request(s) to the server. After completion of yaz_wait the result of the Extended Service operation should be expected with a call to yaz_es_result.

参数

id
The connection resource returned by yaz_connect.

type
A string which represents the type of the Extended Service: itemorder (Item Order), create (Create Database), drop (Drop Database), commit (Commit Operation), update (Update Record), xmlupdate (XML Update). Each type is specified in the following section.

args
An array with extended service options plus package specific options. The options are identical to those offered in the C API of ZOOM C. Refer to the ZOOM » Extended Services.

返回值

没有返回值。

范例

示例 #1 Record Update

<?php
$con = yaz_connect("myhost/database");
$args = array (
    "record" => "<gils><title>some title</title></gils>",
    "syntax" => "xml",
    "action" => "specialUpdate"
);
yaz_es($con, "update", $args);
yaz_wait();
$result = yaz_es_result($id);
?>

参见

yaz_es_result

yaz_get_option

Returns value of option for connection

说明

string yaz_get_option ( resource $id , string $name )

Returns the value of the option specified with name.

参数

id
The connection resource returned by yaz_connect.

name
The option name.

返回值

Returns the value of the specified option or an empty string if the option wasn't set.

参见

The description of yaz_set_option for available options

yaz_hits

Returns number of hits for last search

说明

int yaz_hits ( resource $id [, array &$searchresult ] )

yaz_hits returns the number of hits for the last search.

参数

id
The connection resource returned by yaz_connect.

searchresult
Result array for detailed search result information.

返回值

Returns the number of hits for the last search or 0 if no search was performed.

The search result array (if supplied) holds information that is returned by a Z39.50 server in the SearchResult-1 format part of a search response. The SearchResult-1 format can be used to obtain information about hit counts for various parts of the query (subquery). In particular, it is possible to obtain hit counts for the individual search terms in a query. Information for first subquery is in $array[0], second subquery in $array[1], and so forth.

Element	Description
id	Sub query ID2 (string)
count	Result count / hits (integer)
subquery.term	Sub query term (string)
interpretation.term	Interpretated sub query term (string)
recommendation.term	Recommended sub query term (string)

Note:

The SearchResult facility requires PECL YAZ 1.0.5 or later and YAZ 2.1.9 or later.

Note:

Very few Z39.50 implementations support the SearchResult facility.

yaz_itemorder

Prepares for Z39.50 Item Order with an ILL-Request package

说明

void yaz_itemorder ( resource $id , array $args )

This function prepares for an Extended Services request using the Profile for the Use of Z39.50 Item Order Extended Service to Transport ILL (Profile/1). See » this and the » specification.

参数

id
The connection resource returned by yaz_connect.

args
Must be an associative array with information about the Item Order request to be sent. The key of the hash is the name of the corresponding ASN.1 tag path. For example, the ISBN below the Item-ID has the key item-id,ISBN.

The ILL-Request parameters are:

protocol-version-num
transaction-id,initial-requester-id,person-or-institution-symbol,person
transaction-id,initial-requester-id,person-or-institution-symbol,institution
transaction-id,initial-requester-id,name-of-person-or-institution,name-of-person
transaction-id,initial-requester-id,name-of-person-or-institution,name-of-institution
transaction-id,transaction-group-qualifier
transaction-id,transaction-qualifier
transaction-id,sub-transaction-qualifier
service-date-time,this,date
service-date-time,this,time
service-date-time,original,date
service-date-time,original,time
requester-id,person-or-institution-symbol,person
requester-id,person-or-institution-symbol,institution
requester-id,name-of-person-or-institution,name-of-person
requester-id,name-of-person-or-institution,name-of-institution
responder-id,person-or-institution-symbol,person
responder-id,person-or-institution-symbol,institution
responder-id,name-of-person-or-institution,name-of-person
responder-id,name-of-person-or-institution,name-of-institution
transaction-type
delivery-address,postal-address,name-of-person-or-institution,name-of-person
delivery-address,postal-address,name-of-person-or-institution,name-of-institution
delivery-address,postal-address,extended-postal-delivery-address
delivery-address,postal-address,street-and-number
delivery-address,postal-address,post-office-box
delivery-address,postal-address,city
delivery-address,postal-address,region
delivery-address,postal-address,country
delivery-address,postal-address,postal-code
delivery-address,electronic-address,telecom-service-identifier
delivery-address,electronic-address,telecom-service-addreess
billing-address,postal-address,name-of-person-or-institution,name-of-person
billing-address,postal-address,name-of-person-or-institution,name-of-institution
billing-address,postal-address,extended-postal-delivery-address
billing-address,postal-address,street-and-number
billing-address,postal-address,post-office-box
billing-address,postal-address,city
billing-address,postal-address,region
billing-address,postal-address,country
billing-address,postal-address,postal-code
billing-address,electronic-address,telecom-service-identifier
billing-address,electronic-address,telecom-service-addreess
ill-service-type
requester-optional-messages,can-send-RECEIVED
requester-optional-messages,can-send-RETURNED
requester-optional-messages,requester-SHIPPED
requester-optional-messages,requester-CHECKED-IN
search-type,level-of-service
search-type,need-before-date
search-type,expiry-date
search-type,expiry-flag
place-on-hold
client-id,client-name
client-id,client-status
client-id,client-identifier
item-id,item-type
item-id,call-number
item-id,author
item-id,title
item-id,sub-title
item-id,sponsoring-body
item-id,place-of-publication
item-id,publisher
item-id,series-title-number
item-id,volume-issue
item-id,edition
item-id,publication-date
item-id,publication-date-of-component
item-id,author-of-article
item-id,title-of-article
item-id,pagination
item-id,ISBN
item-id,ISSN
item-id,additional-no-letters
item-id,verification-reference-source
copyright-complicance
retry-flag
forward-flag
requester-note
forward-note

There are also a few parameters that are part of the Extended Services Request package and the ItemOrder package:

package-name
user-id
contact-name
contact-phone
contact-email
itemorder-item

返回值

没有返回值。

yaz_present

Prepares for retrieval (Z39.50 present)

说明

bool yaz_present ( resource $id )

This function prepares for retrieval of records after a successful search.

The yaz_range function should be called prior to this function to specify the range of records to be retrieved.

参数

id
The connection resource returned by yaz_connect.

返回值

成功时返回 true，或者在失败时返回 false。

yaz_range

Specifies a range of records to retrieve

说明

void yaz_range ( resource $id , int $start , int $number )

Specifies a range of records to retrieve.

This function should be called before yaz_search or yaz_present.

参数

id
The connection resource returned by yaz_connect.

start
Specifies the position of the first record to be retrieved. The records numbers goes from 1 to yaz_hits.

number
Specifies the number of records to be retrieved.

返回值

没有返回值。

yaz_record

Returns a record

说明

string yaz_record ( resource $id , int $pos , string $type )

The yaz_record function inspects a record in the current result set at the position specified by parameter pos.

参数

id
The connection resource returned by yaz_connect.

pos
The record position. Records positions in a result set are numbered 1, 2, ... $hits where $hits is the count returned by yaz_hits.

type
The type specifies the form of the returned record.

Note:

It is the application which is responsible for actually ensuring that the records are returned from the Z39.50/SRW server in the proper format. The type given only specifies a conversion to take place on the client side (in PHP/YAZ).

Besides conversion of the transfer record to a string/array, PHP/YAZ it is also possible to perform a character set conversion of the record. Especially for USMARC/MARC21 that is recommended since these are typically returned in the character set MARC-8 that is not supported by browsers, etc. To specify a conversion, add ; charset=from, to where from is the original character set of the record and to is the resulting character set (as seen by PHP).

string
The record is returned as a string for simple display. In this mode, all MARC records are converted to a line-by-line format since ISO2709 is hardly readable. XML records and SUTRS are returned in their original format. GRS-1 are returned in a (ugly) line-by-line format.

This format is suitable if records are to be displayed in a quick way - for debugging - or because it is not feasible to perform proper display.

xml
The record is returned as an XML string if possible. In this mode, all MARC records are converted to » MARCXML. XML records and SUTRS are returned in their original format. GRS-1 is not supported.

This format is similar to string except that MARC records are converted to MARCXML

This format is suitable if records are processed by an XML parser or XSLT processor afterwards.

raw
The record is returned as a string in its original form. This type is suitable for MARC, XML and SUTRS. It does not work for GRS-1.

MARC records are returned as a ISO2709 string. XML and SUTRS are returned as strings.

syntax
The syntax of the record is returned as a string, i.e. USmarc, GRS-1, XML, etc.

database
The name of database associated with record at the position is returned as a string.

array
The record is returned as an array that reflects the GRS-1 structure. This type is suitable for MARC and GRS-1. XML, SUTRS are not supported and if the actual record is XML or SUTRS an empty string will be returned.

The array returned consists of a list corresponding to each leaf/internal node of GRS-1. Each list item consists a sub list with first element path and data (if data is available).

The path which is a string holds a list of each tree component (of the structured GRS-1 record) from root to leaf. Each component is a tag type, tag value pair of the form (type, value

String tags normally has a corresponding tag type 3. MARC can also be returned as an array (they are converted to GRS-1 internally).

返回值

Returns the record at position pos or an empty string if no record exists at the given position.

If no database record exists at the given position an empty string is returned.

范例

示例 #1 Array for GRS-1 record

Consider this GRS-1 record:

(4,52)Robert M. Pirsig
(4,70)
      (4,90)
            (2,7)Transworld Publishers, ltd.

This record has two nodes at root level. First element at root level is (4,52) [tag type 4, tag value 52], and has data Robert M. Pirsig. Second element at root level (4,70) has a subtree with a single element (4,90). (4,90) has yet another sub tree (2,7) with data Transworld Publishers, ltd..

If this record is present at position $p, then

<?php

$ar = yaz_record($id, $p, "array");
print_r($ar);

?>

will output:

Array
(
    [0] => Array
        (
            [0] => (4,52)
            [1] => Robert M. Pirsig
        )
    [1] => Array
        (
            [0] => (4,70)
        )
    [2] => Array
        (
            [0] => (4,70)(4,90)
        )
    [3] => Array
        (
            [0] => (4,70)(4,90)(2,7)
            [1] => Transworld Publishers, ltd.
        )
)

示例 #2 Working with MARCXML

The following PHP snippet returns a MARC21/USMARC record as MARCXML. The original record is returned in marc-8 (unknown to most XML parsers), so we convert it to UTF-8 (which all XML parsers must support).

<?php
$rec = yaz_record($id, $p, "xml; charset=marc-8,utf-8");
?>

The record $rec can be processed with the Sablotron XSLT processor as follows:

<?php

$xslfile = 'display.xsl';
$processor = xslt_create();
$parms = array('/_xml' => $rec);
$res = xslt_process($processor, 'arg:/_xml', $xslfile, NULL, $parms);
xslt_free($processor);
$res = preg_replace("'</?html[^>]*>'", '', $res);
echo $res;

?>

For PHP 5 the XSL extension must be used instead of Sablotron XSLT.

yaz_scan_result

Returns Scan Response result

说明

array yaz_scan_result ( resource $id [, array &$result ] )

yaz_scan_result returns terms and associated information as received from the server in the last performed yaz_scan.

参数

id
The connection resource returned by yaz_connect.

result
If given, this array will be modified to hold additional information taken from the Scan Response:

number - Number of entries returned
stepsize - Step size
position - Position of term
status - Scan status

返回值

Returns an array (0..n-1) where n is the number of terms returned. Each value is a pair where the first item is the term, and the second item is the result-count.

yaz_scan

Prepares for a scan

说明

void yaz_scan ( resource $id , string $type , string $startterm [, array $flags ] )

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 must be called. Upon completion of yaz_wait call yaz_error and yaz_scan_result to handle the response.

参数

id
The connection resource returned by yaz_connect.

type
Currently only type rpn is supported.

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. It consists of zero or more @attr-operator specifications, then followed by exactly one token.

flags
This optional parameter specifies additional information to control the behaviour of the scan request. Three indexes are currently read from the flags array: number (number of terms requested), position (preferred position of term) and stepSize (preferred step size).

返回值

没有返回值。

范例

示例 #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 />";
  }
}
?>

yaz_schema

Specifies schema for retrieval

说明

void yaz_schema ( resource $id , string $schema )

yaz_schema specifies the schema for retrieval.

This function should be called before yaz_search or yaz_present.

参数

id
The connection resource returned by yaz_connect.

schema
Must be specified as an OID (Object Identifier) in a raw dot-notation (like 1.2.840.10003.13.4) or as one of the known registered schemas: GILS-schema, Holdings, Zthes, ...

返回值

没有返回值。

yaz_search

Prepares for a search

说明

bool yaz_search ( resource $id , string $type , string $query )

yaz_search prepares for a search on the given connection.

Like yaz_connect this function is non-blocking and only prepares for a search to be executed later when yaz_wait is called.

参数

id
The connection resource returned by yaz_connect.

type
This parameter represents the query type - only "rpn" is supported now in which case the third argument specifies a Type-1 query in prefix query notation.

query
The RPN query is a textual representation of the Type-1 query as defined by the Z39.50 standard. However, in the text representation as used by YAZ a prefix notation is used, that is the operator precedes the operands. The query string is a sequence of tokens where white space is ignored unless surrounded by double quotes. Tokens beginning with an at-character (@) are considered operators, otherwise they are treated as search terms.

Construct	Description
@and query1 query2	intersection of query1 and query2
@or query1 query2	union of query1 and query2
@not query1 query2	query1 and not query2
@set name	result set reference
@attrset set query	specifies attribute-set for query. This construction is only allowed once - in the beginning of the whole query
@attr [set] type=value query	applies attribute to query. The type and value are integers specifying the attribute-type and attribute-value respectively. The set, if given, specifies the attribute-set.

You can find information about attributes at the » Z39.50 Maintenance Agency site.

Note:

If you would like to use a more friendly notation, use the CCL parser - functions yaz_ccl_conf and yaz_ccl_parse.

返回值

成功时返回 true，或者在失败时返回 false。

范例

示例 #1 Query Examples

You can search for simple terms, like this:

computer

which matches documents where "computer" occur. No attributes are specified.

The query

"knuth donald"

matches documents where "knuth donald" occur (provided that the server supports phrase search).

This query applies two attributes for the same phrase.

@attr 1=1003 @attr 4=1 "knuth donald"

First attribute is type 1 (Bib-1 use), attribute value is 1003 (Author). Second attribute has is type 4 (structure), value 1 (phrase), so this should match documents where Donald Knuth is author.

The query

@and @or a b @not @or c d e

would in infix notation look like (a or b) and ((c or d) not e).

Another, more complex, one:

@attrset gils @and @attr 1=4 art @attr 1=2000 company

The query as a whole uses the GILS attributeset. The query matches documents where art occur in the title (GILS,BIB-1) and in which company occur as Distributor (GILS).

yaz_set_option

Sets one or more options for connection

说明

void yaz_set_option ( resource $id , string $name , string $value )

void yaz_set_option ( resource $id , array $options )

Sets one or more options on the given connection.

参数

id
The connection resource returned by yaz_connect.

name or options
May be either a string or an array.

If given as a string, this will be the name of the option to set. You'll need to give it's value.

If given as an array, this will be an associative array (option name => option value).

Name	Description
implementationName	implementation name of server
implementationVersion	implementation version of server
implementationId	implementation ID of server
schema	schema for retrieval. By default, no schema is used. Setting this option is equivalent to using function yaz_schema
preferredRecordSyntax	record syntax for retrieval. By default, no syntax is used. Setting this option is equivalent to using function yaz_syntax
start	offset for first record to be retrieved via yaz_search or yaz_present. First record is numbered has a start value of 0. Second record has start value 1. Setting this option in combination with option count has the same effect as calling yaz_range except that records are numbered from 1 in yaz_range
count	maximum number of records to be retrieved via yaz_search or yaz_present.
elementSetName	element-set-name for retrieval. Setting this option is equivalent to calling yaz_element.

value
The new value of the option. Use this only if the previous argument is a string.

返回值

没有返回值。

yaz_sort

Sets sorting criteria

说明

void yaz_sort ( resource $id , string $criteria )

This function sets sorting criteria and enables Z39.50 Sort.

Call this function before yaz_search. Using this function alone does not have any effect. When used in conjunction with yaz_search, a Z39.50 Sort will be sent after a search response has been received and before any records are retrieved with Z39.50 Present (yaz_present.

参数

id
The connection resource returned by yaz_connect.

criteria
A string that takes the form field1 flags1 field2 flags2 where field1 specifies the primary attributes for sort, field2 seconds, etc..

The field specifies either a numerical attribute combinations consisting of type=value pairs separated by comma (e.g. 1=4,2=1) ; or the field may specify a plain string criteria (e.g. title. The flags is a sequence of the following characters which may not be separated by any white space.

a
Sort ascending

d
Sort descending

i
Case insensitive sorting

s
Case sensitive sorting

返回值

没有返回值。

范例

示例 #1 Sort Criterias

To sort on Bib1 attribute title, case insensitive, and ascending you would use the following sort criteria:

1=4 ia

If the secondary sorting criteria should be author, case sensitive and ascending you would use:

1=4 ia 1=1003 sa

yaz_syntax

Specifies the preferred record syntax for retrieval

说明

void yaz_syntax ( resource $id , string $syntax )

yaz_syntax specifies the preferred record syntax for retrieval

This function should be called before yaz_search or yaz_present.

参数

id
The connection resource returned by yaz_connect.

syntax
The syntax must be specified as an OID (Object Identifier) in a raw dot-notation (like 1.2.840.10003.5.10) or as one of the known registered record syntaxes (sutrs, usmarc, grs1, xml, etc.).

返回值

没有返回值。

yaz_wait

Wait for Z39.50 requests to complete

说明

mixed yaz_wait ([ array &$options ] )

This function carries out networked (blocked) activity for outstanding requests which have been prepared by the functions yaz_connect, yaz_search, yaz_present, yaz_scan and yaz_itemorder.

yaz_wait returns when all servers have either completed all requests or aborted (in case of errors).

参数

options
An associative array of options:

timeout
Sets timeout in seconds. If a server has not responded within the timeout it is considered dead and yaz_wait returns. The default value for timeout is 15 seconds.

event
A boolean.

返回值

成功时返回 true，或者在失败时返回 false。 In event mode, returns resource 或者在失败时返回 false.

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