PHP Interface Icicle\Http\Message\Response

Inheritance: extends Icicle\Http\Message\Message

Show file Open project: icicleio/http Interface Usage Examples

Public Methods

Method	Description
getCookie ( string $name ) : Icicle\Http\Message\Cookie\MetaCookie \| null
getCookies ( ) : array
getReasonPhrase ( ) : string	Returns the reason phrase describing the status code.
getStatusCode ( ) : integer	Returns the response status code.
hasCookie ( string $name ) : boolean
withCookie ( string $name, string $value = '', integer $expires, string $path = '', string $domain = '', boolean $secure = false, boolean $httpOnly = false ) : Icicle\Http\Message\Response
withStatus ( integer $code, string $reason = '' ) : Icicle\Http\Message\Response	Returns a new instance with the given status.
withoutCookie ( string $name ) : Icicle\Http\Message\Response

Method Details

getCookie() public method

public getCookie ( string $name ) : Icicle\Http\Message\Cookie\MetaCookie \| null
$name	string
return	Icicle\Http\Message\Cookie\MetaCookie \| null

getCookies() public method

public getCookies ( ) : array
return	array

getReasonPhrase() public method

Returns the reason phrase describing the status code.

public getReasonPhrase ( ) : string
return	string

getStatusCode() public method

Returns the response status code.

public getStatusCode ( ) : integer
return	integer

hasCookie() public method

public hasCookie ( string $name ) : boolean
$name	string
return	boolean

withCookie() public method

public withCookie ( string $name, string $value = '', integer $expires, string $path = '', string $domain = '', boolean $secure = false, boolean $httpOnly = false ) : Icicle\Http\Message\Response
$name	string
$value	string
$expires	integer
$path	string
$domain	string
$secure	boolean
$httpOnly	boolean
return	Icicle\Http\Message\Response

withStatus() public method

Returns a new instance with the given status.

public withStatus ( integer $code, string $reason = '' ) : Icicle\Http\Message\Response
$code	integer	3-digit status code.
$reason	string	Description of status code or null to use default reason associated with the status code given.
return	Icicle\Http\Message\Response

withoutCookie() public method

public withoutCookie ( string $name ) : Icicle\Http\Message\Response
$name	string
return	Icicle\Http\Message\Response