Timeframe

class Firstred\PostNL\Entity\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 getCity()
public setCity($City)
public getCountryCode()
public setCountryCode($CountryCode)
public getHouseNr()
public setHouseNr($HouseNr)
public getHouseNrExt()
public setHouseNrExt($HouseNrExt)
public getOptions()
public setOptions($Options)
public getStreet()
public setStreet($Street)
public getInterval()
public setInterval($Interval)
public getTimeframeRange()
public setTimeframeRange($TimeframeRange)
public getTimeframes()
public setTimeframes($Timeframes)
public getDate()
public getEndDate()
public getPostalCode()
public getStartDate()
public getSundaySorting()
public setSundaySorting($SundaySorting)
public jsonSerialize()

Properties

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:: \DateTimeInterface | 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, string|\\DateTimeInterface|null $Date=null, string|\\DateTimeInterface|null $EndDate=null, $HouseNr=null, $HouseNrExt=null, $Options=\[\], $PostalCode=null, $Street=null, $SundaySorting=\'false\', $Interval=null, $Range=null, $Timeframes=null, string|\\DateTimeInterface|null $StartDate=null)

Throws:: \Firstred\PostNL\Exception\InvalidArgumentException

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

Throws:: \Firstred\PostNL\Exception\InvalidArgumentException
Since:: 1.2.0

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

Throws:: \Firstred\PostNL\Exception\InvalidArgumentException
Since:: 1.2.0

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

Throws:: \Firstred\PostNL\Exception\InvalidArgumentException
Since:: 1.2.0

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

Parameters:

$PostalCode (string | null)

Returns:

static

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

Returns:: string | null

public Firstred\PostNL\Entity\Timeframe::setCity($City)

Parameters:

$City (string | null)

Returns:

\Firstred\PostNL\Entity\Timeframe

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

Returns:: string | null

public Firstred\PostNL\Entity\Timeframe::setCountryCode($CountryCode)

Parameters:

$CountryCode (string | null)

Returns:

\Firstred\PostNL\Entity\Timeframe

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

Returns:: string | null

public Firstred\PostNL\Entity\Timeframe::setHouseNr($HouseNr)

Parameters:

$HouseNr (string | null)

Returns:

\Firstred\PostNL\Entity\Timeframe

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

Returns:: string | null

public Firstred\PostNL\Entity\Timeframe::setHouseNrExt($HouseNrExt)

Parameters:

$HouseNrExt (string | null)

Returns:

\Firstred\PostNL\Entity\Timeframe

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

Returns:: array | null

public Firstred\PostNL\Entity\Timeframe::setOptions($Options)

Parameters:

$Options (array | null)

Returns:

\Firstred\PostNL\Entity\Timeframe

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

Returns:: string | null

public Firstred\PostNL\Entity\Timeframe::setStreet($Street)

Parameters:

$Street (string | null)

Returns:

static

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

Returns:: string | null

public Firstred\PostNL\Entity\Timeframe::setInterval($Interval)

Parameters:

$Interval (string | null)

Returns:

static

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

Returns:: string | null

public Firstred\PostNL\Entity\Timeframe::setTimeframeRange($TimeframeRange)

Parameters:

$TimeframeRange (string | null)

Returns:

static

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

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

public Firstred\PostNL\Entity\Timeframe::setTimeframes($Timeframes)

Parameters:

$Timeframes (Firstred\PostNL\Entity\TimeframeTimeFrame[] | \Firstred\PostNL\Entity\Timeframe[] | null)

Returns:

static

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

Returns:: \DateTimeInterface | null

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

Returns:: \DateTimeInterface | null

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

Returns:: string | null

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

Returns:: \DateTimeInterface | null

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

Returns:: bool | null

public Firstred\PostNL\Entity\Timeframe::setSundaySorting(string|bool|int|null $SundaySorting=null)

Since:: 1.0.0
Since:: 1.0.0

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

Returns:: array
Throws:: \Firstred\PostNL\Exception\ServiceNotSetException