Phalcon http

Http\Cookie¶

Class Source on GitHub

Provide OO wrappers to manage a HTTP cookie.

Uses 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¶

Constants¶

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.

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.

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 Source on GitHub

Interface for Phalcon\Http\Cookie

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.

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

useEncryption()¶

public function useEncryption( bool $useEncryption ): CookieInterface;

Sets if the cookie must be encrypted/decrypted automatically

Http\Cookie\Exception¶

Class Source on GitHub

Phalcon\Http\Cookie\Exception

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

Http\Cookie\Exceptions\CookieKeyTooShort¶

Class Source on GitHub

Uses Phalcon\Http\Cookie\Exception

Method Summary¶

Methods¶

__construct()¶

public function __construct( int $length );

Http\Cookie\Exceptions\CryptInterfaceRequired¶

Class Source on GitHub

Uses Phalcon\Http\Cookie\Exception

Method Summary¶

Methods¶

__construct()¶

public function __construct();

Http\Cookie\Exceptions\CryptServiceUnavailable¶

Class Source on GitHub

Uses Phalcon\Http\Cookie\Exception

Method Summary¶

Methods¶

__construct()¶

public function __construct();

Http\Cookie\Exceptions\FilterServiceUnavailable¶

Class Source on GitHub

Uses Phalcon\Http\Cookie\Exception

Method Summary¶

Methods¶

__construct()¶

public function __construct();

Http\Enums\HttpStatusEnum¶

Class Source on GitHub

Status Phrases trait

Method Summary¶

Constants¶

Methods¶

text()¶

public function text(): string;

Http\Message\AbstractCommon¶

Abstract Source on GitHub

Common methods

Uses Phalcon\Http\Message\Exception\InvalidArgumentException

Method Summary¶

Methods¶

checkStringParameter()¶

final protected function checkStringParameter( mixed $element ): void;

Checks the element passed if it is a string

cloneInstance()¶

final protected function cloneInstance(
    mixed $element,
    string $property
);

Returns a new instance having set the parameter

Http\Message\AbstractMessage¶

Abstract Source on GitHub

Message methods

Uses Phalcon\Http\Message\Exception\InvalidArgumentException · Phalcon\Http\Message\Interfaces\MessageInterface · Phalcon\Http\Message\Interfaces\ResponseStatusCodeInterface · Phalcon\Http\Message\Interfaces\StreamInterface

Method Summary¶

Properties¶

Methods¶

getBody()¶

public function getBody(): StreamInterface;

Return the body of the stream

getHeader()¶

public function getHeader( string $name ): array;

Retrieves a message header value by the given case-insensitive name.

This method returns an array of all the header values of the given case-insensitive header name.

If the header does not appear in the message, this method MUST return an empty array.

getHeaderLine()¶

public function getHeaderLine( string $name ): string;

Retrieves a comma-separated string of the values for a single header.

This method returns all the header values of the given case-insensitive header name as a string concatenated together using a comma.

NOTE: Not all header values may be appropriately represented using comma concatenation. For such headers, use getHeader() instead and supply your own delimiter when concatenating.

If the header does not appear in the message, this method MUST return an empty string.

getHeaders()¶

public function getHeaders(): array;

Retrieves all message header values.

The keys represent the header name as it will be sent over the wire, and each value is an array of strings associated with the header.

// Represent the headers as a string
foreach ($message->getHeaders() as $name => $values) {
    echo $name . ': ' . implode(', ', $values);
}

// Emit headers iteratively:
foreach ($message->getHeaders() as $name => $values) {
    foreach ($values as $value) {
        header(sprintf('%s: %s', $name, $value), false);
    }
}

While header names are not case-sensitive, getHeaders() will preserve the exact case in which headers were originally specified.

getProtocolVersion()¶

public function getProtocolVersion(): string;

Returns the protocol version

hasHeader()¶

public function hasHeader( string $name ): bool;

Checks if a header exists by the given case-insensitive name.

withAddedHeader()¶

public function withAddedHeader(
    string $name,
    mixed $value
): MessageInterface;

Return an instance with the specified header appended with the given value.

Existing values for the specified header will be maintained. The new value(s) will be appended to the existing list. If the header did not exist previously, it will be added.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the new header and/or value.

withBody()¶

public function withBody( StreamInterface $body ): MessageInterface;

Return an instance with the specified message body.

The body MUST be a StreamInterface object.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return a new instance that has the new body stream.

withHeader()¶

public function withHeader(
    string $name,
    mixed $value
): MessageInterface;

Return an instance with the provided value replacing the specified header.

While header names are case-insensitive, the casing of the header will be preserved by this function, and returned from getHeaders().

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the new and/or updated header and value.

withProtocolVersion()¶

public function withProtocolVersion( string $version ): MessageInterface;

Return an instance with the specified HTTP protocol version.

The version string MUST contain only the HTTP version number (e.g., '1.1', '1.0').

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the new protocol version.

withoutHeader()¶

public function withoutHeader( string $name ): MessageInterface;

Return an instance without the specified header.

Header resolution MUST be done without case-sensitivity.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that removes the named header.

processBody()¶

final protected function processBody(
    mixed $body = "php://memory",
    string $mode = "r+b"
): StreamInterface;

Set a valid stream

processProtocol()¶

final protected function processProtocol( string $protocol = "" ): string;

Checks the protocol

Http\Message\AbstractRequest¶

Abstract Source on GitHub

Request methods

@property string $method @property string|null $requestTarget @property UriInterface $uri

Uses Phalcon\Http\Message\Exception\InvalidArgumentException · Phalcon\Http\Message\Interfaces\RequestInterface · Phalcon\Http\Message\Interfaces\RequestMethodInterface · Phalcon\Http\Message\Interfaces\UriInterface

Method Summary¶

Properties¶

Methods¶

getMethod()¶

public function getMethod(): string;

getRequestTarget()¶

public function getRequestTarget(): string;

Retrieves the message's request target.

Retrieves the message's request-target either as it will appear (for clients), as it appeared at request (for servers), or as it was specified for the instance (see withRequestTarget()).

In most cases, this will be the origin-form of the composed URI, unless a value was provided to the concrete implementation (see withRequestTarget() below).

getUri()¶

public function getUri(): UriInterface;

Returns the Uri object

withMethod()¶

public function withMethod( string $method ): RequestInterface;

Return an instance with the provided HTTP method.

While HTTP method names are typically all uppercase characters, HTTP method names are case-sensitive and thus implementations SHOULD NOT modify the given string.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the changed request method.

withRequestTarget()¶

public function withRequestTarget( string|null $requestTarget ): RequestInterface;

Return an instance with the specific request-target.

If the request needs a non-origin-form request-target - e.g., for specifying an absolute-form, authority-form, or asterisk-form - this method may be used to create an instance with the specified request-target, verbatim.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the changed request target.

@see https://tools.ietf.org/html/rfc7230#section-5.3 (for the various request-target forms allowed in request messages)

withUri()¶

public function withUri(
    UriInterface $uri,
    bool $preserveHost = false
): RequestInterface;

Returns an instance with the provided URI.

This method MUST update the Host header of the returned request by default if the URI contains a host component. If the URI does not contain a host component, any pre-existing Host header MUST be carried over to the returned request.

You can opt-in to preserving the original state of the Host header by setting $preserveHost to true. When $preserveHost is set to true, this method interacts with the Host header in the following ways:

• If the Host header is missing or empty, and the new URI contains a host component, this method MUST update the Host header in the returned request.
• If the Host header is missing or empty, and the new URI does not contain a host component, this method MUST NOT update the Host header in the returned request.
• If a Host header is present and non-empty, this method MUST NOT update the Host header in the returned request.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the new UriInterface instance.

@see https://tools.ietf.org/html/rfc3986#section-4.3

processMethod()¶

final protected function processMethod( string $method = "" ): string;

Check the method

processUri()¶

final protected function processUri( mixed $uri ): UriInterface;

Sets a valid Uri

Http\Message\Exception\InvalidArgumentException¶

Class Source on GitHub

Uses Throwable

Http\Message\Exception\RuntimeException¶

Class Source on GitHub

Uses Throwable

Http\Message\Factories\RequestFactory¶

Final Source on GitHub

Factory for Request objects

Uses Phalcon\Http\Message\Interfaces\RequestFactoryInterface · Phalcon\Http\Message\Interfaces\RequestInterface · Phalcon\Http\Message\Interfaces\UriInterface · Phalcon\Http\Message\Request

Method Summary¶

Methods¶

createRequest()¶

public function createRequest(
    string $method,
    mixed $uri
): RequestInterface;

Create a new request.

Http\Message\Factories\ResponseFactory¶

Final Source on GitHub

Factory for Response objects

Uses Phalcon\Http\Message\Interfaces\ResponseFactoryInterface · Phalcon\Http\Message\Interfaces\ResponseInterface · Phalcon\Http\Message\Response

Method Summary¶

Methods¶

createResponse()¶

public function createResponse(
    int $code = 200,
    string $reasonPhrase = ""
): ResponseInterface;

Create a new response.

Http\Message\Factories\ServerRequestFactory¶

Class Source on GitHub

Factory for ServerRequest objects

Uses Phalcon\Http\Message\Exception\InvalidArgumentException · Phalcon\Http\Message\Interfaces\RequestMethodInterface · Phalcon\Http\Message\Interfaces\ServerRequestFactoryInterface · Phalcon\Http\Message\Interfaces\ServerRequestInterface · Phalcon\Http\Message\Interfaces\UploadedFileInterface · Phalcon\Http\Message\Interfaces\UriInterface · Phalcon\Http\Message\ServerRequest · Phalcon\Http\Message\UploadedFile · Phalcon\Http\Message\Uri · Phalcon\Support\Collection · Phalcon\Support\Collection\CollectionInterface

Method Summary¶

Methods¶

createServerRequest()¶

public function createServerRequest(
    string $method,
    mixed $uri,
    array $serverParams = []
): ServerRequestInterface;

Create a new server request.

Note that server-params are taken precisely as given - no parsing/processing of the given values is performed, and, in particular, no attempt is made to determine the HTTP method or URI, which must be provided explicitly.

load()¶

public function load(
    array|null $server = null,
    array|null $get = null,
    array|null $post = null,
    array|null $cookies = null,
    array|null $files = null
): ServerRequest;

Create a request from the supplied superglobal values.

If any argument is not supplied, the corresponding superglobal value will be used.

getHeaders()¶

protected function getHeaders();

Returns the apache_request_headers if it exists

Http\Message\Factories\StreamFactory¶

Final Source on GitHub

Factory for Stream objects

Uses Phalcon\Http\Message\Exception\InvalidArgumentException · Phalcon\Http\Message\Interfaces\StreamFactoryInterface · Phalcon\Http\Message\Interfaces\StreamInterface · Phalcon\Http\Message\Stream · Phalcon\Traits\Php\FileTrait

Method Summary¶

Methods¶

createStream()¶

public function createStream( string $content = "" ): StreamInterface;

Create a new stream from a string.

The stream SHOULD be created with a temporary resource.

createStreamFromFile()¶

public function createStreamFromFile(
    string $filename,
    string $mode = "r+b"
): StreamInterface;

Create a stream from an existing file.

The file MUST be opened using the given mode, which may be any mode supported by the fopen function.

The $filename MAY be any string supported by fopen().

createStreamFromResource()¶

public function createStreamFromResource( mixed $phpResource ): StreamInterface;

Create a new stream from an existing resource.

The stream MUST be readable and may be writable.

Http\Message\Factories\UploadedFileFactory¶

Final Source on GitHub

Factory for UploadedFile objects

Uses Phalcon\Http\Message\Exception\InvalidArgumentException · Phalcon\Http\Message\Interfaces\StreamInterface · Phalcon\Http\Message\Interfaces\UploadedFileFactoryInterface · Phalcon\Http\Message\Interfaces\UploadedFileInterface · Phalcon\Http\Message\UploadedFile

Method Summary¶

Methods¶

createUploadedFile()¶

public function createUploadedFile(
    StreamInterface $stream,
    int|null $size = null,
    int $error = 0,
    string|null $clientFilename = null,
    string|null $clientMediaType = null
): UploadedFileInterface;

Create a new uploaded file.

If a size is not provided it will be determined by checking the size of the stream.

@link httsp://php.net/manual/features.file-upload.post-method.php @link https://php.net/manual/features.file-upload.errors.php

Http\Message\Factories\UriFactory¶

Final Source on GitHub

Factory for Uri objects

Uses Phalcon\Http\Message\Interfaces\UriFactoryInterface · Phalcon\Http\Message\Interfaces\UriInterface · Phalcon\Http\Message\Uri

Method Summary¶

Methods¶

createUri()¶

public function createUri( string $uri = "" ): UriInterface;

Returns a Uri object

Http\Message\Headers¶

Class Source on GitHub

Message methods

Uses Phalcon\Http\Message\Exception\InvalidArgumentException · Phalcon\Http\Message\Interfaces\UriInterface · Phalcon\Support\Collection

Method Summary¶

Methods¶

checkHeaderHost()¶

final public function checkHeaderHost(
    Headers $collection,
    UriInterface|null $uri = null
): Headers;

Ensure Host is the first header.

@see: https://tools.ietf.org/html/rfc7230#section-5.4

checkHeaderName()¶

final public function checkHeaderName( string $name ): void;

Check the name of the header. Throw exception if not valid

@see https://tools.ietf.org/html/rfc7230#section-3.2

checkHeaderValue()¶

final public function checkHeaderValue( mixed $value ): void;

Validates a header value

Most HTTP header field values are defined using common syntax components (token, quoted-string, and comment) separated by whitespace or specific delimiting characters. Delimiters are chosen from the set of US-ASCII visual characters not allowed in a token (DQUOTE and '(),/:;<=>?@[]{}').

token          = 1*tchar

tchar          = '!' / '#' / '$' / '%' / '&' / ''' / '*'
               / '+' / '-' / '.' / '^' / '_' / '`' / '|' / '~'
               / DIGIT / ALPHA
               ; any VCHAR, except delimiters

A string of text is parsed as a single value if it is quoted using double-quote marks.

quoted-string  = DQUOTE *( qdtext / quoted-pair ) DQUOTE
qdtext         = HTAB / SP /%x21 / %x23-5B / %x5D-7E / obs-text
obs-text       = %x80-FF

Comments can be included in some HTTP header fields by surrounding the comment text with parentheses. Comments are only allowed in fields containing 'comment' as part of their field value definition.

comment        = '(' *( ctext / quoted-pair / comment ) ')'
ctext          = HTAB / SP / %x21-27 / %x2A-5B / %x5D-7E / obs-text

The backslash octet ('\') can be used as a single-octet quoting mechanism within quoted-string and comment constructs. Recipients that process the value of a quoted-string MUST handle a quoted-pair as if it were replaced by the octet following the backslash.

quoted-pair    = '\' ( HTAB / SP / VCHAR / obs-text )

A sender SHOULD NOT generate a quoted-pair in a quoted-string except where necessary to quote DQUOTE and backslash octets occurring within that string. A sender SHOULD NOT generate a quoted-pair in a comment except where necessary to quote parentheses ['(' and ')'] and backslash octets occurring within that comment.

@see https://tools.ietf.org/html/rfc7230#section-3.2.6

getHeaderValue()¶

final public function getHeaderValue( mixed $values ): array;

Returns the header values checked for validity

populateHeaders()¶

final public function populateHeaders( array $headers ): Headers;

Populates the header collection

processHeaders()¶

final public function processHeaders(
    mixed $headers,
    UriInterface|null $uri = null
): Headers;

Sets the headers

setData()¶

protected function setData(
    string $element,
    mixed $value
): void;

Internal method to set data

Http\Message\Interfaces\MessageInterface¶

Interface Source on GitHub

HTTP messages consist of requests from a client to a server and responses from a server to a client. This interface defines the methods common to each.

Messages are considered immutable; all methods that might change state MUST be implemented such that they retain the internal state of the current message and return an instance that contains the changed state.

@link https://www.ietf.org/rfc/rfc7230.txt @link https://www.ietf.org/rfc/rfc7231.txt

Uses Phalcon\Http\Message\Exception\InvalidArgumentException

Method Summary¶

Methods¶

getBody()¶

public function getBody(): StreamInterface;

Gets the body of the message.

getHeader()¶

public function getHeader( string $name ): array;

Retrieves a message header value by the given case-insensitive name.

This method returns an array of all the header values of the given case-insensitive header name.

If the header does not appear in the message, this method MUST return an empty array.

getHeaderLine()¶

public function getHeaderLine( string $name ): string;

Retrieves a comma-separated string of the values for a single header.

This method returns all of the header values of the given case-insensitive header name as a string concatenated together using a comma.

NOTE: Not all header values may be appropriately represented using comma concatenation. For such headers, use getHeader() instead and supply your own delimiter when concatenating.

If the header does not appear in the message, this method MUST return an empty string.

getHeaders()¶

public function getHeaders(): array;

Retrieves all message header values.

The keys represent the header name as it will be sent over the wire, and each value is an array of strings associated with the header.

// Represent the headers as a string
foreach ($message->getHeaders() as $name => $values) {
    echo $name . ": " . implode(", ", $values);
}

// Emit headers iteratively:
foreach ($message->getHeaders() as $name => $values) {
    foreach ($values as $value) {
        header(sprintf('%s: %s', $name, $value), false);
    }
}

While header names are not case-sensitive, getHeaders() will preserve the exact case in which headers were originally specified.

getProtocolVersion()¶

public function getProtocolVersion(): string;

Retrieves the HTTP protocol version as a string.

The string MUST contain only the HTTP version number (e.g., "1.1", "1.0").

hasHeader()¶

public function hasHeader( string $name ): bool;

Checks if a header exists by the given case-insensitive name.

withAddedHeader()¶

public function withAddedHeader(
    string $name,
    mixed $value
): MessageInterface;

Return an instance with the specified header appended with the given value.

Existing values for the specified header will be maintained. The new value(s) will be appended to the existing list. If the header did not exist previously, it will be added.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the new header and/or value.

withBody()¶

public function withBody( StreamInterface $body ): MessageInterface;

Return an instance with the specified message body.

The body MUST be a StreamInterface object.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return a new instance that has the new body stream.

withHeader()¶

public function withHeader(
    string $name,
    mixed $value
): MessageInterface;

Return an instance with the provided value replacing the specified header.

While header names are case-insensitive, the casing of the header will be preserved by this function, and returned from getHeaders().

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the new and/or updated header and value.

withProtocolVersion()¶

public function withProtocolVersion( string $version ): MessageInterface;

Return an instance with the specified HTTP protocol version.

The version string MUST contain only the HTTP version number (e.g., "1.1", "1.0").

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the new protocol version.

withoutHeader()¶

public function withoutHeader( string $name ): MessageInterface;

Return an instance without the specified header.

Header resolution MUST be done without case-sensitivity.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that removes the named header.

Http\Message\Interfaces\RequestFactoryInterface¶

Interface Source on GitHub

Method Summary¶

Methods¶

createRequest()¶

public function createRequest(
    string $method,
    mixed $uri
): RequestInterface;

Create a new request.

Http\Message\Interfaces\RequestInterface¶

Interface Source on GitHub

Representation of an outgoing, client-side request.

Per the HTTP specification, this interface includes properties for each of the following:

• Protocol version
• HTTP method
• URI
• Headers
• Message body

During construction, implementations MUST attempt to set the Host header from a provided URI if no Host header is provided.

Requests are considered immutable; all methods that might change state MUST be implemented such that they retain the internal state of the current message and return an instance that contains the changed state.

Uses Phalcon\Http\Message\Exception\InvalidArgumentException

Method Summary¶

Methods¶

getMethod()¶

public function getMethod(): string;

Retrieves the HTTP method of the request.

getRequestTarget()¶

public function getRequestTarget(): string;

Retrieves the message's request target.

Retrieves the message's request-target either as it will appear (for clients), as it appeared at request (for servers), or as it was specified for the instance (see withRequestTarget()).

In most cases, this will be the origin-form of the composed URI, unless a value was provided to the concrete implementation (see withRequestTarget() below).

If no URI is available, and no request-target has been specifically provided, this method MUST return the string "/".

getUri()¶

public function getUri(): UriInterface;

Retrieves the URI instance.

This method MUST return a UriInterface instance.

@link https://tools.ietf.org/html/rfc3986#section-4.3

withMethod()¶

public function withMethod( string $method ): RequestInterface;

Return an instance with the provided HTTP method.

While HTTP method names are typically all uppercase characters, HTTP method names are case-sensitive and thus implementations SHOULD NOT modify the given string.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the changed request method.

withRequestTarget()¶

public function withRequestTarget( string|null $requestTarget ): RequestInterface;

Return an instance with the specific request-target.

If the request needs a non-origin-form request-target - e.g., for specifying an absolute-form, authority-form, or asterisk-form - this method may be used to create an instance with the specified request-target, verbatim.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the changed request target.

@link https://tools.ietf.org/html/rfc7230#section-5.3 (for the various request-target forms allowed in request messages)

withUri()¶

public function withUri(
    UriInterface $uri,
    bool $preserveHost = false
): RequestInterface;

Returns an instance with the provided URI.

This method MUST update the Host header of the returned request by default if the URI contains a host component. If the URI does not contain a host component, any pre-existing Host header MUST be carried over to the returned request.

You can opt-in to preserving the original state of the Host header by setting $preserveHost to true. When $preserveHost is set to true, this method interacts with the Host header in the following ways:

• If the Host header is missing or empty, and the new URI contains a host component, this method MUST update the Host header in the returned request.
• If the Host header is missing or empty, and the new URI does not contain a host component, this method MUST NOT update the Host header in the returned request.
• If a Host header is present and non-empty, this method MUST NOT update the Host header in the returned request.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the new UriInterface instance.

@link https://tools.ietf.org/html/rfc3986#section-4.3

Http\Message\Interfaces\RequestMethodInterface¶

Interface Source on GitHub

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\Interfaces\ResponseFactoryInterface¶

Interface Source on GitHub

Method Summary¶

Methods¶

createResponse()¶

public function createResponse(
    int $code = 200,
    string $reasonPhrase = ""
): ResponseInterface;

Create a new response.

Http\Message\Interfaces\ResponseInterface¶

Interface Source on GitHub

Representation of an outgoing, server-side response.

Per the HTTP specification, this interface includes properties for each of the following:

• Protocol version
• Status code and reason phrase
• Headers
• Message body

Responses are considered immutable; all methods that might change state MUST be implemented such that they retain the internal state of the current message and return an instance that contains the changed state.

Uses Phalcon\Http\Message\Exception\InvalidArgumentException

Method Summary¶

Methods¶

getReasonPhrase()¶

public function getReasonPhrase(): string;

Gets the response reason phrase associated with the status code.

Because a reason phrase is not a required element in a response status line, the reason phrase value MAY be null. Implementations MAY choose to return the default RFC 7231 recommended reason phrase (or those listed in the IANA HTTP Status Code Registry) for the response's status code.

@link https://tools.ietf.org/html/rfc7231#section-6 @link https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml

getStatusCode()¶

public function getStatusCode(): int;

Gets the response status code.

The status code is a 3-digit integer result code of the server's attempt to understand and satisfy the request.

withStatus()¶

public function withStatus(
    int $code,
    string $reasonPhrase = ""
): ResponseInterface;

Return an instance with the specified status code and, optionally, reason phrase.

If no reason phrase is specified, implementations MAY choose to default to the RFC 7231 or IANA recommended reason phrase for the response's status code.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the updated status and reason phrase.

@link https://tools.ietf.org/html/rfc7231#section-6 @link https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml

Http\Message\Interfaces\ResponseStatusCodeInterface¶

Interface Source on GitHub

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\Message\Interfaces\ServerRequestFactoryInterface¶

Interface Source on GitHub

Method Summary¶

Methods¶

createServerRequest()¶

public function createServerRequest(
    string $method,
    mixed $uri,
    array $serverParams = []
): ServerRequestInterface;

Create a new server request.

Note that server-params are taken precisely as given - no parsing/processing of the given values is performed, and, in particular, no attempt is made to determine the HTTP method or URI, which must be provided explicitly.

Http\Message\Interfaces\ServerRequestInterface¶

Interface Source on GitHub

Representation of an incoming, server-side HTTP request.

Per the HTTP specification, this interface includes properties for each of the following:

• Protocol version
• HTTP method
• URI
• Headers
• Message body

Additionally, it encapsulates all data as it has arrived to the application from the CGI and/or PHP environment, including:

• The values represented in $_SERVER.
• Any cookies provided (generally via $_COOKIE)
• Query string arguments (generally via $_GET, or as parsed via parse_str())
• Upload files, if any (as represented by $_FILES)
• Deserialized body parameters (generally from $_POST)

$_SERVER values MUST be treated as immutable, as they represent application state at the time of request; as such, no methods are provided to allow modification of those values. The other values provide such methods, as they can be restored from $_SERVER or the request body, and may need treatment during the application (e.g., body parameters may be deserialized based on content type).

Additionally, this interface recognizes the utility of introspecting a request to derive and match additional parameters (e.g., via URI path matching, decrypting cookie values, deserializing non-form-encoded body content, matching authorization headers to users, etc). These parameters are stored in an "attributes" property.

Requests are considered immutable; all methods that might change state MUST be implemented such that they retain the internal state of the current message and return an instance that contains the changed state.

Uses Phalcon\Http\Message\Exception\InvalidArgumentException

Method Summary¶

Methods¶

getAttribute()¶

public function getAttribute(
    string $name,
    mixed $defaultValue = null
);

Retrieve a single derived request attribute.

Retrieves a single derived request attribute as described in getAttributes(). If the attribute has not been previously set, returns the default value as provided.

This method obviates the need for a hasAttribute() method, as it allows specifying a default value to return if the attribute is not found.

getAttributes()¶

public function getAttributes(): array;

Retrieve attributes derived from the request.

The request "attributes" may be used to allow injection of any parameters derived from the request: e.g., the results of path match operations; the results of decrypting cookies; the results of deserializing non-form-encoded message bodies; etc. Attributes will be application and request specific, and CAN be mutable.

getCookieParams()¶

public function getCookieParams(): array;

Retrieve cookies.

Retrieves cookies sent by the client to the server.

The data MUST be compatible with the structure of the $_COOKIE superglobal.

getParsedBody()¶

public function getParsedBody();

Retrieve any parameters provided in the request body.

If the request Content-Type is either application/x-www-form-urlencoded or multipart/form-data, and the request method is POST, this method MUST return the contents of $_POST.

Otherwise, this method may return any results of deserializing the request body content; as parsing returns structured content, the potential types MUST be arrays or objects only. A null value indicates the absence of body content.

getQueryParams()¶

public function getQueryParams(): array;

Retrieve query string arguments.

Retrieves the deserialized query string arguments, if any.

Note: the query params might not be in sync with the URI or server params. If you need to ensure you are only getting the original values, you may need to parse the query string from getUri()->getQuery() or from the QUERY_STRING server param.

getServerParams()¶

public function getServerParams(): array;

Retrieve server parameters.

Retrieves data related to the incoming request environment, typically derived from PHP's $_SERVER superglobal. The data IS NOT REQUIRED to originate from $_SERVER.

getUploadedFiles()¶

public function getUploadedFiles(): array;

Retrieve normalized file upload data.

This method returns upload metadata in a normalized tree, with each leaf an instance of Psr\Http\Message\UploadedFileInterface.

These values MAY be prepared from $_FILES or the message body during instantiation, or MAY be injected via withUploadedFiles().

withAttribute()¶

public function withAttribute(
    string $name,
    mixed $value
): ServerRequestInterface;

Return an instance with the specified derived request attribute.

This method allows setting a single derived request attribute as described in getAttributes().

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the updated attribute.

withCookieParams()¶

public function withCookieParams( array $cookies ): ServerRequestInterface;

Return an instance with the specified cookies.

The data IS NOT REQUIRED to come from the $_COOKIE superglobal, but MUST be compatible with the structure of $_COOKIE. Typically, this data will be injected at instantiation.

This method MUST NOT update the related Cookie header of the request instance, nor related values in the server params.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the updated cookie values.

withParsedBody()¶

public function withParsedBody( mixed $data ): ServerRequestInterface;

Return an instance with the specified body parameters.

These MAY be injected during instantiation.

If the request Content-Type is either application/x-www-form-urlencoded or multipart/form-data, and the request method is POST, use this method ONLY to inject the contents of $_POST.

The data IS NOT REQUIRED to come from $_POST, but MUST be the results of deserializing the request body content. Deserialization/parsing returns structured data, and, as such, this method ONLY accepts arrays or objects, or a null value if nothing was available to parse.

As an example, if content negotiation determines that the request data is a JSON payload, this method could be used to create a request instance with the deserialized parameters.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the updated body parameters.

withQueryParams()¶

public function withQueryParams( array $query ): ServerRequestInterface;

Return an instance with the specified query string arguments.

These values SHOULD remain immutable over the course of the incoming request. They MAY be injected during instantiation, such as from PHP's $_GET superglobal, or MAY be derived from some other value such as the URI. In cases where the arguments are parsed from the URI, the data MUST be compatible with what PHP's parse_str() would return for purposes of how duplicate query parameters are handled, and how nested sets are handled.

Setting query string arguments MUST NOT change the URI stored by the request, nor the values in the server params.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the updated query string arguments.

withUploadedFiles()¶

public function withUploadedFiles( array $uploadedFiles ): ServerRequestInterface;

Create a new instance with the specified uploaded files.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the updated body parameters.

withoutAttribute()¶

public function withoutAttribute( string $name ): ServerRequestInterface;

Return an instance that removes the specified derived request attribute.

This method allows removing a single derived request attribute as described in getAttributes().

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that removes the attribute.

Http\Message\Interfaces\StreamFactoryInterface¶

Interface Source on GitHub

Uses Phalcon\Http\Message\Exception\InvalidArgumentException · Phalcon\Http\Message\Exception\RuntimeException

Method Summary¶

Methods¶

createStream()¶

public function createStream( string $content = "" ): StreamInterface;

Create a new stream from a string.

The stream SHOULD be created with a temporary resource.

createStreamFromFile()¶

public function createStreamFromFile(
    string $filename,
    string $mode = "r"
): StreamInterface;

Create a stream from an existing file.

The file MUST be opened using the given mode, which may be any mode supported by the fopen function.

The $filename MAY be any string supported by fopen().

createStreamFromResource()¶

public function createStreamFromResource( mixed $phpResource ): StreamInterface;

Create a new stream from an existing resource.

The stream MUST be readable and may be writable.

Http\Message\Interfaces\StreamInterface¶

Interface Source on GitHub

Describes a data stream.

Typically, an instance will wrap a PHP stream; this interface provides a wrapper around the most common operations, including serialization of the entire stream to a string.

Uses Phalcon\Http\Message\Exception\RuntimeException

Method Summary¶

Methods¶

__toString()¶

public function __toString();

Reads all data from the stream into a string, from the beginning to end.

This method MUST attempt to seek to the beginning of the stream before reading data and read the stream until the end is reached.

Warning: This could attempt to load a large amount of data into memory.

This method MUST NOT raise an exception in order to conform with PHP's string casting operations.

@see https://php.net/manual/en/language.oop5.magic.php#object.tostring

close()¶

public function close();

Closes the stream and any underlying resources.

detach()¶

public function detach();

Separates any underlying resources from the stream.

After the stream has been detached, the stream is in an unusable state.

eof()¶

public function eof(): bool;

Returns true if the stream is at the end of the stream.

getContents()¶

public function getContents(): string;

Returns the remaining contents in a string

getMetadata()¶

public function getMetadata( string|null $key = null );

Get stream metadata as an associative array or retrieve a specific key.

The keys returned are identical to the keys returned from PHP's stream_get_meta_data() function.

@link https://php.net/manual/en/function.stream-get-meta-data.php

getSize()¶

public function getSize(): int|null;

Get the size of the stream if known.

isReadable()¶

public function isReadable(): bool;

Returns whether the stream is readable.

isSeekable()¶

public function isSeekable(): bool;

Returns whether the stream is seekable.

isWritable()¶

public function isWritable(): bool;

Returns whether the stream is writable.

read()¶

public function read( int $length ): string;

Read data from the stream.

rewind()¶

public function rewind(): void;

Seek to the beginning of the stream.

If the stream is not seekable, this method will raise an exception; otherwise, it will perform a seek(0).

seek()¶

public function seek(
    int $offset,
    int $whence = SEEK_SET
): void;

Seek to a position in the stream.

@link https://www.php.net/manual/en/function.fseek.php

tell()¶

public function tell(): int;

Returns the current position of the file read/write pointer

write()¶

public function write( string $data ): int;

Write data to the stream.

Http\Message\Interfaces\UploadedFileFactoryInterface¶

Interface Source on GitHub

Uses Phalcon\Http\Message\Exception\InvalidArgumentException

Method Summary¶

Methods¶

createUploadedFile()¶

public function createUploadedFile(
    StreamInterface $stream,
    int|null $size = null,
    int $error = UPLOAD_ERR_OK,
    string|null $clientFilename = null,
    string|null $clientMediaType = null
): UploadedFileInterface;

Create a new uploaded file.

If a size is not provided it will be determined by checking the size of the file.

@see https://php.net/manual/features.file-upload.post-method.php @see https://php.net/manual/features.file-upload.errors.php

Http\Message\Interfaces\UploadedFileInterface¶

Interface Source on GitHub

Value object representing a file uploaded through an HTTP request.

Instances of this interface are considered immutable; all methods that might change state MUST be implemented such that they retain the internal state of the current instance and return an instance that contains the changed state.

Uses Phalcon\Http\Message\Exception\InvalidArgumentException · Phalcon\Http\Message\Exception\RuntimeException

Method Summary¶

Methods¶

getClientFilename()¶

public function getClientFilename(): string|null;

Retrieve the filename sent by the client.

Do not trust the value returned by this method. A client could send a malicious filename with the intention to corrupt or hack your application.

Implementations SHOULD return the value stored in the "name" key of the file in the $_FILES array.

getClientMediaType()¶

public function getClientMediaType(): string|null;

Retrieve the media type sent by the client.

Do not trust the value returned by this method. A client could send a malicious media type with the intention to corrupt or hack your application.

Implementations SHOULD return the value stored in the "type" key of the file in the $_FILES array.

getError()¶

public function getError(): int;

Retrieve the error associated with the uploaded file.

The return value MUST be one of PHP's UPLOAD_ERR_XXX constants.

If the file was uploaded successfully, this method MUST return UPLOAD_ERR_OK.

Implementations SHOULD return the value stored in the "error" key of the file in the $_FILES array.

@see https://php.net/manual/en/features.file-upload.errors.php

getSize()¶

public function getSize(): int|null;

Retrieve the file size.

Implementations SHOULD return the value stored in the "size" key of the file in the $_FILES array if available, as PHP calculates this based on the actual size transmitted.

getStream()¶

public function getStream(): StreamInterface;

Retrieve a stream representing the uploaded file.

This method MUST return a StreamInterface instance, representing the uploaded file. The purpose of this method is to allow utilizing native PHP stream functionality to manipulate the file upload, such as stream_copy_to_stream() (though the result will need to be decorated in a native PHP stream wrapper to work with such functions).

If the moveTo() method has been called previously, this method MUST raise an exception.

moveTo()¶

public function moveTo( string $targetPath ): void;

Move the uploaded file to a new location.

Use this method as an alternative to move_uploaded_file(). This method is guaranteed to work in both SAPI and non-SAPI environments. Implementations must determine which environment they are in, and use the appropriate method (move_uploaded_file(), rename(), or a stream operation) to perform the operation.

$targetPath may be an absolute path, or a relative path. If it is a relative path, resolution should be the same as used by PHP's rename() function.

The original file or stream MUST be removed on completion.

If this method is called more than once, any subsequent calls MUST raise an exception.

When used in an SAPI environment where $_FILES is populated, when writing files via moveTo(), is_uploaded_file() and move_uploaded_file() SHOULD be used to ensure permissions and upload status are verified correctly.

If you wish to move to a stream, use getStream(), as SAPI operations cannot guarantee writing to stream destinations.

@see https://php.net/is_uploaded_file @see https://php.net/move_uploaded_file

Http\Message\Interfaces\UriFactoryInterface¶

Interface Source on GitHub

Uses Phalcon\Http\Message\Exception\InvalidArgumentException

Method Summary¶

Methods¶

createUri()¶

public function createUri( string $uri = "" ): UriInterface;

Create a new URI.

Http\Message\Interfaces\UriInterface¶

Interface Source on GitHub

Value object representing a URI.

This interface is meant to represent URIs according to RFC 3986 and to provide methods for most common operations. Additional functionality for working with URIs can be provided on top of the interface or externally. Its primary use is for HTTP requests, but may also be used in other contexts.

Instances of this interface are considered immutable; all methods that might change state MUST be implemented such that they retain the internal state of the current instance and return an instance that contains the changed state.

Typically, the Host header will be also be present in the request message. For server-side requests, the scheme will typically be discoverable in the server parameters.

@link https://tools.ietf.org/html/rfc3986 (the URI specification)

Uses Phalcon\Http\Message\Exception\InvalidArgumentException

Method Summary¶

Methods¶

__toString()¶

public function __toString(): string;

Return the string representation as a URI reference.

Depending on which components of the URI are present, the resulting string is either a full URI or relative reference according to RFC 3986, Section 4.1. The method concatenates the various components of the URI, using the appropriate delimiters:

• If a scheme is present, it MUST be suffixed by ":".
• If an authority is present, it MUST be prefixed by "//".
• The path can be concatenated without delimiters. But there are two cases where the path has to be adjusted to make the URI reference valid as PHP does not allow to throw an exception in __toString():
  • If the path is rootless and an authority is present, the path MUST be prefixed by "/".
  • If the path is starting with more than one "/" and no authority is present, the starting slashes MUST be reduced to one.
• If a query is present, it MUST be prefixed by "?".
• If a fragment is present, it MUST be prefixed by "#".

@see https://tools.ietf.org/html/rfc3986#section-4.1

getAuthority()¶

public function getAuthority(): string;

Retrieve the authority component of the URI.

If no authority information is present, this method MUST return an empty string.

The authority syntax of the URI is:

[user-info@]host[:port]

If the port component is not set or is the standard port for the current scheme, it SHOULD NOT be included.

@see https://tools.ietf.org/html/rfc3986#section-3.2

getFragment()¶

public function getFragment(): string;

Retrieve the fragment component of the URI.

If no fragment is present, this method MUST return an empty string.

The leading "#" character is not part of the fragment and MUST NOT be added.

The value returned MUST be percent-encoded, but MUST NOT double-encode any characters. To determine what characters to encode, please refer to RFC 3986, Sections 2 and 3.5.

@see https://tools.ietf.org/html/rfc3986#section-2 @see https://tools.ietf.org/html/rfc3986#section-3.5

getHost()¶

public function getHost(): string;

Retrieve the host component of the URI.

If no host is present, this method MUST return an empty string.

The value returned MUST be normalized to lowercase, per RFC 3986 Section 3.2.2.

@see https://tools.ietf.org/html/rfc3986#section-3.2.2

getPath()¶

public function getPath(): string;

Retrieve the path component of the URI.

The path can either be empty or absolute (starting with a slash) or rootless (not starting with a slash). Implementations MUST support all three syntaxes.

Normally, the empty path "" and absolute path "/" are considered equal as defined in RFC 7230 Section 2.7.3. But this method MUST NOT automatically do this normalization because in contexts with a trimmed base path, e.g. the front controller, this difference becomes significant. It's the task of the user to handle both "" and "/".

The value returned MUST be percent-encoded, but MUST NOT double-encode any characters. To determine what characters to encode, please refer to RFC 3986, Sections 2 and 3.3.

As an example, if the value should include a slash ("/") not intended as delimiter between path segments, that value MUST be passed in encoded form (e.g., "%2F") to the instance.

@see https://tools.ietf.org/html/rfc3986#section-2 @see https://tools.ietf.org/html/rfc3986#section-3.3

getPort()¶

public function getPort(): int|null;

Retrieve the port component of the URI.

If a port is present, and it is non-standard for the current scheme, this method MUST return it as an integer. If the port is the standard port used with the current scheme, this method SHOULD return null.

If no port is present, and no scheme is present, this method MUST return a null value.

If no port is present, but a scheme is present, this method MAY return the standard port for that scheme, but SHOULD return null.

getQuery()¶

public function getQuery(): string;

Retrieve the query string of the URI.

If no query string is present, this method MUST return an empty string.

The leading "?" character is not part of the query and MUST NOT be added.

The value returned MUST be percent-encoded, but MUST NOT double-encode any characters. To determine what characters to encode, please refer to RFC 3986, Sections 2 and 3.4.

As an example, if a value in a key/value pair of the query string should include an ampersand ("&") not intended as a delimiter between values, that value MUST be passed in encoded form (e.g., "%26") to the instance.

@see https://tools.ietf.org/html/rfc3986#section-2 @see https://tools.ietf.org/html/rfc3986#section-3.4

getScheme()¶

public function getScheme(): string;

Retrieve the scheme component of the URI.

If no scheme is present, this method MUST return an empty string.

The value returned MUST be normalized to lowercase, per RFC 3986 Section 3.1.

The trailing ":" character is not part of the scheme and MUST NOT be added.

@see https://tools.ietf.org/html/rfc3986#section-3.1

getUserInfo()¶

public function getUserInfo(): string;

Retrieve the user information component of the URI.

If no user information is present, this method MUST return an empty string.

If a user is present in the URI, this will return that value; additionally, if the password is also present, it will be appended to the user value, with a colon (":") separating the values.

The trailing "@" character is not part of the user information and MUST NOT be added.

withFragment()¶

public function withFragment( string $fragment ): UriInterface;

Return an instance with the specified URI fragment.

This method MUST retain the state of the current instance, and return an instance that contains the specified URI fragment.

Users can provide both encoded and decoded fragment characters. Implementations ensure the correct encoding as outlined in getFragment().

An empty fragment value is equivalent to removing the fragment.

withHost()¶

public function withHost( string $host ): UriInterface;

Return an instance with the specified host.

This method MUST retain the state of the current instance, and return an instance that contains the specified host.

An empty host value is equivalent to removing the host.

withPath()¶

public function withPath( string $path ): UriInterface;

Return an instance with the specified path.

This method MUST retain the state of the current instance, and return an instance that contains the specified path.

The path can either be empty or absolute (starting with a slash) or rootless (not starting with a slash). Implementations MUST support all three syntaxes.

If the path is intended to be domain-relative rather than path relative then it must begin with a slash ("/"). Paths not starting with a slash ("/") are assumed to be relative to some base path known to the application or consumer.

Users can provide both encoded and decoded path characters. Implementations ensure the correct encoding as outlined in getPath().

withPort()¶

public function withPort( int|null $port ): UriInterface;

Return an instance with the specified port.

This method MUST retain the state of the current instance, and return an instance that contains the specified port.

Implementations MUST raise an exception for ports outside the established TCP and UDP port ranges.

A null value provided for the port is equivalent to removing the port information.

withQuery()¶

public function withQuery( string $query ): UriInterface;

Return an instance with the specified query string.

This method MUST retain the state of the current instance, and return an instance that contains the specified query string.

Users can provide both encoded and decoded query characters. Implementations ensure the correct encoding as outlined in getQuery().

An empty query string value is equivalent to removing the query string.

withScheme()¶

public function withScheme( string $scheme ): UriInterface;

Return an instance with the specified scheme.

This method MUST retain the state of the current instance, and return an instance that contains the specified scheme.

Implementations MUST support the schemes "http" and "https" case insensitively, and MAY accommodate other schemes if required.

An empty scheme is equivalent to removing the scheme.

withUserInfo()¶

public function withUserInfo(
    string $user,
    string|null $password = null
): UriInterface;

Return an instance with the specified user information.

This method MUST retain the state of the current instance, and return an instance that contains the specified user information.

Password is optional, but the user information MUST include the user; an empty string for the user is equivalent to removing user information.

Http\Message\Request¶

Class Source on GitHub

Request object

Uses Phalcon\Http\Message\Interfaces\RequestInterface · Phalcon\Http\Message\Interfaces\RequestMethodInterface · Phalcon\Http\Message\Interfaces\StreamInterface · Phalcon\Http\Message\Interfaces\UriInterface · Phalcon\Http\Message\Stream\Input · Phalcon\Support\Collection\CollectionInterface

Method Summary¶

Methods¶

__construct()¶

public function __construct(
    string $method = self::METHOD_GET,
    mixed $uri = null,
    mixed $body = "php://memory",
    mixed $headers = []
);

Request constructor.

Http\Message\Response¶

Class Source on GitHub

Response object

Uses Phalcon\Http\Message\Exception\InvalidArgumentException · Phalcon\Http\Message\Interfaces\ResponseInterface · Phalcon\Http\Message\Interfaces\StreamInterface · Phalcon\Http\Traits\StatusPhrasesTrait

Method Summary¶

Properties¶

Methods¶

__construct()¶

public function __construct(
    mixed $body = "php://memory",
    int $code = 200,
    array $headers = []
);

Response constructor.

getReasonPhrase()¶

public function getReasonPhrase(): string;

getStatusCode()¶

public function getStatusCode(): int;

withStatus()¶

public function withStatus(
    int $code,
    string $reasonPhrase = ""
): ResponseInterface;

Return an instance with the specified status code and, optionally, reason phrase.

If no reason phrase is specified, implementations MAY choose to default to the RFC 7231 or IANA recommended reason phrase for the response's status code.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the updated status and reason phrase.

@see https://tools.ietf.org/html/rfc7231#section-6 @see https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml

processCode()¶

protected function processCode(
    int $code,
    string $phrase = ""
): void;

Set a valid status code and phrase

Http\Message\ResponseStatusCodeInterface¶

Interface Source on GitHub

Backward-compatible interface so that Phalcon\Http\Message\ResponseStatusCodeInterface resolves to the same set of constants as the canonical Phalcon\Http\Message\Interfaces\ResponseStatusCodeInterface.

Uses Phalcon\Http\Message\Interfaces\ResponseStatusCodeInterface

Http\Message\ServerRequest¶

Class Source on GitHub

ServerRequest

Uses Phalcon\Http\Message\Exception\InvalidArgumentException · Phalcon\Http\Message\Interfaces\ServerRequestInterface · Phalcon\Http\Message\Interfaces\StreamInterface · Phalcon\Http\Message\Interfaces\UploadedFileInterface · Phalcon\Http\Message\Interfaces\UriInterface · Phalcon\Http\Message\Stream\Input · Phalcon\Support\Collection · Phalcon\Support\Collection\CollectionInterface

Method Summary¶

Properties¶

Methods¶

__construct()¶

public function __construct(
    string $method = self::METHOD_GET,
    mixed $uri = null,
    array $serverParams = [],
    mixed $body = "php://input",
    mixed $headers = [],
    array $cookies = [],
    array $queryParams = [],
    array $uploadFiles = [],
    mixed $parsedBody = null,
    string $protocol = "1.1"
);

ServerRequest constructor.

getAttribute()¶

public function getAttribute(
    string $name,
    mixed $defaultValue = null
);

Retrieve a single derived request attribute.

Retrieves a single derived request attribute as described in getAttributes(). If the attribute has not been previously set, returns the default value as provided.

This method obviates the need for a hasAttribute() method, as it allows specifying a default value to return if the attribute is not found.

getAttributes()¶

public function getAttributes(): array;

Retrieve attributes derived from the request.

The request 'attributes' may be used to allow injection of any parameters derived from the request: e.g., the results of path match operations; the results of decrypting cookies; the results of deserializing non-form-encoded message bodies; etc. Attributes will be application and request specific, and CAN be mutable.

getCookieParams()¶

public function getCookieParams(): array;

getParsedBody()¶

public function getParsedBody();

getQueryParams()¶

public function getQueryParams(): array;

getServerParams()¶

public function getServerParams(): array;

getUploadedFiles()¶

public function getUploadedFiles(): array;

withAttribute()¶

public function withAttribute(
    string $name,
    mixed $value
): ServerRequest;

Return an instance with the specified derived request attribute.

This method allows setting a single derived request attribute as described in getAttributes().

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the updated attribute.

withCookieParams()¶

public function withCookieParams( array $cookies ): ServerRequest;

Return an instance with the specified cookies.

The data IS NOT REQUIRED to come from the $_COOKIE superglobal, but MUST be compatible with the structure of $_COOKIE. Typically, this data will be injected at instantiation.

This method MUST NOT update the related Cookie header of the request instance, nor related values in the server params.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the updated cookie values.

withParsedBody()¶

public function withParsedBody( mixed $data ): ServerRequest;

Return an instance with the specified body parameters.

These MAY be injected during instantiation.

If the request Content-Type is either application/x-www-form-urlencoded or multipart/form-data, and the request method is POST, use this method ONLY to inject the contents of $_POST.

The data IS NOT REQUIRED to come from $_POST, but MUST be the results of deserializing the request body content. Deserialization/parsing returns structured data, and, as such, this method ONLY accepts arrays or objects, or a null value if nothing was available to parse.

As an example, if content negotiation determines that the request data is a JSON payload, this method could be used to create a request instance with the deserialized parameters.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the updated body parameters.

withQueryParams()¶

public function withQueryParams( array $query ): ServerRequest;

Return an instance with the specified query string arguments.

These values SHOULD remain immutable over the course of the incoming request. They MAY be injected during instantiation, such as from PHP's $_GET superglobal, or MAY be derived from some other value such as the URI. In cases where the arguments are parsed from the URI, the data MUST be compatible with what PHP's parse_str() would return for purposes of how duplicate query parameters are handled, and how nested sets are handled.

Setting query string arguments MUST NOT change the URI stored by the request, nor the values in the server params.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the updated query string arguments.

withUploadedFiles()¶

public function withUploadedFiles( array $uploadedFiles ): ServerRequest;

Create a new instance with the specified uploaded files.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the updated body parameters.

withoutAttribute()¶

public function withoutAttribute( string $name ): ServerRequest;

Return an instance that removes the specified derived request attribute.

This method allows removing a single derived request attribute as described in getAttributes().

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that removes the attribute.

Http\Message\Stream¶

Class Source on GitHub

Stream/file OO class

@property resource|null $handle @property resource|string $stream

Uses Exception · Phalcon\Http\Message\Exception\RuntimeException · Phalcon\Http\Message\Interfaces\StreamInterface · Phalcon\Traits\Php\FileTrait

Method Summary¶

Properties¶

Methods¶

__construct()¶

public function __construct(
    mixed $stream,
    string $mode = "rb"
);

Stream constructor.

__destruct()¶