Class Response

Summary

Fully Qualified Name: Zend\Console\Response
Extends: Message
Implements: ResponseInterface

Description

Methods

Name Description Defined By
contentSent() Check if content was sent Response
getContent() Get message content Message
getErrorLevel() Response
getMetadata() Retrieve all metadata or a single metadatum as specified by key Message
send() Response
sendContent() Send content Response
setContent() Set message content Message
setErrorLevel() Set the error level that will be returned to shell. Response
setMetadata() Set message metadata Message
toString() Message

Method Details

contentSent()

Check if content was sent

Returns: bool

getContent()

Get message content

Returns: mixed

getErrorLevel()

Returns: void

getMetadata()

Retrieve all metadata or a single metadatum as specified by key

Parameter Name Type Description
$key null|string|int
$default null|mixed

Returns: mixed

send()

Returns:

sendContent()

Send content

Returns: \Response

setContent()

Set message content

Parameter Name Type Description
$value mixed

Returns: \Message

setErrorLevel()

Set the error level that will be returned to shell.

Parameter Name Type Description
$errorLevel int

Returns: \Response

setMetadata()

Set message metadata

Non-destructive setting of message metadata; always adds to the metadata, never overwrites the entire metadata container.

Parameter Name Type Description
$spec string|int|array|\Traversable
$value mixed

Returns: \Message

toString()

Returns: string

Top