# php_manual

id: NumberFormatter::getPattern
type: function
doc:
<comment>Description:</comment>
  Get formatter pattern
  
  Objektorientierter Stil
  
  Prozeduraler Stil
  
  Extract pattern used by the formatter.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> object.

<comment>Return:</comment>
  <info>string|false</info>  Pattern <info>string</info> that is used by the formatter, or <info>false</info> if an error happens.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>numfmt_set_pattern()</strong>
   * <strong>numfmt_create()</strong>


id: NumberFormatter::getSymbol
type: function
doc:
<comment>Description:</comment>
  Get a symbol value
  
  Objektorientierter Stil
  
  Prozeduraler Stil
  
  Get a symbol associated with the formatter. The formatter uses symbols to represent the special
  locale-dependent characters in a number, for example the percent sign. This API is not supported
  for rule-based formatters.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> object.
  <info>int</info>              <strong>$symbol</strong>     Symbol specifier, one of the  format symbol constants.

<comment>Return:</comment>
  <info>string|false</info>  The symbol string or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>numfmt_set_symbol()</strong>


id: NumberFormatter::getTextAttribute
type: function
doc:
<comment>Description:</comment>
  Get a text attribute
  
  Objektorientierter Stil
  
  Prozeduraler Stil
  
  Get a text attribute associated with the formatter. An example of a text attribute is the suffix
  for positive numbers. If the formatter does not understand the attribute, <info>U_UNSUPPORTED_ERROR</info>
  error is produced. Rule-based formatters only understand <info>NumberFormatter::DEFAULT_RULESET</info> and
  <info>NumberFormatter::PUBLIC_RULESETS</info>.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> object.
  <info>int</info>              <strong>$attribute</strong>  Attribute specifier - one of the  text attribute constants.

<comment>Return:</comment>
  <info>string|false</info>  Return attribute value on success, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>numfmt_get_attribute()</strong>
   * <strong>numfmt_set_text_attribute()</strong>


id: NumberFormatter::parse
type: function
doc:
<comment>Description:</comment>
  Parse a number
  
  Objektorientierter Stil
  
  Prozeduraler Stil
  
  Parse a string into a number using the current formatter rules.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> object.
  <info>string</info>           <strong>$string</strong>     The string to parse for the number.
  <info>int</info>              <strong>$type</strong>       The  formatting type to use. By default, <info>NumberFormatter::TYPE_DOUBLE</info>
                               is used. Note that <info>NumberFormatter::TYPE_CURRENCY</info> is not supported;
                               use NumberFormatter::parseCurrency instead.
  <info>int</info>              <strong>$offset</strong>     Offset in the string at which to begin parsing. On return, this value
                               will hold the offset at which parsing ended.

<comment>Return:</comment>
  <info>int|float|false</info>  The value of the parsed number or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>numfmt_format()</strong>
   * <strong>numfmt_parse_currency()</strong>


id: NumberFormatter::parseCurrency
type: function
doc:
<comment>Description:</comment>
  Parse a currency number
  
  Objektorientierter Stil
  
  Prozeduraler Stil
  
  Parse a string into a float and a currency using the current formatter.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> object.
  <info>string</info>           <strong>$currency</strong>   Parameter to receive the currency name (3-letter ISO 4217 currency
                               code).
  <info>int</info>              <strong>$offset</strong>     Offset in the string at which to begin parsing. On return, this value
                               will hold the offset at which parsing ended.

<comment>Return:</comment>
  <info>float|false</info>  The parsed numeric value or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>numfmt_parse()</strong>
   * <strong>numfmt_format_currency()</strong>


id: NumberFormatter::setAttribute
type: function
doc:
<comment>Description:</comment>
  Set an attribute
  
  Objektorientierter Stil
  
  Prozeduraler Stil
  
  Set a numeric attribute associated with the formatter. An example of a numeric attribute is the
  number of integer digits the formatter will produce.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> object.
  <info>int</info>              <strong>$attribute</strong>  Attribute specifier - one of the  numeric attribute constants.
  <info>int|float</info>        <strong>$value</strong>      The attribute value.

<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>numfmt_get_error_code()</strong>
   * <strong>numfmt_get_attribute()</strong>
   * <strong>numfmt_set_text_attribute()</strong>


id: NumberFormatter::setPattern
type: function
doc:
<comment>Description:</comment>
  Set formatter pattern
  
  Objektorientierter Stil
  
  Prozeduraler Stil
  
  Set the pattern used by the formatter. Can not be used on a rule-based formatter.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> object.
  <info>string</info>           <strong>$pattern</strong>    Pattern in syntax described in ICU DecimalFormat documentation.

<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>numfmt_get_error_code()</strong>
   * <strong>numfmt_create()</strong>
   * <strong>numfmt_get_pattern()</strong>


id: NumberFormatter::setSymbol
type: function
doc:
<comment>Description:</comment>
  Set a symbol value
  
  Objektorientierter Stil
  
  Prozeduraler Stil
  
  Set a symbol associated with the formatter. The formatter uses symbols to represent the special
  locale-dependent characters in a number, for example the percent sign. This API is not supported
  for rule-based formatters.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> object.
  <info>int</info>              <strong>$symbol</strong>     Symbol specifier, one of the  format symbol constants.
  <info>string</info>           <strong>$value</strong>      Text for the symbol.

<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>numfmt_get_error_code()</strong>
   * <strong>numfmt_get_symbol()</strong>


id: NumberFormatter::setTextAttribute
type: function
doc:
<comment>Description:</comment>
  Set a text attribute
  
  Objektorientierter Stil
  
  Prozeduraler Stil
  
  Set a text attribute associated with the formatter. An example of a text attribute is the suffix
  for positive numbers. If the formatter does not understand the attribute, <info>U_UNSUPPORTED_ERROR</info>
  error is produced. Rule-based formatters only understand <info>NumberFormatter::DEFAULT_RULESET</info> and
  <info>NumberFormatter::PUBLIC_RULESETS</info>.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> object.
  <info>int</info>              <strong>$attribute</strong>  Attribute specifier - one of the text attribute constants.
  <info>string</info>           <strong>$value</strong>      Text for the attribute value.

<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>numfmt_get_error_code()</strong>
   * <strong>numfmt_get_text_attribute()</strong>
   * <strong>numfmt_set_attribute()</strong>


id: OAUTH_AUTH_TYPE_AUTHORIZATION
type: constant
doc:
<comment>Description:</comment>
  This constant represents putting OAuth parameters in the <return>Authorization</return> header.


id: OAUTH_AUTH_TYPE_FORM
type: constant
doc:
<comment>Description:</comment>
  This constant represents putting OAuth parameters as part of the HTTP POST body.


id: OAUTH_AUTH_TYPE_URI
type: constant
doc:
<comment>Description:</comment>
  This constant represents putting OAuth parameters in the request URI.


id: OAUTH_BAD_NONCE
type: constant
doc:
<comment>Description:</comment>
  The oauth_nonce value was used in a previous request, therefore it cannot be used now.


id: OAUTH_BAD_TIMESTAMP
type: constant
doc:
<comment>Description:</comment>
  The oauth_timestamp value was not accepted by the service provider. In this case, the response
  should also contain the oauth_acceptable_timestamps parameter.


id: OAUTH_CONSUMER_KEY_UNKNOWN
type: constant
doc:
<comment>Description:</comment>
  The oauth_consumer_key is temporarily unacceptable to the service provider. For example, the
  service provider may be throttling the consumer.


id: OAUTH_INVALID_SIGNATURE
type: constant
doc:
<comment>Description:</comment>
  The oauth_signature is invalid, as it does not match the signature computed by the service
  provider.


id: OAUTH_PARAMETER_ABSENT
type: constant
doc:
<comment>Description:</comment>
  A required parameter was not received. In this case, the response should also contain the
  oauth_parameters_absent parameter.


id: OAUTH_REQENGINE_CURL
type: constant
doc:
<comment>Description:</comment>
  Used by OAuth::setRequestEngine to set the engine to  Curl, as opposed to  <info>OAUTH_REQENGINE_STREAMS</info>
  for PHP streams.


id: OAUTH_REQENGINE_STREAMS
type: constant
doc:
<comment>Description:</comment>
  Used by OAuth::setRequestEngine to set the engine to  PHP streams, as opposed to
  <info>OAUTH_REQENGINE_CURL</info> for  Curl.


id: OAUTH_TOKEN_REJECTED
type: constant
doc:
<comment>Description:</comment>
  The oauth_token was not accepted by the service provider. The reason is not known, but it might be
  because the token was never issued, already consumed, expired, and/or forgotten by the service
  provider.


id: OAUTH_TOKEN_USED
type: constant
doc:
<comment>Description:</comment>
  The oauth_token has been consumed. It can no longer be used because it has already been used in
  the previous request(s).


id: OAuth
type: class
doc:
<comment>Description:</comment>
  The OAuth extension provides a simple interface to interact with data providers using the OAuth
  HTTP specification to protect private resources.


id: OAuth::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new OAuth object
  
  Creates a new OAuth object

<comment>Param:</comment>
  <info>string</info>  <strong>$consumer_key</strong>      The consumer key provided by the service provider.
  <info>string</info>  <strong>$consumer_secret</strong>   The consumer secret provided by the service provider.
  <info>string</info>  <strong>$signature_method</strong>  This optional parameter defines which signature method to use, by
                             default it is <info>OAUTH_SIG_METHOD_HMACSHA1</info> (HMAC-SHA1).
  <info>int</info>     <strong>$auth_type</strong>         This optional parameter defines how to pass the OAuth parameters to a
                             consumer, by default it is <info>OAUTH_AUTH_TYPE_AUTHORIZATION</info> (in the
                             <return>Authorization</return> header).


id: OAuth::__destruct
type: function
doc:
<comment>Description:</comment>
  The destructor
  
  The destructor.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

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

<comment>See Also:</comment>
   * OAuth::__construct


id: OAuth::disableDebug
type: function
doc:
<comment>Description:</comment>
  Turn off verbose debugging
  
  Turns off verbose request information (off by default). Alternatively, the debug property can be
  set to a <info>false</info> value to turn debug off.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>

<comment>See Also:</comment>
   * OAuth::enableDebug


id: OAuth::disableRedirects
type: function
doc:
<comment>Description:</comment>
  Turn off redirects
  
  Disable redirects from being followed automatically, thus allowing the request to be manually
  redirected.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>

<comment>See Also:</comment>
   * OAuth::enableRedirects


id: OAuth::disableSSLChecks
type: function
doc:
<comment>Description:</comment>
  Turn off SSL checks
  
  Turns off the usual SSL peer certificate and host checks, this is not for production environments.
  Alternatively, the <strong>$sslChecks</strong> member can be set to <info>false</info> to turn SSL checks off.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>

<comment>See Also:</comment>
   * OAuth::enableSSLChecks


id: OAuth::enableDebug
type: function
doc:
<comment>Description:</comment>
  Turn on verbose debugging
  
  Turns on verbose request information useful for debugging, the debug information is stored in the
  <strong>$debugInfo</strong> member. Alternatively, the <strong>$debug</strong> member can  be set to a non-<info>false</info> value to turn debug
  on.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>

<comment>See Also:</comment>
   * OAuth::disableDebug


id: OAuth::enableRedirects
type: function
doc:
<comment>Description:</comment>
  Turn on redirects
  
  Follow and sign redirects automatically, which is enabled by default.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>

<comment>See Also:</comment>
   * OAuth::disableRedirects


id: OAuth::enableSSLChecks
type: function
doc:
<comment>Description:</comment>
  Turn on SSL checks
  
  Turns on the usual SSL peer certificate and host checks (enabled by default). Alternatively, the
  <strong>$sslChecks</strong> member can be set to a non-<info>false</info> value to turn SSL checks off.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>

<comment>See Also:</comment>
   * OAuth::disableSSLChecks


id: OAuth::fetch
type: function
doc:
<comment>Description:</comment>
  Fetch an OAuth protected resource
  
  Fetch a resource.

<comment>Param:</comment>
  <info>string</info>  <strong>$protected_resource_url</strong>  URL to the OAuth protected resource.
  <info>array</info>   <strong>$extra_parameters</strong>        Extra parameters to send with the request for the resource.
  <info>string</info>  <strong>$http_method</strong>             One of the <info>OAUTH_HTTP_METHOD_*</info> OAUTH constants, which includes
                                   GET, POST, PUT, HEAD, or DELETE.
                                   
                                   HEAD (<info>OAUTH_HTTP_METHOD_HEAD</info>) can be useful for discovering
                                   information prior to the request (if OAuth credentials are in the
                                   <return>Authorization</return> header).
  <info>array</info>   <strong>$http_headers</strong>            HTTP client headers (such as User-Agent, Accept, etc.)

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

<comment>See Also:</comment>
   * OAuth::getLastResponse
   * OAuth::getLastResponseInfo
   * OAuth::setToken


id: OAuth::generateSignature
type: function
doc:
<comment>Description:</comment>
  Generate a signature
  
  Generate a signature based on the final HTTP method, URL and a string/array of parameters.

<comment>Param:</comment>
  <info>string</info>  <strong>$http_method</strong>       HTTP method for request
  <info>string</info>  <strong>$url</strong>               URL for request
  <info>mixed</info>   <strong>$extra_parameters</strong>  String or array of additional parameters.

<comment>Return:</comment>
  <info>string|false</info>  A string containing the generated signatureBei einem Fehler wird <info>false</info>
                zurückgegeben.


id: OAuth::getAccessToken
type: function
doc:
<comment>Description:</comment>
  Fetch an access token
  
  Fetch an access token, secret and any additional response parameters from the service provider.

<comment>Param:</comment>
  <info>string</info>  <strong>$access_token_url</strong>     URL to the access token API.
  <info>string</info>  <strong>$auth_session_handle</strong>  Authorization session handle, this parameter does not have any
                                citation in the core OAuth 1.0 specification but may be  implemented
                                by large providers.  See ScalableOAuth for more information.
  <info>string</info>  <strong>$verifier_token</strong>       For service providers which support 1.0a, a <strong>$verifier_token</strong> must be
                                passed while exchanging the request token for the access token. If
                                the <strong>$verifier_token</strong> is present in <strong>$_GET</strong>  or <strong>$_POST</strong> it is passed
                                automatically and the caller  does not need to specify a
                                <strong>$verifier_token</strong> (usually if the access token  is exchanged at the
                                oauth_callback URL). See ScalableOAuth for more information.
  <info>string</info>  <strong>$http_method</strong>          HTTP method to use, e.g. <return>GET</return> or <return>POST</return>.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing the parsed OAuth response on success or <info>false</info> on failure.

<comment>See Also:</comment>
   * OAuth::getLastResponse
   * OAuth::getLastResponseInfo
   * OAuth::setToken


id: OAuth::getCAPath
type: function
doc:
<comment>Description:</comment>
  Gets CA information
  
  Gets the Certificate Authority information, which includes the ca_path and ca_info set by
  OAuth::setCaPath.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> of Certificate Authority information, specifically as <return>ca_path</return> and <return>ca_info</return> keys
         within the returned associative array.

<comment>See Also:</comment>
   * OAuth::setCAPath
   * OAuth::getLastResponseInfo


id: OAuth::getLastResponse
type: function
doc:
<comment>Description:</comment>
  Get the last response
  
  Get the raw response of the most recent request.

<comment>Return:</comment>
  <info>string</info>  Returns a string containing the last response.

<comment>See Also:</comment>
   * OAuth::getLastResponseInfo
   * OAuth::fetch


id: OAuth::getLastResponseHeaders
type: function
doc:
<comment>Description:</comment>
  Get headers for last response
  
  Get headers for last response.

<comment>Return:</comment>
  <info>string|false</info>  A string containing the last response's headersBei einem Fehler wird <info>false</info>
                zurückgegeben.


id: OAuth::getLastResponseInfo
type: function
doc:
<comment>Description:</comment>
  Get HTTP information about the last response
  
  Get HTTP information about the last response.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing the response information for the last request. Constants from
         <strong>curl_getinfo()</strong> may be used.

<comment>See Also:</comment>
   * OAuth::fetch
   * OAuth::getLastResponse


id: OAuth::getRequestHeader
type: function
doc:
<comment>Description:</comment>
  Generate OAuth header string signature
  
  Generate OAuth header string signature based on the final HTTP method, URL and a string/array of
  parameters

<comment>Param:</comment>
  <info>string</info>  <strong>$http_method</strong>       HTTP method for request.
  <info>string</info>  <strong>$url</strong>               URL for request.
  <info>mixed</info>   <strong>$extra_parameters</strong>  String or array of additional parameters.

<comment>Return:</comment>
  <info>string|false</info>  A string containing the generated request headerBei einem Fehler wird <info>false</info>
                zurückgegeben.


id: OAuth::getRequestToken
type: function
doc:
<comment>Description:</comment>
  Fetch a request token
  
  Fetch a request token, secret and any additional response parameters from the service provider.

<comment>Param:</comment>
  <info>string</info>  <strong>$request_token_url</strong>  URL to the request token API.
  <info>string</info>  <strong>$callback_url</strong>       OAuth callback URL. If <strong>$callback_url</strong> is passed and is an empty value,
                              it is set to "oob" to address the OAuth 2009.1 advisory.
  <info>string</info>  <strong>$http_method</strong>        HTTP method to use, e.g. <return>GET</return> or <return>POST</return>.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing the parsed OAuth response on success or <info>false</info> on failure.

<comment>See Also:</comment>
   * OAuth::getLastResponse
   * OAuth::getLastResponseInfo


id: OAuth::setAuthType
type: function
doc:
<comment>Description:</comment>
  Set authorization type
  
  Set where the OAuth parameters should be passed.

<comment>Param:</comment>
  <info>int</info>  <strong>$auth_type</strong>  <strong>$auth_type</strong> can be one of the following flags (in order of decreasing preference
                   as per OAuth 1.0 section 5.2): <info>OAUTH_AUTH_TYPE_AUTHORIZATION</info> Pass the OAuth
                   parameters in the HTTP <return>Authorization</return> header. <info>OAUTH_AUTH_TYPE_FORM</info> Append the
                   OAuth parameters to the HTTP POST request body. <info>OAUTH_AUTH_TYPE_URI</info> Append the
                   OAuth parameters to the request URI. <info>OAUTH_AUTH_TYPE_NONE</info> None.
                   
                   Pass the OAuth parameters in the HTTP <return>Authorization</return> header.
                   
                   Append the OAuth parameters to the HTTP POST request body.
                   
                   Append the OAuth parameters to the request URI.
                   
                   None.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if a parameter is correctly set, otherwise <info>false</info> (e.g., if an invalid
        <strong>$auth_type</strong> is passed in.)


id: OAuth::setCAPath
type: function
doc:
<comment>Description:</comment>
  Set CA path and info
  
  Sets the Certificate Authority (CA), both for path and info.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>string</info>  <strong>$ca_path</strong>  The CA Path being set.
  <info>string</info>  <strong>$ca_info</strong>  The CA Info being set.

<comment>Return:</comment>
  <info>mixed</info>  Returns <info>true</info> on success, or <info>false</info> if either <strong>$ca_path</strong> or <strong>$ca_info</strong> are considered invalid.

<comment>See Also:</comment>
   * OAuth::getCaPath


id: OAuth::setNonce
type: function
doc:
<comment>Description:</comment>
  Set the nonce for subsequent requests
  
  Sets the nonce for all subsequent requests.

<comment>Param:</comment>
  <info>string</info>  <strong>$nonce</strong>  The value for oauth_nonce.

<comment>Return:</comment>
  <info>mixed</info>  Returns <info>true</info> on success, or <info>false</info> if the <strong>$nonce</strong> is considered invalid.

<comment>See Also:</comment>
   * OAuth::setToken
   * OAuth::setAuthType
   * OAuth::setVersion


id: OAuth::setRSACertificate
type: function
doc:
<comment>Description:</comment>
  Set the RSA certificate
  
  Sets the RSA certificate.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>string</info>  <strong>$cert</strong>  The RSA certificate.

<comment>Return:</comment>
  <info>mixed</info>  Returns <info>true</info> on success, or <info>false</info> on failure (e.g., the RSA certificate cannot be parsed.)

<comment>See Also:</comment>
   * OAuth::setCaPath


id: OAuth::setRequestEngine
type: function
doc:
<comment>Description:</comment>
  The setRequestEngine purpose
  
  Sets the Request Engine, that will be sending the HTTP requests.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>int</info>  <strong>$reqengine</strong>  The desired request engine. Set to <info>OAUTH_REQENGINE_STREAMS</info> to use PHP Streams, or
                   <info>OAUTH_REQENGINE_CURL</info> to use Curl.

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

<comment>See Also:</comment>
   * Curl
   * PHP streams
   * <class>OAuthException</class>


id: OAuth::setSSLChecks
type: function
doc:
<comment>Description:</comment>
  Tweak specific SSL checks for requests
  
  Tweak specific SSL checks for requests.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>int</info>  <strong>$sslcheck</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: OAuth::setTimestamp
type: function
doc:
<comment>Description:</comment>
  Set the timestamp
  
  Sets the OAuth timestamp for subsequent requests.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>string</info>  <strong>$timestamp</strong>  The timestamp.

<comment>Return:</comment>
  <info>mixed</info>  Returns <info>true</info>, unless the <strong>$timestamp</strong> is invalid, in which case <info>false</info> is returned.

<comment>See Also:</comment>
   * OAuth::setNonce


id: OAuth::setToken
type: function
doc:
<comment>Description:</comment>
  Sets the token and secret
  
  Set the token and secret for subsequent requests.

<comment>Param:</comment>
  <info>string</info>  <strong>$token</strong>         The OAuth token.
  <info>string</info>  <strong>$token_secret</strong>  The OAuth token secret.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>


id: OAuth::setVersion
type: function
doc:
<comment>Description:</comment>
  Set the OAuth version
  
  Sets the OAuth version for subsequent requests

<comment>Param:</comment>
  <info>string</info>  <strong>$version</strong>  OAuth version, default value is always "1.0"

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


id: OAuthException
type: class
doc:
<comment>Description:</comment>
  This exception is thrown when exceptional errors occur while using the OAuth extension and
  contains useful debugging information.


id: OAuthProvider
type: class
doc:
<comment>Description:</comment>
  Manages an OAuth provider class.
  
  See also an external in-depth tutorial titled Writing an OAuth Provider Service, which takes a
  hands-on approach to providing this service. There are also  OAuth provider examples within the
  OAuth extensions sources.


id: OAuthProvider::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new OAuthProvider object
  
  Initiates a new <class>OAuthProvider</class> <info>object</info>.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>array</info>  <strong>$params_array</strong>  Setting these optional parameters is limited to the CLI SAPI.

<comment>Return:</comment>
  <info>unknown</info>  An <class>OAuthProvider</class> <info>object</info>.

<comment>See Also:</comment>
   * OAuthProvider::setParam


id: OAuthProvider::addRequiredParameter
type: function
doc:
<comment>Description:</comment>
  Add required parameters
  
  Add required oauth provider parameters.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>string</info>  <strong>$req_params</strong>  The required parameters.

<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>
   * OAuthProvider::removeRequiredParameter


id: OAuthProvider::callTimestampNonceHandler
type: function
doc:
<comment>Description:</comment>
  Calls the timestampNonceHandler callback
  
  Calls the registered timestamp handler callback function, which is set with
  OAuthProvider::timestampNonceHandler.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

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

<comment>See Also:</comment>
   * OAuthProvider::timestampNonceHandler


id: OAuthProvider::callconsumerHandler
type: function
doc:
<comment>Description:</comment>
  Calls the consumerNonceHandler callback
  
  Calls the registered consumer handler callback function, which is set with
  OAuthProvider::consumerHandler.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

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

<comment>See Also:</comment>
   * OAuthProvider::consumerHandler


id: OAuthProvider::calltokenHandler
type: function
doc:
<comment>Description:</comment>
  Calls the tokenNonceHandler callback
  
  Calls the registered token handler callback function, which is set with
  OAuthProvider::tokenHandler.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

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

<comment>See Also:</comment>
   * OAuthProvider::tokenHandler


id: OAuthProvider::checkOAuthRequest
type: function
doc:
<comment>Description:</comment>
  Check an oauth request
  
  Checks an OAuth request.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>string</info>  <strong>$uri</strong>     The optional URI, or endpoint.
  <info>string</info>  <strong>$method</strong>  The HTTP method. Optionally pass in one of the  <info>OAUTH_HTTP_METHOD_*</info> OAuth
                   constants.

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

<comment>See Also:</comment>
   * OAuthProvider::reportProblem


id: OAuthProvider::consumerHandler
type: function
doc:
<comment>Description:</comment>
  Set the consumerHandler handler callback
  
  Sets the consumer handler callback, which will later be called with
  OAuthProvider::callConsumerHandler.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback_function</strong>  The <info>callable</info> functions name.

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

<comment>See Also:</comment>
   * OAuthProvider::callConsumerHandler


id: OAuthProvider::generateToken
type: function
doc:
<comment>Description:</comment>
  Generate a random token
  
  Generates a <info>string</info> of pseudo-random bytes.

<comment>Param:</comment>
  <info>int</info>   <strong>$size</strong>    The desired token length, in terms of bytes.
  <info>bool</info>  <strong>$strong</strong>  Setting to <info>true</info> means <return>/dev/random</return> will be used for entropy, as otherwise the
                 non-blocking <return>/dev/urandom</return> is used. This parameter is ignored on Windows.

<comment>Return:</comment>
  <info>string</info>  The generated token, as a <info>string</info> of bytes.

<comment>See Also:</comment>
   * <strong>openssl_random_pseudo_bytes()</strong>
   * <strong>mcrypt_create_iv()</strong>


id: OAuthProvider::is2LeggedEndpoint
type: function
doc:
<comment>Description:</comment>
  is2LeggedEndpoint
  
  The 2-legged flow, or request signing. It does not require a token.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$params_array</strong>  

<comment>Return:</comment>
  <info>void</info>  An <class>OAuthProvider</class> <info>object</info>.

<comment>See Also:</comment>
   * OAuthProvider::__construct


id: OAuthProvider::isRequestTokenEndpoint
type: function
doc:
<comment>Description:</comment>
  Sets isRequestTokenEndpoint
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>bool</info>  <strong>$will_issue_request_token</strong>  Sets whether or not it will issue a request token, thus
                                   determining if OAuthProvider::tokenHandler needs to be called.

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

<comment>See Also:</comment>
   * OAuthProvider::setRequestTokenPath
   * OAuthProvider::reportProblem


id: OAuthProvider::removeRequiredParameter
type: function
doc:
<comment>Description:</comment>
  Remove a required parameter
  
  Removes a required parameter.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>string</info>  <strong>$req_params</strong>  The required parameter to be removed.

<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>
   * OAuthProvider::setParam
   * OAuthProvider::addRequiredParameter


id: OAuthProvider::reportProblem
type: function
doc:
<comment>Description:</comment>
  Report a problem
  
  Pass in a problem as an <class>OAuthException</class>, with possible problems listed in the OAuth constants
  section.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>string</info>  <strong>$oauthexception</strong>  The <class>OAuthException</class>.

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

<comment>See Also:</comment>
   * OAuthProvider::checkOAuthRequest
   * OAuthProvider::isRequestTokenEndpoint


id: OAuthProvider::setParam
type: function
doc:
<comment>Description:</comment>
  Set a parameter
  
  Sets a parameter.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>string</info>  <strong>$param_key</strong>  The parameter key.
  <info>mixed</info>   <strong>$param_val</strong>  The optional parameter value.
                      
                      To exclude a parameter from signature verification, set its value to <info>null</info>.

<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>
   * OAuthProvider::addRequiredParameter


id: OAuthProvider::setRequestTokenPath
type: function
doc:
<comment>Description:</comment>
  Set request token path
  
  Sets the request tokens path.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  The path.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>

<comment>See Also:</comment>
   * OAuthProvider::tokenHandler


id: OAuthProvider::timestampNonceHandler
type: function
doc:
<comment>Description:</comment>
  Set the timestampNonceHandler handler callback
  
  Sets the timestamp nonce handler callback, which will later be called with
  OAuthProvider::callTimestampNonceHandler. Errors related to timestamp/nonce are thrown to this
  callback.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback_function</strong>  The <info>callable</info> functions name.

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

<comment>See Also:</comment>
   * OAuthProvider::callTimestampNonceHandler


id: OAuthProvider::tokenHandler
type: function
doc:
<comment>Description:</comment>
  Set the tokenHandler handler callback
  
  Sets the token handler callback, which will later be called with OAuthProvider::callTokenHandler.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback_function</strong>  The <info>callable</info> functions name.

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

<comment>See Also:</comment>
   * OAuthProvider::callTokenHandler


id: OCICollection
type: class
doc:
<comment>Description:</comment>
  OCI8 Collection functionality.
  
  The <class>OCI-Collection</class> class was renamed to <class>OCICollection</class> in PHP 8 OCI8 3.0.0 to align with PHP naming
  standards.


id: OCICollection::append
type: function
doc:
<comment>Description:</comment>
  Hängt ein Element an eine Sammlung
  
  Hängt ein Element ans Ende einer Sammlung.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  Der Wert, der der Sammlung hinzugefügt werden soll.

<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>
   * 


id: OCICollection::assign
type: function
doc:
<comment>Description:</comment>
  Weist einer Sammlung einen Wert aus einer anderen Sammlung zu
  
  Weist einer Sammlung den Wert einer vorher erstellten Sammlung zu. Beide Sammlungen müssen mit
  <strong>oci_new_collection()</strong> erstellt worden sein, bevor sie verwendet werden.

<comment>Param:</comment>
  <info>OCICollection</info>  <strong>$from</strong>  Eine Instanz einer OCI-Sammlung.

<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>
   * 


id: OCICollection::assignElem
type: function
doc:
<comment>Description:</comment>
  Weist einem Element einer Sammlung einen Wert zu
  
  Weist dem Element mit dem Index <strong>$index</strong> einen Wert zu.

<comment>Param:</comment>
  <info>int</info>     <strong>$index</strong>  Der Index des Elements. Der erste Index ist 0.
  <info>string</info>  <strong>$value</strong>  Kann eine Zeichenkette oder eine Zahl sein.

<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>
   * 


id: OCICollection::free
type: function
doc:
<comment>Description:</comment>
  Gibt die mit einem Sammelobjekt verknüpften Ressourcen frei
  
  Gibt die mit einem Sammelobjekt verknüpften Ressourcen frei.

<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>
   * 


id: OCICollection::getElem
type: function
doc:
<comment>Description:</comment>
  Liefert den Wert eines Elements
  
  Gibt den Wert des Elements mit dem Index <strong>$index</strong> (beginnend bei 0) zurück.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Der Index des Elements. Der erste Index ist 0.

<comment>Return:</comment>
  <info>string|float|null|false</info>  Gibt <info>false</info> zurück, wenn ein solches Element nicht existiert, <info>null</info>, wenn
                           das Element <info>null</info> ist, eine Zeichenkette, wenn das Element zu einer Spalte
                           vom Datentyp Zeichenkette gehört und eine Nummer, wenn das Element ein
                           numerisches Feld ist.

<comment>See Also:</comment>
   * 


id: OCICollection::max
type: function
doc:
<comment>Description:</comment>
  Liefert die maximale Anzahl der Elemente in einer Sammlung
  
  Gibt die maximale Anzahl der Elemente in einer Sammlung zurück.

<comment>Return:</comment>
  <info>int|false</info>  Gibt die maximale Anzahl als Integer zurück oder <info>false</info> bei Fehlern.
             
             Wenn der zurückgegebene Wert 0 ist, ist die Anzahl der Elemente nicht begrenzt.

<comment>See Also:</comment>
   * 


id: OCICollection::size
type: function
doc:
<comment>Description:</comment>
  Liefert die Größe der Sammlung
  
  Gibt die Größe der Sammlung zurück.

<comment>Return:</comment>
  <info>int|false</info>  Gibt die Anzahl Elemente der Sammlung zurück oder <info>false</info> bei einem Fehler.

<comment>See Also:</comment>
   * 


id: OCICollection::trim
type: function
doc:
<comment>Description:</comment>
  Entfernt Elemente vom Ende einer Sammlung
  
  Entfernt <strong>$num</strong> Elemente vom Ende einer Sammlung.

<comment>Param:</comment>
  <info>int</info>  <strong>$num</strong>  Die zu entfernende Anzahl Elemente.

<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>
   * 


id: OCILob
type: class
doc:
<comment>Description:</comment>
  OCI8 LOB functionality for large binary (BLOB) and character (CLOB) objects.
  
  The <class>OCI-Lob</class> class was renamed to <class>OCILob</class> in PHP 8 and PECL OCI8 3.0.0 to align with PHP naming
  standards.


id: OCILob::append
type: function
doc:
<comment>Description:</comment>
  Appends data from the large object to another large object
  
  Appends data from the large object to the end of another large object.
  
  Writing to the large object with this method will fail if buffering was previously enabled. You
  must disable buffering before appending. You may need to flush buffers with  before disabling
  buffering.

<comment>Param:</comment>
  <info>OCILob</info>  <strong>$from</strong>  The copied LOB.

<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>
   * 
   * 
   * 


id: OCILob::close
type: function
doc:
<comment>Description:</comment>
  Closes LOB descriptor
  
  Closes descriptor of LOB or FILE. This function should be used only with .

<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>
   * 


id: OCILob::eof
type: function
doc:
<comment>Description:</comment>
  Tests for end-of-file on a large object's descriptor
  
  Tells whether the internal pointer of large object is at the end of LOB.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if internal pointer of large object is at the end of LOB. Otherwise returns
        <info>false</info>.

<comment>See Also:</comment>
   * 


id: OCILob::erase
type: function
doc:
<comment>Description:</comment>
  Erases a specified portion of the internal LOB data
  
  Erases a specified portion of the internal LOB data starting at a specified <strong>$offset</strong>. If called
  without parameters, it erases all LOB data.
  
  For BLOBs, erasing means that the existing LOB value is overwritten with zero-bytes. For CLOBs,
  the existing LOB value is overwritten with spaces.

<comment>Param:</comment>
  <info>int|null</info>  <strong>$offset</strong>  
  <info>int|null</info>  <strong>$length</strong>  

<comment>Return:</comment>
  <info>int|false</info>  Returns the actual number of characters/bytes erased Bei einem Fehler wird <info>false</info>
             zurückgegeben..

<comment>See Also:</comment>
   * 


id: OCILob::export
type: function
doc:
<comment>Description:</comment>
  Exports LOB's contents to a file
  
  Exports LOB contents to a file.

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>  Path to the file.
  <info>int|null</info>  <strong>$offset</strong>    Indicates from where to start exporting.
  <info>int|null</info>  <strong>$length</strong>    Indicates the length of data to be exported.

<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>
   * 


id: OCILob::flush
type: function
doc:
<comment>Description:</comment>
  Flushes/writes buffer of the LOB to the server
  
  <strong>OCILob::flush()</strong> actually writes data to the server.

<comment>Param:</comment>
  <info>int</info>  <strong>$flag</strong>  By default, resources are not freed, but using flag  <info>OCI_LOB_BUFFER_FREE</info> you can do it
              explicitly. Be sure you know what you're doing - next read/write operation to the same
              part of LOB will involve a round-trip to the server and initialize new buffer
              resources. It is recommended to use  <info>OCI_LOB_BUFFER_FREE</info> flag only when you are not
              going to work with the LOB anymore.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.
        
        Returns <info>false</info> if buffering was not enabled or an error occurred.

<comment>See Also:</comment>
   * 
   * 


id: OCILob::free
type: function
doc:
<comment>Description:</comment>
  Frees resources associated with the LOB descriptor
  
  Frees resources associated with the descriptor, previously allocated with  <strong>oci_new_descriptor()</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: OCILob::getBuffering
type: function
doc:
<comment>Description:</comment>
  Returns current state of buffering for the large object
  
  Tells whether the buffering for the large object is on or off.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>false</info> if buffering for the large object is off and <info>true</info> if buffering is used.

<comment>See Also:</comment>
   * 


id: OCILob::import
type: function
doc:
<comment>Description:</comment>
  Imports file data to the LOB
  
  Writes data from the <strong>$filename</strong> in to the current position of large object.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Path to the file.

<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>
   * 
   * 


id: OCILob::load
type: function
doc:
<comment>Description:</comment>
  Returns large object's contents
  
  Returns large object's contents. As script execution is terminated when the memory_limit is
  reached, ensure that the LOB does not exceed this limit. In most cases it's recommended to use
  instead.

<comment>Return:</comment>
  <info>string|false</info>  Returns the contents of the object, or <info>false</info> on errors.

<comment>See Also:</comment>
   * 


id: OCILob::read
type: function
doc:
<comment>Description:</comment>
  Reads part of the large object
  
  Reads <strong>$length</strong> of bytes (BLOB) or characters (CLOB) from the current position of LOB's internal
  pointer.
  
  Reading stops when <strong>$length</strong> of bytes have been read for a BLOB, when <strong>$length</strong> of characters have
  been read for a CLOB, or when the end of the large object is reached. Internal pointer of the
  large object will be shifted on the amount of bytes/characters read.

<comment>Param:</comment>
  <info>int</info>  <strong>$length</strong>  The length of data to read, in bytes (BLOB) or characters (CLOB). Large values will
                be rounded down to 1 MB.

<comment>Return:</comment>
  <info>string|false</info>  Returns the contents as a string, Bei einem Fehler wird <info>false</info> zurückgegeben..

<comment>See Also:</comment>
   * 
   * 


id: OCILob::rewind
type: function
doc:
<comment>Description:</comment>
  Moves the internal pointer to the beginning of the large object
  
  Sets the internal pointer to the beginning of the large object.

<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>
   * 
   * 


id: OCILob::save
type: function
doc:
<comment>Description:</comment>
  Saves data to the large object
  
  Saves <strong>$data</strong> to the large object.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>    The data to be saved.
  <info>int</info>     <strong>$offset</strong>  Can be used to indicate offset from the beginning of the large object.

<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>
   * 
   * 


id: OCILob::saveFile
type: function
doc:
<comment>Description:</comment>
  Alias von OCILob::import
  
  Diese Funktion ist ein Alias für:  <strong>OCILob::import()</strong>.


id: OCILob::seek
type: function
doc:
<comment>Description:</comment>
  Sets the internal pointer of the large object
  
  Sets the internal pointer of the large object.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  Indicates the amount of bytes, on which internal pointer should be moved from the
                position, pointed by <strong>$whence</strong>.
  <info>int</info>  <strong>$whence</strong>  May be one of: <info>OCI_SEEK_SET</info> - sets the position equal to  <strong>$offset</strong> <info>OCI_SEEK_CUR</info> -
                adds <strong>$offset</strong>  bytes to the current position   <info>OCI_SEEK_END</info> - adds <strong>$offset</strong> bytes to
                the end of large object (use negative value to move to a position before the end of
                large object)

<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>
   * 
   * 
   * 


id: OCILob::setBuffering
type: function
doc:
<comment>Description:</comment>
  Changes current state of buffering for the large object
  
  Sets the buffering for the large object, depending on the value of the <strong>$mode</strong> parameter.
  
  Use of this function may provide performance improvements by buffering small reads and writes of
  LOBs by reducing the number of network round-trips and LOB versions.  <strong>OCILob::flush()</strong> should be
  used to flush buffers, when you have finished working with the large object.

<comment>Param:</comment>
  <info>bool</info>  <strong>$mode</strong>  <info>true</info> for on and <info>false</info> for off.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben. Repeated calls to
        this method with the same flag will return <info>true</info>.

<comment>See Also:</comment>
   * 


id: OCILob::size
type: function
doc:
<comment>Description:</comment>
  Returns size of large object
  
  Gets the size of the large object.

<comment>Return:</comment>
  <info>int|false</info>  Returns length of large object value Bei einem Fehler wird <info>false</info> zurückgegeben.. Empty
             objects have zero length.


id: OCILob::tell
type: function
doc:
<comment>Description:</comment>
  Returns the current position of internal pointer of large object
  
  Gets the current position of a LOB's internal pointer.

<comment>Return:</comment>
  <info>int|false</info>  Returns current position of a LOB's internal pointer or <info>false</info> if an error occurred.

<comment>See Also:</comment>
   * 
   * 
   * 


id: OCILob::truncate
type: function
doc:
<comment>Description:</comment>
  Truncates large object
  
  Truncates the LOB.

<comment>Param:</comment>
  <info>int</info>  <strong>$length</strong>  If provided, this method will truncate the LOB to <strong>$length</strong> bytes. Otherwise, it will
                completely purge the LOB.

<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>
   * 


id: OCILob::write
type: function
doc:
<comment>Description:</comment>
  Writes data to the large object
  
  Writes data from the parameter <strong>$data</strong> into the current position of LOB's internal pointer.

<comment>Param:</comment>
  <info>string</info>    <strong>$data</strong>    The data to write in the LOB.
  <info>int|null</info>  <strong>$length</strong>  If this parameter is an integer, writing will stop after <strong>$length</strong> bytes have
                     been written or the end of <strong>$data</strong> is reached, whichever comes first.

<comment>Return:</comment>
  <info>int|false</info>  Returns the number of bytes written Bei einem Fehler wird <info>false</info> zurückgegeben..

<comment>See Also:</comment>
   * 


id: OCILob::writeTemporary
type: function
doc:
<comment>Description:</comment>
  Writes a temporary large object
  
  Creates a temporary large object and writes <strong>$data</strong> to it.
  
  You should use  when you are done with this object.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The data to write.
  <info>int</info>     <strong>$type</strong>  Can be one of the following: <info>OCI_TEMP_BLOB</info> is used to create temporary BLOBs
                 <info>OCI_TEMP_CLOB</info> is used to create temporary CLOBs

<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>
   * 


id: OCILob::writeToFile
type: function
doc:
<comment>Description:</comment>
  Alias von OCILob::export
  
  Diese Funktion ist ein Alias für:  <strong>OCILob::export()</strong>.


id: OCI_ASSOC
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_fetch_all()</strong> and <strong>oci_fetch_array()</strong> to get results as an associative array.


id: OCI_BOTH
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_fetch_all()</strong> and <strong>oci_fetch_array()</strong> to get results as an array with both associative
  and number indices.


id: OCI_B_BFILE
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_bind_by_name()</strong> when binding BFILEs.


id: OCI_B_BIN
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_bind_by_name()</strong> to bind RAW values.


id: OCI_B_BLOB
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_bind_by_name()</strong> when binding BLOBs.


id: OCI_B_BOL
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_bind_by_name()</strong> to bind a PL/SQL BOOLEAN variable.


id: OCI_B_CFILEE
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_bind_by_name()</strong> when binding CFILEs.


id: OCI_B_CLOB
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_bind_by_name()</strong> when binding CLOBs.


id: OCI_B_CURSOR
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_bind_by_name()</strong> when binding cursors, previously allocated with <strong>oci_new_descriptor()</strong>.


id: OCI_B_INT
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_bind_array_by_name()</strong> to bind arrays of INTEGER.


id: OCI_B_NTY
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_bind_by_name()</strong> when binding named data types.


id: OCI_B_NUM
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_bind_array_by_name()</strong> to bind arrays of NUMBER.


id: OCI_B_ROWID
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_bind_by_name()</strong> when binding ROWIDs.


id: OCI_COMMIT_ON_SUCCESS
type: constant
doc:
<comment>Description:</comment>
  Statement execution mode for <strong>oci_execute()</strong> call. Automatically commit changes when the statement
  has succeeded.


id: OCI_CRED_EXT
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_connect()</strong> for using Oracles' External or OS authentication.


id: OCI_DESCRIBE_ONLY
type: constant
doc:
<comment>Description:</comment>
  Statement execution mode for <strong>oci_execute()</strong>.  Use this mode if you want meta data such as the
  column names but don't want to fetch rows from the query.


id: OCI_DTYPE_FILE
type: constant
doc:
<comment>Description:</comment>
  This flag tells <strong>oci_new_descriptor()</strong> to initialize a new FILE descriptor.


id: OCI_DTYPE_LOB
type: constant
doc:
<comment>Description:</comment>
  This flag tells <strong>oci_new_descriptor()</strong> to initialize a new LOB descriptor.


id: OCI_DTYPE_ROWID
type: constant
doc:
<comment>Description:</comment>
  This flag tells <strong>oci_new_descriptor()</strong> to initialize a new ROWID descriptor.


id: OCI_EXACT_FETCH
type: constant
doc:
<comment>Description:</comment>
  Obsolete. Statement fetch mode. Used when the application knows in advance exactly how many rows
  it will be fetching. This mode turns prefetching off for Oracle release 8 or later mode. The
  cursor is canceled after the desired rows are fetched which may result in reduced server-side
  resource usage.


id: OCI_NO_AUTO_COMMIT
type: constant
doc:
<comment>Description:</comment>
  Statement execution mode for <strong>oci_execute()</strong>. The transaction is not automatically committed when
  using this mode.  For readability in new code, use this value instead of the older, equivalent
  <info>OCI_DEFAULT</info> constant.


id: OCI_NUM
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_fetch_all()</strong> and <strong>oci_fetch_array()</strong> to get results as an enumerated array.


id: OCI_RETURN_LOBS
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_fetch_array()</strong> to get the data value of the LOB instead of the descriptor.


id: OCI_RETURN_NULLS
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_fetch_array()</strong> to get empty array elements if the row items value is <info>null</info>.


id: OCI_SYSDBA
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_connect()</strong> to connect with the SYSDBA privilege. The php.ini setting
  oci8.privileged_connect should be enabled to use this.


id: OCI_SYSOPER
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_connect()</strong> to connect with the SYSOPER privilege. The php.ini setting
  oci8.privileged_connect should be enabled to use this.


id: OPENSSL_ALGO_MD2
type: constant
doc:
<comment>Description:</comment>
  Diese Konstante ist nur verfügbar, wenn PHP mit MD2-Unterstützung kompiliert wurde. Dies erfordert
  die Übergabe des CFLAGs -DHAVE_OPENSSL_MD2_H, wenn PHP kompiliert wird, und enable-md2, wenn
  OpenSSL 1.0.0+ kompiliert wird.


id: OPENSSL_ALGO_SHA1
type: constant
doc:
<comment>Description:</comment>
  Wird als Standard-Algorithmus für die Funktionen <strong>openssl_sign()</strong> und <strong>openssl_verify()</strong> verwendet.


id: OPENSSL_CMS_BINARY
type: constant
doc:
<comment>Description:</comment>
  Normalerweise wird die Nachricht in ein "kanonisches" Format konvertiert, das effektiv <return>CR</return> und <return>LF</return>
  als Zeilende verwendet, wie von der CMS-Spezifikation gefordert. Wird diese Option angegeben,
  findet keine Konvertierung statt. Dies ist nützlich beim Umgang mit Binärdaten, die nicht im
  CMS-Format vorliegen.


id: OPENSSL_CMS_DETACHED
type: constant
doc:
<comment>Description:</comment>
  Beim Signieren einer Nachricht wird die Klartext-Signierung mit dem MIME-Typ <return>"multipart/signed"</return>
  verwendet. Das ist der Standard, wenn in <strong>$flags</strong> keine optionalen Parameter an die Funktion
  <strong>openssl_cms_sign()</strong> übergeben werden. Wenn Sie diese Option ausschalten, wird die Nachricht mit
  einer intransparenten Signatur unterzeichnet. Dieses Verhalten ist robuster gegenüber der
  Übersetzung durch Mail-Relays, kann aber nicht mit Mailprogrammen gelesen werden, die den
  S/Mime-Standard nicht unterstützen.


id: OPENSSL_CMS_NOATTR
type: constant
doc:
<comment>Description:</comment>
  Beim Signieren einer Nachricht wird normalerweise eine Reihe von Attributen mit angehängt. Diese
  enthalten die Zeit der Signierung und die unterstützen symmetrischen Algorithmen. Mit dieser
  Option werden diese Attribute nicht mit aufgenommen.


id: OPENSSL_CMS_NOCERTS
type: constant
doc:
<comment>Description:</comment>
  Beim Signieren einer Nachricht wird normalerweise das Zertifikat des Unterzeichnenden mit in die
  Nachricht aufgenommen. Mit dieser Option wird das Zertifikat nicht mit aufgenommen. Diese Option
  verringert die Größe der signierten Nachricht, aber der Überprüfende muss eine lokale Kopie des
  Zertifikats vom Unterzeichnenden besitzen (zum Beispiel durch Angabe des Parameters
  <strong>$untrusted_certificates_filename</strong> in der Funktion <strong>openssl_cms_verify()</strong>).


id: OPENSSL_CMS_NOINTERN
type: constant
doc:
<comment>Description:</comment>
  Beim Überprüfen einer Nachricht werden in der Nachricht enthaltene Zertifikate (falls vorhanden)
  nach dem Signatur-Zertifikat durchsucht. Mit dieser Option werden nur Zertifikate verwendet, die
  mit dem Parameter <strong>$untrusted_certificates_filename</strong> in der Funktion <strong>openssl_cms_verify()</strong> angegeben
  wurden. Die mitgelieferten Zertifikate können aber dennoch verwendet werden, allerdings als nicht
  vertrauenswürdige CAs.


id: OPENSSL_CMS_NOVERIFY
type: constant
doc:
<comment>Description:</comment>
  Das Zertifikat des Unterzeichners einer signierten Nachricht nicht überprüfen.


id: OPENSSL_CMS_OLDMIMETYPE
type: constant
doc:
<comment>Description:</comment>
  Verfügbar ab PHP 8.3.0. Setzt den Inhaltstyp auf <return>application/x-pkcs7-mime</return> anstelle von
  <return>application/pkcs7-mime</return>, um eine Nachricht zu verschlüsseln.


id: OPENSSL_CMS_TEXT
type: constant
doc:
<comment>Description:</comment>
  Fügt einer verschlüsselten/signierten Nachricht den Inhaltstyp-Header text/plain zu hinzu. Beim
  Entschlüsseln oder Überprüfen wird dieser Header aus der Ausgabe entfernt. Entspricht die
  entschlüsselte oder geprüfte Nachricht nicht dem MIME-Typ text/plain, tritt ein Fehler auf.


id: OPENSSL_ENCODING_DER
type: constant
doc:
<comment>Description:</comment>
  Gibt an, dass die Kodierung im DER-Format (Distinguished Encoding Rules) erfolgt.


id: OPENSSL_ENCODING_PEM
type: constant
doc:
<comment>Description:</comment>
  Gibt an, dass die Kodierung im PEM-Format (Privacy-Enhanced Mail) erfolgt.


id: OPENSSL_KEYTYPE_EC
type: constant
doc:
<comment>Description:</comment>
  Diese Konstante ist nur verfügbar, wenn PHP mit OpenSSL 0.9.8+ kompiliert wurde.


id: OPENSSL_RAW_DATA
type: constant
doc:
<comment>Description:</comment>
  Wenn <info>OPENSSL_RAW_DATA</info> in den Funktionen <strong>openssl_encrypt()</strong> oder <strong>openssl_decrypt()</strong> im Parameter
  <strong>$options</strong> angegeben ist, werden die Daten so zurückgegeben, wie sie sind. Ist es nicht angegeben,
  werden Base64-kodierte Daten an den Aufrufenden zurückgegeben.


id: OPENSSL_ZERO_PADDING
type: constant
doc:
<comment>Description:</comment>
  Standardmäßig wird bei Verschlüsselungsvorgängen mit Standard-Blockpadding aufgefüllt und das
  Padding wird beim Entschlüsseln geprüft und entfernt. Wenn <info>OPENSSL_ZERO_PADDING</info> in den Funktionen
  <strong>openssl_encrypt()</strong> oder <strong>openssl_decrypt()</strong> im Parameter <strong>$options</strong> angegeben ist, wird kein Padding
  durchgeführt und die Gesamtmenge der verschlüsselten oder entschlüsselten Daten muss ein
  Vielfaches der Blockgröße sein, sonst tritt ein Fehler auf.


id: OP_HALFOPEN
type: constant
doc:
<comment>Description:</comment>
  Verbindung aufbauen, aber noch kein Postfach öffnen (IMAP und NNTP)


id: OpenSSLAsymmetricKey
type: class
doc:
<comment>Description:</comment>
  A fully opaque class which replaces <return>OpenSSL key</return> resources as of PHP 8.0.0.


id: OpenSSLCertificate
type: class
doc:
<comment>Description:</comment>
  A fully opaque class which replaces <return>OpenSSL X.509</return> resources as of PHP 8.0.0.


id: OpenSSLCertificateSigningRequest
type: class
doc:
<comment>Description:</comment>
  A fully opaque class which replaces <return>OpenSSL X.509 CSR</return> resources as of PHP 8.0.0.


id: OuterIterator
type: class
doc:
<comment>Description:</comment>
  Classes implementing <class>OuterIterator</class> can be used to iterate over iterators.


id: OuterIterator::getInnerIterator
type: function
doc:
<comment>Description:</comment>
  Returns the inner iterator for the current entry
  
  Returns the inner iterator for the current iterator entry.

<comment>Return:</comment>
  <info>Iterator|null</info>  Returns the inner iterator for the current entry if it exists, or <info>null</info> otherwise.


id: PASSWORD_ARGON2I
type: constant
doc:
<comment>Description:</comment>
  <info>PASSWORD_ARGON2I</info> wird verwendet, um neue Passwort-Hashes unter Verwendung des Argon2i-Algorithmus
  zu erzeugen.
  
  Unterstützte Optionen:
  
  <return>memory_cost</return> (<info>int</info>) - die Obergrenze des Speichers (in Kibibytes), der verwendet werden darf, um den
  Argon2-Hash zu berechnen. Der Vorgabewert ist <info>PASSWORD_ARGON2_DEFAULT_MEMORY_COST</info>.
  
  <return>time_cost</return> (<info>int</info>) - die Höchstdauer der Berechnung des Argon2-Hashs. Der Vorgabewert ist
  <info>PASSWORD_ARGON2_DEFAULT_TIME_COST</info>.
  
  <return>threads</return> (<info>int</info>) - Die Anzahl der Threads, die für die Berechnung des Argon2-Hashs verwendet werden.
  Der Vorgabewert ist <info>PASSWORD_ARGON2_DEFAULT_THREADS</info>. Nur mit libargon2 verfügbar, nicht mit der
  libsodium-Implementierung.
  
  Verfügbar von PHP 7.2.0 an.


id: PASSWORD_ARGON2ID
type: constant
doc:
<comment>Description:</comment>
  <info>PASSWORD_ARGON2ID</info> wird verwendet, um neue Passwort-Hashes unter Verwendung des
  Argon2id-Algorithmus zu erzeugen. Es werden dieselben Optionen wie bei <info>PASSWORD_ARGON2I</info>
  unterstützt.
  
  Verfügbar von PHP 7.3.0 an.


id: PASSWORD_ARGON2_DEFAULT_MEMORY_COST
type: constant
doc:
<comment>Description:</comment>
  Der Vorgabewert des Speichers in Bytes, der beim Versuch, den Hash zu berechnen, verwenden wird.
  
  Verfügbar von PHP 7.2.0 an.


id: PASSWORD_ARGON2_DEFAULT_THREADS
type: constant
doc:
<comment>Description:</comment>
  Der Vorgabewert der Anzahl Threads, die Argon2lib verwenden wird.
  
  Verfügbar von PHP 7.2.0 an.


id: PASSWORD_ARGON2_DEFAULT_TIME_COST
type: constant
doc:
<comment>Description:</comment>
  Der Vorgabewert der Dauer, die beim Versuch, den Hash zu berechnen, verwenden wird.
  
  Verfügbar von PHP 7.2.0 an.


id: PASSWORD_BCRYPT
type: constant
doc:
<comment>Description:</comment>
  <info>PASSWORD_BCRYPT</info> wird verwendet, um neue Passwort-Hashes unter Verwendung des <info>CRYPT_BLOWFISH</info>
  Algorithmus zu erzeugen.
  
  Dies ergibt immer einen Hash, der das "$2y$"-Crypt-Format verwendet und immer 60 Zeichen lang ist.
  
  Unterstützte Optionen:
  
  <return>salt</return> (<info>string</info>) - um manuell ein Salt anzugeben, das beim Hashing des Passworts verwendet wird. Es
  ist zu beachten, dass dies die automatische Erzeugung des Salt verhindert.
  
  Wird diese Option ausgelassen, dann wird von <strong>password_hash()</strong> ein zufälliges Salt für jedes
  gehashte Passwort erzeugt. Dies ist die vorgesehene Funktionsweise, und von PHP 7.0.0 an wird die
  salt-Option missbilligt.
  
  <return>cost</return> (<info>int</info>) - bezeichnet den algorithmischen Aufwand, der angewendet werden soll. Beispiele dieses
  Wertes können der <strong>crypt()</strong>-Dokumentation entnommen werden.
  
  Wird diese Option ausgelassen, dann wird der Standardwert <return>10</return> verwendet. Das ist eine gute
  Ausgangsbasis, aber es ist zu erwägen, diesen Wert in Abhängigkeit von der Hardware zu erhöhen.


id: PASSWORD_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  Der Vorgabewert des Algorithmus, der für das Hashing verwendet wird, wenn kein Algorithmus
  angegeben wird. Dies kann sich in neueren PHP-Releases ändern, wenn neuere, stärkere
  Hash-Algorithmen unterstützt werden.
  
  Es ist zu betonen, dass sich diese Konstante im Lauf der Zeit ändern kann (und vermutlich wird).
  Daher ist zu beachten, dass sich die Länge des resultierenden Hashs ändern kann. Also sollte bei
  Verwendung von <info>PASSWORD_DEFAULT</info> der sich ergebende Hash so gespeichert werden, dass er mehr als 60
  Zeichen lang sein kann (255 ist die empfohlene Länge).
  
  Werte dieser Konstante:
  
  PHP 5.5.0 - <info>PASSWORD_BCRYPT</info>


id: PATH_SEPARATOR
type: constant
doc:
<comment>Description:</comment>
  Strichpunkt bei Windows Systemen, Doppelpunkt bei UNIX basierten.


id: PCRE_VERSION
type: constant
doc:
<comment>Description:</comment>
  Die PCRE-Version und das Freigabedatum (z. B. "<return>7.0 18-Dec-2006</return>").
  
  5.2.4


id: PDO
type: class
doc:
<comment>Description:</comment>
  Repräsentiert eine Verbindung zwischen PHP und einem Datenbankserver.


id: PDO::ATTR_AUTOCOMMIT
type: constant
doc:
<comment>Description:</comment>
  Wenn dieser Wert <info>false</info> ist, versucht PDO, Autocommit zu deaktivieren, damit die Verbindung eine
  Transaktion starten kann.


id: PDO::ATTR_CASE
type: constant
doc:
<comment>Description:</comment>
  Erzwingt die Zuordnung von Spaltennamen zur Groß- oder Kleinschreibung, die durch die
  <return>PDO::CASE_*</return>-Konstanten festgelegt wird.


id: PDO::ATTR_CLIENT_VERSION
type: constant
doc:
<comment>Description:</comment>
  Dieses Attribut ist schreibgeschützt; es gibt Informationen über die Versionen der
  Client-Bibliotheken zurück, die der PDO-Treiber verwendet.


id: PDO::ATTR_CURSOR
type: constant
doc:
<comment>Description:</comment>
  Wählt den Cursortyp aus. PDO unterstützt derzeit entweder <info>PDO::CURSOR_FWDONLY</info> oder
  <info>PDO::CURSOR_SCROLL</info>. Bleiben Sie bei <info>PDO::CURSOR_FWDONLY</info>, es sei denn, Sie wissen, dass Sie einen
  scrollbaren Cursor benötigen.


id: PDO::ATTR_CURSOR_NAME
type: constant
doc:
<comment>Description:</comment>
  Liefert oder setzt den Namen, der für einen Cursor verwendet werden soll. Am nützlichsten bei der
  Verwendung von scrollbaren Cursorn und positionierten Aktualisierungen.


id: PDO::ATTR_DEFAULT_STR_PARAM
type: constant
doc:
<comment>Description:</comment>
  Legt den Standard-Zeichenketten-Parametertypen fest; entweder <info>PDO::PARAM_STR_NATL</info> oder
  <info>PDO::PARAM_STR_CHAR</info>.
  
  Verfügbar seit PHP 7.2.0.


id: PDO::ATTR_DRIVER_NAME
type: constant
doc:
<comment>Description:</comment>
  Gibt den Namen des Treibers zurück.
  
  Die Verwendung von <info>PDO::ATTR_DRIVER_NAME</info>getAttribute(PDO::ATTR_DRIVER_NAME) == 'mysql') { echo
  "Läuft auf MySQL; macht hier etwas MySQL-spezifisches\n";
  }
  ?>
  ]]>


id: PDO::ATTR_ERRMODE
type: constant
doc:
<comment>Description:</comment>
  Informationen zu diesem Attribut finden Sie im Abschnitt Fehler und Fehlerbehandlung.


id: PDO::ATTR_FETCH_CATALOG_NAMES
type: constant
doc:
<comment>Description:</comment>
  Stellt jedem Spaltennamen, der in der Ergebnismenge zurückgegeben wird, den Namen des enthaltenden
  Katalogs voran. Der Katalogname und der Spaltenname werden durch einen Punkt (.) getrennt. Die
  Unterstützung dieses Attributs liegt auf der Treiberebene; es kann sein, dass es von Ihrem Treiber
  nicht unterstützt wird.


id: PDO::ATTR_FETCH_TABLE_NAMES
type: constant
doc:
<comment>Description:</comment>
  Stellt jedem Spaltennamen, der in der Ergebnismenge zurückgegeben wird, den Namen der enthaltenden
  Tabelle voran. Der Tabellenname und der Spaltenname werden durch einen Punkt (.) getrennt. Die
  Unterstützung dieses Attributs liegt auf der Treiberebene; es kann sein, dass es von Ihrem Treiber
  nicht unterstützt wird.


id: PDO::ATTR_ORACLE_NULLS
type: constant
doc:
<comment>Description:</comment>
  Konvertiert leere Zeichenketten bei Datenabfragen in SQL-NULL-Werte.


id: PDO::ATTR_PERSISTENT
type: constant
doc:
<comment>Description:</comment>
  Fordert eine persistente Verbindung an, anstatt eine neue Verbindung zu erstellen. Weitere
  Informationen zu diesem Attribut finden Sie im Abschnitt Verbindungen und Verbindungsmanagement.


id: PDO::ATTR_PREFETCH
type: constant
doc:
<comment>Description:</comment>
  Durch Ändern der Prefetch-Puffergröße können Sie die Balance zwischen Speicherverbrauch und
  Datenbankgeschwindigkeit einstellen. Nicht alle Datenbank/Treiber-Kombinationen unterstützen die
  Größenänderung dieses Puffers. Je größer der Puffer ist, desto höher ist die Leistung, aber auch
  der Speicherverbrauch.


id: PDO::ATTR_SERVER_INFO
type: constant
doc:
<comment>Description:</comment>
  Dieses Attribut ist schreibgeschützt; es gibt einige Metainformationen über den Datenbankserver
  zurück, mit dem PDO verbunden ist.


id: PDO::ATTR_SERVER_VERSION
type: constant
doc:
<comment>Description:</comment>
  Dieses Attribut ist schreibgeschützt; es gibt Informationen über die Version des Datenbankservers
  zurück, mit dem PDO verbunden ist.


id: PDO::ATTR_STATEMENT_CLASS
type: constant
doc:
<comment>Description:</comment>
  Legt den Name der Klasse fest, die als Statement zurückgegeben wird.


id: PDO::ATTR_TIMEOUT
type: constant
doc:
<comment>Description:</comment>
  Legt den Timeout-Wert für die Kommunikation mit der Datenbank in Sekunden fest.


id: PDO::CASE_NATURAL
type: constant
doc:
<comment>Description:</comment>
  Belässt die Spaltennamen so, wie sie vom Datenbanktreiber zurückgegeben werden.


id: PDO::CURSOR_FWDONLY
type: constant
doc:
<comment>Description:</comment>
  Erzeugt ein <class>PDOStatement</class>-Objekt mit einem Nur-Vorwärts-Cursor. Dies ist die Standard-Cursor-Wahl,
  da es das schnellste und häufigste Datenzugriffsmuster in PHP ist.


id: PDO::CURSOR_SCROLL
type: constant
doc:
<comment>Description:</comment>
  Erzeugt ein <class>PDOStatement</class>-Objekt mit einem scrollbaren Cursor. Übergeben Sie die Konstante
  <return>PDO::FETCH_ORI_*</return>, um die aus der Ergebnismenge abgerufenen Zeilen zu steuern.


id: PDO::ERRMODE_EXCEPTION
type: constant
doc:
<comment>Description:</comment>
  Löst eine <class>PDOException</class> aus, wenn ein Fehler auftritt. Weitere Informationen zu diesem Attribut
  finden Sie im Abschnitt Fehler und Fehlerbehandlung.


id: PDO::ERRMODE_SILENT
type: constant
doc:
<comment>Description:</comment>
  Löst keinen Fehler und keine Ausnahme aus, wenn ein Fehler auftritt. Es wird erwartet, dass der
  Entwickler explizit auf Fehler prüft. Dies ist der Standardmodus. Weitere Informationen zu diesem
  Attribut finden Sie im Abschnitt Fehler und Fehlerbehandlung.


id: PDO::ERRMODE_WARNING
type: constant
doc:
<comment>Description:</comment>
  Gibt eine PHP-<info>E_WARNING</info>-Meldung aus, wenn ein Fehler auftritt. Weitere Informationen zu diesem
  Attribut finden Sie im Abschnitt Fehler und Fehlerbehandlung.


id: PDO::ERR_NONE
type: constant
doc:
<comment>Description:</comment>
  Entspricht dem SQLSTATE '00000', d. h. die SQL-Anweisung wurde erfolgreich und ohne Fehler oder
  Warnungen ausgegeben. Diese Konstante ist für die Unterstützung bei der Überprüfung von
  PDO::errorCode oder PDOStatement::errorCode, um festzustellen, ob ein Fehler aufgetreten ist.
  Normalerweise wissen Sie sowieso, ob dies der Fall ist, indem Sie den Rückgabewert der Methode
  untersuchen, die die Fehlerbedingung ausgelöst hat.


id: PDO::FETCH_ASSOC
type: constant
doc:
<comment>Description:</comment>
  Legt fest, dass die Methode zum Abrufen von Daten jede Zeile in einem assoziativen Array
  zurückgibt, das mit den Spaltennamen aus der Ergebnismenge indiziert wird. Wenn die Ergebnismenge
  mehrere gleichlautende Spaltennamen enthält, gibt <info>PDO::FETCH_ASSOC</info> nur einen Wert pro Spaltenname
  zurück.


id: PDO::FETCH_BOTH
type: constant
doc:
<comment>Description:</comment>
  Legt fest, dass die Methode zum Abrufen von Daten jede Zeile als Array zurückgeben soll, das durch
  den Spaltennamen und die Spaltennummer indiziert ist, wie sie in der entsprechenden Ergebnismenge
  zurückgegeben werden, beginnend bei Spalte 0.


id: PDO::FETCH_BOUND
type: constant
doc:
<comment>Description:</comment>
  Legt fest, dass die Methode zum Abrufen von Daten TRUE zurückgeben soll und die Werte der Spalten
  in der Ergebnismenge den PHP-Variablen zuweist, an die sie mit der Methode PDOStatement::bindParam
  oder der Methode PDOStatement::bindColumn gebunden wurden.


id: PDO::FETCH_CLASS
type: constant
doc:
<comment>Description:</comment>
  Legt fest, dass die Methode zum Abrufen von Daten eine neue Instanz der angeforderten Klasse
  zurückgeben soll, die die Spalten den benannten Eigenschaften der Klasse zuordnet.
  
  Die magische Methode __set wird aufgerufen, wenn die Eigenschaft in der angeforderten Klasse nicht
  vorhanden ist


id: PDO::FETCH_COLUMN
type: constant
doc:
<comment>Description:</comment>
  Legt fest, dass die Methode zum Abrufen von Daten nur eine einzige angeforderte Spalte aus der
  nächsten Zeile in der Ergebnismenge zurückgeben soll.


id: PDO::FETCH_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  Legt fest, dass der standardmäßige Abrufmodus verwendet werden soll. Verfügbar seit PHP 8.0.7.


id: PDO::FETCH_FUNC
type: constant
doc:
<comment>Description:</comment>
  Ermöglicht die ad-hoc Anpassung der Daten (nur gültig innerhalb von PDOStatement::fetchAll).


id: PDO::FETCH_GROUP
type: constant
doc:
<comment>Description:</comment>
  Gruppiert die Rückgabe nach den Werten. Üblicherweise in Verbindung mit <info>PDO::FETCH_COLUMN</info> oder
  <info>PDO::FETCH_KEY_PAIR</info>.


id: PDO::FETCH_INTO
type: constant
doc:
<comment>Description:</comment>
  Legt fest, dass die Methode zum Abrufen von Daten eine vorhandene Instanz der angeforderten Klasse
  aktualisieren soll, indem die Spalten den benannten Eigenschaften der Klasse zugeordnet werden.


id: PDO::FETCH_KEY_PAIR
type: constant
doc:
<comment>Description:</comment>
  Liefert das Ergebnis von zwei Spalten als Array. Der Inhalt der ersten Spalte ist der Schlüssel
  und der Inhalt der zweiten Spalte ist der Wert.


id: PDO::FETCH_LAZY
type: constant
doc:
<comment>Description:</comment>
  Legt fest, dass die Methode zum Abrufen von Daten jede Zeile als eigenständiges Objekt mit
  variablem Namen zurückgeben soll, welcher gleichlautend mit den Spaltennamen in der Ergebnismenge
  ist. <info>PDO::FETCH_LAZY</info> erstellt die variablen Objektnamen, sobald auf diese zugegriffen wird.
  Ungültig innerhalb von PDOStatement::fetchAll.


id: PDO::FETCH_NAMED
type: constant
doc:
<comment>Description:</comment>
  Legt fest, dass die Methode zum Abrufen von Daten jede Zeile als ein Array mit dem Index des
  Spaltennamens der entsprechenden Ergebnismenge zurückgeben soll. Wenn die Ergebnismenge mehrere
  Spalten mit dem gleichen Namen besitzt, gibt <info>PDO::FETCH_NAMED</info> ein Array von Werten pro Spaltenname
  zurück.


id: PDO::FETCH_NUM
type: constant
doc:
<comment>Description:</comment>
  Legt fest, dass die Methode zum Abrufen von Daten jede Zeile als Array zurückgeben soll, indiziert
  durch die Spaltennummer, wie sie in der entsprechenden Ergebnismenge zurückgegeben wird, beginnend
  bei Spalte 0.


id: PDO::FETCH_OBJ
type: constant
doc:
<comment>Description:</comment>
  Legt fest, dass die Methode zum Abrufen von Daten jede Zeile als ein Objekt mit Eigenschaftsnamen
  zurückgeben soll, die den in der Ergebnismenge zurückgegebenen Spaltennamen entsprechen.


id: PDO::FETCH_ORI_ABS
type: constant
doc:
<comment>Description:</comment>
  Liefert die angeforderte Zeile anhand der Zeilennummer aus der Ergebnismenge. Gilt nur für
  scrollbare Cursor.


id: PDO::FETCH_ORI_FIRST
type: constant
doc:
<comment>Description:</comment>
  Liefert die erste Zeile aus der Ergebnismenge. Gilt nur für scrollbare Cursor.


id: PDO::FETCH_ORI_LAST
type: constant
doc:
<comment>Description:</comment>
  Liefert die vorherige Zeile aus der Ergebnismenge. Gilt nur für scrollbare Cursor.


id: PDO::FETCH_ORI_NEXT
type: constant
doc:
<comment>Description:</comment>
  Liefert die nächste Zeile aus der Ergebnismenge. Gilt nur für scrollbare Cursor.


id: PDO::FETCH_ORI_REL
type: constant
doc:
<comment>Description:</comment>
  Liefert die angeforderte Zeile an einer Position relativ zur aktuellen Position des Cursors aus
  der Ergebnismenge. Gilt nur für scrollbare Cursor.


id: PDO::FETCH_SERIALIZE
type: constant
doc:
<comment>Description:</comment>
  Ähnlich wie <info>PDO::FETCH_INTO</info>, liefert aber das Objekt als serialisierte Zeichenkette. Der
  Konstruktor wird nicht aufgerufen, wenn dieses Flag gesetzt ist. Ab PHP 8.1.0 veraltet.


id: PDO::MYSQL_ATTR_DIRECT_QUERY
type: constant
doc:
<comment>Description:</comment>
  Abfragen direkt ausführen, keine vorbereiteten Anweisungen verwenden.


id: PDO::MYSQL_ATTR_FOUND_ROWS
type: constant
doc:
<comment>Description:</comment>
  Die Anzahl der gefundenen (übereinstimmenden) Zeilen zurückgeben, nicht die Anzahl der geänderten
  Zeilen.


id: PDO::MYSQL_ATTR_IGNORE_SPACE
type: constant
doc:
<comment>Description:</comment>
  Leerzeichen nach Funktionsnamen zulassen; macht alle Funktionsnamen zu reservierten Wörtern.


id: PDO::MYSQL_ATTR_INIT_COMMAND
type: constant
doc:
<comment>Description:</comment>
  Der Befehl, der ausgeführt werden soll, wenn eine Verbindung zum MySQL-Server aufgebaut wird. Wird
  beim erneuten Verbindungsaufbau automatisch wieder ausgeführt.
  
  Es ist zu beachten, dass diese Konstante nur im Array <strong>$driver_options</strong> verwendet werden kann, wenn
  ein neues Datenbank-Handle erstellt wird.


id: PDO::MYSQL_ATTR_LOCAL_INFILE
type: constant
doc:
<comment>Description:</comment>
  Aktiviert <return>Load LOCAL INFILE</return>.
  
  Es ist zu beachten, dass diese Konstante nur im Array <strong>$driver_options</strong> verwendet werden kann, wenn
  ein neues Datenbank-Handle erstellt wird.


id: PDO::MYSQL_ATTR_LOCAL_INFILE_DIRECTORY
type: constant
doc:
<comment>Description:</comment>
  Ermöglicht es, das Laden von LOCAL DATA auf Dateien zu beschränken, die sich im angegebenen
  Verzeichnis befinden. Verfügbar ab PHP 8.1.0.
  
  Es ist zu beachten, dass diese Konstante nur im Array <strong>$driver_options</strong> verwendet werden kann, wenn
  ein neues Datenbank-Handle erstellt wird.


id: PDO::MYSQL_ATTR_MAX_BUFFER_SIZE
type: constant
doc:
<comment>Description:</comment>
  Die maximale Puffergröße. Der Standardwert ist 1 MiB. Diese Konstante wird nicht unterstützt, wenn
  gegen mysqlnd kompiliert wird.


id: PDO::MYSQL_ATTR_MULTI_STATEMENTS
type: constant
doc:
<comment>Description:</comment>
  Wenn auf <info>false</info> gesetzt, wird die Ausführung von Mehrfachabfragen sowohl bei <strong>PDO::prepare()</strong> als
  auch bei <strong>PDO::query()</strong> deaktiviert.
  
  Es ist zu beachten, dass diese Konstante nur im Array <strong>$driver_options</strong> verwendet werden kann, wenn
  ein neues Datenbank-Handle erstellt wird.


id: PDO::MYSQL_ATTR_READ_DEFAULT_FILE
type: constant
doc:
<comment>Description:</comment>
  Die Optionen aus der genannten Optionsdatei lesen, statt aus my.cnf. Diese Option ist nicht
  verfügbar, wenn mysqlnd verwendet wird, weil mysqlnd die mysql-Konfigurationsdateien nicht liest.


id: PDO::MYSQL_ATTR_READ_DEFAULT_GROUP
type: constant
doc:
<comment>Description:</comment>
  Die Optionen der genannten Gruppe aus my.cnf oder der mit <info>MYSQL_READ_DEFAULT_FILE</info> angegebenen
  Datei lesen. Diese Option ist nicht verfügbar, wenn mysqlnd verwendet wird, weil mysqlnd die
  mysql-Konfigurationsdateien nicht liest.


id: PDO::MYSQL_ATTR_SSL_CAPATH
type: constant
doc:
<comment>Description:</comment>
  Der Pfad zum Verzeichnis, das die im PEM-Format gespeicherten vertrauenswürdigen SSL-Zertifikate
  der Zertifizierungsstelle (CA) enthält.


id: PDO::MYSQL_ATTR_SSL_CIPHER
type: constant
doc:
<comment>Description:</comment>
  Eine Liste von einer oder mehreren zulässigen Chiffren, die für die SSL-Verschlüsselung zu
  verwenden sind, in einem Format, das von OpenSSL verstanden wird, z. B.
  <return>DHE-RSA-AES256-SHA:AES128-SHA</return>


id: PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT
type: constant
doc:
<comment>Description:</comment>
  Bietet die Möglichkeit, die Überprüfung des SSL-Zertifikats des Servers zu deaktivieren.
  
  Dies existiert seit PHP  7.0.18 und PHP 7.1.4.


id: PDO::MYSQL_ATTR_USE_BUFFERED_QUERY
type: constant
doc:
<comment>Description:</comment>
  In der Voreinstellung werden alle Anweisungen im gepufferten Modus ausgeführt. Wenn dieses
  Attribut bei einem <class>PDO</class>-Objekt auf <info>false</info> gesetzt ist, verwendet der MySQL-Treiber den ungepufferten
  Modus.
  
  Den ungepufferten Modus von MySQL aktivierensetAttribute(PDO::MYSQL_ATTR_USE_BUFFERED_QUERY,
  false);
  
  $unbufferedResult = $pdo->query("SELECT Name FROM City");
  foreach ($unbufferedResult as $row) { echo $row['Name'] . PHP_EOL;
  }
  ?>
  ]]>


id: PDO::OCI_ATTR_ACTION
type: constant
doc:
<comment>Description:</comment>
  Provides a way to specify the action on the database session.
  
  Dies existiert seit PHP  7.2.16 and 7.3.3


id: PDO::OCI_ATTR_CLIENT_IDENTIFIER
type: constant
doc:
<comment>Description:</comment>
  Provides a way to specify the client identifier on the database session.
  
  Dies existiert seit PHP  7.2.16 and 7.3.3


id: PDO::OCI_ATTR_CLIENT_INFO
type: constant
doc:
<comment>Description:</comment>
  Provides a way to specify the client info on the database session.
  
  Dies existiert seit PHP  7.2.16 and 7.3.3


id: PDO::OCI_ATTR_MODULE
type: constant
doc:
<comment>Description:</comment>
  Provides a way to specify the module on the database session.
  
  Dies existiert seit PHP  7.2.16 and 7.3.3


id: PDO::ODBC_ATTR_ASSUME_UTF8
type: constant
doc:
<comment>Description:</comment>
  Windows only. If <info>true</info>, UTF-16 encoded character data (<return>CHAR</return>, <return>VARCHAR</return> and <return>LONGVARCHAR</return>) is converted
  to UTF-8 when reading from or writing data to the database. If <info>false</info> (the default), character
  encoding conversion may be done by the driver.


id: PDO::ODBC_ATTR_USE_CURSOR_LIBRARY
type: constant
doc:
<comment>Description:</comment>
  This option controls whether the ODBC cursor library is used. The ODBC cursor library supports
  some advanced ODBC features (e.g. block scrollable cursors), which may not be implemented by the
  driver. The following values are supported: <info>PDO::ODBC_SQL_USE_IF_NEEDED</info> (the default): use the
  ODBC cursor library when needed. <info>PDO::ODBC_SQL_USE_DRIVER</info>: never use the ODBC cursor library.
  <info>PDO::ODBC_SQL_USE_ODBC</info>: always use the ODBC cursor library.
  
  <info>PDO::ODBC_SQL_USE_IF_NEEDED</info> (the default): use the ODBC cursor library when needed.
  
  <info>PDO::ODBC_SQL_USE_DRIVER</info>: never use the ODBC cursor library.
  
  <info>PDO::ODBC_SQL_USE_ODBC</info>: always use the ODBC cursor library.


id: PDO::PARAM_EVT_EXEC_POST
type: constant
doc:
<comment>Description:</comment>
  Löst ein Ereignis nach der Ausführung einer vorbereiteten Anweisung aus.


id: PDO::PARAM_EVT_EXEC_PRE
type: constant
doc:
<comment>Description:</comment>
  Löst ein Ereignis vor der Ausführung einer vorbereiteten Anweisung aus.


id: PDO::PARAM_EVT_FETCH_POST
type: constant
doc:
<comment>Description:</comment>
  Löst ein Ereignis nach dem Abrufen eines Ergebnisses aus einer Ergebnismenge aus.


id: PDO::PARAM_EVT_FETCH_PRE
type: constant
doc:
<comment>Description:</comment>
  Löst ein Ereignis vor dem Abrufen eines Ergebnisses aus einer Ergebnismenge aus.


id: PDO::PARAM_EVT_NORMALIZE
type: constant
doc:
<comment>Description:</comment>
  Löst ein Ereignis während der Registrierung eines gebundenen Parameters aus, was es dem Treiber
  ermöglicht, den Parameternamen zu normalisieren.


id: PDO::PARAM_INPUT_OUTPUT
type: constant
doc:
<comment>Description:</comment>
  Legt fest, dass der Parameter ein INOUT-Parameter für eine Stored Procedure sein muss. Auf den
  Wert muss ein bitweises OR mit einem eindeutigen PDO::PARAM_*-Parameter ausgeführt werden.


id: PDO::PARAM_STMT
type: constant
doc:
<comment>Description:</comment>
  Stellt einen Datensatztyp dar. Wird derzeit von keinem Treiber unterstützt.


id: PDO::PARAM_STR_CHAR
type: constant
doc:
<comment>Description:</comment>
  Ein Flag, das angibt, dass eine Zeichenkette den regulären Zeichensatz verwendet.
  
  Verfügbar seit PHP 7.2.0


id: PDO::PARAM_STR_NATL
type: constant
doc:
<comment>Description:</comment>
  Ein Flag, das angibt, dass eine Zeichenkette den nationalen Zeichensatz verwendet.
  
  Verfügbar seit PHP 7.2.0


id: PDO::PGSQL_ATTR_DISABLE_PREPARES
type: constant
doc:
<comment>Description:</comment>
  Send the query and the parameters to the server together in a single call, avoiding the need to
  create a named prepared statement separately. If the query is only going to be executed once this
  can reduce latency by avoiding an unnecessary server round-trip.


id: PDO::SQLITE_DETERMINISTIC
type: constant
doc:
<comment>Description:</comment>
  Signalisiert, dass eine Funktion die mit PDO::sqliteCreateFunction erzeugt wurde, deterministisch
  ist, d. h. dass sie immer dasselbe Ergebnis liefert, wenn sie innerhalb derselben SQL-Anweisung
  mit den gleichen Parametern aufgerufen wird. (Verfügbar seit PHP 7.1.4.)


id: PDO::SQLSRV_ATTR_DIRECT_QUERY
type: constant
doc:
<comment>Description:</comment>
  Indicates that a query should be executed directly, without being prepared.  This constant can be
  passed to PDO::setAttribute, and PDO::prepare. For more  information, see  Direct and Prepared
  Statement Execution.


id: PDO::SQLSRV_ATTR_QUERY_TIMEOUT
type: constant
doc:
<comment>Description:</comment>
  A non-negative integer representing the timeout period, in seconds. Zero (0)  is the default and
  means no timeout. This constant can be passed to  PDOStatement::setAttribute, PDO::setAttribute,
  and PDO::prepare.


id: PDO::SQLSRV_ENCODING_BINARY
type: constant
doc:
<comment>Description:</comment>
  Specifies that data is sent/retrieved as a raw byte stream to/from the server  without performing
  encoding or translation. This constant can be passed to  PDOStatement::setAttribute, PDO::prepare,
  PDOStatement::bindColumn, and  PDOStatement::bindParam.


id: PDO::SQLSRV_ENCODING_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  Specifies that data is sent/retrieved to/from the server according to  PDO::SQLSRV_ENCODING_SYSTEM
  if specified during connection. The connection's  encoding is used if specified in a prepare
  statement. This constant can be  passed to PDOStatement::setAttribute, PDO::setAttribute,
  PDO::prepare,  PDOStatement::bindColumn, and PDOStatement::bindParam.


id: PDO::SQLSRV_ENCODING_SYSTEM
type: constant
doc:
<comment>Description:</comment>
  Specifies that data is sent/retrieved to/from the server as 8-bit characters  as specified in the
  code page of the Windows locale that is set on the system.  Any multi-byte characters or
  characters that do not map into this code page  are substituted with a single byte question mark
  (?) character. This constant  can be passed to PDOStatement::setAttribute, PDO::setAttribute,
  PDO::prepare,  PDOStatement::bindColumn, and PDOStatement::bindParam.


id: PDO::SQLSRV_ENCODING_UTF8
type: constant
doc:
<comment>Description:</comment>
  Specifies that data is sent/retrieved to/from the server in UTF-8 encoding.  This is the default
  encoding. This constant can be passed to  PDOStatement::setAttribute, PDO::setAttribute,
  PDO::prepare,  PDOStatement::bindColumn, and PDOStatement::bindParam.


id: PDO::SQLSRV_TXN_READ_COMMITTED
type: constant
doc:
<comment>Description:</comment>
  This constant is an acceptable value for the SQLSRV DSN key TransactionIsolation.  This constant
  sets the transaction isolation level for the connection to  Read Committed.


id: PDO::SQLSRV_TXN_READ_UNCOMMITTED
type: constant
doc:
<comment>Description:</comment>
  This constant is an acceptable value for the SQLSRV DSN key TransactionIsolation.  This constant
  sets the transaction isolation level for the connection to  Read Uncommitted.


id: PDO::SQLSRV_TXN_REPEATABLE_READ
type: constant
doc:
<comment>Description:</comment>
  This constant is an acceptable value for the SQLSRV DSN key TransactionIsolation.  This constant
  sets the transaction isolation level for the connection to  Repeateable Read.


id: PDO::SQLSRV_TXN_SERIALIZABLE
type: constant
doc:
<comment>Description:</comment>
  This constant is an acceptable value for the SQLSRV DSN key TransactionIsolation.  This constant
  sets the transaction isolation level for the connection to  Serializable.


id: PDO::SQLSRV_TXN_SNAPSHOT
type: constant
doc:
<comment>Description:</comment>
  This constant is an acceptable value for the SQLSRV DSN key TransactionIsolation.  This constant
  sets the transaction isolation level for the connection to Snapshot.


id: PDO::__construct
type: function
doc:
<comment>Description:</comment>
  Erzeugt eine PDO-Instanz, die eine Datenbankverbindung darstellt
    
  
  Erzeugt eine PDO-Instanz, die eine Verbindung zur angegebenen Datenbank darstellt.

<comment>Param:</comment>
  <info>string</info>       <strong>$dsn</strong>       Der Name der Datenquelle (Data Source Name oder DSN) enthält die
                          Informationen, die für die Verbindung mit der Datenbank erforderlich sind.
                          
                          Im Allgemeinen besteht ein DSN aus dem Namen des PDO-Treibers, gefolgt von
                          einem Doppelpunkt, gefolgt von der treiberspezifischen
                          PDO-Verbindungssyntax. Weitere Informationen sind in der Dokumentation des
                          betreffenden PDO-Treibers zu finden.
                          
                          Der Parameter <strong>$dsn</strong> unterstützt drei verschiedene Methoden, die für eine
                          Datenbankverbindung benötigten Argumente anzugeben:
                          
                          Aufrufen eines Treibers<strong>$dsn</strong> enthält den vollständigen DSN. Aufrufen eines
                          URIs<strong>$dsn</strong> besteht aus uri:, gefolgt von einem URI, der den Ort der Datei
                          mit der DSN-Zeichenkette definiert. Der URI kann eine lokale Datei oder
                          eine entfernte URL angeben. uri:file:///pfad/zur/dsndateiÜber einen
                          Alias<strong>$dsn</strong> besteht aus einem Namen <strong>$name</strong>, der auf pdo.dsn.<strong>$name</strong> in der
                          php.ini abgebildet wird, das die DSN-Zeichenkette definiert.  Der Alias
                          muss in der php.ini definiert werden, nicht in der .htaccess oder der
                          httpd.conf
                          
                          <strong>$dsn</strong> enthält den vollständigen DSN.
                          
                          <strong>$dsn</strong> besteht aus uri:, gefolgt von einem URI, der den Ort der Datei mit
                          der DSN-Zeichenkette definiert. Der URI kann eine lokale Datei oder eine
                          entfernte URL angeben.
                          
                          uri:file:///pfad/zur/dsndatei
                          
                          <strong>$dsn</strong> besteht aus einem Namen <strong>$name</strong>, der auf pdo.dsn.<strong>$name</strong> in der php.ini
                          abgebildet wird, das die DSN-Zeichenkette definiert.
                          
                          Der Alias muss in der php.ini definiert werden, nicht in der .htaccess
                          oder der httpd.conf
  <info>string</info>       <strong>$dsn</strong>       <strong>$dsn</strong> enthält den vollständigen DSN.
  <info>string</info>       <strong>$dsn</strong>       <strong>$dsn</strong> besteht aus uri:, gefolgt von einem URI, der den Ort der Datei mit
                          der DSN-Zeichenkette definiert. Der URI kann eine lokale Datei oder eine
                          entfernte URL angeben.
                          
                          uri:file:///pfad/zur/dsndatei
  <info>string</info>       <strong>$dsn</strong>       <strong>$dsn</strong> besteht aus einem Namen <strong>$name</strong>, der auf pdo.dsn.<strong>$name</strong> in der php.ini
                          abgebildet wird, das die DSN-Zeichenkette definiert.
                          
                          Der Alias muss in der php.ini definiert werden, nicht in der .htaccess
                          oder der httpd.conf
  <info>string|null</info>  <strong>$username</strong>  Der Benutzername für die DSN-Zeichenkette. Dieser Parameter ist bei
                          einigen PDO-Treibern optional.
  <info>string|null</info>  <strong>$password</strong>  Das Passwort für die DSN-Zeichenkette. Dieser Parameter ist bei einigen
                          PDO-Treibern optional.
  <info>array|null</info>   <strong>$options</strong>   Ein Schlüssel=&gt;Wert-Array mit treiberspezifischen Verbindungsoptionen.


id: PDO::beginTransaction
type: function
doc:
<comment>Description:</comment>
  Startet eine Transaktion
  
  Deaktiviert den Autocommit-Modus. Wenn der Autocommit-Modus deaktiviert ist, werden Änderungen,
  die über die Instanz eines PDO-Objekts an der Datenbank vorgenommen werden, erst dann bestätigt,
  wenn die Transaktion durch den Aufruf von PDO::commit beendet wird. Wenn PDO::rollBack aufgerufen
  wird, werden alle Änderungen an der Datenbank rückgängig gemacht und die Verbindung wird wieder in
  den Autocommit-Modus versetzt.
  
  Einige Datenbanken, darunter auch MySQL, führen automatisch ein implizites COMMIT durch, wenn
  innerhalb einer Transaktion eine DDL- (Database Definition Language) Anweisung wie DROP TABLE oder
  CREATE TABLE ausgeführt wird. Durch das implizite COMMIT wird verhindert, dass andere Änderungen,
  die in dieser Transaktion vorgenommen wurden, rückgängig gemacht werden können.

<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>
   * PDO::commit
   * PDO::rollBack
   * Transaktionen und Autocommit


id: PDO::commit
type: function
doc:
<comment>Description:</comment>
  Bestätigt eine Transaktion
  
  Bestätigt eine Transaktion und versetzt die Datenbankverbindung wieder zurück in den
  Autocommit-Modus, bis mittels PDO::beginTransaction eine neue Transaktion gestartet wird.

<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>
   * PDO::beginTransaction
   * PDO::rollBack
   * Transaktionen und Autocommit


id: PDO::cubrid_schema
type: function
doc:
<comment>Description:</comment>
  Get the requested schema information
  
  This function is used to get the requested schema information from database. You have to designate
  <strong>$table_name</strong>, if you want to get information on certain table, <strong>$col_name</strong>, if you want to get
  information on certain column (can be used only with PDO::CUBRID_SCH_COL_PRIVILEGE).
  
  The result of this function is returned as a two-dimensional array (column (associative array) *
  row (numeric array)). The following tables shows types of schema and the column structure of the
  result array to be returned based on the schema type.
  
  Result Composition of Each TypeSchemaColumn NumberColumn
  NameValuePDO::CUBRID_SCH_TABLE1NAME2TYPE0:system table 1:view
  2:tablePDO::CUBRID_SCH_VIEW1NAME2TYPE1:viewPDO::CUBRID_SCH_QUERY_SPEC1QUERY_SPECPDO::CUBRID_SCH_ATTRIBUTE
  / PDO::CUBRID_SCH_TABLE_ATTRIBUTE1ATTR_NAME2DOMAIN3SCALE4PRECISION5INDEXED1:indexed6NOT NULL1:not
  null7SHARED1:shared8UNIQUE1:unique9DEFAULT10ATTR_ORDERbase:111CLASS_NAME12SOURCE_CLASS13IS_KEY1:keyPDO::CUBRID_SCH_METHOD
  /
  PDO::CUBRID_SCH_TABLE_METHOD1NAME2RET_DOMAIN3ARG_DOMAINPDO::CUBRID_SCH_METHOD_FILE1METHOD_FILEPDO::CUBRID_SCH_SUPER_TABLE
  / PDO::CUBRID_SCH_DIRECT_SUPER_TABLE / PDO::CUBRID_SCH_SUB_TABLE1CLASS_NAME2TYPE0:system table
  1:view 2:tablePDO::CUBRID_SCH_CONSTRAINT1TYPE0:unique 1:index 2:reverse unique 3:reverse
  index2NAME3ATTR_NAME4NUM_PAGES5NUM_KEYS6PRIMARY_KEY1:primary
  key7KEY_ORDERbase:1PDO::CUBRID_SCH_TRIGGER1NAME2STATUS3EVENT4TARGET_CLASS5TARGET_ATTR6ACTION_TIME7ACTION8PRIORITY9CONDITION_TIME10CONDITIONPDO::CUBRID_SCH_TABLE_PRIVILEGE
  / PDO::CUBRID_SCH_COL_PRIVILEGE1CLASS_NAME /
  ATTR_NAME2PRIVILEGE3GRANTABLEPDO::CUBRID_SCH_PRIMARY_KEY1CLASS_NAME2ATTR_NAME3KEY_SEQbase:14KEY_NAMEPDO::CUBRID_SCH_IMPORTED_KEYS
  / PDO::CUBRID_SCH_EXPORTED_KEYS /
  PDO::CUBRID_SCH_CROSS_REFERENCE1PKTABLE_NAME2PKCOLUMN_NAME3FKTABLE_NAMEbase:14FKCOLUMN_NAME5KEY_SEQbase:16UPDATE_ACTION0:cascade
  1:restrict 2:no action 3:set null7DELETE_ACTION0:cascade 1:restrict 2:no action 3:set
  null8FK_NAME9PK_NAME

<comment>Param:</comment>
  <info>int</info>     <strong>$schema_type</strong>  Schema type that you want to know.
  <info>string</info>  <strong>$table_name</strong>   Table you want to know the schema of.
  <info>string</info>  <strong>$col_name</strong>     Column you want to know the schema of.

<comment>Return:</comment>
  <info>array</info>  Array containing the schema information, when process is successful;
         
         FALSE, when process is unsuccessful


id: PDO::errorCode
type: function
doc:
<comment>Description:</comment>
  Ruft den SQLSTATE-Code ab, der mit der letzten Operation über das
     Datenbank-Handle verknüpft ist

<comment>Return:</comment>
  <info>string|null</info>  Gibt einen SQLSTATE zurück, eine fünfstellige alphanumerische Kennung, die im ANSI
               SQL-92-Standard definiert ist. Kurz gesagt besteht ein SQLSTATE aus einem
               zweistelligen Klassenwert, gefolgt von einem dreistelligen Unterklassenwert. Ein
               Klassenwert von 01 steht für eine Warnung und wird vom Rückgabewert
               SQL_SUCCESS_WITH_INFO begleitet. Alle anderen Klassenwerte mit Ausnahme der Klasse
               "IM" weisen auf einen Fehler hin. Die Klasse "IM" ist spezifisch für Warnungen und
               Fehler, die sich aus der Implementierung von PDO (oder ODBC, wenn der ODBC-Treiber
               verwendet wird) selbst ergeben. Der Unterklassenwert "000" in einer Klasse zeigt an,
               dass es keine Unterklasse für diesen SQLSTATE gibt.
               
               PDO::errorCode ruft Fehlercodes nur bei Operationen ab, die direkt auf dem
               Datenbank-Handle ausgeführt werden. Wenn ein PDOStatement-Objekt mittels PDO::prepare
               oder PDO::query erzeugt wird und ein Fehler auf dem Anweisungs-Handle auftritt, zeigt
               PDO::errorCode diesen Fehler nicht an. Um den Fehlercode einer Operation zu erhalten,
               die mit einem bestimmten Anweisungs-Handle durchgeführt wurde, muss
               PDOStatement::errorCode aufgerufen werden.
               
               Gibt <info>null</info> zurück, wenn keine Operation über das Datenbank-Handle ausgeführt wurde.

<comment>See Also:</comment>
   * PDO::errorInfo
   * PDOStatement::errorCode
   * PDOStatement::errorInfo


id: PDO::errorInfo
type: function
doc:
<comment>Description:</comment>
  Ruft die erweiterten Fehlerinformationen ab, die mit der letzten Operation
     über das Datenbank-Handle verknüpft sind

<comment>Return:</comment>
  <info>array</info>  PDO::errorInfo gibt ein Array mit Informationen über den Fehler zurück, der bei der letzten
         über dieses Datenbank-Handle durchgeführte Operation aufgetreten ist. Das Array besteht
         mindestens aus den folgenden Feldern: ElementInformation0 SQLSTATE-Fehlercode (eine
         fünfstellige alphanumerische Kennung, die im ANSI-SQL-Standard definiert ist)
         1Treiberspezifischer Fehlercode2Treiberspezifische Fehlermeldung
         
         Wenn kein SQLSTATE-Fehlercode definiert ist oder kein treiberspezifischer Fehler vorliegt,
         werden die auf Element 0 folgenden Elemente auf <info>null</info> gesetzt.
         
         PDO::errorInfo ruft Informationen über Fehler nur bei Operationen ab, die direkt über das
         Datenbank-Handle ausgeführt werden. Wenn ein PDOStatement-Objekt mittels PDO::prepare oder
         PDO::query erzeugt wird und ein Fehler auf dem Anweisungs-Handle auftritt, zeigt
         PDO::errorInfo diesen Fehler nicht an. Um Informationen über den Fehler einer Operation zu
         erhalten, die über ein bestimmtes Anweisungs-Handle durchgeführt wurde, muss
         PDOStatement::errorInfo aufgerufen werden.

<comment>See Also:</comment>
   * PDO::errorCode
   * PDOStatement::errorCode
   * PDOStatement::errorInfo


id: PDO::exec
type: function
doc:
<comment>Description:</comment>
  Führt ein SQL-Statement aus und liefert die Anzahl der betroffenen Zeilen
    
  
  PDO::exec führt ein SQL-Statement aus und gibt die Anzahl der betroffenen Zeilen zurück.
  
  PDO::exec gibt nicht die Ergebnisse eines SELECT-Statements zurück. Um diese zu erhalten kann
  entweder PDO::query genutzt werden, oder ein ein PDOStatement, welches über PDO::prepare erstellt
  und über PDOStatement::execute ausgeführt wird.

<comment>Param:</comment>
  <info>string</info>  <strong>$statement</strong>  Das SQL-Statement, welches ausgeführt werden soll.
                      
                      Alle Usereingaben in diesem Query müssen maskiert werden.

<comment>Return:</comment>
  <info>int|false</info>  PDO::exec gibt die Anzahl von Zeilen zurück, welche durch diese Abfrage geändert oder
             gelöscht wurden. Wenn keine Zeilen geändert wurden, gibt PDO::exec <return>0</return> zurück.
             
             Diese Funktion kann sowohl das
             boolsche <info>false</info> zurückliefern, als auch einen nicht-boolschen Wert, welcher zu <info>false</info>
             ausgewertet wird.
             Weitere Informationen entnehmen Sie bitte dem Abschnitt über die
              boolschen Typen. Benutzen Sie deshalb
             den === Operator,
             um den Rückgabewert dieser Funktion zu überprüfen.
             
             Das folgende Beispiel verlässt sich fälschlicherweise auf den Rückgabewert von
             PDO::exec, weswegen ein Statement, welches 0 Zeilen ändert, einen Aufruf von <strong>die()</strong> nach
             sich zieht: exec() or die(print_r($db->errorInfo(), true)); // unrichtig
             ?>
             ]]>

<comment>See Also:</comment>
   * PDO::prepare
   * PDO::query
   * PDOStatement::execute


id: PDO::getAttribute
type: function
doc:
<comment>Description:</comment>
  Ruft ein Attribut einer Datenbankverbindung ab
  
  Diese Funktion gibt den Wert eines Attributs einer Datenbankverbindung zurück. Um
  PDOStatement-Attribute abzurufen, siehe PDOStatement::getAttribute.
  
  Es ist zu beachten, dass einige Kombinationen von Datenbanken und Treibern möglicherweise nicht
  alle Attribute der Datenbankverbindung unterstützen.

<comment>Param:</comment>
  <info>int</info>  <strong>$attribute</strong>  Eine der <return>PDO::ATTR_*</return>-Konstanten. Die folgenden generischen Attribute gelten für
                   Datenbankverbindungen:
                   <info>PDO::ATTR_AUTOCOMMIT</info><info>PDO::ATTR_CASE</info><info>PDO::ATTR_CLIENT_VERSION</info><info>PDO::ATTR_CONNECTION_STATUS</info><info>PDO::ATTR_DRIVER_NAME</info><info>PDO::ATTR_ERRMODE</info><info>PDO::ATTR_ORACLE_NULLS</info><info>PDO::ATTR_PERSISTENT</info><info>PDO::ATTR_PREFETCH</info><info>PDO::ATTR_SERVER_INFO</info><info>PDO::ATTR_SERVER_VERSION</info><info>PDO::ATTR_TIMEOUT</info>
                   
                   Es ist zu beachten, dass einige Treiber möglicherweise zusätzliche
                   treiberspezifische Attribute verwenden, die nicht mit anderen Treibern verwendet
                   werden dürfen.

<comment>Return:</comment>
  <info>mixed</info>  Gibt bei Erfolg den Wert des angeforderten PDO-Attributs zurück. Wenn der Aufruf
         fehlschlägt, wird <return>null</return> zurückgegeben.

<comment>See Also:</comment>
   * PDO::setAttribute
   * PDOStatement::getAttribute
   * PDOStatement::setAttribute


id: PDO::getAvailableDrivers
type: function
doc:
<comment>Description:</comment>
  Liefert ein Array mit den verfügbaren PDO-Treibern
  
  Diese Funktion gibt alle aktuell verfügbaren PDO-Treiber zurück, die bei der Methode
  PDO::__construct im Parameter <strong>$DSN</strong> verwendet werden können.

<comment>Return:</comment>
  <info>array</info>  PDO::getAvailableDrivers gibt ein Array mit den Namen der PDO-Treiber zurück. Wenn keine
         Treiber verfügbar sind, wird ein leeres Array zurückgegeben.


id: PDO::inTransaction
type: function
doc:
<comment>Description:</comment>
  Prüft, ob es eine offene Transaktion gibt
  
  Prüft, ob gerade eine Transaktion innerhalb des Treibers aktiv ist. Diese Methode funktioniert nur
  bei Datenbanktreibern, die Transaktionen unterstützen.

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn es eine aktive Transaktion gibt, und <info>false</info> wenn nicht.


id: PDO::lastInsertId
type: function
doc:
<comment>Description:</comment>
  Liefert die ID der zuletzt eingefügten Zeile oder den Wert der zuletzt
     eingefügten Sequenz
    
  
  Gibt je nach zugrundeliegendem Treiber die ID der zuletzt eingefügten Zeile oder den letzten Wert
  eines Sequenzobjekts zurück. Beispielsweise erlaubt PDO_PGSQL, für den Parameter <strong>$name</strong> den Namen
  eines beliebigen Sequenzobjekts anzugeben.
  
  Es ist möglich, dass diese Methode bei verschiedenen PDO-Treibern nicht zu einem sinnvollen oder
  konsistenten Ergebnis führt, da die zugrundeliegende Datenbank unter Umständen nicht einmal das
  Konzept der automatischen Inkrementierung von Feldern oder Sequenzen unterstützt.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$name</strong>  Der Name des Sequenzobjekts, dessen ID zurückgegeben werden soll.

<comment>Return:</comment>
  <info>string|false</info>  Wenn für den Parameter <strong>$name</strong> kein Sequenzname angegeben wurde, gibt
                PDO::lastInsertId eine Zeichenkette zurück, die die Zeilen-ID der zuletzt in die
                Datenbank eingefügten Zeile darstellt.
                
                Wenn für den Parameter <strong>$name</strong> ein Sequenzname angegeben wurde, gibt PDO::lastInsertId
                eine Zeichenkette zurück, die den zuletzt aus dem angegebenen Sequenzobjekt
                abgerufenen Wert darstellt.
                
                Wenn der PDO-Treiber diese Funktionalität nicht unterstützt, löst PDO::lastInsertId
                den SQLSTATE <return>IM001</return> aus.


id: PDO::pgsqlCopyFromArray
type: function
doc:
<comment>Description:</comment>
  Copy data from PHP array into table
  
  Copies data from <strong>$rows</strong> array to table <strong>$table_name</strong> using <strong>$delimiter</strong> as fields delimiter and <strong>$fields</strong>
  list

<comment>Param:</comment>
  <info>string</info>  <strong>$table_name</strong>  String containing table name
  <info>array</info>   <strong>$rows</strong>        Array of strings with fields separated by <strong>$delimiter</strong>
  <info>string</info>  <strong>$delimiter</strong>   Delimiter used in <strong>$rows</strong> array
  <info>string</info>  <strong>$null_as</strong>     How to interpret null values
  <info>string</info>  <strong>$fields</strong>      List of fields to insert

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success,Bei einem Fehler wird <info>false</info> zurückgegeben..


id: PDO::pgsqlCopyFromFile
type: function
doc:
<comment>Description:</comment>
  Copy data from file into table
  
  Copies data from file specified by <strong>$filename</strong> into table <strong>$table_name</strong> using <strong>$delimiter</strong> as fields
  delimiter and <strong>$fields</strong> list

<comment>Param:</comment>
  <info>string</info>  <strong>$table_name</strong>  String containing table name
  <info>string</info>  <strong>$filename</strong>    Filename containing data to import
  <info>string</info>  <strong>$delimiter</strong>   Delimiter used in file specified by <strong>$filename</strong>
  <info>string</info>  <strong>$null_as</strong>     How to interpret null values
  <info>string</info>  <strong>$fields</strong>      List of fields to insert

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success,Bei einem Fehler wird <info>false</info> zurückgegeben..


id: PDO::pgsqlCopyToArray
type: function
doc:
<comment>Description:</comment>
  Copy data from database table into PHP array
  
  Copies data from <strong>$table</strong> into array using <strong>$delimiter</strong> as fields delimiter and <strong>$fields</strong> list

<comment>Param:</comment>
  <info>string</info>  <strong>$table_name</strong>  String containing table name
  <info>string</info>  <strong>$delimiter</strong>   Delimiter used in rows
  <info>string</info>  <strong>$null_as</strong>     How to interpret null values
  <info>string</info>  <strong>$fields</strong>      List of fields to export

<comment>Return:</comment>
  <info>array|false</info>  Returns an array of rows,Bei einem Fehler wird <info>false</info> zurückgegeben..


id: PDO::pgsqlCopyToFile
type: function
doc:
<comment>Description:</comment>
  Copy data from table into file
  
  Copies data from table into file specified by <strong>$filename</strong> using <strong>$delimiter</strong> as fields delimiter and
  <strong>$fields</strong> list

<comment>Param:</comment>
  <info>string</info>  <strong>$table_name</strong>  String containing table name
  <info>string</info>  <strong>$filename</strong>    Filename to export data
  <info>string</info>  <strong>$delimiter</strong>   Delimiter used in file specified by <strong>$filename</strong>
  <info>string</info>  <strong>$null_as</strong>     How to interpret null values
  <info>string</info>  <strong>$fields</strong>      List of fields to insert

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success,Bei einem Fehler wird <info>false</info> zurückgegeben..


id: PDO::pgsqlGetNotify
type: function
doc:
<comment>Description:</comment>
  Get asynchronous notification
  
  Returns a result set representing a pending asynchronous notification.

<comment>Param:</comment>
  <info>int</info>  <strong>$result_type</strong>  The format the result set should be returned as, represented as a <info>PDO::FETCH_*</info>
                     constant.
  <info>int</info>  <strong>$ms_timeout</strong>   The length of time to wait for a response, in milliseconds.

<comment>Return:</comment>
  <info>array|false</info>  If one or more notifications is pending, returns a single row, with fields <return>message</return>
               and <return>pid</return>, otherwise returns <info>false</info>.


id: PDO::pgsqlGetPid
type: function
doc:
<comment>Description:</comment>
  Get the server PID
  
  Returns the server's PID.

<comment>Return:</comment>
  <info>int</info>  The server's PID.


id: PDO::pgsqlLOBCreate
type: function
doc:
<comment>Description:</comment>
  Creates a new large object
  
  <strong>PDO::pgsqlLOBCreate()</strong> creates a large object and returns the OID of that object.  You may then
  open a stream on the object using <strong>PDO::pgsqlLOBOpen()</strong> to read or write data to it.  The OID can be
  stored in columns of type OID and be used to reference the large object, without causing the row
  to grow arbitrarily large. The large object will continue to live in the database until it is
  removed by calling <strong>PDO::pgsqlLOBUnlink()</strong>.
  
  Large objects can be up to 2GB in size, but are cumbersome to use; you need to ensure that
  <strong>PDO::pgsqlLOBUnlink()</strong> is called prior to deleting the last row that references its OID from your
  database. In addition, large objects have no access controls.  As an alternative, try the bytea
  column type; recent versions of PostgreSQL allow bytea columns of up to 1GB in size and
  transparently manage the storage for optimal row size.
  
  This function must be called within a transaction.

<comment>Return:</comment>
  <info>string</info>  Returns the OID of the newly created large object on success, or <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>PDO::pgsqlLOBOpen()</strong>
   * <strong>PDO::pgsqlLOBUnlink()</strong>
   * <strong>pg_lo_create()</strong>


id: PDO::pgsqlLOBOpen
type: function
doc:
<comment>Description:</comment>
  Opens an existing large object stream
  
  <strong>PDO::pgsqlLOBOpen()</strong> opens a stream to access the data referenced by <strong>$oid</strong>.  If <strong>$mode</strong> is <return>r</return>, the
  stream is opened for reading, if <strong>$mode</strong> is <return>w</return>, then the stream will be opened for writing.  You can
  use all the usual filesystem functions, such as <strong>fread()</strong>, <strong>fwrite()</strong> and <strong>fgets()</strong> to manipulate the
  contents of the stream.
  
  This function, and all manipulations of the large object, must be called and carried out within a
  transaction.

<comment>Param:</comment>
  <info>string</info>  <strong>$oid</strong>   A large object identifier.
  <info>string</info>  <strong>$mode</strong>  If mode is <return>r</return>, open the stream for reading. If mode is <return>w</return>, open the stream for
                 writing.

<comment>Return:</comment>
  <info>resource|false</info>  Returns a stream resource on successBei einem Fehler wird <info>false</info> zurückgegeben..

<comment>See Also:</comment>
   * <strong>PDO::pgsqlLOBCreate()</strong>
   * <strong>PDO::pgsqlLOBUnlink()</strong>
   * <strong>pg_lo_open()</strong>


id: PDO::pgsqlLOBUnlink
type: function
doc:
<comment>Description:</comment>
  Deletes the large object
  
  Deletes a large object from the database identified by OID.
  
  This function must be called within a transaction.

<comment>Param:</comment>
  <info>string</info>  <strong>$oid</strong>  A large object identifier

<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>PDO::pgsqlLOBOpen()</strong>
   * <strong>PDO::pgsqlLOBCreate()</strong>


id: PDO::prepare
type: function
doc:
<comment>Description:</comment>
  Bereitet eine Anweisung zur Ausführung vor und liefert ein Anweisungsobjekt
    
  
  Bereitet eine SQL-Anweisung vor, die von der Methode PDOStatement::execute ausgeführt werden soll.
  Die Vorlage für eine Anweisung kann null oder mehr benannte (:name) oder mit Fragezeichen (?)
  versehene Platzhalter für Parameter enthalten, die bei der Ausführung der Anweisung durch reale
  Werte ersetzt werden. Benannte und Fragezeichen-Parameter dürfen nicht gleichzeitig in derselben
  Anweisungsvorlage verwendet werden, sondern nur eine der beiden Varianten. Diese Parameter werden
  verwendet, um die Benutzereingaben zu binden. Benutzerangaben sollten niemals direkt in die
  Abfrage aufgenommen werden.
  
  Für jeden Wert, der beim Aufruf von PDOStatement::execute an die Anweisung übergeben werden soll,
  muss ein eindeutiger Platzhalter angegeben werden. Ein benannter Platzhalter darf nur dann
  mehrfach verwendet werden, wenn der Emulationsmodus aktiviert ist.
  
  Die Platzhalter für die Parameter können nur ein vollständiges Datenliteral darstellen. Es ist
  nicht möglich, einen Teil eines Literals, ein Schlüsselwort, einen Bezeichner oder einen
  beliebigen Teil einer Abfrage an einen Parameter zu binden. So können zum Beispiel in einer
  IN()-Klausel einer SQL-Anweisung nicht mehrere Werte an einen einzigen Parameter gebunden werden.
  
  Mittels PDO::prepare und PDOStatement::execute kann der Treiber bei Anweisungen, die mehrfach mit
  unterschiedlichen Parameterwerten ausgeführt werden, die Leistung einer Anwendung optimieren,
  indem er die Zwischenspeicherung des Abfrageplans und der Metainformationen auf Client- und/oder
  Serverseite aushandelt. Außerdem trägt dies dazu bei, Angriffe durch SQL-Injection zu verhindern,
  weil die Parameter nicht mehr manuell maskiert und in Anführungszeichen gesetzt werden müssen.
  
  Bei Treibern, die diese nicht unterstützen, emuliert PDO vorbereitete Anweisungen/gebundene
  Parameter und kann außerdem benannte oder mit Fragezeichen versehene Parametermarkierungen in eine
  geeignetere Form umwandeln, wenn der Treiber zwar die eine, nicht aber die andere Form
  unterstützt.
  
  Der Parser, der für emulierte vorbereitete Anweisungen verwendet wird und die benannten oder durch
  Fragezeichen angegebenen Parameter umschreibt, unterstützt die nicht standardmäßige Maskierung
  einfacher und doppelter Anführungszeichen durch Backslashes. Dies hat zur Folge, dass
  abschließende Anführungszeichen, denen ein Backslash unmittelbar vorausgeht, nicht als solche
  erkannt werden, was dazu führen kann, dass Parameter falsch erkannt werden und die vorbereitete
  Anweisung bei ihrer Ausführung fehlschlägt. Um dies zu umgehen, sollten für solche SQL-Abfragen
  keine emulierten vorbereiteten Anweisungen verwendet werden. Außerdem sollte ein vom Treiber nativ
  unterstützter Parameterstil verwendet werden, um ein Umschreiben der Parameter zu vermeiden.
  
  Seit PHP 7.4.0 können Fragezeichen durch Verdoppeln maskiert werden. Das bedeutet, dass die
  Zeichenkette <return>??</return> beim Senden der Abfrage an die Datenbank in <return>?</return> übersetzt wird.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>    Dies muss eine für den jeweiligen Datenbankserver gültige Vorlage für eine
                    SQL-Anweisung sein.
  <info>array</info>   <strong>$options</strong>  Dieses Array enthält ein oder mehrere Schlüssel=&gt;Wert-Paare, um die Werte der
                    Attribute des von dieser Methode zurückgegebenen PDOStatement-Objekts zu setzen.
                    Am häufigsten wird dies verwendet, um den Wert von <info>PDO::ATTR_CURSOR</info> für einen
                    scrollbaren Cursor auf <info>PDO::CURSOR_SCROLL</info> zu setzen. Einige Treiber haben
                    treiberspezifische Optionen, die während der Vorbereitung gesetzt werden können.

<comment>Return:</comment>
  <info>PDOStatement|false</info>  Wenn der Datenbankserver die Anweisung erfolgreich vorbereitet hat, gibt
                      PDO::prepare ein <class>PDOStatement</class>-Objekt zurück. Schlägt die Vorbereitung fehl,
                      gibt PDO::prepare <info>false</info> zurück oder löst eine <class>PDOException</class> aus (abhängig von
                      der Fehlerbehandlung).
                      
                      Da emulierte vorbereitete Anweisungen nicht mit dem Datenbankserver
                      kommunizieren, überprüft PDO::prepare die Anweisung nicht.

<comment>See Also:</comment>
   * PDO::exec
   * PDO::query
   * PDOStatement::execute


id: PDO::query
type: function
doc:
<comment>Description:</comment>
  Bereitet eine SQL-Anweisung ohne Platzhalter vor und führt sie aus
    
  
  Mit PDO::query wird eine SQL-Anweisung in einem einzigen Funktionsaufruf vorbereitet und
  ausgeführt und die Anweisung als <class>PDOStatement</class>-Objekt zurückgegeben.
  
  Bei einer Abfrage, die mehrmals ausgeführt werden soll, wird die Effizienz verbessert, indem ein
  <class>PDOStatement</class>-Objekt mit PDO::prepare vorbereitet und die Anweisung mit mehreren Aufrufen von
  PDOStatement::execute ausgeführt wird.
  
  Wenn vor dem nächsten Aufruf von PDO::query nicht alle Daten einer Ergebnismenge abgerufen werden,
  schlägt der Aufruf möglicherweise fehl. Deshalb sollten die mit dem <class>PDOStatement</class>-Objekt
  verbundenen Datenbankressourcen mittels PDOStatement::closeCursor freigegeben werden, bevor
  PDO::query erneut aufgerufen wird.
  
  Wenn <strong>$query</strong> Platzhalter enthält, muss die Anweisung mit der Methode PDO::prepare vorbereitet und
  mit der Methode PDOStatement::execute ausgeführt werden.

<comment>Param:</comment>
  <info>string</info>    <strong>$query</strong>      Die SQL-Anweisung, die vorbereitet und ausgeführt werden soll
                        
                        Wenn das SQL Platzhalter enthält, müssen stattdessen die Methoden
                        PDO::prepare und PDOStatement::execute verwendet werden. Wenn es der Treiber
                        unterstützt, kann das SQL alternativ mittels PDO::quote mit korrekt
                        formatierten Daten manuell vorbereitet werden, bevor PDO::query aufgerufen
                        wird.
  <info>int|null</info>  <strong>$fetchMode</strong>  Der voreingestellte Abrufmodus für das zurückgegebene <class>PDOStatement</class>. Es muss
                        eine der <return>PDO::FETCH_*</return>-Konstanten sein.
                        
                        Wenn dieses Argument an die Funktion übergeben wird, werden die restlichen
                        Argumente so behandelt, als ob PDOStatement::setFetchMode für das
                        resultierende Anweisungsobjekt aufgerufen wurde. Die nachfolgenden Argumente
                        hängen vom gewählten Abrufmodus ab.

<comment>Return:</comment>
  <info>PDOStatement|false</info>  Gibt ein <class>PDOStatement</class>-Objekt zurück. Bei einem Fehler wird <info>false</info>
                      zurückgegeben.

<comment>See Also:</comment>
   * PDO::exec
   * PDO::prepare
   * PDOStatement::execute


id: PDO::quote
type: function
doc:
<comment>Description:</comment>
  Setzt eine Zeichenkette für die Verwendung in einer Abfrage in Anführungszeichen
    
  
  PDO::quote schließt die angegebene Zeichenkette (falls erforderlich) in Anführungszeichen ein und
  maskiert Sonderzeichen innerhalb der Zeichenkette, wobei ein für den zugrundeliegenden Treiber
  geeigneter Stil der Anführungszeichen verwendet wird.
  
  Wenn SQL-Anweisungen mit dieser Funktion erstellt werden, wird dringend empfohlen, PDO::prepare zu
  verwenden, um SQL-Anweisungen mit gebundenen Parametern vorzubereiten, anstatt PDO::quote zu
  verwenden, um Benutzereingaben in eine SQL-Anweisung einzufügen. Vorbereitete Anweisungen mit
  gebundenen Parametern sind nicht nur portabler, bequemer und immun gegen SQL-Injections, sondern
  lassen sich oft auch viel schneller ausführen als interpolierte Abfragen, da sowohl der Server als
  auch der Client die Abfragen in einer bereits kompilierten Form zwischenspeichern können.
  
  Diese Methode ist nicht bei allen PDO-Treibern implementiert (insbesondere nicht bei PDO_ODBC). In
  diesem Fall sollten stattdessen vorbereitete Anweisungen verwendet werden.
  
  Der Zeichensatz muss je nach Treiber entweder auf Serverebene oder in der Datenbankverbindung
  selbst eingestellt werden, damit er sich auf PDO::quote auswirkt. Weitere Informationen sind in
  der Treiberspezifischen Dokumentation zu finden.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Die Zeichenkette, die in Anführungszeichen gesetzt werden soll
  <info>int</info>     <strong>$type</strong>    Gibt Treibern, die andere Anführungszeichen verwenden, einen Hinweis auf den
                   Datentyp. Zum Beispiel teilt <info>PDO_PARAM_LOB</info> dem Treiber mit, dass er binäre Daten
                   maskieren soll.

<comment>Return:</comment>
  <info>string|false</info>  Gibt eine Zeichenkette in Anführungszeichen zurück, die theoretisch bedenkenlos an
                eine SQL-Anweisung übergeben werden kann, oder <info>false</info>, wenn der Treiber diese
                Anführungszeichen nicht unterstützt.

<comment>See Also:</comment>
   * PDO::prepare
   * PDOStatement::execute


id: PDO::rollBack
type: function
doc:
<comment>Description:</comment>
  Macht eine Transaktion rückgängig (Rollback)
  
  Macht die aktuelle durch PDO::beginTransaction gestartete Transaktion rückgängig.
  
  Falls die Datenbank auf den Autocommit-Modus eingestellt war, wird er wiederhergestellt, nachdem
  die Transaktion zurückgesetzt wurde.
  
  Wenn im Rahmen einer Transaktion eine DDL- (Database Definition Language) Anweisung wie DROP TABLE
  oder CREATE TABLE ausgeführt wird, geben einige Datenbanken, darunter auch MySQL, ein implizites
  COMMIT aus. Durch das implizite COMMIT wird verhindert, dass weitere im Rahmen der Transaktion
  vorgenommene Änderungen rückgängig gemacht werden können.

<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>
   * PDO::beginTransaction
   * PDO::commit
   * Transaktionen und Autocommit


id: PDO::setAttribute
type: function
doc:
<comment>Description:</comment>
  Setzt ein Attribut
  
  Legt ein Attribut für eine Datenbankverbindung fest. Einige der allgemein verfügbaren Attribute
  sind unten aufgeführt; manche Treiber verwenden möglicherweise zusätzliche treiberspezifische
  Attribute. Es ist zu beachten, dass die treiberspezifischen Attribute nicht mit anderen Treibern
  verwendet werden dürfen. <info>PDO::ATTR_CASE</info> Erzwingt, dass Spaltennamen eine bestimmte
  Groß-/Kleinschreibung aufweisen; kann einen der folgenden Werte annehmen: <info>PDO::CASE_LOWER</info>
  Erzwingt, dass Spaltennamen klein geschrieben werden. <info>PDO::CASE_NATURAL</info> Belässt die Spaltennamen
  so, wie sie vom Datenbanktreiber zurückgegeben werden. <info>PDO::CASE_UPPER</info> Erzwingt, dass Spaltennamen
  groß geschrieben werden. <info>PDO::ATTR_ERRMODE</info> Modus der PDO-Fehlermeldung; kann einen der folgenden
  Werte annehmen: <info>PDO::ERRMODE_SILENT</info> Es werden nur Fehlercodes gesetzt. <info>PDO::ERRMODE_WARNING</info> Gibt
  einen Fehler der Stufe <info>E_WARNING</info> aus. <info>PDO::ERRMODE_EXCEPTION</info> Löst <class>PDOException</class>s aus.
  <info>PDO::ATTR_ORACLE_NULLS</info> Dieses Attribut ist für alle Treiber verfügbar, nicht nur für Oracle.  Legt
  fest, ob und wie <info>null</info> und leere Strings umgewandelt werden sollen; kann einen der folgenden Werte
  annehmen: <info>PDO::NULL_NATURAL</info> Es findet keine Umwandlung statt. <info>PDO::NULL_EMPTY_STRING</info> Leere
  Zeichenketten werden in <info>null</info> umgewandelt. <info>PDO::NULL_TO_STRING</info><info>null</info> wird in eine leere Zeichenkette
  umgewandelt. <info>PDO::ATTR_STRINGIFY_FETCHES</info> Legt fest, ob numerische Werte beim Abrufen in
  Zeichenketten umgewandelt werden sollen; akzeptiert einen Wert vom Typ <info>bool</info>: <info>true</info> zum Aktivieren
  und <info>false</info> zum Deaktivieren. <info>PDO::ATTR_STATEMENT_CLASS</info> Legt die vom Benutzer bereitgestellte
  Anweisungsklasse fest, die von PDOStatement abgeleitet ist; muss das Format <return>array(string
  classname, array(mixed constructor_args))</return> haben.  Kann nicht mit persistenten PDO-Instanzen
  verwendet werden. <info>PDO::ATTR_TIMEOUT</info> Legt das Zeitlimit fest (in Sekunden); akzeptiert einen Wert
  vom Typ <info>int</info>.  Diese Option wird nicht von allen Treibern unterstützt und ihre Bedeutung kann sich
  je nach Treiber unterscheiden. So wartet SQLite beispielsweise bis zu diesem Zeitwert, bevor es
  aufgibt, eine beschreibbare Sperre zu erhalten, aber andere Treiber können dies als Zeitlimit für
  den Verbindungsaufbau oder den Lesevorgang interpretieren. <info>PDO::ATTR_AUTOCOMMIT</info> Nur für die OCI-,
  Firebird- und MySQL-Treiber verfügbar.  Legt fest, ob jede einzelne Anweisung automatisch
  bestätigt werden soll; akzeptiert einen Wert vom Typ <info>bool</info>: <info>true</info> zum Aktivieren und <info>false</info> zum
  Deaktivieren. Voreinstellung: <info>true</info>. <info>PDO::ATTR_EMULATE_PREPARES</info> Nur für die OCI-, Firebird- und
  MySQL-Treiber verfügbar.  Aktiviert oder deaktiviert die Emulation vorbereiteter Anweisungen.
  Einige Treiber unterstützen vorbereitete Anweisungen nicht nativ oder nur eingeschränkt. Wenn es
  auf <info>true</info> gesetzt ist, werden vorbereitete Anweisungen immer emuliert, andernfalls versucht PDO,
  nativ vorbereitete Anweisungen zu verwenden. Falls der Treiber die aktuelle Abfrage nicht
  erfolgreich vorbereiten kann, greift PDO immer darauf zurück, die vorbereitete Anweisung zu
  emulieren. <info>PDO::MYSQL_ATTR_USE_BUFFERED_QUERY</info> Nur für den MySQL-Treiber verfügbar.  Legt fest, ob
  gepufferte Abfragen verwendet werden sollen; akzeptiert einen Wert vom Typ <info>bool</info>: <info>true</info> zum
  Aktivieren und <info>false</info> zum Deaktivieren. Voreinstellung: <info>true</info>. <info>PDO::ATTR_DEFAULT_FETCH_MODE</info> Legt den
  standardmäßigen Abrufmodus fest. Eine Beschreibung der Modi und ihrer Verwendung ist in der
  Dokumentation zu PDOStatement::fetch zu finden.
  
  Erzwingt, dass Spaltennamen eine bestimmte Groß-/Kleinschreibung aufweisen; kann einen der
  folgenden Werte annehmen:
  
  Erzwingt, dass Spaltennamen klein geschrieben werden.
  
  Belässt die Spaltennamen so, wie sie vom Datenbanktreiber zurückgegeben werden.
  
  Erzwingt, dass Spaltennamen groß geschrieben werden.
  
  Modus der PDO-Fehlermeldung; kann einen der folgenden Werte annehmen:
  
  Es werden nur Fehlercodes gesetzt.
  
  Gibt einen Fehler der Stufe <info>E_WARNING</info> aus.
  
  Löst <class>PDOException</class>s aus.
  
  Dieses Attribut ist für alle Treiber verfügbar, nicht nur für Oracle.
  
  Legt fest, ob und wie <info>null</info> und leere Strings umgewandelt werden sollen; kann einen der folgenden
  Werte annehmen:
  
  Es findet keine Umwandlung statt.
  
  Leere Zeichenketten werden in <info>null</info> umgewandelt.
  
  <info>null</info> wird in eine leere Zeichenkette umgewandelt.
  
  Legt fest, ob numerische Werte beim Abrufen in Zeichenketten umgewandelt werden sollen; akzeptiert
  einen Wert vom Typ <info>bool</info>: <info>true</info> zum Aktivieren und <info>false</info> zum Deaktivieren.
  
  Legt die vom Benutzer bereitgestellte Anweisungsklasse fest, die von PDOStatement abgeleitet ist;
  muss das Format <return>array(string classname, array(mixed constructor_args))</return> haben.
  
  Kann nicht mit persistenten PDO-Instanzen verwendet werden.
  
  Legt das Zeitlimit fest (in Sekunden); akzeptiert einen Wert vom Typ <info>int</info>.
  
  Diese Option wird nicht von allen Treibern unterstützt und ihre Bedeutung kann sich je nach
  Treiber unterscheiden. So wartet SQLite beispielsweise bis zu diesem Zeitwert, bevor es aufgibt,
  eine beschreibbare Sperre zu erhalten, aber andere Treiber können dies als Zeitlimit für den
  Verbindungsaufbau oder den Lesevorgang interpretieren.
  
  Nur für die OCI-, Firebird- und MySQL-Treiber verfügbar.
  
  Legt fest, ob jede einzelne Anweisung automatisch bestätigt werden soll; akzeptiert einen Wert vom
  Typ <info>bool</info>: <info>true</info> zum Aktivieren und <info>false</info> zum Deaktivieren. Voreinstellung: <info>true</info>.
  
  Nur für die OCI-, Firebird- und MySQL-Treiber verfügbar.
  
  Aktiviert oder deaktiviert die Emulation vorbereiteter Anweisungen. Einige Treiber unterstützen
  vorbereitete Anweisungen nicht nativ oder nur eingeschränkt. Wenn es auf <info>true</info> gesetzt ist, werden
  vorbereitete Anweisungen immer emuliert, andernfalls versucht PDO, nativ vorbereitete Anweisungen
  zu verwenden. Falls der Treiber die aktuelle Abfrage nicht erfolgreich vorbereiten kann, greift
  PDO immer darauf zurück, die vorbereitete Anweisung zu emulieren.
  
  Nur für den MySQL-Treiber verfügbar.
  
  Legt fest, ob gepufferte Abfragen verwendet werden sollen; akzeptiert einen Wert vom Typ <info>bool</info>:
  <info>true</info> zum Aktivieren und <info>false</info> zum Deaktivieren. Voreinstellung: <info>true</info>.
  
  Legt den standardmäßigen Abrufmodus fest. Eine Beschreibung der Modi und ihrer Verwendung ist in
  der Dokumentation zu PDOStatement::fetch zu finden.

<comment>Param:</comment>
  <info>int</info>    <strong>$attribute</strong>  Das Attribut, das geändert werden soll.
  <info>mixed</info>  <strong>$value</strong>      Der Wert, auf den <strong>$attribute</strong> gesetzt wird; je nach Attribut kann ein bestimmter
                     Typ erforderlich sein.

<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>PDO::getAttribute()</strong>
   * <strong>PDOStatement::getAttribute()</strong>
   * <strong>PDOStatement::setAttribute()</strong>


id: PDO::sqliteCreateAggregate
type: function
doc:
<comment>Description:</comment>
  Registriert eine benutzerdefinierte Aggregationsfunktion zur Verwendung in
     SQL-Annweisungen
    
  
  Diese Funktion ist
  EXPERIMENTELL. Das Verhalten, der Funktionsname und die
  zugehörige Dokumentation können sich in zukünftigen PHP-Versionen ohne
  Ankündigung ändern. Die Verwendung dieser Funktion erfolgt auf eigene Gefahr.
  
  Diese Methode entspricht , mit dem Unterschied, dass sie Funktionen registriert, welche benutzt
  werden können, ein Ergebnis über alle Zeilen einer Anfrage zu aggregieren.
  
  Der Hauptunterschied zwischen dieser Methode und  ist, dass zwei Funktionen notwendig sind, um das
  Aggregat zu verwalten.

<comment>Param:</comment>
  <info>string</info>    <strong>$function_name</strong>  Der Name der in SQL-Anweisungen genutzten Funktion.
  <info>callable</info>  <strong>$step_func</strong>      Die Callback-Funktion, welche für jede Zeile des Abfrageergebnisses
                            ausgeführt wird. Ihr PHP sollte das Ergebnis akkumulieren und im
                            Aggregationskontext speichern.
                            
                            Es ist notwendig, diese Funktion wie folgt zu definieren:
                            <info>mixed</info>step<info>mixed</info><strong>$context</strong><info>int</info><strong>$rownumber</strong><info>mixed</info><strong>$value</strong><info>mixed</info><strong>$values</strong> <strong>$context</strong> Der
                            Aggregationskontext. <info>null</info> für die erste Zeile; in den folgenden Zeilen
                            hat er den Wert, der zuvor von der Schritt-Funktion zurückgegeben wurde.
                            Sie sollten diesen nutzen, um den Aggregationszustand zu bewahren.
                            <strong>$rownumber</strong> Die Nummer der aktuellen Zeile. <strong>$value</strong> Das erste Argument,
                            das an das Aggregat übergeben wurde. <strong>$values</strong> Weitere Argumente, die an
                            das Aggregat übergeben wurden.  Der Rückgabewert dieser Funktion wird
                            als <strong>$context</strong>-Argument im nächsten Aufruf der Schritt- oder End-Funktion
                            verwendet.
                            
                            Der Aggregationskontext. <info>null</info> für die erste Zeile; in den folgenden
                            Zeilen hat er den Wert, der zuvor von der Schritt-Funktion zurückgegeben
                            wurde. Sie sollten diesen nutzen, um den Aggregationszustand zu
                            bewahren.
                            
                            Die Nummer der aktuellen Zeile.
                            
                            Das erste Argument, das an das Aggregat übergeben wurde.
                            
                            Weitere Argumente, die an das Aggregat übergeben wurden.
  <info>mixed</info>     <strong>$context</strong>        Der Aggregationskontext. <info>null</info> für die erste Zeile; in den folgenden
                            Zeilen hat er den Wert, der zuvor von der Schritt-Funktion zurückgegeben
                            wurde. Sie sollten diesen nutzen, um den Aggregationszustand zu
                            bewahren.
  <info>int</info>       <strong>$rownumber</strong>      Die Nummer der aktuellen Zeile.
  <info>mixed</info>     <strong>$value</strong>          Das erste Argument, das an das Aggregat übergeben wurde.
  <info>mixed</info>     <strong>$values</strong>         Weitere Argumente, die an das Aggregat übergeben wurden.
  <info>callable</info>  <strong>$finalize_func</strong>  Die Callback-Funktion, die die Informationen aller Zeilen aggregiert.
                            Sind alle Zeilen abgearbeitet, wird diese Funktion aufgerufen. Diese
                            sollte dann die Daten des Aggregationskontexts auswerten und das
                            Ergebnis zurückgeben. Diese Callback-Funktion sollte einen Variablentyp
                            liefern, der von SQLite erwartet wird, z. B. den Skalar-Typ.
                            
                            Diese Funktion ist wie folgt zu definieren:
                            <info>mixed</info>fini<info>mixed</info><strong>$context</strong><info>int</info><strong>$rowcount</strong> <strong>$context</strong> Enthält den Rückgabewert des
                            letzten Aufrufs der Schritt-Funktion. <strong>$rowcount</strong> Enthält die Anzahl an
                            Zeilen, die bereits aggregiert wurden.  Der Rückgabewert dieser Funktion
                            wird als Rückgabewert für die Aggregation genutzt.
                            
                            Enthält den Rückgabewert des letzten Aufrufs der Schritt-Funktion.
                            
                            Enthält die Anzahl an Zeilen, die bereits aggregiert wurden.
  <info>mixed</info>     <strong>$context</strong>        Enthält den Rückgabewert des letzten Aufrufs der Schritt-Funktion.
  <info>int</info>       <strong>$rowcount</strong>       Enthält die Anzahl an Zeilen, die bereits aggregiert wurden.
  <info>int</info>       <strong>$num_args</strong>       Hinweis für den SQLite-Parser, ob die Callback-Funktion eine bestimmte
                            Anzahl an Parametern erwartet.

<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>sqlite_create_function()</strong>
   * <strong>sqlite_create_aggregate()</strong>


id: PDO::sqliteCreateCollation
type: function
doc:
<comment>Description:</comment>
  Registers a User Defined Function for use as a collating function in SQL statements
    
  
  Diese Funktion ist
  EXPERIMENTELL. Das Verhalten, der Funktionsname und die
  zugehörige Dokumentation können sich in zukünftigen PHP-Versionen ohne
  Ankündigung ändern. Die Verwendung dieser Funktion erfolgt auf eigene Gefahr.

<comment>Param:</comment>
  <info>string</info>    <strong>$name</strong>      Name of the SQL collating function to be created or redefined.
  <info>callable</info>  <strong>$callback</strong>  The name of a PHP function or user-defined function to apply as a callback,
                       defining the behavior of the collation. It should accept two strings and
                       return as strcmp() does, i.e. it should return -1, 1, or 0 if the first
                       string sorts before, sorts after, or is equal to the second.
                       
                       This function need to be defined as: <info>int</info>collation<info>string</info><strong>$string1</strong><info>string</info><strong>$string2</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: PDO::sqliteCreateFunction
type: function
doc:
<comment>Description:</comment>
  Registriert eine benutzerdefinierte Funktion (UDF) zur Nutzung in
     SQL-Anweisungen
    
  
  Diese Funktion ist
  EXPERIMENTELL. Das Verhalten, der Funktionsname und die
  zugehörige Dokumentation können sich in zukünftigen PHP-Versionen ohne
  Ankündigung ändern. Die Verwendung dieser Funktion erfolgt auf eigene Gefahr.
  
  Diese Methode ermöglicht es, in SQLite eine PHP-Funktion als eine benutzerdefinierte Funktion
  (UDF) zu registrieren, die dann in einer SQL-Anweisung aufgerufen werden kann.
  
  Die UDF kann nun in jeder SQL-Anweisung genutzt werden, die Funktionen aufrufen kann, wie SELECT
  und UPDATE und auch in Triggern.

<comment>Param:</comment>
  <info>string</info>    <strong>$function_name</strong>  Der Name der Funktion, der in SQL-Anweisungen genutzt wird.
  <info>callable</info>  <strong>$callback</strong>       Die Callback-Funktion, die die definierte SQL-Funktion verarbeitet.
                            
                            Die Callback-Funktionen sollten einen Typ zurückgeben, der von SQLite
                            verstanden wird, z. B. den Skalar-Typ.
                            
                            Diese Funktion muss wie folgt definiert werden:
                            <info>mixed</info>callback<info>mixed</info><strong>$value</strong><info>mixed</info><strong>$values</strong> <strong>$value</strong> Das erste Argument, das an
                            die SQL-Funktion übergeben wurde. <strong>$values</strong> Weitere Argumente, die an die
                            SQL-Funktion übergeben wurden.
                            
                            Das erste Argument, das an die SQL-Funktion übergeben wurde.
                            
                            Weitere Argumente, die an die SQL-Funktion übergeben wurden.
  <info>mixed</info>     <strong>$value</strong>          Das erste Argument, das an die SQL-Funktion übergeben wurde.
  <info>mixed</info>     <strong>$values</strong>         Weitere Argumente, die an die SQL-Funktion übergeben wurden.
  <info>int</info>       <strong>$num_args</strong>       Die Anzahl von Argumenten, die die SQL-Funktion erwartet. Ist dieser
                            Parameter <return>-1</return>, dann kann die SQL-Funktion eine beliebige Anzahl von
                            Argumenten annehmen.
  <info>int</info>       <strong>$flags</strong>          Eine bitweise Verknüpfung von Flags. Zurzeit wird nur
                            <info>PDO::SQLITE_DETERMINISTIC</info> unterstützt, das angibt, dass die Funktion für
                            dieselbe Eingabe immer dasselbe Ergebnis innerhalb einer einzelnen
                            SQL-Anweisung zurückgibt.

<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>sqlite_create_function()</strong>
   * <strong>sqlite_create_aggregate()</strong>


id: PDOStatement
type: class
doc:
<comment>Description:</comment>
  Repräsentiert ein Prepared Statement und, nachdem es ausgeführt wurde, die zugehörige
  Ergebnismenge.


id: PDOStatement::bindColumn
type: function
doc:
<comment>Description:</comment>
  Bindet eine Spalte an eine PHP-Variable
  
  PDOStatement::bindColumn bindet die angegebene Variable an die angegebene Spalte der Ergebnismenge
  einer Abfrage. Jedes Mal, wenn PDOStatement::fetch oder PDOStatement::fetchAll aufgerufen wird,
  werden alle an Spalten gebundenen Variablen aktualisiert.
  
  Da Informationen über die Spalten für PDO erst verfügbar sind, nachdem die Anweisung ausgeführt
  wurde, sollte diese Funktion in portablen Anwendungen nach PDOStatement::execute aufgerufen
  werden.
  
  Um jedoch bei Verwendung des PgSQL-Treibers eine Spalte vom Typ LOB mit einem Stream verknüpfen zu
  können, muss diese Methode vor PDOStatement::execute aufgerufen werden, weil die Anwendung das
  OID-Objekt ansonsten als Integer erhält.

<comment>Param:</comment>
  <info>string|int</info>  <strong>$column</strong>         Die Spaltennummer (beginnend mit 1) oder der Spaltenname in der
                              Ergebnismenge. Wird der Spaltenname verwendet, ist zu beachten, dass
                              der Name mit der vom Treiber zurückgegebenen Groß-/Kleinschreibung der
                              Spalte übereinstimmen muss.
  <info>mixed</info>       <strong>$var</strong>            Der Name der PHP-Variable, an die die Spalte gebunden werden soll.
  <info>int</info>         <strong>$type</strong>           Der Datentyp des Parameters, angegeben durch eine der
                              <return>PDO::PARAM_*</return>-Konstanten.
  <info>int</info>         <strong>$maxLength</strong>      Ein Hinweis, um Speicherplatz vorab zuzuweisen.
  <info>mixed</info>       <strong>$driverOptions</strong>  Optionale Parameter für den Treiber.

<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>
   * PDOStatement::execute
   * PDOStatement::fetch
   * PDOStatement::fetchAll
   * PDOStatement::fetchColumn


id: PDOStatement::bindParam
type: function
doc:
<comment>Description:</comment>
  Bindet einen Parameter an den angegebenen Variablennamen
  
  Bindet eine PHP-Variable an den entsprechenden benannten oder durch ein Fragezeichen
  gekennzeichneten Platzhalter der vorbereiteten SQL-Anweisung. Im Gegensatz zu
  PDOStatement::bindValue wird die Variable als Referenz gebunden und wird erst ausgewertet, wenn
  PDOStatement::execute aufgerufen wird.
  
  Meistens handelt es sich bei den Parametern um Eingabeparameter, d. h. um Parameter, die nur
  lesend verwendet werden, um die Abfrage zu erstellen (sie können aber dennoch nach <strong>$type</strong>
  umgewandelt werden). Einige Treiber ermöglichen jedoch die Ausführung gespeicherter Prozeduren,
  die Daten über Ausgabeparameter zurückgeben können. Solche Parameter werden häufig gleichzeitig
  als Ein- und Ausgabeparameter verwendet, die sowohl Daten senden als auch aktualisiert werden, um
  sie zu empfangen.

<comment>Param:</comment>
  <info>string|int</info>  <strong>$param</strong>          Der Bezeichner des Parameters. Bei einer vorbereiteten Anweisung, die
                              benannte Platzhalter verwendet, ist dies ein Parametername der Form
                              :name. Bei einer vorbereiteten Anweisung mit Fragezeichen-Platzhaltern
                              ist dies die Position des Parameters, beginnend mit 1 (1-indiziert).
  <info>mixed</info>       <strong>$var</strong>            Der Name der PHP-Variable, die an den Parameter der SQL-Anweisung
                              gebunden werden soll.
  <info>int</info>         <strong>$type</strong>           Ein expliziter Datentyp für den Parameter, der durch eine der
                              <return>PDO::PARAM_*</return>-Konstanten angegeben wird. Soll ein INOUT-Parameter von
                              einer gespeicherten Prozedur zurückgegeben werden, muss der bitweise
                              OR-Operator verwendet werden, um die <info>PDO::PARAM_INPUT_OUTPUT</info>-Bits für
                              den Parameter <strong>$type</strong> zu setzen.
  <info>int</info>         <strong>$maxLength</strong>      Die Länge des Datentyps. Um anzuzeigen, dass ein Parameter ein
                              OUT-Parameter einer gespeicherten Prozedur ist, muss die Länge
                              explizit angegeben werden; nur sinnvoll, wenn der Parameter <strong>$type</strong>
                              <info>PDO::PARAM_INPUT_OUTPUT</info> ist.
  <info>mixed</info>       <strong>$driverOptions</strong>  

<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>
   * PDO::prepare
   * PDOStatement::execute
   * PDOStatement::bindValue


id: PDOStatement::bindValue
type: function
doc:
<comment>Description:</comment>
  Bindet einen Wert an einen Parameter
  
  Bindet einen Wert an den entsprechend benannten oder durch ein Fragezeichen gekennzeichneten
  Platzhalter in der SQL-Anweisung, die zur Vorbereitung der Anweisung verwendet wurde.

<comment>Param:</comment>
  <info>string|int</info>  <strong>$param</strong>  Der Bezeichner des Parameters. Bei einer vorbereiteten Anweisung, die benannte
                      Platzhalter verwendet, ist dies ein Parametername der Form :name. Bei einer
                      vorbereiteten Anweisung mit Fragezeichen-Platzhaltern ist dies die Position
                      des Parameters, beginnend mit 1 (1-indiziert).
  <info>mixed</info>       <strong>$value</strong>  Der Wert, der an den Parameter gebunden werden soll.
  <info>int</info>         <strong>$type</strong>   Ein expliziter Datentyp für den Parameter, der durch eine der
                      <return>PDO::PARAM_*</return>-Konstanten angegeben wird.

<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>
   * PDO::prepare
   * PDOStatement::execute
   * PDOStatement::bindParam


id: PDOStatement::closeCursor
type: function
doc:
<comment>Description:</comment>
  Schließt den Cursor, damit die Anweisung erneut ausgeführt werden kann
    
  
  PDOStatement::closeCursor gibt die Verbindung zum Server frei, damit andere SQL-Anweisungen
  ausgeführt werden können, belässt die Anweisung aber in einem Zustand, in dem sie erneut
  ausgeführt werden kann.
  
  Diese Methode ist nützlich für Datenbanktreiber, die die Ausführung eines PDOStatement-Objekts
  nicht unterstützen, wenn ein zuvor ausgeführtes PDOStatement-Objekt noch nicht abgrufene Zeilen
  enthält. Wenn der Datenbanktreiber diese Einschränkung aufweist, kann es zu einem
  Out-of-Sequence-Fehler kommen.
  
  PDOStatement::closeCursor ist entweder als optionale treiberspezifische Methode implementiert (für
  maximale Effizienz), oder als generischer PDO-Fallback, wenn keine treiberspezifische Funktion
  installiert ist. Der generische PDO-Fallback ist semantisch dasselbe wie der folgende Code in
  einem PHP-Skript: fetch()) ; if (!$stmt->nextRowset()) break;
  } while (true);
  ?>
  ]]>

<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>
   * PDOStatement::execute


id: PDOStatement::columnCount
type: function
doc:
<comment>Description:</comment>
  Liefert die Anzahl der Spalten in der Ergebnismenge
  
  PDOStatement::columnCount gibt die Anzahl der Spalten in der Ergebnismenge zurück, die durch das
  PDOStatement-Objekt repräsentiert wird.
  
  Wenn das PDOStatement-Objekt von PDO::query zurückgegeben wurde, ist die Anzahl der Spalten sofort
  verfügbar.
  
  Wurde das PDOStatement-Objekt von PDO::prepare zurückgegeben, ist die genaue Anzahl der Spalten
  erst verfügbar, nachdem PDOStatement::execute aufgerufen wurde.

<comment>Return:</comment>
  <info>int</info>  Gibt die Anzahl der Spalten in der Ergebnismenge zurück, die durch das PDOStatement-Objekt
       repräsentiert wird, auch wenn die Ergebnismenge leer ist. Wenn es keine Ergebnismenge gibt,
       gibt PDOStatement::columnCount <return>0</return> zurück.

<comment>See Also:</comment>
   * PDO::prepare
   * PDOStatement::execute
   * PDOStatement::rowCount


id: PDOStatement::debugDumpParams
type: function
doc:
<comment>Description:</comment>
  Gibt Informationen über einen vorbereiteten SQL-Befehl aus
  
  Scheibt die in einer vorbereiteten Anweisung enthaltenen Informationen direkt in die Ausgabe.
  Ausgegeben werden die verwendete <return>SQL</return>-Abfrage, die Anzahl der verwendeten Parameter (<return>Params</return>), die
  Liste der Parameter mit ihrem Schlüsselnamen oder ihrer Position, ihren Namen, ihre Position in
  der Abfrage (falls dies vom PDO-Treiber unterstützt wird, andernfalls ist es -1), ihren Typ
  (<return>param_type</return>) als Ganzzahl und einen booleschen Wert <return>is_param</return>.
  
  Dies ist eine Debug-Funktion, die die Daten direkt in die normale Ausgabe schreibt. Bei allem,
  dessen Ergebnisausgabe direkt
  im Browser angezeigt wird, können Sie die
  Funktionen zur Ausgabesteuerung verwenden.
  Damit lässt sich die Ausgabe dieser Funktion erfassen, und - zum Beispiel -
  in einem <info>string</info> speichern.
  
  Bei allem, dessen Ergebnisausgabe direkt
  im Browser angezeigt wird, können Sie die
  Funktionen zur Ausgabesteuerung verwenden.
  Damit lässt sich die Ausgabe dieser Funktion erfassen, und - zum Beispiel -
  in einem <info>string</info> speichern.
  
  Hierbei werden nur die Parameter ausgegeben, die zum Zeitpunkt der Ausgabe in der Anweisung
  enthalten sind. Überzählige Parameter werden nicht in der Anweisung gespeichert und daher auch
  nicht angezeigt.

<comment>Return:</comment>
  <info>bool|null</info>  Gibt <info>null</info> zurück oder <info>false</info>, wenn ein Fehler aufgetreten ist.

<comment>See Also:</comment>
   * PDO::prepare
   * PDOStatement::bindParam
   * PDOStatement::bindValue


id: PDOStatement::errorCode
type: function
doc:
<comment>Description:</comment>
  Ruft den SQLSTATE-Code ab, der mit der letzten Operation über das
     Anweisungs-Handle verknüpft ist

<comment>Return:</comment>
  <info>string|null</info>  Entspricht PDO::errorCode, mit dem Unterschied, dass PDOStatement::errorCode nur
               Fehlercodes für Operationen mit PDOStatement-Objekten abfragt.

<comment>See Also:</comment>
   * PDO::errorCode
   * PDO::errorInfo
   * PDOStatement::errorInfo


id: PDOStatement::errorInfo
type: function
doc:
<comment>Description:</comment>
  Ruft die erweiterten Fehlerinformationen ab, die mit der letzten Operation
     über das Anweisungs-Handle verknüpft sind

<comment>Return:</comment>
  <info>array</info>  PDOStatement::errorInfo gibt ein Array mit Informationen über den Fehler zurück, der bei
         der letzten über dieses Anweisungs-Handle durchgeführte Operation aufgetreten ist. Das
         Array besteht mindestens aus den folgenden Feldern: ElementInformation0 SQLSTATE-Fehlercode
         (eine fünfstellige alphanumerische Kennung, die im ANSI-SQL-Standard definiert ist)
         1Treiberspezifischer Fehlercode2Treiberspezifische Fehlermeldung

<comment>See Also:</comment>
   * PDO::errorCode
   * PDO::errorInfo
   * PDOStatement::errorCode


id: PDOStatement::execute
type: function
doc:
<comment>Description:</comment>
  Führt ein Prepared Statement aus
  
  Führt das Prepared Statement aus. Falls das Prepared Statement Parameter-Marker enthält, muss
  entweder: PDOStatement::bindParam und/oder PDOStatement::bindValue müssen aufgerufen werden, um
  Variablen bzw. Werte an die Parameter-Marker zu binden. Gebundene Variablen übergeben ihren Wert
  als Eingabe und erhalten, falls vorhanden, den Ausgabewert ihrer zugehörigen Parameter-Marker.
  oder ein Array mit Nur-Eingabe-Parameterwerten übergeben werden.
  
  PDOStatement::bindParam und/oder PDOStatement::bindValue müssen aufgerufen werden, um Variablen
  bzw. Werte an die Parameter-Marker zu binden. Gebundene Variablen übergeben ihren Wert als Eingabe
  und erhalten, falls vorhanden, den Ausgabewert ihrer zugehörigen Parameter-Marker.
  
  oder ein Array mit Nur-Eingabe-Parameterwerten übergeben werden.

<comment>Param:</comment>
  <info>array|null</info>  <strong>$params</strong>  Ein Array von Werten mit so vielen Elementen, wie es gebundene Parameter in
                       der auszuführenden SQL-Anweisung gibt. Alle Werte werden als <info>PDO::PARAM_STR</info>
                       behandelt.
                       
                       An einen einzelnen Paramter können nicht mehrere Werte gebunden werden; es
                       ist z. B. nicht gestattet, zwei Werte an einen einzelnen benannten Parameter
                       in einer IN()-Klausel zu binden.
                       
                       Mehr Werte zu binden als festgelegt ist nicht möglich; wenn <strong>$params</strong> mehr
                       Parameter enthält als in PDO::prepare definiert wurden, wird die Anweisung
                       fehlschlagen und ein Fehler wird ausgegeben.

<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>
   * PDO::prepare
   * PDOStatement::bindParam
   * PDOStatement::fetch
   * PDOStatement::fetchAll
   * PDOStatement::fetchColumn


id: PDOStatement::fetch
type: function
doc:
<comment>Description:</comment>
  Ruft die nächste Zeile aus einer Ergebnismenge ab
  
  Ruft eine Zeile aus einer Ergebnismenge ab, die mit einem PDOStatement-Objekt verknüpft ist. Der
  Parameter <strong>$mode</strong> bestimmt, wie PDO die Zeile zurückgibt.

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>               Legt fest, wie die nächste Zeile an die aufrufende Methode zurückgegeben
                           werden soll. Dieser Wert muss eine der <info>PDO::FETCH_*</info>-Konstanten sein.
                           Voreingestellt ist <info>PDO::ATTR_DEFAULT_FETCH_MODE</info> (das standardmäßig auf
                           <info>PDO::FETCH_BOTH</info> gesetzt ist). <info>PDO::FETCH_ASSOC</info>: gibt ein Array zurück,
                           das durch die Spaltennamen der Ergebnismenge indiziert ist.
                           <info>PDO::FETCH_BOTH</info> (Voreinstellung): gibt ein Array zurück, das sowohl durch
                           die Spaltennamen der Ergebnismenge als auch durch deren Spaltennummern
                           (beginnend bei 0) indiziert ist. <info>PDO::FETCH_BOUND</info>: gibt <info>true</info> zurück und
                           weist die Werte der Spalten der Ergebnismenge den PHP-Variablen zu, an
                           die sie mit der Methode PDOStatement::bindColumn gebunden wurden.
                           <info>PDO::FETCH_CLASS</info>: gibt eine neue Instanz der angeforderten Klasse zurück,
                           wobei die Spalten der Ergebnismenge den benannten Eigenschaften der
                           Klasse zugeordnet werden und anschließend der Konstruktor aufgerufen
                           wird, es sei denn, <info>PDO::FETCH_PROPS_LATE</info> ist ebenfalls angegeben. Wenn
                           <strong>$mode</strong> das Attribut PDO::FETCH_CLASSTYPE enthält (z. B. <return>PDO::FETCH_CLASS |
                           PDO::FETCH_CLASSTYPE</return>), wird der Name der Klasse aus einem Wert der ersten
                           Spalte ermittelt. <info>PDO::FETCH_INTO</info>: aktualisiert eine bestehende Instanz
                           der angeforderten Klasse, wobei die Spalten der Ergebnismenge den
                           benannten Eigenschaften der Klasse zugeordnet werden. <info>PDO::FETCH_LAZY</info>:
                           kombiniert <info>PDO::FETCH_BOTH</info> und <info>PDO::FETCH_OBJ</info>, wobei die Namen der
                           Objektvariablen erstellt werden, wenn auf sie zugegriffen wird.
                           <info>PDO::FETCH_NAMED</info>: gibt ein Array zurück, das die gleiche Form hat wie
                           <info>PDO::FETCH_ASSOC</info>. Wenn es jedoch mehrere Spalten mit demselben Namen
                           gibt, ist der Wert, auf den der betreffende Schlüssel verweist, ein Array
                           mit allen Werten in der Zeile, die diesen Spaltennamen hatten.
                           <info>PDO::FETCH_NUM</info>: gibt ein Array zurück, das durch die Spaltennummer aus
                           der Ergebnismenge indiziert ist (beginnend bei Spalte 0). <info>PDO::FETCH_OBJ</info>:
                           gibt ein anonymes Objekt mit Eigenschaftsnamen zurück, die den
                           Spaltennamen aus der Ergebnismenge entsprechen. <info>PDO::FETCH_PROPS_LATE</info>: in
                           Kombination mit <info>PDO::FETCH_CLASS</info> wird der Konstruktor der Klasse
                           aufgerufen, bevor die Eigenschaften aus den jeweiligen Spaltenwerten
                           zugewiesen werden.
                           
                           <info>PDO::FETCH_ASSOC</info>: gibt ein Array zurück, das durch die Spaltennamen der
                           Ergebnismenge indiziert ist.
                           
                           <info>PDO::FETCH_BOTH</info> (Voreinstellung): gibt ein Array zurück, das sowohl durch
                           die Spaltennamen der Ergebnismenge als auch durch deren Spaltennummern
                           (beginnend bei 0) indiziert ist.
                           
                           <info>PDO::FETCH_BOUND</info>: gibt <info>true</info> zurück und weist die Werte der Spalten der
                           Ergebnismenge den PHP-Variablen zu, an die sie mit der Methode
                           PDOStatement::bindColumn gebunden wurden.
                           
                           <info>PDO::FETCH_CLASS</info>: gibt eine neue Instanz der angeforderten Klasse zurück,
                           wobei die Spalten der Ergebnismenge den benannten Eigenschaften der
                           Klasse zugeordnet werden und anschließend der Konstruktor aufgerufen
                           wird, es sei denn, <info>PDO::FETCH_PROPS_LATE</info> ist ebenfalls angegeben. Wenn
                           <strong>$mode</strong> das Attribut PDO::FETCH_CLASSTYPE enthält (z. B. <return>PDO::FETCH_CLASS |
                           PDO::FETCH_CLASSTYPE</return>), wird der Name der Klasse aus einem Wert der ersten
                           Spalte ermittelt.
                           
                           <info>PDO::FETCH_INTO</info>: aktualisiert eine bestehende Instanz der angeforderten
                           Klasse, wobei die Spalten der Ergebnismenge den benannten Eigenschaften
                           der Klasse zugeordnet werden.
                           
                           <info>PDO::FETCH_LAZY</info>: kombiniert <info>PDO::FETCH_BOTH</info> und <info>PDO::FETCH_OBJ</info>, wobei die
                           Namen der Objektvariablen erstellt werden, wenn auf sie zugegriffen wird.
                           
                           <info>PDO::FETCH_NAMED</info>: gibt ein Array zurück, das die gleiche Form hat wie
                           <info>PDO::FETCH_ASSOC</info>. Wenn es jedoch mehrere Spalten mit demselben Namen
                           gibt, ist der Wert, auf den der betreffende Schlüssel verweist, ein Array
                           mit allen Werten in der Zeile, die diesen Spaltennamen hatten.
                           
                           <info>PDO::FETCH_NUM</info>: gibt ein Array zurück, das durch die Spaltennummer aus
                           der Ergebnismenge indiziert ist (beginnend bei Spalte 0).
                           
                           <info>PDO::FETCH_OBJ</info>: gibt ein anonymes Objekt mit Eigenschaftsnamen zurück,
                           die den Spaltennamen aus der Ergebnismenge entsprechen.
                           
                           <info>PDO::FETCH_PROPS_LATE</info>: in Kombination mit <info>PDO::FETCH_CLASS</info> wird der
                           Konstruktor der Klasse aufgerufen, bevor die Eigenschaften aus den
                           jeweiligen Spaltenwerten zugewiesen werden.
  <info>int</info>  <strong>$cursorOrientation</strong>  Bei einem PDOStatement-Objekt, das einen scrollbaren Cursor
                           repräsentiert, bestimmt dieser Wert, welche Zeile an die aufrufende
                           Methode zurückgegeben werden soll. Dieser Wert muss eine der
                           <info>PDO::FETCH_ORI_*</info>-Konstanten sein, wobei <info>PDO::FETCH_ORI_NEXT</info>
                           voreingestellt ist. Wenn die SQL-Anweisung mit PDO::prepare vorbereitet
                           wird, muss das Attribut <info>PDO::ATTR_CURSOR</info> auf <info>PDO::CURSOR_SCROLL</info> gesetzt
                           werden, um einen scrollbaren Cursor für das PDOStatement-Objekt zu
                           erhalten.
  <info>int</info>  <strong>$cursorOffset</strong>       Bei einem PDOStatement-Objekt, das einen scrollbaren Cursor
                           repräsentiert, dessen Parameter <strong>$cursorOrientation</strong> auf <info>PDO::FETCH_ORI_ABS</info>
                           gesetzt ist, gibt dieser Wert die absolute Nummer der Zeile in der
                           Ergebnismenge an, die abgerufen werden soll.
                           
                           Bei einem PDOStatement-Objekt, das einen scrollbaren Cursor
                           repräsentiert, dessen Parameter <strong>$cursorOrientation</strong> auf <info>PDO::FETCH_ORI_REL</info>
                           gesetzt ist, gibt dieser Wert die abzurufende Zeile relativ zur Position
                           des Zeigers vor dem Aufruf von PDOStatement::fetch an.

<comment>Return:</comment>
  <info>mixed</info>  Bei Erfolg hängt der Rückgabewert dieser Funktion von der Art des Abrufs ab. Bei einem
         Fehler oder wenn es keine weiteren Zeilen gibt, wird in jedem Fall <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * PDO::prepare
   * PDOStatement::execute
   * PDOStatement::fetchAll
   * PDOStatement::fetchColumn
   * PDOStatement::fetchObject
   * PDOStatement::setFetchMode


id: PDOStatement::fetchAll
type: function
doc:
<comment>Description:</comment>
  Ruft die verbleibenden Zeilen aus einer Ergebnismenge ab

<comment>Param:</comment>
  <info>int</info>         <strong>$mode</strong>             Legt die Struktur des zurückgegebenen Arrays fest, wie in
                                PDOStatement::fetch dokumentiert. Voreingestellt ist
                                <info>PDO::ATTR_DEFAULT_FETCH_MODE</info> (das standardmäßig auf <info>PDO::FETCH_BOTH</info>
                                gesetzt ist).
                                
                                Damit ein Array zurückgegeben wird, das aus allen Werten einer
                                einzelnen Spalte der Ergebnismenge besteht, muss <info>PDO::FETCH_COLUMN</info>
                                angegeben werden. Die gewünschte Spalte kann mit dem Parameter
                                <strong>$column</strong> angegeben werden.
                                
                                Um nur die eindeutigen Werte einer einzelnen Spalte aus der
                                Ergebnismenge zu abzurufen, müssen <info>PDO::FETCH_COLUMN</info> und
                                <info>PDO::FETCH_UNIQUE</info> mittels bitweisem OR verknüpft werden.
                                
                                Damit ein Array zurückgegeben wird, das nach den Werten einer
                                bestimmten Spalte gruppiert ist, müssen <info>PDO::FETCH_COLUMN</info> und
                                <info>PDO::FETCH_GROUP</info> mittels bitweisem OR verknüpft werden.
  <info>int</info>         <strong>$column</strong>           Wird zusammen mit <info>PDO::FETCH_COLUMN</info> verwendet. Gibt die angegebene
                                Spalte zurück (der Index beginnt bei 0).
  <info>string</info>      <strong>$class</strong>            Wird zusammen mit <info>PDO::FETCH_CLASS</info> verwendet. Gibt Instanzen der
                                angegebenen Klasse zurück, wobei die Spalten jeder Zeile auf
                                benannte Eigenschaften der Klasse abgebildet werden.
  <info>array|null</info>  <strong>$constructorArgs</strong>  Argumente des benutzerdefinierten Klassenkonstruktors, wenn der
                                Parameter <strong>$mode</strong> auf <info>PDO::FETCH_CLASS</info> gesetzt ist.
  <info>callable</info>    <strong>$callback</strong>         Wird zusammen mit <info>PDO::FETCH_FUNC</info> verwendet. Gibt die Ergebnisse des
                                angegebenen Funktionsaufrufs zurück, wobei die Spalten jeder Zeile
                                als Parameter für den Aufruf verwendet werden.

<comment>Return:</comment>
  <info>array</info>  PDOStatement::fetchAll gibt ein Array zurück, das die restlichen Zeilen der Ergebnismenge
         enthält. Das Array enthält jede Zeile entweder als Array von Spaltenwerten oder als Objekt
         mit Eigenschaften, die den einzelnen Spaltennamen entsprechen. Wenn es keine Ergebnisse
         gibt, die abgerufen werden können, wird ein leeres Array zurückgegeben.
         
         Wenn diese Methode verwendet wird, um große Ergebnismengen abzurufen, kann dies zu einer
         hohen Beanspruchung der System- und Netzwerkressourcen führen. Anstatt alle Daten abzurufen
         und in PHP zu bearbeiten, sollte in Betracht gezogen werden, den Datenbankserver für die
         Bearbeitung der Ergebnismengen zu verwenden. Zum Beispiel könnten WHERE- und ORDER
         BY-Klauseln in SQL verwendet werden, um die Ergebnismenge einzuschränken, bevor sie mit PHP
         abgerufen und verarbeitet wird.

<comment>See Also:</comment>
   * PDO::query
   * PDOStatement::fetch
   * PDOStatement::fetchColumn
   * PDO::prepare
   * PDOStatement::setFetchMode


id: PDOStatement::fetchColumn
type: function
doc:
<comment>Description:</comment>
  Liefert eine einzelne Spalte aus der nächsten Zeile einer Ergebnismenge
    
  
  Gibt eine einzelne Spalte aus der nächsten Zeile einer Ergebnismenge zurück oder <info>false</info>, wenn es
  keine weiteren Zeilen gibt.
  
  PDOStatement::fetchColumn sollte nicht verwendet werden, um boolesche Spalten abzurufen, da nicht
  unterschieden werden kann, ob der Wert <info>false</info> ist oder ob keine weiteren Zeilen abgerufen werden
  können. Stattdessen sollte PDOStatement::fetch verwendet werden.

<comment>Param:</comment>
  <info>int</info>  <strong>$column</strong>  Die Nummer der Spalte (beginnend bei 0), die aus der Zeile abgerufen werden soll.
                Wenn kein Wert angegeben wird, ruft PDOStatement::fetchColumn die erste Spalte ab.

<comment>Return:</comment>
  <info>mixed</info>  PDOStatement::fetchColumn gibt eine einzelne Spalte aus der nächsten Zeile einer
         Ergebnismenge zurück oder <info>false</info>, wenn es keine weiteren Zeilen gibt.
         
         Wenn Daten mittels PDOStatement::fetchColumn abgerufen werden, gibt es keine Möglichkeit,
         eine andere Spalte aus derselben Zeile abzurufen.

<comment>See Also:</comment>
   * PDO::query
   * PDOStatement::fetch
   * PDOStatement::fetchAll
   * PDO::prepare
   * PDOStatement::setFetchMode


id: PDOStatement::fetchObject
type: function
doc:
<comment>Description:</comment>
  Ruft die nächste Zeile ab und liefert sie als Objekt
  
  Ruft die nächste Zeile ab und gibt sie als Objekt zurück. Diese Funktion ist eine Alternative zu
  PDOStatement::fetch in Verbindung mit <info>PDO::FETCH_CLASS</info> oder <info>PDO::FETCH_OBJ</info>.
  
  Wenn ein Objekt abgerufen wird, werden seinen Eigenschaften die jeweiligen Werte der Spalten
  zugewiesen, und anschließend wird sein Konstruktor aufgerufen.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$class</strong>            Der Name der erstellten Klasse
  <info>array</info>        <strong>$constructorArgs</strong>  Die Elemente dieses Arrays werden an den Konstruktor übergeben.

<comment>Return:</comment>
  <info>object|false</info>  Gibt eine Instanz der angegebenen Klasse zurück, deren Eigenschaftsnamen den
                Spaltennamen entsprechen. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * PDOStatement::fetch


id: PDOStatement::getAttribute
type: function
doc:
<comment>Description:</comment>
  Ruft ein Attribut einer Anweisung ab
  
  Ruft ein Attribut einer Anweisung ab. Derzeit gibt es keine allgemeinen Attribute, sondern nur
  treiberspezifische: <info>PDO::ATTR_CURSOR_NAME</info> (spezifisch für Firebird und ODBC): Ermittelt den Namen
  des Cursors für <return>UPDATE ... WHERE CURRENT OF</return>.  Es ist zu beachten, dass treiberspezifische
  Attribute nicht zusammen mit anderen Treibern verwendet werden dürfen.
  
  <info>PDO::ATTR_CURSOR_NAME</info> (spezifisch für Firebird und ODBC): Ermittelt den Namen des Cursors für
  <return>UPDATE ... WHERE CURRENT OF</return>.

<comment>Param:</comment>
  <info>int</info>  <strong>$name</strong>  Das Attribut, das abgerufen werden soll

<comment>Return:</comment>
  <info>mixed</info>  Gibt den Wert des Attributs zurück.

<comment>See Also:</comment>
   * PDO::getAttribute
   * PDO::setAttribute
   * PDOStatement::setAttribute


id: PDOStatement::getColumnMeta
type: function
doc:
<comment>Description:</comment>
  Liefert die Metadaten zu einer Spalte einer Ergebnismenge
    
  
  Ruft die Metadaten für eine Spalte (beginnend bei 0) einer Ergebnismenge als assoziatives Array
  ab.
  
  Da PDOStatement::getColumnMeta optional ist, kann es sein, dass manche Treiber es nicht
  implementieren. Allerdings wird diese Funktion von allen im Handbuch dokumentierten PDO-Treibern
  implementiert.

<comment>Param:</comment>
  <info>int</info>  <strong>$column</strong>  Die Spalte der Ergebnismenge (beginnend bei 0)

<comment>Return:</comment>
  <info>array|false</info>  Gibt ein assoziatives Array mit den folgenden Werten zurück, die die Metadaten für
               eine einzelne Spalte darstellen:
               
               Gibt <info>false</info> zurück, wenn die angeforderte Spalte in der Ergebnismenge nicht vorhanden
               ist, oder wenn es keine Ergebnismenge gibt.

<comment>See Also:</comment>
   * PDOStatement::columnCount
   * PDOStatement::rowCount


id: PDOStatement::getIterator
type: function
doc:
<comment>Description:</comment>
  Ermittelt den Iterator der Ergebnismenge
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>Iterator</info>  


id: PDOStatement::nextRowset
type: function
doc:
<comment>Description:</comment>
  Rückt in einem Anweisungshandle mit mehreren Sätzen von Zeilen (Rowsets)
     zum nächsten vor
    
  
  Einige Datenbankserver unterstützen gespeicherte Prozeduren, die mehr als einen Satz von Zeilen
  (sog. Rowsets, auch Ergebnismenge genannt) zurückgeben. PDOStatement::nextRowset ermöglicht den
  Zugriff auf den zweiten und die folgenden Sätze von Zeilen, die zu einem PDOStatement-Objekt
  gehören. Jeder Zeilensatz kann einen anderen Satz von Spalten haben als der vorhergehende
  Zeilensatz.

<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>
   * PDOStatement::columnCount
   * PDOStatement::execute
   * PDOStatement::getColumnMeta
   * PDO::query


id: PDOStatement::rowCount
type: function
doc:
<comment>Description:</comment>
  Liefert die Anzahl der von der letzten SQL-Anweisung betroffenen Zeilen
    
  
  PDOStatement::rowCount gibt die Anzahl der Zeilen zurück, die von der letzten DELETE-, INSERT-
  oder UPDATE-Anweisung des zugehörigen <return>PDOStatement</return>-Objekts betroffen waren.
  
  Bei Anweisungen, die Ergebnismengen erzeugen, z. B. <return>SELECT</return>, ist das Verhalten nicht definiert und
  kann je nach Treiber unterschiedlich sein. Einige Datenbanken können die Anzahl der von dieser
  Anweisung erzeugten Zeilen zurückgeben (z. B. MySQL im gepufferten Modus), aber dieses Verhalten
  ist nicht für alle Datenbanken garantiert und sollte nicht für portable Anwendungen verwendet
  werden.
  
  Diese Methode gibt beim SQLite-Treiber immer "0" (Null) zurück, beim PostgreSQL-Treiber nur dann,
  wenn das Statement-Attribut <info>PDO::ATTR_CURSOR</info> auf <info>PDO::CURSOR_SCROLL</info> gesetzt ist.

<comment>Return:</comment>
  <info>int</info>  Gibt die Anzahl der Zeilen zurück.

<comment>See Also:</comment>
   * PDOStatement::columnCount
   * PDOStatement::fetchColumn
   * PDO::query


id: PDOStatement::setAttribute
type: function
doc:
<comment>Description:</comment>
  Setzt ein Anweisungsattribut
  
  Setzt ein Attribut für eine Anweisung. Derzeit werden keine allgemeinen Attribute gesetzt, sondern
  nur treiberspezifische: <info>PDO::ATTR_CURSOR_NAME</info> (spezifisch für Firebird und ODBC): setzt den Namen
  des Cursors für <return>UPDATE ... WHERE CURRENT OF</return>.  Es ist zu beachten, dass treiberspezifische
  Attribute nicht zusammen mit anderen Treibern verwendet werden dürfen.
  
  <info>PDO::ATTR_CURSOR_NAME</info> (spezifisch für Firebird und ODBC): setzt den Namen des Cursors für <return>UPDATE
  ... WHERE CURRENT OF</return>.

<comment>Param:</comment>
  <info>int</info>    <strong>$attribute</strong>  Das zu ändernde Attribut
  <info>mixed</info>  <strong>$value</strong>      Der Wert, auf den das <strong>$attribute</strong> gesetzt werden soll, muss je nach Attribut
                     möglicherweise einen bestimmten Typ haben.

<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>
   * PDO::getAttribute
   * PDO::setAttribute
   * PDOStatement::getAttribute


id: PDOStatement::setFetchMode
type: function
doc:
<comment>Description:</comment>
  Legt den standardmäßigen Abrufmodus eine Anweisung fest

<comment>Param:</comment>
  <info>int</info>         <strong>$mode</strong>             Der Abrufmodus muss eine der <return>PDO::FETCH_*</return>-Konstanten sein.
  <info>int</info>         <strong>$colno</strong>            Die Nummer der Spalte
  <info>string</info>      <strong>$class</strong>            Der Name der Klasse
  <info>array|null</info>  <strong>$constructorArgs</strong>  Konstruktorargumente
  <info>object</info>      <strong>$object</strong>           Das Objekt

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


id: PGSQL_ASSOC
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_fetch_array()</strong> übergeben. Gibt ein assoziatives Array zurück, mit den
  Feldnamen als Indizes und den entsprechenden Werten.


id: PGSQL_BAD_RESPONSE
type: constant
doc:
<comment>Description:</comment>
  Wird von der Funktion <strong>pg_result_status()</strong> zurückgegeben. Die Serverantwort wurde nicht verstanden.


id: PGSQL_BOTH
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_fetch_array()</strong> übergeben. Gibt ein Array zurück, das sowohl assoziativ (mit
  den Feldnamen) als auch numerisch (mit den Feldnummern) indiziert ist, und den entsprechenden
  Werten.


id: PGSQL_COMMAND_OK
type: constant
doc:
<comment>Description:</comment>
  Wird von der Funktion <strong>pg_result_status()</strong> zurückgegeben. Ein Kommando wurde erfolgreich ausgeführt,
  aber es wurden keine Daten zurückgegeben.


id: PGSQL_CONNECTION_BAD
type: constant
doc:
<comment>Description:</comment>
  Wird von der Funktion <strong>pg_connection_status()</strong> zurückgegeben und zeigt an, dass der Status der
  Datenbankverbindung ungültig ist.


id: PGSQL_CONNECTION_OK
type: constant
doc:
<comment>Description:</comment>
  Wird von der Funktion <strong>pg_connection_status()</strong> zurückgegeben und zeigt an, dass der Status der
  Datenbankverbindung gültig ist.


id: PGSQL_CONNECT_ASYNC
type: constant
doc:
<comment>Description:</comment>
  Wird an <strong>pg_connect()</strong> übergeben, um eine asynchrone Verbindung zu erzeugen.


id: PGSQL_CONNECT_FORCE_NEW
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_connect()</strong> übergeben, um eine neue Verbindung zu erzwingen, anstatt eine
  identische, bereits geöffnete Verbindung wieder zu benutzen.


id: PGSQL_CONV_FORCE_NULL
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_convert()</strong> übergeben. Anstelle eines leeren Strings <info>string</info> wird der
  SQL-Nullwert <return>NULL</return> benutzt.


id: PGSQL_CONV_IGNORE_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_convert()</strong> übergeben. Während der Konversion werden Standardwerte in der
  Tabelle ignoriert.


id: PGSQL_CONV_IGNORE_NOT_NULL
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_convert()</strong> übergeben. Die Konversion von <info>null</info> in SQL <return>NOT NULL</return>-Spalten wird
  ignoriert.


id: PGSQL_COPY_IN
type: constant
doc:
<comment>Description:</comment>
  Wird von der Funktion <strong>pg_result_status()</strong> zurückgegeben. Ein Datentransfer zum Server wurde
  gestartet.


id: PGSQL_COPY_OUT
type: constant
doc:
<comment>Description:</comment>
  Wird von der Funktion <strong>pg_result_status()</strong> zurückgegeben. Ein Datentransfer vom Server wurde
  gestartet.


id: PGSQL_DIAG_CONTEXT
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_result_error_field()</strong> übergeben. Dies gibt einen Hinweis auf den Kontext,
  in dem ein Fehler auftrat. Gegenwärtig sind Zurückverfolgungen des Aufrufstacks von Funktionen
  aktivierter prozeduraler Sprachen darin enthalten, sowie intern generierte Abfragen. Die
  Ablaufverfolgung enthält einen Eintrag pro Zeile, die neuesten Einträge zuerst.


id: PGSQL_DIAG_INTERNAL_POSITION
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_result_error_field()</strong> übergeben. Per Definition ist das dasselbe wie das
  Feld <info>PG_DIAG_STATEMENT_POSITION</info>, es wird aber benutzt, wenn die Cursorposition auf ein intern
  generiertes Kommando verweist und nicht auf eines, das vom Benutzer eingegeben wurde. Das Feld
  <info>PG_DIAG_INTERNAL_QUERY</info> wird immer gesetzt, wenn dieses Feld gesetzt ist.


id: PGSQL_DIAG_INTERNAL_QUERY
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_result_error_field()</strong> übergeben. Dies ist der Text eines fehlgeschlagenen,
  intern generierten Kommandos. Das kann beispielsweise eine SQL-Abfrage sein, die von einer
  PL/pgSQL-Funktion gesendet wurde.


id: PGSQL_DIAG_MESSAGE_DETAIL
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_result_error_field()</strong> übergeben. Detail: eine optionale untergeordnete
  Fehlermeldung, in der das Problem genauer beschrieben wird. Diese Meldung kann mehrere Zeilen lang
  sein.


id: PGSQL_DIAG_MESSAGE_HINT
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_result_error_field()</strong> übergeben. Hint: ein optionaler Hinweis, wie mit dem
  Problem umzugehen ist. Dies wurde eingeführt, um (möglicherweise unpassende) Lösungen zur
  Verfügung zu stellen, anstatt harte Fakten, wie bei Details. Diese Meldung kann mehrere Zeilen
  lang sein.


id: PGSQL_DIAG_MESSAGE_PRIMARY
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_result_error_field()</strong> übergeben. Dies ist die primäre, für Menschen lesbare
  Fehlermeldung (normalerweise in einer Zeile) und ist immer verfügbar.


id: PGSQL_DIAG_SEVERITY
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_result_error_field()</strong> übergeben. Gibt den Schweregrad des Fehlers zurück.
  Die Feldinhalte sind <return>ERROR</return>, <return>FATAL</return> oder <return>PANIC</return> (in einer Fehlermeldung) oder <return>WARNING</return>, <return>NOTICE</return>, <return>DEBUG</return>,
  <return>INFO</return> oder <return>LOG</return> (in einer Notice-Meldung) oder eine lokalisierte Übersetzung davon. Dieses Feld ist
  immer verfügbar.


id: PGSQL_DIAG_SEVERITY_NONLOCALIZED
type: constant
doc:
<comment>Description:</comment>
  Der Schweregrad. Das Feld enthält ERROR, FATAL oder PANIC (in einer Fehlermeldung), oder WARNING,
  NOTICE, DEBUG, INFO oder LOG (in einer Hinweismeldung). Dies ist identisch zum PG_DIAG_SEVERITY
  Feld, außer dass der Inhalt nie lokalisiert ist. Es ist nur ab Version 9.6 vorhanden.


id: PGSQL_DIAG_SOURCE_FILE
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_result_error_field()</strong> übergeben. Dies ist der Name der Datei im
  PostgreSQL-Quellcode, bei der der Fehler gemeldet wurde.


id: PGSQL_DIAG_SOURCE_FUNCTION
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_result_error_field()</strong> übergeben. Der Name der Funktion im
  PostgreSQL-Quellcode, bei der der Fehler gemeldet wurde.


id: PGSQL_DIAG_SOURCE_LINE
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_result_error_field()</strong> übergeben. Die Zeilennummer in der Datei im
  PostgreSQL-Quellcode, bei der der Fehler gemeldet wurde.


id: PGSQL_DIAG_SQLSTATE
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_result_error_field()</strong> übergeben. Gibt den SQLSTATE-Code des Fehlers zurück.
  Der SQLSTATE-Code identifiziert den Typ des aufgetretenen Fehlers. Dieser kann von Anwendungen
  ausgewertet werden, um entsprechende Operationen auszuführen (beispielsweise
  Fehlerbehandlungsroutinen), als Reaktion auf einen bestimmten Datenbankfehler. dieses Feld kann
  nicht lokalisiert werden und ist immer verfügbar.


id: PGSQL_DIAG_STATEMENT_POSITION
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_result_error_field()</strong> übergeben. Dies ist ein String, der eine dezimale
  Integerzahl enthält, die die Cursorposition des originalen SQL-Strings angibt, an der ein Fehler
  auftrat. Das erste Zeichen hat die Position 1 und zur Bestimmung der Positionen werden Zeichen
  zugrundegelegt und nicht Bytes.


id: PGSQL_DML_ASYNC
type: constant
doc:
<comment>Description:</comment>
  Wird an <strong>pg_insert()</strong>, <strong>pg_select()</strong>, <strong>pg_update()</strong> und <strong>pg_delete()</strong> übergeben. Führt eine asynchrone
  Abfrage durch diese Funktionen aus.


id: PGSQL_DML_ESCAPE
type: constant
doc:
<comment>Description:</comment>
  Wird an <strong>pg_insert()</strong>, <strong>pg_select()</strong>, <strong>pg_update()</strong> und <strong>pg_delete()</strong> übergeben. Maskiert alle Parameter
  anstatt <strong>pg_convert()</strong> intern aufzurufen. Diese Option verzichtet auf das Nachschlagen von
  Meta-Daten. Die Abfrage kann so schnell sein wie <strong>pg_query()</strong> und <strong>pg_send_query()</strong>.


id: PGSQL_DML_EXEC
type: constant
doc:
<comment>Description:</comment>
  Wird an <strong>pg_insert()</strong>, <strong>pg_select()</strong>, <strong>pg_update()</strong> und <strong>pg_delete()</strong> übergeben. Führt eine Abfrage durch
  diese Funktionen aus.


id: PGSQL_DML_NO_CONV
type: constant
doc:
<comment>Description:</comment>
  Wird an <strong>pg_insert()</strong>, <strong>pg_select()</strong>, <strong>pg_update()</strong> und <strong>pg_delete()</strong> übergeben. Alle Parameter werden
  übergeben wie sie sind. Manuelles Maskieren ist erforderlich, wenn Parameter Anwenderdaten
  enthalten. Dafür ist <strong>pg_escape_string()</strong> zu verwenden.


id: PGSQL_DML_STRING
type: constant
doc:
<comment>Description:</comment>
  Wird an <strong>pg_insert()</strong>, <strong>pg_select()</strong>, <strong>pg_update()</strong> und <strong>pg_delete()</strong> übergeben. Gibt den ausgeführten
  Abfragestring zurück.


id: PGSQL_EMPTY_QUERY
type: constant
doc:
<comment>Description:</comment>
  Wird von der Funktion <strong>pg_result_status()</strong> zurückgegeben, wenn der an den Server gesendete String
  leer war.


id: PGSQL_ERRORS_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_set_error_verbosity()</strong> übergeben. Die Standardeinstellung gibt Meldungen
  mit den oben beschriebenen Inhalten zurück, zuzüglich aller Details, Hinweise und
  Kontext-Informationen (dies kann mehrere Zeilen umfassen).


id: PGSQL_ERRORS_TERSE
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_set_error_verbosity()</strong> übergeben. Damit wird festgelegt, dass
  Fehlermeldungen die Felder severity, primary text und position enthalten. Normalerweise passt das
  alles in eine Zeile.


id: PGSQL_ERRORS_VERBOSE
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_set_error_verbosity()</strong> übergeben. In diesem Modus werden alle verfügbaren
  Felder zurückgegeben.


id: PGSQL_FATAL_ERROR
type: constant
doc:
<comment>Description:</comment>
  Wird von der Funktion <strong>pg_result_status()</strong> zurückgegeben. Ein fataler Fehler ist aufgetreten.


id: PGSQL_LIBPQ_VERSION_STR
type: constant
doc:
<comment>Description:</comment>
  Vor PHP 8.0.0 die lange libpq-Version, die Compiler-Informationen enthält. Ab PHP 8.0.0 ist der
  Wert identisch mit <info>PGSQL_LIBPQ_VERSION</info> und die Verwendung von <info>PGSQL_LIBPQ_VERSION_STR</info> ist
  veraltet.


id: PGSQL_NONFATAL_ERROR
type: constant
doc:
<comment>Description:</comment>
  Wird von der Funktion <strong>pg_result_status()</strong> zurückgegeben. Ein nicht-fataler Fehler (eine Notiz oder
  Warnung) ist aufgetreten.


id: PGSQL_NOTICE_ALL
type: constant
doc:
<comment>Description:</comment>
  Verwendet von <strong>pg_last_notice()</strong>. Verfügbar seit PHP 7.1.0.


id: PGSQL_NUM
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_fetch_array()</strong> übergeben. Gibt ein numerisches Array zurück, mit den
  Feldnummern als Indizes und den entsprechenden Werten.


id: PGSQL_POLLING_ACTIVE
type: constant
doc:
<comment>Description:</comment>
  Wird von <strong>pg_connect_poll()</strong> zurückgegeben, um anzuzeigen, dass die Verbindung zur Zeit aktiv ist.


id: PGSQL_POLLING_FAILED
type: constant
doc:
<comment>Description:</comment>
  Wird von <strong>pg_connect_poll()</strong> zurückgegeben, um anzuzeigen, dass der Verbindungsversuch fehlschlug.


id: PGSQL_POLLING_OK
type: constant
doc:
<comment>Description:</comment>
  Wird von <strong>pg_connect_poll()</strong> zurückgegeben, um anzuzeigen, dass die Verbindung bereit zur Verwendung
  ist.


id: PGSQL_POLLING_READING
type: constant
doc:
<comment>Description:</comment>
  Wird von <strong>pg_connect_poll()</strong> zurückgegeben, um anzuzeigen, dass die Verbindung auf Lesebereitschaft
  des PostgreSQL-Socket wartet.


id: PGSQL_POLLING_WRITING
type: constant
doc:
<comment>Description:</comment>
  Wird von <strong>pg_connect_poll()</strong> zurückgegeben, um anzuzeigen, dass die Verbindung auf
  Schreibbereitschaft des PostgreSQL-Socket wartet.


id: PGSQL_SEEK_CUR
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_lo_seek()</strong> übergeben. Das Objekt wird ab der aktuellen Position durchsucht.


id: PGSQL_SEEK_END
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_lo_seek()</strong> übergeben. Das Objekt wird ausgehend vom Ende durchsucht.


id: PGSQL_SEEK_SET
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_lo_seek()</strong> übergeben. Das Objekt wird von Beginn an durchsucht.


id: PGSQL_SHOW_CONTEXT_ALWAYS
type: constant
doc:
<comment>Description:</comment>
  Wird in <strong>pg_set_error_context_set_visibility()</strong> verwendet, damit die Felder des Kontexts in Fehler-,
  Hinweis- und Warnmeldungen enthalten sind. Verfügbar seit PHP 8.3.0.


id: PGSQL_SHOW_CONTEXT_ERRORS
type: constant
doc:
<comment>Description:</comment>
  Wird in <strong>pg_set_error_context_set_visibility()</strong> verwendet, damit die Felder des Kontexts nur in
  Fehlermeldungen enthalten sind. Dies ist das standardmäßige Verhalten. Verfügbar seit PHP 8.3.0.


id: PGSQL_SHOW_CONTEXT_NEVER
type: constant
doc:
<comment>Description:</comment>
  Wird in <strong>pg_set_error_context_set_visibility()</strong> verwendet, damit der Kontext nie angezeigt wird.
  Verfügbar seit PHP 8.3.0.


id: PGSQL_STATUS_LONG
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_result_status()</strong> übergeben. Zeigt an, dass ein numerischer Ergebniscode
  gewünscht ist.


id: PGSQL_STATUS_STRING
type: constant
doc:
<comment>Description:</comment>
  Wird an die Funktion <strong>pg_result_status()</strong> übergeben. Zeigt an, dass eine textuelles Ergebnis
  gewünscht ist.


id: PGSQL_TRACE_REGRESS_MODE
type: constant
doc:
<comment>Description:</comment>
  Wird in <strong>pg_trace()</strong> verwendet, damit solche Felder wie OIDs in die Meldungen der Ablaufverfolgung
  aufgenommen werden. Verfügbar seit PHP 8.3.0.


id: PGSQL_TRACE_SUPPRESS_TIMESTAMPS
type: constant
doc:
<comment>Description:</comment>
  Wird in <strong>pg_trace()</strong> verwendet, damit der Zeitstempel nicht in den Meldungen der Ablaufverfolgung
  enthalten ist. Verfügbar seit PHP 8.3.0.


id: PGSQL_TRANSACTION_ACTIVE
type: constant
doc:
<comment>Description:</comment>
  Wird von der Funktion <strong>pg_transaction_status()</strong> zurückgegeben. Die Verbindung wird momentan benutzt.
  Es wird eine Abfrage ausgeführt, die noch nicht beendet ist.


id: PGSQL_TRANSACTION_IDLE
type: constant
doc:
<comment>Description:</comment>
  Wird von der Funktion <strong>pg_transaction_status()</strong> zurückgegeben. Die Verbindung wird momentan nicht
  benutzt, es findet aktuell keine Transaktion statt.


id: PGSQL_TRANSACTION_INERROR
type: constant
doc:
<comment>Description:</comment>
  Wird von der Funktion <strong>pg_transaction_status()</strong> zurückgegeben. Die Verbindung wurde von einer
  abgebrochenen Transaktion benutzt und ist momentan nicht aktiv.


id: PGSQL_TRANSACTION_INTRANS
type: constant
doc:
<comment>Description:</comment>
  Wird von der Funktion <strong>pg_transaction_status()</strong> zurückgegeben. Die Verbindung wird von einer
  Transaktion benutzt, ist aber momentan nicht aktiv.


id: PGSQL_TRANSACTION_UNKNOWN
type: constant
doc:
<comment>Description:</comment>
  Wird von der Funktion <strong>pg_transaction_status()</strong> zurückgegeben. Die Verbindung ist ungültig.


id: PGSQL_TUPLES_OK
type: constant
doc:
<comment>Description:</comment>
  Wird von der Funktion <strong>pg_result_status()</strong> zurückgegeben. Ein Kommando wurde erfolgreich ausgeführt
  und es wurden Daten (wie etwa ein <return>SELECT</return> oder <return>SHOW</return>) zurückgegeben.


id: PHP_BINDIR
type: constant
doc:
<comment>Description:</comment>
  Der Wert von --bindir, der während der Konfiguration angegeben wurde. Unter Windows ist dies der
  Wert von --with-prefix, der während der Konfiguration angegeben wurde.


id: PHP_EXTENSION_DIR
type: constant
doc:
<comment>Description:</comment>
  Das Standardverzeichnis, in dem nach dynamisch ladbaren Erweiterungen gesucht werden soll (sofern
  es nicht durch extension_dir überschrieben wird). Der Standardwert ist <info>PHP_PREFIX</info> (oder PHP_PREFIX
  . "\\ext" unter Windows).


id: PHP_EXTRA_VERSION
type: constant
doc:
<comment>Description:</comment>
  Die aktuelle "Extra"-Versionsnummer von PHP als Zeichenkette (z. B. '-extra' bei Version
  "5.2.7-extra"). Wird oft von Distributionsanbietern zur Angabe einer Paketversion verwendet.


id: PHP_FD_SETSIZE
type: constant
doc:
<comment>Description:</comment>
  Die Höchstanzahl von Dateideskriptoren für select Systemaufrufe. Verfügbar ab PHP 7.1.0.


id: PHP_FLOAT_DIG
type: constant
doc:
<comment>Description:</comment>
  Die Anzahl von Dezimalstellen, die zu float und zurück ohne Genauigkeitsverlust gerundet werden
  können. Verfügbar ab PHP 7.2.0.


id: PHP_FLOAT_EPSILON
type: constant
doc:
<comment>Description:</comment>
  Die kleinste darstellbare positive Zahl x, sodass <return>x + 1.0 != 1.0</return>. Verfügbar ab PHP 7.2.0.


id: PHP_FLOAT_MIN
type: constant
doc:
<comment>Description:</comment>
  Die kleinste darstellbare positive Gleitkommazahl. Um die kleinste darstellbare negative
  Gleitkommazahl zu erhalten, ist <return>- PHP_FLOAT_MAX</return> zu verwenden. Verfügbar ab PHP 7.2.0.


id: PHP_INT_MAX
type: constant
doc:
<comment>Description:</comment>
  Die größtmögliche Ganzzahl, die von diesem Build von PHP unterstützt wird. Üblicherweise
  int(2147483647) auf 32-bit-Systemen und int(9223372036854775807) auf 64-bit-Systemen.


id: PHP_INT_MIN
type: constant
doc:
<comment>Description:</comment>
  Die kleinsmögliche Ganzzahl, die von diesem Build von PHP unterstützt wird. Üblicherweise
  int(-2147483648) auf 32-bit-Systemen und int(-922337206854775808) auf 64-bit-Systemen.
  Üblicherweise ist PHP_INT_MIN === ~PHP_INT_MAX.


id: PHP_MAJOR_VERSION
type: constant
doc:
<comment>Description:</comment>
  Die aktuelle "Hauptversion" von PHP als Ganzzahl (z. B. int(5) bei Version "5.2.7-extra").


id: PHP_MAXPATHLEN
type: constant
doc:
<comment>Description:</comment>
  Die maximale Länge von Dateinamen (inklusive Pfad), die von diesem Build von PHP unterstützt wird.


id: PHP_MINOR_VERSION
type: constant
doc:
<comment>Description:</comment>
  Die aktuelle "Unterversion" von PHP als Ganzzahl (z. B. int(2) bei Version "5.2.7-extra").


id: PHP_OS_FAMILY
type: constant
doc:
<comment>Description:</comment>
  Die Betriebssystemfamilie, für die PHP kompiliert wurde. Eins von <return>'Windows'</return>, <return>'BSD'</return>, <return>'Darwin'</return>,
  <return>'Solaris'</return>, <return>'Linux'</return> oder <return>'Unknown'</return> (unbekannt). Verfügbar ab PHP 7.2.0.


id: PHP_OUTPUT_HANDLER_CLEANABLE
type: constant
doc:
<comment>Description:</comment>
  Steuert, ob ein durch <strong>ob_start()</strong> erzeugter Ausgabepuffer gelöscht werden kann.


id: PHP_OUTPUT_HANDLER_CONT
type: constant
doc:
<comment>Description:</comment>
  Zeigt an, dass der Ausgabepuffer geleert und ausgegeben wurde, aber die Pufferung fortgesetzt
  wird.
  
  Es ist ein Alias für <info>PHP_OUTPUT_HANDLER_WRITE</info>.


id: PHP_OUTPUT_HANDLER_END
type: constant
doc:
<comment>Description:</comment>
  Zeigt an, dass die Ausgabepufferung endete.
  
  Es ist ein Alias für <info>PHP_OUTPUT_HANDLER_FINAL</info>.


id: PHP_OUTPUT_HANDLER_FLUSHABLE
type: constant
doc:
<comment>Description:</comment>
  Steuert, ob ein durch <strong>ob_start()</strong> erzeugter Ausgabepuffer geleert und ausgegeben werden kann.


id: PHP_OUTPUT_HANDLER_REMOVABLE
type: constant
doc:
<comment>Description:</comment>
  Steuert, ob ein durch <strong>ob_start()</strong> erzeugter Ausgabepuffer vor Ende der Skriptlaufzeit entfernt
  werden kann.


id: PHP_OUTPUT_HANDLER_STDFLAGS
type: constant
doc:
<comment>Description:</comment>
  Die Standardeinstellungen der Pufferflags. Derzeit gleichbedeutend mit
  <info>PHP_OUTPUT_HANDLER_CLEANABLE</info> | <info>PHP_OUTPUT_HANDLER_FLUSHABLE</info> | <info>PHP_OUTPUT_HANDLER_REMOVABLE</info>.


id: PHP_OUTPUT_HANDLER_WRITE
type: constant
doc:
<comment>Description:</comment>
  Zeigt an, dass der Ausgabepuffer geleert wird und Daten zur Ausgabe bereitstehen.


id: PHP_PREFIX
type: constant
doc:
<comment>Description:</comment>
  Der Wert von --prefix, der während der Konfiguration angegeben wurde. Unter Windows ist dies der
  Wert von --with-prefix, der während der Konfiguration angegeben wurde.


id: PHP_QUERY_RFC1738
type: constant
doc:
<comment>Description:</comment>
  Die Kodierung wird gemäß RFC 1738 und dem Medientyp <return>application/x-www-form-urlencoded</return>
  durchgeführt, was impliziert, dass Leerzeichen als Pluszeichen (<return>+</return>) kodiert werden.


id: PHP_QUERY_RFC3986
type: constant
doc:
<comment>Description:</comment>
  Die Kodierung wird gemäß RFC 3986 durchgeführt, und Leerzeichen werden prozentkodiert (<return>%20</return>).


id: PHP_RELEASE_VERSION
type: constant
doc:
<comment>Description:</comment>
  Die aktuelle "Release"-Version von PHP als Ganzzahl (z. B. int(7) bei Version "5.2.7-extra").


id: PHP_SAPI
type: constant
doc:
<comment>Description:</comment>
  Die Server-API dieses Builds von PHP. Siehe auch <strong>php_sapi_name()</strong>.


id: PHP_SESSION_ACTIVE
type: constant
doc:
<comment>Description:</comment>
  Der Rückgabewert von <strong>session_status()</strong>, falls Sessions aktiviert sind und eine Session existiert.


id: PHP_SESSION_DISABLED
type: constant
doc:
<comment>Description:</comment>
  Der Rückgabewert von <strong>session_status()</strong>, falls Sessions deaktiviert sind.


id: PHP_SESSION_NONE
type: constant
doc:
<comment>Description:</comment>
  Der Rückgabewert von <strong>session_status()</strong>, falls Sessions aktiviert sind, aber keine Session
  existiert.


id: PHP_SHLIB_SUFFIX
type: constant
doc:
<comment>Description:</comment>
  Die Dateiendung für dynamische Bibliotheken der Build-Plattform, beispielsweise "so" (die meisten
  Unixe) oder "dll" (Windows").


id: PHP_URL_FRAGMENT
type: constant
doc:
<comment>Description:</comment>
  Gibt das Fragment (Zeichenkette nach der Raute #) der geparsten URL aus.


id: PHP_VERSION
type: constant
doc:
<comment>Description:</comment>
  Die aktuelle PHP-Version als Zeichenkette im Format "Hauptversion.Unterversion.Release[Extra]".


id: PHP_VERSION_ID
type: constant
doc:
<comment>Description:</comment>
  Die aktuelle PHP-Version als Ganzzahl. Nützlich beispielsweise für Versionsvergleiche (z. B.
  int(50207) bei Version "5.2.7-extra").


id: PHP_WINDOWS_EVENT_CTRL_BREAK
type: constant
doc:
<comment>Description:</comment>
  Windows-Ereignis <return>CTRL+BREAK</return>. Verfügbar von PHP 7.4.0 an (nur Windows).


id: PHP_WINDOWS_EVENT_CTRL_C
type: constant
doc:
<comment>Description:</comment>
  Windows-Ereignis <return>CTRL+C</return>. Verfügbar von PHP 7.4.0 an (nur Windows).


id: PHP_WINDOWS_NT_SERVER
type: constant
doc:
<comment>Description:</comment>
  Es handelt sich um ein Serversystem (z. B. Server 2008/2003/2000); es ist zu beachten, dass
  Domänen-Controller als <info>PHP_WINDOWS_NT_DOMAIN_CONTROLLER</info> gemeldet werden.


id: PHP_WINDOWS_NT_WORKSTATION
type: constant
doc:
<comment>Description:</comment>
  Es handelt sich um ein Arbeitsplatzsystem (z. B. Vista/XP/2000/NT4).


id: PHP_WINDOWS_VERSION_BUILD
type: constant
doc:
<comment>Description:</comment>
  Die Windows-Buildnummer (beispielsweise ist Windows Vista mit SP1 Build 6001).


id: PHP_WINDOWS_VERSION_MAJOR
type: constant
doc:
<comment>Description:</comment>
  Die Hauptversion von Windows, also entweder <return>4</return> (NT4/Me/98/95), <return>5</return> (XP/2003 R2/2003/2000) oder <return>6</return>
  (Vista/2008/7/8/8.1).


id: PHP_WINDOWS_VERSION_MINOR
type: constant
doc:
<comment>Description:</comment>
  Die Nebenversion von Windows, also entweder <return>0</return> (Vista/2008/2000/NT4/95), <return>1</return> (XP), <return>2</return> (2003 R2/2003/XP
  x64), <return>10</return> (98) oder <return>90</return> (ME).


id: PHP_WINDOWS_VERSION_PLATFORM
type: constant
doc:
<comment>Description:</comment>
  Die Plattform, auf der PHP ausgeführt wird, also <return>2</return> unter Windows Vista/XP/2000/NT4 und Server
  2008/2003 und <return>1</return> unter Windows ME/98/95.


id: PHP_WINDOWS_VERSION_PRODUCTTYPE
type: constant
doc:
<comment>Description:</comment>
  Diese enthält den Wert, der verwendet wird, um die <return>PHP_WINDOWS_NT_*</return>-Konstanten zu bestimmen.
  Dieser Wert kann eine der <return>PHP_WINDOWS_NT_*</return>-Konstanten sein, die den Plattformtyp anzeigen.


id: PHP_WINDOWS_VERSION_SP_MAJOR
type: constant
doc:
<comment>Description:</comment>
  Die Hauptversion des installierten Service-Packs; dieser Wert ist <return>0</return>, wenn kein Service-Pack
  installiert ist. Beispielsweise ist dieser Wert unter Windows XP mit Service-Pack 3 <return>3</return>.


id: PHP_WINDOWS_VERSION_SP_MINOR
type: constant
doc:
<comment>Description:</comment>
  Die Nebenversion des installierten Service-Packs; dieser Wert ist <return>0</return>, wenn kein Service-Pack
  installiert ist.


id: PHP_WINDOWS_VERSION_SUITEMASK
type: constant
doc:
<comment>Description:</comment>
  Die Suitemask ist eine Bitmaske, die angibt, ob verschiedene Windows-Features installiert sind. In
  der Tabelle weiter unten werden die möglichen Bitfeldwerte angeführt.


id: PKCS7_BINARY
type: constant
doc:
<comment>Description:</comment>
  Normalerweise wird die Nachricht in ein "kanonisches" Format konvertiert, das effektiv <return>CR</return> und <return>LF</return>
  als Zeilende verwendet, wie von der S/MIME-Spezifikation gefordert. Wird diese Option angegeben,
  findet keine Konvertierung statt. Dies ist nützlich beim Umgang mit Binärdaten, die nicht im
  MIME-Format vorliegen.


id: PKCS7_DETACHED
type: constant
doc:
<comment>Description:</comment>
  Beim Signieren einer Nachricht wird die Klartext-Signierung mit dem MIME-Typ <return>"multipart/signed"</return>
  verwendet. Das ist der Standard, wenn in <strong>$flags</strong> keine optionalen Parameter an die Funktion
  <strong>openssl_pkcs7_sign()</strong> übergeben werden. Wenn Sie diese Option ausschalten, wird die Nachricht mit
  einer intransparenten Signatur unterzeichnet. Dieses Verhalten ist robuster gegenüber der
  Übersetzung durch Mail-Relays, kann aber nicht mit Mailprogrammen gelesen werden, die den
  S/Mime-Standard nicht unterstützen.


id: PKCS7_NOCERTS
type: constant
doc:
<comment>Description:</comment>
  Beim Signieren einer Nachricht wird normalerweise das Zertifikat des Unterzeichnenden mit in die
  Nachricht aufgenommen. Mit dieser Option wird das Zertifikat nicht mit aufgenommen. Diese Option
  verringert die Größe der signierten Nachricht, aber der Überprüfende muss eine lokale Kopie des
  Zertifikats vom Unterzeichnenden besitzen (zum Beispiel durch Angabe des Parameters <strong>$extracerts</strong> in
  der Funktion <strong>openssl_pkcs7_verify()</strong>).


id: PKCS7_NOCHAIN
type: constant
doc:
<comment>Description:</comment>
  Die Überprüfung der Zertifikate des Unterzeichners nicht verketten, das bedeutet, die Zertifikate
  in der signierten Nachricht werden nicht als nicht vertrauenswürdige CAs verwendet.


id: PKCS7_NOINTERN
type: constant
doc:
<comment>Description:</comment>
  Beim Überprüfen einer Nachricht werden in der Nachricht enthaltene Zertifikate (falls vorhanden)
  nach dem Signatur-Zertifikat durchsucht. Mit dieser Option werden nur Zertifikate verwendet, die
  mit dem Parameter <strong>$extracerts</strong> in der Funktion <strong>openssl_pkcs7_verify()</strong> angegeben wurden. Die
  mitgelieferten Zertifikate können aber dennoch verwendet werden, allerdings als nicht
  vertrauenswürdige CAs.


id: PKCS7_NOOLDMIMETYPE
type: constant
doc:
<comment>Description:</comment>
  Verfügbar ab PHP 8.3.0. Setzt den Inhaltstyp auf <return>application/pkcs7-mime</return> anstelle von
  <return>application/x-pkcs7-mime</return>, um eine Nachricht zu verschlüsseln.


id: PNG_ALL_FILTERS
type: constant
doc:
<comment>Description:</comment>
  Ein spezieller PNG-Filter, der von der Funktion <strong>imagepng()</strong> verwendet wird.


id: POSIX_PC_ALLOC_SIZE_MIN
type: constant
doc:
<comment>Description:</comment>
  Die Mindestanzahl von Bytes, die für einen beliebigen Teil einer Datei zugewiesen werden.
  Verfügbar seit PHP 8.3.0.


id: POSIX_PC_ALLOC_SYMLINK_MAX
type: constant
doc:
<comment>Description:</comment>
  Die maximale Anzahl symbolischer Links, die eine bestimmte Datei oder ein bestimmtes Verzeichnis
  haben darf. Verfügbar seit PHP 8.3.0.


id: POSIX_PC_CHOWN_RESTRICTED
type: constant
doc:
<comment>Description:</comment>
  Wenn Berechtigungen erforderlich sind, damit <strong>chown()</strong> funktioniert. Verfügbar seit PHP 8.3.0.


id: POSIX_PC_LINK_MAX
type: constant
doc:
<comment>Description:</comment>
  Die maximale Anzahl von Links, die eine bestimmte Datei oder ein bestimmtes Verzeichnis haben
  darf. Verfügbar seit PHP 8.3.0.


id: POSIX_PC_MAX_CANON
type: constant
doc:
<comment>Description:</comment>
  Die maximale Anzahl von Bytes in einem kanonischen Eingabepuffer eines Terminals (wobei der
  Pfadname dann eine zeichenorientierte Spezialdatei ist). Verfügbar seit PHP 8.3.0.


id: POSIX_PC_MAX_INPUT
type: constant
doc:
<comment>Description:</comment>
  Die maximale Anzahl von Bytes in der Eingabe-Warteschlange eines Terminals (wobei der Pfadname
  dann eine zeichenorientierte Spezialdatei ist). Verfügbar seit PHP 8.3.0.


id: POSIX_PC_NAME_MAX
type: constant
doc:
<comment>Description:</comment>
  Die maximale Anzahl von Zeichen für einen Dateinamen allein, ohne den Pfad. Verfügbar seit PHP
  8.3.0.


id: POSIX_PC_NO_TRUNC
type: constant
doc:
<comment>Description:</comment>
  Wenn ein Dateiname (oder Dateien unter einem Verzeichnis) länger ist, als <info>POSIX_PC_NAME_MAX</info>.
  Verfügbar seit PHP 8.3.0.


id: POSIX_PC_PATH_MAX
type: constant
doc:
<comment>Description:</comment>
  Die maximale Anzahl von Zeichen für einen kompletten Pfadnamen. Verfügbar seit PHP 8.3.0.


id: POSIX_PC_PIPE_BUF
type: constant
doc:
<comment>Description:</comment>
  Die maximale Anzahl von Bytes, die in einer Operation in eine Pipe geschrieben werden können.
  Verfügbar seit PHP 8.3.0.


id: POSIX_RLIMIT_AS
type: constant
doc:
<comment>Description:</comment>
  Die Maximalgröße des Adressraums des Prozesses in Bytes. Siehe auch die Konfigurationsdirektive
  memory_limit von PHP.


id: POSIX_RLIMIT_CORE
type: constant
doc:
<comment>Description:</comment>
  Die Maximalgröße einer Core-Dump-Datei. Ist das Limit 0, dann wird keine Core-Dump-Datei erzeugt.


id: POSIX_RLIMIT_CPU
type: constant
doc:
<comment>Description:</comment>
  Die maximale CPU-Zeit, die ein Prozess nutzen kann, in Sekunden. Ist das weiche Limit erreicht,
  wird ein <return>SIGXCPU</return>-Signal gesendet, das mit <strong>pcntl_signal()</strong> abgefangen werden kann. In Abhängigkeit
  vom Betriebssystem können jede Sekunde weitere <return>SIGXCPU</return>-Signale gesendet werden, solange bis das
  harte Limit erreicht ist, was dazu führt, dass ein nicht abfangbares <return>SIGKILL</return>-Signal gesendet wird.
  
  Siehe auch <strong>set_time_limit()</strong>.


id: POSIX_RLIMIT_DATA
type: constant
doc:
<comment>Description:</comment>
  Die Maximalgröße des Datensegments des Prozesses in Bytes. Es ist sehr unwahrscheinlich, dass
  diese irgendeine Auswirkung auf die Ausführung von PHP hat, es sei denn, dass eine Erweiterung
  verwendet wird, die <strong>brk()</strong> oder <strong>sbrk()</strong> aufruft.


id: POSIX_RLIMIT_FSIZE
type: constant
doc:
<comment>Description:</comment>
  Die Maximalgröße von Dateien, die der Prozess erzeugen kann, in Bytes.


id: POSIX_RLIMIT_INFINITY
type: constant
doc:
<comment>Description:</comment>
  Wird verwendet, um einen unbegrenzten Wert für ein Ressourcenlimit anzuzeigen.


id: POSIX_RLIMIT_KQUEUES
type: constant
doc:
<comment>Description:</comment>
  Die maximale Anzahl von kqueues, die diese Nutzerkennung erstellen darf (FreeBSD). Verfügbar seit
  PHP 8.1.0.


id: POSIX_RLIMIT_LOCKS
type: constant
doc:
<comment>Description:</comment>
  Die maximale Anzahl von Sperren, die der Prozess erzeugen kann. Dies wird nur auf sehr alten
  Linux-Systemkernen unterstützt.


id: POSIX_RLIMIT_MEMLOCK
type: constant
doc:
<comment>Description:</comment>
  Die maximale Anzahl von Bytes, die im Speicher gesperrt werden können.


id: POSIX_RLIMIT_MSGQUEUE
type: constant
doc:
<comment>Description:</comment>
  Die maximale Anzahl von Bytes, die für POSIX-Nachrichtenwarteschlangen belegt werden können. PHP
  unterstützt POSIX-Nachrichtenwarteschlangen nicht, so dass dieses Limit keine Auswirkung hat, es
  sei denn eine Erweiterung würde verwendet, die diese Unterstützung implementiert.


id: POSIX_RLIMIT_NICE
type: constant
doc:
<comment>Description:</comment>
  Der Höchstwert, auf den die Prozesspriorität geändert werden kann. Der zu nutzende Wert ist <return>20 -
  limit</return>, da Ressourcenlimits nicht negativ sein können.


id: POSIX_RLIMIT_NOFILE
type: constant
doc:
<comment>Description:</comment>
  Ein Wert, der um eins größer ist, als die größte Dateikennungszahl, die von diesem Prozess
  geöffnet werden kann.


id: POSIX_RLIMIT_NPROC
type: constant
doc:
<comment>Description:</comment>
  Die maximale Anzahl von Prozessen (und/oder Threads auf manchem Betriebssystemen), die für die
  reelle Nutzerkennung des Prozesses erzeugt werden kann.


id: POSIX_RLIMIT_NPTS
type: constant
doc:
<comment>Description:</comment>
  Die maximale Anzahl von Pseudoterminals, die diese Nutzerkennung erstellen darf (FreeBSD).
  Verfügbar seit PHP 8.1.0.


id: POSIX_RLIMIT_RTPRIO
type: constant
doc:
<comment>Description:</comment>
  Die maximale Echtzeitpriorität, die mit den Systemaufrufen <strong>sched_setscheduler()</strong> und
  <strong>sched_setparam()</strong>, eingestellt werden kann.


id: POSIX_RLIMIT_RTTIME
type: constant
doc:
<comment>Description:</comment>
  Die maximale Menge an CPU-Zeit in Mikrosekunden, die der Prozess verbrauchen kann, ohne einen
  blockierenden Systemaufruf durchzuführen, wenn er Echtzeit-Scheduling verwendet.


id: POSIX_RLIMIT_SIGPENDING
type: constant
doc:
<comment>Description:</comment>
  Die maximale Anzahl von Signalen, die für die reelle Nutzerkennung des Prozesses in die
  Warteschlange eingereiht werden können.


id: POSIX_SC_ARG_MAX
type: constant
doc:
<comment>Description:</comment>
  Die maximale Anzahl von Bytes, die Argumente (und Umgebungsvariablen) haben dürfen. Verfügbar seit
  PHP 8.3.0.


id: POSIX_SC_NPROCESSORS_CONF
type: constant
doc:
<comment>Description:</comment>
  Die Anzahl der im System konfigurierten CPUs. Verfügbar seit PHP 8.3.0.


id: POSIX_SC_NPROCESSORS_ONLN
type: constant
doc:
<comment>Description:</comment>
  Die Anzahl der derzeit im System aktiven CPUs. Verfügbar seit PHP 8.3.0.


id: POSIX_SC_PAGESIZE
type: constant
doc:
<comment>Description:</comment>
  Die Anzahl der Bytes der aktuellen Speicherseite. Verfügbar seit PHP 8.3.0.


id: POSIX_W_OK
type: constant
doc:
<comment>Description:</comment>
  Prüft, ob die Datei existiert und ob sie geschrieben werden darf.


id: PREG_BACKTRACK_LIMIT_ERROR
type: constant
doc:
<comment>Description:</comment>
  Dieses Flag wird von <strong>preg_last_error()</strong> zurückgegeben, falls das Limit der Zurückverfolgung
  (Backtracking) überschritten wurde.
  
  5.2.0


id: PREG_BAD_UTF8_ERROR
type: constant
doc:
<comment>Description:</comment>
  Dieses Flag wird von <strong>preg_last_error()</strong> zurückgegeben, falls der letzte Fehler durch fehlerhafte
  UTF-8-Daten verursacht wurde (nur bei RegEx, die im UTF-8-Modus laufen).
  
  5.2.0


id: PREG_BAD_UTF8_OFFSET_ERROR
type: constant
doc:
<comment>Description:</comment>
  Dieses Flag wird von <strong>preg_last_error()</strong> zurückgegeben, falls sich der Versatz nicht mit dem Anfang
  eines gültigen UTF-8-Codepoints deckt (nur wenn die RegEx im UTF-8-Modus ausgeführt wird).
  
  5.3.0


id: PREG_INTERNAL_ERROR
type: constant
doc:
<comment>Description:</comment>
  Dieses Flag wird von <strong>preg_last_error()</strong> zurückgegeben, falls ein interner PCRE-Fehler aufgetreten
  ist.
  
  5.2.0


id: PREG_JIT_STACKLIMIT_ERROR
type: constant
doc:
<comment>Description:</comment>
  Dieses Flag wird von <strong>preg_last_error()</strong> zurückgegeben, falls die letzte PCRE-Funktion wegen
  begrenzten Speichers im JIT-Stack fehlschlug.
  
  7.0.0


id: PREG_NO_ERROR
type: constant
doc:
<comment>Description:</comment>
  Dieses Flag wird von <strong>preg_last_error()</strong> zurückgegeben, falls kein Fehler aufgetreten ist.
  
  5.2.0


id: PREG_PATTERN_ORDER
type: constant
doc:
<comment>Description:</comment>
  Sortiert die Ergebnisse so, dass $matches[0] ein Array von Übereinstimmungen mit dem ganzen
  Suchmuster ist, $matches[1] ein Array von Zeichenketten, die mit dem ersten geklammerten
  Teilsuchmuster übereinstimmen und so weiter. Dieses Flag wird nur bei <strong>preg_match_all()</strong> verwendet.


id: PREG_RECURSION_LIMIT_ERROR
type: constant
doc:
<comment>Description:</comment>
  Dieses Flag wird von <strong>preg_last_error()</strong> zurückgegeben, falls das Rekursionslimit überschritten
  wurde.
  
  5.2.0


id: PREG_SET_ORDER
type: constant
doc:
<comment>Description:</comment>
  Sortiert die Ergebnisse so, dass $matches[0] ein Array des ersten Satzes von Übereinstimmungen
  ist, $matches[1] ein Array des zweiten Satzes von Übereinstimmungen und so weiter. Dieses Flag
  wird nur bei <strong>preg_match_all()</strong> verwendet.


id: PREG_SPLIT_DELIM_CAPTURE
type: constant
doc:
<comment>Description:</comment>
  Dieses Flag teilt der Funktion <strong>preg_split()</strong> mit, dass sie auch die eingeklammerten Ausdrücke des
  Trennsymbol-Musters zurückgeben soll.


id: PREG_SPLIT_NO_EMPTY
type: constant
doc:
<comment>Description:</comment>
  Dieses Flag teilt der Funktion <strong>preg_split()</strong> mit, dass sie nur nicht-leere Teile zurückgeben soll.


id: PREG_SPLIT_OFFSET_CAPTURE
type: constant
doc:
<comment>Description:</comment>
  Wenn dieses Flag gesetzt ist, wird für jede gefundene Übereinstimmung auch der dazugehörige
  Versatz zurückgegeben. Beachten Sie, dass dies die Rückgabewerte in einem Array dahingehend
  ändert, dass jedes Element ein Array ist, das aus der übereinstimmenden Zeichenkette als erstem
  und deren Stelle im durchsuchten Text als zweitem Element besteht. Dieses Flag wird nur für
  <strong>preg_split()</strong> verwendet.


id: PREG_UNMATCHED_AS_NULL
type: constant
doc:
<comment>Description:</comment>
  Dieses Flag teilt der Funktion <strong>preg_match()</strong> und <strong>preg_match_all()</strong> mit, dass nicht gefundene
  Teilsuchmuster in $matches als <info>null</info>-Werte enthalten sein sollen. Ohne dieses Flag werden nicht
  gefundene Teilsuchmuster als leere Zeichenketten angegeben, so als ob es leere Übereinstimmungen
  wären. Das Setzen dieses Flags erlaubt es zwischen diesen beiden Fällen zu unterscheiden.
  
  7.2.0


id: PSFS_ERR_FATAL
type: constant
doc:
<comment>Description:</comment>
  <return>Return Code</return> indicating that the userspace filter encountered an unrecoverable error (i.e. Invalid
  data received).


id: PSFS_FEED_ME
type: constant
doc:
<comment>Description:</comment>
  <return>Return Code</return> indicating that the userspace filter did not return buckets in <strong>$out</strong> (i.e. No data
  available).


id: PSFS_PASS_ON
type: constant
doc:
<comment>Description:</comment>
  <return>Return Code</return> indicating that the userspace filter returned buckets in <strong>$out</strong>.


id: PSpell\Config
type: class
doc:
<comment>Description:</comment>
  A fully opaque class which replaces a <return>pspell config</return> resource as of PHP 8.1.0.


id: PSpell\Dictionary
type: class
doc:
<comment>Description:</comment>
  A fully opaque class which replaces a <return>pspell</return> resource as of PHP 8.1.0.


id: PTHREADS_ALLOW_HEADERS
type: constant
doc:
<comment>Description:</comment>
  Allow new Threads to send headers to standard output (normally prohibited)


id: PTHREADS_INHERIT_ALL
type: constant
doc:
<comment>Description:</comment>
  The default options for all Threads, causes pthreads to copy the environment when new Threads are
  started


id: ParentIterator
type: class
doc:
<comment>Description:</comment>
  This extended <class>FilterIterator</class> allows a recursive iteration using <class>RecursiveIteratorIterator</class> that
  only shows those elements which have children.


id: ParentIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a ParentIterator
  
  Constructs a <class>ParentIterator</class> on an iterator.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>RecursiveIterator</info>  <strong>$iterator</strong>  The iterator being constructed upon.


id: ParentIterator::accept
type: function
doc:
<comment>Description:</comment>
  Determines acceptability
  
  Determines if the current element has children.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the current element is acceptable, otherwise <info>false</info>.

<comment>See Also:</comment>
   * ParentIterator::hasChildren
   * FilterIterator::accept


id: ParentIterator::getChildren
type: function
doc:
<comment>Description:</comment>
  Return the inner iterator's children contained in a ParentIterator
  
  Get the inner iterator's children contained in a ParentIterator.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>ParentIterator</info>  An <info>object</info>.


id: ParentIterator::hasChildren
type: function
doc:
<comment>Description:</comment>
  Check whether the inner iterator's current element has children
  
  Check whether the inner iterator's current element has children.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

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


id: ParentIterator::next
type: function
doc:
<comment>Description:</comment>
  Move the iterator forward
  
  Moves the iterator forward.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

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


id: ParentIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind the iterator
  
  Rewinds the iterator.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

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


id: Parle\ErrorInfo
type: class
doc:
<comment>Description:</comment>
  The class represents detailed error information as supplied by Parle\Parser::errorInfo


id: Parle\INTERNAL_UTF32
type: constant
doc:
<comment>Description:</comment>
  Flag whether the internal UTF-32 support is compiled in. Available since parle 0.7.2.


id: Parle\Lexer
type: class
doc:
<comment>Description:</comment>
  Single state lexer class. Lexemes can be defined on the fly. If the particular lexer instance is
  meant to be used with <class>Parle\Parser</class>, the token IDs need to be taken from there. Otherwise,
  arbitrary token IDs can be supplied. This lexer can give a certain performance advantage over
  <class>Parle\RLexer</class>, if no multiple states are required. Note, that <class>Parle\RParser</class> is not compatible with
  this lexer.


id: Parle\Lexer::advance
type: function
doc:
<comment>Description:</comment>
  Process next lexer rule
  
  Processes the next rule and prepares the resulting token data.

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


id: Parle\Lexer::build
type: function
doc:
<comment>Description:</comment>
  Finalize the lexer rule set
  
  Rules, previously added with Parle\Lexer::push are finalized. This method call has to be done
  after all the necessary rules was pushed. The rule set becomes read only. The lexing can begin.

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


id: Parle\Lexer::callout
type: function
doc:
<comment>Description:</comment>
  Define token callback
  
  Define a callback to be invoked once lexer encounters a particular token.

<comment>Param:</comment>
  <info>int</info>       <strong>$id</strong>        Token id.
  <info>callable</info>  <strong>$callback</strong>  Callable to be invoked. The callable doesn't receive any arguments and its
                       return value is ignored.

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


id: Parle\Lexer::consume
type: function
doc:
<comment>Description:</comment>
  Pass the data for processing
  
  Consume the data for lexing.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Data to be lexed.

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


id: Parle\Lexer::dump
type: function
doc:
<comment>Description:</comment>
  Dump the state machine
  
  Dump the current state machine to stdout.

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


id: Parle\Lexer::getToken
type: function
doc:
<comment>Description:</comment>
  Retrieve the current token
  
  Retrieve the current token.

<comment>Return:</comment>
  <info>Parle\Token</info>  Returns an instance of <class>Parle\Token</class>.


id: Parle\Lexer::insertMacro
type: function
doc:
<comment>Description:</comment>
  Insert regex macro
  
  Insert a regex macro, that can be later used as a shortcut and included in other regular
  expressions.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Name of the macros.
  <info>string</info>  <strong>$regex</strong>  Regular expression.

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


id: Parle\Lexer::push
type: function
doc:
<comment>Description:</comment>
  Add a lexer rule
  
  Push a pattern for lexeme recognition.

<comment>Param:</comment>
  <info>string</info>  <strong>$regex</strong>  Regular expression used for token matching.
  <info>int</info>     <strong>$id</strong>     Token id. If the lexer instance is meant to be used standalone, this can be an
                  arbitrary number. If the lexer instance is going to be passed to the parser, it
                  has to be an id returned by Parle\Parser::tokenid.

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


id: Parle\Lexer::reset
type: function
doc:
<comment>Description:</comment>
  Reset lexer
  
  Reset lexing optionally supplying the desired offset.

<comment>Param:</comment>
  <info>int</info>  <strong>$pos</strong>  Reset position.

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


id: Parle\Parser
type: class
doc:
<comment>Description:</comment>
  Parser class. Rules can be defined on the fly. Once finalized, a <class>Parle\Lexer</class> instance is required
  to deliver the token stream.


id: Parle\Parser::advance
type: function
doc:
<comment>Description:</comment>
  Process next parser rule
  
  Process next parser rule.

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


id: Parle\Parser::build
type: function
doc:
<comment>Description:</comment>
  Finalize the grammar rules
  
  Any tokens and grammar rules previously added are finalized. The rule set becomes readonly and the
  parser is ready to start.

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


id: Parle\Parser::consume
type: function
doc:
<comment>Description:</comment>
  Consume the data for processing
  
  Consume the data for parsing.

<comment>Param:</comment>
  <info>string</info>       <strong>$data</strong>   Data to be parsed.
  <info>Parle\Lexer</info>  <strong>$lexer</strong>  A lexer object containing the lexing rules prepared for the particular
                       grammar.

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


id: Parle\Parser::dump
type: function
doc:
<comment>Description:</comment>
  Dump the grammar
  
  Dump the current grammar to stdout.

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


id: Parle\Parser::errorInfo
type: function
doc:
<comment>Description:</comment>
  Retrieve the error information
  
  Retrieve the error information in case Parle\Parser::action returned the error action.

<comment>Return:</comment>
  <info>Parle\ErrorInfo</info>  Returns an instance of <class>Parle\ErrorInfo</class>.


id: Parle\Parser::left
type: function
doc:
<comment>Description:</comment>
  Declare a token with left-associativity
  
  Declare a terminal with left associativity.

<comment>Param:</comment>
  <info>string</info>  <strong>$tok</strong>  Token name.

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


id: Parle\Parser::nonassoc
type: function
doc:
<comment>Description:</comment>
  Declare a token with no associativity
  
  Declare a terminal, that cannot appear more than once in the row.

<comment>Param:</comment>
  <info>string</info>  <strong>$tok</strong>  Token name.

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


id: Parle\Parser::precedence
type: function
doc:
<comment>Description:</comment>
  Declare a precedence rule
  
  Declares a precedence rule for a fictitious terminal symbol. This rule can be later used in the
  specific grammar rules.

<comment>Param:</comment>
  <info>string</info>  <strong>$tok</strong>  Token name.

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


id: Parle\Parser::push
type: function
doc:
<comment>Description:</comment>
  Add a grammar rule
  
  Push a grammar rule. The production id returned can be used later in the parsing process to
  identify the rule matched.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Rule name.
  <info>string</info>  <strong>$rule</strong>  The rule to be added. The syntax is Bison compatible.

<comment>Return:</comment>
  <info>int</info>  Returns Integer representing the rule index.


id: Parle\Parser::reset
type: function
doc:
<comment>Description:</comment>
  Reset parser state
  
  Reset parser state using the given token id.

<comment>Param:</comment>
  <info>int</info>  <strong>$tokenId</strong>  Token id.

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


id: Parle\Parser::right
type: function
doc:
<comment>Description:</comment>
  Declare a token with right-associativity
  
  Declare a terminal with right associativity.

<comment>Param:</comment>
  <info>string</info>  <strong>$tok</strong>  Token name.

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


id: Parle\Parser::sigil
type: function
doc:
<comment>Description:</comment>
  Retrieve a matching part of a rule
  
  Retrieve a part of the match by a rule. This method is equivalent to the pseudo variable
  functionality in Bison.

<comment>Param:</comment>
  <info>int</info>  <strong>$idx</strong>  Match index, zero based.

<comment>Return:</comment>
  <info>string</info>  Returns a String with the matched part.


id: Parle\Parser::sigilCount
type: function
doc:
<comment>Description:</comment>
  Number of elements in matched rule
  
  Get number of elements in the matched rule.

<comment>Return:</comment>
  <info>int</info>  Returns Integer


id: Parle\Parser::sigilName
type: function
doc:
<comment>Description:</comment>
  Retrieve a rule or token name
  
  Retrieve a partial rule name or token name corresponding to the sigil index.

<comment>Param:</comment>
  <info>int</info>  <strong>$idx</strong>  Match index, zero based.

<comment>Return:</comment>
  <info>string</info>  Returns a String with the matched part.


id: Parle\Parser::token
type: function
doc:
<comment>Description:</comment>
  Declare a token
  
  Declare a terminal to be used in the grammar.

<comment>Param:</comment>
  <info>string</info>  <strong>$tok</strong>  Token name.

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


id: Parle\Parser::tokenId
type: function
doc:
<comment>Description:</comment>
  Get token id
  
  Retrieve the id of the named token.

<comment>Param:</comment>
  <info>string</info>  <strong>$tok</strong>  Name of the token as used in Parle\Parser::token.

<comment>Return:</comment>
  <info>int</info>  Returns Integer representing the token id.


id: Parle\Parser::trace
type: function
doc:
<comment>Description:</comment>
  Trace the parser operation
  
  Retrieve the current parser operation description. This can be especially useful for studying the
  parser and to optimize the grammar.

<comment>Return:</comment>
  <info>string</info>  Returns a String with the trace information.


id: Parle\Parser::validate
type: function
doc:
<comment>Description:</comment>
  Validate input
  
  Validate an input string. The string is parsed internally, thus this method is useful for the
  quick input validation.

<comment>Param:</comment>
  <info>string</info>       <strong>$data</strong>   String to be validated.
  <info>Parle\Lexer</info>  <strong>$lexer</strong>  A lexer object containing the lexing rules prepared for the particular
                       grammar.

<comment>Return:</comment>
  <info>bool</info>  Returns Boolean witnessing whether the input chimes or not with the defined rules.


id: Parle\RLexer
type: class
doc:
<comment>Description:</comment>
  Multistate lexer class. Lexemes can be defined on the fly. If the particular lexer instance is
  meant to be used with <class>Parle\RParser</class>, the token IDs need to be taken from there. Otherwise,
  arbitrary token IDs can be supplied. Note, that <class>Parle\Parser</class> is not compatible with this lexer.


id: Parle\RLexer::build
type: function
doc:
<comment>Description:</comment>
  Finalize the lexer rule set
  
  Rules, previously added with Parle\RLexer::push are finalized. This method call has to be done
  after all the necessary rules was pushed. The rule set becomes read only. The lexing can begin.

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


id: Parle\RLexer::getToken
type: function
doc:
<comment>Description:</comment>
  Retrieve the current token
  
  Retrive the current token.

<comment>Return:</comment>
  <info>Parle\Token</info>  Returns an instance of <class>Parle\Token</class>.


id: Parle\RLexer::push
type: function
doc:
<comment>Description:</comment>
  Add a lexer rule
  
  Push a pattern for lexeme recognition.
  
  A 'start state' and 'exit state' can be specified by using a suitable signature.

<comment>Param:</comment>
  <info>string</info>  <strong>$regex</strong>     Regular expression used for token matching.
  <info>int</info>     <strong>$id</strong>        Token id. If the lexer instance is meant to be used standalone, this can be an
                     arbitrary number. If the lexer instance is going to be passed to the parser, it
                     has to be an id returned by Parle\RParser::tokenid.
  <info>string</info>  <strong>$state</strong>     State name. If '*' is used as start state, then the rule is applied to all
                     lexer states.
  <info>string</info>  <strong>$newState</strong>  New state name, after the rule was applied.
                     
                     If '.' is specified as the exit state, then the lexer state is unchanged when
                     that rule matches. An exit state with '&gt;' before the name means push. Use
                     the signature without id for either continuation or to start matching, when a
                     continuation or recursion is required.
                     
                     If '\<' is specified as exit state, it means pop. In that case, the signature containing the id can be used to identify the match. Note that even in the case an id is specified, the rule will finish first when all the previous pushes popped.

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


id: Parle\RLexer::pushState
type: function
doc:
<comment>Description:</comment>
  Push a new start state
  
  This lexer type can have more than one state machine. This allows you to lex different tokens
  depending on context, thus allowing simple parsing to take place. Once a state pushed, it can be
  used with a suitable Parle\RLexer::push signature variant.

<comment>Param:</comment>
  <info>string</info>  <strong>$state</strong>  Name of the state.

<comment>Return:</comment>
  <info>int</info>  


id: Parle\RParser
type: class
doc:
<comment>Description:</comment>
  Parser class. Rules can be defined on the fly. Once finalized, a <class>Parle\RLexer</class> instance is required
  to deliver the token stream.


id: Parle\RParser::advance
type: function
doc:
<comment>Description:</comment>
  Process next parser rule
  
  Prosess next parser rule.

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


id: Parle\RParser::consume
type: function
doc:
<comment>Description:</comment>
  Consume the data for processing
  
  Consume the data for parsing.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>   Data to be parsed.
  <info></info>        <strong>$lexer</strong>  A lexer object containing the lexing rules prepared for the particular grammar.

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


id: Parle\RParser::errorInfo
type: function
doc:
<comment>Description:</comment>
  Retrieve the error information
  
  Retrieve the error information in case Parle\RParser::action returned the error action.

<comment>Return:</comment>
  <info>Parle\ErrorInfo</info>  Returns an instance of <class>Parle\ErrorInfo</class>.


id: Parle\RParser::precedence
type: function
doc:
<comment>Description:</comment>
  Declare a precedence rule
  
  Declares a precedence rule for a fictious terminal symbol. This rule can be later used in the
  specific grammar rules.

<comment>Param:</comment>
  <info>string</info>  <strong>$tok</strong>  Token name.

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


id: Parle\RParser::tokenId
type: function
doc:
<comment>Description:</comment>
  Get token id
  
  Retrieve the id of the named token.

<comment>Param:</comment>
  <info>string</info>  <strong>$tok</strong>  Name of the token as used in Parle\RParser::token.

<comment>Return:</comment>
  <info>int</info>  Returns Integer representing the token id.


id: Parle\RParser::trace
type: function
doc:
<comment>Description:</comment>
  Trace the parser operation
  
  Retrieve the current parser operation description. This can be especially useful to study the
  parser and to optimize the grammar.

<comment>Return:</comment>
  <info>string</info>  Returns a String with the trace information.


id: Parle\RParser::validate
type: function
doc:
<comment>Description:</comment>
  Validate input
  
  Validate an input string. The string is parsed internally, thus this method is useful for the
  quick input validation.

<comment>Param:</comment>
  <info>string</info>        <strong>$data</strong>   String to be validated.
  <info>Parle\RLexer</info>  <strong>$lexer</strong>  A lexer object containing the lexing rules prepared for the particular
                        grammar.

<comment>Return:</comment>
  <info>bool</info>  Returns Boolean whitnessing whether the input chimes or not with the defined rules.


id: Parle\Stack
type: class
doc:
<comment>Description:</comment>
  <class>Parle\Stack</class> is a LIFO stack. The elements are inserted and removed only from one end.


id: Parle\Stack::pop
type: function
doc:
<comment>Description:</comment>
  Pop an item from the stack

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


id: Parle\Stack::push
type: function
doc:
<comment>Description:</comment>
  Push an item into the stack

<comment>Param:</comment>
  <info>mixed</info>  <strong>$item</strong>  Variable to be pushed.

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


id: Parle\Token
type: class
doc:
<comment>Description:</comment>
  This class represents a token. Lexer returns instances of this class.


id: PgSql\Connection
type: class
doc:
<comment>Description:</comment>
  A fully opaque class which replaces a <return>pgsql link</return> resource as of PHP 8.1.0.


id: PgSql\Lob
type: class
doc:
<comment>Description:</comment>
  A fully opaque class which replaces a <return>pgsql large object</return> resource as of PHP 8.1.0.


id: PgSql\Result
type: class
doc:
<comment>Description:</comment>
  A fully opaque class which replaces a <return>pgsql result</return> resource as of PHP 8.1.0.


id: Phar
type: class
doc:
<comment>Description:</comment>
  Die Klasse Phar bietet ein High-Level-Interface zum Zugreifen auf und Erstellen von Phar-Archiven.


id: Phar::COMPRESSED
type: constant
doc:
<comment>Description:</comment>
  0x0000F000
  
  bitmask that can be used with file flags to determine if any compression is present


id: Phar::OPENSSL
type: constant
doc:
<comment>Description:</comment>
  signature with OpenSSL public/private key pair.  This is a true, asymmetric key signature.


id: Phar::PHP
type: constant
doc:
<comment>Description:</comment>
  used to instruct the mimeoverrides parameter of <strong>Phar::webPhar()</strong> that the extension should be
  parsed as a PHP file


id: Phar::PHPS
type: constant
doc:
<comment>Description:</comment>
  used to instruct the mimeoverrides parameter of <strong>Phar::webPhar()</strong> that the extension should be
  parsed as a PHP source file through <strong>highlight_file()</strong>


id: Phar::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a Phar archive object

<comment>Param:</comment>
  <info>string</info>       <strong>$filename</strong>  Path to an existing Phar archive or to-be-created archive. The file name's
                          extension must contain .phar.
  <info>int</info>          <strong>$flags</strong>     Flags to pass to parent class <class>RecursiveDirectoryIterator</class>.
  <info>string|null</info>  <strong>$alias</strong>     Alias with which this Phar archive should be referred to in calls to
                          stream functionality.


id: Phar::addEmptyDir
type: function
doc:
<comment>Description:</comment>
  Add an empty directory to the phar archive
  
  Diese Methode des <class>Phar</class>-Objekts funktioniert nur wenn die php.ini-Einstellung <return>phar.readonly</return> auf 0
  gesetzt ist, sonst wird eine <class>PharException</class> geworfen.
  
  With this method, an empty directory is created with path <return>dirname</return>. This method is similar to
  <strong>ZipArchive::addEmptyDir()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  The name of the empty directory to create in the phar archive

<comment>Return:</comment>
  <info>void</info>  no return value, exception is thrown on failure.

<comment>See Also:</comment>
   * <strong>PharData::addEmptyDir()</strong>
   * <strong>Phar::addFile()</strong>
   * <strong>Phar::addFromString()</strong>


id: Phar::addFile
type: function
doc:
<comment>Description:</comment>
  Add a file from the filesystem to the phar archive
  
  Diese Methode des <class>Phar</class>-Objekts funktioniert nur wenn die php.ini-Einstellung <return>phar.readonly</return> auf 0
  gesetzt ist, sonst wird eine <class>PharException</class> geworfen.
  
  With this method, any file or URL can be added to the phar archive.  If the optional second
  parameter <strong>$localName</strong> is a String, the file will be stored in the archive with that name, otherwise
  the <return>file</return> parameter is used as the path to store within the archive.  URLs must have a localname or
  an exception is thrown. This method is similar to <strong>ZipArchive::addFile()</strong>.

<comment>Param:</comment>
  <info>string</info>       <strong>$filename</strong>   Full or relative path to a file on disk to be added to the phar archive.
  <info>string|null</info>  <strong>$localName</strong>  Path that the file will be stored in the archive.

<comment>Return:</comment>
  <info>void</info>  no return value, exception is thrown on failure.

<comment>See Also:</comment>
   * <strong>Phar::offsetSet()</strong>
   * <strong>PharData::addFile()</strong>
   * <strong>Phar::addFromString()</strong>
   * <strong>Phar::addEmptyDir()</strong>


id: Phar::addFromString
type: function
doc:
<comment>Description:</comment>
  Add a file from a string to the phar archive
  
  Diese Methode des <class>Phar</class>-Objekts funktioniert nur wenn die php.ini-Einstellung <return>phar.readonly</return> auf 0
  gesetzt ist, sonst wird eine <class>PharException</class> geworfen.
  
  With this method, any string can be added to the phar archive. The file will be stored in the
  archive with <return>localname</return> as its path.  This method is similar to <strong>ZipArchive::addFromString()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  Path that the file will be stored in the archive.
  <info>string</info>  <strong>$contents</strong>   The file contents to store

<comment>Return:</comment>
  <info>void</info>  no return value, exception is thrown on failure.

<comment>See Also:</comment>
   * <strong>Phar::offsetSet()</strong>
   * <strong>PharData::addFromString()</strong>
   * <strong>Phar::addFile()</strong>
   * <strong>Phar::addEmptyDir()</strong>


id: Phar::apiVersion
type: function
doc:
<comment>Description:</comment>
  Returns the api version
  
  Return the API version of the phar file format that will be used when creating phars.  The Phar
  extension supports reading API version 1.0.0 or newer.  API version 1.1.0 is required for SHA-256
  and SHA-512 hash, and API version 1.1.1 is required to store empty directories.

<comment>Return:</comment>
  <info>string</info>  The API version string as in <return>"1.0.0"</return>.


id: Phar::buildFromDirectory
type: function
doc:
<comment>Description:</comment>
  Construct a phar archive from the files within a directory
  
  Diese Methode des <class>Phar</class>-Objekts funktioniert nur wenn die php.ini-Einstellung <return>phar.readonly</return> auf 0
  gesetzt ist, sonst wird eine <class>PharException</class> geworfen.
  
  Populate a phar archive from directory contents.  The optional second parameter is a regular
  expression (pcre) that is used to exclude files. Any filename that matches the regular expression
  will be included, all others will be excluded.  For more fine-grained control, use
  <strong>Phar::buildFromIterator()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  The full or relative path to the directory that contains all files to add to
                      the archive.
  <info>string</info>  <strong>$pattern</strong>    An optional pcre regular expression that is used to filter the list of files.
                      Only file paths matching the regular expression will be included in the
                      archive.

<comment>Return:</comment>
  <info>array</info>  <strong>Phar::buildFromDirectory()</strong> returns an associative array mapping internal path of file to
         the full path of the file on the filesystem.

<comment>See Also:</comment>
   * <strong>Phar::buildFromIterator()</strong>


id: Phar::buildFromIterator
type: function
doc:
<comment>Description:</comment>
  Construct a phar archive from an iterator
  
  Diese Methode des <class>Phar</class>-Objekts funktioniert nur wenn die php.ini-Einstellung <return>phar.readonly</return> auf 0
  gesetzt ist, sonst wird eine <class>PharException</class> geworfen.
  
  Populate a phar archive from an iterator.  Two styles of iterators are supported, iterators that
  map the filename within the phar to the name of a file on disk, and iterators like
  DirectoryIterator that return SplFileInfo objects.  For iterators that return SplFileInfo objects,
  the second parameter is required.

<comment>Param:</comment>
  <info>Traversable</info>  <strong>$iterator</strong>       Any iterator that either associatively maps phar file to location or
                               returns SplFileInfo objects
  <info>string|null</info>  <strong>$baseDirectory</strong>  For iterators that return SplFileInfo objects, the portion of each
                               file's full path to remove when adding to the phar archive

<comment>Return:</comment>
  <info>array</info>  <strong>Phar::buildFromIterator()</strong> returns an associative array mapping internal path of file to the
         full path of the file on the filesystem.

<comment>See Also:</comment>
   * <strong>Phar::buildFromDirectory()</strong>


id: Phar::canCompress
type: function
doc:
<comment>Description:</comment>
  Returns whether phar extension supports compression using either zlib or bzip2
  
  This should be used to test whether compression is possible prior to loading a phar archive
  containing compressed files.

<comment>Param:</comment>
  <info>int</info>  <strong>$compression</strong>  Either <return>Phar::GZ</return> or <return>Phar::BZ2</return> can be used to test whether compression is
                     possible with a specific compression algorithm (zlib or bzip2).

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if compression/decompression is available, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>Phar::compressFiles()</strong>
   * <strong>Phar::decompressFiles()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>Phar::convertToExecutable()</strong>
   * <strong>Phar::convertToData()</strong>


id: Phar::canWrite
type: function
doc:
<comment>Description:</comment>
  Returns whether phar extension supports writing and creating phars
  
  This static method determines whether write access has been disabled in the system php.ini via the
  phar.readonly ini variable.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if write access is enabled, <info>false</info> if it is disabled.

<comment>See Also:</comment>
   * phar.readonly
   * <strong>Phar::isWritable()</strong>


id: Phar::compress
type: function
doc:
<comment>Description:</comment>
  Compresses the entire Phar archive using Gzip or Bzip2 compression
  
  Diese Methode des <class>Phar</class>-Objekts funktioniert nur wenn die php.ini-Einstellung <return>phar.readonly</return> auf 0
  gesetzt ist, sonst wird eine <class>PharException</class> geworfen.
  
  For tar-based and phar-based phar archives, this method compresses the entire archive using gzip
  compression or bzip2 compression.  The resulting file can be processed with the gunzip
  command/bunzip command, or accessed directly and transparently with the Phar extension.
  
  For Zip-based phar archives, this method fails with an exception. The zlib extension must be
  enabled to compress with gzip compression, the bzip2 extension must be enabled in order to
  compress with bzip2 compression. As with all functionality that modifies the contents of a phar,
  the phar.readonly INI variable must be off in order to succeed.
  
  In addition, this method automatically renames the archive, appending <return>.gz</return>, <return>.bz2</return> or removing the
  extension if passed <return>Phar::NONE</return> to remove compression.  Alternatively, a file extension may be
  specified with the second parameter.

<comment>Param:</comment>
  <info>int</info>          <strong>$compression</strong>  Compression must be one of <return>Phar::GZ</return>, <return>Phar::BZ2</return> to add compression, or
                             <return>Phar::NONE</return> to remove compression.
  <info>string|null</info>  <strong>$extension</strong>    By default, the extension is <return>.phar.gz</return> or <return>.phar.bz2</return> for compressing phar
                             archives, and <return>.phar.tar.gz</return> or <return>.phar.tar.bz2</return> for compressing tar
                             archives.  For decompressing, the default file extensions are <return>.phar</return> and
                             <return>.phar.tar</return>.

<comment>Return:</comment>
  <info>Phar|null</info>  Returns a <class>Phar</class> object, or <info>null</info> on failure.

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>PharData::compress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>Phar::decompress()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>Phar::compressFiles()</strong>
   * <strong>Phar::decompressFiles()</strong>


id: Phar::compressFiles
type: function
doc:
<comment>Description:</comment>
  Compresses all files in the current Phar archive
  
  Diese Methode des <class>Phar</class>-Objekts funktioniert nur wenn die php.ini-Einstellung <return>phar.readonly</return> auf 0
  gesetzt ist, sonst wird eine <class>PharException</class> geworfen.
  
  For tar-based phar archives, this method throws a <class>BadMethodCallException</class>, as compression of
  individual files within a tar archive is not supported by the file format.  Use <strong>Phar::compress()</strong>
  to compress an entire tar-based phar archive.
  
  For Zip-based and phar-based phar archives, this method compresses all files in the Phar archive
  using the specified compression. The zlib  or bzip2 extensions must be enabled to take advantage
  of this feature.  In addition, if any files are already compressed using bzip2/zlib compression,
  the respective extension must be enabled in order to decompress the files prior to re-compressing.
  As with all functionality that modifies the contents of a phar, the phar.readonly INI variable
  must be off in order to succeed.

<comment>Param:</comment>
  <info>int</info>  <strong>$compression</strong>  Compression must be one of <return>Phar::GZ</return>, <return>Phar::BZ2</return> to add compression, or
                     <return>Phar::NONE</return> to remove compression.

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

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>Phar::decompressFiles()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>Phar::compress()</strong>
   * <strong>Phar::decompress()</strong>


id: Phar::convertToData
type: function
doc:
<comment>Description:</comment>
  Convert a phar archive to a non-executable tar or zip file
  
  This method is used to convert an executable phar archive to either a tar or zip file.  To make
  the tar or zip non-executable, the phar stub and phar alias files are removed from the newly
  created archive.
  
  If no changes are specified, this method throws a <class>BadMethodCallException</class> if the archive is in phar
  file format.  For archives in tar or zip file format, this method converts the archive to a
  non-executable archive.
  
  If successful, the method creates a new archive on disk and returns a <class>PharData</class> object.  The old
  archive is not removed from disk, and should be done manually after the process has finished.

<comment>Param:</comment>
  <info>int|null</info>     <strong>$format</strong>       This should be one of <return>Phar::TAR</return> or <return>Phar::ZIP</return>.  If set to <info>null</info>, the
                             existing file format will be preserved.
  <info>int|null</info>     <strong>$compression</strong>  This should be one of <return>Phar::NONE</return> for no whole-archive compression,
                             <return>Phar::GZ</return> for zlib-based compression, and <return>Phar::BZ2</return> for bzip-based
                             compression.
  <info>string|null</info>  <strong>$extension</strong>    This parameter is used to override the default file extension for a
                             converted archive.  Note that <return>.phar</return> cannot be used anywhere in the
                             filename for a non-executable tar or zip archive.
                             
                             If converting to a tar-based phar archive, the default extensions are
                             <return>.tar</return>, <return>.tar.gz</return>, and <return>.tar.bz2</return> depending on specified compression. For
                             zip-based archives, the default extension is <return>.zip</return>.

<comment>Return:</comment>
  <info>PharData|null</info>  The method returns a <class>PharData</class> object on success, or <info>null</info> on failure.

<comment>See Also:</comment>
   * <strong>Phar::convertToExecutable()</strong>
   * <strong>PharData::convertToExecutable()</strong>
   * <strong>PharData::convertToData()</strong>


id: Phar::convertToExecutable
type: function
doc:
<comment>Description:</comment>
  Convert a phar archive to another executable phar archive file format
  
  Diese Methode des <class>Phar</class>-Objekts funktioniert nur wenn die php.ini-Einstellung <return>phar.readonly</return> auf 0
  gesetzt ist, sonst wird eine <class>PharException</class> geworfen.
  
  This method is used to convert a phar archive to another file format.  For instance, it can be
  used to create a tar-based executable phar archive from a zip-based executable phar archive, or
  from an executable phar archive in the phar file format.  In addition, it can be used to apply
  whole-archive compression to a tar or phar-based archive.
  
  If no changes are specified, this method throws a <class>BadMethodCallException</class>.
  
  If successful, the method creates a new archive on disk and returns a <class>Phar</class> object.  The old
  archive is not removed from disk, and should be done manually after the process has finished.

<comment>Param:</comment>
  <info>int|null</info>     <strong>$format</strong>       This should be one of <return>Phar::PHAR</return>, <return>Phar::TAR</return>, or <return>Phar::ZIP</return>.  If set to
                             <info>null</info>, the existing file format will be preserved.
  <info>int|null</info>     <strong>$compression</strong>  This should be one of <return>Phar::NONE</return> for no whole-archive compression,
                             <return>Phar::GZ</return> for zlib-based compression, and <return>Phar::BZ2</return> for bzip-based
                             compression.
  <info>string|null</info>  <strong>$extension</strong>    This parameter is used to override the default file extension for a
                             converted archive.  Note that all zip- and tar-based phar archives must
                             contain <return>.phar</return> in their file extension in order to be processed as a
                             phar archive.
                             
                             If converting to a phar-based archive, the default extensions are
                             <return>.phar</return>, <return>.phar.gz</return>, or <return>.phar.bz2</return> depending on the specified compression.
                             For tar-based phar archives, the default extensions are <return>.phar.tar</return>,
                             <return>.phar.tar.gz</return>, and <return>.phar.tar.bz2</return>.  For zip-based phar archives, the
                             default extension is <return>.phar.zip</return>.

<comment>Return:</comment>
  <info>Phar|null</info>  The method returns a <class>Phar</class> object on success, or <info>null</info> on failure.

<comment>See Also:</comment>
   * <strong>Phar::convertToData()</strong>
   * <strong>PharData::convertToExecutable()</strong>
   * <strong>PharData::convertToData()</strong>


id: Phar::copy
type: function
doc:
<comment>Description:</comment>
  Copy a file internal to the phar archive to another new file within the phar
  
  Diese Methode des <class>Phar</class>-Objekts funktioniert nur wenn die php.ini-Einstellung <return>phar.readonly</return> auf 0
  gesetzt ist, sonst wird eine <class>PharException</class> geworfen.
  
  Copy a file internal to the phar archive to another new file within the phar. This is an
  object-oriented alternative to using <strong>copy()</strong> with the phar stream wrapper.

<comment>Param:</comment>
  <info>string</info>  <strong>$from</strong>  
  <info>string</info>  <strong>$to</strong>    

<comment>Return:</comment>
  <info>bool</info>  returns <info>true</info> on success, but it is safer to encase method call in a try/catch block and
        assume success if no exception is thrown.


id: Phar::count
type: function
doc:
<comment>Description:</comment>
  Returns the number of entries (files) in the Phar archive

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  <strong>$mode</strong> is an integer value specifying the counting mode to be used. By default, it is
              set to <info>COUNT_NORMAL</info>, which counts only the number of items in the archive that have
              not been deleted or hidden. When set to <info>COUNT_RECURSIVE</info>, it counts all items in the
              archive, including those that have been deleted or hidden.

<comment>Return:</comment>
  <info>int</info>  The number of files contained within this phar, or <return>0</return> (the number zero) if none.


id: Phar::createDefaultStub
type: function
doc:
<comment>Description:</comment>
  Create a phar-file format specific stub
  
  This method is intended for creation of phar-file format-specific stubs, and is not intended for
  use with tar- or zip-based phar archives.
  
  Phar archives contain a bootstrap loader, or <return>stub</return> written in PHP that is executed when the archive
  is executed in PHP either via include:  ]]> or by simple execution:
  
  This method provides a simple and easy method to create a stub that will run a startup file from
  the phar archive.  In addition, different files can be specified for running the phar archive from
  the command line versus through a web server.  The loader stub also calls
  <strong>Phar::interceptFileFuncs()</strong> to allow easy bundling of a PHP application that accesses the file
  system.  If the phar extension is not present, the loader stub will extract the phar archive to a
  temporary directory and then operate on the files.  A shutdown function erases the temporary files
  on exit.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$index</strong>     Relative path within the phar archive to run if accessed on the
                          command-line
  <info>string|null</info>  <strong>$webIndex</strong>  Relative path within the phar archive to run if accessed through a web
                          browser

<comment>Return:</comment>
  <info>string</info>  Returns a string containing the contents of a customized bootstrap loader (stub) that
          allows the created Phar archive to work with or without the Phar extension enabled.

<comment>See Also:</comment>
   * <strong>Phar::setStub()</strong>
   * <strong>Phar::getStub()</strong>


id: Phar::decompress
type: function
doc:
<comment>Description:</comment>
  Decompresses the entire Phar archive
  
  Diese Methode des <class>Phar</class>-Objekts funktioniert nur wenn die php.ini-Einstellung <return>phar.readonly</return> auf 0
  gesetzt ist, sonst wird eine <class>PharException</class> geworfen.
  
  For tar-based and phar-based phar archives, this method decompresses the entire archive.
  
  For Zip-based phar archives, this method fails with an exception. The zlib extension must be
  enabled to decompress an archive compressed with gzip compression, and the bzip2 extension must be
  enabled in order to decompress an archive compressed with bzip2 compression. As with all
  functionality that modifies the contents of a phar, the phar.readonly INI variable must be off in
  order to succeed.
  
  In addition, this method automatically changes the file extension of the archive, <return>.phar</return> by default
  for phar archives, or <return>.phar.tar</return> for tar-based phar archives. Alternatively, a file extension may
  be specified with the second parameter.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$extension</strong>  For decompressing, the default file extensions are <return>.phar</return> and <return>.phar.tar</return>.
                           Use this parameter to specify another file extension.  Be aware that all
                           executable phar archives must contain <return>.phar</return> in their filename.

<comment>Return:</comment>
  <info>Phar|null</info>  A <class>Phar</class> object is returned on success, and <info>null</info> on failure.

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>PharData::compress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>Phar::compress()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>Phar::compressFiles()</strong>
   * <strong>Phar::decompressFiles()</strong>


id: Phar::decompressFiles
type: function
doc:
<comment>Description:</comment>
  Decompresses all files in the current Phar archive
  
  Diese Methode des <class>Phar</class>-Objekts funktioniert nur wenn die php.ini-Einstellung <return>phar.readonly</return> auf 0
  gesetzt ist, sonst wird eine <class>PharException</class> geworfen.
  
  For tar-based phar archives, this method throws a <class>BadMethodCallException</class>, as compression of
  individual files within a tar archive is not supported by the file format.  Use <strong>Phar::compress()</strong>
  to compress an entire tar-based phar archive.
  
  For Zip-based and phar-based phar archives, this method decompresses all files in the Phar
  archive. The zlib  or bzip2 extensions must be enabled to take advantage of this feature if any
  files are compressed using bzip2/zlib compression. As with all functionality that modifies the
  contents of a phar, the phar.readonly INI variable must be off in order to succeed.

<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>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>Phar::compressFiles()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>Phar::compress()</strong>
   * <strong>Phar::decompress()</strong>


id: Phar::delMetadata
type: function
doc:
<comment>Description:</comment>
  Deletes the global metadata of the phar
  
  Diese Methode des <class>Phar</class>-Objekts funktioniert nur wenn die php.ini-Einstellung <return>phar.readonly</return> auf 0
  gesetzt ist, sonst wird eine <class>PharException</class> geworfen.
  
  Deletes the global metadata of the phar

<comment>Return:</comment>
  <info>bool</info>  returns <info>true</info> on success, but it is better to check for thrown exception, and assume success
        if none is thrown.

<comment>See Also:</comment>
   * <strong>Phar::getMetadata()</strong>
   * <strong>Phar::setMetadata()</strong>
   * <strong>Phar::hasMetadata()</strong>


id: Phar::delete
type: function
doc:
<comment>Description:</comment>
  Delete a file within a phar archive
  
  Diese Methode des <class>Phar</class>-Objekts funktioniert nur wenn die php.ini-Einstellung <return>phar.readonly</return> auf 0
  gesetzt ist, sonst wird eine <class>PharException</class> geworfen.
  
  Delete a file within an archive.  This is the functional equivalent of calling <strong>unlink()</strong> on the
  stream wrapper equivalent, as shown in the example below.

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  Path within an archive to the file to delete.

<comment>Return:</comment>
  <info>bool</info>  returns <info>true</info> on success, but it is better to check for thrown exception, and assume success
        if none is thrown.

<comment>See Also:</comment>
   * <strong>PharData::delete()</strong>
   * <strong>Phar::unlinkArchive()</strong>


id: Phar::extractTo
type: function
doc:
<comment>Description:</comment>
  Extract the contents of a phar archive to a directory
  
  Extract all files within a phar archive to disk.  Extracted files and directories preserve
  permissions as stored in the archive.  The optional parameters allow optional control over which
  files are extracted, and whether existing files on disk can be overwritten. The second parameter
  <strong>$files</strong> can be either the name of a file or directory to extract, or an array of names of files and
  directories to extract.  By default, this method will not overwrite existing files, the third
  parameter can be set to true to enable overwriting of files. This method is similar to
  <strong>ZipArchive::extractTo()</strong>.

<comment>Param:</comment>
  <info>string</info>             <strong>$directory</strong>  Path to extract the given <strong>$files</strong> to
  <info>array|string|null</info>  <strong>$files</strong>      The name of a file or directory to extract, or an array of
                                 files/directories to extract, <info>null</info> to skip this param
  <info>bool</info>               <strong>$overwrite</strong>  Set to <info>true</info> to enable overwriting existing files

<comment>Return:</comment>
  <info>bool</info>  returns <info>true</info> on success, but it is better to check for thrown exception, and assume success
        if none is thrown.

<comment>See Also:</comment>
   * <strong>PharData::extractTo()</strong>


id: Phar::getAlias
type: function
doc:
<comment>Description:</comment>
  Get the alias for Phar
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>string|null</info>  Returns the alias or <info>null</info> if there's no alias.


id: Phar::getMetadata
type: function
doc:
<comment>Description:</comment>
  Returns phar archive meta-data
  
  Retrieve archive meta-data.  Meta-data can be any PHP variable that can be serialized.

<comment>Return:</comment>
  <info>mixed</info>  Any PHP value that can be serialized and is stored as meta-data for the Phar archive, or
         <info>null</info> if no meta-data is stored.

<comment>See Also:</comment>
   * <strong>Phar::setMetadata()</strong>
   * <strong>Phar::delMetadata()</strong>
   * <strong>Phar::hasMetadata()</strong>


id: Phar::getModified
type: function
doc:
<comment>Description:</comment>
  Return whether phar was modified
  
  This method can be used to determine whether a phar has either had an internal file deleted, or
  contents of a file changed in some way.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the phar has been modified since opened, <info>false</info> if not.


id: Phar::getPath
type: function
doc:
<comment>Description:</comment>
  Get the real path to the Phar archive on disk
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

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


id: Phar::getSignature
type: function
doc:
<comment>Description:</comment>
  Return MD5/SHA1/SHA256/SHA512/OpenSSL signature of a Phar archive
  
  Returns the verification signature of a phar archive in a hexadecimal string.

<comment>Return:</comment>
  <info>array|false</info>  Array with the opened archive's signature in <return>hash</return> key and <return>MD5</return>, <return>SHA-1</return>, <return>SHA-256</return>,
               <return>SHA-512</return>, or <return>OpenSSL</return> in <return>hash_type</return>.  This signature is a hash calculated on the entire
               phar's contents, and may be used to verify the integrity of the archive. A valid
               signature is absolutely required of all executable phar archives if the
               phar.require_hash INI variable is set to true. If there is no signature, the function
               returns <info>false</info>.


id: Phar::getStub
type: function
doc:
<comment>Description:</comment>
  Return the PHP loader or bootstrap stub of a Phar archive
  
  Phar archives contain a bootstrap loader, or <return>stub</return> written in PHP that is executed when the archive
  is executed in PHP either via include:  ]]> or by simple execution:

<comment>Return:</comment>
  <info>string</info>  Returns a string containing the contents of the bootstrap loader (stub) of the current
          Phar archive.

<comment>See Also:</comment>
   * <strong>Phar::setStub()</strong>
   * <strong>Phar::createDefaultStub()</strong>


id: Phar::getSupportedCompression
type: function
doc:
<comment>Description:</comment>
  Return array of supported compression algorithms

<comment>Return:</comment>
  <info>array</info>  Returns an array containing any of <return>Phar::GZ</return> or <return>Phar::BZ2</return>, depending on the availability of
         the zlib extension or the bz2 extension.

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>Phar::compress()</strong>
   * <strong>Phar::decompress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>Phar::compressFiles()</strong>
   * <strong>Phar::decompressFiles()</strong>


id: Phar::getSupportedSignatures
type: function
doc:
<comment>Description:</comment>
  Return array of supported signature types
  
  Return array of supported signature types

<comment>Return:</comment>
  <info>array</info>  Returns an array containing any of <return>MD5</return>, <return>SHA-1</return>, <return>SHA-256</return>, <return>SHA-512</return>, or <return>OpenSSL</return>.

<comment>See Also:</comment>
   * <strong>Phar::getSignature()</strong>
   * <strong>Phar::setSignatureAlgorithm()</strong>


id: Phar::getVersion
type: function
doc:
<comment>Description:</comment>
  Return version info of Phar archive
  
  Returns the API version of an opened Phar archive.

<comment>Return:</comment>
  <info>string</info>  The opened archive's API version.  This is not to be confused with the API version that
          the loaded phar extension will use to create new phars.  Each Phar archive has the API
          version hard-coded into its manifest.  See Phar file format documentation for more
          information.

<comment>See Also:</comment>
   * <strong>Phar::apiVersion()</strong>


id: Phar::hasMetadata
type: function
doc:
<comment>Description:</comment>
  Returns whether phar has global meta-data
  
  Returns whether phar has global meta-data set.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if meta-data has been set, and <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>Phar::getMetadata()</strong>
   * <strong>Phar::setMetadata()</strong>
   * <strong>Phar::delMetadata()</strong>


id: Phar::interceptFileFuncs
type: function
doc:
<comment>Description:</comment>
  Instructs phar to intercept fopen, file_get_contents, opendir, and all of the stat-related
  functions
  
  instructs phar to intercept <strong>fopen()</strong>, <strong>readfile()</strong>, <strong>file_get_contents()</strong>, <strong>opendir()</strong>, and all of the
  stat-related functions.  If any of these functions is called from within a phar archive with a
  relative path, the call is modified to access a file within the phar archive.  Absolute paths are
  assumed to be attempts to load external files from the filesystem.
  
  This function makes it possible to run PHP applications designed to run off of a hard disk as a
  phar application.

<comment>Return:</comment>
  <info>void</info>  


id: Phar::isBuffering
type: function
doc:
<comment>Description:</comment>
  Used to determine whether Phar write operations are being buffered, or are flushing directly to
  disk
  
  This method can be used to determine whether a Phar will save changes to disk immediately, or
  whether a call to <strong>Phar::stopBuffering()</strong> is needed to enable saving changes.
  
  Phar write buffering is per-archive, buffering active for the <return>foo.phar</return> Phar archive does not
  affect changes to the <return>bar.phar</return> Phar archive.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the write operations are being buffer, <info>false</info> otherwise.

<comment>See Also:</comment>
   * <strong>Phar::startBuffering()</strong>
   * <strong>Phar::stopBuffering()</strong>


id: Phar::isCompressed
type: function
doc:
<comment>Description:</comment>
  Returns Phar::GZ or PHAR::BZ2 if the entire phar archive is compressed (.tar.gz/tar.bz and so on)
  
  Diese Methode des <class>Phar</class>-Objekts funktioniert nur wenn die php.ini-Einstellung <return>phar.readonly</return> auf 0
  gesetzt ist, sonst wird eine <class>PharException</class> geworfen.
  
  Returns Phar::GZ or PHAR::BZ2 if the entire phar archive is compressed (.tar.gz/tar.bz and so on).
  Zip-based phar archives cannot be compressed as a file, and so this method will always return
  <info>false</info> if a zip-based phar archive is queried.

<comment>Return:</comment>
  <info>int|false</info>  <return>Phar::GZ</return>, <return>Phar::BZ2</return> or <info>false</info>.

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>Phar::decompress()</strong>
   * <strong>Phar::compress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::compressFiles()</strong>
   * <strong>Phar::decompressFiles()</strong>
   * <strong>Phar::getSupportedCompression()</strong>


id: Phar::isFileFormat
type: function
doc:
<comment>Description:</comment>
  Returns true if the phar archive is based on the tar/phar/zip file format depending on the
  parameter

<comment>Param:</comment>
  <info>int</info>  <strong>$format</strong>  Either <return>Phar::PHAR</return>, <return>Phar::TAR</return>, or <return>Phar::ZIP</return> to test for the format of the archive.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the phar archive matches the file format requested by the parameter

<comment>See Also:</comment>
   * <strong>Phar::convertToExecutable()</strong>
   * <strong>Phar::convertToData()</strong>


id: Phar::isValidPharFilename
type: function
doc:
<comment>Description:</comment>
  Returns whether the given filename is a valid phar filename
  
  Returns whether the given filename is a valid phar filename that will be recognized as a phar
  archive by the phar extension.  This can be used to test a name without having to instantiate a
  phar archive and catch the inevitable Exception that will be thrown if an invalid name is
  specified.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>    The name or full path to a phar archive not yet created
  <info>bool</info>    <strong>$executable</strong>  This parameter determines whether the filename should be treated as a phar
                       executable archive, or a data non-executable archive

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the filename is valid, <info>false</info> if not.


id: Phar::isWritable
type: function
doc:
<comment>Description:</comment>
  Returns true if the phar archive can be modified
  
  This method returns <info>true</info> if <return>phar.readonly</return> is <return>0</return>, and the actual phar archive on disk is not
  read-only.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the phar archive can be modified

<comment>See Also:</comment>
   * <strong>Phar::canWrite()</strong>
   * <strong>PharData::isWritable()</strong>


id: Phar::loadPhar
type: function
doc:
<comment>Description:</comment>
  Loads any phar archive with an alias
  
  This can be used to read the contents of an external Phar archive.  This is most useful for
  assigning an alias to a phar so that subsequent references to the phar can use the shorter alias,
  or for loading Phar archives that only contain data and are not intended for execution/inclusion
  in PHP scripts.

<comment>Param:</comment>
  <info>string</info>       <strong>$filename</strong>  the full or relative path to the phar archive to open
  <info>string|null</info>  <strong>$alias</strong>     The alias that may be used to refer to the phar archive.  Note that many
                          phar archives specify an explicit alias inside the phar archive, and a
                          <class>PharException</class> will be thrown if a new alias is specified in this case.

<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>Phar::mapPhar()</strong>


id: Phar::mapPhar
type: function
doc:
<comment>Description:</comment>
  Reads the currently executed file (a phar) and registers its manifest
  
  This static method can only be used inside a Phar archive's loader stub in order to initialize the
  phar when it is directly executed, or when it is included in another script.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$alias</strong>   The alias that can be used in <return>phar://</return> URLs to refer to this archive, rather
                        than its full path.
  <info>int</info>          <strong>$offset</strong>  Unused variable, here for compatibility with PEAR's PHP_Archive.

<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>Phar::loadPhar()</strong>


id: Phar::mount
type: function
doc:
<comment>Description:</comment>
  Mount an external path or file to a virtual location within the phar archive
  
  Much like the unix file system concept of mounting external devices to paths within the directory
  tree, <strong>Phar::mount()</strong> allows referring to external files and directories as if they were inside of
  an archive.  This allows powerful abstraction such as referring to external configuration files as
  if they were inside the archive.

<comment>Param:</comment>
  <info>string</info>  <strong>$pharPath</strong>      The internal path within the phar archive to use as the mounted path
                         location. This must be a relative path within the phar archive, and must
                         not already exist.
  <info>string</info>  <strong>$externalPath</strong>  A path or URL to an external file or directory to mount within the phar
                         archive

<comment>Return:</comment>
  <info>void</info>  No return.  <class>PharException</class> is thrown on failure.


id: Phar::mungServer
type: function
doc:
<comment>Description:</comment>
  Defines a list of up to 4 $_SERVER variables that should be modified for execution
  
  <strong>Phar::mungServer()</strong> should only be called within the stub of a phar archive.
  
  Defines a list of up to 4 $_SERVER variables that should be modified for execution. Variables that
  can be modified to remove traces of phar execution are <return>REQUEST_URI</return>, <return>PHP_SELF</return>, <return>SCRIPT_NAME</return> and
  <return>SCRIPT_FILENAME</return>.
  
  On its own, this method does nothing.  Only when combined with <strong>Phar::webPhar()</strong> does it take
  effect, and only when the requested file is a PHP file to be parsed.  Note that the <return>PATH_INFO</return> and
  <return>PATH_TRANSLATED</return> variables are always modified.
  
  The original values of variables that are modified are stored in the SERVER array with <return>PHAR_</return>
  prepended, so for instance <return>SCRIPT_NAME</return> would be saved as <return>PHAR_SCRIPT_NAME</return>.

<comment>Param:</comment>
  <info>array</info>  <strong>$variables</strong>  An array of any of the strings <return>REQUEST_URI</return>, <return>PHP_SELF</return>, <return>SCRIPT_NAME</return> and
                     <return>SCRIPT_FILENAME</return>. Other values trigger an exception, and <strong>Phar::mungServer()</strong> is
                     case-sensitive.

<comment>Return:</comment>
  <info>void</info>  No return.

<comment>See Also:</comment>
   * <strong>Phar::webPhar()</strong>
   * <strong>Phar::setStub()</strong>


id: Phar::offsetExists
type: function
doc:
<comment>Description:</comment>
  Determines whether a file exists in the phar
  
  This is an implementation of the ArrayAccess interface allowing direct manipulation of the
  contents of a Phar archive using array access brackets.
  
  offsetExists() is called whenever <strong>isset()</strong> is called.

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  The filename (relative path) to look for in a Phar.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the file exists within the phar, or <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>Phar::offsetGet()</strong>
   * <strong>Phar::offsetSet()</strong>
   * <strong>Phar::offsetUnset()</strong>


id: Phar::offsetGet
type: function
doc:
<comment>Description:</comment>
  Gets a PharFileInfo object for a specific file
  
  This is an implementation of the ArrayAccess interface allowing direct manipulation of the
  contents of a Phar archive using array access brackets. Phar::offsetGet is used  for retrieving
  files from a Phar archive.

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  The filename (relative path) to look for in a Phar.

<comment>Return:</comment>
  <info>SplFileInfo</info>  A <class>PharFileInfo</class> object is returned that can be used to iterate over a file's contents
               or to retrieve information about the current file.

<comment>See Also:</comment>
   * <strong>Phar::offsetExists()</strong>
   * <strong>Phar::offsetSet()</strong>
   * <strong>Phar::offsetUnset()</strong>


id: Phar::offsetSet
type: function
doc:
<comment>Description:</comment>
  Set the contents of an internal file to those of an external file
  
  Diese Methode des <class>Phar</class>-Objekts funktioniert nur wenn die php.ini-Einstellung <return>phar.readonly</return> auf 0
  gesetzt ist, sonst wird eine <class>PharException</class> geworfen.
  
  This is an implementation of the ArrayAccess interface allowing direct manipulation of the
  contents of a Phar archive using array access brackets.  offsetSet is used for modifying an
  existing file, or adding a new file to a Phar archive.

<comment>Param:</comment>
  <info>string</info>           <strong>$localName</strong>  The filename (relative path) to modify in a Phar.
  <info>resource|string</info>  <strong>$value</strong>      Content of the file.

<comment>Return:</comment>
  <info>void</info>  No return values.

<comment>See Also:</comment>
   * <strong>Phar::offsetExists()</strong>
   * <strong>Phar::offsetGet()</strong>
   * <strong>Phar::offsetUnset()</strong>


id: Phar::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Remove a file from a phar
  
  Diese Methode des <class>Phar</class>-Objekts funktioniert nur wenn die php.ini-Einstellung <return>phar.readonly</return> auf 0
  gesetzt ist, sonst wird eine <class>PharException</class> geworfen.
  
  This is an implementation of the ArrayAccess interface allowing direct manipulation of the
  contents of a Phar archive using array access brackets.  offsetUnset is used for deleting an
  existing file, and is called by the <strong>unset()</strong> language construct.

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  The filename (relative path) to modify in a Phar.

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

<comment>See Also:</comment>
   * <strong>Phar::offsetExists()</strong>
   * <strong>Phar::offsetGet()</strong>
   * <strong>Phar::offsetSet()</strong>
   * <strong>Phar::unlinkArchive()</strong>
   * <strong>Phar::delete()</strong>


id: Phar::running
type: function
doc:
<comment>Description:</comment>
  Returns the full path on disk or full phar URL to the currently executing Phar archive
  
  Returns the full path to the running phar archive.  This is intended for use much like the
  <return>__FILE__</return> magic constant, and only has effect inside an executing phar archive.
  
  Inside the stub of an archive, <strong>Phar::running()</strong> returns <return>""</return>.  Simply use <info>__FILE__</info> to access the
  current running phar inside a stub.

<comment>Param:</comment>
  <info>bool</info>  <strong>$returnPhar</strong>  If <info>false</info>, the full path on disk to the phar archive is returned.  If <info>true</info>, a
                     full phar URL is returned.

<comment>Return:</comment>
  <info>string</info>  Returns the filename if valid, empty string otherwise.


id: Phar::setAlias
type: function
doc:
<comment>Description:</comment>
  Set the alias for the Phar archive
  
  Diese Methode des <class>Phar</class>-Objekts funktioniert nur wenn die php.ini-Einstellung <return>phar.readonly</return> auf 0
  gesetzt ist, sonst wird eine <class>PharException</class> geworfen.
  
  Set the alias for the Phar archive, and write it as the permanent alias for this phar archive.  An
  alias can be used internally to a phar archive to ensure that use of the <return>phar</return> stream wrapper to
  access internal files always works regardless of the location of the phar archive on the
  filesystem.  Another alternative is to rely upon Phar's interception of <strong>include()</strong> or to use
  <strong>Phar::interceptFileFuncs()</strong> and use relative paths.

<comment>Param:</comment>
  <info>string</info>  <strong>$alias</strong>  A shorthand string that this archive can be referred to in <return>phar</return> stream wrapper
                  access.

<comment>Return:</comment>
  <info>bool</info>  

<comment>See Also:</comment>
   * <strong>Phar::__construct()</strong>
   * <strong>Phar::interceptFileFuncs()</strong>


id: Phar::setDefaultStub
type: function
doc:
<comment>Description:</comment>
  Used to set the PHP loader or bootstrap stub of a Phar archive to the default loader
  
  Diese Methode des <class>Phar</class>-Objekts funktioniert nur wenn die php.ini-Einstellung <return>phar.readonly</return> auf 0
  gesetzt ist, sonst wird eine <class>PharException</class> geworfen.
  
  This method is a convenience method that combines the functionality of <strong>Phar::createDefaultStub()</strong>
  and <strong>Phar::setStub()</strong>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$index</strong>     Relative path within the phar archive to run if accessed on the
                          command-line
  <info>string|null</info>  <strong>$webIndex</strong>  Relative path within the phar archive to run if accessed through a web
                          browser

<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>Phar::setStub()</strong>
   * <strong>Phar::createDefaultStub()</strong>


id: Phar::setMetadata
type: function
doc:
<comment>Description:</comment>
  Sets phar archive meta-data
  
  Diese Methode des <class>Phar</class>-Objekts funktioniert nur wenn die php.ini-Einstellung <return>phar.readonly</return> auf 0
  gesetzt ist, sonst wird eine <class>PharException</class> geworfen.
  
  <strong>Phar::setMetadata()</strong> should be used to store customized data that describes something about the
  phar archive as a complete entity. <strong>PharFileInfo::setMetadata()</strong> should be used for file-specific
  meta-data. Meta-data can slow down the performance of loading a phar archive if the data is large.
  
  Some possible uses for meta-data include specifying which file within the archive should be used
  to bootstrap the archive, or the location of a file manifest like PEAR's package.xml file.
  However, any useful data that describes the phar archive may be stored.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$metadata</strong>  Any PHP variable containing information to store that describes the phar archive

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

<comment>See Also:</comment>
   * <strong>Phar::getMetadata()</strong>
   * <strong>Phar::delMetadata()</strong>
   * <strong>Phar::hasMetadata()</strong>


id: Phar::setSignatureAlgorithm
type: function
doc:
<comment>Description:</comment>
  Set the signature algorithm for a phar and apply it
  
  Diese Methode des <class>Phar</class>-Objekts funktioniert nur wenn die php.ini-Einstellung <return>phar.readonly</return> auf 0
  gesetzt ist, sonst wird eine <class>PharException</class> geworfen.
  
  set the signature algorithm for a phar and apply it.  The signature algorithm must be one of
  <return>Phar::MD5</return>, <return>Phar::SHA1</return>, <return>Phar::SHA256</return>, <return>Phar::SHA512</return>, or <return>Phar::OPENSSL</return>.
  
  Note that all executable phar archives have a signature created automatically, <return>SHA1</return> by default.
  data tar- or zip-based archives (archives created with the <class>PharData</class> class) must have their
  signature created and set explicitly via <strong>Phar::setSignatureAlgorithm()</strong>.

<comment>Param:</comment>
  <info>int</info>          <strong>$algo</strong>        One of <return>Phar::MD5</return>, <return>Phar::SHA1</return>, <return>Phar::SHA256</return>, <return>Phar::SHA512</return>, or
                            <return>Phar::OPENSSL</return>
  <info>string|null</info>  <strong>$privateKey</strong>  The contents of an OpenSSL private key, as extracted from a certificate
                            or OpenSSL key file: setSignatureAlgorithm(Phar::OPENSSL, $pkey);
                            ?> ]]> See phar introduction for instructions on naming and placement of
                            the public key file.

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

<comment>See Also:</comment>
   * <strong>Phar::getSupportedSignatures()</strong>
   * <strong>Phar::getSignature()</strong>


id: Phar::setStub
type: function
doc:
<comment>Description:</comment>
  Used to set the PHP loader or bootstrap stub of a Phar archive
  
  Diese Methode des <class>Phar</class>-Objekts funktioniert nur wenn die php.ini-Einstellung <return>phar.readonly</return> auf 0
  gesetzt ist, sonst wird eine <class>PharException</class> geworfen.
  
  This method is used to add a PHP bootstrap loader stub to a new Phar archive, or to replace the
  loader stub in an existing Phar archive.
  
  The loader stub for a Phar archive is used whenever an archive is included directly as in this
  example:
  
  The loader is not accessed when including a file through the <return>phar</return> stream wrapper like so:

<comment>Param:</comment>
  <info>resource|string</info>  <strong>$stub</strong>    A string or an open stream handle to use as the executable stub for this
                            phar archive.
  <info>int</info>              <strong>$length</strong>  

<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>Phar::getStub()</strong>
   * <strong>Phar::createDefaultStub()</strong>


id: Phar::startBuffering
type: function
doc:
<comment>Description:</comment>
  Start buffering Phar write operations, do not modify the Phar object on disk
  
  Although technically unnecessary, the <strong>Phar::startBuffering()</strong> method can provide a significant
  performance boost when creating or modifying a Phar archive with a large number of files.
  Ordinarily, every time a file within a Phar archive is created or modified in any way, the entire
  Phar archive will be recreated with the changes.  In this way, the archive will be up-to-date with
  the activity performed on it.
  
  However, this can be unnecessary when simply creating a new Phar archive, when it would make more
  sense to write the entire archive out at once. Similarly, it is often necessary to make a series
  of changes and to ensure that they all are possible before making any changes on disk, similar to
  the relational database concept of transactions.  the <strong>Phar::startBuffering()</strong>/<strong>Phar::stopBuffering()</strong>
  pair of methods is provided for this purpose.
  
  Phar write buffering is per-archive, buffering active for the <return>foo.phar</return> Phar archive does not
  affect changes to the <return>bar.phar</return> Phar archive.

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

<comment>See Also:</comment>
   * <strong>Phar::stopBuffering()</strong>
   * <strong>Phar::isBuffering()</strong>


id: Phar::stopBuffering
type: function
doc:
<comment>Description:</comment>
  Stop buffering write requests to the Phar archive, and save changes to disk
  
  <strong>Phar::stopBuffering()</strong> is used in conjunction with the <strong>Phar::startBuffering()</strong> method.
  <strong>Phar::startBuffering()</strong> can provide a significant performance boost when creating or modifying a
  Phar archive with a large number of files.  Ordinarily, every time a file within a Phar archive is
  created or modified in any way, the entire Phar archive will be recreated with the changes.  In
  this way, the archive will be up-to-date with the activity performed on it.
  
  However, this can be unnecessary when simply creating a new Phar archive, when it would make more
  sense to write the entire archive out at once. Similarly, it is often necessary to make a series
  of changes and to ensure that they all are possible before making any changes on disk, similar to
  the relational database concept of transactions.  The <strong>Phar::startBuffering()</strong>/<strong>Phar::stopBuffering()</strong>
  pair of methods is provided for this purpose.
  
  Phar write buffering is per-archive, buffering active for the <return>foo.phar</return> Phar archive does not
  affect changes to the <return>bar.phar</return> Phar archive.

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

<comment>See Also:</comment>
   * <strong>Phar::startBuffering()</strong>
   * <strong>Phar::isBuffering()</strong>


id: Phar::unlinkArchive
type: function
doc:
<comment>Description:</comment>
  Completely remove a phar archive from disk and from memory
  
  Removes a phar archive from disk and memory.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The path on disk to the phar archive.

<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>Phar::delete()</strong>
   * <strong>Phar::offsetUnset()</strong>


id: Phar::webPhar
type: function
doc:
<comment>Description:</comment>
  Routes a request from a web browser to an internal file within the phar archive
  
  <strong>Phar::webPhar()</strong> serves as <strong>Phar::mapPhar()</strong> for  web-based phars.  This method parses
  $_SERVER['REQUEST_URI'] and  routes a request from a web browser to an internal file within the
  phar archive.   It simulates a web server, routing requests to the correct file, echoing the
  correct  headers and parsing PHP files as needed.  Combined with <strong>Phar::mungServer()</strong>  and
  <strong>Phar::interceptFileFuncs()</strong>, any web application can be used  unmodified from a phar archive.
  
  <strong>Phar::webPhar()</strong> should only be called from the stub of a phar archive (see here for more
  information on what a stub is).

<comment>Param:</comment>
  <info>string|null</info>    <strong>$alias</strong>               The alias that can be used in <return>phar://</return> URLs to refer to this
                                      archive, rather than its full path.
  <info>string|null</info>    <strong>$index</strong>               The location within the phar of the directory index.
  <info>string|null</info>    <strong>$fileNotFoundScript</strong>  The location of the script to run when a file is not found.
                                      This script should output the proper HTTP 404 headers.
  <info>array</info>          <strong>$mimeTypes</strong>           An array mapping additional file extensions to MIME type. If
                                      the default mapping is sufficient, pass an empty array. By
                                      default, these extensions are mapped to these MIME types:
                                      Phar::PHPS, // pass to highlight_file() 'c' => 'text/plain',
                                      'cc' => 'text/plain', 'cpp' => 'text/plain', 'c++' =>
                                      'text/plain', 'dtd' => 'text/plain', 'h' => 'text/plain',
                                      'log' => 'text/plain', 'rng' => 'text/plain', 'txt' =>
                                      'text/plain', 'xsd' => 'text/plain', 'php' => Phar::PHP, //
                                      parse as PHP 'inc' => Phar::PHP, // parse as PHP 'avi' =>
                                      'video/avi', 'bmp' => 'image/bmp', 'css' => 'text/css', 'gif'
                                      => 'image/gif', 'htm' => 'text/html', 'html' => 'text/html',
                                      'htmls' => 'text/html', 'ico' => 'image/x-ico', 'jpe' =>
                                      'image/jpeg', 'jpg' => 'image/jpeg', 'jpeg' => 'image/jpeg',
                                      'js' => 'application/x-javascript', 'midi' => 'audio/midi',
                                      'mid' => 'audio/midi', 'mod' => 'audio/mod', 'mov' =>
                                      'movie/quicktime', 'mp3' => 'audio/mp3', 'mpg' =>
                                      'video/mpeg', 'mpeg' => 'video/mpeg', 'pdf' =>
                                      'application/pdf', 'png' => 'image/png', 'swf' =>
                                      'application/shockwave-flash', 'tif' => 'image/tiff', 'tiff'
                                      => 'image/tiff', 'wav' => 'audio/wav', 'xbm' => 'image/xbm',
                                      'xml' => 'text/xml',
                                      );
                                      ?> ]]>
  <info>callable|null</info>  <strong>$rewrite</strong>             The rewrites function is passed a string as its only parameter
                                      and must return a <info>string</info> or <info>false</info>.
                                      
                                      If you are using fast-cgi or cgi then the parameter passed to
                                      the function is the value of the  $_SERVER['PATH_INFO']
                                      variable. Otherwise, the parameter passed to the function is
                                      the value of the $_SERVER['REQUEST_URI'] variable.
                                      
                                      If a string is returned it is used as the internal file path.
                                      If <info>false</info> is returned then webPhar() will send a HTTP 403
                                      Denied Code.

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

<comment>See Also:</comment>
   * <strong>Phar::mungServer()</strong>
   * <strong>Phar::interceptFileFuncs()</strong>


id: PharData
type: class
doc:
<comment>Description:</comment>
  The PharData class provides a high-level interface to accessing and creating non-executable tar
  and zip archives.  Because these archives do not contain a stub and cannot be executed by the phar
  extension, it is possible to create and manipulate regular zip and tar files using the PharData
  class even if <return>phar.readonly</return> php.ini setting is <return>1</return>.


id: PharData::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a non-executable tar or zip archive object

<comment>Param:</comment>
  <info>string</info>       <strong>$filename</strong>  Path to an existing tar/zip archive or to-be-created archive
  <info>int</info>          <strong>$flags</strong>     Flags to pass to <class>Phar</class> parent class <class>RecursiveDirectoryIterator</class>.
  <info>string|null</info>  <strong>$alias</strong>     Alias with which this Phar archive should be referred to in calls to
                          stream functionality.
  <info>int</info>          <strong>$format</strong>    One of the file format constants available within the <class>Phar</class> class.


id: PharData::addEmptyDir
type: function
doc:
<comment>Description:</comment>
  Add an empty directory to the tar/zip archive
  
  With this method, an empty directory is created with path <return>dirname</return>. This method is similar to
  <strong>ZipArchive::addEmptyDir()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  The name of the empty directory to create in the phar archive

<comment>Return:</comment>
  <info>void</info>  no return value, exception is thrown on failure.

<comment>See Also:</comment>
   * <strong>Phar::addEmptyDir()</strong>
   * <strong>PharData::addFile()</strong>
   * <strong>PharData::addFromString()</strong>


id: PharData::addFile
type: function
doc:
<comment>Description:</comment>
  Add a file from the filesystem to the tar/zip archive
  
  With this method, any file or URL can be added to the tar/zip archive.  If the optional second
  parameter <return>localname</return> is specified, the file will be stored in the archive with that name, otherwise
  the <return>file</return> parameter is used as the path to store within the archive.  URLs must have a localname or
  an exception is thrown. This method is similar to <strong>ZipArchive::addFile()</strong>.

<comment>Param:</comment>
  <info>string</info>       <strong>$filename</strong>   Full or relative path to a file on disk to be added to the phar archive.
  <info>string|null</info>  <strong>$localName</strong>  Path that the file will be stored in the archive.

<comment>Return:</comment>
  <info>void</info>  no return value, exception is thrown on failure.

<comment>See Also:</comment>
   * <strong>PharData::offsetSet()</strong>
   * <strong>Phar::addFile()</strong>
   * <strong>PharData::addFromString()</strong>
   * <strong>PharData::addEmptyDir()</strong>


id: PharData::addFromString
type: function
doc:
<comment>Description:</comment>
  Add a file from a string to the tar/zip archive
  
  With this method, any string can be added to the tar/zip archive. The file will be stored in the
  archive with <return>localname</return> as its path.  This method is similar to <strong>ZipArchive::addFromString()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  Path that the file will be stored in the archive.
  <info>string</info>  <strong>$contents</strong>   The file contents to store

<comment>Return:</comment>
  <info>void</info>  no return value, exception is thrown on failure.

<comment>See Also:</comment>
   * <strong>PharData::offsetSet()</strong>
   * <strong>Phar::addFromString()</strong>
   * <strong>PharData::addFile()</strong>
   * <strong>PharData::addEmptyDir()</strong>


id: PharData::buildFromDirectory
type: function
doc:
<comment>Description:</comment>
  Construct a tar/zip archive from the files within a directory
  
  Populate a tar/zip archive from directory contents.  The optional second parameter is a regular
  expression (pcre) that is used to exclude files. Any filename that matches the regular expression
  will be included, all others will be excluded.  For more fine-grained control, use
  <strong>PharData::buildFromIterator()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  The full or relative path to the directory that contains all files to add to
                      the archive.
  <info>string</info>  <strong>$pattern</strong>    An optional pcre regular expression that is used to filter the list of files.
                      Only file paths matching the regular expression will be included in the
                      archive.

<comment>Return:</comment>
  <info>array</info>  <strong>Phar::buildFromDirectory()</strong> returns an associative array mapping internal path of file to
         the full path of the file on the filesystem, Bei einem Fehler wird <info>false</info> zurückgegeben..

<comment>See Also:</comment>
   * <strong>Phar::buildFromDirectory()</strong>
   * <strong>PharData::buildFromIterator()</strong>


id: PharData::buildFromIterator
type: function
doc:
<comment>Description:</comment>
  Construct a tar or zip archive from an iterator
  
  Populate a tar or zip archive from an iterator.  Two styles of iterators are supported, iterators
  that map the filename within the tar/zip to the name of a file on disk, and iterators like
  DirectoryIterator that return SplFileInfo objects.  For iterators that return SplFileInfo objects,
  the second parameter is required.

<comment>Param:</comment>
  <info>Traversable</info>  <strong>$iterator</strong>       Any iterator that either associatively maps tar/zip file to location
                               or returns SplFileInfo objects
  <info>string|null</info>  <strong>$baseDirectory</strong>  For iterators that return SplFileInfo objects, the portion of each
                               file's full path to remove when adding to the tar/zip archive

<comment>Return:</comment>
  <info>array</info>  <strong>PharData::buildFromIterator()</strong> returns an associative array mapping internal path of file to
         the full path of the file on the filesystem.

<comment>See Also:</comment>
   * <strong>Phar::buildFromIterator()</strong>


id: PharData::compress
type: function
doc:
<comment>Description:</comment>
  Compresses the entire tar/zip archive using Gzip or Bzip2 compression
  
  For tar archives, this method compresses the entire archive using gzip compression or bzip2
  compression.  The resulting file can be processed with the gunzip command/bunzip command, or
  accessed directly and transparently with the Phar extension.
  
  For zip archives, this method fails with an exception. The zlib extension must be enabled to
  compress with gzip compression, the bzip2 extension must be enabled in order to compress with
  bzip2 compression.
  
  In addition, this method automatically renames the archive, appending <return>.gz</return>, <return>.bz2</return> or removing the
  extension if passed <return>Phar::NONE</return> to remove compression.  Alternatively, a file extension may be
  specified with the second parameter.

<comment>Param:</comment>
  <info>int</info>          <strong>$compression</strong>  Compression must be one of <return>Phar::GZ</return>, <return>Phar::BZ2</return> to add compression, or
                             <return>Phar::NONE</return> to remove compression.
  <info>string|null</info>  <strong>$extension</strong>    By default, the extension is <return>.tar.gz</return> or <return>.tar.bz2</return> for compressing a tar,
                             and <return>.tar</return> for decompressing.

<comment>Return:</comment>
  <info>PharData|null</info>  A <class>PharData</class> object is returned on success, or <info>null</info> on failure.

<comment>See Also:</comment>
   * <strong>Phar::compress()</strong>


id: PharData::compressFiles
type: function
doc:
<comment>Description:</comment>
  Compresses all files in the current tar/zip archive
  
  For tar-based archives, this method throws a <class>BadMethodCallException</class>, as compression of individual
  files within a tar archive is not supported by the file format.  Use <strong>PharData::compress()</strong> to
  compress an entire tar-based archive.
  
  For Zip-based archives, this method compresses all files in the archive using the specified
  compression. The zlib  or bzip2 extensions must be enabled to take advantage of this feature.  In
  addition, if any files are already compressed using bzip2/zlib compression, the respective
  extension must be enabled in order to decompress the files prior to re-compressing.

<comment>Param:</comment>
  <info>int</info>  <strong>$compression</strong>  Compression must be one of <return>Phar::GZ</return>, <return>Phar::BZ2</return> to add compression, or
                     <return>Phar::NONE</return> to remove compression.

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

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>PharData::decompressFiles()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>PharData::compress()</strong>
   * <strong>PharData::decompress()</strong>


id: PharData::convertToData
type: function
doc:
<comment>Description:</comment>
  Convert a phar archive to a non-executable tar or zip file
  
  This method is used to convert a non-executable tar or zip archive to another non-executable
  format.
  
  If no changes are specified, this method throws a <class>BadMethodCallException</class>. This method should be
  used to convert a tar archive to zip format or vice-versa.  Although it is possible to simply
  change the compression of a tar archive using this method, it is better to use the
  <strong>PharData::compress()</strong> method for logical consistency.
  
  If successful, the method creates a new archive on disk and returns a <class>PharData</class> object.  The old
  archive is not removed from disk, and should be done manually after the process has finished.

<comment>Param:</comment>
  <info>int|null</info>     <strong>$format</strong>       This should be one of <return>Phar::TAR</return> or <return>Phar::ZIP</return>.  If set to <info>null</info>, the
                             existing file format will be preserved.
  <info>int|null</info>     <strong>$compression</strong>  This should be one of <return>Phar::NONE</return> for no whole-archive compression,
                             <return>Phar::GZ</return> for zlib-based compression, and <return>Phar::BZ2</return> for bzip-based
                             compression.
  <info>string|null</info>  <strong>$extension</strong>    This parameter is used to override the default file extension for a
                             converted archive.  Note that <return>.phar</return> cannot be used anywhere in the
                             filename for a non-executable tar or zip archive.
                             
                             If converting to a tar-based phar archive, the default extensions are
                             <return>.tar</return>, <return>.tar.gz</return>, and <return>.tar.bz2</return> depending on specified compression. For
                             zip-based archives, the default extension is <return>.zip</return>.

<comment>Return:</comment>
  <info>PharData|null</info>  The method returns a <class>PharData</class> object on success, or <info>null</info> on failure.

<comment>See Also:</comment>
   * <strong>Phar::convertToExecutable()</strong>
   * <strong>Phar::convertToData()</strong>
   * <strong>PharData::convertToExecutable()</strong>


id: PharData::convertToExecutable
type: function
doc:
<comment>Description:</comment>
  Convert a non-executable tar/zip archive to an executable phar archive
  
  Diese Methode des <class>Phar</class>-Objekts funktioniert nur wenn die php.ini-Einstellung <return>phar.readonly</return> auf 0
  gesetzt ist, sonst wird eine <class>PharException</class> geworfen.
  
  This method is used to convert a non-executable tar or zip archive to an executable phar archive.
  Any of the three executable file formats (phar, tar or zip) can be used, and whole-archive
  compression can also be performed.
  
  If no changes are specified, this method throws a <class>BadMethodCallException</class>.
  
  If successful, the method creates a new archive on disk and returns a <class>Phar</class> object.  The old
  archive is not removed from disk, and should be done manually after the process has finished.

<comment>Param:</comment>
  <info>int|null</info>     <strong>$format</strong>       This should be one of <return>Phar::PHAR</return>, <return>Phar::TAR</return>, or <return>Phar::ZIP</return>.  If set to
                             <info>null</info>, the existing file format will be preserved.
  <info>int|null</info>     <strong>$compression</strong>  This should be one of <return>Phar::NONE</return> for no whole-archive compression,
                             <return>Phar::GZ</return> for zlib-based compression, and <return>Phar::BZ2</return> for bzip-based
                             compression.
  <info>string|null</info>  <strong>$extension</strong>    This parameter is used to override the default file extension for a
                             converted archive.  Note that all zip- and tar-based phar archives must
                             contain <return>.phar</return> in their file extension in order to be processed as a
                             phar archive.
                             
                             If converting to a phar-based archive, the default extensions are
                             <return>.phar</return>, <return>.phar.gz</return>, or <return>.phar.bz2</return> depending on the specified compression.
                             For tar-based phar archives, the default extensions are <return>.phar.tar</return>,
                             <return>.phar.tar.gz</return>, and <return>.phar.tar.bz2</return>.  For zip-based phar archives, the
                             default extension is <return>.phar.zip</return>.

<comment>Return:</comment>
  <info>Phar|null</info>  The method returns a <class>Phar</class> object on success, or <info>null</info> on failure.

<comment>See Also:</comment>
   * <strong>Phar::convertToExecutable()</strong>
   * <strong>Phar::convertToData()</strong>
   * <strong>PharData::convertToData()</strong>


id: PharData::copy
type: function
doc:
<comment>Description:</comment>
  Copy a file internal to the phar archive to another new file within the phar
  
  Copy a file internal to the tar/zip archive to another new file within the same archive. This is
  an object-oriented alternative to using <strong>copy()</strong> with the phar stream wrapper.

<comment>Param:</comment>
  <info>string</info>  <strong>$from</strong>  
  <info>string</info>  <strong>$to</strong>    

<comment>Return:</comment>
  <info>bool</info>  returns <info>true</info> on success, but it is safer to encase method call in a try/catch block and
        assume success if no exception is thrown.


id: PharData::decompress
type: function
doc:
<comment>Description:</comment>
  Decompresses the entire Phar archive
  
  For tar-based archives, this method decompresses the entire archive.
  
  For Zip-based archives, this method fails with an exception. The zlib extension must be enabled to
  decompress an archive compressed with gzip compression, and the bzip2 extension must be enabled in
  order to decompress an archive compressed with bzip2 compression.
  
  In addition, this method automatically renames the file extension of the archive, <return>.tar</return> by default.
  Alternatively, a file extension may be specified with the <strong>$extension</strong> parameter.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$extension</strong>  For decompressing, the default file extension is <return>.tar</return>. Use this parameter
                           to specify another file extension. Be aware that only executable archives
                           can contain <return>.phar</return> in their filename.

<comment>Return:</comment>
  <info>PharData|null</info>  A <class>PharData</class> object is returned on success, or <info>null</info> on failure.

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>PharData::compress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>PharData::compress()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>PharData::compressFiles()</strong>
   * <strong>PharData::decompressFiles()</strong>


id: PharData::decompressFiles
type: function
doc:
<comment>Description:</comment>
  Decompresses all files in the current zip archive
  
  Diese Methode des <class>Phar</class>-Objekts funktioniert nur wenn die php.ini-Einstellung <return>phar.readonly</return> auf 0
  gesetzt ist, sonst wird eine <class>PharException</class> geworfen.
  
  For tar-based archives, this method throws a <class>BadMethodCallException</class>, as compression of individual
  files within a tar archive is not supported by the file format.  Use <strong>PharData::compress()</strong> to
  compress an entire tar-based archive.
  
  For Zip-based archives, this method decompresses all files in the archive. The zlib  or bzip2
  extensions must be enabled to take advantage of this feature if any files are compressed using
  bzip2/zlib compression.

<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>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>PharData::compressFiles()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>PharData::compress()</strong>
   * <strong>PharData::decompress()</strong>


id: PharData::delMetadata
type: function
doc:
<comment>Description:</comment>
  Deletes the global metadata of a zip archive
  
  Diese Methode des <class>Phar</class>-Objekts funktioniert nur wenn die php.ini-Einstellung <return>phar.readonly</return> auf 0
  gesetzt ist, sonst wird eine <class>PharException</class> geworfen.
  
  Deletes the global metadata of the zip archive

<comment>Return:</comment>
  <info>bool</info>  returns <info>true</info> on success, but it is better to check for thrown exception, and assume success
        if none is thrown.

<comment>See Also:</comment>
   * <strong>Phar::delMetadata()</strong>


id: PharData::delete
type: function
doc:
<comment>Description:</comment>
  Delete a file within a tar/zip archive
  
  Delete a file within an archive.  This is the functional equivalent of calling <strong>unlink()</strong> on the
  stream wrapper equivalent, as shown in the example below.

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  Path within an archive to the file to delete.

<comment>Return:</comment>
  <info>bool</info>  returns <info>true</info> on success, but it is better to check for thrown exception, and assume success
        if none is thrown.

<comment>See Also:</comment>
   * <strong>Phar::delete()</strong>


id: PharData::extractTo
type: function
doc:
<comment>Description:</comment>
  Extract the contents of a tar/zip archive to a directory
  
  Extract all files within a tar/zip archive to disk.  Extracted files and directories preserve
  permissions as stored in the archive.  The optional parameters allow optional control over which
  files are extracted, and whether existing files on disk can be overwritten. The second parameter
  <return>files</return> can be either the name of a file or directory to extract, or an array of names of files and
  directories to extract.  By default, this method will not overwrite existing files, the third
  parameter can be set to true to enable overwriting of files. This method is similar to
  <strong>ZipArchive::extractTo()</strong>.

<comment>Param:</comment>
  <info>string</info>             <strong>$directory</strong>  Path to extract the given <return>files</return> to
  <info>array|string|null</info>  <strong>$files</strong>      The name of a file or directory to extract, or an array of
                                 files/directories to extract
  <info>bool</info>               <strong>$overwrite</strong>  Set to <info>true</info> to enable overwriting existing files

<comment>Return:</comment>
  <info>bool</info>  returns <info>true</info> on success, but it is better to check for thrown exception, and assume success
        if none is thrown.

<comment>See Also:</comment>
   * <strong>Phar::extractTo()</strong>


id: PharData::isWritable
type: function
doc:
<comment>Description:</comment>
  Returns true if the tar/zip archive can be modified
  
  This method returns <info>true</info> if the tar/zip archive on disk is not read-only. Unlike
  <strong>Phar::isWritable()</strong>, data-only tar/zip archives can be modified even if <return>phar.readonly</return> is set to <return>1</return>.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the tar/zip archive can be modified

<comment>See Also:</comment>
   * <strong>Phar::canWrite()</strong>
   * <strong>Phar::isWritable()</strong>


id: PharData::offsetSet
type: function
doc:
<comment>Description:</comment>
  Set the contents of a file within the tar/zip to those of an external file or string
  
  This is an implementation of the ArrayAccess interface allowing direct manipulation of the
  contents of a tar/zip archive using array access brackets.  offsetSet is used for modifying an
  existing file, or adding a new file to a tar/zip archive.

<comment>Param:</comment>
  <info>string</info>           <strong>$localName</strong>  The filename (relative path) to modify in a tar or zip archive.
  <info>resource|string</info>  <strong>$value</strong>      Content of the file.

<comment>Return:</comment>
  <info>void</info>  No return values.

<comment>See Also:</comment>
   * <strong>Phar::offsetSet()</strong>


id: PharData::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Remove a file from a tar/zip archive
  
  This is an implementation of the ArrayAccess interface allowing direct manipulation of the
  contents of a tar/zip archive using array access brackets.  offsetUnset is used for deleting an
  existing file, and is called by the <strong>unset()</strong> language construct.

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  The filename (relative path) to modify in the tar/zip archive.

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

<comment>See Also:</comment>
   * <strong>Phar::offsetUnset()</strong>


id: PharData::setAlias
type: function
doc:
<comment>Description:</comment>
  Dummy function (Phar::setAlias is not valid for PharData)
  
  Non-executable tar/zip archives cannot have an alias, so this method simply throws an exception.

<comment>Param:</comment>
  <info>string</info>  <strong>$alias</strong>  A shorthand string that this archive can be referred to in <return>phar</return> stream wrapper
                  access.  This parameter is ignored.

<comment>Return:</comment>
  <info>bool</info>  

<comment>See Also:</comment>
   * <strong>Phar::setAlias()</strong>


id: PharData::setDefaultStub
type: function
doc:
<comment>Description:</comment>
  Dummy function (Phar::setDefaultStub is not valid for PharData)
  
  Non-executable tar/zip archives cannot have a stub, so this method simply throws an exception.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$index</strong>     Relative path within the phar archive to run if accessed on the
                          command-line
  <info>string|null</info>  <strong>$webIndex</strong>  Relative path within the phar archive to run if accessed through a web
                          browser

<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>Phar::setDefaultStub()</strong>


id: PharData::setSignatureAlgorithm
type: function
doc:
<comment>Description:</comment>
  Set the signature algorithm for a phar and apply it
  
  Diese Methode des <class>Phar</class>-Objekts funktioniert nur wenn die php.ini-Einstellung <return>phar.readonly</return> auf 0
  gesetzt ist, sonst wird eine <class>PharException</class> geworfen.
  
  Set the signature algorithm for a phar and apply it.  The signature algorithm must be one of
  <return>Phar::MD5</return>, <return>Phar::SHA1</return>, <return>Phar::SHA256</return>, <return>Phar::SHA512</return>, or <return>Phar::OPENSSL</return>.

<comment>Param:</comment>
  <info>int</info>  <strong>$algo</strong>  One of <return>Phar::MD5</return>, <return>Phar::SHA1</return>, <return>Phar::SHA256</return>, <return>Phar::SHA512</return>, or <return>Phar::OPENSSL</return>

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

<comment>See Also:</comment>
   * <strong>Phar::getSupportedSignatures()</strong>
   * <strong>Phar::getSignature()</strong>


id: PharData::setStub
type: function
doc:
<comment>Description:</comment>
  Dummy function (Phar::setStub is not valid for PharData)
  
  Non-executable tar/zip archives cannot have a stub, so this method simply throws an exception.

<comment>Param:</comment>
  <info>string</info>  <strong>$stub</strong>  A string or an open stream handle to use as the executable stub for this phar
                 archive.  This parameter is ignored.
  <info>int</info>     <strong>$len</strong>   

<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>Phar::setStub()</strong>


id: PharFileInfo
type: class
doc:
<comment>Description:</comment>
  The PharFileInfo class provides a high-level interface to the contents and attributes of a single
  file within a phar archive.


id: PharFileInfo::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a Phar entry object
  
  This should not be called directly.  Instead, a PharFileInfo object is initialized by calling
  <strong>Phar::offsetGet()</strong> through array access.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The full url to retrieve a file.  If you wish to retrieve the information for
                     the file <return>my/file.php</return> from the phar <return>boo.phar</return>, the entry should be
                     <return>phar://boo.phar/my/file.php</return>.


id: PharFileInfo::chmod
type: function
doc:
<comment>Description:</comment>
  Sets file-specific permission bits
  
  <strong>PharFileInfo::chmod()</strong> allows setting of the executable file permissions bit, as well as read-only
  bits.  Writeable bits are ignored, and set at runtime based on the phar.readonly INI variable. As
  with all functionality that modifies the contents of a phar, the phar.readonly INI variable must
  be off in order to succeed if the file is within a <class>Phar</class> archive.  Files within <class>PharData</class> archives
  do not have this restriction.

<comment>Param:</comment>
  <info>int</info>  <strong>$perms</strong>  permissions (see <strong>chmod()</strong>)

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


id: PharFileInfo::compress
type: function
doc:
<comment>Description:</comment>
  Compresses the current Phar entry with either zlib or bzip2 compression
  
  This method compresses the file inside the Phar archive using either bzip2 compression or zlib
  compression. The bzip2 or zlib extension must be enabled to take advantage of this feature.  In
  addition, if the file is already compressed, the respective extension must be enabled in order to
  decompress the file.  As with all functionality that modifies the contents of a phar, the
  phar.readonly INI variable must be off in order to succeed if the file is within a <class>Phar</class> archive.
  Files within <class>PharData</class> archives do not have this restriction.

<comment>Param:</comment>
  <info>int</info>  <strong>$compression</strong>  Compression must be <info>Phar::GZ</info> or <info>Phar::BZ2</info>.

<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>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>Phar::compressFiles()</strong>
   * <strong>Phar::decompressFiles()</strong>
   * <strong>Phar::compress()</strong>
   * <strong>Phar::decompress()</strong>
   * <strong>Phar::getSupportedCompression()</strong>


id: PharFileInfo::decompress
type: function
doc:
<comment>Description:</comment>
  Decompresses the current Phar entry within the phar
  
  This method decompresses the file inside the Phar archive. Depending on how the file is
  compressed, the bzip2 or zlib extensions must be enabled to take advantage of this feature.  As
  with all functionality that modifies the contents of a phar, the phar.readonly INI variable must
  be off in order to succeed if the file is within a <class>Phar</class> archive.  Files within <class>PharData</class> archives
  do not have this restriction.

<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>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>Phar::compressFiles()</strong>
   * <strong>Phar::decompressFiles()</strong>
   * <strong>Phar::compress()</strong>
   * <strong>Phar::decompress()</strong>
   * <strong>Phar::getSupportedCompression()</strong>


id: PharFileInfo::delMetadata
type: function
doc:
<comment>Description:</comment>
  Deletes the metadata of the entry
  
  Deletes the metadata of the entry, if any.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if successful, <info>false</info> if the entry had no metadata. As with all functionality
        that modifies the contents of a phar, the phar.readonly INI variable must be off in order to
        succeed if the file is within a <class>Phar</class> archive.  Files within <class>PharData</class> archives do not have
        this restriction.

<comment>See Also:</comment>
   * <strong>PharFileInfo::setMetadata()</strong>
   * <strong>PharFileInfo::hasMetadata()</strong>
   * <strong>PharFileInfo::getMetadata()</strong>
   * <strong>Phar::setMetadata()</strong>
   * <strong>Phar::hasMetadata()</strong>
   * <strong>Phar::getMetadata()</strong>


id: PharFileInfo::getCRC32
type: function
doc:
<comment>Description:</comment>
  Returns CRC32 code or throws an exception if CRC has not been verified
  
  This returns the <strong>crc32()</strong> checksum of the file within the Phar archive.

<comment>Return:</comment>
  <info>int</info>  The <strong>crc32()</strong> checksum of the file within the Phar archive.


id: PharFileInfo::getCompressedSize
type: function
doc:
<comment>Description:</comment>
  Returns the actual size of the file (with compression) inside the Phar archive
  
  This returns the size of the file within the Phar archive.  Uncompressed files will return the
  same value for getCompressedSize as they will with <strong>filesize()</strong>

<comment>Return:</comment>
  <info>int</info>  The size in bytes of the file within the Phar archive on disk.

<comment>See Also:</comment>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>Phar::compress()</strong>
   * <strong>Phar::decompress()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>Phar::decompressFiles()</strong>
   * <strong>Phar::compressFiles()</strong>


id: PharFileInfo::getContent
type: function
doc:
<comment>Description:</comment>
  Get the complete file contents of the entry
  
  This function behaves like <strong>file_get_contents()</strong> but for Phar.

<comment>Return:</comment>
  <info>string</info>  Returns the file contents.


id: PharFileInfo::getMetadata
type: function
doc:
<comment>Description:</comment>
  Returns file-specific meta-data saved with a file
  
  Return meta-data that was saved in the Phar archive's manifest for this file.

<comment>Return:</comment>
  <info>mixed</info>  any PHP variable that can be serialized and is stored as meta-data for the file, or <info>null</info> if
         no meta-data is stored.

<comment>See Also:</comment>
   * <strong>PharFileInfo::setMetadata()</strong>
   * <strong>PharFileInfo::hasMetadata()</strong>
   * <strong>PharFileInfo::delMetadata()</strong>
   * <strong>Phar::setMetadata()</strong>
   * <strong>Phar::hasMetadata()</strong>
   * <strong>Phar::getMetadata()</strong>


id: PharFileInfo::getPharFlags
type: function
doc:
<comment>Description:</comment>
  Returns the Phar file entry flags
  
  This returns the flags set in the manifest for a Phar.  This will always return <return>0</return> in the current
  implementation.

<comment>Return:</comment>
  <info>int</info>  The Phar flags (always <return>0</return> in the current implementation)


id: PharFileInfo::hasMetadata
type: function
doc:
<comment>Description:</comment>
  Returns the metadata of the entry
  
  Returns the metadata of a file within a phar archive.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>false</info> if no metadata is set or is <info>null</info>, <info>true</info> if metadata is not <info>null</info>

<comment>See Also:</comment>
   * <strong>PharFileInfo::setMetadata()</strong>
   * <strong>PharFileInfo::getMetadata()</strong>
   * <strong>PharFileInfo::delMetadata()</strong>
   * <strong>Phar::setMetadata()</strong>
   * <strong>Phar::hasMetadata()</strong>
   * <strong>Phar::getMetadata()</strong>


id: PharFileInfo::isCRCChecked
type: function
doc:
<comment>Description:</comment>
  Returns whether file entry has had its CRC verified
  
  This returns whether a file within a Phar archive has had its CRC verified.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the file has had its CRC verified, <info>false</info> if not.


id: PharFileInfo::isCompressed
type: function
doc:
<comment>Description:</comment>
  Returns whether the entry is compressed
  
  This returns whether a file is compressed within a Phar archive with either Gzip or Bzip2
  compression.

<comment>Param:</comment>
  <info>int|null</info>  <strong>$compression</strong>  One of <info>Phar::GZ</info> or <info>Phar::BZ2</info>, defaults to any compression.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the file is compressed within the Phar archive, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>Phar::decompress()</strong>
   * <strong>Phar::compress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>Phar::decompressFiles()</strong>
   * <strong>Phar::compressFiles()</strong>


id: PharFileInfo::setMetadata
type: function
doc:
<comment>Description:</comment>
  Sets file-specific meta-data saved with a file
  
  <strong>PharFileInfo::setMetadata()</strong> should only be used to store customized data in a file that cannot be
  represented with existing information stored with a file. Meta-data can significantly slow down
  the performance of loading a phar archive if the data is large, or if there are many files
  containing meta-data. It is important to note that file permissions are natively supported inside
  a phar; it is possible to set them with the <strong>PharFileInfo::chmod()</strong> method.  As with all
  functionality that modifies the contents of a phar, the phar.readonly INI variable must be off in
  order to succeed if the file is within a <class>Phar</class> archive.  Files within <class>PharData</class> archives do not have
  this restriction.
  
  Some possible uses for meta-data include passing a user/group that should be set when a file is
  extracted from the phar to disk.  Other uses could include explicitly specifying a MIME type to
  return.  However, any useful data that describes a file, but should not be contained inside of it
  may be stored.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$metadata</strong>  Any PHP variable containing information to store alongside a file

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

<comment>See Also:</comment>
   * <strong>PharFileInfo::hasMetadata()</strong>
   * <strong>PharFileInfo::getMetadata()</strong>
   * <strong>PharFileInfo::delMetadata()</strong>
   * <strong>Phar::setMetadata()</strong>
   * <strong>Phar::hasMetadata()</strong>
   * <strong>Phar::getMetadata()</strong>


id: PhpToken
type: class
doc:
<comment>Description:</comment>
  This class provides an alternative to <strong>token_get_all()</strong>. While the function returns tokens either as
  a single-character string, or an array with a token ID, token text and line number,
  <strong>PhpToken::tokenize()</strong> normalizes all tokens into PhpToken objects, which makes code operating on
  tokens more memory efficient and readable.


id: PhpToken::__construct
type: function
doc:
<comment>Description:</comment>
  Returns a new PhpToken object
  
  Returns a new PhpToken object

<comment>Param:</comment>
  <info>int</info>     <strong>$id</strong>    One of the T_* constants (see ), or an ASCII codepoint representing a single-char
                 token.
  <info>string</info>  <strong>$text</strong>  The textual content of the token.
  <info>int</info>     <strong>$line</strong>  The starting line number (1-based) of the token.
  <info>int</info>     <strong>$pos</strong>   The starting position (0-based) in the tokenized string (the number of bytes).

<comment>See Also:</comment>
   * <strong>PhpToken::tokenize()</strong>


id: PhpToken::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the textual content of the token.
  
  Returns the textual content of the token.

<comment>Return:</comment>
  <info>string</info>  A textual content of the token.

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


id: PhpToken::getTokenName
type: function
doc:
<comment>Description:</comment>
  Returns the name of the token.
  
  Returns the name of the token.

<comment>Return:</comment>
  <info>string|null</info>  An ASCII character for single-char tokens, or one of T_* constant names for known
               tokens (see ), or <info>null</info> for unknown tokens.

<comment>See Also:</comment>
   * <strong>PhpToken::tokenize()</strong>
   * <strong>token_name()</strong>


id: PhpToken::is
type: function
doc:
<comment>Description:</comment>
  Tells whether the token is of given kind.
  
  Tells whether the token is of given <strong>$kind</strong>.

<comment>Param:</comment>
  <info>int|string|array</info>  <strong>$kind</strong>  Either a single value to match the token's id or textual content, or an
                           array thereof.

<comment>Return:</comment>
  <info>bool</info>  A boolean value whether the token is of given kind.

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


id: PhpToken::isIgnorable
type: function
doc:
<comment>Description:</comment>
  Tells whether the token would be ignored by the PHP parser.
  
  Tells whether the token would be ignored by the PHP parser.

<comment>Return:</comment>
  <info>bool</info>  A boolean value whether the token would be ignored by the PHP parser (such as whitespace or
        comments).

<comment>See Also:</comment>
   * <strong>PhpToken::tokenize()</strong>


id: PhpToken::tokenize
type: function
doc:
<comment>Description:</comment>
  Splits given source into PHP tokens, represented by PhpToken objects.
  
  Returns an array of PhpToken objects representing given <strong>$code</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$code</strong>   The PHP source to parse.
  <info>int</info>     <strong>$flags</strong>  Valid flags: <info>TOKEN_PARSE</info> - Recognises the ability to use reserved words in
                  specific contexts.
                  
                  <info>TOKEN_PARSE</info> - Recognises the ability to use reserved words in specific contexts.

<comment>Return:</comment>
  <info>array</info>  An array of PHP tokens represented by instances of PhpToken or its descendants. This method
         returns <info>static[]</info> so that PhpToken can be seamlessly extended.

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


id: Pool
type: class
doc:
<comment>Description:</comment>
  A Pool is a container for, and controller of, an adjustable number of Workers.
  
  Pooling provides a higher level abstraction of the Worker functionality, including the management
  of references in the way required by pthreads.


id: Pool::__construct
type: function
doc:
<comment>Description:</comment>
  Creates a new Pool of Workers
  
  Construct a new pool of workers. Pools lazily create their threads, which means new threads will
  only be spawned when they are required to execute tasks.

<comment>Param:</comment>
  <info>int</info>     <strong>$size</strong>   The maximum number of workers for this pool to create
  <info>string</info>  <strong>$class</strong>  The class for new Workers. If no class is given, then it defaults to the <class>Worker</class>
                  class.
  <info>array</info>   <strong>$ctor</strong>   An array of arguments to be passed to new workers' constructors


id: Pool::collect
type: function
doc:
<comment>Description:</comment>
  Collect references to completed tasks
  
  Allows the pool to collect references determined to be garbage by the optionally given collector.

<comment>Param:</comment>
  <info>Callable</info>  <strong>$collector</strong>  A Callable collector that returns a boolean on whether the task can be
                        collected or not. Only in rare cases should a custom collector need to be
                        used.

<comment>Return:</comment>
  <info>int</info>  The number of remaining tasks in the pool to be collected.


id: Pool::resize
type: function
doc:
<comment>Description:</comment>
  Resize the Pool
  
  Resize the Pool

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  The maximum number of Workers this Pool can create

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


id: Pool::shutdown
type: function
doc:
<comment>Description:</comment>
  Shutdown all workers
  
  Shuts down all of the workers in the pool. This will block until all submitted tasks have been
  executed.

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


id: Pool::submit
type: function
doc:
<comment>Description:</comment>
  Submits an object for execution
  
  Submit the task to the next Worker in the Pool

<comment>Param:</comment>
  <info>Threaded</info>  <strong>$task</strong>  The task for execution

<comment>Return:</comment>
  <info>int</info>  the identifier of the Worker executing the object


id: Pool::submitTo
type: function
doc:
<comment>Description:</comment>
  Submits a task to a specific worker for execution
  
  Submit a task to the specified worker in the pool. The workers are indexed from 0, and will only
  exist if the pool has needed to create them (since threads are lazily spawned).

<comment>Param:</comment>
  <info>int</info>       <strong>$worker</strong>  The worker to stack the task onto, indexed from <return>0</return>.
  <info>Threaded</info>  <strong>$task</strong>    The task for execution.

<comment>Return:</comment>
  <info>int</info>  The identifier of the worker that accepted the task.


id: QuickHashIntHash
type: class
doc:
<comment>Description:</comment>
  This class wraps around a hash containing integer numbers, where the values are also integer
  numbers. Hashes are also available as implementation of the ArrayAccess interface.
  
  Hashes can also be iterated over with <return>foreach</return> as the Iterator interface is implemented as well.
  The order of which elements are returned in is not guaranteed.


id: QuickHashIntHash::CHECK_FOR_DUPES
type: constant
doc:
<comment>Description:</comment>
  If enabled, adding duplicate elements to a set (through either QuickHashIntHash::add or
  QuickHashIntHash::loadFromFile) will result in those elements to be dropped from the set. This
  will take up extra time, so only used when it is required.


id: QuickHashIntHash::DO_NOT_USE_ZEND_ALLOC
type: constant
doc:
<comment>Description:</comment>
  Disables the use of PHP's internal memory manager for internal set structures. With this option
  enabled, internal allocations will not count towards the memory_limit settings.


id: QuickHashIntHash::HASHER_JENKINS1
type: constant
doc:
<comment>Description:</comment>
  This is the default hashing function to turn the integer hashes into bucket list indexes.


id: QuickHashIntHash::HASHER_NO_HASH
type: constant
doc:
<comment>Description:</comment>
  Selects to not use a hashing function, but merely use a modulo to find the bucket list index. This
  is not faster than normal hashing, and gives more collisions.


id: QuickHashIntHash::__construct
type: function
doc:
<comment>Description:</comment>
  Creates a new QuickHashIntHash object
  
  This constructor creates a new <class>QuickHashIntHash</class>. The size is the amount of bucket lists to create.
  The more lists there are, the less collisions you will have. Options are also supported.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>     The amount of bucket lists to configure. The number you pass in will be
                 automatically rounded up to the next power of two. It is also automatically limited
                 from <return>64</return> to <return>4194304</return>.
  <info>int</info>  <strong>$options</strong>  The options that you can pass in are: <info>QuickHashIntHash::CHECK_FOR_DUPES</info>, which
                 makes sure no duplicate entries are added to the hash;
                 <info>QuickHashIntHash::DO_NOT_USE_ZEND_ALLOC</info> to not use PHP's internal memory manager as
                 well as one of <info>QuickHashIntHash::HASHER_NO_HASH</info>, <info>QuickHashIntHash::HASHER_JENKINS1</info>
                 or <info>QuickHashIntHash::HASHER_JENKINS2</info>. These last three configure which hashing
                 algorithm to use. All options can be combined using bitmasks.

<comment>Return:</comment>
  <info>unknown</info>  Returns a new <class>QuickHashIntHash</class> object.


id: QuickHashIntHash::add
type: function
doc:
<comment>Description:</comment>
  This method adds a new entry to the hash
  
  This method adds a new entry to the hash, and returns whether the entry was added. Entries are by
  default always added unless <info>QuickHashIntHash::CHECK_FOR_DUPES</info> has been passed when the hash was
  created.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>    The key of the entry to add.
  <info>int</info>  <strong>$value</strong>  The optional value of the entry to add. If no value is specified, <return>1</return> will be used.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> when the entry was added, and <info>false</info> if the entry was not added.


id: QuickHashIntHash::delete
type: function
doc:
<comment>Description:</comment>
  This method deletes an entry from the hash
  
  This method deletes an entry from the hash, and returns whether the entry was deleted or not.
  Associated memory structures will not be freed immediately, but rather when the hash itself is
  freed.
  
  Elements can not be deleted when the hash is used in an iterator. The method will not throw an
  exception, but simply return <info>false</info> like would happen with any other deletion failure.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>  The key of the entry to delete.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> when the entry was deleted, and <info>false</info> if the entry was not deleted.


id: QuickHashIntHash::exists
type: function
doc:
<comment>Description:</comment>
  This method checks whether a key is part of the hash
  
  This method checks whether an entry with the provided key exists in the hash.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>  The key of the entry to check for whether it exists in the hash.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> when the entry was found, or <info>false</info> when the entry is not found.


id: QuickHashIntHash::get
type: function
doc:
<comment>Description:</comment>
  This method retrieves a value from the hash by its key
  
  This method retrieves a value from the hash by its key.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>  The key of the entry to retrieve.

<comment>Return:</comment>
  <info>int</info>  The value if the key exists, or <info>null</info> if the key wasn't part of the hash.


id: QuickHashIntHash::getSize
type: function
doc:
<comment>Description:</comment>
  Returns the number of elements in the hash
  
  Returns the number of elements in the hash.

<comment>Return:</comment>
  <info>int</info>  The number of elements in the hash.


id: QuickHashIntHash::loadFromFile
type: function
doc:
<comment>Description:</comment>
  This factory method creates a hash from a file
  
  This factory method creates a new hash from a definition file on disk. The file format consists of
  a signature <return>'QH\0x11\0'</return>, the number of elements as a 32 bit signed integer in system Endianness,
  followed by 32 bit signed integers packed together in the Endianness that the system that the code
  runs on uses. For each hash element there are two 32 bit signed integers stored. The first of each
  element is the key, and the second is the value belonging to the key. An example could be:
  
  QuickHash IntHash file format
  
  QuickHash IntHash file format

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The filename of the file to read the hash from.
  <info>int</info>     <strong>$options</strong>   The same options that the class' constructor takes; except that the size option
                     is ignored. It is automatically calculated to be the same as the number of
                     entries in the hash, rounded up to the nearest power of two with a maximum
                     limit of <return>4194304</return>.

<comment>Return:</comment>
  <info>QuickHashIntHash</info>  Returns a new <class>QuickHashIntHash</class>.


id: QuickHashIntHash::loadFromString
type: function
doc:
<comment>Description:</comment>
  This factory method creates a hash from a string
  
  This factory method creates a new hash from a definition in a string. The file format consists of
  32 bit signed integers packed together in the Endianness that the system that the code runs on
  uses. For each element there are two 32 bit signed integers stored. The first of each element is
  the key, and the second is the value belonging to the key.

<comment>Param:</comment>
  <info>string</info>  <strong>$contents</strong>  The string containing a serialized format of the hash.
  <info>int</info>     <strong>$options</strong>   The same options that the class' constructor takes; except that the size option
                     is ignored. It is automatically calculated to be the same as the number of
                     entries in the hash, rounded up to the nearest power of two with a maximum
                     limit of <return>4194304</return>.

<comment>Return:</comment>
  <info>QuickHashIntHash</info>  Returns a new <class>QuickHashIntHash</class>.


id: QuickHashIntHash::saveToFile
type: function
doc:
<comment>Description:</comment>
  This method stores an in-memory hash to disk
  
  This method stores an existing hash to a file on disk, in the same format that
  QuickHashIntHash::loadFromFile can read.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The filename of the file to store the hash in.

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


id: QuickHashIntHash::saveToString
type: function
doc:
<comment>Description:</comment>
  This method returns a serialized version of the hash
  
  This method returns a serialized version of the hash in the same format that
  QuickHashIntHash::loadFromString can read.

<comment>Return:</comment>
  <info>string</info>  This method returns a string containing a serialized format of the hash. Each element is
          stored as a four byte value in the Endianness that the current system uses.


id: QuickHashIntHash::set
type: function
doc:
<comment>Description:</comment>
  This method updates an entry in the hash with a new value, or
    adds a new one if the entry doesn't exist
  
  This method tries to update an entry with a new value. In case the entry did not yet exist, it
  will instead add a new entry. It returns whether the entry was added or update. If there are
  duplicate keys, only the first found element will get an updated value. Use
  <info>QuickHashIntHash::CHECK_FOR_DUPES</info> during hash creation to prevent duplicate keys from being part
  of the hash.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>    The key of the entry to add or update.
  <info>int</info>  <strong>$value</strong>  The new value to set the entry with.

<comment>Return:</comment>
  <info>bool</info>  2 if the entry was found and updated, 1 if the entry was newly added or 0 if there was an
        error.


id: QuickHashIntHash::update
type: function
doc:
<comment>Description:</comment>
  This method updates an entry in the hash with a new value
  
  This method updates an entry with a new value, and returns whether the entry was update. If there
  are duplicate keys, only the first found element will get an updated value. Use
  <info>QuickHashIntHash::CHECK_FOR_DUPES</info> during hash creation to prevent duplicate keys from being part
  of the hash.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>    The key of the entry to update.
  <info>int</info>  <strong>$value</strong>  The new value to update the entry with.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> when the entry was found and updated, and <info>false</info> if the entry was not part of the hash
        already.


id: QuickHashIntSet
type: class
doc:
<comment>Description:</comment>
  This class wraps around a set containing integer numbers.
  
  Sets can also be iterated over with <return>foreach</return> as the Iterator interface is implemented as well. The
  order of which elements are returned in is not guaranteed.


id: QuickHashIntSet::CHECK_FOR_DUPES
type: constant
doc:
<comment>Description:</comment>
  If enabled, adding duplicate elements to a set (through either QuickHashIntSet::add or
  QuickHashIntSet::loadFromFile) will result in those elements to be dropped from the set. This will
  take up extra time, so only used when it is required.


id: QuickHashIntSet::__construct
type: function
doc:
<comment>Description:</comment>
  Creates a new QuickHashIntSet object
  
  This constructor creates a new <class>QuickHashIntSet</class>. The size is the amount of bucket lists to create.
  The more lists there are, the less collisions you will have. Options are also supported.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>     The amount of bucket lists to configure. The number you pass in will be
                 automatically rounded up to the next power of two. It is also automatically limited
                 from <return>4</return> to <return>4194304</return>.
  <info>int</info>  <strong>$options</strong>  The options that you can pass in are: <info>QuickHashIntSet::CHECK_FOR_DUPES</info>, which makes
                 sure no duplicate entries are added to the set;
                 <info>QuickHashIntSet::DO_NOT_USE_ZEND_ALLOC</info> to not use PHP's internal memory manager as
                 well as one of <info>QuickHashIntSet::HASHER_NO_HASH</info>, <info>QuickHashIntSet::HASHER_JENKINS1</info> or
                 <info>QuickHashIntSet::HASHER_JENKINS2</info>. These last three configure which hashing
                 algorithm to use. All options can be combined using bitmasks.

<comment>Return:</comment>
  <info>unknown</info>  Returns a new <class>QuickHashIntSet</class> object.


id: QuickHashIntSet::add
type: function
doc:
<comment>Description:</comment>
  This method adds a new entry to the set
  
  This method adds a new entry to the set, and returns whether the entry was added. Entries are by
  default always added unless <info>QuickHashIntSet::CHECK_FOR_DUPES</info> has been passed when the set was
  created.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>  The key of the entry to add.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> when the entry was added, and <info>false</info> if the entry was not added.


id: QuickHashIntSet::delete
type: function
doc:
<comment>Description:</comment>
  This method deletes an entry from the set
  
  This method deletes an entry from the set, and returns whether the entry was deleted or not.
  Associated memory structures will not be freed immediately, but rather when the set itself is
  freed.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>  The key of the entry to delete.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> when the entry was deleted, and <info>false</info> if the entry was not deleted.


id: QuickHashIntSet::exists
type: function
doc:
<comment>Description:</comment>
  This method checks whether a key is part of the set
  
  This method checks whether an entry with the provided key exists in the set.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>  The key of the entry to check for whether it exists in the set.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> when the entry was found, or <info>false</info> when the entry is not found.


id: QuickHashIntSet::getSize
type: function
doc:
<comment>Description:</comment>
  Returns the number of elements in the set
  
  Returns the number of elements in the set.

<comment>Return:</comment>
  <info>int</info>  The number of elements in the set.


id: QuickHashIntSet::loadFromFile
type: function
doc:
<comment>Description:</comment>
  This factory method creates a set from a file
  
  This factory method creates a new set from a definition file on disk. The file format consists of
  32 bit signed integers packed together in the Endianness that the system that the code runs on
  uses.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The filename of the file to read the set from.
  <info>int</info>     <strong>$size</strong>      The amount of bucket lists to configure. The number you pass in will be
                     automatically rounded up to the next power of two. It is also automatically
                     limited from <return>4</return> to <return>4194304</return>.
  <info>int</info>     <strong>$options</strong>   The same options that the class' constructor takes; except that the size option
                     is ignored. It is automatically calculated to be the same as the number of
                     entries in the set, rounded up to the nearest power of two with a maximum limit
                     of <return>4194304</return>.

<comment>Return:</comment>
  <info>QuickHashIntSet</info>  Returns a new <class>QuickHashIntSet</class>.


id: QuickHashIntSet::loadFromString
type: function
doc:
<comment>Description:</comment>
  This factory method creates a set from a string
  
  This factory method creates a new set from a definition in a string. The file format consists of
  32 bit signed integers packed together in the Endianness that the system that the code runs on
  uses.

<comment>Param:</comment>
  <info>string</info>  <strong>$contents</strong>  The string containing a serialized format of the set.
  <info>int</info>     <strong>$size</strong>      The amount of bucket lists to configure. The number you pass in will be
                     automatically rounded up to the next power of two. It is also automatically
                     limited from <return>4</return> to <return>4194304</return>.
  <info>int</info>     <strong>$options</strong>   The same options that the class' constructor takes; except that the size option
                     is ignored. It is automatically calculated to be the same as the number of
                     entries in the set, rounded up to the nearest power of two automatically
                     limited from <return>64</return> to <return>4194304</return>.

<comment>Return:</comment>
  <info>QuickHashIntSet</info>  Returns a new <class>QuickHashIntSet</class>.


id: QuickHashIntSet::saveToFile
type: function
doc:
<comment>Description:</comment>
  This method stores an in-memory set to disk
  
  This method stores an existing set to a file on disk, in the same format that
  QuickHashIntSet::loadFromFile can read.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The filename of the file to store the hash in.

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


id: QuickHashIntSet::saveToString
type: function
doc:
<comment>Description:</comment>
  This method returns a serialized version of the set
  
  This method returns a serialized version of the set in the same format that
  QuickHashIntSet::loadFromString can read.

<comment>Return:</comment>
  <info>string</info>  This method returns a string containing a serialized format of the set. Each element is
          stored as a four byte value in the Endianness that the current system uses.


id: QuickHashIntStringHash
type: class
doc:
<comment>Description:</comment>
  This class wraps around a hash containing integer numbers, where the values are strings. Hashes
  are also available as implementation of the ArrayAccess interface.
  
  Hashes can also be iterated over with <return>foreach</return> as the Iterator interface is implemented as well.
  The order of which elements are returned in is not guaranteed.


id: QuickHashIntStringHash::CHECK_FOR_DUPES
type: constant
doc:
<comment>Description:</comment>
  If enabled, adding duplicate elements to a set (through either QuickHashIntStringHash::add or
  QuickHashIntStringHash::loadFromFile) will result in those elements to be dropped from the set.
  This will take up extra time, so only used when it is required.


id: QuickHashIntStringHash::__construct
type: function
doc:
<comment>Description:</comment>
  Creates a new QuickHashIntStringHash object
  
  This constructor creates a new <class>QuickHashIntStringHash</class>. The size is the amount of bucket lists to
  create. The more lists there are, the less collisions you will have. Options are also supported.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>     The amount of bucket lists to configure. The number you pass in will be
                 automatically rounded up to the next power of two. It is also automatically limited
                 from <return>64</return> to <return>4194304</return>.
  <info>int</info>  <strong>$options</strong>  The options that you can pass in are: <info>QuickHashIntStringHash::CHECK_FOR_DUPES</info>,
                 which makes sure no duplicate entries are added to the hash;
                 <info>QuickHashIntStringHash::DO_NOT_USE_ZEND_ALLOC</info> to not use PHP's internal memory
                 manager as well as one of <info>QuickHashIntStringHash::HASHER_NO_HASH</info>,
                 <info>QuickHashIntStringHash::HASHER_JENKINS1</info> or <info>QuickHashIntStringHash::HASHER_JENKINS2</info>.
                 These last three configure which hashing algorithm to use. All options can be
                 combined using bitmasks.

<comment>Return:</comment>
  <info>unknown</info>  Returns a new <class>QuickHashIntStringHash</class> object.


id: QuickHashIntStringHash::add
type: function
doc:
<comment>Description:</comment>
  This method adds a new entry to the hash
  
  This method adds a new entry to the hash, and returns whether the entry was added. Entries are by
  default always added unless <info>QuickHashIntStringHash::CHECK_FOR_DUPES</info> has been passed when the hash
  was created.

<comment>Param:</comment>
  <info>int</info>     <strong>$key</strong>    The key of the entry to add.
  <info>string</info>  <strong>$value</strong>  The value of the entry to add. If a non-string is passed, it will be converted to
                  a string automatically if possible.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> when the entry was added, and <info>false</info> if the entry was not added.


id: QuickHashIntStringHash::get
type: function
doc:
<comment>Description:</comment>
  This method retrieves a value from the hash by its key
  
  This method retrieves a value from the hash by its key.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>  The key of the entry to retrieve.

<comment>Return:</comment>
  <info>mixed</info>  The value if the key exists, or <info>null</info> if the key wasn't part of the hash.


id: QuickHashIntStringHash::loadFromFile
type: function
doc:
<comment>Description:</comment>
  This factory method creates a hash from a file
  
  This factory method creates a new hash from a definition file on disk. The file format consists of
  a signature <return>'QH\0x12\0'</return>, the number of elements as a 32 bit signed integer in system Endianness,
  an unsigned 32 bit integer containing the number of element data to follow in characters. This
  element data contains all the strings. After the header and the strings, the elements follow in
  pairs of two unsigned 32 bit integers where the first one is the key, and the second one the index
  in the element data string. An example could be:
  
  QuickHash IntString file format
  
  QuickHash IntString file format

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The filename of the file to read the hash from.
  <info>int</info>     <strong>$size</strong>      The amount of bucket lists to configure. The number you pass in will be
                     automatically rounded up to the next power of two. It is also automatically
                     limited from <return>4</return> to <return>4194304</return>.
  <info>int</info>     <strong>$options</strong>   The same options that the class' constructor takes; except that the size option
                     is ignored. It is automatically calculated to be the same as the number of
                     entries in the hash, rounded up to the nearest power of two with a maximum
                     limit of <return>4194304</return>.

<comment>Return:</comment>
  <info>QuickHashIntStringHash</info>  Returns a new <class>QuickHashIntStringHash</class>.


id: QuickHashIntStringHash::loadFromString
type: function
doc:
<comment>Description:</comment>
  This factory method creates a hash from a string
  
  This factory method creates a new hash from a definition in a string. The format is the same as
  the one used in "loadFromFile".

<comment>Param:</comment>
  <info>string</info>  <strong>$contents</strong>  The string containing a serialized format of the hash.
  <info>int</info>     <strong>$size</strong>      The amount of bucket lists to configure. The number you pass in will be
                     automatically rounded up to the next power of two. It is also automatically
                     limited from 4 to 4194304.
  <info>int</info>     <strong>$options</strong>   The same options that the class' constructor takes; except that the size option
                     is ignored. It is automatically calculated to be the same as the number of
                     entries in the hash, rounded up to the nearest power of two with a maximum
                     limit of 4194304.

<comment>Return:</comment>
  <info>QuickHashIntStringHash</info>  Returns a new QuickHashIntStringHash.


id: QuickHashIntStringHash::saveToFile
type: function
doc:
<comment>Description:</comment>
  This method stores an in-memory hash to disk
  
  This method stores an existing hash to a file on disk, in the same format that loadFromFile() can
  read.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The filename of the file to store the hash in.

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


id: QuickHashIntStringHash::saveToString
type: function
doc:
<comment>Description:</comment>
  This method returns a serialized version of the hash
  
  This method returns a serialized version of the hash in the same format that
  QuickHashIntStringHash::loadFromString can read.

<comment>Return:</comment>
  <info>string</info>  This method returns a string containing a serialized format of the hash. Each element is
          stored as a four byte value in the Endianness that the current system uses.


id: QuickHashIntStringHash::set
type: function
doc:
<comment>Description:</comment>
  This method updates an entry in the hash with a new value, or
    adds a new one if the entry doesn't exist
  
  This method tries to update an entry with a new value. In case the entry did not yet exist, it
  will instead add a new entry. It returns whether the entry was added or update. If there are
  duplicate keys, only the first found element will get an updated value. Use
  QuickHashIntStringHash::CHECK_FOR_DUPES during hash creation to prevent duplicate keys from being
  part of the hash.

<comment>Param:</comment>
  <info>int</info>     <strong>$key</strong>    The key of the entry to add or update.
  <info>string</info>  <strong>$value</strong>  The value of the entry to add. If a non-string is passed, it will be converted to
                  a string automatically if possible.

<comment>Return:</comment>
  <info>int</info>  2 if the entry was found and updated, 1 if the entry was newly added or 0 if there was an
       error.


id: QuickHashIntStringHash::update
type: function
doc:
<comment>Description:</comment>
  This method updates an entry in the hash with a new value
  
  This method updates an entry with a new value, and returns whether the entry was update. If there
  are duplicate keys, only the first found element will get an updated value. Use
  QuickHashIntStringHash::CHECK_FOR_DUPES during hash creation to prevent duplicate keys from being
  part of the hash.

<comment>Param:</comment>
  <info>int</info>     <strong>$key</strong>    The key of the entry to update.
  <info>string</info>  <strong>$value</strong>  The new value for the entry. If a non-string is passed, it will be converted to a
                  string automatically if possible.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> when the entry was found and updated, and <info>false</info> if the entry was not part of the hash
        already.


id: QuickHashStringIntHash
type: class
doc:
<comment>Description:</comment>
  This class wraps around a hash containing strings, where the values are integer numbers. Hashes
  are also available as implementation of the ArrayAccess interface.
  
  Hashes can also be iterated over with <return>foreach</return> as the Iterator interface is implemented as well.
  The order of which elements are returned in is not guaranteed.


id: QuickHashStringIntHash::CHECK_FOR_DUPES
type: constant
doc:
<comment>Description:</comment>
  If enabled, adding duplicate elements to a set (through either QuickHashStringIntHash::add or
  QuickHashStringIntHash::loadFromFile) will result in those elements to be dropped from the set.
  This will take up extra time, so only used when it is required.


id: QuickHashStringIntHash::__construct
type: function
doc:
<comment>Description:</comment>
  Creates a new QuickHashStringIntHash object
  
  This constructor creates a new <class>QuickHashStringIntHash</class>. The size is the amount of bucket lists to
  create. The more lists there are, the less collisions you will have. Options are also supported.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>     The amount of bucket lists to configure. The number you pass in will be
                 automatically rounded up to the next power of two. It is also automatically limited
                 from <return>64</return> to <return>4194304</return>.
  <info>int</info>  <strong>$options</strong>  The options that you can pass in are: <info>QuickHashStringIntHash::CHECK_FOR_DUPES</info>,
                 which makes sure no duplicate entries are added to the hash and
                 <info>QuickHashStringIntHash::DO_NOT_USE_ZEND_ALLOC</info> to not use PHP's internal memory
                 manager.

<comment>Return:</comment>
  <info>unknown</info>  Returns a new <class>QuickHashStringIntHash</class> object.


id: QuickHashStringIntHash::add
type: function
doc:
<comment>Description:</comment>
  This method adds a new entry to the hash
  
  This method adds a new entry to the hash, and returns whether the entry was added. Entries are by
  default always added unless <info>QuickHashStringIntHash::CHECK_FOR_DUPES</info> has been passed when the hash
  was created.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    The key of the entry to add.
  <info>int</info>     <strong>$value</strong>  The value of the entry to add.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> when the entry was added, and <info>false</info> if the entry was not added.


id: QuickHashStringIntHash::delete
type: function
doc:
<comment>Description:</comment>
  This method deletes an entry from the hash
  
  This method deletes an entry from the hash, and returns whether the entry was deleted or not.
  Associated memory structures will not be freed immediately, but rather when the hash itself is
  freed.
  
  Elements can not be deleted when the hash is used in an iterator. The method will not throw an
  exception, but simply return <info>false</info> like would happen with any other deletion failure.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  The key of the entry to delete.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> when the entry was deleted, and <info>false</info> if the entry was not deleted.


id: QuickHashStringIntHash::exists
type: function
doc:
<comment>Description:</comment>
  This method checks whether a key is part of the hash
  
  This method checks whether an entry with the provided key exists in the hash.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  The key of the entry to check for whether it exists in the hash.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> when the entry was found, or <info>false</info> when the entry is not found.


id: QuickHashStringIntHash::get
type: function
doc:
<comment>Description:</comment>
  This method retrieves a value from the hash by its key
  
  This method retrieves a value from the hash by its key.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  The key of the entry to retrieve.

<comment>Return:</comment>
  <info>mixed</info>  The value if the key exists, or <info>null</info> if the key wasn't part of the hash.


id: QuickHashStringIntHash::loadFromFile
type: function
doc:
<comment>Description:</comment>
  This factory method creates a hash from a file
  
  This factory method creates a new hash from a definition file on disk. The file format consists of
  a signature <return>'QH\0x21\0'</return>, the number of elements as a 32 bit signed integer in system Endianness,
  an unsigned 32 bit integer containing the number of element data to follow in characters. This
  element data contains all the strings. The follows another signed 32 bit integer containing the
  number of bucket lists.  After the header and the strings, the elements follow. They are ordered
  by bucket list so that the keys don't have to be hashed in order to restore the hash. For each
  bucket list, the following information is stored (all as 32 bit integers): the bucket list index,
  the number of elements in that list, and then in pairs of two unsigned 32 bit integers the
  elements, where the first one is the index into the string list containing the keys, and the
  second one the value.  An example could be:
  
  QuickHash StringIntHash file format
  
  QuickHash IntHash file format

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The filename of the file to read the hash from.
  <info>int</info>     <strong>$size</strong>      The amount of bucket lists to configure. The number you pass in will be
                     automatically rounded up to the next power of two. It is also automatically
                     limited from <return>4</return> to <return>4194304</return>.
  <info>int</info>     <strong>$options</strong>   The same options that the class' constructor takes; except that the size option
                     is ignored. It is read from the file format (unlike the <class>QuickHashIntHash</class> and
                     <class>QuickHashIntStringHash</class> classes, where it is automatically calculated from the
                     number of entries in the hash.)

<comment>Return:</comment>
  <info>QuickHashStringIntHash</info>  Returns a new <class>QuickHashStringIntHash</class>.


id: QuickHashStringIntHash::loadFromString
type: function
doc:
<comment>Description:</comment>
  This factory method creates a hash from a string
  
  This factory method creates a new hash from a definition in a string. The format is the same as
  the one used in "loadFromFile".

<comment>Param:</comment>
  <info>string</info>  <strong>$contents</strong>  The string containing a serialized format of the hash.
  <info>int</info>     <strong>$size</strong>      The amount of bucket lists to configure. The number you pass in will be
                     automatically rounded up to the next power of two. It is also automatically
                     limited from 4 to 4194304.
  <info>int</info>     <strong>$options</strong>   The same options that the class' constructor takes; except that the size option
                     is ignored. It is automatically calculated to be the same as the number of
                     entries in the hash, rounded up to the nearest power of two with a maximum
                     limit of 4194304.

<comment>Return:</comment>
  <info>QuickHashStringIntHash</info>  Returns a new QuickHashStringIntHash.


id: QuickHashStringIntHash::saveToString
type: function
doc:
<comment>Description:</comment>
  This method returns a serialized version of the hash
  
  This method returns a serialized version of the hash in the same format that
  QuickHashStringIntHash::loadFromString can read.

<comment>Return:</comment>
  <info>string</info>  This method returns a serialized format of an existing hash, in the same format that
          QuickHashStringIntHash::loadFromString can read.


id: QuickHashStringIntHash::set
type: function
doc:
<comment>Description:</comment>
  This method updates an entry in the hash with a new value, or
    adds a new one if the entry doesn't exist
  
  This method tries to update an entry with a new value. In case the entry did not yet exist, it
  will instead add a new entry. It returns whether the entry was added or update. If there are
  duplicate keys, only the first found element will get an updated value. Use
  QuickHashStringIntHash::CHECK_FOR_DUPES during hash creation to prevent duplicate keys from being
  part of the hash.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    The key of the entry to add or update.
  <info>int</info>     <strong>$value</strong>  The value of the entry to add. If a non-string is passed, it will be converted to
                  a string automatically if possible.

<comment>Return:</comment>
  <info>int</info>  2 if the entry was found and updated, 1 if the entry was newly added or 0 if there was an
       error.


id: QuickHashStringIntHash::update
type: function
doc:
<comment>Description:</comment>
  This method updates an entry in the hash with a new value
  
  This method updates an entry with a new value, and returns whether the entry was update. If there
  are duplicate keys, only the first found element will get an updated value. Use
  QuickHashStringIntHash::CHECK_FOR_DUPES during hash creation to prevent duplicate keys from being
  part of the hash.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    The key of the entry to update.
  <info>int</info>     <strong>$value</strong>  The new value for the entry. If a non-string is passed, it will be converted to a
                  string automatically if possible.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> when the entry was found and updated, and <info>false</info> if the entry was not part of the hash
        already.


id: RADIUS_ACCESS_ACCEPT
type: constant
doc:
<comment>Description:</comment>
  An Access-Accept response to an Access-Request indicating that the RADIUS server authenticated the
  user successfully.


id: RADIUS_ACCESS_CHALLENGE
type: constant
doc:
<comment>Description:</comment>
  An Access-Challenge response to an Access-Request indicating that the RADIUS server requires
  further information in another Access-Request before authenticating the user.


id: RADIUS_ACCESS_REJECT
type: constant
doc:
<comment>Description:</comment>
  An Access-Reject response to an Access-Request indicating that the RADIUS server could not
  authenticate the user.


id: RADIUS_ACCESS_REQUEST
type: constant
doc:
<comment>Description:</comment>
  An Access-Request, used to authenticate a user against a RADIUS server. Access request packets
  must include a <info>RADIUS_NAS_IP_ADDRESS</info> or a <info>RADIUS_NAS_IDENTIFIER</info> attribute, must also include a
  <info>RADIUS_USER_PASSWORD</info>, <info>RADIUS_CHAP_PASSWORD</info> or a <info>RADIUS_STATE</info> attribute, and should include a
  <info>RADIUS_USER_NAME</info> attribute.


id: RADIUS_ACCOUNTING_REQUEST
type: constant
doc:
<comment>Description:</comment>
  An Accounting-Request, used to convey accounting information for a service to the RADIUS server.


id: RADIUS_ACCT_AUTHENTIC
type: constant
doc:
<comment>Description:</comment>
  Accounting authentic, one of: <info>RADIUS_AUTH_RADIUS</info><info>RADIUS_AUTH_LOCAL</info><info>RADIUS_AUTH_REMOTE</info>


id: RADIUS_ACCT_STATUS_TYPE
type: constant
doc:
<comment>Description:</comment>
  Accounting status type, one of: <info>RADIUS_START</info><info>RADIUS_STOP</info><info>RADIUS_ACCOUNTING_ON</info><info>RADIUS_ACCOUNTING_OFF</info>


id: RADIUS_ACCT_TERMINATE_CAUSE
type: constant
doc:
<comment>Description:</comment>
  Accounting terminate cause, one of:
  <info>RADIUS_TERM_USER_REQUEST</info><info>RADIUS_TERM_LOST_CARRIER</info><info>RADIUS_TERM_LOST_SERVICE</info><info>RADIUS_TERM_IDLE_TIMEOUT</info><info>RADIUS_TERM_SESSION_TIMEOUT</info><info>RADIUS_TERM_ADMIN_RESET</info><info>RADIUS_TERM_ADMIN_REBOOT</info><info>RADIUS_TERM_PORT_ERROR</info><info>RADIUS_TERM_NAS_ERROR</info><info>RADIUS_TERM_NAS_REQUEST</info><info>RADIUS_TERM_NAS_REBOOT</info><info>RADIUS_TERM_PORT_UNNEEDED</info><info>RADIUS_TERM_PORT_PREEMPTED</info><info>RADIUS_TERM_PORT_SUSPENDED</info><info>RADIUS_TERM_SERVICE_UNAVAILABLE</info><info>RADIUS_TERM_CALLBACK</info><info>RADIUS_TERM_USER_ERROR</info><info>RADIUS_TERM_HOST_REQUEST</info>


id: RADIUS_CALLBACK_ID
type: constant
doc:
<comment>Description:</comment>
  The Callback-Id attribute. The attribute value is a <info>string</info> containing an implementation-specific
  name of the place to be called.


id: RADIUS_CALLBACK_NUMBER
type: constant
doc:
<comment>Description:</comment>
  The Callback-Number attribute. The attribute value is a <info>string</info> containing the dialing string to
  use for callback.


id: RADIUS_CHAP_PASSWORD
type: constant
doc:
<comment>Description:</comment>
  The Chap-Password attribute. The attribute value is expected to be a <info>string</info> with the first byte
  containing the CHAP identifier, and the subsequent 16 bytes containing the MD5 hash of the CHAP
  identifier, the plaintext password and the CHAP challenge value concatenated together. Note that
  the CHAP challenge value should also be sent separately in a <info>RADIUS_CHAP_CHALLENGE</info> attribute.
  
  Using CHAP passwords


id: RADIUS_CLASS
type: constant
doc:
<comment>Description:</comment>
  The Class attribute. The attribute value is an arbitrary <info>string</info> included in an Access-Accept
  message that should then be sent to the accounting server in Accounting-Request messages, and can
  be set using <strong>radius_put_attr()</strong>.


id: RADIUS_COA_ACK
type: constant
doc:
<comment>Description:</comment>
  A CoA-ACK, sent to the RADIUS server to indicate that the user authorisations have been updated.
  
  This constant is available in PECL radius 1.3.0 and later.


id: RADIUS_COA_NAK
type: constant
doc:
<comment>Description:</comment>
  A CoA-NAK, sent to the RADIUS server to indicate that the user authorisations could not be
  updated.
  
  This constant is available in PECL radius 1.3.0 and later.


id: RADIUS_COA_REQUEST
type: constant
doc:
<comment>Description:</comment>
  A CoA-Request, sent from the RADIUS server to indicate that the authorisations within the user
  session have changed. A response must be sent in the form of a CoA-ACK or a CoA-NAK.
  
  This constant is available in PECL radius 1.3.0 and later.


id: RADIUS_DISCONNECT_ACK
type: constant
doc:
<comment>Description:</comment>
  A Disconnect-ACK, sent to the RADIUS server to indicate that the user session has been terminated.
  
  This constant is available in PECL radius 1.3.0 and later.


