README

ConditionalPeriod is a php class allowing to store 2 numerical/DateInterval intervals resulting in a DateInterval.

It is, actually, a requirement for a project I'm working on. Typically, it concerns the working contracts. Here is an example using integers as conditions:

If the category of the employee is between 1 and 5, the prior notice is 1 month.
If the category of the employee is between 6 and 7, the prior notice is 2 months.
If the category of the employee is between 8 and 12, the prior notice is 3 months.

Here is another example using date intervals as conditions:

If the fixed term contract lasts from 0 to 6 months, then the trial period is 15 days.
Above 6 months, the trial period is 1 month.

Expressing these interval with conditions using ConditionalPeriod is super duper easy and can be expressed in 2 ways: Using 4 arguments on the constructor, or using a string syntax.

Installation

You can use composer: composer require max13/conditional-period:^1.0

Or download the repo and add the files (in /src) to your project.

Usage

Using 4 arguments on the constructor, aka "classic instantiation"

use Carbon\CarbonInterval;
use MX\ConditionalCollection;
use MX\ConditionalPeriod;
...
$prior_notices = [
    new ConditionalPeriod(
        ConditionalType::CATEGORY,
        1,
        5,
        CarbonInterval::make('1 month')
    ),
    new ConditionalPeriod(
        ConditionalType::CATEGORY,
        6,
        7,
        CarbonInterval::make('2 months')
    ),
    new ConditionalPeriod(
        ConditionalType::CATEGORY,
        8,
        12,
        CarbonInterval::make('3 months')
    ),
];

$prior_notices = ConditionalCollection::fromArray($prior_notices);


$trial_periods = [
    new ConditionalPeriod(
        ConditionalType::DURATION,
        CarbonInterval::make(0),
        CarbonInterval::make('6 months'),
        CarbonInterval::make('15 days')
    ),
    new ConditionalPeriod(
        ConditionalType::DURATION,
        CarbonInterval::make('6 months'),
        CarbonInterval::make('99 years'), // Equivalent to +∞
        CarbonInterval::make('1 month')
    ),
];

$trial_periods = ConditionalCollection::fromArray($trial_periods);

Using the short string format, aka "badass mode"

use MX\ConditionalCollection;
use MX\ConditionalPeriod;
...
$prior_notices = [
    new ConditionalPeriod('C1-5P1M'),
    new ConditionalPeriod('C6-7P2M'),
    new ConditionalPeriod('C8-12P3M'),
];

// OR
$prior_notices = new ConditionalCollection;
$prior_notices[] = new ConditionalPeriod('C1-5P1M');
$prior_notices[] = 'C6-7P2M';
$prior_notices[] = new ConditionalPeriod('C8-12P3M');

$trial_periods = [
    new ConditionalPeriod('DP0DP6MP15D'),
    new ConditionalPeriod('DP6MP99YP1M')
];

// OR
$trial_periods = ConditionalCollection::parse('DP0DP6MP15D,DP6MP99YP1M');

Miscellaneous

You may of may not have noticed it, but every CarbonInterval argument can be replaced by either its ISO8601 duration spec (the same way you can instanciate a DateInterval, or a relative date string (as you can with CarbonInterval.

So, here are the 5 same ways to input a Carboninterval using ConditionalPeriod constructor:

Carboninterval::createFromDateString('1 year, 2 months, 3 days')
Carboninterval::make('P1Y2M3D');
new Carboninterval('P1Y2M3D');
'1 year, 2 months, 3 days'
'P1Y2M3D'

And there are 5 ways to create a ConditionalCollection:

ConditionalCollection::create(new ConditionalPeriod(…)), which instanciates it and sets its first value (); // Or ConditionalPeriod string form
new ConditionalCollection, then push to it: c->push(new ConditionalPeriod(…)); // or ConditionalPeriod string form
new ConditionalCollection, then treat it as an array: $c[] = new ConditionalPeriod(…); // or ConditionalPeriod string form
ConditionalCollection::parse(…), which takes its own toString() form
ConditionalCollection::fromArray(…), which takes an array of ConditionalPeriod or its string form

Need help?

Open an issue.

Now have fun.

max13 / conditional-period

Maintainers

Details