sfneal / time-helpers

src/Carbonate.php

<?php

namespace Sfneal\Helpers\Time;

use Carbon\Carbon;

class Carbonate
{
    /**
     * Create a Carbon datetime objects $x days forward/backward in the past or future.
     *
     *  - a positive(+) integer $days value correlates to days FORWARD
     *  - a negative(-) integer $days value correlates to days BACKWARD
     *
     * @param int $days
     * @return Carbon
     */
    public static function days(int $days): Carbon
    {
        return ($days < 0) ? self::daysAgo(abs($days)) : self::daysHence($days);

It seems like abs($days) can also be of type double; however, parameter $days of Sfneal\Helpers\Time\Carbonate::daysAgo() does only seem to accept integer, maybe add an additional type check?

    }

    /**
     * Create a Carbon datetime objects $x months forward/backward in the past or future.
     *
     *  - a positive(+) integer $months value correlates to days FORWARD
     *  - a negative(-) integer $months value correlates to days BACKWARD
     *
     * @param int $months
     * @return Carbon
     */
    public static function months(int $months): Carbon
    {
        return ($months < 0) ? self::monthsAgo(abs($months)) : self::monthsHence($months);

It seems like abs($months) can also be of type double; however, parameter $months of Sfneal\Helpers\Time\Carbonate::monthsAgo() does only seem to accept integer, maybe add an additional type check?

    }

    /**
     * Create a Carbon datetime objects $x years forward/backward in the past or future.
     *
     *  - a positive(+) integer $years value correlates to days FORWARD
     *  - a negative(-) integer $years value correlates to days BACKWARD
     *
     * @param int $years
     * @return Carbon
     */
    public static function years(int $years): Carbon
    {
        return ($years < 0) ? self::yearsAgo(abs($years)) : self::yearsHence($years);

It seems like abs($years) can also be of type double; however, parameter $years of Sfneal\Helpers\Time\Carbonate::yearsAgo() does only seem to accept integer, maybe add an additional type check?

    }

    /**
     * Create a Carbon datetime object representing $x days ago.
     *
     * @param int $days
     * @return Carbon
     */
    public static function daysAgo(int $days): Carbon
    {
        return Carbon::now()->subDays($days);
    }

    /**
     * Create a Carbon datetime object representing $x days from now.
     *
     * @param int $days
     * @return Carbon
     */
    public static function daysHence(int $days): Carbon
    {
        return Carbon::now()->addDays($days);
    }

    /**
     * Create a Carbon datetime object representing $x months ago.
     *
     * @param int $months
     * @return Carbon
     */
    public static function monthsAgo(int $months): Carbon
    {
        return Carbon::now()->subMonths($months);
    }

    /**
     * Create a Carbon datetime object representing $x months from now.
     *
     * @param int $months
     * @return Carbon
     */
    public static function monthsHence(int $months): Carbon
    {
        return Carbon::now()->addMonths($months);
    }

    /**
     * Create a Carbon datetime object representing $x days ago.
     *
     * @param int $years
     * @return Carbon
     */
    public static function yearsAgo(int $years): Carbon
    {
        return Carbon::now()->subYears($years);
    }

    /**
     * Create a Carbon datetime object representing $x days from now.
     *
     * @param int $years
     * @return Carbon
     */
    public static function yearsHence(int $years): Carbon
    {
        return Carbon::now()->addYears($years);
    }
}