Arguments

$date

Date in various string formats:

Y-m-d

d.m.Y

timestamp

date -String

eDate

Default: today

null, false Undefined date

Example

Get expected delivery date:

$DeliveryDate = $this->get('date', $order_date)->addDays(3)->setNextWorkday();

Get date

Current date

$this->get('date');

Specific date

You can give target date as a second parameter. Date can be in many formats: The given value is interpreted accordingly.

Y-m-d        $this->get('date','2013-04-13');
d.m.Y        $this->get('date','13.04.2013');
Timestamp    $this->get('date',1365870932);
Date -string $this->get('date','Tomorrow');
Date range -string $this->get('date','This week'); --> Monday
Date range -string $this->get('date','This week','end'); --> Sunday

Or if you know the correct format, you can use the explicit method to set the date:

Y,m,d       $this->get('date')->setDate('2013','04','13');
Y-m-d       $this->get('date')->setDateFromYmd('2013-04-13');
d.m.Y       $this->get('date')->setDateFromDmy('13.04.2013');
Timestamp   $this->get('date')->setDateFromTimestamp(1365870932);
Date string $this->get('date')->setDateFromString('Tomorrow');
Week        $this->get('date')->setWeek('15','2013');

Get date of value in date -field

You can create new eDate -object of date -fields with Field::getDate() -method.

$expirationDate = $Order->billing_date->getDate()->addDays(14);

You can get reference to eDate -object of value in Date -field using Field::getDateReference() method.

Add 14 days to value in field:

$Order->billing_date->getDateReference()->addDays(14);

All undefined method calls in Date -field are bridged to Field::getDateReference():

$Order->billing_date->addDays(14);

Modify date

You can create a date and then change its value with modifier -methods:

Tomorrow is             $this->get('date')->addDay();
Expiration date is      $this->get('date',$billingDate)->addWeeks(2);
Expiration date is      $this->get('date',$billingDate)->modify('+14 days');
This day in january is  $this->get('date')->setMonth(1);
First day for month     $this->get('date')->getFirstDateOfMonth(1);

Compare dates

Comparing functions creates a date from given parameter and compares it to current date value. Default target date is Today.

if ( $this->get('date',$date)->isToday() ){
    // Date is today
}
if ( $this->get('date',$date)->isAfter() ){
    // Date is after today
}
if ( $this->get('date',$date)->isAfterOr('Tomorrow') ){
    // Date is tomorrow or after
}
if ( $this->get('date',$date)->isBefore('2013-07-12') ){
    // Date is before 2013-07-12
}
if ( $this->get('date',$date)->isBefore('next friday') ){
    // Date is before next friday
}
if ( $this->get('date',$date)->isSame($dateParam,'week') ){
    // Date is in the same week as date in param
}
if ( $this->get('date',$date)->isAfter('Today','month') ){
    // Date is in next month or after
}
if ( $this->get('date',$date)->isBetween('yesterday','tomorrow') ){
    // Date is yesterday, today or tomorrow
}
if ( $this->get('date',$date)->isBetween($start,$end) ){
    // Date is: $start, $end, Between or start/end is not defined.
}

Iterate through dates

Go through all days in week

foreach ( $this->get('date',$date)->getDatesInWeek() as $Date ){
   $txt .= "Date: {$Date}";
}

Get all dates until given date:

foreach ( $this->get('date',$startDate)->getDatesTo($endDate) as $Date ){
   $txt .= "Date: {$Date}";
}

Loop through months (jan to dec):

foreach ( $this->get('date')->getMonths() as $Date ){
    $txt .= "{$Date->getMonth()}. month is {$Date->getMonthName()}";
}

Full method list

Date -class is chainable. ie. all methods that returns 'this' can be written in chain. When cast to string, class returns the date in local or setFormat() -format.

Setting date

Modifying date

Getting date information

Workdays

Anniversary

Set/Get methods

eDate setter/getter -pattern: If given argument, it is set as value. If argument is not set, value is get.

Date info

Comparing dates

date

Comparison date in any eDate create -format.

unit

Comparison unit: day, week, month, quarter, year

Default: day

Date periods

Misc

Config