Download the PHP package fyre/period without Composer
On this page you can find all versions of the php package fyre/period. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package period
FyrePeriod
FyrePeriod is a free, open-source date period library for PHP.
Table Of Contents
- Installation
- Periods
- Period Collections
Installation
Using Composer
Periods
$start
is a DateTime or string representing the start date.$end
is a DateTime or string representing the end date.$granularity
is a string representing the granularity, and can be one of either "year", "month", "day", "hour", "minute" or "second", and will default to "day".$excludeBoundaries
is a string representing the excluded boundaries, and can be one of either "none", "start", "end" or "both", and will default to "none".
The Period is an implementation of an Iterator and can be used in a foreach loop.
Contains
Determine whether this period contains another Period.
$other
is the Period to compare against.
Diff Symmetric
Get the symmetric difference between the periods.
$other
is the Period to compare against.
This method will return a new PeriodCollection.
End
Get the end date.
This method will return a DateTime.
End Equals
Determine whether this period ends on a given date.
$date
is the DateTime to compare against.
Ends After
Determine whether this period ends after a given date.
$date
is the DateTime to compare against.
Ends After Or Equals
Determine whether this period ends on or after a given date.
$date
is the DateTime to compare against.
Ends Before
Determine whether this period ends before a given date.
$date
is the DateTime to compare against.
Ends Before Or Equals
Determine whether this period ends on or before a given date.
$date
is the DateTime to compare against.
Equals
Determine whether this period equals another Period.
$other
is the Period to compare against.
Gap
Get the gap between the periods.
$other
is the Period to compare against.
This method will return a new Period, or null if there's no gap.
Granularity
Get the granularity.
Included End
Get the included end date.
This method will return a DateTime.
Included Start
Get the included start date.
This method will return a DateTime.
Includes End
Determine whether the Period includes the end date.
Includes
Determine whether this period includes a given date.
$date
is the DateTime to compare against.
Includes Start
Determine whether the Period includes the start date.
Length
Get the length of the period.
Overlap
Get the overlap of the periods.
$other
is the Period to compare against.
This method will return a new Period, or null if there's no overlap.
Overlap All
Get the overlap of all the periods.
This method will return a new Period, or null if there's no overlap.
Overlap Any
Get the overlaps of any of the periods.
This method will return a new PeriodCollection.
Overlaps With
Determine whether this period overlaps with another Period.
$other
is the Period to compare against.
Renew
Create a new period with the same length after this period.
This method will return a new Period.
Start
Get the start date.
This method will return a DateTime.
Start Equals
Determine whether this period starts on a given date.
$date
is the DateTime to compare against.
Starts After
Determine whether this period starts after a given date.
$date
is the DateTime to compare against.
Starts After Or Equals
Determine whether this period starts on or after a given date.
$date
is the DateTime to compare against.
Starts Before
Determine whether this period starts before a given date.
$date
is the DateTime to compare against.
Starts Before Or Equals
Determine whether this period starts on or before a given date.
$date
is the DateTime to compare against.
Subtract
Get the inverse overlap of the periods.
$other
is the Period to compare against.
This method will return a new PeriodCollection.
Subtract All
Get the inverse overlap of all periods.
This method will return a new PeriodCollection.
Touches
Determine whether this period touches another Period.
$other
is the Period to compare against.
Period Collections
All arguments supplied will be used as periods for the collection.
The PeriodCollection is an implementation of an Iterator and can be used in a foreach loop.
Add
Add periods to the collection.
All arguments supplied will be used as periods to add to the collection.
This method will return a new PeriodCollection.
Boundaries
Get the boundaries of the collection.
This method will return a new Period, or null if the collection is empty.
Gaps
Get the the gaps between the periods in the collection.
This method will return a new PeriodCollection.
Intersect
Intersect a period with every period in the collection.
$period
is the Period to compare against.
This method will return a new PeriodCollection.
Overlap All
Get the overlap of all the collections.
All arguments supplied will be used as collections to compare against.
This method will return a new PeriodCollection.
Sort
Sort the periods.
This method will return a new PeriodCollection.
Subtract
Get the inverse overlap of the collections.
$others
is the PeriodCollection to compare against.
This method will return a new PeriodCollection.
Unique
Filter the periods to remove duplicates.
This method will return a new PeriodCollection.