ICanBoogie/HTTP master
  • Namespace
  • Class

Namespaces

  • ICanBoogie
    • Exception
    • HTTP
      • Headers
      • Request
      • RequestDispatcher

Classes

  • CallableDispatcher
  • DispatcherProvider
  • File
  • FileInfo
  • FileList
  • FileResponse
  • Headers
  • ProvideDispatcher
  • RedirectResponse
  • Request
  • RequestDispatcher
  • RequestOptionsMapper
  • RequestRange
  • Response
  • Status
  • WeightedDispatcher

Interfaces

  • Dispatcher
  • Exception
  • FileOptions
  • RequestMethods
  • RequestOptions
  • ResponseStatus
  • SecurityError

Exceptions

  • AuthenticationRequired
  • ClientError
  • DispatcherNotDefined
  • DispatcherProviderNotDefined
  • ForceRedirect
  • MethodNotSupported
  • NotFound
  • PermissionRequired
  • ServerError
  • ServiceUnavailable
  • StatusCodeNotValid

Functions

  • dispatch
  • get_dispatcher
  • get_initial_request

Class RequestRange

Representation of a request range.

ICanBoogie\HTTP\RequestRange uses ICanBoogie\Accessor\AccessorTrait (not available)
Namespace: ICanBoogie\HTTP
Located at RequestRange.php

Methods summary

public static ICanBoogie\HTTP\RequestRange|null
# from( ICanBoogie\HTTP\Headers $headers, integer $total, string $etag )

Creates a new instance.

Creates a new instance.

Parameters

$headers
$total
$etag

Returns

ICanBoogie\HTTP\RequestRange|null

A new instance, or null if the range is not defined or deprecated (because If-Range doesn't match $etag).

protected
# __construct( integer $start, integer $end, integer $total )

Parameters

$start
$end
$total
public string
# __toString( )

Formats the instance as a string suitable for the Content-Range header field.

Formats the instance as a string suitable for the Content-Range header field.

Returns

string
protected boolean
# get_is_satisfiable( )

Whether the range is satisfiable.

Whether the range is satisfiable.

Returns

boolean
protected boolean
# get_is_total( )

Whether the range is actually the total.

Whether the range is actually the total.

Returns

boolean
protected integer
# get_length( )

Returns the length of the range, suitable for the Content-Length header field.

Returns the length of the range, suitable for the Content-Length header field.

Returns

integer
protected integer
# get_max_length( )

Maximum bytes to copy, suitable for the stream_copy_to_stream() function.

Maximum bytes to copy, suitable for the stream_copy_to_stream() function.

Returns

integer
protected integer
# get_offset( )

Returns the offset where to start to copy data, suitable for the stream_copy_to_stream() function.

Returns the offset where to start to copy data, suitable for the stream_copy_to_stream() function.

Returns

integer

Properties summary

Magic properties

public boolean $is_satisfiable

Whether the range is satisfiable.

public boolean $is_total

Whether the range is actually the total.

public integer $length

Length of the range, suitable for the Content-Length header field.

public integer $max_length

Maximum bytes to copy, suitable for the stream_copy_to_stream() function.

public integer $offset

The offset where to start to copy data, suitable for the stream_copy_to_stream() function.

ICanBoogie/HTTP master API documentation generated by ApiGen