Verzeichnisstruktur phpBB-3.2.0


Veröffentlicht
06.01.2017

So funktioniert es


Auf das letzte Element klicken. Dies geht jeweils ein Schritt zurück

Auf das Icon klicken, dies öffnet das Verzeichnis. Nochmal klicken schließt das Verzeichnis.
Auf den Verzeichnisnamen klicken, dies zeigt nur das Verzeichnis mit Inhalt an

      (Beispiel Datei-Icons)

Auf das Icon klicken um den Quellcode anzuzeigen

ResponseInterface.php

Zuletzt modifiziert: 09.10.2024, 12:57 - Dateigröße: 3.91 KiB


 001  <?php
 002  namespace GuzzleHttp\Message;
 003   
 004  /**
 005   * Represents an HTTP response message.
 006   */
 007  interface ResponseInterface extends MessageInterface
 008  {
 009      /**
 010       * Gets the response Status-Code.
 011       *
 012       * The Status-Code is a 3-digit integer result code of the server's attempt
 013       * to understand and satisfy the request.
 014       *
 015       * @return int Status code.
 016       */
 017      public function getStatusCode();
 018   
 019      /**
 020       * Sets the status code of this response.
 021       *
 022       * @param int $code The 3-digit integer result code to set.
 023       */
 024      public function setStatusCode($code);
 025   
 026      /**
 027       * Gets the response Reason-Phrase, a short textual description of the
 028       * Status-Code.
 029       *
 030       * Because a Reason-Phrase is not a required element in response
 031       * Status-Line, the Reason-Phrase value MAY be null. Implementations MAY
 032       * choose to return the default RFC 2616 recommended reason phrase for the
 033       * response's Status-Code.
 034       *
 035       * @return string|null Reason phrase, or null if unknown.
 036       */
 037      public function getReasonPhrase();
 038   
 039      /**
 040       * Sets the Reason-Phrase of the response.
 041       *
 042       * If no Reason-Phrase is specified, implementations MAY choose to default
 043       * to the RFC 2616 recommended reason phrase for the response's Status-Code.
 044       *
 045       * @param string $phrase The Reason-Phrase to set.
 046       */
 047      public function setReasonPhrase($phrase);
 048   
 049      /**
 050       * Get the effective URL that resulted in this response (e.g. the last
 051       * redirect URL).
 052       *
 053       * @return string
 054       */
 055      public function getEffectiveUrl();
 056   
 057      /**
 058       * Set the effective URL that resulted in this response (e.g. the last
 059       * redirect URL).
 060       *
 061       * @param string $url Effective URL
 062       */
 063      public function setEffectiveUrl($url);
 064   
 065      /**
 066       * Parse the JSON response body and return the JSON decoded data.
 067       *
 068       * @param array $config Associative array of configuration settings used
 069       *     to control how the JSON data is parsed. Concrete implementations MAY
 070       *     add further configuration settings as needed, but they MUST implement
 071       *     functionality for the following options:
 072       *
 073       *     - object: Set to true to parse JSON objects as PHP objects rather
 074       *       than associative arrays. Defaults to false.
 075       *     - big_int_strings: When set to true, large integers are converted to
 076       *       strings rather than floats. Defaults to false.
 077       *
 078       *     Implementations are free to add further configuration settings as
 079       *     needed.
 080       *
 081       * @return mixed Returns the JSON decoded data based on the provided
 082       *     parse settings.
 083       * @throws \RuntimeException if the response body is not in JSON format
 084       */
 085      public function json(array $config = []);
 086   
 087      /**
 088       * Parse the XML response body and return a \SimpleXMLElement.
 089       *
 090       * In order to prevent XXE attacks, this method disables loading external
 091       * entities. If you rely on external entities, then you must parse the
 092       * XML response manually by accessing the response body directly.
 093       *
 094       * @param array $config Associative array of configuration settings used
 095       *     to control how the XML is parsed. Concrete implementations MAY add
 096       *     further configuration settings as needed, but they MUST implement
 097       *     functionality for the following options:
 098       *
 099       *     - ns: Set to a string to represent the namespace prefix or URI
 100       *     - ns_is_prefix: Set to true to specify that the NS is a prefix rather
 101       *       than a URI (defaults to false).
 102       *     - libxml_options: Bitwise OR of the libxml option constants
 103       *       listed at http://php.net/manual/en/libxml.constants.php
 104       *       (defaults to LIBXML_NONET)
 105       *
 106       * @return \SimpleXMLElement
 107       * @throws \RuntimeException if the response body is not in XML format
 108       * @link http://websec.io/2012/08/27/Preventing-XXE-in-PHP.html
 109       */
 110      public function xml(array $config = []);
 111  }
 112