cashwarden / api

core/services/RecurrenceService.php

<?php

namespace app\core\services;

use app\core\exceptions\InvalidArgumentException;
use app\core\exceptions\ThirdPartyServiceErrorException;
use app\core\helpers\HolidayHelper;
use app\core\models\Recurrence;
use app\core\traits\SendRequestTrait;
use app\core\traits\ServiceTrait;
use app\core\types\RecurrenceFrequency;
use app\core\types\RecurrenceStatus;
use Yii;
use yii\base\BaseObject;
use yii\base\InvalidConfigException;
use yii\db\Exception;
use yii\web\NotFoundHttpException;
use yiier\helpers\Setup;

class RecurrenceService extends BaseObject
{
    use SendRequestTrait;
    use ServiceTrait;

    /**
     * @param int $id
     * @param string $status
     * @return Recurrence
     * @throws Exception
     * @throws InvalidConfigException
     * @throws NotFoundHttpException
     * @throws InvalidArgumentException
     */
    public function updateStatus(int $id, string $status): Recurrence
    {
        $model = $this->findCurrentOne($id);
        $model->load($model->toArray(), '');
        if (RecurrenceStatus::ACTIVE == RecurrenceStatus::toEnumValue($status)) {
            $model->started_at = strtotime($model->started_at) > time() ? $model->started_at : 'now';

It seems like $model->started_at can also be of type null; however, parameter $datetime of strtotime() does only seem to accept string, maybe add an additional type check?

        }
        $model->started_at = Yii::$app->formatter->asDate($model->started_at);
        $model->status = $status;

It seems like $status of type string is incompatible with the declared type integer|null of property $status.

        if (!$model->save()) {
            throw new Exception(Setup::errorMessage($model->firstErrors));
        }
        return $model;
    }


    /**
     * @param int $id
     * @return Recurrence|object
     * @throws NotFoundHttpException
     */
    public function findCurrentOne(int $id): Recurrence
    {
        if (!$model = Recurrence::find()->where(['id' => $id, 'user_id' => \Yii::$app->user->id])->one()) {
            throw new NotFoundHttpException('No data found');
        }
        return $model;

The expression return $model returns the type array which is incompatible with the type-hinted return app\core\models\Recurrence.

    }

    /**
     * @param Recurrence $recurrence
     * @return string|null
     * @throws InvalidConfigException
     * @throws \Exception
     */
    public static function getExecutionDate(Recurrence $recurrence)
    {
        $formatter = Yii::$app->formatter;
        switch ($recurrence->frequency) {
            case RecurrenceFrequency::DAY:
                $date = strtotime("+1 day", strtotime($recurrence->started_at));

It seems like $recurrence->started_at can also be of type null; however, parameter $datetime of strtotime() does only seem to accept string, maybe add an additional type check?

                break;
            case RecurrenceFrequency::WEEK:
                $currentWeekDay = $formatter->asDatetime('now', 'php:N') - 1;
                $weekDay = $recurrence->schedule;
                $addDay = $currentWeekDay > $weekDay ? 7 - $currentWeekDay + $weekDay : $weekDay - $currentWeekDay;
                $date = strtotime("+{$addDay} day", strtotime($recurrence->started_at));
                break;

            case RecurrenceFrequency::MONTH:
                $currDay = $formatter->asDatetime('now', 'php:d');
                $d = $recurrence->schedule;
                $date = Yii::$app->formatter->asDatetime($currDay > $d ? strtotime('+1 month') : time(), 'php:Y-m');
                $d = sprintf("%02d", $d);
                return "{$date}-{$d}";
            case RecurrenceFrequency::YEAR:
                $m = current(explode('-', $recurrence->schedule));

It seems like $recurrence->schedule can also be of type null; however, parameter $string of explode() does only seem to accept string, maybe add an additional type check?

                $currMonth = $formatter->asDatetime('now', 'php:m');
                $y = Yii::$app->formatter->asDatetime($currMonth > $m ? strtotime('+1 year') : time(), 'php:Y');
                return "{$y}-{$recurrence->schedule}";
            case RecurrenceFrequency::WORKING_DAY:
                if (($currentWeekDay = $formatter->asDatetime('now', 'php:N') - 1) > 5) {

The assignment to $currentWeekDay is dead and can be removed.

                    return null;
                }
                $date = strtotime("+1 day", strtotime($recurrence->started_at));
                break;
            case RecurrenceFrequency::LEGAL_WORKING_DAY:
                return HolidayHelper::getNextWorkday();
            default:
                return null;
        }
        return $formatter->asDatetime($date, 'php:Y-m-d');
    }

    /**
     * @param int $transactionId
     * @param int $userId
     * @return bool|int|string|null
     */
    public static function countByTransactionId(int $transactionId, int $userId)
    {
        return Recurrence::find()
            ->where(['user_id' => $userId, 'transaction_id' => $transactionId])
            ->count();
    }

    /**
     * @throws InvalidConfigException|ThirdPartyServiceErrorException
     */
    public static function updateAllExecutionDate()
    {
        $items = Recurrence::find()
            ->where(['status' => RecurrenceStatus::ACTIVE])
            ->andWhere(['!=', 'frequency', RecurrenceFrequency::LEGAL_WORKING_DAY])
            ->all();
        /** @var Recurrence $item */
        foreach ($items as $item) {
            $date = self::getExecutionDate($item);
            Recurrence::updateAll(
                ['execution_date' => $date, 'updated_at' => Yii::$app->formatter->asDatetime('now')],
                ['id' => $item->id]

Accessing id on the interface yii\db\ActiveRecordInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

            );
        }
        self::updateAllLegalWorkingDay();
    }

    /**
     * @throws InvalidConfigException
     * @throws ThirdPartyServiceErrorException
     */
    private static function updateAllLegalWorkingDay()
    {
        $items = Recurrence::find()
            ->where(['frequency' => RecurrenceFrequency::LEGAL_WORKING_DAY, 'status' => RecurrenceStatus::ACTIVE])
            ->asArray()
            ->all();
        $nextWorkday = HolidayHelper::getNextWorkday();
        foreach ($items as $key => $item) {
            Recurrence::updateAll(
                ['execution_date' => $nextWorkday, 'updated_at' => Yii::$app->formatter->asDatetime('now')],
                ['id' => $item['id']]
            );
        }
    }
}