Alpha Framework 3.1.0 API Documentation

Date extends Type implements TypeInterface

The Date complex data type.

Tags
since
1.0
author

John Collins dev@alphaframework.org

license

http://www.opensource.org/licenses/bsd-license.php The BSD License

copyright

Copyright (c) 2019, John Collins (founder of Alpha Framework). All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
following conditions are met:

* Redistributions of source code must retain the above
  copyright notice, this list of conditions and the
  following disclaimer.
* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the
  following disclaimer in the documentation and/or other
  materials provided with the distribution.
* Neither the name of the Alpha Framework nor the names
  of its contributors may be used to endorse or promote
  products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Interfaces, Classes and Traits

TypeInterface
The interface for all complex data types.

Table of Contents

$helper  : string
The error message returned for invalid values.
$day  : string
The day part.
$month  : string
The month part.
$monthName  : string
The textual version of the month, e.g. July.
$validationRule  : string
The validation rule (reg-ex) applied to Date values.
$weekday  : string
The textual version of the day, e.g. Monday.
$year  : string
The year part.
__construct()  : mixed
Constructor. Leave $date param empty to default to now.
__toString()  : string
Used to convert the object to a printable string.
getDay()  : string
Get the day part.
getEuroValue()  : string
Get the date value as a string in the format "DD/MM/YYYY".
getHelper()  : string
Used to get the validation helper message string.
getMonth()  : string
Get the month part.
getMonthName()  : string
Get the month part.
getRule()  : string
Get the validation rule.
getStartAndEndDate()  : array<string|int, mixed>
Get the start date and the end date of the week of the year provided
getUnixValue()  : int
Return the value in UNIX timestamp format.
getUSValue()  : string
Get the date value as a string in the format "MM/DD/YYYY".
getValue()  : string
Get the date value as a string in the format "YYYY-MM-DD".
getWeekday()  : string
Get the textual weekday part, e.g. Monday.
getYear()  : string
Get the year part.
increment()  : mixed
Increment the cunrrent date by the amount provided
populateFromString()  : mixed
Accepts a full date string in YYYY-MM-DD format and populates relevent Date attributes.
setDateValue()  : mixed
Set the Date attributes to match the three values provided.
setHelper()  : mixed
Set the validation helper text.
setRule()  : mixed
Set the validation rule.
setValue()  : mixed
Accepts a full date string in ISO YYYY-mm-dd format and populates relevent Date attributes.

Properties

$helper

The error message returned for invalid values.

protected string $helper = 'Not a valid date value! A date should be in the ISO format YYYY-MM-DD.'
Tags
since
1.0

$day

The day part.

private string $day
Tags
since
1.0

$month

The month part.

private string $month
Tags
since
1.0

$monthName

The textual version of the month, e.g. July.

private string $monthName
Tags
since
3.1

$validationRule

The validation rule (reg-ex) applied to Date values.

private string $validationRule
Tags
since
1.0

$weekday

The textual version of the day, e.g. Monday.

private string $weekday
Tags
since
1.0

$year

The year part.

private string $year
Tags
since
1.0

Methods

__construct()

Constructor. Leave $date param empty to default to now.

public __construct([string $date = '' ]) : mixed
Parameters
$date : string = ''

Date string in the ISO format YYYY-MM-DD.

Tags
since
1.0
throws
IllegalArguementException
Return values
mixed —

__toString()

Used to convert the object to a printable string.

public __toString() : string
Tags
since
1.0
Return values
string —

getDay()

Get the day part.

public getDay() : string
Tags
since
1.0
Return values
string —

getEuroValue()

Get the date value as a string in the format "DD/MM/YYYY".

public getEuroValue() : string
Tags
since
1.0
Return values
string —

getHelper()

Used to get the validation helper message string.

public getHelper() : string
Tags
since
1.0
Return values
string —

getMonth()

Get the month part.

public getMonth() : string
Tags
since
1.0
Return values
string —

getMonthName()

Get the month part.

public getMonthName() : string
Tags
since
3.1
Return values
string —

getRule()

Get the validation rule.

public getRule() : string
Tags
since
1.0
Return values
string —

getStartAndEndDate()

Get the start date and the end date of the week of the year provided

public static getStartAndEndDate(mixed $week, mixed $year) : array<string|int, mixed>
Parameters
$week : mixed
$year : mixed
Tags
since
3.1.0
Return values
array<string|int, mixed> —

An array containing the "start" date and "end" date.

getUnixValue()

Return the value in UNIX timestamp format.

public getUnixValue() : int
Tags
since
1.0
Return values
int —

getUSValue()

Get the date value as a string in the format "MM/DD/YYYY".

public getUSValue() : string
Tags
since
1.0
Return values
string —

getValue()

Get the date value as a string in the format "YYYY-MM-DD".

public getValue() : string
Tags
since
1.0
Return values
string —

getWeekday()

Get the textual weekday part, e.g. Monday.

public getWeekday() : string
Tags
since
1.0
Return values
string —

getYear()

Get the year part.

public getYear() : string
Tags
since
1.0
Return values
string —

increment()

Increment the cunrrent date by the amount provided

public increment(string $amount) : mixed
Parameters
$amount : string

The amount to increment the date by, e.g. "1 day"

Tags
since
3.1.0
Return values
mixed —

populateFromString()

Accepts a full date string in YYYY-MM-DD format and populates relevent Date attributes.

public populateFromString(string $date) : mixed
Parameters
$date : string
Tags
throws
IllegalArguementException
since
1.0
Return values
mixed —

setDateValue()

Set the Date attributes to match the three values provided.

public setDateValue(int $year, int $month, int $day) : mixed
Parameters
$year : int
$month : int
$day : int
Tags
throws
IllegalArguementException
since
1.0
Return values
mixed —

setHelper()

Set the validation helper text.

public setHelper(string $helper) : mixed
Parameters
$helper : string
Tags
since
1.0
Return values
mixed —

setRule()

Set the validation rule.

public setRule(string $rule) : mixed
Parameters
$rule : string
Tags
since
1.0
Return values
mixed —

setValue()

Accepts a full date string in ISO YYYY-mm-dd format and populates relevent Date attributes.

public setValue(string $date) : mixed
Parameters
$date : string
Tags
since
1.0
throws
IllegalArguementException
Return values
mixed —

Search results