Interface IResponse

Responsibility - completing all information for response - headers (cookies) and content. - HTTP response wrapper carrying response headers and response body. - PHP setcookie function wrapper to complete default values such domain or http only etc. - Sending response at application terminate process by \MvcCore\IResponse::Send();. - Completing MvcCore performance header at response end.

MvcCore\IResponse implements MvcCore\Response\IConstants

Direct known implementers

MvcCore\Response

Namespace: MvcCore
Located at mvccore/src/MvcCore/IResponse.php

Methods summary
`public static MvcCore\Response`	# `CreateInstance( integer\|null $code = NULL, array $headers = [], string $body = '' )` No singleton, get every time new instance of configured HTTP response class in `\MvcCore\Application::GetInstance()->GetResponseClass();`. No singleton, get every time new instance of configured HTTP response class in `\MvcCore\Application::GetInstance()->GetResponseClass();`. Parameters `$code` `$headers` `$body` Returns `MvcCore\Response`
`public string`	# `GetHttpVersion( )` Get response protocol HTTP version by `$_SERVER['SERVER_PROTOCOL']`, `HTTP/1.1` by default. Get response protocol HTTP version by `$_SERVER['SERVER_PROTOCOL']`, `HTTP/1.1` by default. Returns string
`public MvcCore\Response`	# `SetHttpVersion( string $httpVersion )` Set response protocol HTTP version - `HTTP/1.1 \| HTTP/2.0`... Set response protocol HTTP version - `HTTP/1.1 \| HTTP/2.0`... Parameters `$httpVersion` Returns `MvcCore\Response`
`public MvcCore\Response`	# `SetCode( integer $code, string\|null $codeMessage = NULL )` Set HTTP response code. Set HTTP response code. Parameters `$code` `$codeMessage` Returns `MvcCore\Response`
`public integer`	# `GetCode( )` Get HTTP response code. Get HTTP response code. Returns integer `200 \| 301 \| 404`
`public MvcCore\Response`	# `SetHeaders( array $headers = [], boolean $cleanAllPrevious,… )` Set multiple HTTP response headers as `key => value` array. All given headers are automatically merged with previously setted headers. If you change second argument to true, all previous request object and PHP headers are removed and given headers will be only headers for output. There is automatically set response encoding from value for `Content-Type` header, if contains any `charset=...`. There is automatically set response encoding from value for `Content-Encoding` header. Example: `$request->SetHeader(array('Content-Type' => 'text/plain; charset=utf-8'));` Set multiple HTTP response headers as `key => value` array. All given headers are automatically merged with previously setted headers. If you change second argument to true, all previous request object and PHP headers are removed and given headers will be only headers for output. There is automatically set response encoding from value for `Content-Type` header, if contains any `charset=...`. There is automatically set response encoding from value for `Content-Encoding` header. Example: `$request->SetHeader(array('Content-Type' => 'text/plain; charset=utf-8'));` Parameters `$headers` `$cleanAllPrevious`,… `FALSE` by default. If `TRUE`, all previous headers set by PHP `header()` or by this object will be removed. Returns `MvcCore\Response`
`public MvcCore\Response`	# `SetHeader( string $name, string $value )` Set HTTP response header. There is automatically set response encoding from value for `Content-Type` header, if contains any `charset=...`. There is automatically set response encoding from value for `Content-Encoding` header. Example: `$request->SetHeader('Content-Type', 'text/plain; charset=utf-8');` Set HTTP response header. There is automatically set response encoding from value for `Content-Type` header, if contains any `charset=...`. There is automatically set response encoding from value for `Content-Encoding` header. Example: `$request->SetHeader('Content-Type', 'text/plain; charset=utf-8');` Parameters `$name` `$value` Returns `MvcCore\Response`
`public string\|null`	# `GetHeader( string $name )` Get HTTP response header by name. If header doesn't exists, null is returned. Example: `$response->GetHeader('Content-Type'); // returns 'text/plain; charset=utf-8'` Get HTTP response header by name. If header doesn't exists, null is returned. Example: `$response->GetHeader('Content-Type'); // returns 'text/plain; charset=utf-8'` Parameters `$name` Returns string\|null
`public boolean`	# `HasHeader( string $name )` Get if response has any HTTP response header by given `$name`. Example: `$request->GetHeader('Content-Type'); // returns TRUE if there is header 'Content-Type'`$request->GetHeader('content-type'); // returns FALSE if there is header 'Content-Type' Get if response has any HTTP response header by given `$name`. Example: `$request->GetHeader('Content-Type'); // returns TRUE if there is header 'Content-Type'`$request->GetHeader('content-type'); // returns FALSE if there is header 'Content-Type' Parameters `$name` Returns boolean
`public MvcCore\Response`	# `SetEncoding( string $encoding = 'utf-8' )` Set HTTP response content encoding. Example: `$response->SetEncoding('utf-8');` Set HTTP response content encoding. Example: `$response->SetEncoding('utf-8');` Parameters `$encoding` Returns `MvcCore\Response`
`public string\|null`	# `GetEncoding( )` Get HTTP response content encoding. Example: `$response->GetEncoding(); // returns 'utf-8'` Get HTTP response content encoding. Example: `$response->GetEncoding(); // returns 'utf-8'` Returns string\|null
`public MvcCore\Response`	# `SetBody( string $body )` Set HTTP response body. Set HTTP response body. Parameters `$body` Returns `MvcCore\Response`
`public MvcCore\Response`	# `PrependBody( string $body )` Prepend HTTP response body. Prepend HTTP response body. Parameters `$body` Returns `MvcCore\Response`
`public MvcCore\Response`	# `AppendBody( string $body )` Append HTTP response body. Append HTTP response body. Parameters `$body` Returns `MvcCore\Response`
`public string\|null &`	# `GetBody( )` Get HTTP response body. Get HTTP response body. Returns string\|null
`public MvcCore\Response`	# `UpdateHeaders( )` Consolidate all headers from PHP response by calling `headers_list()` into local headers list. Consolidate all headers from PHP response by calling `headers_list()` into local headers list. Returns `MvcCore\Response`
`public boolean`	# `IsRedirect( )` Return if response has any redirect `"Location: ..."` header inside. Return if response has any redirect `"Location: ..."` header inside. Returns boolean
`public boolean`	# `IsHtmlOutput( )` Returns if response has any `text/html` or `application/xhtml+xml` substring in `Content-Type` header. Returns if response has any `text/html` or `application/xhtml+xml` substring in `Content-Type` header. Returns boolean
`public boolean`	# `IsXmlOutput( )` Returns if response has any `xml` substring in `Content-Type` header. Returns if response has any `xml` substring in `Content-Type` header. Returns boolean
`public boolean`	# `IsSent( )` `TRUE` if headers and body has been sent. `TRUE` if headers and body has been sent. Returns boolean
`public boolean`	# `IsSentHeaders( )` `TRUE` if headers has been sent. `TRUE` if headers has been sent. Returns boolean
`public boolean`	# `IsSentBody( )` `TRUE` if body has been sent. `TRUE` if body has been sent. Returns boolean
`public MvcCore\Response`	# `Send( )` Send all HTTP headers and send response body. Send all HTTP headers and send response body. Returns `MvcCore\Response`
`public MvcCore\Response`	# `SendHeaders( )` Send all HTTP headers. Send all HTTP headers. Returns `MvcCore\Response`
`public MvcCore\Response`	# `SendBody( )` Send response body. Send response body. Returns `MvcCore\Response`
`public boolean`	# `SetCookie( string $name, string $value, integer $lifetime = 0, string $path = '/', string $domain = NULL, boolean $secure = NULL, boolean $httpOnly = TRUE )` Send a cookie. Send a cookie. Parameters `$name` Cookie name. Assuming the name is `cookiename`, this value is retrieved through `$_COOKIE['cookiename']`. `$value` The value of the cookie. This value is stored on the clients computer; do not store sensitive information. `$lifetime` Life time in seconds to expire. 0 means "until the browser is closed". `$path` The path on the server in which the cookie will be available on. If set to '/', the cookie will be available within the entire domain. `$domain` If not set, value is completed by `\MvcCore\Application::GetInstance()->GetRequest()->GetHostName();` . `$secure` If not set, value is completed by `\MvcCore\Application::GetInstance()->GetRequest()->IsSecure();`. `$httpOnly` HTTP only cookie, `TRUE` by default. Returns boolean True if cookie has been set. Throws RuntimeException If HTTP headers have been sent.
`public boolean`	# `DeleteCookie( string $name, string $path = '/', string $domain = NULL, boolean $secure = NULL )` Delete cookie - set value to empty string and set expiration to past time. Delete cookie - set value to empty string and set expiration to past time. Parameters `$name` Cookie name. Assuming the name is `cookiename`, this value is retrieved through `$_COOKIE['cookiename']`. `$path` The path on the server in which the cookie will be available on. If set to '/', the cookie will be available within the entire domain. `$domain` If not set, value is completed by `\MvcCore\Application::GetInstance()->GetRequest()->GetHostName();` . `$secure` If not set, value is completed by `\MvcCore\Application::GetInstance()->GetRequest()->IsSecure();`. Returns boolean True if cookie has been set. Throws RuntimeException If HTTP headers have been sent.
`public MvcCore\Response`	# `SetDisabledHeaders( string[] $disabledHeaders )` Set disabled headers, never sent except if there is rendered exception in development environment. Set disabled headers, never sent except if there is rendered exception in development environment. Parameters `$disabledHeaders` Returns `MvcCore\Response`
`public string[]`	# `GetDisabledHeaders( )` Get disabled headers, never sent except if there is rendered exception in development environment. Get disabled headers, never sent except if there is rendered exception in development environment. Returns string[]

Constants inherited from MvcCore\Response\IConstants
`HEADER_X_MVCCORE_CPU_RAM, INTERNAL_SERVER_ERROR, MOVED_PERMANENTLY, NOT_FOUND, OK, SEE_OTHER`

Classes

Interfaces

Traits

Exceptions

Functions

Interface IResponse

Direct known implementers

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Returns