# php_manual

id: yaz_database
type: function
doc:
<comment>Description:</comment>
  Specifies the databases within a session
    
  
  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  <strong>yaz_connect()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>         The connection resource returned by <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$databases</strong>  A string containing one or more databases. Multiple databases are  separated
                        by a plus sign <return>+</return>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: yaz_element
type: function
doc:
<comment>Description:</comment>
  Specifies Element-Set Name for retrieval
    
  
  This function sets the element set name for retrieval.
  
  Call this function before <strong>yaz_search()</strong> or <strong>yaz_present()</strong> to specify the element set name for
  records to be retrieved.
  
  If this function appears to have no effect, see the description of the  <return>piggybacking</return> option in
  <strong>yaz_connect()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>          The connection resource returned by <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$elementset</strong>  Most servers support <return>F</return> (for full records) and <return>B</return> (for brief records).

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: yaz_errno
type: function
doc:
<comment>Description:</comment>
  Returns error number
  
  Returns an error number for the server (last request) identified by <strong>$id</strong>.
  
  <strong>yaz_errno()</strong> should be called after network activity for each server - (after <strong>yaz_wait()</strong> returns)
  to determine the success or failure of the last operation (e.g. search).

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  The connection resource returned by <strong>yaz_connect()</strong>.

<comment>Return:</comment>
  <info>int</info>  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.

<comment>See Also:</comment>
   * <strong>yaz_error()</strong>
   * <strong>yaz_addinfo()</strong>


id: yaz_error
type: function
doc:
<comment>Description:</comment>
  Returns error description
  
  <strong>yaz_error()</strong> returns an English text message corresponding to the last error number as returned by
  <strong>yaz_errno()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  The connection resource returned by <strong>yaz_connect()</strong>.

<comment>Return:</comment>
  <info>string</info>  Returns an error text message for server (last request), identified by parameter <strong>$id</strong>. An
          empty string is returned if the last operation was successful.

<comment>See Also:</comment>
   * <strong>yaz_errno()</strong>
   * <strong>yaz_addinfo()</strong>


id: yaz_es
type: function
doc:
<comment>Description:</comment>
  Prepares for an Extended Service Request
    
  
  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.
  
  Many Z39.50 Servers do not support Extended Services.
  
  The <strong>yaz_es()</strong> creates an Extended Service Request packages and puts it into a queue of operations.
  Use <strong>yaz_wait()</strong> to send the request(s) to the server. After completion of <strong>yaz_wait()</strong> the result of
  the Extended Service operation should be expected with a call to <strong>yaz_es_result()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>    The connection resource returned by <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$type</strong>  A string which represents the type of the Extended Service:  <return>itemorder</return> (Item
                   Order), <return>create</return> (Create Database), <return>drop</return> (Drop Database), <return>commit</return> (Commit
                   Operation), <return>update</return> (Update Record), <return>xmlupdate</return> (XML Update). Each type is
                   specified in the following section.
  <info>array</info>     <strong>$args</strong>  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.

<comment>Return:</comment>
  <info>void</info>  Es wird kein Wert zurückgegeben.

<comment>See Also:</comment>
   * <strong>yaz_es_result()</strong>


id: yaz_es_result
type: function
doc:
<comment>Description:</comment>
  Inspects Extended Services Result
    
  
  This function inspects the last returned Extended Service result from a server. An Extended
  Service is  initiated by either <strong>yaz_item_order()</strong> or <strong>yaz_es()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  The connection resource returned by <strong>yaz_connect()</strong>.

<comment>Return:</comment>
  <info>array</info>  Returns array with element <return>targetReference</return> for the reference for the extended service
         operation (generated and returned from the server).

<comment>See Also:</comment>
   * <strong>yaz_es()</strong>


id: yaz_get_option
type: function
doc:
<comment>Description:</comment>
  Returns value of option for connection
  
  Returns the value of the option specified with <strong>$name</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>    The connection resource returned by <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$name</strong>  The option name.

<comment>Return:</comment>
  <info>string</info>  Returns the value of the specified option or an empty string if the option wasn't set.

<comment>See Also:</comment>
   * 
     The description of <strong>yaz_set_option()</strong> for available 
     options
    


id: yaz_hits
type: function
doc:
<comment>Description:</comment>
  Returns number of hits for last search
  
  <strong>yaz_hits()</strong> returns the number of hits for the last search.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>            The connection resource returned by <strong>yaz_connect()</strong>.
  <info>array</info>     <strong>$searchresult</strong>  Result array for detailed search result information.

<comment>Return:</comment>
  <info>int</info>  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.
       
       The SearchResult facility requires PECL YAZ 1.0.5 or later and YAZ 2.1.9 or later.
       
       Very few Z39.50 implementations support the SearchResult facility.


id: yaz_itemorder
type: function
doc:
<comment>Description:</comment>
  Prepares for Z39.50 Item Order with an ILL-Request package
    
  
  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.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>    The connection resource returned by <strong>yaz_connect()</strong>.
  <info>array</info>     <strong>$args</strong>  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:
                   
                   There are also a few parameters that are part of the Extended Services Request
                   package and the ItemOrder package:

<comment>Return:</comment>
  <info>void</info>  Es wird kein Wert zurückgegeben.


id: yaz_present
type: function
doc:
<comment>Description:</comment>
  Prepares for retrieval (Z39.50 present)
    
  
  This function prepares for retrieval of records after a successful search.
  
  The <strong>yaz_range()</strong> function should be called prior to this function to specify the range of records
  to be retrieved.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  The connection resource returned by <strong>yaz_connect()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: yaz_range
type: function
doc:
<comment>Description:</comment>
  Specifies a range of records to retrieve
    
  
  Specifies a range of records to retrieve.
  
  This function should be called before <strong>yaz_search()</strong> or  <strong>yaz_present()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      The connection resource returned by <strong>yaz_connect()</strong>.
  <info>int</info>       <strong>$start</strong>   Specifies the position of the first record to be retrieved. The  records
                     numbers goes from 1 to <strong>yaz_hits()</strong>.
  <info>int</info>       <strong>$number</strong>  Specifies the number of records to be retrieved.

<comment>Return:</comment>
  <info>void</info>  Es wird kein Wert zurückgegeben.


id: yaz_record
type: function
doc:
<comment>Description:</comment>
  Returns a record
  
  The <strong>yaz_record()</strong> function inspects a record in the current result set at the position specified by
  parameter <strong>$pos</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      The connection resource returned by <strong>yaz_connect()</strong>.
  <info>int</info>       <strong>$pos</strong>     The record position. Records positions in a result set are numbered 1, 2, ...
                     $hits where $hits is the count returned by <strong>yaz_hits()</strong>.
  <info>string</info>    <strong>$type</strong>    The <strong>$type</strong> specifies the form of the returned record.
                     
                     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 <return>; charset=</return>from<return>, </return>to where from is the original character set  of
                     the record and to is the resulting character set (as seen by PHP).
                     
                     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.
                     
                     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 <strong>$string</strong> except that MARC records are converted to
                     MARCXML
                     
                     This format is suitable if records are processed by an XML parser or XSLT
                     processor afterwards.
                     
                     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.
                     
                     The syntax of the record is returned as a string, i.e. <return>USmarc</return>, <return>GRS-1</return>, <return>XML</return>, etc.
                     
                     The name of database associated with record at the position is returned as a
                     string.
                     
                     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 <return>(</return>type<return>,</return> 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).
  <info></info>          <strong>$string</strong>  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 <strong>$string</strong> except that MARC records are converted to
                     MARCXML
                     
                     This format is suitable if records are processed by an XML parser or XSLT
                     processor afterwards.

<comment>Return:</comment>
  <info>string</info>  Returns the record at position <strong>$pos</strong> 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.


id: yaz_scan
type: function
doc:
<comment>Description:</comment>
  Prepares for a scan
  
  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, <strong>yaz_wait()</strong> must
  be called. Upon completion of <strong>yaz_wait()</strong> call <strong>yaz_error()</strong> and <strong>yaz_scan_result()</strong> to handle the
  response.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>         The connection resource returned by <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$type</strong>       Currently only type <return>rpn</return> is supported.
  <info>string</info>    <strong>$startterm</strong>  Starting term point for the scan.
                        
                        The form in which the starting term is specified is given by parameter
                        <strong>$type</strong>.
                        
                        The syntax this parameter is similar to the RPN query as described in
                        <strong>yaz_search()</strong>. It consists of zero or more  <return>@attr</return>-operator specifications,
                        then followed by  exactly one token.
  <info>array</info>     <strong>$flags</strong>      This optional parameter specifies additional information to control  the
                        behaviour of the scan request. Three indexes are currently read  from the
                        flags array: <return>number</return> (number of terms requested), <return>position</return> (preferred
                        position of term) and <return>stepSize</return> (preferred step size).

<comment>Return:</comment>
  <info>void</info>  Es wird kein Wert zurückgegeben.


id: yaz_scan_result
type: function
doc:
<comment>Description:</comment>
  Returns Scan Response result
  
  <strong>yaz_scan_result()</strong> returns terms and associated information as received from the server in the last
  performed <strong>yaz_scan()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      The connection resource returned by <strong>yaz_connect()</strong>.
  <info>array</info>     <strong>$result</strong>  If given, this array will be modified to hold additional information  taken
                     from the Scan Response: <return>number</return> - Number of entries returned <return>stepsize</return> - Step
                     size <return>position</return> - Position of term <return>status</return> - Scan status
                     
                     <return>number</return> - Number of entries returned
                     
                     <return>stepsize</return> - Step size
                     
                     <return>position</return> - Position of term
                     
                     <return>status</return> - Scan status

<comment>Return:</comment>
  <info>array</info>  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.


id: yaz_schema
type: function
doc:
<comment>Description:</comment>
  Specifies schema for retrieval
    
  
  <strong>yaz_schema()</strong> specifies the schema for retrieval.
  
  This function should be called before  <strong>yaz_search()</strong> or <strong>yaz_present()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      The connection resource returned by <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$schema</strong>  Must be specified as an OID (Object Identifier) in a raw dot-notation  (like
                     <return>1.2.840.10003.13.4</return>) or as one of the known  registered schemas: <return>GILS-schema</return>,
                     <return>Holdings</return>, <return>Zthes</return>, ...

<comment>Return:</comment>
  <info>void</info>  Es wird kein Wert zurückgegeben.


id: yaz_search
type: function
doc:
<comment>Description:</comment>
  Prepares for a search
  
  <strong>yaz_search()</strong> prepares for a search on the given  connection.
  
  Like <strong>yaz_connect()</strong> this function is non-blocking and only prepares for a search to be executed
  later when  <strong>yaz_wait()</strong> is called.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>     The connection resource returned by <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$type</strong>   This parameter represents the query type - only <return>"rpn"</return> is supported now in which
                    case the third argument specifies a Type-1  query in prefix query notation.
  <info>string</info>    <strong>$query</strong>  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 (<return>@</return>) are considered operators,
                    otherwise they are treated as search terms.
                    
                    You can find information about attributes at the  Z39.50 Maintenance Agency
                    site.
                    
                    If you would like to use a more friendly notation, use the CCL parser -
                    functions <strong>yaz_ccl_conf()</strong> and  <strong>yaz_ccl_parse()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: yaz_set_option
type: function
doc:
<comment>Description:</comment>
  Sets one or more options for connection
  
  Sets one or more options on the given connection.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>     The connection resource returned by <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$name</strong>   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 <strong>$value</strong>.
                    
                    If given as an array, this will be an associative array (option name  =&gt;
                    option value).
  <info>string</info>    <strong>$value</strong>  The new value of the option. Use this only if the previous argument is a string.

<comment>Return:</comment>
  <info>void</info>  Es wird kein Wert zurückgegeben.


id: yaz_sort
type: function
doc:
<comment>Description:</comment>
  Sets sorting criteria
  
  This function sets sorting criteria and enables Z39.50 Sort.
  
  Call this function before <strong>yaz_search()</strong>. Using this function alone does not have any effect. When
  used in conjunction with <strong>yaz_search()</strong>, a Z39.50 Sort will be sent after a search response has been
  received and before any records are retrieved with Z39.50 Present (<strong>yaz_present()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>        The connection resource returned by <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$criteria</strong>  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. <return>1=4,2=1</return>) ; or the field may specify
                       a plain string criteria (e.g.  <return>title</return>. The flags is a sequence of the
                       following  characters which may not be separated by any white space.
                       
                       Sort Flags<return>a</return> Sort ascending <return>d</return> Sort descending <return>i</return> Case insensitive sorting <return>s</return>
                       Case sensitive sorting
                       
                       Sort ascending
                       
                       Sort descending
                       
                       Case insensitive sorting
                       
                       Case sensitive sorting

<comment>Return:</comment>
  <info>void</info>  Es wird kein Wert zurückgegeben.


id: yaz_syntax
type: function
doc:
<comment>Description:</comment>
  Specifies the preferred record syntax for retrieval
    
  
  <strong>yaz_syntax()</strong> specifies the preferred record syntax for retrieval
  
  This function should be called before <strong>yaz_search()</strong> or  <strong>yaz_present()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      The connection resource returned by <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$syntax</strong>  The syntax must be specified as an OID (Object Identifier) in a raw
                     dot-notation (like <return>1.2.840.10003.5.10</return>) or as one of the known registered record
                     syntaxes (sutrs, usmarc, grs1, xml, etc.).

<comment>Return:</comment>
  <info>void</info>  Es wird kein Wert zurückgegeben.


id: yaz_wait
type: function
doc:
<comment>Description:</comment>
  Wait for Z39.50 requests to complete
  
  This function carries out networked (blocked) activity for outstanding requests which have been
  prepared by the functions  <strong>yaz_connect()</strong>, <strong>yaz_search()</strong>,  <strong>yaz_present()</strong>, <strong>yaz_scan()</strong> and
  <strong>yaz_itemorder()</strong>.
  
  <strong>yaz_wait()</strong> returns when all servers have either completed all requests or aborted (in case of
  errors).

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  An associative array of options: <return>timeout</return> Sets timeout in seconds. If a server has
                   not responded within the timeout it is considered dead and <strong>yaz_wait()</strong> returns.
                   The default value for timeout is 15 seconds. <return>event</return> A boolean.
                   
                   Sets timeout in seconds. If a server has not responded within the timeout it is
                   considered dead and <strong>yaz_wait()</strong> returns. The default value for timeout is 15
                   seconds.
                   
                   A boolean.

<comment>Return:</comment>
  <info>mixed</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben. In event mode,
         returns resource Bei einem Fehler wird <info>false</info> zurückgegeben..


id: zend_thread_id
type: function
doc:
<comment>Description:</comment>
  Liefert eine eindeutige ID für den aktuellen Thread
  
  Diese Funktion gibt eine eindeutige ID für den aktuellen Thread zurück.

<comment>Return:</comment>
  <info>int</info>  Gibt die Thread-ID als Integer zurück.


id: zend_version
type: function
doc:
<comment>Description:</comment>
  Liefert die aktuelle Version der Zend-Engine
  
  Liefert die Versionsnummer der aktuell laufenden Zend-Engine als Zeichenkette.

<comment>Return:</comment>
  <info>string</info>  Liefert die Versionsnummer der Zend-Engine als Zeichenkette.

<comment>See Also:</comment>
   * <strong>phpinfo()</strong>
   * <strong>phpcredits()</strong>
   * <strong>phpversion()</strong>


id: zip_close
type: function
doc:
<comment>Description:</comment>
  Schließt ein ZIP-Archiv
  
  Schließt das übergebene ZIP-Archiv.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip</strong>  Eine ZIP-Datei, die zuvor mittels <strong>zip_open()</strong> geöffnet wurde.

<comment>Return:</comment>
  <info>void</info>  Es wird kein Wert zurückgegeben.

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_read()</strong>


id: zip_entry_close
type: function
doc:
<comment>Description:</comment>
  Schließt einen Verzeichniseintrag
  
  Schließt den angegebenen Verzeichniseintrag.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  Ein Verzeichniseintrag, der zuvor mit <strong>zip_entry_open()</strong> geöffnet wurde.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>zip_entry_open()</strong>
   * <strong>zip_entry_read()</strong>


id: zip_entry_compressedsize
type: function
doc:
<comment>Description:</comment>
  Ermittelt die komprimierte Größe eines Verzeichniseintrages
  
  Gibt die komprimierte Größe des angegebenen Verzeichniseintrages zurück.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  Ein von <strong>zip_read()</strong> zurückgegebener Verzeichniseintrag.

<comment>Return:</comment>
  <info>int|false</info>  Die komprimierte Größe. Bei einem Fehler wird <info>false</info> zurückgegeben..

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_read()</strong>


id: zip_entry_compressionmethod
type: function
doc:
<comment>Description:</comment>
  Ermittelt die Komprimierungsmethode eines Verzeichniseintrags
  
  Gibt die Komprimierungsmethode des von <strong>$zip_entry</strong> angegebenen Verzeichniseintrages zurück.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  Ein von <strong>zip_read()</strong> zurückgegebener Verzeichniseintrag.

<comment>Return:</comment>
  <info>string|false</info>  Die Komprimierungsmethode. Bei einem Fehler wird <info>false</info> zurückgegeben..

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_read()</strong>


id: zip_entry_filesize
type: function
doc:
<comment>Description:</comment>
  Ermittelt die effektive Größe eines Verzeichniseintrages
  
  Gibt die effektive Größe des angegebenen Verzeichniseintrags zurück.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  Ein von <strong>zip_read()</strong> zurückgegebener Verzeichniseintrag.

<comment>Return:</comment>
  <info>int|false</info>  Die Größe des Verzeichniseintrags. Bei einem Fehler wird <info>false</info> zurückgegeben..

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_read()</strong>


id: zip_entry_name
type: function
doc:
<comment>Description:</comment>
  Gibt den Namen eines Verzeichniseintrages zurück
  
  Gibt den Names eines angegebenen Verzeichniseintrags zurück.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  Ein von <strong>zip_read()</strong> zurückgegebener Verzeichniseintrag.

<comment>Return:</comment>
  <info>string|false</info>  Der Name des Verzeichniseintrags. Bei einem Fehler wird <info>false</info> zurückgegeben..

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_read()</strong>


id: zip_entry_open
type: function
doc:
<comment>Description:</comment>
  Öffnet einen Verzeichniseintrag für den Lesezugriff
  
  Öffnet einen Verzeichniseintrag für den Lesezugriff.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_dp</strong>     Ein valides Ressource-Handle, das von der <strong>zip_open()</strong> zurückgegeben wurde.
  <info>resource</info>  <strong>$zip_entry</strong>  Ein Verzeichniseintrag, der von <strong>zip_read()</strong> zurückgegeben wurde.
  <info>string</info>    <strong>$mode</strong>       Einer der in der Dokumentation zu <strong>fopen()</strong> angegebenen Modi.
                        
                        Derzeit wird <strong>$mode</strong> ignoriert und statt dessen standardmäßig <return>"rb"</return> verwendet.
                        Dies ist dadurch bedingt, dass der ZIP-Support in PHP nur den
                        Nur-Lesen-Modus unterstützt.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.
        
        Im Gegensatz zu <strong>fopen()</strong> und vergleichbaren Funktionen zeigt der Rückgabewert von
        <strong>zip_entry_open()</strong> nur das Gelingen an und wird nicht für weitere Operationen benötigt.

<comment>See Also:</comment>
   * <strong>zip_entry_close()</strong>
   * <strong>zip_entry_read()</strong>


id: zip_entry_read
type: function
doc:
<comment>Description:</comment>
  Liest einen geöffneten Verzeichniseintrag aus
  
  Liest aus einem geöffneten Verzeichniseintrag.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  Ein von <strong>zip_read()</strong> zurückgegebener Verzeichniseintrag.
  <info>int</info>       <strong>$len</strong>        Die Anzahl der zurückzugebenden Bytes.
                        
                        Dies sollte die Länge der der unkomprimierten Daten sein, die Sie auslesen
                        möchten.

<comment>Return:</comment>
  <info>string|false</info>  Gibt die gelesenen Daten zurück oder einen leeren String, wenn das Ende der Datei
                erreicht ist oder <info>false</info>, bei einem Fehler.

<comment>See Also:</comment>
   * <strong>zip_entry_open()</strong>
   * <strong>zip_entry_close()</strong>
   * <strong>zip_entry_filesize()</strong>


id: zip_open
type: function
doc:
<comment>Description:</comment>
  Öffnet ein ZIP-Archiv
  
  Öffnet ein ZIP-Archiv für den Lesezugriff.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Der Name der zu öffnenden ZIP-Datei.

<comment>Return:</comment>
  <info>resource|int|false</info>  Gibt einen Dateizeiger für die spätere Verwendung mit <strong>zip_read()</strong> und
                      <strong>zip_close()</strong> zurück. Ist <strong>$filename</strong> nicht vorhanden oder tritt ein anderer
                      Fehler auf, wird entweder <info>false</info> oder die Fehlernummer zurückgegeben.

<comment>See Also:</comment>
   * <strong>zip_read()</strong>
   * <strong>zip_close()</strong>


id: zip_read
type: function
doc:
<comment>Description:</comment>
  Liest den nächsten Eintrag innerhalb des ZIP-Archivs
  
  Liest den nächsten Eintrag innerhalb des ZIP-Archivs.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip</strong>  Eine ZIP-Datei, die zuvor mittels <strong>zip_open()</strong> geöffnet wurde.

<comment>Return:</comment>
  <info>resource|false</info>  Gibt im Erfolgsfall einen Verzeichniseintrag zur späteren Benutzung mit den
                  <return>zip_entry_...</return>-Funktionen zurück. Wenn keine weiteren Einträge vorhanden sind, wird
                  <info>false</info> zurückgegeben. Tritt ein Fehler auf, ist der Rückgabewert die entsprechende
                  Fehlernummer.

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_close()</strong>
   * <strong>zip_entry_open()</strong>
   * <strong>zip_entry_read()</strong>


id: zlib_decode
type: function
doc:
<comment>Description:</comment>
  Dekomprimiert raw-/gzip-/zlib-kodierte Daten
  
  Dekomprimiert raw-/gzip-/zlib-kodierte Daten.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>        
  <info>int</info>     <strong>$max_length</strong>  

<comment>Return:</comment>
  <info>string|false</info>  Gibt die unkomprimierten Daten zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>zlib_encode()</strong>


id: zlib_encode
type: function
doc:
<comment>Description:</comment>
  Komprimiert Daten mit der gewählten Kodierung
  
  Komprimiert Daten mit der gewählten Kodierung.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>      Die zu komprimierenden Daten.
  <info>int</info>     <strong>$encoding</strong>  Der Komprimierungsalgorithmus. Entweder <info>ZLIB_ENCODING_RAW</info>,
                     <info>ZLIB_ENCODING_DEFLATE</info> oder <info>ZLIB_ENCODING_GZIP</info>.
  <info>int</info>     <strong>$level</strong>     

<comment>Return:</comment>
  <info>string|false</info>  

<comment>See Also:</comment>
   * <strong>zlib_decode()</strong>


id: zlib_get_coding_type
type: function
doc:
<comment>Description:</comment>
  Gibt die für Ausgabekomprimierung genutzte Methode zurück
  
  Gibt die für Ausgabekomprimierung genutzte Methode zurück.

<comment>Return:</comment>
  <info>string|false</info>  Mögliche Ergebnisse sind <return>gzip</return>, <return>deflate</return> oder <info>false</info>.

<comment>See Also:</comment>
   * 
     Die zlib.output_compression-Direktive.
    


id: zookeeper_dispatch
type: function
doc:
<comment>Description:</comment>
  Calls callbacks for pending operations
  
  The <strong>zookeeper_dispatch()</strong> function calls the callbacks passed by operations like Zookeeper::get or
  Zookeeper::exists.
  
  Since version 0.4.0, this function must be called manually to achieve asynchronous operations. If
  you want that to be done automatically, you also can declare ticks at the beginning of your
  program.
  
  After PHP 7.1, you can ignore this function. This extension uses EG(vm_interrupt) to implement
  async dispatch.

<comment>Return:</comment>
  <info>void</info>  Es wird kein Wert zurückgegeben.

<comment>See Also:</comment>
   * Zookeeper::addAuth
   * Zookeeper::connect
   * Zookeeper::__construct
   * Zookeeper::exists
   * Zookeeper::get
   * Zookeeper::getChildren
   * Zookeeper::setWatcher


