HumHub Documentation (unofficial)

Stream extends Response

in package

• Application

Represents an HTTP response message as PHP stream resource

Table of Contents

Constants

STATUS_CODE_100  = 100

STATUS_CODE_101  = 101

STATUS_CODE_102  = 102

STATUS_CODE_200  = 200

STATUS_CODE_201  = 201

STATUS_CODE_202  = 202

STATUS_CODE_203  = 203

STATUS_CODE_204  = 204

STATUS_CODE_205  = 205

STATUS_CODE_206  = 206

STATUS_CODE_207  = 207

STATUS_CODE_208  = 208

STATUS_CODE_226  = 226

STATUS_CODE_300  = 300

STATUS_CODE_301  = 301

STATUS_CODE_302  = 302

STATUS_CODE_303  = 303

STATUS_CODE_304  = 304

STATUS_CODE_305  = 305

STATUS_CODE_306  = 306

STATUS_CODE_307  = 307

STATUS_CODE_308  = 308

STATUS_CODE_400  = 400

STATUS_CODE_401  = 401

STATUS_CODE_402  = 402

STATUS_CODE_403  = 403

STATUS_CODE_404  = 404

STATUS_CODE_405  = 405

STATUS_CODE_406  = 406

STATUS_CODE_407  = 407

STATUS_CODE_408  = 408

STATUS_CODE_409  = 409

STATUS_CODE_410  = 410

STATUS_CODE_411  = 411

STATUS_CODE_412  = 412

STATUS_CODE_413  = 413

STATUS_CODE_414  = 414

STATUS_CODE_415  = 415

STATUS_CODE_416  = 416

STATUS_CODE_417  = 417

STATUS_CODE_418  = 418

STATUS_CODE_422  = 422

STATUS_CODE_423  = 423

STATUS_CODE_424  = 424

STATUS_CODE_425  = 425

STATUS_CODE_426  = 426

STATUS_CODE_428  = 428

STATUS_CODE_429  = 429

STATUS_CODE_431  = 431

STATUS_CODE_444  = 444

STATUS_CODE_451  = 451

STATUS_CODE_499  = 499

STATUS_CODE_500  = 500

STATUS_CODE_501  = 501

STATUS_CODE_502  = 502

STATUS_CODE_503  = 503

STATUS_CODE_504  = 504

STATUS_CODE_505  = 505

STATUS_CODE_506  = 506

STATUS_CODE_507  = 507

STATUS_CODE_508  = 508

STATUS_CODE_510  = 510

STATUS_CODE_511  = 511

STATUS_CODE_599  = 599

STATUS_CODE_CUSTOM  = 0

VERSION_10  = '1.0'

VERSION_11  = '1.1'

VERSION_2  = '2'

Properties

$cleanup  : bool

Should we clean up the stream file when this response is closed?

$content  : mixed

$contentLength  : int

The Content-Length value, if set

$contentStreamed  : int

The portion of the body that has already been streamed

$headers  : Headers|null

$metadata  : array<string|int, mixed>

$reasonPhrase  : string|null

$recommendedReasonPhrases  : array<string|int, mixed>

$statusCode  : int

$stream  : resource

Response as stream

$streamName  : string

The name of the file containing the stream

$version  : string

Methods

__destruct()  : mixed

Destructor

__toString()  : string

Allow PHP casting of this object

fromStream()  : $this

Create a new Laminas\Http\Response\Stream object from a stream

fromString()  : static

Populate object from string

getBody()  : string

Get the response body as string

getCleanup()  : bool

Get the cleanup trigger

getContent()  : mixed

Get message content

getContentLength()  : int|null

Get content length

getCookie()  : array<string|int, SetCookie>

getHeaders()  : Headers

Return the header container responsible for headers

getMetadata()  : mixed

Retrieve all metadata or a single metadatum as specified by key

getRawBody()  : string

Get the raw response body (as transferred "on wire") as string

getReasonPhrase()  : string

Get HTTP status message

getStatusCode()  : int

Retrieve HTTP status code

getStream()  : resource

Get the response as stream

getStreamName()  : string

Get file name associated with the stream

getVersion()  : string

Return the HTTP version for this request

isClientError()  : bool

Does the status code indicate a client error?

isForbidden()  : bool

Is the request forbidden due to ACLs?

isGone()  : bool

Does the status code indicate the resource is gone?

isInformational()  : bool

Is the current status "informational"?

isNotFound()  : bool

Does the status code indicate the resource is not found?

isOk()  : bool

Do we have a normal, OK response?

isRedirect()  : bool

Do we have a redirect?

isServerError()  : bool

Does the status code reflect a server error?

isSuccess()  : bool

Was the response successful?

renderStatusLine()  : string

Render the status line header

setCleanup()  : mixed

Set the cleanup trigger

setContent()  : Message

Set message content

setContentLength()  : mixed

Set content length

setCustomStatusCode()  : $this

Set custom HTTP status code

setHeaders()  : $this

Provide an alternate Parameter Container implementation for headers in this object, (this is NOT the primary API for value setting, for that see getHeaders())

setMetadata()  : Message

Set message metadata

setReasonPhrase()  : $this

setStatusCode()  : $this

Set HTTP status code and (optionally) message

setStream()  : $this

Set the response stream

setStreamName()  : $this

Set file name associated with the stream

setVersion()  : $this

Set the HTTP version for this object, one of 1.0, 1.1 or 2 (AbstractMessage::VERSION_10, AbstractMessage::VERSION_11, AbstractMessage::VERSION_2)

toString()  : string

Render entire response as HTTP response string

decodeChunkedBody()  : string

Decode a "chunked" transfer-encoded body and return the decoded text

decodeDeflate()  : string

Decode a zlib deflated message (when Content-encoding = deflate)

decodeGzip()  : string

Decode a gzip encoded message (when Content-encoding = gzip)

parseStatusLine()  : mixed

readStream()  : string

Read stream content and return it as string

saveStatusCode()  : $this

Assign status code