Method Details

getContentType() public method #

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

public string, null getContentType ( )

prepare() protected method #

Prepares for sending the response.

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

protected void prepare ( )

sendAndClose() public method #

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.

public void sendAndClose ( )

sendContentAsFile() public method #

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

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

sendFile() public method #

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

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

setCacheHeaders() public method #

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

public static setCacheHeaders ( )

setLastModifiedHeader() public method #

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

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