Phalcon Http

Http\Cookie

Provide OO wrappers to manage a HTTP cookie.

Uses 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

Properties

Methods

__construct()

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()

public function __toString(): string;

Magic __toString method converts the cookie’s value to string

delete()

public function delete(): void;

Deletes the cookie by setting an expiration time in the past

getDomain()

public function getDomain(): string;

Returns the domain that the cookie is available to

getExpiration()

public function getExpiration(): int;

Returns the current expiration time

getHttpOnly()

public function getHttpOnly(): bool;

Returns if the cookie is accessible only through the HTTP protocol

getName()

public function getName(): string;

Returns the current cookie’s name

getOptions()

public function getOptions(): array;

Returns the current cookie’s options

getPath()

public function getPath(): string;

Returns the current cookie’s path

getSecure()

public function getSecure(): bool;

Returns whether the cookie must only be sent when the connection is secure (HTTPS)

getValue()

public function getValue(
    mixed $filters = null,
    mixed $defaultValue = null
): mixed;

Returns the cookie’s value.

@todo filters needs to be array/string

restore()

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()

public function send(): CookieInterface;

Sends the cookie to the HTTP client.

Stores the cookie definition in session.

setDomain()

public function setDomain( string $domain ): CookieInterface;

Sets the domain that the cookie is available to

setExpiration()

public function setExpiration( int $expire ): CookieInterface;

Sets the cookie’s expiration time

setHttpOnly()

public function setHttpOnly( bool $httpOnly ): CookieInterface;

Sets if the cookie is accessible only through the HTTP protocol

setOptions()

public function setOptions( array $options ): CookieInterface;

Sets the cookie’s options

setPath()

public function setPath( string $path ): CookieInterface;

Sets the cookie’s path

setSecure()

public function setSecure( bool $secure ): CookieInterface;

Sets if the cookie must only be sent when the connection is secure (HTTPS)

setSignKey()

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()

public function setValue( mixed $value ): CookieInterface;

Sets the cookie’s value

useEncryption()

public function useEncryption( bool $useEncryption ): CookieInterface;

Sets if the cookie must be encrypted/decrypted automatically

assertSignKeyIsLongEnough()

protected function assertSignKeyIsLongEnough( string $signKey ): void;

Assert the cookie’s key is enough long.

Http\Cookie\CookieInterface

Interface for Phalcon\Http\Cookie

Uses Phalcon\Contracts\Http\HttpTypes

Method Summary

Methods

delete()

public function delete(): void;

Deletes the cookie

getDomain()

public function getDomain(): string;

Returns the domain that the cookie is available to

getExpiration()

public function getExpiration(): int;

Returns the current expiration time

getHttpOnly()

public function getHttpOnly(): bool;

Returns if the cookie is accessible only through the HTTP protocol

getName()

public function getName(): string;

Returns the current cookie’s name

getOptions()

public function getOptions(): array;

Returns the current cookie’s options

getPath()

public function getPath(): string;

Returns the current cookie’s path

getSecure()

public function getSecure(): bool;

Returns whether the cookie must only be sent when the connection is secure (HTTPS)

getValue()

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()

public function isUsingEncryption(): bool;

Check if the cookie is using implicit encryption

send()

public function send(): CookieInterface;

Sends the cookie to the HTTP client

setDomain()

public function setDomain( string $domain ): CookieInterface;

Sets the domain that the cookie is available to

setExpiration()

public function setExpiration( int $expire ): CookieInterface;

Sets the cookie’s expiration time

setHttpOnly()

public function setHttpOnly( bool $httpOnly ): CookieInterface;

Sets if the cookie is accessible only through the HTTP protocol

setOptions()

public function setOptions( array $options ): CookieInterface;

Sets the cookie’s options

setPath()

public function setPath( string $path ): CookieInterface;

Sets the cookie’s expiration time

setSecure()

public function setSecure( bool $secure ): CookieInterface;

Sets if the cookie must only be sent when the connection is secure (HTTPS)

setValue()

public function setValue( mixed $value ): CookieInterface;

Sets the cookie’s value

@todo check if we can make this a string

useEncryption()

public function useEncryption( bool $useEncryption ): CookieInterface;

Sets if the cookie must be encrypted/decrypted automatically

Http\Cookie\Exception

Phalcon\Http\Cookie\Exception

Exceptions thrown in Phalcon\Http\Cookie will use this class.

Http\Cookie\Exceptions\CookieKeyTooShort

Uses Phalcon\Http\Cookie\Exception

Method Summary

Methods

__construct()

public function __construct( int $length );

Http\Cookie\Exceptions\CryptInterfaceRequired

Uses Phalcon\Http\Cookie\Exception

Method Summary

Methods

__construct()

public function __construct();

Http\Cookie\Exceptions\CryptServiceUnavailable

Uses Phalcon\Http\Cookie\Exception

Method Summary

Methods

__construct()

public function __construct();

Http\Cookie\Exceptions\FilterServiceUnavailable

Uses Phalcon\Http\Cookie\Exception

Method Summary

Methods

__construct()

public function __construct();

Http\Message\RequestMethodInterface

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

Constants

Http\Message\ResponseStatusCodeInterface

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

Constants

Http\Request

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.

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();

Uses 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

Properties

Methods

get()

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

// 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()

public function getAcceptableContent(): array;

Gets an array with mime/types and their quality accepted by the browser/client from _SERVER[“HTTP_ACCEPT”]

getAttributes()

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.

$request->getAttributes()->set("user", $user);

$user = $request->getAttributes()->get("user");

getBasicAuth()

public function getBasicAuth(): array|null;

Gets auth info accepted by the browser/client from $_SERVER[“PHP_AUTH_USER”]

getBestAccept()

public function getBestAccept(): string;

Gets best mime/type accepted by the browser/client from _SERVER[“HTTP_ACCEPT”]

getBestCharset()

public function getBestCharset(): string;

Gets best charset accepted by the browser/client from _SERVER[“HTTP_ACCEPT_CHARSET”]

getBestLanguage()

public function getBestLanguage(): string;

Gets the best language accepted by the browser/client from _SERVER[“HTTP_ACCEPT_LANGUAGE”]

getClientAddress()

public function getClientAddress( bool $trustForwardedHeader = false ): string|bool;

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()

public function getClientCharsets(): array;

Gets a charsets array and their quality accepted by the browser/client from _SERVER[“HTTP_ACCEPT_CHARSET”]

getContentType()

public function getContentType(): string|null;

Gets content type which request has been made

getDigestAuth()

public function getDigestAuth(): array;

Gets auth info accepted by the browser/client from $_SERVER[“PHP_AUTH_DIGEST”]

getFilteredData()

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()

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()

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()

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()

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()

public function getHTTPReferer(): string;

Gets web page that refers active request. ie: http://www.google.com

getHeader()

public function getHeader( string $header ): string;

Gets HTTP header from request data

getHeaders()

public function getHeaders(): array;

Returns the available headers in the request

$_SERVER = [
    "PHP_AUTH_USER" => "phalcon",
    "PHP_AUTH_PW"   => "secret",
];

$headers = $request->getHeaders();

echo $headers["Authorization"]; // Basic cGhhbGNvbjpzZWNyZXQ=

getHttpHost()

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.

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()

public function getHttpMethodParameterOverride(): bool;

Return the HTTP method parameter override flag

getJsonRawBody()

public function getJsonRawBody( bool $associative = false ): \stdClass|array|bool;

Gets decoded JSON HTTP raw request body

getLanguages()

public function getLanguages(): array;

Gets languages array and their quality accepted by the browser/client from _SERVER[“HTTP_ACCEPT_LANGUAGE”]

getMethod()

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()

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

// 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()

public function getPort(): int;

Gets information about the port on which the request is made.

getPost()

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

// 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()

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()

public function getPut(
    string|null $name = null,
    mixed $filters = null,
    mixed $defaultValue = null,
    bool $notAllowEmpty = false,
    bool $noRecursive = false
): mixed;

Gets a variable from the PUT request

// 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");

getQuery()

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

// 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()

public function getRawBody(): string;

Gets HTTP raw request body

getScheme()

public function getScheme(): string;

Gets HTTP schema (http/https)

getServer()

public function getServer( string $name ): string|null;

Gets variable from $_SERVER superglobal

getServerAddress()

public function getServerAddress(): string;

Gets active server address IP

getServerName()

public function getServerName(): string;

Gets active server name

getURI()

public function getURI( bool $onlyPath = false ): string;

Gets HTTP URI which request has been made to

// Returns /some/path?with=queryParams
$uri = $request->getURI();

// Returns /some/path
$uri = $request->getURI(true);

getUploadedFiles()

public function getUploadedFiles(
    bool $onlySuccessful = false,
    bool $namedKeys = false
): FileInterface[];

Gets attached files as Phalcon\Http\Request\File instances

getUserAgent()

public function getUserAgent(): string;

Gets HTTP user agent used to make the request

has()

public function has( string $name ): bool;

Checks whether $_REQUEST superglobal has certain index

hasFiles()

public function hasFiles(): bool;

Returns if the request has files or not

hasHeader()

final public function hasHeader( string $header ): bool;

Checks whether headers has certain index

hasPatch()

public function hasPatch( string $name ): bool;

Checks whether the PATCH data has certain index

hasPost()

public function hasPost( string $name ): bool;

Checks whether $_POST superglobal has certain index

hasPut()

public function hasPut( string $name ): bool;

Checks whether the PUT data has certain index

hasQuery()

public function hasQuery( string $name ): bool;

Checks whether $_GET superglobal has certain index

hasServer()

final public function hasServer( string $name ): bool;

Checks whether $_SERVER superglobal has certain index

isAjax()

public function isAjax(): bool;

Checks whether request has been made using ajax

isConnect()

public function isConnect(): bool;

Checks whether HTTP method is CONNECT. if _SERVER[“REQUEST_METHOD”]===“CONNECT”

isDelete()

public function isDelete(): bool;

Checks whether HTTP method is DELETE. if _SERVER[“REQUEST_METHOD”]===“DELETE”

isGet()

public function isGet(): bool;

Checks whether HTTP method is GET. if _SERVER[“REQUEST_METHOD”]===“GET”

isHead()

public function isHead(): bool;

Checks whether HTTP method is HEAD. if _SERVER[“REQUEST_METHOD”]===“HEAD”

isJson()

public function isJson(): bool;

Checks whether request content type contains json data

isMethod()

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()

public function isOptions(): bool;

Checks whether HTTP method is OPTIONS. if _SERVER[“REQUEST_METHOD”]===“OPTIONS”

isPatch()

public function isPatch(): bool;

Checks whether HTTP method is PATCH. if _SERVER[“REQUEST_METHOD”]===“PATCH”

isPost()

public function isPost(): bool;

Checks whether HTTP method is POST. if _SERVER[“REQUEST_METHOD”]===“POST”

isPurge()

public function isPurge(): bool;

Checks whether HTTP method is PURGE (Squid and Varnish support). if _SERVER[“REQUEST_METHOD”]===“PURGE”

isPut()

public function isPut(): bool;

Checks whether HTTP method is PUT. if _SERVER[“REQUEST_METHOD”]===“PUT”

isSecure()

public function isSecure(): bool;

Checks whether request has been made using any secure layer

isSoap()

public function isSoap(): bool;

Checks whether request has been made using SOAP

isStrictHostCheck()

public function isStrictHostCheck(): bool;

Checks if the Request::getHttpHost method will be use strict validation of host name or not

isTrace()

public function isTrace(): bool;

Checks whether HTTP method is TRACE. if _SERVER[“REQUEST_METHOD”]===“TRACE”

isValidHttpMethod()

public function isValidHttpMethod( string $method ): bool;

Checks if a method is a valid HTTP method

numFiles()

public function numFiles( bool $onlySuccessful = false ): int;

Returns the number of files available

setHttpMethodParameterOverride()

public function setHttpMethodParameterOverride( bool $override ): static;

Set the HTTP method parameter override flag

setParameterFilters()

public function setParameterFilters(
    string $name,
    array $filters = [],
    array $scope = []
): static;

Sets automatic sanitizers/filters for a particular field and for particular methods

setStrictHostCheck()

public function setStrictHostCheck( bool $flag = true ): static;

Sets if the Request::getHttpHost method must be use strict validation of host name or not

setTrustedProxies()

public function setTrustedProxies( array $trustedProxies ): static;

Set a trusted proxy list for X-Forwarded-For header

setTrustedProxyHeader()

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()

protected function getBestQuality(
    array $qualityParts,
    string $name
): string;

Process a request header and return the one with best quality

getHelper()

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.

getQualityHeader()

protected function getQualityHeader(
    string $serverIndex,
    string $name
): array;

Process a request header and return an array of values with their qualities

hasFileHelper()

protected function hasFileHelper(
    mixed $data,
    bool $onlySuccessful
): int;

Recursively counts file in an array of files

isIpAddressInCIDR()

protected function isIpAddressInCIDR(
    string $ip,
    string $cidr
): bool;

Check if an IP address exists in CIDR range

resolveAuthorizationHeaders()

protected function resolveAuthorizationHeaders(): array;

Resolve authorization headers.

smoothFiles()

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 for Phalcon\Http\Request

Uses Phalcon\Contracts\Http\HttpTypes · Phalcon\Http\Request\FileInterface · stdClass

Method Summary

Methods

get()

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

// 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()

public function getAcceptableContent(): array;

Return an array with mime/types and their quality accepted by the browser/client from _SERVER[“HTTP_ACCEPT”]

getBasicAuth()

public function getBasicAuth(): array|null;

Gets auth info accepted by the browser/client from $_SERVER[“PHP_AUTH_USER”]

getBestAccept()

public function getBestAccept(): string;

Return the best mime/type accepted by the browser/client from _SERVER[“HTTP_ACCEPT”]

getBestCharset()

public function getBestCharset(): string;

Return the best charset accepted by the browser/client from _SERVER[“HTTP_ACCEPT_CHARSET”]

getBestLanguage()

public function getBestLanguage(): string;

Return the best language accepted by the browser/client from _SERVER[“HTTP_ACCEPT_LANGUAGE”]

getClientAddress()

public function getClientAddress( bool $trustForwardedHeader = false ): string|bool;

Return the most possible client IPv4 Address. This method searches in $_SERVER[“REMOTE_ADDR”] and optionally in $_SERVER[“HTTP_X_FORWARDED_FOR”]

getClientCharsets()

public function getClientCharsets(): array;

Return a charset array and their quality accepted by the browser/client from _SERVER[“HTTP_ACCEPT_CHARSET”]

getContentType()

public function getContentType(): string|null;

Return the content type which request has been made

getDigestAuth()

public function getDigestAuth(): array;

Return the auth info accepted by the browser/client from $_SERVER[“PHP_AUTH_DIGEST”]

getHTTPReferer()

public function getHTTPReferer(): string;

Return the web page that refers active request. ie: https://phalcon.io

getHeader()

public function getHeader( string $header ): string;

Return the HTTP header from request data

getHeaders()

public function getHeaders(): array;

Returns the available headers in the request

$_SERVER = [
    "PHP_AUTH_USER" => "phalcon",
    "PHP_AUTH_PW"   => "secret",
];

$headers = $request->getHeaders();

echo $headers["Authorization"]; // Basic cGhhbGNvbjpzZWNyZXQ=

getHttpHost()

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.

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()

public function getJsonRawBody( bool $associative = false ): array|bool|stdClass;

Return the decoded JSON HTTP raw request body

getLanguages()

public function getLanguages(): array;

Return the languages array and their quality accepted by the browser/client from _SERVER[“HTTP_ACCEPT_LANGUAGE”]

getMethod()

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()

public function getPort(): int;

Return the information about the port on which the request is made

getPost()

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

// 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()

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

// 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()

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

// 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()

public function getRawBody(): string;

Return the HTTP raw request body

getScheme()

public function getScheme(): string;

Return the HTTP schema (http/https)

getServer()

public function getServer( string $name ): string|null;

Return a variable from $_SERVER superglobal

getServerAddress()

public function getServerAddress(): string;

Return the active server address IP

getServerName()

public function getServerName(): string;

Return the active server name

getURI()

public function getURI( bool $onlyPath = false ): string;

Return the HTTP URI which request has been made to

// Returns /some/path?with=queryParams
$uri = $request->getURI();

// Returns /some/path
$uri = $request->getURI(true);

getUploadedFiles()

public function getUploadedFiles(
    bool $onlySuccessful = false,
    bool $namedKeys = false
): FileInterface[];

Return the attached files as Phalcon\Http\Request\FileInterface compatible instances

getUserAgent()

public function getUserAgent(): string;

Return the HTTP user agent used to make the request

has()

public function has( string $name ): bool;

Return whether the $_REQUEST superglobal has certain index

hasFiles()

public function hasFiles(): bool;

Return whether the request includes attached files

hasHeader()

public function hasHeader( string $header ): bool;

Return whether the headers have a certain index

hasPost()

public function hasPost( string $name ): bool;

Return whether the $_POST superglobal has certain index

hasPut()

public function hasPut( string $name ): bool;

Return whether the PUT data has certain index

hasQuery()

public function hasQuery( string $name ): bool;

Return whether the $_GET superglobal has certain index

hasServer()

public function hasServer( string $name ): bool;

Return whether the $_SERVER superglobal has certain index

isAjax()

public function isAjax(): bool;

Return whether the request has been made using ajax. Checks if $_SERVER[“HTTP_X_REQUESTED_WITH”] === “XMLHttpRequest”

isConnect()

public function isConnect(): bool;

Return whether the HTTP method is CONNECT. if $_SERVER[“REQUEST_METHOD”] === “CONNECT”

isDelete()

public function isDelete(): bool;

Return whether the HTTP method is DELETE. if $_SERVER[“REQUEST_METHOD”] === “DELETE”

isGet()

public function isGet(): bool;

Return whether the HTTP method is GET. if $_SERVER[“REQUEST_METHOD”] === “GET”

isHead()

public function isHead(): bool;

Return whether the HTTP method is HEAD. if $_SERVER[“REQUEST_METHOD”] === “HEAD”

isMethod()

public function isMethod(
    mixed $methods,
    bool $strict = false
): bool;

Return if the current HTTP method matches any of the passed methods

isOptions()

public function isOptions(): bool;

Return whether the HTTP method is OPTIONS. if $_SERVER[“REQUEST_METHOD”] === “OPTIONS”

isPost()

public function isPost(): bool;

Return whether the HTTP method is POST. if $_SERVER[“REQUEST_METHOD”] === “POST”

isPurge()

public function isPurge(): bool;

Return whether the HTTP method is PURGE (Squid and Varnish support). if $_SERVER[“REQUEST_METHOD”] === “PURGE”

isPut()

public function isPut(): bool;

Return whether the HTTP method is PUT. if $_SERVER[“REQUEST_METHOD”] === “PUT”

isSecure()

public function isSecure(): bool;

Return whether the request has been made using any secure layer

isSoap()

public function isSoap(): bool;

Return whether the request has been made using SOAP

isTrace()

public function isTrace(): bool;

Return whether the HTTP method is TRACE. if $_SERVER[“REQUEST_METHOD”] === “TRACE”

numFiles()

public function numFiles( bool $onlySuccessful = false ): int;

Returns the number of files available

Http\Request\Bag\AbstractBag

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>

Uses ArrayAccess · ArrayIterator · Countable · IteratorAggregate · Phalcon\Contracts\Http\HttpTypes · Phalcon\Http\Request\Exceptions\NullKeyException · Traversable

Method Summary

Properties

Methods

__construct()

public function __construct( array $items = [] );

AbstractBag constructor.

all()

public function all(): array;

Returns all the elements of the bag

count()

public function count(): int;

Returns the number of elements in the bag

get()

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()

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()

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()

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()

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()

public function getIterator(): Traversable;

Returns the iterator of the bag

getString()

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()

public function has( mixed $key ): bool;

Checks whether an element exists in the bag

offsetExists()

public function offsetExists( mixed $offset ): bool;

Whether an offset exists

offsetGet()

public function offsetGet( mixed $offset ): mixed;

Offset to retrieve

offsetSet()

public function offsetSet(
    mixed $offset,
    mixed $value
): void;

Offset to set

offsetUnset()

public function offsetUnset( mixed $offset ): void;

Offset to unset

remove()

public function remove( mixed $key ): void;

Removes an element from the bag

set()

public function set(
    mixed $key,
    mixed $value
): void;

Sets an element in the bag

normalizeItems()

protected function normalizeItems( array $items ): array;

Normalizes the items at construction time. Identity in the base; subclasses can override it to normalize keys

normalizeKey()

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

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.

Http\Request\Exception

Phalcon\Http\Request\Exception

Exceptions thrown in Phalcon\Http\Request will use this class

Http\Request\Exceptions\FilterServiceUnavailable

Uses Phalcon\Http\Request\Exception

Method Summary

Methods

__construct()

public function __construct();

Http\Request\Exceptions\InvalidHost

Uses UnexpectedValueException

Method Summary

Methods

__construct()

public function __construct( string $host );

Http\Request\Exceptions\InvalidHttpMethod

Uses Phalcon\Http\Request\Exception

Method Summary

Methods

__construct()

public function __construct( string $method );

Http\Request\Exceptions\MissingFilters

Uses Phalcon\Http\Request\Exception

Method Summary

Methods

__construct()

public function __construct( string $name );

Http\Request\Exceptions\NullKeyException

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.

Uses Phalcon\Http\Request\Exception

Method Summary

Methods

__construct()

public function __construct();

Http\Request\Exceptions\SanitizerNotFound

Uses Phalcon\Http\Request\Exception

Method Summary

Methods

__construct()

public function __construct( string $sanitizer );

Http\Request\File

Phalcon\Http\Request\File

Provides OO wrappers to the $_FILES superglobal

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";
            }
        }
    }
}

Uses Phalcon\Contracts\Http\HttpTypes · Phalcon\Traits\Support\Helper\Arr\GetTrait

Method Summary

Properties

Methods

__construct()

public function __construct(
    array $file,
    string $key = ""
);

Constructor

getError()

public function getError(): int;

getExtension()

public function getExtension(): string;

getKey()

public function getKey(): string;

getName()

public function getName(): string;

Returns the real name of the uploaded file

getRealType()

public function getRealType(): string;

Gets the real mime type of the upload file using finfo

getSize()

public function getSize(): int;

Returns the file size of the uploaded file

getTempName()

public function getTempName(): string;

Returns the temporary name of the uploaded file

getType()

public function getType(): string;

Returns the mime type reported by the browser This mime type is not completely secure, use getRealType() instead

isUploadedFile()

public function isUploadedFile(): bool;

Checks whether the file has been uploaded via Post.

moveTo()

public function moveTo( string $destination ): bool;

Moves the temporary file to a destination within the application

Http\Request\FileInterface

Interface for Phalcon\Http\Request\File

Method Summary

Methods

getError()

public function getError(): int;

Returns the error if any

getName()

public function getName(): string;

Returns the real name of the uploaded file

getRealType()

public function getRealType(): string;

Gets the real mime type of the upload file using finfo

getSize()

public function getSize(): int;

Returns the file size of the uploaded file

getTempName()

public function getTempName(): string;

Returns the temporal name of the uploaded file

getType()

public function getType(): string;

Returns the mime type reported by the browser This mime type is not completely secure, use getRealType() instead

moveTo()

public function moveTo( string $destination ): bool;

Move the temporary file to a destination

Http\Response

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.

$response = new \Phalcon\Http\Response();

$response->setStatusCode(200, "OK");
$response->setContent("<html><body>Hello</body></html>");

$response->send();

Uses 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