• 홈
• yii
• web
• Response

PHP 클래스 yii\web\Response

It holds the [[headers]], [[cookies]] and [[content]] that is to be sent to the client. It also controls the HTTP [[statusCode|status code]]. Response is configured as an application component in Application by default. You can access that instance via Yii::$app->response. You can modify its configuration by adding an array to your application config under components as it is shown in the following example: php 'response' => [ 'format' => yii\web\Response::FORMAT_JSON, 'charset' => 'UTF-8', ... ] For more details and usage information on Response, see the guide article on responses. 파일 보기 프로젝트 열기: yiisoft/yii2 1 사용 예제들

공개 프로퍼티들

프로퍼티	타입	설명
$acceptMimeType		the MIME type (e.g. application/json) from the request ACCEPT header chosen for this response. This property is mainly set by ContentNegotiator.
$acceptParams		the parameters (e.g. ['q' => 1, 'version' => '1.0']) associated with the [[acceptMimeType|chosen MIME type]]. This is a list of name-value pairs associated with [[acceptMimeType]] from the ACCEPT HTTP header. This property is mainly set by ContentNegotiator.
$charset		the charset of the text response. If not set, it will use the value of [[Application::charset]].
$content		the response content. When [[data]] is not null, it will be converted into [[content]] according to [[format]] when the response is being sent out.
$data		the original response data. When this is not null, it will be converted into [[content]] according to [[format]] when the response is being sent out.
$format		the response format. This determines how to convert [[data]] into [[content]] when the latter is not set. The value of this property must be one of the keys declared in the [[formatters]] array. By default, the following formats are supported: - [[FORMAT_RAW]]: the data will be treated as the response content without any conversion. No extra HTTP header will be added. - [[FORMAT_HTML]]: the data will be treated as the response content without any conversion. The "Content-Type" header will set as "text/html". - [[FORMAT_JSON]]: the data will be converted into JSON format, and the "Content-Type" header will be set as "application/json". - [[FORMAT_JSONP]]: the data will be converted into JSONP format, and the "Content-Type" header will be set as "text/javascript". Note that in this case $data must be an array with "data" and "callback" elements. The former refers to the actual data to be sent, while the latter refers to the name of the JavaScript callback. - [[FORMAT_XML]]: the data will be converted into XML format. Please refer to XmlResponseFormatter for more details. You may customize the formatting process or support additional formats by configuring [[formatters]].
$formatters		the formatters for converting data into the response content of the specified [[format]]. The array keys are the format names, and the array values are the corresponding configurations for creating the formatter objects.
$httpStatuses		list of HTTP status codes and the corresponding texts
$isSent		whether the response has been sent. If this is true, calling Response::send will do nothing.
$statusText		the HTTP status description that comes together with the status code.
$stream		the stream to be sent. This can be a stream handle or an array of stream handle, the begin position and the end position. Note that when this property is set, the [[data]] and [[content]] properties will be ignored by Response::send.
$version		the version of the HTTP protocol to use. If not set, it will be determined via $_SERVER['SERVER_PROTOCOL'], or '1.1' if that is not available.

공개 메소드들

메소드	설명
clear ( )	Clears the headers, cookies, content, status code of the response.
getCookies ( ) : CookieCollection	Returns the cookie collection.
getHeaders ( ) : HeaderCollection	Returns the header collection.
getIsClientError ( ) : boolean
getIsEmpty ( ) : boolean
getIsForbidden ( ) : boolean
getIsInformational ( ) : boolean
getIsInvalid ( ) : boolean
getIsNotFound ( ) : boolean
getIsOk ( ) : boolean
getIsRedirection ( ) : boolean
getIsServerError ( ) : boolean
getIsSuccessful ( ) : boolean
getStatusCode ( ) : integer
init ( )	Initializes this component.
redirect ( string | array $url, integer $statusCode = 302, boolean $checkAjax = true )	Redirects the browser to the specified URL.
refresh ( string $anchor = '' ) : Response	Refreshes the current page.
send ( )	Sends the response to the client.
sendContentAsFile ( string $content, string $attachmentName, array $options = [] )	Sends the specified content as a file to the browser.
sendFile ( string $filePath, string $attachmentName = null, array $options = [] )	Sends a file to the browser.
sendStreamAsFile ( resource $handle, string $attachmentName, array $options = [] )	Sends the specified stream as a file to the browser.
setDownloadHeaders ( string $attachmentName, string $mimeType = null, boolean $inline = false, integer $contentLength = null )	Sets a default set of HTTP headers for file downloading purpose.
setStatusCode ( integer $value, string $text = null )	Sets the response status code.
xSendFile ( string $filePath, string $attachmentName = null, array $options = [] )	Sends existing file to a browser as a download using x-sendfile.

보호된 메소드들

메소드	설명
defaultFormatters ( ) : array
getDispositionHeaderValue ( string $disposition, string $attachmentName ) : string	Returns Content-Disposition header value that is safe to use with both old and new browsers
getHttpRange ( integer $fileSize ) : array | boolean	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

메소드 상세

프로퍼티 상세