Quick Reference For Attribute Fields
(eg: "@attr 2=" refers to the Relation attribute)
1 = Use Field
2 = Relation
3 = Position
4 = Structure
5 = Truncate
6 = Completeness
yaz_search
(PHP 4 >= 4.0.1, PECL yaz >= 0.9.0)
yaz_search — Prepares for a search
Description
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.
Parameters
-
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.RPN Operators Construct Description @andquery1 query2intersection of query1 and query2 @orquery1 query2union of query1 and query2 @notquery1 query2query1 and not query2 @setnameresult set reference @attrsetset queryspecifies attribute-set for query. This construction is only allowed once - in the beginning of the whole query @attr[set] type=value queryapplies 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().
Return Values
Returns true on success or false on failure.
Examples
Example #1 Query Examples
You can search for simple terms, like this:
computer
The query
"knuth donald"
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
(a or b) and ((c or d) not
e).
Another, more complex, one:
@attrset gils @and @attr 1=4 art @attr 1=2000 company
art occur in the title (GILS,BIB-1)
and in which company occur as Distributor (GILS).
add a note
User Contributed Notes 3 notes
jwohlers at mail dot wcc dot cc dot il dot us ¶
22 years ago
k dot andris at gmail dot com ¶
15 years ago
To display holdings data set the syntax and the record format to "opac" (at least for Horizon ILS). It will give you an xml, containg <holding> elements with all info:
<?php
$z = yaz_connect(...
yaz_syntax($z, 'opac');
yaz_search($z, 'rpn', '@attr 1=4 "title%"');
yaz_wait();
$hits = yaz_hits($z);
yaz_range($z, 1, $hits);
yaz_present($z);
for($i = 1; $i <= $hits; $i++)
my_display(yaz_record($z, $i, 'opac'));
yaz_close($z);
function my_display($s)
{
$lines = explode("\n", trim($s));
var_dump($lines);
}
?>
