Release Notes

These are the release notes from Period. We’ve tried to cover all changes, including backward compatible breaks from 3.0 through to the current stable release. If we’ve missed anything, feel free to create an issue, or send a pull request.

version 5.3.2 - 2024-03-23

Added

• None

Fixed

• Fix package to avoid PHP8.4 deprecation warnings

Deprecated

• None

Removed

• None

version 5.3.1 - 2023-12-06

Added

• None

Fixed

• Fix Period duplication during intersection calculation #135 by maogou

Deprecated

• None

Removed

• None

version 5.3.0 - 2023-11-28

Added

• Chart\LetterCase::convert

Fixed

• Handles gracefully new Date exception in PHP8.3

Deprecated

• None

Removed

• None

version 5.2.1 - 2023-02-25

Added

• None

Fixed

• Period::fromRange should work in PHP8.1 with DatePeriod limitations.

Deprecated

• InitialDatePresence use instead Period::fromRange

Removed

• None

version 5.2.0 - 2023-02-18

Added

• Period::rangeForward allows iteration over a set of dates and times, recurring at regular intervals, over the instance forward starting from the instance start.
• Period::rangeBackwards Allows iteration over a set of dates and times, recurring at regular intervals, over the instance backwards starting from the instance ending.
• Period::fromRange returns a new Period instance from a DatePeriod object. Only usable in PHP8.2+ installation

Fixed

• Using PHPUnit 10 instead of PHPUnit 9.

Deprecated

• Period::dateRangeForward use instead Period::rangeForward
• Period::dateRangeBackwards use instead Period::rangeBackwards

Removed

• None

version 5.1.0 - 2022-06-29

Added

• DatePoint::fromFormat to instantiate from a date format and its related string.

Fixed

• Period::fromIso8601 now supports truncated date and duration in the interval string.

Deprecated

• None

Removed

• None

version 5.0.0 - 2022-02-22

Added

• IntervalError used as the error interface marker.
• InvalidInterval exception for anything regarding creating an object.
• Duration::fromSeconds uses a dedicated fraction parameter and the seconds are no longer expressed using a float value.
• Period::fromTimestamp to instantiate a time range object from two timestamps.
• Period::fromIso80000 to instantiate a time range object from a mathematical representation and a date format.
• Period::fromBourbaki to instantiate a time range object from a mathematical representation and a date format.
• Period duration comparison methods accepts also Duration and DateInterval in addition to Period objects.
• Period::union
• Period::snapTo* methods to ease period expansion.
• Period::meets
• Period::meetsOnStart
• Period::meetsOnEnd
• Period::toBourbaki
• Period::toIso80000
• Period::toBourbaki
• Bounds Enumeration.
• InitialDatePresence Enumeration.
• Sequence::toList
• Chart\LetterCase Enumeration.
• Chart\Alignment Enumeration.
• Chart\StreamOutput class to replace Chart\ConsoleOutput class.
• Chart\Terminal Enumeration.
• Chart\ChartError used as the chart error interface marker.
• Chart\UnableToDrawChart exception for anything regarding drawing a chart out of Period and/or Sequence objects.

Fixed

• Switch from using Closure object instead of the callable pseudo type with the Sequence methods.
• Period::diff returns a Sequence instance instead of an array.
• Period::__construct is private.
• Period named constructors, all parameters are required except for the boundaries.
• Period::timeDuration now returns an int instead of a float value.
• Period::intersect now can take multiple Period instances as parameters.
• Period::subtract now can take multiple Period instances as parameters.
• Duration no longer extends a DateInterval object.
• Duration::fromIsoString supports 3 versions of dealing with fractions with ISO valid string.
• Datepoint class renamed DatePoint.
• DatePoint no longer extends a DateTimeImmutable object.
• Argument names are normalized throughout the package. (PHP8 BC break)
• Chart\LatinLetter in case of wrong value will fall back to A instead of 0 which is not a letter.
• Chart\LatinLetter the starting label must be explicit on instantiation.
• Chart\RomanNumber requires its two arguments to be explicitly set.

Deprecated

• None

Removed

• Support for PHP7 and PHP8.0
• Period::fromDatepoint replaced by Period::fromDate
• Period::getStartDate replaced by accessing readonly property Period::startDate
• Period::getEndDate replaced by accessing readonly property Period::endDate
• Period::getBoundaryType replaced by accessing readonly property Period::bounds
• Period::getDateInterval replaced by Period::dateInterval
• Period::getTimestampInterval replaced by Period::timeDuration
• Period::withBoundaryType replaced by Period::boundedBy
• Period::isStartIncluded with no replacement use Bounds::isStartIncluded
• Period::isStartExcluded with no replacement use Bounds::isStartIncluded instead
• Period::isEndIncluded with no replacement use Bounds::isEndIncluded
• Period::isEndExcluded with no replacement use Bounds::isEndIncluded instead
• Period::fromDatePeriod replaced by Period::fromDateRange
• Period::getDatePeriod replaced by Period::dateRange
• Period::getDatePeriodBackwards replaced by Period::dateRangeBackwards
• Period::__string replaced by Period::toIso8601
• Period::format replaced by Period::toIso80000
• Period::split replaced by Period::splitForward
• Period::substract use Period::subtract instead
• Sequence::substract use Sequence::subtract instead
• Sequence::getIntersections use Sequence::intersections instead
• Sequence::getGaps use Sequence::gaps instead
• Sequence::getBoundaries use Sequence::length instead
• Sequence::getTotalTimestampInterval use Sequence::totalTimeDuration instead
• Sequence::toArray use Sequence::toList instead
• Duration::__toString and Duration::format with no replacement
• Duration::create is removed with no replacement
• Datepoint::create is removed with no replacement
• The create prefix is removed from the Duration and Datepoint named constructors.
• All charts related classes have their properties exposed as public readonly. All their getters are removed except if they are part of an interface.
• Chart\ConsoleOutput replaced by Chart\StreamOutput class.
• Chart\RomanNumber::isLower use Chart\LetterCase::isUpper instead.
• Chart\RomanNumber::startingAt use Chart\DecimalNumber::startLabel public readonly property
• Chart\RomanNumber::startsWith is removed with no replacement
• Chart\RomanNumber::withLetterCase is removed with no replacement
• Chart\DecimalNumber::startsWith is removed with no replacement
• Chart\LatinNumber::startsWith is removed with no replacement
• Chart\LatinNumber::startingAt use Chart\LatinNumber::startLabel public readonly property
• Chart\AffixLabel::withPrefix is removed with no replacement
• Chart\AffixLabel::withSuffix is removed with no replacement
• Chart\AffixLabel::prefix method use Chart\AffixLabel::labelPrefix public readonly property
• Chart\AffixLabel::suffix method use Chart\AffixLabel::labelSuffix public readonly property

Removed all the following namespaced functions from the package:

• League\Period\datepoint
• League\Period\duration
• League\Period\year
• League\Period\semester
• League\Period\quarter
• League\Period\month
• League\Period\day
• League\Period\hour
• League\Period\minute
• League\Period\second
• League\Period\instant
• League\Period\iso_year
• League\Period\iso_week
• League\Period\interval_after
• League\Period\interval_before
• League\Period\interval_around
• League\Period\interval_from_dateperiod

version 4.12.0 - 2022-02-21

Added

• Datepoint::second
• Datepoint::minute
• Datepoint::hour
• Datepoint::isoWeek
• Datepoint::month
• Datepoint::quarter
• Datepoint::semester
• Datepoint::year
• Datepoint::isoYear
• Duration::fromDateInterval
• Duration::fromSeconds
• Duration::fromChronoString
• Duration::fromTimeString
• Duration::fromDateString
• Period::timeDuration
• Period::dateInterval
• Period::dateRangeForward
• Period::dateRangeBackwards
• Period::toIso80000
• Period::splitForward
• Period::timeDurationDiff
• Period::boundedBy
• Sequence::length
• Sequence::totalTimeDuration

Fixed

• None

Deprecated

• Datepoint::getSecond is deprecated in favor of Datepoint::second
• Datepoint::getMinute is deprecated in favor of Datepoint::minute
• Datepoint::getHour is deprecated in favor of Datepoint::hour
• Datepoint::getIsoWeek is deprecated in favor of Datepoint::isoWeek
• Datepoint::getMonth is deprecated in favor of Datepoint::month
• Datepoint::getQuarter is deprecated in favor of Datepoint::quarter
• Datepoint::getSemester is deprecated in favor of Datepoint::semester
• Datepoint::getYear is deprecated in favor of Datepoint::year
• Datepoint::getIsoYear is deprecated in favor of Datepoint::isoYear
• Duration::createfromDateInterval is deprecated in favor of Datepoint::fromDateInterval
• Duration::createfromSeconds is deprecated in favor of Datepoint::fromSeconds
• Duration::createfromChronoString is deprecated in favor of Datepoint::fromChronoString
• Duration::createfromTimeString is deprecated in favor of Datepoint::fromTimeString
• Duration::createfromDateString is deprecated in favor of Datepoint::fromDateString
• Period::getTimestampInterval is deprecated in favor of Period::timeDuration
• Period::getDateInterval is deprecated in favor of Period::dateInterval
• Period::getDatePeriod is deprecated in favor of Period::dateRangeForward
• Period::getDatePeriodBackwards is deprecated in favor of Period::dateRangeBackwards
• Period::format is deprecated in favor of Period::toIso80000
• Period::split is deprecated in favor of Period::splitForward
• Period::withBoundaryType is deprecated in favor of Period::boundedBy
• Period::timestampIntervalDiff is deprecated in favor of Period::timeDurationDiff
• Sequence::boundaries is deprecated in favor of Sequence::length
• Sequence::getTotalTimestampInterval is deprecated in favor of Sequence::totalTimeDuration

Removed

• None

version 4.11.0 - 2020-11-11

Added

• Period::fromDatepoint
• Duration::createFromDateInterval
• Duration::createFromTimeString
• Duration::createFromChronoString
• Duration::createFromSeconds
• Duration::create supports DateInterval spec strings.
• Support for PHP8

Fixed

• Duration::create when using a float will now overflow the results up to the Hour unit.

Deprecated

• None

Removed

• None

version 4.10.0 - 2020-03-22

Added

• Period::toIso8601
• Charts featuring ported from Bakame\Period\Vizualizer

Fixed

• Fix issue with Sequence::intersections method.

Deprecated

• Period::__string replaced by Period::toIso8601

Removed

• Support for PHP7.1

version 4.9.0 - 2019-09-02

Added

• $boundaryType argument added to the following named constructors:
  • Period::fromDay
  • Period::fromIsoWeek
  • Period::fromMonth
  • Period::fromQuarter
  • Period::fromSemester
  • Period::fromYear
  • Period::fromIsoYear
• Period::subtract
• Sequence::subtract

Fixed

• None

Deprecated

• Period::substract use Period::subtract instead
• Sequence::substract use Sequence::subtract instead

Removed

• None

version 4.8.1 - 2019-07-16

Added

• None

Fixed

• Sequence negative offsets for a object with only one Period instance issue #85

Deprecated

• None

Removed

• None

version 4.8.0 - 2019-06-20

Added

• Datepoint methods returning Period objects supports boundaryType
• Period::merge supports empty arguments.
• Sequence::contains supports empty arguments.
• Sequence::unshift supports empty arguments.
• Sequence::push supports empty arguments.
• Sequence class supports negative offsets.

Fixed

• Duration::adjustedTo no longer compares DateInterval objects to be compatible with PHP7.4+

Deprecated

• None

Removed

• None

version 4.7.1 - 2019-05-19

Added

• None

Fixed

• Improve Duration::createFromDateString bug fix to take into account DateInterval::createFromDateString bug fix
• Update the development tools to Infection 0.13

Deprecated

• None

Removed

• None

version 4.7.0 - 2019-03-31

Added

• Sequence::getTotalTimestampInterval see PR #79
• Period::substract see PR #80
• Sequence::substract see PR #81

Fixed

• Update Duration::createFromDateString to take into account DateInterval::createFromDateString bug fix
• Update the development tools to PHPUnit8.0 and PHPstan 0.11

Deprecated

• None

Removed

• None

version 4.6.0 - 2019-03-06

Added

• Duration::adjustedTo
• Internals: added support for PHP7.4 and PHP8.0 in travis.yml

Fixed

• None

Deprecated

• Duration::withoutCarryOver use Duration::adjustedTo instead

Removed

• None

version 4.5.0 - 2019-02-03

Added

• Datepoint::isBefore
• Datepoint::bordersOnStart
• Datepoint::isStarting
• Datepoint::isDuring
• Datepoint::isEnding
• Datepoint::bordersOnEnd
• Datepoint::isAfter
• Datepoint::abuts
• Duration::create now supports chronometer format
• Duration::withoutCarryOver

Fixed

• Period::durationCompare to take into account Timezone and DST

Deprecated

• Duration::__toString use Duration::format instead

Removed

• None

version 4.4.0 - 2019-01-20

Added

• Added support for the boundary type
  • Period::EXCLUDE_START_INCLUDE_END
  • Period::INCLUDE_START_EXCLUDE_END
  • Period::EXCLUDE_ALL
  • Period::INCLUDE_ALL
  • Period::getBoundaryType
  • Period::isStartExcluded
  • Period::isStartIncluded
  • Period::isEndExcluded
  • Period::isEndIncluded
  • Period::withBoundaryType
  • Period::__construct adds the $boundaryType argument;
  • Period::after adds the $boundaryType argument;
  • Period::before adds the $boundaryType argument;
  • Period::around adds the $boundaryType argument;
  • Period::fromDatePeriod adds the $boundaryType argument;
• Added missing Allen’s Algebra intervals
  • Period::bordersOnStart
  • Period::bordersOnEnd
  • Period::isDuring
  • Period::isStartedBy
  • Period::isEndedBy
• Added additional methods to the Sequence class
  • Sequence::unions
  • Sequence::intersections
  • Sequence::gaps
  • Sequence::boundaries
  • Sequence::reduce

Fixed

• None

Deprecated

• Sequence::getIntersections use Sequence::intersections instead
• Sequence::getGaps use Sequence::gaps instead
• Sequence::getBoundaries use Sequence::boundaries instead

Removed

• None

version 4.3.1 - 2019-01-07

Added

• None

Fixed

• Datepoint::createFromFormat see issue #72

Deprecated

• None

Removed

• None

version 4.3.0 - 2018-12-21

Added

• Sequence implements the ArrayAccess interface

Fixed

• Sequence::map must preserve offset index after modification.

Deprecated

• None

Removed

• None

version 4.2.0 - 2018-12-19

Added

• League\Period\Datepoint
• League\Period\Duration
• Period::fromIsoYear
• Period::fromYear
• Period::fromSemester
• Period::fromQuarter
• Period::fromMonth
• Period::fromIsoWeek
• Period::fromDay
• Period::after
• Period::before
• Period::around
• Period::fromDatePeriod
• Sequence::map

Fixed

• None

Deprecated

• League\Period\datepoint
• League\Period\duration
• League\Period\year
• League\Period\semester
• League\Period\quarter
• League\Period\month
• League\Period\day
• League\Period\hour
• League\Period\minute
• League\Period\second
• League\Period\instant
• League\Period\iso_year
• League\Period\iso_week
• League\Period\interval_after
• League\Period\interval_before
• League\Period\interval_around
• League\Period\interval_from_dateperiod

Removed

• None

version 4.1.0 - 2018-12-07

Added

• League\Period\Sequence
• League\Period\InvalidIndex

Fixed

• None

Deprecated

• None

Removed

• None

version 4.0.1 - 2018-11-30

Added

• None

Fixed

• Period::split does not work with daylight saving see issue #68

Deprecated

• None

Removed

• None

version 4.0.0 - 2018-10-18

Added

Classes

• Exception class

Methods

• Period::durationCompare
• Period::durationEquals
• Period::format
• Period::expand
• Period::equals
• Period::getDatePeriodBackwards

Functions

• League\Period\datepoint
• League\Period\duration
• League\Period\year
• League\Period\semester
• League\Period\quarter
• League\Period\month
• League\Period\day
• League\Period\hour
• League\Period\minute
• League\Period\second
• League\Period\instant
• League\Period\iso_year
• League\Period\iso_week
• League\Period\interval_after
• League\Period\interval_before
• League\Period\interval_around
• League\Period\interval_from_dateperiod

Fixed

• The Period class is now final
• Period::JsonSerialize now returns datepoint in JavaScript compatible notation
• Period::diff always returns an array containing two values.
• An instance with a duration equals to DateInterval('PT0S') will contains no datepoint not even its starting datepoint.

Deprecated

• None

Removed

• Support for PHP 7.0
• Period::next
• Period::previous
• Period::add
• Period::sub
• Period::createFromYear replaced by League\Period\year
• Period::createFromMonth replaced by League\Period\month
• Period::createFromWeek replaced by League\Period\iso_week
• Period::createFromDay replaced by League\Period\day
• Period::createFromSemester replaced by League\Period\semester
• Period::createFromQuarter replaced by League\Period\quarter
• Period::createFromDuration replaced by League\Period\interval_after
• Period::createFromDurationBeforeEnd replaced by League\Period\interval_before
• Period::sameValueAs replaced by Period::equals
• Period::sameDurationAs replaced by Period::durationEquals
• Period::compareDuration replaced by Period::durationCompare
• Period::withDuration replaced by Period::withDurationAfterStart

version 3.4.0 - 2017-11-17

Added

• Period::withDurationBeforeEnd
• Period::splitBackwards

Fixed

• None

Deprecated

• None

Removed

• dropped support for HHVM

version 3.3.0 - 2016-09-19

Added

• Period::move see Pull Request #40
• Period::moveStartDate see Pull Request #42
• Period::moveEndDate see Pull Request #42

Fixed

• None

Deprecated

• Period::add you should use Period::moveEndDate instead see Pull Request #42
• Period::sub you should use Period::moveEndDate instead see Pull Request #42

Removed

• None

version 3.2.0 - 2016-05-09

Added

• Period::__set_state
• autoloader to use the library without composer

Fixed

• Period::createFromDay see issue #36
• Period::intersect see issue #33

Deprecated

• None

Removed

• None

version 3.1.1 - 2016-02-12

Added

• None

Fixed

• Period::contains see issue #31
• microseconds are taken into account when converting DateTimeInterface objects.

Deprecated

• None

Removed

• None

version 3.1.0 - 2016-02-01

Added

• Period::createFromDay

Fixed

• Period::getDatePeriod adding the $option parameter
• DateTime to DateTimeImmutable convertion improved for PHP 5.6+ version
• Bumped version requirement to PHP 5.5.9 because of a bug in DatePeriod constructor

Deprecated

• None

Removed

• None

version 3.0.1 - 2015-12-22

Added

• None

Fixed

• Period::contains see issue #28

Deprecated

• None

Removed

• None

version 3.0.0 - 2015-09-02

Added

• Period implements the JsonSerializable interface
• Period can now be extended

Fixed

• Period always returns DateTimeImmutable objects
• Period::split returns a Generator
• Period::merge no longer throws RuntimeException

Deprecated

• None

Removed

• support for PHP 5.4
• Period::getStart
• Period::getEnd
• Period::getRange
• Period::duration
• Period::durationDiff

version 2.5.1 - 2015-03-06

Fixed

• Period always returns DateTime objects even when given DateTimeImmutable objects.

version 2.5.0 - 2015-03-06

Added

• Period::split to split a Period object into smaller Period objects #16

Fixed

• DateInterval validation when created from an integer.

Remove

• support for PHP 5.3

Please refers to the documentation or the library CHANGELOG for more details

version 2.4.0 - 2014-12-18

• Added Period::diff
• Added support for the DateTimeInterface

Please refers to the documentation or the library CHANGELOG for more details

version 2.3.0 - 2014-12-15

• Added : Period::createFromDurationBeforeEnd
• Bug Fixed : Period::isBefore and Period::isAfter
• Internal code improved

Please refers to the documentation or the library CHANGELOG for more details

version 2.2.0 - 2014-12-12

Added new methods

• Period::gap
• Period::abuts
• Period::isAfter
• Period::isBefore

Fixed methods

• Period::overlaps bug from issue #8

Please refers to the documentation or the library CHANGELOG for more details

version 2.1.0 - 2014-12-08

Added

• Modifying methods:
  • Period::next
  • Period::previous
• Period::__toString using ISO8601 representation

version 2.0.0 - 2014-10-15

Added

• Change vendor namespace from Period to League\Period
• Comparing methods:
  • Period::sameValueAs,
  • Period::compareDuration,
  • Period::durationGreaterThan,
  • Period::durationLessThan,
  • Period::sameDurationAs,
  • Period::durationDiff
• Modifying methods:
  • Period::add,
  • Period::sub,
  • Period::intersect

Fixed

• Period::contains now works with Period objects
• Period::getDuration accept an optional parameter $get_as_seconds if used and set to true, the method will return a integer which represents the duration in seconds.
• Period::merge now accepts one or more Period objects to return the Period object which contains all submitted Period objects.

version 1.0.1 - 2014-10-08

• The $interval parameter can also be an integer interpreted as the number of seconds after which the period must be considered finished.

version 1.0.0 - 2014-09-24

First stable release

version 0.3.0 - 2014-09-22

• Added methods overlaps and merge
• namespace simplification

version 0.2.1 - 2014-09-22

bug fixes

version 0.2.0 - 2014-09-22

Class name changed from ReportingPeriod to Period

• added the following methods contains, getRange, setDuration and getDuration
• name consistency applied by removing the (Date reference)

you can feed:

• a DateTime or a string when a DateTime is expected
• a DateInterval or a string when a DateInterval is expected

version 0.1.0 - 2014-09-19

Initiale release