Zend Framework » \Zend\Http\Header\RetryAfter

Retry-After HTTP Header

link	http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.37

Methods

Allow casting to string

__toString() : string

Inherited

inherited_from	\Zend\Http\Header\AbstractDate::__toString()

Returns

string

Compare provided date to date for this header Returns < 0 if date in header is less than $date; > 0 if it's greater, and 0 if they are equal.

compareTo(string | \DateTime $date) : int

Inherited

see	\strcmp()
inherited_from	\Zend\Http\Header\AbstractDate::compareTo()

Parameters

$date

string\DateTime

Exceptions

`\Zend\Http\Header\Exception\InvalidArgumentException`

Returns

int

Return date for this header as an instance of \DateTime

date() : \DateTime

Inherited

inherited_from	\Zend\Http\Header\AbstractDate::date()

Returns

\DateTime

Create Retry-After header from string

fromString(string $headerLine) : \Zend\Http\Header\RetryAfter

Parameters

$headerLine

string

Exceptions

`\Zend\Http\Header\Exception\InvalidArgumentException`

Returns

\Zend\Http\Header\RetryAfter

Create date-based header from strtotime()-compatible string

fromTimeString(int | string $time) : \Zend\Http\Header\self

Inherited

inherited_from	\Zend\Http\Header\AbstractDate::fromTimeString()

Parameters

$time

intstring

Exceptions

`\Zend\Http\Header\Exception\InvalidArgumentException`

Returns

\Zend\Http\Header\self

Create date-based header from Unix timestamp

fromTimestamp(int $time) : \Zend\Http\Header\self

Inherited

inherited_from	\Zend\Http\Header\AbstractDate::fromTimestamp()

Parameters

$time

int

Exceptions

`\Zend\Http\Header\Exception\InvalidArgumentException`

Returns

\Zend\Http\Header\self

Return date for this header

getDate() : string

Inherited

inherited_from	\Zend\Http\Header\AbstractDate::getDate()

Returns

string

Return current date output format

getDateFormat() : string

Inherited

inherited_from	\Zend\Http\Header\AbstractDate::getDateFormat()

Returns

string

Get number of seconds

getDeltaSeconds() : int

Returns

int

Get header name

getFieldName() : string

Returns

string

Returns date if it's set, or number of seconds

getFieldValue() : int | string

Returns

intstring

Set the date for this header, this can be a string or an instance of \DateTime

setDate(string | \DateTime $date) : \Zend\Http\Header\AbstractDate

Inherited

inherited_from	\Zend\Http\Header\AbstractDate::setDate()

Parameters

$date

string\DateTime

Exceptions

`\Zend\Http\Header\Exception\InvalidArgumentException`

Returns

\Zend\Http\Header\AbstractDate

Set date output format

setDateFormat(int $format)

Inherited

inherited_from	\Zend\Http\Header\AbstractDate::setDateFormat()

Parameters

$format

int

Exceptions

`\Zend\Http\Header\Exception\InvalidArgumentException`

Set number of seconds

setDeltaSeconds(int $delta) : \Zend\Http\Header\RetryAfter

Parameters

$delta

int

Returns

\Zend\Http\Header\RetryAfter

Return header line

toString() : string

Returns in form of "NAME: VALUE"

Returns

string

Properties

Date instance for this header

$date : \DateTime

Inherited

inherited_from	\Zend\Http\Header\AbstractDate::$$date

Date output format

$dateFormat : string

Inherited

inherited_from	\Zend\Http\Header\AbstractDate::$$dateFormat

Date formats defined by RFC 2616.

$dateFormats : array

Inherited

RFC 1123 date is required RFC 1036 and ANSI C formats are provided for compatibility with old servers/clients

link	http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.3
inherited_from	\Zend\Http\Header\AbstractDate::$$dateFormats

Value of header in delta-seconds By default set to 1 hour

$deltaSeconds : int

Constants

DATE_ANSIC

DATE_ANSIC

Inherited

inherited_from	\Zend\Http\Header\AbstractDate::DATE_ANSIC

DATE_RFC1036

DATE_RFC1036

Inherited

inherited_from	\Zend\Http\Header\AbstractDate::DATE_RFC1036

Date formats according to RFC 2616

DATE_RFC1123

Inherited

link	http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.3
inherited_from	\Zend\Http\Header\AbstractDate::DATE_RFC1123