TonisOrmisson / yii2-myabstract

src/traits/ModelWithHasStatusTrait.php

<?php
namespace andmemasin\myabstract\traits;

use andmemasin\myabstract\HasStatusModel;
use andmemasin\myabstract\StatusModel;
use yii\base\ErrorException;
use yii\base\UserException;
use yii\db\Query;

/**
 * Trait ModelWithHasStatusTrait
 * @package andmemasin\myabstract
 * @author Tonis Ormisson <tonis@andmemasin.eu>
 *
 * @property HasStatusModel[] $hasStatuses
 * @property StatusModel $currentStatus
 * @property HasStatusModel $hasStatus
 */
trait ModelWithHasStatusTrait
{

    /**
     * @return boolean
     */
    public function isActive() {
        /** @var StatusModel $statusModel */
        $statusModel = (new static)->statusModelClass;

The property statusModelClass does not exist on andmemasin\myabstract\traits\ModelWithHasStatusTrait. Did you mean status?

        return (new $statusModel)->isActive($this->currentStatus->id);
    }

    public function addStatus($status) {
        /** @var HasStatusModel $hasStatus */
        $hasStatus = new static::$hasStatusClassName;

The property hasStatusClassName does not exist on andmemasin\myabstract\traits\ModelWithHasStatusTrait. Did you mean hasStatus?

        $hasStatus->status = $status;
        $hasStatus->{$hasStatus->parentIdColumn} = static::getPrimaryKey();

        if (!$hasStatus->save()) {
            throw new UserException(serialize($hasStatus->errors));
        }
    }

    /** {@inheritdoc} */
    public function afterSave($insert, $changedAttributes)
    {

        if ($insert) {
            // add a created status im the status history if some other status is assigned
            if ($this->status != $this->initialStatus) {
                $this->addStatus($this->initialStatus);
            }
            $this->addStatus($this->status);
        } else {
            if (isset($changedAttributes['status'])) {
                $this->addStatus($this->status);
            }
        }
        parent::afterSave($insert, $changedAttributes);
    }


    /**
     * @return \yii\db\ActiveQuery
     */
    public function getHasStatuses()
    {
        /** @var HasStatusModel $hasStatus */
        $hasStatus = new static::$hasStatusClassName;

The property hasStatusClassName does not exist on andmemasin\myabstract\traits\ModelWithHasStatusTrait. Did you mean hasStatus?

        return $this->hasMany(static::$hasStatusClassName, [$hasStatus->parentIdColumn => $hasStatus->parentIdColumn]);

It seems like hasMany() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * @return HasStatusModel
     */
    public function getHasStatus()
    {
        /** @var HasStatusModel $hasStatusModel */
        $hasStatusModel = new static::$hasStatusClassName;

The property hasStatusClassName does not exist on andmemasin\myabstract\traits\ModelWithHasStatusTrait. Did you mean hasStatus?

        $query = $this->getHasStatuses();
        $query->orderBy([$hasStatusModel->primaryKeySingle()=>SORT_DESC]);
        /** @var HasStatusModel $model */
        $model = $query->limit(1)->one();
        return $model;
    }

    /**
     * @return StatusModel
     */
    public function getCurrentStatus()
    {
        /** @var StatusModel $class */
        $class = (new static)->statusModelClass;

The property statusModelClass does not exist on andmemasin\myabstract\traits\ModelWithHasStatusTrait. Did you mean status?

        return $class::getById($this->status);
    }


    /**
     * @param string $status
     * @param integer[] $model_ids
     * @throws ErrorException
     */
    public static function bulkSetStatus($status, $model_ids) {
        $query = new Query();
        /** @var StatusModel $class */
        $class = (new static)->statusModelClass;

The property statusModelClass does not exist on andmemasin\myabstract\traits\ModelWithHasStatusTrait. Did you mean status?

        if (!$class::isStatus($status)) {
            throw new ErrorException('Invalid Status');
        }
        $query->createCommand()
            ->update(static::tableName(), ['status'=>$status], ['in', (new static)->primaryKeySingle(), $model_ids])

It seems like primaryKeySingle() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            ->execute();
    }

    /**
     * Find the Latest one HasStatus model by status
     * @param $status
     * @return StatusModel
     */
    public function findStatus($status) {
        /** @var HasStatusModel $hasStatusModel */
        $hasStatusModel = new static::$hasStatusClassName;

The property hasStatusClassName does not exist on andmemasin\myabstract\traits\ModelWithHasStatusTrait. Did you mean hasStatus?

        $query = $this->getHasStatuses()
            ->andWhere(['status' => $status]);
        // latest first
        $query->orderBy([$hasStatusModel->primaryKeySingle() => SORT_DESC]);

        /** @var StatusModel $model */
        $model = $query->limit(1)->one();
        return $model;
    }

}