Open Journal Systems  3.3.0
Symfony\Component\HttpFoundation\StreamedResponse Class Reference
Inheritance diagram for Symfony\Component\HttpFoundation\StreamedResponse:
Symfony\Component\HttpFoundation\Response

Public Member Functions

 __construct (callable $callback=null, $status=200, $headers=array())
 
 __construct (callable $callback=null, int $status=200, array $headers=[])
 
 getContent ()
 
 getContent ()
 
 sendContent ()
 
 sendContent ()
 
 sendHeaders ()
 
 sendHeaders ()
 
 setCallback (callable $callback)
 
 setCallback (callable $callback)
 
 setContent ($content)
 
 setContent ($content)
 
- Public Member Functions inherited from Symfony\Component\HttpFoundation\Response
 __clone ()
 
 __clone ()
 
 __construct ($content='', $status=200, $headers=array())
 
 __construct ($content='', int $status=200, array $headers=[])
 
 __toString ()
 
 __toString ()
 
 expire ()
 
 expire ()
 
 getAge ()
 
 getAge ()
 
 getCharset ()
 
 getCharset ()
 
 getDate ()
 
 getDate ()
 
 getEtag ()
 
 getEtag ()
 
 getExpires ()
 
 getExpires ()
 
 getLastModified ()
 
 getLastModified ()
 
 getMaxAge ()
 
 getMaxAge ()
 
 getProtocolVersion ()
 
 getProtocolVersion ()
 
 getStatusCode ()
 
 getStatusCode ()
 
 getTtl ()
 
 getTtl ()
 
 getVary ()
 
 getVary ()
 
 hasVary ()
 
 hasVary ()
 
 isCacheable ()
 
 isCacheable ()
 
 isClientError ()
 
 isClientError ()
 
 isEmpty ()
 
 isEmpty ()
 
 isForbidden ()
 
 isForbidden ()
 
 isFresh ()
 
 isFresh ()
 
 isImmutable ()
 
 isInformational ()
 
 isInformational ()
 
 isInvalid ()
 
 isInvalid ()
 
 isNotFound ()
 
 isNotFound ()
 
 isNotModified (Request $request)
 
 isNotModified (Request $request)
 
 isOk ()
 
 isOk ()
 
 isRedirect ($location=null)
 
 isRedirect (string $location=null)
 
 isRedirection ()
 
 isRedirection ()
 
 isServerError ()
 
 isServerError ()
 
 isSuccessful ()
 
 isSuccessful ()
 
 isValidateable ()
 
 isValidateable ()
 
 mustRevalidate ()
 
 mustRevalidate ()
 
 prepare (Request $request)
 
 prepare (Request $request)
 
 send ()
 
 send ()
 
 setCache (array $options)
 
 setCache (array $options)
 
 setCharset ($charset)
 
 setCharset (string $charset)
 
 setClientTtl ($seconds)
 
 setClientTtl (int $seconds)
 
 setDate (\DateTime $date)
 
 setDate (\DateTimeInterface $date)
 
 setEtag ($etag=null, $weak=false)
 
 setEtag (string $etag=null, bool $weak=false)
 
 setExpires (\DateTime $date=null)
 
 setExpires (\DateTimeInterface $date=null)
 
 setImmutable (bool $immutable=true)
 
 setLastModified (\DateTime $date=null)
 
 setLastModified (\DateTimeInterface $date=null)
 
 setMaxAge ($value)
 
 setMaxAge (int $value)
 
 setNotModified ()
 
 setNotModified ()
 
 setPrivate ()
 
 setPrivate ()
 
 setProtocolVersion ($version)
 
 setProtocolVersion (string $version)
 
 setPublic ()
 
 setPublic ()
 
 setSharedMaxAge ($value)
 
 setSharedMaxAge (int $value)
 
 setStatusCode ($code, $text=null)
 
 setStatusCode (int $code, $text=null)
 
 setTtl ($seconds)
 
 setTtl (int $seconds)
 
 setVary ($headers, $replace=true)
 
 setVary ($headers, bool $replace=true)
 

Static Public Member Functions

static create ($callback=null, $status=200, $headers=[])
 
static create ($callback=null, $status=200, $headers=array())
 
- Static Public Member Functions inherited from Symfony\Component\HttpFoundation\Response
static closeOutputBuffers ($targetLevel, $flush)
 
static closeOutputBuffers (int $targetLevel, bool $flush)
 

Protected Attributes

 $callback
 
 $streamed
 
- Protected Attributes inherited from Symfony\Component\HttpFoundation\Response
 $charset
 
 $content
 
 $statusCode
 
 $statusText
 
 $version
 

Additional Inherited Members

- Data Fields inherited from Symfony\Component\HttpFoundation\Response
 $headers
 
const HTTP_ACCEPTED = 202
 
const HTTP_ALREADY_REPORTED = 208
 
const HTTP_BAD_GATEWAY = 502
 
const HTTP_BAD_REQUEST = 400
 
const HTTP_CONFLICT = 409
 
const HTTP_CONTINUE = 100
 
const HTTP_CREATED = 201
 
const HTTP_EARLY_HINTS = 103
 
const HTTP_EXPECTATION_FAILED = 417
 
const HTTP_FAILED_DEPENDENCY = 424
 
const HTTP_FORBIDDEN = 403
 
const HTTP_FOUND = 302
 
const HTTP_GATEWAY_TIMEOUT = 504
 
const HTTP_GONE = 410
 
const HTTP_I_AM_A_TEAPOT = 418
 
const HTTP_IM_USED = 226
 
const HTTP_INSUFFICIENT_STORAGE = 507
 
const HTTP_INTERNAL_SERVER_ERROR = 500
 
const HTTP_LENGTH_REQUIRED = 411
 
const HTTP_LOCKED = 423
 
const HTTP_LOOP_DETECTED = 508
 
const HTTP_METHOD_NOT_ALLOWED = 405
 
const HTTP_MISDIRECTED_REQUEST = 421
 
const HTTP_MOVED_PERMANENTLY = 301
 
const HTTP_MULTI_STATUS = 207
 
const HTTP_MULTIPLE_CHOICES = 300
 
const HTTP_NETWORK_AUTHENTICATION_REQUIRED = 511
 
const HTTP_NO_CONTENT = 204
 
const HTTP_NON_AUTHORITATIVE_INFORMATION = 203
 
const HTTP_NOT_ACCEPTABLE = 406
 
const HTTP_NOT_EXTENDED = 510
 
const HTTP_NOT_FOUND = 404
 
const HTTP_NOT_IMPLEMENTED = 501
 
const HTTP_NOT_MODIFIED = 304
 
const HTTP_OK = 200
 
const HTTP_PARTIAL_CONTENT = 206
 
const HTTP_PAYMENT_REQUIRED = 402
 
const HTTP_PERMANENTLY_REDIRECT = 308
 
const HTTP_PRECONDITION_FAILED = 412
 
const HTTP_PRECONDITION_REQUIRED = 428
 
const HTTP_PROCESSING = 102
 
const HTTP_PROXY_AUTHENTICATION_REQUIRED = 407
 
const HTTP_REQUEST_ENTITY_TOO_LARGE = 413
 
const HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE = 431
 
const HTTP_REQUEST_TIMEOUT = 408
 
const HTTP_REQUEST_URI_TOO_LONG = 414
 
const HTTP_REQUESTED_RANGE_NOT_SATISFIABLE = 416
 
const HTTP_RESERVED = 306
 
const HTTP_RESERVED_FOR_WEBDAV_ADVANCED_COLLECTIONS_EXPIRED_PROPOSAL = 425
 
const HTTP_RESET_CONTENT = 205
 
const HTTP_SEE_OTHER = 303
 
const HTTP_SERVICE_UNAVAILABLE = 503
 
const HTTP_SWITCHING_PROTOCOLS = 101
 
const HTTP_TEMPORARY_REDIRECT = 307
 
const HTTP_TOO_EARLY = 425
 
const HTTP_TOO_MANY_REQUESTS = 429
 
const HTTP_UNAUTHORIZED = 401
 
const HTTP_UNAVAILABLE_FOR_LEGAL_REASONS = 451
 
const HTTP_UNPROCESSABLE_ENTITY = 422
 
const HTTP_UNSUPPORTED_MEDIA_TYPE = 415
 
const HTTP_UPGRADE_REQUIRED = 426
 
const HTTP_USE_PROXY = 305
 
const HTTP_VARIANT_ALSO_NEGOTIATES_EXPERIMENTAL = 506
 
const HTTP_VERSION_NOT_SUPPORTED = 505
 
- Static Public Attributes inherited from Symfony\Component\HttpFoundation\Response
static $statusTexts
 
- Protected Member Functions inherited from Symfony\Component\HttpFoundation\Response
 ensureIEOverSSLCompatibility (Request $request)
 
 ensureIEOverSSLCompatibility (Request $request)
 

Detailed Description

StreamedResponse represents a streamed HTTP response.

A StreamedResponse uses a callback for its content.

The callback should use the standard PHP functions like echo to stream the response back to the client. The flush() method can also be used if needed.

See also
flush()
Author
Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

StreamedResponse represents a streamed HTTP response.

A StreamedResponse uses a callback for its content.

The callback should use the standard PHP functions like echo to stream the response back to the client. The flush() function can also be used if needed.

See also
flush()
Author
Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Definition at line 27 of file lib/vendor/symfony/http-foundation/StreamedResponse.php.

Constructor & Destructor Documentation

◆ __construct() [1/2]

Symfony\Component\HttpFoundation\StreamedResponse::__construct ( callable  $callback = null,
  $status = 200,
  $headers = array() 
)

Constructor.

Parameters
callable | null$callbackA valid PHP callback or null to set it later
int$statusThe response status code
array$headersAn array of response headers

Definition at line 40 of file lib/vendor/symfony/http-foundation/StreamedResponse.php.

References Symfony\Component\HttpFoundation\StreamedResponse\$callback, Symfony\Component\HttpFoundation\Response\$headers, and Symfony\Component\HttpFoundation\StreamedResponse\setCallback().

◆ __construct() [2/2]

Symfony\Component\HttpFoundation\StreamedResponse::__construct ( callable  $callback = null,
int  $status = 200,
array  $headers = [] 
)
Parameters
callable | null$callbackA valid PHP callback or null to set it later
int$statusThe response status code
array$headersAn array of response headers

Definition at line 38 of file vendor/symfony/http-foundation/StreamedResponse.php.

References Symfony\Component\HttpFoundation\StreamedResponse\$callback, Symfony\Component\HttpFoundation\Response\$headers, and Symfony\Component\HttpFoundation\StreamedResponse\setCallback().

Member Function Documentation

◆ create() [1/2]

static Symfony\Component\HttpFoundation\StreamedResponse::create (   $callback = null,
  $status = 200,
  $headers = [] 
)
static

Factory method for chainability.

Parameters
callable | null$callbackA valid PHP callback or null to set it later
int$statusThe response status code
array$headersAn array of response headers
Returns
static

Reimplemented from Symfony\Component\HttpFoundation\Response.

Definition at line 58 of file vendor/symfony/http-foundation/StreamedResponse.php.

References Symfony\Component\HttpFoundation\StreamedResponse\$callback, and Symfony\Component\HttpFoundation\Response\$headers.

◆ create() [2/2]

static Symfony\Component\HttpFoundation\StreamedResponse::create (   $callback = null,
  $status = 200,
  $headers = array() 
)
static

Factory method for chainability.

Parameters
callable | null$callbackA valid PHP callback or null to set it later
int$statusThe response status code
array$headersAn array of response headers
Returns
static

Reimplemented from Symfony\Component\HttpFoundation\Response.

Definition at line 60 of file lib/vendor/symfony/http-foundation/StreamedResponse.php.

References Symfony\Component\HttpFoundation\StreamedResponse\$callback, and Symfony\Component\HttpFoundation\Response\$headers.

Referenced by Symfony\Component\HttpFoundation\Tests\StreamedResponseTest\testCreate().

◆ getContent() [1/2]

Symfony\Component\HttpFoundation\StreamedResponse::getContent ( )

{Gets the current response content.

Returns
string Content
}

Returns
false

Reimplemented from Symfony\Component\HttpFoundation\Response.

Definition at line 128 of file lib/vendor/symfony/http-foundation/StreamedResponse.php.

◆ getContent() [2/2]

Symfony\Component\HttpFoundation\StreamedResponse::getContent ( )

{Gets the current response content.

Returns
string Content
}

Reimplemented from Symfony\Component\HttpFoundation\Response.

Definition at line 138 of file vendor/symfony/http-foundation/StreamedResponse.php.

◆ sendContent() [1/2]

Symfony\Component\HttpFoundation\StreamedResponse::sendContent ( )

{Sends content for the current web response.

Returns
$this
}

This method only sends the content once.

Reimplemented from Symfony\Component\HttpFoundation\Response.

Definition at line 96 of file lib/vendor/symfony/http-foundation/StreamedResponse.php.

◆ sendContent() [2/2]

Symfony\Component\HttpFoundation\StreamedResponse::sendContent ( )

{Sends content for the current web response.

Returns
$this
}

This method only sends the content once.

Returns
$this

Reimplemented from Symfony\Component\HttpFoundation\Response.

Definition at line 100 of file vendor/symfony/http-foundation/StreamedResponse.php.

References Symfony\Component\HttpFoundation\StreamedResponse\$callback.

◆ sendHeaders() [1/2]

Symfony\Component\HttpFoundation\StreamedResponse::sendHeaders ( )

{Sends HTTP headers.

Returns
$this
}

This method only sends the headers once.

Reimplemented from Symfony\Component\HttpFoundation\Response.

Definition at line 80 of file lib/vendor/symfony/http-foundation/StreamedResponse.php.

◆ sendHeaders() [2/2]

Symfony\Component\HttpFoundation\StreamedResponse::sendHeaders ( )

{Sends HTTP headers.

Returns
$this
}

This method only sends the headers once.

Returns
$this

Reimplemented from Symfony\Component\HttpFoundation\Response.

Definition at line 82 of file vendor/symfony/http-foundation/StreamedResponse.php.

◆ setCallback() [1/2]

Symfony\Component\HttpFoundation\StreamedResponse::setCallback ( callable  $callback)

Sets the PHP callback associated with this Response.

Returns
$this

Definition at line 68 of file vendor/symfony/http-foundation/StreamedResponse.php.

References Symfony\Component\HttpFoundation\StreamedResponse\$callback.

◆ setCallback() [2/2]

Symfony\Component\HttpFoundation\StreamedResponse::setCallback ( callable  $callback)

Sets the PHP callback associated with this Response.

Parameters
callable$callbackA valid PHP callback

Definition at line 70 of file lib/vendor/symfony/http-foundation/StreamedResponse.php.

References Symfony\Component\HttpFoundation\StreamedResponse\$callback.

Referenced by Symfony\Component\HttpFoundation\StreamedResponse\__construct().

◆ setContent() [1/2]

Symfony\Component\HttpFoundation\StreamedResponse::setContent (   $content)

{Sets the response content.Valid types are strings, numbers, null, and objects that implement a __toString() method.

Parameters
mixed$contentContent that can be cast to string
Returns
$this
Exceptions
}

Exceptions

Reimplemented from Symfony\Component\HttpFoundation\Response.

Definition at line 116 of file lib/vendor/symfony/http-foundation/StreamedResponse.php.

References Symfony\Component\HttpFoundation\Response\$content.

◆ setContent() [2/2]

Symfony\Component\HttpFoundation\StreamedResponse::setContent (   $content)

{Sets the response content.Valid types are strings, numbers, null, and objects that implement a __toString() method.

Parameters
mixed$contentContent that can be cast to string
Returns
$this
Exceptions
}

Exceptions

Reimplemented from Symfony\Component\HttpFoundation\Response.

Definition at line 124 of file vendor/symfony/http-foundation/StreamedResponse.php.

References Symfony\Component\HttpFoundation\Response\$content.

Field Documentation

◆ $callback

◆ $streamed

Symfony\Component\HttpFoundation\StreamedResponse::$streamed
protected

The documentation for this class was generated from the following file: