Response

Type
Class
Namespace
craft\web
Inherits
craft\web\Response » yii\web\Response » yii\base\Response » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.0

View source

Public Properties

PropertyDescription
$acceptMimeTypestring – The MIME type (e.g. application/json) from the request ACCEPT header chosen for this response.
$acceptParamsarray – The parameters (e.g. `['q' => 1, 'version' => '1.
$behaviorsyii\base\Behavior – List of behaviors attached to this component
$charsetstring – The charset of the text response.
$contentstring – The response content.
$contentTypestring, null
$cookiesyii\web\CookieCollection – The cookie collection.
$datamixed – The original response data.
$downloadHeadersstring – The attachment file name
$exitStatusinteger – The exit status.
$formatstring – The response format.
$formattersarray – The formatters for converting data into the response content of the specified $format.
$headersyii\web\HeaderCollection – The header collection
$httpStatusesarray – List of HTTP status codes and the corresponding texts
$isClientErrorboolean – Whether this response indicates a client error
$isEmptyboolean – Whether this response is empty
$isForbiddenboolean – Whether this response indicates the current request is forbidden
$isInformationalboolean – Whether this response is informational
$isInvalidboolean – Whether this response has a valid $statusCode.
$isNotFoundboolean – Whether this response indicates the currently requested resource is not found
$isOkboolean – Whether this response is OK
$isRedirectionboolean – Whether this response is a redirection
$isSentboolean – Whether the response has been sent.
$isServerErrorboolean – Whether this response indicates a server error
$isSuccessfulboolean – Whether this response is successful
$lastModifiedHeaderstring – The file to read the last modified date from.
$statusCodeinteger – The HTTP status code to send with the response.
$statusCodeByExceptionException, Error – The exception object.
$statusTextstring – The HTTP status description that comes together with the status code.
$streamresource, array – The stream to be sent.
$versionstring – The version of the HTTP protocol to use.

$contentType

Type
string, null
Access
Read-only

View source

Signature

public string, null getContentType ( )

$lastModifiedHeader

Type
string
Access
Write-only

The file to read the last modified date from.

View source

Signature

public static setLastModifiedHeader ( \craft\web\string $path )

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()This method is called after the object is created by cloning an existing one.
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to null.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
behaviors()Returns a list of behaviors that this component should behave as.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
clear()Clears the headers, cookies, content, status code of the response.
clearOutputBuffers()Removes all existing output buffers.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
ensureBehaviors()Makes sure that the behaviors declared in behaviors() are attached to this component.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getContentType()Returns the Content-Type header (sans charset=X) that the response will most likely include.
getCookies()Returns the cookie collection.
getHeaders()Returns the header collection.
getIsClientError()
getIsEmpty()
getIsForbidden()
getIsInformational()
getIsInvalid()
getIsNotFound()
getIsOk()
getIsRedirection()
getIsServerError()
getIsSuccessful()
getStatusCode()
hasEventHandlers()Returns a value indicating whether there is any handler attached to the named event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
init()Initializes the object.
off()Detaches an existing event handler from this component.
on()Attaches an event handler to an event.
redirect()Redirects the browser to the specified URL.
refresh()Refreshes the current page.
send()Sends the response to client.
sendAndClose()Attempts to closes the connection with the HTTP client, without ending PHP script execution.
sendContentAsFile()Sends the specified content as a file to the browser.
sendFile()Sends a file to the browser.
sendStreamAsFile()Sends the specified stream as a file to the browser.
setCacheHeaders()Sets headers that will instruct the client to cache this response.
setDownloadHeaders()Sets a default set of HTTP headers for file downloading purpose.
setLastModifiedHeader()Sets a Last-Modified header based on a given file path.
setStatusCode()Sets the response status code.
setStatusCodeByException()Sets the response status code based on the exception.
trigger()Triggers an event.
xSendFile()Sends existing file to a browser as a download using x-sendfile.

getContentType()

Returns the Content-Type header (sans charset=X) that the response will most likely include.

View source

Returns

string, null

Signature

public string, null getContentType ( )

sendAndClose()

Attempts to closes the connection with the HTTP client, without ending PHP script execution. This method relies on flush(), which may not actually work if mod_deflate or mod_gzip is installed, or if this is a Win32 server. See also http://stackoverflow.com/a/141026 View source

Throws

  • Throwable
    An exception will be thrown if content has already been output.

Signature

public void sendAndClose ( )

sendContentAsFile()

Sends the specified content as a file to the browser.

Note that this method only prepares the response for file sending. The file is not sent until send() is called explicitly or implicitly. The latter is done after you return from a controller action.

\yii\web\Response::sendContentAsFile()

View source

Arguments

  • $content (string) – The content to be sent. The existing $content will be discarded.

  • $attachmentName (string) – The file name shown to the user.

  • $options (array) – Additional options for sending the file. The following options are supported:

  • mimeType: the MIME type of the content. Defaults to 'application/octet-stream'.

  • inline: boolean, whether the browser should open the file within the browser window. Defaults to false, meaning a download dialog will pop up.

Returns

static – Self reference

Throws

Signature

public static sendContentAsFile ( $content, $attachmentName, $options = [] )

sendFile()

Sends a file to the browser.

Note that this method only prepares the response for file sending. The file is not sent until send() is called explicitly or implicitly. The latter is done after you return from a controller action.

The following is an example implementation of a controller action that allows requesting files from a directory that is not accessible from web:

public function actionFile($filename)
{
    $storagePath = Yii::getAlias('@app/files');

    // check filename for allowed chars (do not allow ../ to avoid security issue: downloading arbitrary files)
    if (!preg_match('/^[a-z0-9]+\.[a-z0-9]+$/i', $filename) || !is_file("$storagePath/$filename")) {
        throw new \yii\web\NotFoundHttpException('The file does not exists.');
    }
    return Yii::$app->response->sendFile("$storagePath/$filename", $filename);
}

\yii\web\Response::sendFile()

View source

Arguments

  • $filePath (string) – The path of the file to be sent.

  • $attachmentName (string, null) – The file name shown to the user. If null, it will be determined from $filePath.

  • $options (array) – Additional options for sending the file. The following options are supported:

  • mimeType: the MIME type of the content. If not set, it will be guessed based on $filePath

  • inline: boolean, whether the browser should open the file within the browser window. Defaults to false, meaning a download dialog will pop up.

Returns

static – Self reference

Signature

public static sendFile ( $filePath, $attachmentName = null, $options = [] )

setCacheHeaders()

Sets headers that will instruct the client to cache this response.

View source

Returns

static – Self reference

Signature

public static setCacheHeaders ( )

setLastModifiedHeader()

Sets a Last-Modified header based on a given file path.

View source

Arguments

  • $path (string) – The file to read the last modified date from.

Returns

static – Self reference

Signature

public static setLastModifiedHeader ( \craft\web\string $path )

Protected Methods

MethodDescription
defaultFormatters()
getDispositionHeaderValue()Returns Content-Disposition header value that is safe to use with both old and new browsers.
getHttpRange()Determines the HTTP range given in the request.
prepare()Prepares for sending the response.
sendContent()Sends the response content to the client.
sendCookies()Sends the cookies to the client.
sendHeaders()Sends the response headers to the client.

prepare()

Prepares for sending the response.

The default implementation will convert $data into $content and set headers accordingly.

View source

Throws

Signature

protected void prepare ( )

sendContent()

Sends the response content to the client.

View source

Signature

protected void sendContent ( )

Constants

ConstantDescription
FORMAT_HTML
FORMAT_JSON
FORMAT_JSONP
FORMAT_RAW
FORMAT_XML