PHP Class ExpressiveDate

Inheritance: extends DateTime

Afficher le fichier Open project: jasonlewis/expressive-date Class Usage Examples

Protected Properties

Свойство	Type	Description
$defaultDateFormat	string	Default date format used when casting object to string.
$weekStartDay	integer	Starting day of the week, where 0 is Sunday and 1 is Monday.

Méthodes publiques

Méthode	Description
__call ( string $method, array $parameters ) : mixed	Dynamically handle calls for date attributes and testers.
__construct ( string $time = null, string \| DateTimeZone $timezone = null ) : void	Create a new ExpressiveDate instance.
__toString ( ) : string	Return the default date format when casting to string.
addDays ( integer $amount ) : ExpressiveDate	Add a given amount of days.
addHours ( integer $amount ) : ExpressiveDate	Add a given amount of hours.
addMinutes ( integer $amount ) : ExpressiveDate	Add a given amount of minutes.
addMonths ( integer $amount ) : ExpressiveDate	Add a given amount of months.
addOneDay ( ) : ExpressiveDate	Add one day.
addOneHour ( ) : ExpressiveDate	Add one hour.
addOneMinute ( ) : ExpressiveDate	Add one minute.
addOneMonth ( ) : ExpressiveDate	Add one month.
addOneSecond ( ) : ExpressiveDate	Add one second.
addOneWeek ( ) : ExpressiveDate	Add one week.
addOneYear ( ) : ExpressiveDate	Add one year.
addSeconds ( integer $amount ) : ExpressiveDate	Add a given amount of seconds.
addWeeks ( integer $amount ) : ExpressiveDate	Add a given amount of weeks.
addYears ( integer $amount ) : ExpressiveDate	Add a given amount of years.
copy ( ) : ExpressiveDate	Return copy of expressive date object
endOfDay ( ) : ExpressiveDate	Use the end of the day.
endOfMonth ( ) : ExpressiveDate	Use the end of the month.
endOfWeek ( ) : ExpressiveDate	Use the end of the week.
equalTo ( ExpressiveDate $date ) : boolean	Determine if date is equal to another Expressive Date instance.
getDate ( ) : string	Get a date string in the format of 2012-12-04.
getDateTime ( ) : string	Get a date and time string in the format of 2012-12-04 23:43:27.
getDefaultDate ( ) : string	Get a date string in the default format.
getDifferenceInDays ( ExpressiveDate $compare = null ) : string	Get the difference in days.
getDifferenceInHours ( ExpressiveDate $compare = null ) : string	Get the difference in hours.
getDifferenceInMinutes ( ExpressiveDate $compare = null ) : string	Get the difference in minutes.
getDifferenceInMonths ( ExpressiveDate $compare = null ) : string	Get the difference in months.
getDifferenceInSeconds ( ExpressiveDate $compare = null ) : string	Get the difference in seconds.
getDifferenceInYears ( ExpressiveDate $compare = null ) : string	Get the difference in years.
getLongDate ( ) : string	Get a date string in the format of January 31st, 1991 at 7:45am.
getRelativeDate ( ExpressiveDate $compare = null ) : string	Get a relative date string, e.g., 3 days ago.
getShortDate ( ) : string	Get a date string in the format of Jan 31, 1991.
getTime ( ) : string	Get a date string in the format of 07:42:32.
getWeekStartDay ( ) : integer	Get the starting day of the week, where 0 is Sunday and 1 is Monday
greaterOrEqualTo ( ExpressiveDate $date ) : boolean	Determine if date is greater than or equal to another Expressive Date instance.
greaterThan ( ExpressiveDate $date ) : boolean	Determine if date is greater than another Expressive Date instance.
isWeekday ( ) : boolean	Determine if day is a weekday.
isWeekend ( ) : boolean	Determine if day is a weekend.
lessOrEqualTo ( ExpressiveDate $date ) : boolean	Determine if date is less than or equal to another Expressive Date instance.
lessThan ( ExpressiveDate $date ) : boolean	Determine if date is less than another Expressive Date instance.
make ( string $time = null, string \| DateTimeZone $timezone = null ) : ExpressiveDate	Make and return new ExpressiveDate instance.
makeFromDate ( integer $year = null, integer $month = null, integer $day = null, string \| DateTimeZone $timezone = null ) : ExpressiveDate	Make and return a new ExpressiveDate instance with defined year, month, and day.
makeFromDateTime ( integer $year = null, integer $month = null, integer $day = null, integer $hour = null, integer $minute = null, integer $second = null, string \| DateTimeZone $timezone = null ) : ExpressiveDate	Make and return a new ExpressiveDate instance with defined year, month, day, hour, minute, and second.
makeFromTime ( integer $hour = null, integer $minute = null, integer $second = null, string \| DateTimeZone $timezone = null ) : ExpressiveDate	Make and return a new ExpressiveDate instance with defined hour, minute, and second.
minusDays ( integer $amount ) : ExpressiveDate	Minus a given amount of days.
minusHours ( integer $amount ) : ExpressiveDate	Minus a given amount of hours.
minusMinutes ( integer $amount ) : ExpressiveDate	Minus a given amount of minutes.
minusMonths ( integer $amount ) : ExpressiveDate	Minus a given amount of months.
minusOneDay ( ) : ExpressiveDate	Minus one day.
minusOneHour ( ) : ExpressiveDate	Minus one hour.
minusOneMinute ( ) : ExpressiveDate	Minus one minute.
minusOneMonth ( ) : ExpressiveDate	Minus one month.
minusOneSecond ( ) : ExpressiveDate	Minus one second.
minusOneWeek ( ) : ExpressiveDate	Minus one week.
minusOneYear ( ) : ExpressiveDate	Minus one year.
minusSeconds ( integer $amount ) : ExpressiveDate	Minus a given amount of seconds.
minusWeeks ( integer $amount ) : ExpressiveDate	Minus a given amount of weeks.
minusYears ( integer $amount ) : ExpressiveDate	Minus a given amount of years.
notEqualTo ( ExpressiveDate $date ) : boolean	Determine if date is not equal to another Expressive Date instance.
now ( ) : ExpressiveDate	Use the current date and time.
sameAs ( ExpressiveDate $date ) : boolean	Alias for ExpressiveDate::equalTo()
setDefaultDateFormat ( string $format ) : ExpressiveDate	Set the default date format.
setTimestampFromString ( string $string ) : ExpressiveDate	Sets the timestamp from a human readable string.
setTimezone ( string \| DateTimeZone $timezone ) : ExpressiveDate	Set the timezone.
setWeekStartDay ( integer \| string $weekStartDay ) : void	Set the starting day of the week, where 0 is Sunday and 1 is Monday.
startOfDay ( ) : ExpressiveDate	Use the start of the day.
startOfMonth ( ) : ExpressiveDate	Use the start of the month.
startOfWeek ( ) : ExpressiveDate	Use the start of the week.
today ( ) : ExpressiveDate	Use today's date and time at midnight.
tomorrow ( ) : ExpressiveDate	Use tomorrow's date and time at midnight.
yesterday ( ) : ExpressiveDate	Use yesterday's date and time at midnight.

Méthodes protégées

Méthode	Description
getDateAttribute ( string $attribute ) : mixed	Get a date attribute.
isDateAttribute ( string $attribute ) : mixed	Syntactical sugar for determining if date object "is" a condition.
isFloat ( integer \| float $amount ) : boolean	Determine if a given amount is a floating point number.
modifyDays ( integer $amount, boolean $invert = false ) : ExpressiveDate	Modify by an amount of days.
modifyFromInterval ( DateInterval $interval, boolean $invert = false ) : ExpressiveDate	Modify from a DateInterval object.
modifyHours ( integer $amount, boolean $invert = false ) : ExpressiveDate	Modify by an amount of hours.
modifyMinutes ( integer $amount, boolean $invert = false ) : ExpressiveDate	Modify by an amount of minutes.
modifyMonths ( integer $amount, boolean $invert = false ) : ExpressiveDate	Modify by an amount of months.
modifySeconds ( integer $amount, boolean $invert = false ) : ExpressiveDate	Modify by an amount of seconds.
modifyWeeks ( integer $amount, boolean $invert = false ) : ExpressiveDate	Modify by an amount of weeks.
modifyYears ( integer $amount, boolean $invert = false ) : ExpressiveDate	Modify by an amount of Years.
parseSuppliedTimezone ( string \| DateTimeZone $timezone ) : DateTimeZone	Parse a supplied timezone.
setDateAttribute ( string $attribute, $value ) : mixed	Set a date attribute.

Method Details

__call() public méthode

Dynamically handle calls for date attributes and testers.

public __call ( string $method, array $parameters ) : mixed
$method	string
$parameters	array
Résultat	mixed

__construct() public méthode

Create a new ExpressiveDate instance.

public __construct ( string $time = null, string \| DateTimeZone $timezone = null ) : void
$time	string
$timezone	string \| DateTimeZone
Résultat	void

__toString() public méthode

Return the default date format when casting to string.

public __toString ( ) : string
Résultat	string

addDays() public méthode

Add a given amount of days.

public addDays ( integer $amount ) : ExpressiveDate
$amount	integer
Résultat	ExpressiveDate

addHours() public méthode

Add a given amount of hours.

public addHours ( integer $amount ) : ExpressiveDate
$amount	integer
Résultat	ExpressiveDate

addMinutes() public méthode

Add a given amount of minutes.

public addMinutes ( integer $amount ) : ExpressiveDate
$amount	integer
Résultat	ExpressiveDate

addMonths() public méthode

Add a given amount of months.

public addMonths ( integer $amount ) : ExpressiveDate
$amount	integer
Résultat	ExpressiveDate

addOneDay() public méthode

Add one day.

public addOneDay ( ) : ExpressiveDate
Résultat	ExpressiveDate

addOneHour() public méthode

Add one hour.

public addOneHour ( ) : ExpressiveDate
Résultat	ExpressiveDate

addOneMinute() public méthode

Add one minute.

public addOneMinute ( ) : ExpressiveDate
Résultat	ExpressiveDate

addOneMonth() public méthode

Add one month.

public addOneMonth ( ) : ExpressiveDate
Résultat	ExpressiveDate

addOneSecond() public méthode

Add one second.

public addOneSecond ( ) : ExpressiveDate
Résultat	ExpressiveDate

addOneWeek() public méthode

Add one week.

public addOneWeek ( ) : ExpressiveDate
Résultat	ExpressiveDate

addOneYear() public méthode

Add one year.

public addOneYear ( ) : ExpressiveDate
Résultat	ExpressiveDate

addSeconds() public méthode

Add a given amount of seconds.

public addSeconds ( integer $amount ) : ExpressiveDate
$amount	integer
Résultat	ExpressiveDate

addWeeks() public méthode

Add a given amount of weeks.

public addWeeks ( integer $amount ) : ExpressiveDate
$amount	integer
Résultat	ExpressiveDate

addYears() public méthode

Add a given amount of years.

public addYears ( integer $amount ) : ExpressiveDate
$amount	integer
Résultat	ExpressiveDate

copy() public méthode

Return copy of expressive date object

public copy ( ) : ExpressiveDate
Résultat	ExpressiveDate

endOfDay() public méthode

Use the end of the day.

public endOfDay ( ) : ExpressiveDate
Résultat	ExpressiveDate

endOfMonth() public méthode

Use the end of the month.

public endOfMonth ( ) : ExpressiveDate
Résultat	ExpressiveDate

endOfWeek() public méthode

Use the end of the week.

public endOfWeek ( ) : ExpressiveDate
Résultat	ExpressiveDate

equalTo() public méthode

Determine if date is equal to another Expressive Date instance.

public equalTo ( ExpressiveDate $date ) : boolean
$date	ExpressiveDate
Résultat	boolean

getDate() public méthode

Get a date string in the format of 2012-12-04.

public getDate ( ) : string
Résultat	string

getDateAttribute() protected méthode

Get a date attribute.

protected getDateAttribute ( string $attribute ) : mixed
$attribute	string
Résultat	mixed

getDateTime() public méthode

Get a date and time string in the format of 2012-12-04 23:43:27.

public getDateTime ( ) : string
Résultat	string

getDefaultDate() public méthode

Get a date string in the default format.

public getDefaultDate ( ) : string
Résultat	string

getDifferenceInDays() public méthode

Get the difference in days.

public getDifferenceInDays ( ExpressiveDate $compare = null ) : string
$compare	ExpressiveDate
Résultat	string

getDifferenceInHours() public méthode

Get the difference in hours.

public getDifferenceInHours ( ExpressiveDate $compare = null ) : string
$compare	ExpressiveDate
Résultat	string

getDifferenceInMinutes() public méthode

Get the difference in minutes.

public getDifferenceInMinutes ( ExpressiveDate $compare = null ) : string
$compare	ExpressiveDate
Résultat	string

getDifferenceInMonths() public méthode

Get the difference in months.

public getDifferenceInMonths ( ExpressiveDate $compare = null ) : string
$compare	ExpressiveDate
Résultat	string

getDifferenceInSeconds() public méthode

Get the difference in seconds.

public getDifferenceInSeconds ( ExpressiveDate $compare = null ) : string
$compare	ExpressiveDate
Résultat	string

getDifferenceInYears() public méthode

Get the difference in years.

public getDifferenceInYears ( ExpressiveDate $compare = null ) : string
$compare	ExpressiveDate
Résultat	string

getLongDate() public méthode

Get a date string in the format of January 31st, 1991 at 7:45am.

public getLongDate ( ) : string
Résultat	string

getRelativeDate() public méthode

Get a relative date string, e.g., 3 days ago.

public getRelativeDate ( ExpressiveDate $compare = null ) : string
$compare	ExpressiveDate
Résultat	string

getShortDate() public méthode

Get a date string in the format of Jan 31, 1991.

public getShortDate ( ) : string
Résultat	string

getTime() public méthode

Get a date string in the format of 07:42:32.

public getTime ( ) : string
Résultat	string

getWeekStartDay() public méthode

Get the starting day of the week, where 0 is Sunday and 1 is Monday

public getWeekStartDay ( ) : integer
Résultat	integer

greaterOrEqualTo() public méthode

Determine if date is greater than or equal to another Expressive Date instance.

public greaterOrEqualTo ( ExpressiveDate $date ) : boolean
$date	ExpressiveDate
Résultat	boolean

greaterThan() public méthode

Determine if date is greater than another Expressive Date instance.

public greaterThan ( ExpressiveDate $date ) : boolean
$date	ExpressiveDate
Résultat	boolean

isDateAttribute() protected méthode

Syntactical sugar for determining if date object "is" a condition.

protected isDateAttribute ( string $attribute ) : mixed
$attribute	string
Résultat	mixed

isFloat() protected méthode

Determine if a given amount is a floating point number.

protected isFloat ( integer \| float $amount ) : boolean
$amount	integer \| float
Résultat	boolean

isWeekday() public méthode

Determine if day is a weekday.

public isWeekday ( ) : boolean
Résultat	boolean

isWeekend() public méthode

Determine if day is a weekend.

public isWeekend ( ) : boolean
Résultat	boolean

lessOrEqualTo() public méthode

Determine if date is less than or equal to another Expressive Date instance.

public lessOrEqualTo ( ExpressiveDate $date ) : boolean
$date	ExpressiveDate
Résultat	boolean

lessThan() public méthode

Determine if date is less than another Expressive Date instance.

public lessThan ( ExpressiveDate $date ) : boolean
$date	ExpressiveDate
Résultat	boolean

make() public static méthode

Make and return new ExpressiveDate instance.

public static make ( string $time = null, string \| DateTimeZone $timezone = null ) : ExpressiveDate
$time	string
$timezone	string \| DateTimeZone
Résultat	ExpressiveDate

makeFromDate() public static méthode

Make and return a new ExpressiveDate instance with defined year, month, and day.

public static makeFromDate ( integer $year = null, integer $month = null, integer $day = null, string \| DateTimeZone $timezone = null ) : ExpressiveDate
$year	integer
$month	integer
$day	integer
$timezone	string \| DateTimeZone
Résultat	ExpressiveDate

makeFromDateTime() public static méthode

Make and return a new ExpressiveDate instance with defined year, month, day, hour, minute, and second.

public static makeFromDateTime ( integer $year = null, integer $month = null, integer $day = null, integer $hour = null, integer $minute = null, integer $second = null, string \| DateTimeZone $timezone = null ) : ExpressiveDate
$year	integer
$month	integer
$day	integer
$hour	integer
$minute	integer
$second	integer
$timezone	string \| DateTimeZone
Résultat	ExpressiveDate

makeFromTime() public static méthode

Make and return a new ExpressiveDate instance with defined hour, minute, and second.

public static makeFromTime ( integer $hour = null, integer $minute = null, integer $second = null, string \| DateTimeZone $timezone = null ) : ExpressiveDate
$hour	integer
$minute	integer
$second	integer
$timezone	string \| DateTimeZone
Résultat	ExpressiveDate

minusDays() public méthode

Minus a given amount of days.

public minusDays ( integer $amount ) : ExpressiveDate
$amount	integer
Résultat	ExpressiveDate

minusHours() public méthode

Minus a given amount of hours.

public minusHours ( integer $amount ) : ExpressiveDate
$amount	integer
Résultat	ExpressiveDate

minusMinutes() public méthode

Minus a given amount of minutes.

public minusMinutes ( integer $amount ) : ExpressiveDate
$amount	integer
Résultat	ExpressiveDate

minusMonths() public méthode

Minus a given amount of months.

public minusMonths ( integer $amount ) : ExpressiveDate
$amount	integer
Résultat	ExpressiveDate

minusOneDay() public méthode

Minus one day.

public minusOneDay ( ) : ExpressiveDate
Résultat	ExpressiveDate

minusOneHour() public méthode

Minus one hour.

public minusOneHour ( ) : ExpressiveDate
Résultat	ExpressiveDate

minusOneMinute() public méthode

Minus one minute.

public minusOneMinute ( ) : ExpressiveDate
Résultat	ExpressiveDate

minusOneMonth() public méthode

Minus one month.

public minusOneMonth ( ) : ExpressiveDate
Résultat	ExpressiveDate

minusOneSecond() public méthode

Minus one second.

public minusOneSecond ( ) : ExpressiveDate
Résultat	ExpressiveDate

minusOneWeek() public méthode

Minus one week.

public minusOneWeek ( ) : ExpressiveDate
Résultat	ExpressiveDate

minusOneYear() public méthode

Minus one year.

public minusOneYear ( ) : ExpressiveDate
Résultat	ExpressiveDate

minusSeconds() public méthode

Minus a given amount of seconds.

public minusSeconds ( integer $amount ) : ExpressiveDate
$amount	integer
Résultat	ExpressiveDate

minusWeeks() public méthode

Minus a given amount of weeks.

public minusWeeks ( integer $amount ) : ExpressiveDate
$amount	integer
Résultat	ExpressiveDate

minusYears() public méthode

Minus a given amount of years.

public minusYears ( integer $amount ) : ExpressiveDate
$amount	integer
Résultat	ExpressiveDate

modifyDays() protected méthode

Modify by an amount of days.

protected modifyDays ( integer $amount, boolean $invert = false ) : ExpressiveDate
$amount	integer
$invert	boolean
Résultat	ExpressiveDate

modifyFromInterval() protected méthode

Modify from a DateInterval object.

protected modifyFromInterval ( DateInterval $interval, boolean $invert = false ) : ExpressiveDate
$interval	DateInterval
$invert	boolean
Résultat	ExpressiveDate

modifyHours() protected méthode

Modify by an amount of hours.

protected modifyHours ( integer $amount, boolean $invert = false ) : ExpressiveDate
$amount	integer
$invert	boolean
Résultat	ExpressiveDate

modifyMinutes() protected méthode

Modify by an amount of minutes.

protected modifyMinutes ( integer $amount, boolean $invert = false ) : ExpressiveDate
$amount	integer
$invert	boolean
Résultat	ExpressiveDate

modifyMonths() protected méthode

Modify by an amount of months.

protected modifyMonths ( integer $amount, boolean $invert = false ) : ExpressiveDate
$amount	integer
$invert	boolean
Résultat	ExpressiveDate

modifySeconds() protected méthode

Modify by an amount of seconds.

protected modifySeconds ( integer $amount, boolean $invert = false ) : ExpressiveDate
$amount	integer
$invert	boolean
Résultat	ExpressiveDate

modifyWeeks() protected méthode

Modify by an amount of weeks.

protected modifyWeeks ( integer $amount, boolean $invert = false ) : ExpressiveDate
$amount	integer
$invert	boolean
Résultat	ExpressiveDate

modifyYears() protected méthode

Modify by an amount of Years.

protected modifyYears ( integer $amount, boolean $invert = false ) : ExpressiveDate
$amount	integer
$invert	boolean
Résultat	ExpressiveDate

notEqualTo() public méthode

Determine if date is not equal to another Expressive Date instance.

public notEqualTo ( ExpressiveDate $date ) : boolean
$date	ExpressiveDate
Résultat	boolean

now() public méthode

Use the current date and time.

public now ( ) : ExpressiveDate
Résultat	ExpressiveDate

parseSuppliedTimezone() protected méthode

Parse a supplied timezone.

protected parseSuppliedTimezone ( string \| DateTimeZone $timezone ) : DateTimeZone
$timezone	string \| DateTimeZone
Résultat	DateTimeZone

sameAs() public méthode

Alias for ExpressiveDate::equalTo()

public sameAs ( ExpressiveDate $date ) : boolean
$date	ExpressiveDate
Résultat	boolean

setDateAttribute() protected méthode

Set a date attribute.

protected setDateAttribute ( string $attribute, $value ) : mixed
$attribute	string
Résultat	mixed

setDefaultDateFormat() public méthode

Set the default date format.

public setDefaultDateFormat ( string $format ) : ExpressiveDate
$format	string
Résultat	ExpressiveDate

setTimestampFromString() public méthode

Sets the timestamp from a human readable string.

public setTimestampFromString ( string $string ) : ExpressiveDate
$string	string
Résultat	ExpressiveDate

setTimezone() public méthode

Set the timezone.

public setTimezone ( string \| DateTimeZone $timezone ) : ExpressiveDate
$timezone	string \| DateTimeZone
Résultat	ExpressiveDate

setWeekStartDay() public méthode

Set the starting day of the week, where 0 is Sunday and 1 is Monday.

public setWeekStartDay ( integer \| string $weekStartDay ) : void
$weekStartDay	integer \| string
Résultat	void

startOfDay() public méthode

Use the start of the day.

public startOfDay ( ) : ExpressiveDate
Résultat	ExpressiveDate

startOfMonth() public méthode

Use the start of the month.

public startOfMonth ( ) : ExpressiveDate
Résultat	ExpressiveDate

startOfWeek() public méthode

Use the start of the week.

public startOfWeek ( ) : ExpressiveDate
Résultat	ExpressiveDate

today() public méthode

Use today's date and time at midnight.

public today ( ) : ExpressiveDate
Résultat	ExpressiveDate

tomorrow() public méthode

Use tomorrow's date and time at midnight.

public tomorrow ( ) : ExpressiveDate
Résultat	ExpressiveDate

yesterday() public méthode

Use yesterday's date and time at midnight.

public yesterday ( ) : ExpressiveDate
Résultat	ExpressiveDate

Property Details

$defaultDateFormat protected_oe property

Default date format used when casting object to string.

protected string $defaultDateFormat
Résultat	string

$weekStartDay protected_oe property

Starting day of the week, where 0 is Sunday and 1 is Monday.

protected int $weekStartDay
Résultat	integer