---
title: "Phalcon Http"
version: "5.23"
---
> Documentation Index
> Fetch the complete documentation index at: https://docs.phalcon.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Phalcon Http
:::info[NOTE]
All classes are prefixed with `Phalcon`
:::
## Http\Cookie
Class
Provide OO wrappers to manage a HTTP cookie.
- `\stdClass`
- [`Phalcon\Di\AbstractInjectionAware`](/5.23/api/phalcon_di/#diabstractinjectionaware)
- **`Phalcon\Http\Cookie`** - implements [`Phalcon\Http\Cookie\CookieInterface`](#httpcookiecookieinterface), `\Stringable`
`Phalcon\Contracts\Http\HttpTypes` · `Phalcon\Di\AbstractInjectionAware` · `Phalcon\Di\DiInterface` · `Phalcon\Encryption\Crypt\CryptInterface` · `Phalcon\Filter\FilterInterface` · `Phalcon\Http\Cookie\CookieInterface` · `Phalcon\Http\Cookie\Exception` · `Phalcon\Http\Cookie\Exceptions\CookieKeyTooShort` · `Phalcon\Http\Cookie\Exceptions\CryptInterfaceRequired` · `Phalcon\Http\Cookie\Exceptions\CryptServiceUnavailable` · `Phalcon\Http\Cookie\Exceptions\FilterServiceUnavailable` · `Phalcon\Http\Response\Exception` · `Phalcon\Http\Traits\EncryptionAwareTrait` · `Phalcon\Session\ManagerInterface` · `Phalcon\Traits\Support\Helper\Arr\GetTrait` · `Stringable`
### Method Summary
- `public __construct(string $name, mixed $value = null, int $expire = 0, string $path = "/", bool $secure = false, string $domain = "", bool $httpOnly = false, array $options = [])` — Phalcon\Http\Cookie constructor.
- `public __toString(): string` — Magic \_\_toString method converts the cookie's value to string
- `public delete(): void` — Deletes the cookie by setting an expiration time in the past
- `public getDomain(): string` — Returns the domain that the cookie is available to
- `public getExpiration(): int` — Returns the current expiration time
- `public getHttpOnly(): bool` — Returns if the cookie is accessible only through the HTTP protocol
- `public getName(): string` — Returns the current cookie's name
- `public getOptions(): array` — Returns the current cookie's options
- `public getPath(): string` — Returns the current cookie's path
- `public getSecure(): bool` — Returns whether the cookie must only be sent when the connection is
- `public getValue(mixed $filters = null, mixed $defaultValue = null): mixed` — Returns the cookie's value.
- `public restore(): CookieInterface` — Reads the cookie-related info from the SESSION to restore the cookie as
- `public send(): CookieInterface` — Sends the cookie to the HTTP client.
- `public setDomain(string $domain): CookieInterface` — Sets the domain that the cookie is available to
- `public setExpiration(int $expire): CookieInterface` — Sets the cookie's expiration time
- `public setHttpOnly(bool $httpOnly): CookieInterface` — Sets if the cookie is accessible only through the HTTP protocol
- `public setOptions(array $options): CookieInterface` — Sets the cookie's options
- `public setPath(string $path): CookieInterface` — Sets the cookie's path
- `public setSecure(bool $secure): CookieInterface` — Sets if the cookie must only be sent when the connection is secure
- `public setSignKey(string|null $signKey = null): CookieInterface` — Sets the cookie's sign key.
- `public setValue(mixed $value): CookieInterface` — Sets the cookie's value
- `public useEncryption(bool $useEncryption): CookieInterface` — Sets if the cookie must be encrypted/decrypted automatically
- `protected assertSignKeyIsLongEnough(string $signKey): void` — Assert the cookie's key is enough long.
### Properties
- `protected string $domain = ""`
- `protected int $expire = 0`
- `protected FilterInterface|null $filter = null`
- `protected bool $httpOnly = false`
- `protected bool $isRead = false`
- `protected bool $isRestored = false`
- `protected string $name`
- `protected array $options = []`
- `protected string $path = "/"`
- `protected bool $secure = false`
- `protected string|null $signKey = null` — The cookie's sign key.
- `protected mixed $value = null`
### Methods
__construct()
```php
public function __construct(
string $name,
mixed $value = null,
int $expire = 0,
string $path = "/",
bool $secure = false,
string $domain = "",
bool $httpOnly = false,
array $options = []
);
```
Phalcon\Http\Cookie constructor.
__toString()
```php
public function __toString(): string;
```
Magic __toString method converts the cookie's value to string
delete()
```php
public function delete(): void;
```
Deletes the cookie by setting an expiration time in the past
getDomain()
```php
public function getDomain(): string;
```
Returns the domain that the cookie is available to
getExpiration()
```php
public function getExpiration(): int;
```
Returns the current expiration time
getHttpOnly()
```php
public function getHttpOnly(): bool;
```
Returns if the cookie is accessible only through the HTTP protocol
getName()
```php
public function getName(): string;
```
Returns the current cookie's name
getOptions()
```php
public function getOptions(): array;
```
Returns the current cookie's options
getPath()
```php
public function getPath(): string;
```
Returns the current cookie's path
getSecure()
```php
public function getSecure(): bool;
```
Returns whether the cookie must only be sent when the connection is
secure (HTTPS)
getValue()
```php
public function getValue(
mixed $filters = null,
mixed $defaultValue = null
): mixed;
```
Returns the cookie's value.
@todo filters needs to be array/string
restore()
```php
public function restore(): CookieInterface;
```
Reads the cookie-related info from the SESSION to restore the cookie as
it was set.
This method is automatically called internally so normally you don't
need to call it.
send()
```php
public function send(): CookieInterface;
```
Sends the cookie to the HTTP client.
Stores the cookie definition in session.
setDomain()
```php
public function setDomain( string $domain ): CookieInterface;
```
Sets the domain that the cookie is available to
setExpiration()
```php
public function setExpiration( int $expire ): CookieInterface;
```
Sets the cookie's expiration time
setHttpOnly()
```php
public function setHttpOnly( bool $httpOnly ): CookieInterface;
```
Sets if the cookie is accessible only through the HTTP protocol
setOptions()
```php
public function setOptions( array $options ): CookieInterface;
```
Sets the cookie's options
setPath()
```php
public function setPath( string $path ): CookieInterface;
```
Sets the cookie's path
setSecure()
```php
public function setSecure( bool $secure ): CookieInterface;
```
Sets if the cookie must only be sent when the connection is secure
(HTTPS)
setSignKey()
```php
public function setSignKey( string|null $signKey = null ): CookieInterface;
```
Sets the cookie's sign key.
The `$signKey' MUST be at least 32 characters long
and generated using a cryptographically secure pseudo random generator.
Use NULL to disable cookie signing.
@see \Phalcon\Encryption\Security\Random
setValue()
```php
public function setValue( mixed $value ): CookieInterface;
```
Sets the cookie's value
useEncryption()
```php
public function useEncryption( bool $useEncryption ): CookieInterface;
```
Sets if the cookie must be encrypted/decrypted automatically
assertSignKeyIsLongEnough()
```php
protected function assertSignKeyIsLongEnough( string $signKey ): void;
```
Assert the cookie's key is enough long.
## Http\Cookie\CookieInterface
Interface
Interface for Phalcon\Http\Cookie
- **`Phalcon\Http\Cookie\CookieInterface`**
`Phalcon\Contracts\Http\HttpTypes`
### Method Summary
- `public delete(): void` — Deletes the cookie
- `public getDomain(): string` — Returns the domain that the cookie is available to
- `public getExpiration(): int` — Returns the current expiration time
- `public getHttpOnly(): bool` — Returns if the cookie is accessible only through the HTTP protocol
- `public getName(): string` — Returns the current cookie's name
- `public getOptions(): array` — Returns the current cookie's options
- `public getPath(): string` — Returns the current cookie's path
- `public getSecure(): bool` — Returns whether the cookie must only be sent when the connection is
- `public getValue(mixed $filters = null, mixed $defaultValue = null): mixed` — Returns the cookie's value.
- `public isUsingEncryption(): bool` — Check if the cookie is using implicit encryption
- `public send(): CookieInterface` — Sends the cookie to the HTTP client
- `public setDomain(string $domain): CookieInterface` — Sets the domain that the cookie is available to
- `public setExpiration(int $expire): CookieInterface` — Sets the cookie's expiration time
- `public setHttpOnly(bool $httpOnly): CookieInterface` — Sets if the cookie is accessible only through the HTTP protocol
- `public setOptions(array $options): CookieInterface` — Sets the cookie's options
- `public setPath(string $path): CookieInterface` — Sets the cookie's expiration time
- `public setSecure(bool $secure): CookieInterface` — Sets if the cookie must only be sent when the connection is secure
- `public setValue(mixed $value): CookieInterface` — Sets the cookie's value
- `public useEncryption(bool $useEncryption): CookieInterface` — Sets if the cookie must be encrypted/decrypted automatically
### Methods
delete()
```php
public function delete(): void;
```
Deletes the cookie
getDomain()
```php
public function getDomain(): string;
```
Returns the domain that the cookie is available to
getExpiration()
```php
public function getExpiration(): int;
```
Returns the current expiration time
getHttpOnly()
```php
public function getHttpOnly(): bool;
```
Returns if the cookie is accessible only through the HTTP protocol
getName()
```php
public function getName(): string;
```
Returns the current cookie's name
getOptions()
```php
public function getOptions(): array;
```
Returns the current cookie's options
getPath()
```php
public function getPath(): string;
```
Returns the current cookie's path
getSecure()
```php
public function getSecure(): bool;
```
Returns whether the cookie must only be sent when the connection is
secure (HTTPS)
getValue()
```php
public function getValue(
mixed $filters = null,
mixed $defaultValue = null
): mixed;
```
Returns the cookie's value.
@todo check if $filters can be more type specific
isUsingEncryption()
```php
public function isUsingEncryption(): bool;
```
Check if the cookie is using implicit encryption
send()
```php
public function send(): CookieInterface;
```
Sends the cookie to the HTTP client
setDomain()
```php
public function setDomain( string $domain ): CookieInterface;
```
Sets the domain that the cookie is available to
setExpiration()
```php
public function setExpiration( int $expire ): CookieInterface;
```
Sets the cookie's expiration time
setHttpOnly()
```php
public function setHttpOnly( bool $httpOnly ): CookieInterface;
```
Sets if the cookie is accessible only through the HTTP protocol
setOptions()
```php
public function setOptions( array $options ): CookieInterface;
```
Sets the cookie's options
setPath()
```php
public function setPath( string $path ): CookieInterface;
```
Sets the cookie's expiration time
setSecure()
```php
public function setSecure( bool $secure ): CookieInterface;
```
Sets if the cookie must only be sent when the connection is secure
(HTTPS)
setValue()
```php
public function setValue( mixed $value ): CookieInterface;
```
Sets the cookie's value
@todo check if we can make this a string
useEncryption()
```php
public function useEncryption( bool $useEncryption ): CookieInterface;
```
Sets if the cookie must be encrypted/decrypted automatically
## Http\Cookie\Exception
Class
Phalcon\Http\Cookie\Exception
Exceptions thrown in Phalcon\Http\Cookie will use this class.
- `\Exception`
- **`Phalcon\Http\Cookie\Exception`**
- [`Phalcon\Http\Cookie\Exceptions\CookieKeyTooShort`](#httpcookieexceptionscookiekeytooshort)
- [`Phalcon\Http\Cookie\Exceptions\CryptInterfaceRequired`](#httpcookieexceptionscryptinterfacerequired)
- [`Phalcon\Http\Cookie\Exceptions\CryptServiceUnavailable`](#httpcookieexceptionscryptserviceunavailable)
- [`Phalcon\Http\Cookie\Exceptions\FilterServiceUnavailable`](#httpcookieexceptionsfilterserviceunavailable)
## Http\Cookie\Exceptions\CookieKeyTooShort
Class
- `\Exception`
- [`Phalcon\Http\Cookie\Exception`](#httpcookieexception)
- **`Phalcon\Http\Cookie\Exceptions\CookieKeyTooShort`**
`Phalcon\Http\Cookie\Exception`
### Method Summary
- `public __construct(int $length)`
### Methods
__construct()
```php
public function __construct( int $length );
```
## Http\Cookie\Exceptions\CryptInterfaceRequired
Class
- `\Exception`
- [`Phalcon\Http\Cookie\Exception`](#httpcookieexception)
- **`Phalcon\Http\Cookie\Exceptions\CryptInterfaceRequired`**
`Phalcon\Http\Cookie\Exception`
### Method Summary
- `public __construct()`
### Methods
__construct()
```php
public function __construct();
```
## Http\Cookie\Exceptions\CryptServiceUnavailable
Class
- `\Exception`
- [`Phalcon\Http\Cookie\Exception`](#httpcookieexception)
- **`Phalcon\Http\Cookie\Exceptions\CryptServiceUnavailable`**
`Phalcon\Http\Cookie\Exception`
### Method Summary
- `public __construct()`
### Methods
__construct()
```php
public function __construct();
```
## Http\Cookie\Exceptions\FilterServiceUnavailable
Class
- `\Exception`
- [`Phalcon\Http\Cookie\Exception`](#httpcookieexception)
- **`Phalcon\Http\Cookie\Exceptions\FilterServiceUnavailable`**
`Phalcon\Http\Cookie\Exception`
### Method Summary
- `public __construct()`
### Methods
__construct()
```php
public function __construct();
```
## Http\Message\RequestMethodInterface
Interface
Interface for Request methods
Implementation of this file has been influenced by PHP FIG
@link https://github.com/php-fig/http-message-util/
@license https://github.com/php-fig/http-message-util/blob/master/LICENSE
- **`Phalcon\Http\Message\RequestMethodInterface`**
### Constants
- `const string METHOD_CONNECT = "CONNECT"`
- `const string METHOD_DELETE = "DELETE"`
- `const string METHOD_GET = "GET"`
- `const string METHOD_HEAD = "HEAD"`
- `const string METHOD_OPTIONS = "OPTIONS"`
- `const string METHOD_PATCH = "PATCH"`
- `const string METHOD_POST = "POST"`
- `const string METHOD_PURGE = "PURGE"`
- `const string METHOD_PUT = "PUT"`
- `const string METHOD_TRACE = "TRACE"`
## Http\Message\ResponseStatusCodeInterface
Interface
Interface for Request methods
Implementation of this file has been influenced by PHP FIG
@link https://github.com/php-fig/http-message-util/
@license https://github.com/php-fig/http-message-util/blob/master/LICENSE
Defines constants for common HTTP status code.
@see https://tools.ietf.org/html/rfc2295#section-8.1
@see https://tools.ietf.org/html/rfc2324#section-2.3
@see https://tools.ietf.org/html/rfc2518#section-9.7
@see https://tools.ietf.org/html/rfc2774#section-7
@see https://tools.ietf.org/html/rfc3229#section-10.4
@see https://tools.ietf.org/html/rfc4918#section-11
@see https://tools.ietf.org/html/rfc5842#section-7.1
@see https://tools.ietf.org/html/rfc5842#section-7.2
@see https://tools.ietf.org/html/rfc6585#section-3
@see https://tools.ietf.org/html/rfc6585#section-4
@see https://tools.ietf.org/html/rfc6585#section-5
@see https://tools.ietf.org/html/rfc6585#section-6
@see https://tools.ietf.org/html/rfc7231#section-6
@see https://tools.ietf.org/html/rfc7238#section-3
@see https://tools.ietf.org/html/rfc7725#section-3
@see https://tools.ietf.org/html/rfc7540#section-9.1.2
@see https://tools.ietf.org/html/rfc8297#section-2
@see https://tools.ietf.org/html/rfc8470#section-7
- **`Phalcon\Http\Message\ResponseStatusCodeInterface`**
### Constants
- `const int STATUS_ACCEPTED = 202`
- `const int STATUS_ALREADY_REPORTED = 208`
- `const int STATUS_BAD_GATEWAY = 502`
- `const int STATUS_BAD_REQUEST = 400`
- `const int STATUS_BANDWIDTH_LIMIT_EXCEEDED = 509`
- `const int STATUS_BLOCKED_BY_WINDOWS_PARENTAL_CONTROLS = 450`
- `const int STATUS_CLIENT_CLOSED_REQUEST = 499`
- `const int STATUS_CONFLICT = 409`
- `const int STATUS_CONNECTION_TIMEOUT = 522`
- `const int STATUS_CONTINUE = 100`
- `const int STATUS_CREATED = 201`
- `const int STATUS_EARLY_HINTS = 103`
- `const int STATUS_EXPECTATION_FAILED = 417`
- `const int STATUS_FAILED_DEPENDENCY = 424`
- `const int STATUS_FORBIDDEN = 403`
- `const int STATUS_FOUND = 302`
- `const int STATUS_GATEWAY_TIMEOUT = 504`
- `const int STATUS_GONE = 410`
- `const int STATUS_HTTP_REQUEST_SENT_TO_HTTPS_PORT = 497`
- `const int STATUS_IM_A_TEAPOT = 418`
- `const int STATUS_IM_USED = 226`
- `const int STATUS_INSUFFICIENT_STORAGE = 507`
- `const int STATUS_INTERNAL_SERVER_ERROR = 500`
- `const int STATUS_INVALID_SSL_CERTIFICATE = 526`
- `const int STATUS_INVALID_TOKEN_ESRI = 498`
- `const int STATUS_LENGTH_REQUIRED = 411`
- `const int STATUS_LOCKED = 423`
- `const int STATUS_LOGIN_TIMEOUT = 440`
- `const int STATUS_LOOP_DETECTED = 508`
- `const int STATUS_METHOD_FAILURE = 420`
- `const int STATUS_METHOD_NOT_ALLOWED = 405`
- `const int STATUS_MISDIRECTED_REQUEST = 421`
- `const int STATUS_MOVED_PERMANENTLY = 301`
- `const int STATUS_MULTIPLE_CHOICES = 300`
- `const int STATUS_MULTI_STATUS = 207`
- `const int STATUS_NETWORK_AUTHENTICATION_REQUIRED = 511`
- `const int STATUS_NETWORK_CONNECT_TIMEOUT_ERROR = 599`
- `const int STATUS_NETWORK_READ_TIMEOUT_ERROR = 598`
- `const int STATUS_NON_AUTHORITATIVE_INFORMATION = 203`
- `const int STATUS_NOT_ACCEPTABLE = 406`
- `const int STATUS_NOT_EXTENDED = 510`
- `const int STATUS_NOT_FOUND = 404`
- `const int STATUS_NOT_IMPLEMENTED = 501`
- `const int STATUS_NOT_MODIFIED = 304`
- `const int STATUS_NO_CONTENT = 204`
- `const int STATUS_NO_RESPONSE = 444`
- `const int STATUS_OK = 200`
- `const int STATUS_ORIGIN_DNS_ERROR = 530`
- `const int STATUS_ORIGIN_IS_UNREACHABLE = 523`
- `const int STATUS_PAGE_EXPIRED = 419`
- `const int STATUS_PARTIAL_CONTENT = 206`
- `const int STATUS_PAYLOAD_TOO_LARGE = 413`
- `const int STATUS_PAYMENT_REQUIRED = 402`
- `const int STATUS_PERMANENT_REDIRECT = 308`
- `const int STATUS_PRECONDITION_FAILED = 412`
- `const int STATUS_PRECONDITION_REQUIRED = 428`
- `const int STATUS_PROCESSING = 102`
- `const int STATUS_PROXY_AUTHENTICATION_REQUIRED = 407`
- `const int STATUS_RAILGUN_ERROR = 527`
- `const int STATUS_RANGE_NOT_SATISFIABLE = 416`
- `const int STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE = 431`
- `const int STATUS_REQUEST_HEADER_TOO_LARGE = 494`
- `const int STATUS_REQUEST_TIMEOUT = 408`
- `const int STATUS_RESERVED = 306`
- `const int STATUS_RESET_CONTENT = 205`
- `const int STATUS_RETRY_WITH = 449`
- `const int STATUS_SEE_OTHER = 303`
- `const int STATUS_SERVICE_UNAVAILABLE = 503`
- `const int STATUS_SSL_CERTIFICATE_ERROR = 495`
- `const int STATUS_SSL_CERTIFICATE_REQUIRED = 496`
- `const int STATUS_SSL_HANDSHAKE_FAILED = 525`
- `const int STATUS_SWITCHING_PROTOCOLS = 101`
- `const int STATUS_TEMPORARY_REDIRECT = 307`
- `const int STATUS_THIS_IS_FINE = 218`
- `const int STATUS_TIMEOUT_OCCURRED = 524`
- `const int STATUS_TOO_EARLY = 425`
- `const int STATUS_TOO_MANY_REQUESTS = 429`
- `const int STATUS_UNAUTHORIZED = 401`
- `const int STATUS_UNAVAILABLE_FOR_LEGAL_REASONS = 451`
- `const int STATUS_UNKNOWN_ERROR = 520`
- `const int STATUS_UNPROCESSABLE_ENTITY = 422`
- `const int STATUS_UNSUPPORTED_MEDIA_TYPE = 415`
- `const int STATUS_UPGRADE_REQUIRED = 426`
- `const int STATUS_URI_TOO_LONG = 414`
- `const int STATUS_USE_PROXY = 305`
- `const int STATUS_VARIANT_ALSO_NEGOTIATES = 506`
- `const int STATUS_VERSION_NOT_SUPPORTED = 505`
- `const int STATUS_WEB_SERVER_IS_DOWN = 521`
## Http\Request
Class
Encapsulates request information for easy and secure access from application
controllers.
The request object is a simple value object that is passed between the
dispatcher and controller classes. It packages the HTTP request environment.
```php
use Phalcon\Http\Request;
$request = new Request();
if ($request->isPost() && $request->isAjax()) {
echo "Request was made using POST and AJAX";
}
// Retrieve SERVER variables
$request->getServer("HTTP_HOST");
// GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH, PURGE, TRACE, CONNECT
$request->getMethod();
// An array of languages the client accepts
$request->getLanguages();
```
- `\stdClass`
- [`Phalcon\Di\AbstractInjectionAware`](/5.23/api/phalcon_di/#diabstractinjectionaware)
- **`Phalcon\Http\Request`** - implements [`Phalcon\Http\RequestInterface`](#httprequestinterface), [`Phalcon\Http\Message\RequestMethodInterface`](#httpmessagerequestmethodinterface), [`Phalcon\Contracts\Http\AttributeRequest`](/5.23/api/phalcon_contracts/#contractshttpattributerequest)
`Phalcon\Contracts\Http\AttributeRequest` · `Phalcon\Contracts\Http\HttpTypes` · `Phalcon\Di\AbstractInjectionAware` · `Phalcon\Di\DiInterface` · `Phalcon\Events\ManagerInterface` · `Phalcon\Events\Traits\EventsAwareTrait` · `Phalcon\Filter\FilterInterface` · `Phalcon\Http\Message\RequestMethodInterface` · `Phalcon\Http\Request\Bag\AttributeBag` · `Phalcon\Http\Request\Exception` · `Phalcon\Http\Request\Exceptions\FilterServiceUnavailable` · `Phalcon\Http\Request\Exceptions\InvalidHost` · `Phalcon\Http\Request\Exceptions\InvalidHttpMethod` · `Phalcon\Http\Request\Exceptions\MissingFilters` · `Phalcon\Http\Request\Exceptions\SanitizerNotFound` · `Phalcon\Http\Request\File` · `Phalcon\Http\Request\FileInterface` · `Phalcon\Support\Helper\Json\Decode` · `Phalcon\Traits\Php\FileTrait` · `stdClass`
### Method Summary
- `public get(string|null $name = null, mixed $filters = null, mixed $defaultValue = null, bool $notAllowEmpty = false, bool $noRecursive = false): mixed` — Gets a variable from the $\_REQUEST superglobal applying filters if
- `public getAcceptableContent(): array` — Gets an array with mime/types and their quality accepted by the
- `public getAttributes(): AttributeBag` — Returns the request attributes bag. Attributes are arbitrary,
- `public getBasicAuth(): array|null` — Gets auth info accepted by the browser/client from
- `public getBestAccept(): string` — Gets best mime/type accepted by the browser/client from
- `public getBestCharset(): string` — Gets best charset accepted by the browser/client from
- `public getBestLanguage(): string` — Gets the best language accepted by the browser/client from
- `public getClientAddress(bool $trustForwardedHeader = false): bool|string` — Gets most possible client IP Address. This method searches in
- `public getClientCharsets(): array` — Gets a charsets array and their quality accepted by the browser/client
- `public getContentType(): string|null` — Gets content type which request has been made
- `public getDigestAuth(): array` — Gets auth info accepted by the browser/client from
- `public getFilteredData(string $methodKey, string $method, string|null $name = null, mixed $defaultValue = null, bool $notAllowEmpty = false, bool $noRecursive = false): mixed` — Gets filtered data
- `public getFilteredPatch(string|null $name = null, mixed $defaultValue = null, bool $notAllowEmpty = false, bool $noRecursive = false): mixed` — Retrieves a patch value always sanitized with the preset filters
- `public getFilteredPost(string|null $name = null, mixed $defaultValue = null, bool $notAllowEmpty = false, bool $noRecursive = false): mixed` — Retrieves a post value always sanitized with the preset filters
- `public getFilteredPut(string|null $name = null, mixed $defaultValue = null, bool $notAllowEmpty = false, bool $noRecursive = false): mixed` — Retrieves a put value always sanitized with the preset filters
- `public getFilteredQuery(string|null $name = null, mixed $defaultValue = null, bool $notAllowEmpty = false, bool $noRecursive = false): mixed` — Retrieves a query/get value always sanitized with the preset filters
- `public getHTTPReferer(): string` — Gets web page that refers active request. ie:
- `public getHeader(string $header): string` — Gets HTTP header from request data
- `public getHeaders(): array` — Returns the available headers in the request
- `public getHttpHost(): string` — Gets host name used by the request.
- `public getHttpMethodParameterOverride(): bool` — Return the HTTP method parameter override flag
- `public getJsonRawBody(bool $associative = false): array|bool|\stdClass` — Gets decoded JSON HTTP raw request body
- `public getLanguages(): array` — Gets languages array and their quality accepted by the browser/client
- `public getMethod(): string` — Gets HTTP method which request has been made
- `public getPatch(string|null $name = null, mixed $filters = null, mixed $defaultValue = null, bool $notAllowEmpty = false, bool $noRecursive = false): mixed` — Gets a variable from put request
- `public getPort(): int` — Gets information about the port on which the request is made.
- `public getPost(string|null $name = null, mixed $filters = null, mixed $defaultValue = null, bool $notAllowEmpty = false, bool $noRecursive = false): mixed` — Gets a variable from the $\_POST superglobal applying filters if needed
- `public getPreferredIsoLocaleVariant(): string` — Gets the preferred ISO locale variant.
- `public getPut(string|null $name = null, mixed $filters = null, mixed $defaultValue = null, bool $notAllowEmpty = false, bool $noRecursive = false): mixed` — Gets a variable from put request
- `public getQuery(string|null $name = null, mixed $filters = null, mixed $defaultValue = null, bool $notAllowEmpty = false, bool $noRecursive = false): mixed` — Gets variable from $\_GET superglobal applying filters if needed.
- `public getRawBody(): string` — Gets HTTP raw request body
- `public getScheme(): string` — Gets HTTP schema (http/https)
- `public getServer(string $name): string|null` — Gets variable from $\_SERVER superglobal
- `public getServerAddress(): string` — Gets active server address IP
- `public getServerName(): string` — Gets active server name
- `public getURI(bool $onlyPath = false): string` — Gets HTTP URI which request has been made to
- `public getUploadedFiles(bool $onlySuccessful = false, bool $namedKeys = false): FileInterface[]` — Gets attached files as Phalcon\Http\Request\File instances
- `public getUserAgent(): string` — Gets HTTP user agent used to make the request
- `public has(string $name): bool` — Checks whether $\_REQUEST superglobal has certain index
- `public hasFiles(): bool` — Returns if the request has files or not
- `public hasHeader(string $header): bool` — Checks whether headers has certain index
- `public hasPatch(string $name): bool` — Checks whether the PATCH data has certain index
- `public hasPost(string $name): bool` — Checks whether $\_POST superglobal has certain index
- `public hasPut(string $name): bool` — Checks whether the PUT data has certain index
- `public hasQuery(string $name): bool` — Checks whether $\_GET superglobal has certain index
- `public hasServer(string $name): bool` — Checks whether $\_SERVER superglobal has certain index
- `public isAjax(): bool` — Checks whether request has been made using ajax
- `public isConnect(): bool` — Checks whether HTTP method is CONNECT.
- `public isDelete(): bool` — Checks whether HTTP method is DELETE.
- `public isGet(): bool` — Checks whether HTTP method is GET.
- `public isHead(): bool` — Checks whether HTTP method is HEAD.
- `public isJson(): bool` — Checks whether request content type contains json data
- `public isMethod(mixed $methods, bool $strict = false): bool` — Check if HTTP method match any of the passed methods
- `public isOptions(): bool` — Checks whether HTTP method is OPTIONS.
- `public isPatch(): bool` — Checks whether HTTP method is PATCH.
- `public isPost(): bool` — Checks whether HTTP method is POST.
- `public isPurge(): bool` — Checks whether HTTP method is PURGE (Squid and Varnish support).
- `public isPut(): bool` — Checks whether HTTP method is PUT.
- `public isSecure(): bool` — Checks whether request has been made using any secure layer
- `public isSoap(): bool` — Checks whether request has been made using SOAP
- `public isStrictHostCheck(): bool` — Checks if the `Request::getHttpHost` method will be use strict validation
- `public isTrace(): bool` — Checks whether HTTP method is TRACE.
- `public isValidHttpMethod(string $method): bool` — Checks if a method is a valid HTTP method
- `public numFiles(bool $onlySuccessful = false): int` — Returns the number of files available
- `public setHttpMethodParameterOverride(bool $override): static` — Set the HTTP method parameter override flag
- `public setParameterFilters(string $name, array $filters = [], array $scope = []): static` — Sets automatic sanitizers/filters for a particular field and for
- `public setStrictHostCheck(bool $flag = true): static` — Sets if the `Request::getHttpHost` method must be use strict validation
- `public setTrustedProxies(array $trustedProxies): static` — Set a trusted proxy list for X-Forwarded-For header
- `public setTrustedProxyHeader(string $trustedProxyHeader): static` — This header takes priority when parsing HTTP headers
- `protected getBestQuality(array $qualityParts, string $name): string` — Process a request header and return the one with best quality
- `protected getHelper(array $source, string|null $name = null, mixed $filters = null, mixed $defaultValue = null, bool $notAllowEmpty = false, bool $noRecursive = false): mixed` — Helper to get data from superglobals, applying filters if needed.
- `protected getQualityHeader(string $serverIndex, string $name): array` — Process a request header and return an array of values with their
- `protected hasFileHelper(mixed $data, bool $onlySuccessful): int` — Recursively counts file in an array of files
- `protected isIpAddressInCIDR(string $ip, string $cidr): bool` — Check if an IP address exists in CIDR range
- `protected resolveAuthorizationHeaders(): array` — Resolve authorization headers.
- `protected smoothFiles(array $names, array $types, array $tmp_names, array $sizes, array $errors, string $prefix): array` — Smooth out $\_FILES to have plain array with all files uploaded
### Properties
- `protected AttributeBag|null $attributes = null`
- `protected FilterInterface|null $filterService = null`
- `protected bool $methodOverride = false`
- `protected array|null $postCache = null`
- `protected array $queryFilters = []`
- `protected string $rawBody = ""`
- `protected bool $strictHostCheck = false`
- `protected array $trustedProxies = []`
- `protected string $trustedProxyHeader = ""`
### Methods
get()
```php
public function get(
string|null $name = null,
mixed $filters = null,
mixed $defaultValue = null,
bool $notAllowEmpty = false,
bool $noRecursive = false
): mixed;
```
Gets a variable from the $_REQUEST superglobal applying filters if
needed. If no parameters are given the $_REQUEST superglobal is returned
```php
// Returns value from $_REQUEST["user_email"] without sanitizing
$userEmail = $request->get("user_email");
// Returns value from $_REQUEST["user_email"] with sanitizing
$userEmail = $request->get("user_email", "email");
```
@todo check the filters
getAcceptableContent()
```php
public function getAcceptableContent(): array;
```
Gets an array with mime/types and their quality accepted by the
browser/client from _SERVER["HTTP_ACCEPT"]
getAttributes()
```php
public function getAttributes(): AttributeBag;
```
Returns the request attributes bag. Attributes are arbitrary,
application-defined values attached to the request during its
lifecycle (router, dispatcher, security components etc.). The bag
is created empty on first access and the same instance is returned
on every subsequent call.
```php
$request->getAttributes()->set("user", $user);
$user = $request->getAttributes()->get("user");
```
getBasicAuth()
```php
public function getBasicAuth(): array|null;
```
Gets auth info accepted by the browser/client from
$_SERVER["PHP_AUTH_USER"]
getBestAccept()
```php
public function getBestAccept(): string;
```
Gets best mime/type accepted by the browser/client from
_SERVER["HTTP_ACCEPT"]
getBestCharset()
```php
public function getBestCharset(): string;
```
Gets best charset accepted by the browser/client from
_SERVER["HTTP_ACCEPT_CHARSET"]
getBestLanguage()
```php
public function getBestLanguage(): string;
```
Gets the best language accepted by the browser/client from
_SERVER["HTTP_ACCEPT_LANGUAGE"]
getClientAddress()
```php
public function getClientAddress( bool $trustForwardedHeader = false ): bool|string;
```
Gets most possible client IP Address. This method searches in
`$_SERVER["REMOTE_ADDR"]` and optionally in
`$_SERVER["HTTP_X_FORWARDED_FOR"]` and returns the first non-private or non-reserved IP address
The user provided trusted header takes priority before checking X-Forwarded-For header.
Using trusted proxies list, user has to provide a trusted list of proxy IPs
```
$request
->setTrustedProxies($trustedProxies)
->getClientAddress(true);
```
Using user provided trusted header, header should only ever contain 1 IP address, eg. HTTP_CLIENT_IP
```
$request
->setTrustedProxyHeader('HTTP_CLIENT_IP')
->setTrustedProxies($trustedProxies)
->getClientAddress(true);
```
getClientCharsets()
```php
public function getClientCharsets(): array;
```
Gets a charsets array and their quality accepted by the browser/client
from _SERVER["HTTP_ACCEPT_CHARSET"]
getContentType()
```php
public function getContentType(): string|null;
```
Gets content type which request has been made
getDigestAuth()
```php
public function getDigestAuth(): array;
```
Gets auth info accepted by the browser/client from
$_SERVER["PHP_AUTH_DIGEST"]
getFilteredData()
```php
public function getFilteredData(
string $methodKey,
string $method,
string|null $name = null,
mixed $defaultValue = null,
bool $notAllowEmpty = false,
bool $noRecursive = false
): mixed;
```
Gets filtered data
getFilteredPatch()
```php
public function getFilteredPatch(
string|null $name = null,
mixed $defaultValue = null,
bool $notAllowEmpty = false,
bool $noRecursive = false
): mixed;
```
Retrieves a patch value always sanitized with the preset filters
getFilteredPost()
```php
public function getFilteredPost(
string|null $name = null,
mixed $defaultValue = null,
bool $notAllowEmpty = false,
bool $noRecursive = false
): mixed;
```
Retrieves a post value always sanitized with the preset filters
getFilteredPut()
```php
public function getFilteredPut(
string|null $name = null,
mixed $defaultValue = null,
bool $notAllowEmpty = false,
bool $noRecursive = false
): mixed;
```
Retrieves a put value always sanitized with the preset filters
getFilteredQuery()
```php
public function getFilteredQuery(
string|null $name = null,
mixed $defaultValue = null,
bool $notAllowEmpty = false,
bool $noRecursive = false
): mixed;
```
Retrieves a query/get value always sanitized with the preset filters
getHTTPReferer()
```php
public function getHTTPReferer(): string;
```
Gets web page that refers active request. ie: http://www.google.com
```php
public function getHeader( string $header ): string;
```
Gets HTTP header from request data
```php
public function getHeaders(): array;
```
Returns the available headers in the request
```php
$_SERVER = [
"PHP_AUTH_USER" => "phalcon",
"PHP_AUTH_PW" => "secret",
];
$headers = $request->getHeaders();
echo $headers["Authorization"]; // Basic cGhhbGNvbjpzZWNyZXQ=
```
getHttpHost()
```php
public function getHttpHost(): string;
```
Gets host name used by the request.
`Request::getHttpHost` trying to find host name in following order:
- `$_SERVER["HTTP_HOST"]`
- `$_SERVER["SERVER_NAME"]`
- `$_SERVER["SERVER_ADDR"]`
Optionally `Request::getHttpHost` validates and clean host name.
The `Request::$strictHostCheck` can be used to validate host name.
Note: validation and cleaning have a negative performance impact because
they use regular expressions.
```php
use Phalcon\Http\Request;
$request = new Request;
$_SERVER["HTTP_HOST"] = "example.com";
$request->getHttpHost(); // example.com
$_SERVER["HTTP_HOST"] = "example.com:8080";
$request->getHttpHost(); // example.com:8080
$request->setStrictHostCheck(true);
$_SERVER["HTTP_HOST"] = "ex=am~ple.com";
$request->getHttpHost(); // UnexpectedValueException
$_SERVER["HTTP_HOST"] = "ExAmPlE.com";
$request->getHttpHost(); // example.com
```
getHttpMethodParameterOverride()
```php
public function getHttpMethodParameterOverride(): bool;
```
Return the HTTP method parameter override flag
getJsonRawBody()
```php
public function getJsonRawBody( bool $associative = false ): array|bool|\stdClass;
```
Gets decoded JSON HTTP raw request body
getLanguages()
```php
public function getLanguages(): array;
```
Gets languages array and their quality accepted by the browser/client
from _SERVER["HTTP_ACCEPT_LANGUAGE"]
getMethod()
```php
public function getMethod(): string;
```
Gets HTTP method which request has been made
If the X-HTTP-Method-Override header is set, and if the method is a POST,
then it is used to determine the "real" intended HTTP method.
The _method request parameter can also be used to determine the HTTP
method, but only if setHttpMethodParameterOverride(true) has been called.
The method is always an uppercased string.
getPatch()
```php
public function getPatch(
string|null $name = null,
mixed $filters = null,
mixed $defaultValue = null,
bool $notAllowEmpty = false,
bool $noRecursive = false
): mixed;
```
Gets a variable from put request
```php
// Returns value from $_PATCH["user_email"] without sanitizing
$userEmail = $request->getPatch("user_email");
// Returns value from $_PATCH["user_email"] with sanitizing
$userEmail = $request->getPatch("user_email", "email");
```
getPort()
```php
public function getPort(): int;
```
Gets information about the port on which the request is made.
getPost()
```php
public function getPost(
string|null $name = null,
mixed $filters = null,
mixed $defaultValue = null,
bool $notAllowEmpty = false,
bool $noRecursive = false
): mixed;
```
Gets a variable from the $_POST superglobal applying filters if needed
If no parameters are given the $_POST superglobal is returned
```php
// Returns value from $_POST["user_email"] without sanitizing
$userEmail = $request->getPost("user_email");
// Returns value from $_POST["user_email"] with sanitizing
$userEmail = $request->getPost("user_email", "email");
```
getPreferredIsoLocaleVariant()
```php
public function getPreferredIsoLocaleVariant(): string;
```
Gets the preferred ISO locale variant.
Gets the preferred locale accepted by the client from the
"Accept-Language" request HTTP header and returns the
base part of it i.e. `en` instead of `en-US`.
Note: This method relies on the `$_SERVER["HTTP_ACCEPT_LANGUAGE"]`
header.
@link https://www.iso.org/standard/50707.html
getPut()
```php
public function getPut(
string|null $name = null,
mixed $filters = null,
mixed $defaultValue = null,
bool $notAllowEmpty = false,
bool $noRecursive = false
): mixed;
```
Gets a variable from put request
```php
// Returns value from $_PUT["user_email"] without sanitizing
$userEmail = $request->getPut("user_email");
// Returns value from $_PUT["user_email"] with sanitizing
$userEmail = $request->getPut("user_email", "email");
```
getQuery()
```php
public function getQuery(
string|null $name = null,
mixed $filters = null,
mixed $defaultValue = null,
bool $notAllowEmpty = false,
bool $noRecursive = false
): mixed;
```
Gets variable from $_GET superglobal applying filters if needed.
If no parameters are given the $_GET superglobal is returned
```php
// Returns value from $_GET["id"] without sanitizing
$id = $request->getQuery("id");
// Returns value from $_GET["id"] with sanitizing
$id = $request->getQuery("id", "int");
// Returns value from $_GET["id"] with a default value
$id = $request->getQuery("id", null, 150);
```
getRawBody()
```php
public function getRawBody(): string;
```
Gets HTTP raw request body
getScheme()
```php
public function getScheme(): string;
```
Gets HTTP schema (http/https)
getServer()
```php
public function getServer( string $name ): string|null;
```
Gets variable from $_SERVER superglobal
getServerAddress()
```php
public function getServerAddress(): string;
```
Gets active server address IP
getServerName()
```php
public function getServerName(): string;
```
Gets active server name
getURI()
```php
public function getURI( bool $onlyPath = false ): string;
```
Gets HTTP URI which request has been made to
```php
// Returns /some/path?with=queryParams
$uri = $request->getURI();
// Returns /some/path
$uri = $request->getURI(true);
```
getUploadedFiles()
```php
public function getUploadedFiles(
bool $onlySuccessful = false,
bool $namedKeys = false
): FileInterface[];
```
Gets attached files as Phalcon\Http\Request\File instances
getUserAgent()
```php
public function getUserAgent(): string;
```
Gets HTTP user agent used to make the request
has()
```php
public function has( string $name ): bool;
```
Checks whether $_REQUEST superglobal has certain index
hasFiles()
```php
public function hasFiles(): bool;
```
Returns if the request has files or not
```php
final public function hasHeader( string $header ): bool;
```
Checks whether headers has certain index
hasPatch()
```php
public function hasPatch( string $name ): bool;
```
Checks whether the PATCH data has certain index
hasPost()
```php
public function hasPost( string $name ): bool;
```
Checks whether $_POST superglobal has certain index
hasPut()
```php
public function hasPut( string $name ): bool;
```
Checks whether the PUT data has certain index
hasQuery()
```php
public function hasQuery( string $name ): bool;
```
Checks whether $_GET superglobal has certain index
hasServer()
```php
final public function hasServer( string $name ): bool;
```
Checks whether $_SERVER superglobal has certain index
isAjax()
```php
public function isAjax(): bool;
```
Checks whether request has been made using ajax
isConnect()
```php
public function isConnect(): bool;
```
Checks whether HTTP method is CONNECT.
if _SERVER["REQUEST_METHOD"]==="CONNECT"
isDelete()
```php
public function isDelete(): bool;
```
Checks whether HTTP method is DELETE.
if _SERVER["REQUEST_METHOD"]==="DELETE"
isGet()
```php
public function isGet(): bool;
```
Checks whether HTTP method is GET.
if _SERVER["REQUEST_METHOD"]==="GET"
isHead()
```php
public function isHead(): bool;
```
Checks whether HTTP method is HEAD.
if _SERVER["REQUEST_METHOD"]==="HEAD"
isJson()
```php
public function isJson(): bool;
```
Checks whether request content type contains json data
isMethod()
```php
public function isMethod(
mixed $methods,
bool $strict = false
): bool;
```
Check if HTTP method match any of the passed methods
When strict is true it checks if validated methods are real HTTP methods
@todo check the $methods type - refactor this !!
isOptions()
```php
public function isOptions(): bool;
```
Checks whether HTTP method is OPTIONS.
if _SERVER["REQUEST_METHOD"]==="OPTIONS"
isPatch()
```php
public function isPatch(): bool;
```
Checks whether HTTP method is PATCH.
if _SERVER["REQUEST_METHOD"]==="PATCH"
isPost()
```php
public function isPost(): bool;
```
Checks whether HTTP method is POST.
if _SERVER["REQUEST_METHOD"]==="POST"
isPurge()
```php
public function isPurge(): bool;
```
Checks whether HTTP method is PURGE (Squid and Varnish support).
if _SERVER["REQUEST_METHOD"]==="PURGE"
isPut()
```php
public function isPut(): bool;
```
Checks whether HTTP method is PUT.
if _SERVER["REQUEST_METHOD"]==="PUT"
isSecure()
```php
public function isSecure(): bool;
```
Checks whether request has been made using any secure layer
isSoap()
```php
public function isSoap(): bool;
```
Checks whether request has been made using SOAP
isStrictHostCheck()
```php
public function isStrictHostCheck(): bool;
```
Checks if the `Request::getHttpHost` method will be use strict validation
of host name or not
isTrace()
```php
public function isTrace(): bool;
```
Checks whether HTTP method is TRACE.
if _SERVER["REQUEST_METHOD"]==="TRACE"
isValidHttpMethod()
```php
public function isValidHttpMethod( string $method ): bool;
```
Checks if a method is a valid HTTP method
numFiles()
```php
public function numFiles( bool $onlySuccessful = false ): int;
```
Returns the number of files available
setHttpMethodParameterOverride()
```php
public function setHttpMethodParameterOverride( bool $override ): static;
```
Set the HTTP method parameter override flag
setParameterFilters()
```php
public function setParameterFilters(
string $name,
array $filters = [],
array $scope = []
): static;
```
Sets automatic sanitizers/filters for a particular field and for
particular methods
setStrictHostCheck()
```php
public function setStrictHostCheck( bool $flag = true ): static;
```
Sets if the `Request::getHttpHost` method must be use strict validation
of host name or not
setTrustedProxies()
```php
public function setTrustedProxies( array $trustedProxies ): static;
```
Set a trusted proxy list for X-Forwarded-For header
```php
public function setTrustedProxyHeader( string $trustedProxyHeader ): static;
```
This header takes priority when parsing HTTP headers
The header return only 1 single IP address, prefixed with HTTP_ eg. HTTP_CLIENT_IP.
getBestQuality()
```php
protected function getBestQuality(
array $qualityParts,
string $name
): string;
```
Process a request header and return the one with best quality
getHelper()
```php
protected function getHelper(
array $source,
string|null $name = null,
mixed $filters = null,
mixed $defaultValue = null,
bool $notAllowEmpty = false,
bool $noRecursive = false
): mixed;
```
Helper to get data from superglobals, applying filters if needed.
If no parameters are given the superglobal is returned.
```php
protected function getQualityHeader(
string $serverIndex,
string $name
): array;
```
Process a request header and return an array of values with their
qualities
hasFileHelper()
```php
protected function hasFileHelper(
mixed $data,
bool $onlySuccessful
): int;
```
Recursively counts file in an array of files
isIpAddressInCIDR()
```php
protected function isIpAddressInCIDR(
string $ip,
string $cidr
): bool;
```
Check if an IP address exists in CIDR range
```php
protected function resolveAuthorizationHeaders(): array;
```
Resolve authorization headers.
smoothFiles()
```php
protected function smoothFiles(
array $names,
array $types,
array $tmp_names,
array $sizes,
array $errors,
string $prefix
): array;
```
Smooth out $_FILES to have plain array with all files uploaded
## Http\RequestInterface
Interface
Interface for Phalcon\Http\Request
- **`Phalcon\Http\RequestInterface`**
- [`Phalcon\Contracts\Http\AttributeRequest`](/5.23/api/phalcon_contracts/#contractshttpattributerequest)
`Phalcon\Contracts\Http\HttpTypes` · `Phalcon\Http\Request\FileInterface` · `stdClass`
### Method Summary
- `public get(string|null $name = null, mixed $filters = null, mixed $defaultValue = null, bool $notAllowEmpty = false, bool $noRecursive = false): mixed` — Gets a variable from the $\_REQUEST superglobal applying filters if
- `public getAcceptableContent(): array` — Return an array with mime/types and their quality accepted by the
- `public getBasicAuth(): array|null` — Gets auth info accepted by the browser/client from
- `public getBestAccept(): string` — Return the best mime/type accepted by the browser/client from
- `public getBestCharset(): string` — Return the best charset accepted by the browser/client from
- `public getBestLanguage(): string` — Return the best language accepted by the browser/client from
- `public getClientAddress(bool $trustForwardedHeader = false): bool|string` — Return the most possible client IPv4 Address. This method searches in
- `public getClientCharsets(): array` — Return a charset array and their quality accepted by the browser/client
- `public getContentType(): string|null` — Return the content type which request has been made
- `public getDigestAuth(): array` — Return the auth info accepted by the browser/client from
- `public getHTTPReferer(): string` — Return the web page that refers active request. ie:
- `public getHeader(string $header): string` — Return the HTTP header from request data
- `public getHeaders(): array` — Returns the available headers in the request
- `public getHttpHost(): string` — Return the host name used by the request.
- `public getJsonRawBody(bool $associative = false): array|bool|stdClass` — Return the decoded JSON HTTP raw request body
- `public getLanguages(): array` — Return the languages array and their quality accepted by the
- `public getMethod(): string` — Return the HTTP method which request has been made
- `public getPort(): int` — Return the information about the port on which the request is made
- `public getPost(string|null $name = null, mixed $filters = null, mixed $defaultValue = null, bool $notAllowEmpty = false, bool $noRecursive = false): mixed` — Return a variable from the $\_POST superglobal applying filters if needed.
- `public getPut(string|null $name = null, mixed $filters = null, mixed $defaultValue = null, bool $notAllowEmpty = false, bool $noRecursive = false): mixed` — Return a variable from put request
- `public getQuery(string|null $name = null, mixed $filters = null, mixed $defaultValue = null, bool $notAllowEmpty = false, bool $noRecursive = false): mixed` — Return a variable from $\_GET superglobal applying filters if needed.
- `public getRawBody(): string` — Return the HTTP raw request body
- `public getScheme(): string` — Return the HTTP schema (http/https)
- `public getServer(string $name): string|null` — Return a variable from $\_SERVER superglobal
- `public getServerAddress(): string` — Return the active server address IP
- `public getServerName(): string` — Return the active server name
- `public getURI(bool $onlyPath = false): string` — Return the HTTP URI which request has been made to
- `public getUploadedFiles(bool $onlySuccessful = false, bool $namedKeys = false): FileInterface[]` — Return the attached files as Phalcon\Http\Request\FileInterface
- `public getUserAgent(): string` — Return the HTTP user agent used to make the request
- `public has(string $name): bool` — Return whether the $\_REQUEST superglobal has certain index
- `public hasFiles(): bool` — Return whether the request includes attached files
- `public hasHeader(string $header): bool` — Return whether the headers have a certain index
- `public hasPost(string $name): bool` — Return whether the $\_POST superglobal has certain index
- `public hasPut(string $name): bool` — Return whether the PUT data has certain index
- `public hasQuery(string $name): bool` — Return whether the $\_GET superglobal has certain index
- `public hasServer(string $name): bool` — Return whether the $\_SERVER superglobal has certain index
- `public isAjax(): bool` — Return whether the request has been made using ajax. Checks if
- `public isConnect(): bool` — Return whether the HTTP method is CONNECT. if
- `public isDelete(): bool` — Return whether the HTTP method is DELETE. if
- `public isGet(): bool` — Return whether the HTTP method is GET. if
- `public isHead(): bool` — Return whether the HTTP method is HEAD. if
- `public isMethod(mixed $methods, bool $strict = false): bool` — Return if the current HTTP method matches any of the passed methods
- `public isOptions(): bool` — Return whether the HTTP method is OPTIONS. if
- `public isPost(): bool` — Return whether the HTTP method is POST. if
- `public isPurge(): bool` — Return whether the HTTP method is PURGE (Squid and Varnish support). if
- `public isPut(): bool` — Return whether the HTTP method is PUT. if
- `public isSecure(): bool` — Return whether the request has been made using any secure layer
- `public isSoap(): bool` — Return whether the request has been made using SOAP
- `public isTrace(): bool` — Return whether the HTTP method is TRACE.
- `public numFiles(bool $onlySuccessful = false): int` — Returns the number of files available
### Methods
get()
```php
public function get(
string|null $name = null,
mixed $filters = null,
mixed $defaultValue = null,
bool $notAllowEmpty = false,
bool $noRecursive = false
): mixed;
```
Gets a variable from the $_REQUEST superglobal applying filters if
needed. If no parameters are given the $_REQUEST superglobal is returned
```php
// Returns value from $_REQUEST["user_email"] without sanitizing
$userEmail = $request->get("user_email");
// Returns value from $_REQUEST["user_email"] with sanitizing
$userEmail = $request->get("user_email", "email");
```
@todo check the filters here
getAcceptableContent()
```php
public function getAcceptableContent(): array;
```
Return an array with mime/types and their quality accepted by the
browser/client from _SERVER["HTTP_ACCEPT"]
getBasicAuth()
```php
public function getBasicAuth(): array|null;
```
Gets auth info accepted by the browser/client from
$_SERVER["PHP_AUTH_USER"]
getBestAccept()
```php
public function getBestAccept(): string;
```
Return the best mime/type accepted by the browser/client from
_SERVER["HTTP_ACCEPT"]
getBestCharset()
```php
public function getBestCharset(): string;
```
Return the best charset accepted by the browser/client from
_SERVER["HTTP_ACCEPT_CHARSET"]
getBestLanguage()
```php
public function getBestLanguage(): string;
```
Return the best language accepted by the browser/client from
_SERVER["HTTP_ACCEPT_LANGUAGE"]
getClientAddress()
```php
public function getClientAddress( bool $trustForwardedHeader = false ): bool|string;
```
Return the most possible client IPv4 Address. This method searches in
$_SERVER["REMOTE_ADDR"] and optionally in
$_SERVER["HTTP_X_FORWARDED_FOR"]
getClientCharsets()
```php
public function getClientCharsets(): array;
```
Return a charset array and their quality accepted by the browser/client
from _SERVER["HTTP_ACCEPT_CHARSET"]
getContentType()
```php
public function getContentType(): string|null;
```
Return the content type which request has been made
getDigestAuth()
```php
public function getDigestAuth(): array;
```
Return the auth info accepted by the browser/client from
$_SERVER["PHP_AUTH_DIGEST"]
getHTTPReferer()
```php
public function getHTTPReferer(): string;
```
Return the web page that refers active request. ie: https://phalcon.io
```php
public function getHeader( string $header ): string;
```
Return the HTTP header from request data
```php
public function getHeaders(): array;
```
Returns the available headers in the request
```php
$_SERVER = [
"PHP_AUTH_USER" => "phalcon",
"PHP_AUTH_PW" => "secret",
];
$headers = $request->getHeaders();
echo $headers["Authorization"]; // Basic cGhhbGNvbjpzZWNyZXQ=
```
getHttpHost()
```php
public function getHttpHost(): string;
```
Return the host name used by the request.
`Request::getHttpHost` trying to find host name in following order:
- `$_SERVER["HTTP_HOST"]`
- `$_SERVER["SERVER_NAME"]`
- `$_SERVER["SERVER_ADDR"]`
Optionally `Request::getHttpHost` validates and clean host name.
The `Request::$strictHostCheck` can be used to validate host name.
Note: validation and cleaning have a negative performance impact because
they use regular expressions.
```php
use Phalcon\Http\Request;
$request = new Request;
$_SERVER["HTTP_HOST"] = "example.com";
$request->getHttpHost(); // example.com
$_SERVER["HTTP_HOST"] = "example.com:8080";
$request->getHttpHost(); // example.com:8080
$request->setStrictHostCheck(true);
$_SERVER["HTTP_HOST"] = "ex=am~ple.com";
$request->getHttpHost(); // UnexpectedValueException
$_SERVER["HTTP_HOST"] = "ExAmPlE.com";
$request->getHttpHost(); // example.com
```
getJsonRawBody()
```php
public function getJsonRawBody( bool $associative = false ): array|bool|stdClass;
```
Return the decoded JSON HTTP raw request body
getLanguages()
```php
public function getLanguages(): array;
```
Return the languages array and their quality accepted by the
browser/client from _SERVER["HTTP_ACCEPT_LANGUAGE"]
getMethod()
```php
public function getMethod(): string;
```
Return the HTTP method which request has been made
If the X-HTTP-Method-Override header is set, and if the method is a POST,
then it is used to determine the "real" intended HTTP method.
The _method request parameter can also be used to determine the HTTP
method, but only if setHttpMethodParameterOverride(true) has been called.
The method is always an uppercased string.
getPort()
```php
public function getPort(): int;
```
Return the information about the port on which the request is made
getPost()
```php
public function getPost(
string|null $name = null,
mixed $filters = null,
mixed $defaultValue = null,
bool $notAllowEmpty = false,
bool $noRecursive = false
): mixed;
```
Return a variable from the $_POST superglobal applying filters if needed.
If no parameters are given the $_POST superglobal is returned
```php
// Returns value from $_POST["user_email"] without sanitizing
$userEmail = $request->getPost("user_email");
// Returns value from $_POST["user_email"] with sanitizing
$userEmail = $request->getPost("user_email", "email");
```
@todo check the filters
getPut()
```php
public function getPut(
string|null $name = null,
mixed $filters = null,
mixed $defaultValue = null,
bool $notAllowEmpty = false,
bool $noRecursive = false
): mixed;
```
Return a variable from put request
```php
// Returns value from PUT stream without sanitizing
$userEmail = $request->getPut("user_email");
// Returns value from PUT stream with sanitizing
$userEmail = $request->getPut("user_email", "email");
```
@todo check the filters
getQuery()
```php
public function getQuery(
string|null $name = null,
mixed $filters = null,
mixed $defaultValue = null,
bool $notAllowEmpty = false,
bool $noRecursive = false
): mixed;
```
Return a variable from $_GET superglobal applying filters if needed.
If no parameters are given the $_GET superglobal is returned
```php
// Returns value from $_GET["id"] without sanitizing
$id = $request->getQuery("id");
// Returns value from $_GET["id"] with sanitizing
$id = $request->getQuery("id", "int");
// Returns value from $_GET["id"] with a default value
$id = $request->getQuery("id", null, 150);
```
@todo check the filters
getRawBody()
```php
public function getRawBody(): string;
```
Return the HTTP raw request body
getScheme()
```php
public function getScheme(): string;
```
Return the HTTP schema (http/https)
getServer()
```php
public function getServer( string $name ): string|null;
```
Return a variable from $_SERVER superglobal
getServerAddress()
```php
public function getServerAddress(): string;
```
Return the active server address IP
getServerName()
```php
public function getServerName(): string;
```
Return the active server name
getURI()
```php
public function getURI( bool $onlyPath = false ): string;
```
Return the HTTP URI which request has been made to
```php
// Returns /some/path?with=queryParams
$uri = $request->getURI();
// Returns /some/path
$uri = $request->getURI(true);
```
getUploadedFiles()
```php
public function getUploadedFiles(
bool $onlySuccessful = false,
bool $namedKeys = false
): FileInterface[];
```
Return the attached files as Phalcon\Http\Request\FileInterface
compatible instances
getUserAgent()
```php
public function getUserAgent(): string;
```
Return the HTTP user agent used to make the request
has()
```php
public function has( string $name ): bool;
```
Return whether the $_REQUEST superglobal has certain index
hasFiles()
```php
public function hasFiles(): bool;
```
Return whether the request includes attached files
```php
public function hasHeader( string $header ): bool;
```
Return whether the headers have a certain index
hasPost()
```php
public function hasPost( string $name ): bool;
```
Return whether the $_POST superglobal has certain index
hasPut()
```php
public function hasPut( string $name ): bool;
```
Return whether the PUT data has certain index
hasQuery()
```php
public function hasQuery( string $name ): bool;
```
Return whether the $_GET superglobal has certain index
hasServer()
```php
public function hasServer( string $name ): bool;
```
Return whether the $_SERVER superglobal has certain index
isAjax()
```php
public function isAjax(): bool;
```
Return whether the request has been made using ajax. Checks if
$_SERVER["HTTP_X_REQUESTED_WITH"] === "XMLHttpRequest"
isConnect()
```php
public function isConnect(): bool;
```
Return whether the HTTP method is CONNECT. if
$_SERVER["REQUEST_METHOD"] === "CONNECT"
isDelete()
```php
public function isDelete(): bool;
```
Return whether the HTTP method is DELETE. if
$_SERVER["REQUEST_METHOD"] === "DELETE"
isGet()
```php
public function isGet(): bool;
```
Return whether the HTTP method is GET. if
$_SERVER["REQUEST_METHOD"] === "GET"
isHead()
```php
public function isHead(): bool;
```
Return whether the HTTP method is HEAD. if
$_SERVER["REQUEST_METHOD"] === "HEAD"
isMethod()
```php
public function isMethod(
mixed $methods,
bool $strict = false
): bool;
```
Return if the current HTTP method matches any of the passed methods
isOptions()
```php
public function isOptions(): bool;
```
Return whether the HTTP method is OPTIONS. if
$_SERVER["REQUEST_METHOD"] === "OPTIONS"
isPost()
```php
public function isPost(): bool;
```
Return whether the HTTP method is POST. if
$_SERVER["REQUEST_METHOD"] === "POST"
isPurge()
```php
public function isPurge(): bool;
```
Return whether the HTTP method is PURGE (Squid and Varnish support). if
$_SERVER["REQUEST_METHOD"] === "PURGE"
isPut()
```php
public function isPut(): bool;
```
Return whether the HTTP method is PUT. if
$_SERVER["REQUEST_METHOD"] === "PUT"
isSecure()
```php
public function isSecure(): bool;
```
Return whether the request has been made using any secure layer
isSoap()
```php
public function isSoap(): bool;
```
Return whether the request has been made using SOAP
isTrace()
```php
public function isTrace(): bool;
```
Return whether the HTTP method is TRACE.
if $_SERVER["REQUEST_METHOD"] === "TRACE"
numFiles()
```php
public function numFiles( bool $onlySuccessful = false ): int;
```
Returns the number of files available
## Http\Request\Bag\AbstractBag
Abstract
Shared base for the HTTP request bags. A bag is a string- or integer-keyed
value store backed by a raw array, exposing `get/has/set/remove/all` plus
typed readers for cast-with-default access.
Two protected hooks (`normalizeKey`, `normalizeItems`) let subclasses
change key handling without restating the surface.
The ArrayAccess append form (`$bag[] = $value`) is rejected with a
NullKeyException: the append form supplies no explicit key, so the write
could never be addressed by the caller.
@implements ArrayAccess<int|string, mixed>
@implements IteratorAggregate<int|string, mixed>
- **`Phalcon\Http\Request\Bag\AbstractBag`** - implements `\ArrayAccess`, `\Countable`, `\IteratorAggregate`
- [`Phalcon\Http\Request\Bag\AttributeBag`](#httprequestbagattributebag)
`ArrayAccess` · `ArrayIterator` · `Countable` · `IteratorAggregate` · `Phalcon\Contracts\Http\HttpTypes` · `Phalcon\Http\Request\Exceptions\NullKeyException` · `Traversable`
### Method Summary
- `public __construct(array $items = [])` — AbstractBag constructor.
- `public all(): array` — Returns all the elements of the bag
- `public clear(): void` — Removes all the elements of the bag
- `public count(): int` — Returns the number of elements in the bag
- `public get(mixed $key, mixed $defaultValue = null): mixed` — Returns an element of the bag, or the default value if it is not set
- `public getArray(mixed $key, array $defaultValue = []): array` — Returns an element of the bag as an array. The default value is
- `public getBool(mixed $key, bool $defaultValue = false): bool` — Returns an element of the bag cast to bool, or the default value if
- `public getFloat(mixed $key, float $defaultValue = 0.0): float` — Returns an element of the bag cast to float, or the default value if
- `public getInt(mixed $key, int $defaultValue = 0): int` — Returns an element of the bag cast to int, or the default value if
- `public getIterator(): Traversable` — Returns the iterator of the bag
- `public getString(mixed $key, string $defaultValue = ""): string` — Returns an element of the bag cast to string, or the default value if
- `public has(mixed $key): bool` — Checks whether an element exists in the bag
- `public offsetExists(mixed $offset): bool` — Whether an offset exists
- `public offsetGet(mixed $offset): mixed` — Offset to retrieve
- `public offsetSet(mixed $offset, mixed $value): void` — Offset to set
- `public offsetUnset(mixed $offset): void` — Offset to unset
- `public remove(mixed $key): void` — Removes an element from the bag
- `public set(mixed $key, mixed $value): void` — Sets an element in the bag
- `protected normalizeItems(array $items): array` — Normalizes the items at construction time. Identity in the base;
- `protected normalizeKey(mixed $key): string` — Normalizes a key for lookups and writes. Identity in the base;
### Properties
- `protected array $items = []`
### Methods
__construct()
```php
public function __construct( array $items = [] );
```
AbstractBag constructor.
all()
```php
public function all(): array;
```
Returns all the elements of the bag
clear()
```php
public function clear(): void;
```
Removes all the elements of the bag
count()
```php
public function count(): int;
```
Returns the number of elements in the bag
get()
```php
public function get(
mixed $key,
mixed $defaultValue = null
): mixed;
```
Returns an element of the bag, or the default value if it is not set
getArray()
```php
public function getArray(
mixed $key,
array $defaultValue = []
): array;
```
Returns an element of the bag as an array. The default value is
returned if the element is not set or is not an array
getBool()
```php
public function getBool(
mixed $key,
bool $defaultValue = false
): bool;
```
Returns an element of the bag cast to bool, or the default value if
it is not set
getFloat()
```php
public function getFloat(
mixed $key,
float $defaultValue = 0.0
): float;
```
Returns an element of the bag cast to float, or the default value if
it is not set
getInt()
```php
public function getInt(
mixed $key,
int $defaultValue = 0
): int;
```
Returns an element of the bag cast to int, or the default value if
it is not set
getIterator()
```php
public function getIterator(): Traversable;
```
Returns the iterator of the bag
getString()
```php
public function getString(
mixed $key,
string $defaultValue = ""
): string;
```
Returns an element of the bag cast to string, or the default value if
it is not set
has()
```php
public function has( mixed $key ): bool;
```
Checks whether an element exists in the bag
offsetExists()
```php
public function offsetExists( mixed $offset ): bool;
```
Whether an offset exists
offsetGet()
```php
public function offsetGet( mixed $offset ): mixed;
```
Offset to retrieve
offsetSet()
```php
public function offsetSet(
mixed $offset,
mixed $value
): void;
```
Offset to set
offsetUnset()
```php
public function offsetUnset( mixed $offset ): void;
```
Offset to unset
remove()
```php
public function remove( mixed $key ): void;
```
Removes an element from the bag
set()
```php
public function set(
mixed $key,
mixed $value
): void;
```
Sets an element in the bag
normalizeItems()
```php
protected function normalizeItems( array $items ): array;
```
Normalizes the items at construction time. Identity in the base;
subclasses can override it to normalize keys
normalizeKey()
```php
protected function normalizeKey( mixed $key ): string;
```
Normalizes a key for lookups and writes. Identity in the base;
subclasses can override it to change key handling
## Http\Request\Bag\AttributeBag
Class
Holds the request attributes: arbitrary, application-defined values
attached to the request during its lifecycle (router, dispatcher,
security components etc.). Unlike the other request bags, it is not
hydrated from a superglobal - it always starts empty.
The base class supplies the entire surface; this class exists as a
distinct type so DI typing and IDE autocomplete stay precise.
- [`Phalcon\Http\Request\Bag\AbstractBag`](#httprequestbagabstractbag)
- **`Phalcon\Http\Request\Bag\AttributeBag`**
## Http\Request\Exception
Class
Phalcon\Http\Request\Exception
Exceptions thrown in Phalcon\Http\Request will use this class
- `\Exception`
- **`Phalcon\Http\Request\Exception`**
- [`Phalcon\Http\Request\Exceptions\FilterServiceUnavailable`](#httprequestexceptionsfilterserviceunavailable)
- [`Phalcon\Http\Request\Exceptions\InvalidHttpMethod`](#httprequestexceptionsinvalidhttpmethod)
- [`Phalcon\Http\Request\Exceptions\MissingFilters`](#httprequestexceptionsmissingfilters)
- [`Phalcon\Http\Request\Exceptions\NullKeyException`](#httprequestexceptionsnullkeyexception)
- [`Phalcon\Http\Request\Exceptions\SanitizerNotFound`](#httprequestexceptionssanitizernotfound)
## Http\Request\Exceptions\FilterServiceUnavailable
Class
- `\Exception`
- [`Phalcon\Http\Request\Exception`](#httprequestexception)
- **`Phalcon\Http\Request\Exceptions\FilterServiceUnavailable`**
`Phalcon\Http\Request\Exception`
### Method Summary
- `public __construct()`
### Methods
__construct()
```php
public function __construct();
```
## Http\Request\Exceptions\InvalidHost
Class
- `\UnexpectedValueException`
- **`Phalcon\Http\Request\Exceptions\InvalidHost`**
`UnexpectedValueException`
### Method Summary
- `public __construct(string $host)`
### Methods
__construct()
```php
public function __construct( string $host );
```
## Http\Request\Exceptions\InvalidHttpMethod
Class
- `\Exception`
- [`Phalcon\Http\Request\Exception`](#httprequestexception)
- **`Phalcon\Http\Request\Exceptions\InvalidHttpMethod`**
`Phalcon\Http\Request\Exception`
### Method Summary
- `public __construct(string $method)`
### Methods
__construct()
```php
public function __construct( string $method );
```
## Http\Request\Exceptions\MissingFilters
Class
- `\Exception`
- [`Phalcon\Http\Request\Exception`](#httprequestexception)
- **`Phalcon\Http\Request\Exceptions\MissingFilters`**
`Phalcon\Http\Request\Exception`
### Method Summary
- `public __construct(string $name)`
### Methods
__construct()
```php
public function __construct( string $name );
```
## Http\Request\Exceptions\NullKeyException
Class
Thrown by AbstractBag::offsetSet() when a null offset is used (the
ArrayAccess append form). Bags are always string-keyed, so an
auto-indexed write could never be addressed by the caller.
- `\Exception`
- [`Phalcon\Http\Request\Exception`](#httprequestexception)
- **`Phalcon\Http\Request\Exceptions\NullKeyException`**
`Phalcon\Http\Request\Exception`
### Method Summary
- `public __construct()`
### Methods
__construct()
```php
public function __construct();
```
## Http\Request\Exceptions\SanitizerNotFound
Class
- `\Exception`
- [`Phalcon\Http\Request\Exception`](#httprequestexception)
- **`Phalcon\Http\Request\Exceptions\SanitizerNotFound`**
`Phalcon\Http\Request\Exception`
### Method Summary
- `public __construct(string $sanitizer)`
### Methods
__construct()
```php
public function __construct( string $sanitizer );
```
## Http\Request\File
Class
Phalcon\Http\Request\File
Provides OO wrappers to the $_FILES superglobal
```php
use Phalcon\Mvc\Controller;
class PostsController extends Controller
{
public function uploadAction()
{
// Check if the user has uploaded files
if ($this->request->hasFiles() == true) {
// Print the real file names and their sizes
foreach ($this->request->getUploadedFiles() as $file) {
echo $file->getName(), " ", $file->getSize(), "\n";
}
}
}
}
```
- **`Phalcon\Http\Request\File`** - implements [`Phalcon\Http\Request\FileInterface`](#httprequestfileinterface)
`Phalcon\Contracts\Http\HttpTypes` · `Phalcon\Traits\Support\Helper\Arr\GetTrait`
### Method Summary
- `public __construct(array $file, string $key = "")` — Constructor
- `public getError(): int`
- `public getExtension(): string`
- `public getKey(): string`
- `public getName(): string` — Returns the real name of the uploaded file
- `public getRealType(): string` — Gets the real mime type of the upload file using finfo
- `public getSize(): int` — Returns the file size of the uploaded file
- `public getTempName(): string` — Returns the temporary name of the uploaded file
- `public getType(): string` — Returns the mime type reported by the browser
- `public isUploadedFile(): bool` — Checks whether the file has been uploaded via Post.
- `public moveTo(string $destination): bool` — Moves the temporary file to a destination within the application
### Properties
- `protected int $error = 0`
- `protected string $extension = ""`
- `protected string $key = ""`
- `protected string $name = ""`
- `protected string $realType`
- `protected int $size = 0`
- `protected string $tmpName = ""`
- `protected string $type = ""`
### Methods
__construct()
```php
public function __construct(
array $file,
string $key = ""
);
```
Constructor
getError()
```php
public function getError(): int;
```
getExtension()
```php
public function getExtension(): string;
```
getKey()
```php
public function getKey(): string;
```
getName()
```php
public function getName(): string;
```
Returns the real name of the uploaded file
getRealType()
```php
public function getRealType(): string;
```
Gets the real mime type of the upload file using finfo
getSize()
```php
public function getSize(): int;
```
Returns the file size of the uploaded file
getTempName()
```php
public function getTempName(): string;
```
Returns the temporary name of the uploaded file
getType()
```php
public function getType(): string;
```
Returns the mime type reported by the browser
This mime type is not completely secure, use getRealType() instead
isUploadedFile()
```php
public function isUploadedFile(): bool;
```
Checks whether the file has been uploaded via Post.
moveTo()
```php
public function moveTo( string $destination ): bool;
```
Moves the temporary file to a destination within the application
## Http\Request\FileInterface
Interface
Interface for Phalcon\Http\Request\File
- **`Phalcon\Http\Request\FileInterface`**
### Method Summary
- `public getError(): int` — Returns the error if any
- `public getName(): string` — Returns the real name of the uploaded file
- `public getRealType(): string` — Gets the real mime type of the upload file using finfo
- `public getSize(): int` — Returns the file size of the uploaded file
- `public getTempName(): string` — Returns the temporal name of the uploaded file
- `public getType(): string` — Returns the mime type reported by the browser
- `public moveTo(string $destination): bool` — Move the temporary file to a destination
### Methods
getError()
```php
public function getError(): int;
```
Returns the error if any
getName()
```php
public function getName(): string;
```
Returns the real name of the uploaded file
getRealType()
```php
public function getRealType(): string;
```
Gets the real mime type of the upload file using finfo
getSize()
```php
public function getSize(): int;
```
Returns the file size of the uploaded file
getTempName()
```php
public function getTempName(): string;
```
Returns the temporal name of the uploaded file
getType()
```php
public function getType(): string;
```
Returns the mime type reported by the browser
This mime type is not completely secure, use getRealType() instead
moveTo()
```php
public function moveTo( string $destination ): bool;
```
Move the temporary file to a destination
## Http\Response
Class
Part of the HTTP cycle is return responses to the clients.
Phalcon\HTTP\Response is the Phalcon component responsible to achieve this
task. HTTP responses are usually composed by headers and body.
```php
$response = new \Phalcon\Http\Response();
$response->setStatusCode(200, "OK");
$response->setContent("Hello");
$response->send();
```
- **`Phalcon\Http\Response`** - implements [`Phalcon\Http\ResponseInterface`](#httpresponseinterface), [`Phalcon\Di\InjectionAwareInterface`](/5.23/api/phalcon_di/#diinjectionawareinterface), [`Phalcon\Events\EventsAwareInterface`](/5.23/api/phalcon_events/#eventseventsawareinterface), [`Phalcon\Http\Message\ResponseStatusCodeInterface`](#httpmessageresponsestatuscodeinterface)
`DateTime` · `DateTimeZone` · `Phalcon\Di\Di` · `Phalcon\Di\DiInterface` · `Phalcon\Di\InjectionAwareInterface` · `Phalcon\Events\EventsAwareInterface` · `Phalcon\Events\ManagerInterface` · `Phalcon\Events\Traits\EventsAwareTrait` · `Phalcon\Http\Message\ResponseStatusCodeInterface` · `Phalcon\Http\Response\CookiesInterface` · `Phalcon\Http\Response\Exception` · `Phalcon\Http\Response\Exceptions\NonStandardStatusCodeRequiresMessage` · `Phalcon\Http\Response\Exceptions\ResponseAlreadySent` · `Phalcon\Http\Response\Exceptions\UrlServiceUnavailable` · `Phalcon\Http\Response\Headers` · `Phalcon\Http\Response\HeadersInterface` · `Phalcon\Http\Traits\StatusPhrasesTrait` · `Phalcon\Mvc\Url\UrlInterface` · `Phalcon\Mvc\ViewInterface` · `Phalcon\Support\Helper\File\Basename` · `Phalcon\Support\Helper\Json\Encode` · `Phalcon\Traits\Php\InfoTrait` · `Phalcon\Traits\Php\UrlTrait`
### Method Summary
- `public __construct(string|null $content = null, mixed $code = null, mixed $status = null)` — Constructor
- `public appendContent(mixed $content): ResponseInterface` — Appends a string to the HTTP response body
- `public getContent(): string` — Gets the HTTP response body
- `public getCookies(): CookiesInterface` — Returns cookies set by the user
- `public getDI(): DiInterface` — Returns the internal dependency injector
- `public getHeaders(): HeadersInterface` — Returns headers set by the user
- `public getReasonPhrase(): string|null` — Returns the reason phrase
- `public getStatusCode(): int|null` — Returns the status code
- `public hasHeader(string $name): bool` — Checks if a header exists
- `public isSent(): bool` — Check if the response is already sent
- `public redirect(mixed $location = null, bool $externalRedirect = false, int $statusCode = 302): ResponseInterface` — Redirect by HTTP to another action or URL
- `public removeHeader(string $name): ResponseInterface` — Remove a header in the response
- `public resetHeaders(): ResponseInterface` — Resets all the established headers
- `public send(): ResponseInterface` — Prints out HTTP response to the client
- `public sendCookies(): ResponseInterface` — Sends cookies to the client
- `public sendHeaders(): bool|ResponseInterface` — Sends headers to the client
- `public setCache(int $minutes): ResponseInterface` — Sets Cache headers to use HTTP cache
- `public setContent(string $content): ResponseInterface` — Sets HTTP response body
- `public setContentLength(int $contentLength): ResponseInterface` — Sets the response content-length
- `public setContentType(string $contentType, string|null $charset = null): ResponseInterface` — Sets the response content-type mime, optionally the charset
- `public setCookies(CookiesInterface $cookies): ResponseInterface` — Sets a cookies bag for the response externally
- `public setDI(DiInterface $container): void` — Sets the dependency injector
- `public setEtag(string $etag): ResponseInterface` — Set a custom ETag
- `public setExpires(DateTime $datetime): ResponseInterface` — Sets an Expires header in the response that allows to use the HTTP cache
- `public setFileToSend(string $filePath, mixed $attachmentName = null, bool $attachment = true): ResponseInterface` — Sets an attached file to be sent at the end of the request
- `public setHeader(string $name, mixed $value): ResponseInterface` — Overwrites a header in the response
- `public setHeaders(HeadersInterface $headers): ResponseInterface` — Sets a headers bag for the response externally
- `public setJsonContent(mixed $content, int $jsonOptions = 0, int $depth = 512): ResponseInterface` — Sets HTTP response body. The parameter is automatically converted to JSON
- `public setLastModified(DateTime $datetime): ResponseInterface` — Sets Last-Modified header
- `public setNotModified(): ResponseInterface` — Sends a Not-Modified response
- `public setRawHeader(string $header): ResponseInterface` — Send a raw header to the response
- `public setStatusCode(int $code, string|null $message = null): ResponseInterface` — Sets the HTTP response code
### Properties
- `protected DiInterface|null $container = null`
- `protected string|null $content = null`
- `protected CookiesInterface|null $cookies = null`
- `protected Encode $encode`
- `protected string|null $file = null`
- `protected Headers $headers`
- `protected bool $sent = false`
### Methods
__construct()
```php
public function __construct(
string|null $content = null,
mixed $code = null,
mixed $status = null
);
```
Constructor
appendContent()
```php
public function appendContent( mixed $content ): ResponseInterface;
```
Appends a string to the HTTP response body
getContent()
```php
public function getContent(): string;
```
Gets the HTTP response body
getCookies()
```php
public function getCookies(): CookiesInterface;
```
Returns cookies set by the user
getDI()
```php
public function getDI(): DiInterface;
```
Returns the internal dependency injector
```php
public function getHeaders(): HeadersInterface;
```
Returns headers set by the user
getReasonPhrase()
```php
public function getReasonPhrase(): string|null;
```
Returns the reason phrase
```php
echo $response->getReasonPhrase();
```
getStatusCode()
```php
public function getStatusCode(): int|null;
```
Returns the status code
```php
echo $response->getStatusCode();
```
```php
public function hasHeader( string $name ): bool;
```
Checks if a header exists
```php
$response->hasHeader("Content-Type");
```
isSent()
```php
public function isSent(): bool;
```
Check if the response is already sent
redirect()
```php
public function redirect(
mixed $location = null,
bool $externalRedirect = false,
int $statusCode = 302
): ResponseInterface;
```
Redirect by HTTP to another action or URL
```php
// Using a string redirect (internal/external)
$response->redirect("posts/index");
$response->redirect("https://en.wikipedia.org", true);
$response->redirect("http://www.example.com/new-location", true, 301);
// Making a redirection based on a named route
$response->redirect(
[
"for" => "index-lang",
"lang" => "jp",
"controller" => "index",
]
);
```
```php
public function removeHeader( string $name ): ResponseInterface;
```
Remove a header in the response
```php
$response->removeHeader("Expires");
```
```php
public function resetHeaders(): ResponseInterface;
```
Resets all the established headers
send()
```php
public function send(): ResponseInterface;
```
Prints out HTTP response to the client
sendCookies()
```php
public function sendCookies(): ResponseInterface;
```
Sends cookies to the client
```php
public function sendHeaders(): bool|ResponseInterface;
```
Sends headers to the client
setCache()
```php
public function setCache( int $minutes ): ResponseInterface;
```
Sets Cache headers to use HTTP cache
```php
$this->response->setCache(60);
```
setContent()
```php
public function setContent( string $content ): ResponseInterface;
```
Sets HTTP response body
```php
$response->setContent("Hello!
");
```
setContentLength()
```php
public function setContentLength( int $contentLength ): ResponseInterface;
```
Sets the response content-length
```php
$response->setContentLength(2048);
```
setContentType()
```php
public function setContentType(
string $contentType,
string|null $charset = null
): ResponseInterface;
```
Sets the response content-type mime, optionally the charset
```php
$response->setContentType("application/pdf");
$response->setContentType("text/plain", "UTF-8");
```
setCookies()
```php
public function setCookies( CookiesInterface $cookies ): ResponseInterface;
```
Sets a cookies bag for the response externally
setDI()
```php
public function setDI( DiInterface $container ): void;
```
Sets the dependency injector
setEtag()
```php
public function setEtag( string $etag ): ResponseInterface;
```
Set a custom ETag
```php
$response->setEtag(
md5(
time()
)
);
```
setExpires()
```php
public function setExpires( DateTime $datetime ): ResponseInterface;
```
Sets an Expires header in the response that allows to use the HTTP cache
```php
$this->response->setExpires(
new DateTime()
);
```
setFileToSend()
```php
public function setFileToSend(
string $filePath,
mixed $attachmentName = null,
bool $attachment = true
): ResponseInterface;
```
Sets an attached file to be sent at the end of the request
```php
public function setHeader(
string $name,
mixed $value
): ResponseInterface;
```
Overwrites a header in the response
```php
$response->setHeader("Content-Type", "text/plain");
```
```php
public function setHeaders( HeadersInterface $headers ): ResponseInterface;
```
Sets a headers bag for the response externally
setJsonContent()
```php
public function setJsonContent(
mixed $content,
int $jsonOptions = 0,
int $depth = 512
): ResponseInterface;
```
Sets HTTP response body. The parameter is automatically converted to JSON
and also sets default header: Content-Type: "application/json; charset=UTF-8"
```php
$response->setJsonContent(
[
"status" => "OK",
]
);
```
setLastModified()
```php
public function setLastModified( DateTime $datetime ): ResponseInterface;
```
Sets Last-Modified header
```php
$this->response->setLastModified(
new DateTime()
);
```
setNotModified()
```php
public function setNotModified(): ResponseInterface;
```
Sends a Not-Modified response
```php
public function setRawHeader( string $header ): ResponseInterface;
```
Send a raw header to the response
```php
$response->setRawHeader("HTTP/1.1 404 Not Found");
```
setStatusCode()
```php
public function setStatusCode(
int $code,
string|null $message = null
): ResponseInterface;
```
Sets the HTTP response code
```php
$response->setStatusCode(404, "Not Found");
```
## Http\ResponseInterface
Interface
Phalcon\Http\Response
Interface for Phalcon\Http\Response
- **`Phalcon\Http\ResponseInterface`**
`DateTime` · `Phalcon\Http\Response\HeadersInterface`
### Method Summary
- `public appendContent(string $content): ResponseInterface` — Appends a string to the HTTP response body
- `public getContent(): string` — Gets the HTTP response body
- `public getHeaders(): HeadersInterface` — Returns headers set by the user
- `public getStatusCode(): int|null` — Returns the status code
- `public hasHeader(string $name): bool` — Checks if a header exists
- `public isSent(): bool` — Checks if the response was already sent
- `public redirect(string|null $location = null, bool $externalRedirect = false, int $statusCode = 302): ResponseInterface` — Redirect by HTTP to another action or URL
- `public resetHeaders(): ResponseInterface` — Resets all the established headers
- `public send(): ResponseInterface` — Prints out HTTP response to the client
- `public sendCookies(): ResponseInterface` — Sends cookies to the client
- `public sendHeaders(): bool|ResponseInterface` — Sends headers to the client
- `public setContent(string $content): ResponseInterface` — Sets HTTP response body
- `public setContentLength(int $contentLength): ResponseInterface` — Sets the response content-length
- `public setContentType(string $contentType, string|null $charset = null): ResponseInterface` — Sets the response content-type mime, optionally the charset
- `public setExpires(DateTime $datetime): ResponseInterface` — Sets output expire time header
- `public setFileToSend(string $filePath, string|null $attachmentName = null): ResponseInterface` — Sets an attached file to be sent at the end of the request
- `public setHeader(string $name, string $value): ResponseInterface` — Overwrites a header in the response
- `public setJsonContent(mixed $content): ResponseInterface` — Sets HTTP response body. The parameter is automatically converted to JSON
- `public setNotModified(): ResponseInterface` — Sends a Not-Modified response
- `public setRawHeader(string $header): ResponseInterface` — Send a raw header to the response
- `public setStatusCode(int $code, string|null $message = null): ResponseInterface` — Sets the HTTP response code
### Methods
appendContent()
```php
public function appendContent( string $content ): ResponseInterface;
```
Appends a string to the HTTP response body
getContent()
```php
public function getContent(): string;
```
Gets the HTTP response body
```php
public function getHeaders(): HeadersInterface;
```
Returns headers set by the user
getStatusCode()
```php
public function getStatusCode(): int|null;
```
Returns the status code
```php
public function hasHeader( string $name ): bool;
```
Checks if a header exists
isSent()
```php
public function isSent(): bool;
```
Checks if the response was already sent
redirect()
```php
public function redirect(
string|null $location = null,
bool $externalRedirect = false,
int $statusCode = 302
): ResponseInterface;
```
Redirect by HTTP to another action or URL
```php
public function resetHeaders(): ResponseInterface;
```
Resets all the established headers
send()
```php
public function send(): ResponseInterface;
```
Prints out HTTP response to the client
sendCookies()
```php
public function sendCookies(): ResponseInterface;
```
Sends cookies to the client
```php
public function sendHeaders(): bool|ResponseInterface;
```
Sends headers to the client
setContent()
```php
public function setContent( string $content ): ResponseInterface;
```
Sets HTTP response body
setContentLength()
```php
public function setContentLength( int $contentLength ): ResponseInterface;
```
Sets the response content-length
setContentType()
```php
public function setContentType(
string $contentType,
string|null $charset = null
): ResponseInterface;
```
Sets the response content-type mime, optionally the charset
@todo check the null
setExpires()
```php
public function setExpires( DateTime $datetime ): ResponseInterface;
```
Sets output expire time header
setFileToSend()
```php
public function setFileToSend(
string $filePath,
string|null $attachmentName = null
): ResponseInterface;
```
Sets an attached file to be sent at the end of the request
@todo check the null
```php
public function setHeader(
string $name,
string $value
): ResponseInterface;
```
Overwrites a header in the response
setJsonContent()
```php
public function setJsonContent( mixed $content ): ResponseInterface;
```
Sets HTTP response body. The parameter is automatically converted to JSON
```php
$response->setJsonContent(
[
"status" => "OK",
]
);
```
@todo check the parameter type
setNotModified()
```php
public function setNotModified(): ResponseInterface;
```
Sends a Not-Modified response
```php
public function setRawHeader( string $header ): ResponseInterface;
```
Send a raw header to the response
setStatusCode()
```php
public function setStatusCode(
int $code,
string|null $message = null
): ResponseInterface;
```
Sets the HTTP response code
@todo change $message to only string
## Http\Response\Cookies
Class
This class is a bag to manage the cookies.
A cookies bag is automatically registered as part of the 'response' service
in the DI. By default, cookies are automatically encrypted before being sent
to the client and are decrypted when retrieved from the user. To set sign key
used to generate a message authentication code use
`Phalcon\Http\Response\Cookies::setSignKey()`.
```php
use Phalcon\Di\Di;
use Phalcon\Encryption\Crypt;
use Phalcon\Http\Response\Cookies;
$di = new Di();
$di->set(
'crypt',
function () {
$crypt = new Crypt();
// The `$key' should have been previously generated in a
// cryptographically safe way.
$key =
"T4\xb1\x8d\xa9\x98\x05\\\x8c\xbe\x1d\x07&[\x99\x18\xa4~Lc1\xbeW\xb3";
$crypt->setKey($key);
return $crypt;
}
);
$di->set(
'cookies',
function () {
$cookies = new Cookies();
// The `$key' MUST be at least 32 characters long and generated
// using a cryptographically secure pseudo random generator.
$key =
"#1dj8$=dp?.ak//j1V$~%*0XaK\xb1\x8d\xa9\x98\x054t7w!z%C*F-Jk\x98\x05\\\x5c";
$cookies->setSignKey($key);
return $cookies;
}
);
```
- `\stdClass`
- [`Phalcon\Di\AbstractInjectionAware`](/5.23/api/phalcon_di/#diabstractinjectionaware)
- **`Phalcon\Http\Response\Cookies`** - implements [`Phalcon\Http\Response\CookiesInterface`](#httpresponsecookiesinterface)
`Phalcon\Contracts\Http\HttpTypes` · `Phalcon\Di\AbstractInjectionAware` · `Phalcon\Di\DiInterface` · `Phalcon\Http\Cookie` · `Phalcon\Http\Cookie\CookieInterface` · `Phalcon\Http\Cookie\Exception` · `Phalcon\Http\Response\Exceptions\ResponseServiceUnavailable` · `Phalcon\Http\Traits\EncryptionAwareTrait`
### Method Summary
- `public __construct(bool $useEncryption = true, string|null $signKey = null)` — Constructor
- `public delete(string $name): bool` — Deletes a cookie by its name
- `public get(string $name): CookieInterface` — Gets a cookie from the bag
- `public getCookies(): array` — Gets all cookies from the bag
- `public has(string $name): bool` — Check if a cookie is defined in the bag or exists in the \_COOKIE
- `public isSent(): bool` — Returns if the headers have already been sent
- `public reset(): CookiesInterface` — Reset set cookies
- `public send(): bool` — Sends the cookies to the client
- `public set(string $name, mixed $value = null, int $expire = 0, string $path = "/", bool $secure = false, string $domain = "", bool $httpOnly = false, array $options = []): CookiesInterface` — Sets a cookie to be sent at the end of the request.
- `public setSignKey(string|null $signKey = null): CookiesInterface` — Sets the cookie's sign key.
- `public useEncryption(bool $useEncryption): CookiesInterface` — Set if cookies in the bag must be automatically encrypted/decrypted
### Properties
- `protected array $cookies = []`
- `protected bool $isRegistered = false`
- `protected bool $isSent = false`
- `protected string|null $signKey = null` — The cookie's sign key.
### Methods
__construct()
```php
public function __construct(
bool $useEncryption = true,
string|null $signKey = null
);
```
Constructor
delete()
```php
public function delete( string $name ): bool;
```
Deletes a cookie by its name
This method does not remove cookies from the _COOKIE super-global
get()
```php
public function get( string $name ): CookieInterface;
```
Gets a cookie from the bag
getCookies()
```php
public function getCookies(): array;
```
Gets all cookies from the bag
has()
```php
public function has( string $name ): bool;
```
Check if a cookie is defined in the bag or exists in the _COOKIE
super-global
isSent()
```php
public function isSent(): bool;
```
Returns if the headers have already been sent
reset()
```php
public function reset(): CookiesInterface;
```
Reset set cookies
send()
```php
public function send(): bool;
```
Sends the cookies to the client
Cookies aren't sent if headers are sent in the current request
set()
```php
public function set(
string $name,
mixed $value = null,
int $expire = 0,
string $path = "/",
bool $secure = false,
string $domain = "",
bool $httpOnly = false,
array $options = []
): CookiesInterface;
```
Sets a cookie to be sent at the end of the request.
This method overrides any cookie set before with the same name.
```php
use Phalcon\Http\Response\Cookies;
$now = new DateTimeImmutable();
$tomorrow = $now->modify('tomorrow');
$cookies = new Cookies();
$cookies->set(
'remember-me',
json_encode(['user_id' => 1]),
(int) $tomorrow->format('U'),
);
```
setSignKey()
```php
public function setSignKey( string|null $signKey = null ): CookiesInterface;
```
Sets the cookie's sign key.
The `$signKey' MUST be at least 32 characters long
and generated using a cryptographically secure pseudo random generator.
Use NULL to disable cookie signing.
@see \Phalcon\Encryption\Security\Random
useEncryption()
```php
public function useEncryption( bool $useEncryption ): CookiesInterface;
```
Set if cookies in the bag must be automatically encrypted/decrypted
## Http\Response\CookiesInterface
Interface
Interface for Phalcon\Http\Response\Cookies
- **`Phalcon\Http\Response\CookiesInterface`**
`Phalcon\Contracts\Http\HttpTypes` · `Phalcon\Http\Cookie\CookieInterface`
### Method Summary
- `public delete(string $name): bool` — Deletes a cookie by its name
- `public get(string $name): CookieInterface` — Gets a cookie from the bag
- `public has(string $name): bool` — Check if a cookie is defined in the bag or exists in the \_COOKIE superglobal
- `public isUsingEncryption(): bool` — Returns if the bag is automatically encrypting/decrypting cookies
- `public reset(): CookiesInterface` — Reset set cookies
- `public send(): bool` — Sends the cookies to the client
- `public set(string $name, mixed $value = null, int $expire = 0, string $path = "/", bool $secure = false, string $domain = "", bool $httpOnly = false, array $options = []): CookiesInterface` — Sets a cookie to be sent at the end of the request
- `public useEncryption(bool $useEncryption): CookiesInterface` — Set if cookies in the bag must be automatically encrypted/decrypted
### Methods
delete()
```php
public function delete( string $name ): bool;
```
Deletes a cookie by its name
This method does not removes cookies from the _COOKIE superglobal
get()
```php
public function get( string $name ): CookieInterface;
```
Gets a cookie from the bag
has()
```php
public function has( string $name ): bool;
```
Check if a cookie is defined in the bag or exists in the _COOKIE superglobal
isUsingEncryption()
```php
public function isUsingEncryption(): bool;
```
Returns if the bag is automatically encrypting/decrypting cookies
reset()
```php
public function reset(): CookiesInterface;
```
Reset set cookies
send()
```php
public function send(): bool;
```
Sends the cookies to the client
set()
```php
public function set(
string $name,
mixed $value = null,
int $expire = 0,
string $path = "/",
bool $secure = false,
string $domain = "",
bool $httpOnly = false,
array $options = []
): CookiesInterface;
```
Sets a cookie to be sent at the end of the request
useEncryption()
```php
public function useEncryption( bool $useEncryption ): CookiesInterface;
```
Set if cookies in the bag must be automatically encrypted/decrypted
## Http\Response\Exception
Class
Phalcon\Http\Response\Exception
Exceptions thrown in Phalcon\Http\Response will use this class.
- `\Exception`
- **`Phalcon\Http\Response\Exception`**
- [`Phalcon\Http\Response\Exceptions\NonStandardStatusCodeRequiresMessage`](#httpresponseexceptionsnonstandardstatuscoderequiresmessage)
- [`Phalcon\Http\Response\Exceptions\ResponseAlreadySent`](#httpresponseexceptionsresponsealreadysent)
- [`Phalcon\Http\Response\Exceptions\ResponseServiceUnavailable`](#httpresponseexceptionsresponseserviceunavailable)
- [`Phalcon\Http\Response\Exceptions\UrlServiceUnavailable`](#httpresponseexceptionsurlserviceunavailable)
## Http\Response\Exceptions\NonStandardStatusCodeRequiresMessage
Class
- `\Exception`
- [`Phalcon\Http\Response\Exception`](#httpresponseexception)
- **`Phalcon\Http\Response\Exceptions\NonStandardStatusCodeRequiresMessage`**
`Phalcon\Http\Response\Exception`
### Method Summary
- `public __construct()`
### Methods
__construct()
```php
public function __construct();
```
## Http\Response\Exceptions\ResponseAlreadySent
Class
- `\Exception`
- [`Phalcon\Http\Response\Exception`](#httpresponseexception)
- **`Phalcon\Http\Response\Exceptions\ResponseAlreadySent`**
`Phalcon\Http\Response\Exception`
### Method Summary
- `public __construct()`
### Methods
__construct()
```php
public function __construct();
```
## Http\Response\Exceptions\ResponseServiceUnavailable
Class
- `\Exception`
- [`Phalcon\Http\Response\Exception`](#httpresponseexception)
- **`Phalcon\Http\Response\Exceptions\ResponseServiceUnavailable`**
`Phalcon\Http\Response\Exception`
### Method Summary
- `public __construct()`
### Methods
__construct()
```php
public function __construct();
```
## Http\Response\Exceptions\UrlServiceUnavailable
Class
- `\Exception`
- [`Phalcon\Http\Response\Exception`](#httpresponseexception)
- **`Phalcon\Http\Response\Exceptions\UrlServiceUnavailable`**
`Phalcon\Http\Response\Exception`
### Method Summary
- `public __construct()`
### Methods
__construct()
```php
public function __construct();
```
## Http\Response\Headers
Class
This class is a bag to manage the response headers
@implements IteratorAggregate<string, string|null>
- **`Phalcon\Http\Response\Headers`** - implements [`Phalcon\Http\Response\HeadersInterface`](#httpresponseheadersinterface), `\IteratorAggregate`
`IteratorAggregate` · `Phalcon\Contracts\Http\HttpTypes` · `Traversable`
### Method Summary
- `public get(string $name): bool|string|null` — Gets a header value from the internal bag
- `public getIterator(): Traversable`
- `public has(string $name): bool` — Checks if a header exists
- `public isSent(): bool` — Returns if the headers have already been sent
- `public remove(string $header): HeadersInterface` — Removes a header by its name
- `public reset(): void` — Reset set headers
- `public send(): bool` — Sends the headers to the client
- `public set(string $name, string $value): HeadersInterface` — Sets a header to be sent at the end of the request
- `public setRaw(string $header): HeadersInterface` — Sets a raw header to be sent at the end of the request
- `public toArray(): array` — Returns the current headers as an array
### Properties
- `protected array $headers = []`
- `protected bool $isSent = false`
### Methods
```php
public function get( string $name ): bool|string|null;
```
Gets a header value from the internal bag
```php
public function getIterator(): Traversable;
```
```php
public function has( string $name ): bool;
```
Checks if a header exists
```php
public function isSent(): bool;
```
Returns if the headers have already been sent
```php
public function remove( string $header ): HeadersInterface;
```
Removes a header by its name
```php
public function reset(): void;
```
Reset set headers
```php
public function send(): bool;
```
Sends the headers to the client
```php
public function set(
string $name,
string $value
): HeadersInterface;
```
Sets a header to be sent at the end of the request
```php
public function setRaw( string $header ): HeadersInterface;
```
Sets a raw header to be sent at the end of the request
```php
public function toArray(): array;
```
Returns the current headers as an array
## Http\Response\HeadersInterface
Interface
Interface for Phalcon\Http\Response\Headers compatible bags
- **`Phalcon\Http\Response\HeadersInterface`**
### Method Summary
- `public get(string $name): bool|string|null` — Gets a header value from the internal bag
- `public has(string $name): bool` — Checks if a header exists
- `public reset(): void` — Reset set headers
- `public send(): bool` — Sends the headers to the client
- `public set(string $name, string $value): HeadersInterface` — Sets a header to be sent at the end of the request
- `public setRaw(string $header): HeadersInterface` — Sets a raw header to be sent at the end of the request
### Methods
```php
public function get( string $name ): bool|string|null;
```
Gets a header value from the internal bag
```php
public function has( string $name ): bool;
```
Checks if a header exists
```php
public function reset(): void;
```
Reset set headers
```php
public function send(): bool;
```
Sends the headers to the client
```php
public function set(
string $name,
string $value
): HeadersInterface;
```
Sets a header to be sent at the end of the request
```php
public function setRaw( string $header ): HeadersInterface;
```
Sets a raw header to be sent at the end of the request
## Http\Traits\EncryptionAwareTrait
Trait
Provides the implicit encryption flag and its accessor shared by the HTTP
cookie classes.
- **`Phalcon\Http\Traits\EncryptionAwareTrait`**
[`Phalcon\Http\Cookie`](#httpcookie) · [`Phalcon\Http\Response\Cookies`](#httpresponsecookies)
### Method Summary
- `public isUsingEncryption(): bool` — Check if implicit encryption is being used
### Properties
- `protected bool $useEncryption = false`
### Methods
isUsingEncryption()
```php
public function isUsingEncryption(): bool;
```
Check if implicit encryption is being used
## Http\Traits\StatusPhrasesTrait
Trait
Status Phrases trait
- **`Phalcon\Http\Traits\StatusPhrasesTrait`**
`Phalcon\Http\Message\ResponseStatusCodeInterface`
[`Phalcon\Http\Response`](#httpresponse)
### Method Summary
- `protected getPhrases(): array` — Returns the list of status codes available
### Methods
getPhrases()
```php
protected function getPhrases(): array;
```
Returns the list of status codes available
Source: https://docs.phalcon.io/5.23/api/phalcon_http/index.mdx