Timeframe

class Firstred\PostNL\Entity\Timeframe

Class Timeframe.

Parent: Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

public __construct($City, $CountryCode, $Date, $EndDate, $HouseNr, $HouseNrExt, $Options, $PostalCode, $Street, $SundaySorting, $Interval, $Range, $Timeframes, $StartDate)
public setDate($Date)
public setStartDate($StartDate)
public setEndDate($EndDate)
public setPostalCode($PostalCode)
public setSundaySorting($SundaySorting)
public jsonSerialize()
public xmlSerialize($writer)

Properties

public property Firstred\PostNL\Entity\Timeframe::$defaultProperties

Type: string[][]

protected static property Firstred\PostNL\Entity\Timeframe::$City

Type: string | null

protected static property Firstred\PostNL\Entity\Timeframe::$CountryCode

Type: string | null

protected static property Firstred\PostNL\Entity\Timeframe::$Date

Type: \DateTimeInterface | null

protected static property Firstred\PostNL\Entity\Timeframe::$EndDate

Type: \DateTimeInterface | null

protected static property Firstred\PostNL\Entity\Timeframe::$HouseNr

Type: string | null

protected static property Firstred\PostNL\Entity\Timeframe::$HouseNrExt

Type: string | null

protected static property Firstred\PostNL\Entity\Timeframe::$Options

Type: string[] | null

protected static property Firstred\PostNL\Entity\Timeframe::$PostalCode

Type: string | null

protected static property Firstred\PostNL\Entity\Timeframe::$StartDate

Type: string | null

protected static property Firstred\PostNL\Entity\Timeframe::$Street

Type: string | null

protected static property Firstred\PostNL\Entity\Timeframe::$SundaySorting

Type: bool | null

protected static property Firstred\PostNL\Entity\Timeframe::$Interval

Type: string | null

protected static property Firstred\PostNL\Entity\Timeframe::$TimeframeRange

Type: string | null

protected static property Firstred\PostNL\Entity\Timeframe::$Timeframes

Type: \Firstred\PostNL\Entity\TimeframeTimeFrame[] | \Firstred\PostNL\Entity\Timeframe[] | null

Methods

public Firstred\PostNL\Entity\Timeframe::__construct( $City=null, $CountryCode=null, $Date=null, $EndDate=null, $HouseNr=null, $HouseNrExt=null, $Options=\[\], $PostalCode=null, $Street=null, $SundaySorting=\'false\', $Interval=null, $Range=null, $Timeframes=null, $StartDate=null)

Timeframe constructor.

Parameters

$City (string | null)
$CountryCode (string | null)
$Date (string | \DateTimeInterface | null)
$EndDate (string | \DateTimeInterface | null)
$HouseNr (string | null)
$HouseNrExt (string | null)
$Options (array | null)
$PostalCode (string | null)
$Street (string | null)
$SundaySorting (string | null)
$Interval (string | null)
$Range (string | null)
$Timeframes (Firstred\PostNL\Entity\Timeframe[] | null)
$StartDate (string | \DateTimeInterface | null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\Entity\Timeframe::setDate($Date=null)

Parameters

$Date (null)

Returns

static

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

public Firstred\PostNL\Entity\Timeframe::setStartDate($StartDate=null)

Parameters

$StartDate (string | \DateTimeInterface | null)

Returns

static

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

public Firstred\PostNL\Entity\Timeframe::setEndDate($EndDate=null)

Parameters

$EndDate (string | \DateTimeInterface | null)

Returns

static

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

public Firstred\PostNL\Entity\Timeframe::setPostalCode($PostalCode=null)

Set the postcode.

Parameters

$PostalCode (string | null)

Returns

static

public Firstred\PostNL\Entity\Timeframe::setSundaySorting($SundaySorting=null)

Parameters

$SundaySorting (string | bool | int | null)

Returns

\Firstred\PostNL\Entity\Timeframe

Since

1.0.0

Since

1.0.0

public Firstred\PostNL\Entity\Timeframe::jsonSerialize()

Return a serializable array for `json_encode`.

Returns: array

public Firstred\PostNL\Entity\Timeframe::xmlSerialize($writer)

Return a serializable array for the XMLWriter.

Parameters

$writer (Sabre\Xml\Writer)

Returns

void

Throws

\Firstred\PostNL\Exception\InvalidArgumentException