flipbox\spark\models\Model

Complexity

Total Complexity

9

Size/Duplication

Total Lines	155
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

0%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	isNew()	0	4	1
B	rules()	0	27	1
A	attributes()	0	11	1
A	attributeLabels()	0	12	1
A	fields()	0	11	1
A	beforeDelete()	0	5	1
A	afterDelete()	0	5	1
A	beforeSave()	0	5	1
A	afterSave()	0	5	1

<?php

/**
 * @copyright  Copyright (c) Flipbox Digital Limited
 * @license    https://github.com/flipbox/spark/blob/master/LICENSE
 * @link       https://github.com/flipbox/spark
 */

namespace flipbox\spark\models;

use Craft;
use craft\events\ModelEvent as ModelSaveEvent;
use craft\validators\DateTimeValidator;
use DateTime;
use flipbox\spark\helpers\ModelHelper;
use flipbox\spark\models\traits\DateCreatedAttribute;
use flipbox\spark\models\traits\DateUpdatedAttribute;
use yii\base\Model as BaseModel;
use yii\base\ModelEvent as ModelDeleteEvent;

/**
 * @property DateTime $dateCreated
 * @property DateTime $dateUpdated
 *
 * @author Flipbox Factory <hello@flipboxfactory.com>
 * @since 1.0.0
 */
abstract class Model extends BaseModel
{

    use DateCreatedAttribute, DateUpdatedAttribute;

    /**
     * @event ModelEvent an event. You may set
     * [[ModelEvent::isValid]] to be false to stop the save.
     */
    const EVENT_BEFORE_SAVE = 'beforeSave';

    /**
     * @event ModelEvent an event. You may set
     * [[ModelEvent::isValid]] to be false to stop the save.
     */
    const EVENT_AFTER_SAVE = 'afterSave';

    /**
     * @event ModelEvent an event. You may set
     * [[ModelEvent::isValid]] to be false to stop the deletion.
     */
    const EVENT_BEFORE_DELETE = 'beforeDelete';

    /**
     * @event ModelEvent an event. You may set
     * [[ModelEvent::isValid]] to be false to stop the deletion.
     */
    const EVENT_AFTER_DELETE = 'afterDelete';

    /**
     * @var string
     */
    public $uid;

    /**
     * @return bool
     */
    public function isNew(): bool
    {
        return true;
    }

    /**
     * @inheritdoc
     */
    public function rules()
    {

        return array_merge(
            parent::rules(),
            [
                [
                    [
                        'dateCreated',
                        'dateUpdated'
                    ],
                    DateTimeValidator::class
                ],
                [
                    [
                        'uid',
                        'dateCreated',
                        'dateUpdated'
                    ],
                    'safe',
                    'on' => [
                        ModelHelper::SCENARIO_DEFAULT
                    ]
                ]
            ]
        );
    }

    /**
     * @inheritdoc
     */
    public function attributes()
    {

        return array_merge(
            parent::attributes(),
            [
                'dateCreated',
                'dateUpdated'
            ]
        );
    }

    /**
     * @inheritdoc
     */
    public function attributeLabels()
    {

        return array_merge(
            parent::attributeLabels(),
            [
                'uid' => Craft::t('app', 'UID'),
                'dateCreated' => Craft::t('app', 'Date Created'),
                'dateUpdated' => Craft::t('app', 'Date Updated')
            ]
        );
    }

    /**
     * @inheritdoc
     */
    public function fields()
    {

        return array_merge(
            parent::fields(),
            [
                'dateCreated' => 'dateCreatedIso8601',
                'dateUpdated' => 'dateUpdatedIso8601'
            ]
        );
    }

    /**
     * @inheritdoc
     */
    public function beforeDelete(ModelDeleteEvent $event): bool
    {
        $this->trigger(self::EVENT_BEFORE_DELETE, $event);
        return $event->isValid;
    }

    /**
     * @inheritdoc
     */
    public function afterDelete(ModelDeleteEvent $event): bool
    {
        $this->trigger(self::EVENT_AFTER_DELETE, $event);
        return $event->isValid;
    }

    /**
     * @inheritdoc
     */
    public function beforeSave(ModelSaveEvent $event): bool
    {
        $this->trigger(self::EVENT_BEFORE_SAVE, $event);
        return $event->isValid;
    }

    /**
     * @inheritdoc
     */
    public function afterSave(ModelSaveEvent $event): bool
    {
        $this->trigger(self::EVENT_AFTER_SAVE, $event);
        return $event->isValid;
    }
}