flipbox\ember\services\traits\ModelSave

Complexity

Total Complexity

17

Size/Duplication

Total Lines	149
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

0%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
	modelToRecord()	0	1	?
	isNew()	0	1	?
B	save()	0	55	6
A	beforeSave()	0	4	1
A	afterSave()	0	8	1
A	transferFromRecord()	0	10	4
B	transferAuditAttributes()	0	16	5

<?php

/**
 * @copyright  Copyright (c) Flipbox Digital Limited
 * @license    https://github.com/flipboxfactory/craft-ember/blob/master/LICENSE
 * @link       https://github.com/flipboxfactory/craft-ember
 */

namespace flipbox\ember\services\traits;

use Craft;
use craft\events\ModelEvent;
use flipbox\ember\interfaces\IdAttributeInterface;
use flipbox\ember\models\Model;
use yii\db\ActiveRecord as Record;

/**
 * @author Flipbox Factory <hello@flipboxfactory.com>
 * @since 1.0.0
 */
trait ModelSave
{
    /*******************************************
     * ABSTRACTS
     *******************************************/

    /**
     * @param Model $model
     * @param bool $mirrorScenario
     * @return Record
     */
    abstract protected function modelToRecord(Model $model, bool $mirrorScenario = true): Record;

    /**
     * @param Model $model
     * @return bool
     */
    abstract protected function isNew(Model $model): bool;

    /*******************************************
     * SAVE
     *******************************************/

    /**
     * @param Model $model
     * @param bool $runValidation
     * @param null $attributes
     * @param bool $mirrorScenario
     * @return bool
     * @throws \Exception
     */
    public function save(Model $model, bool $runValidation = true, $attributes = null, bool $mirrorScenario = true)
    {
        $isNew = $this->isNew($model);

        // a 'beforeSave' event
        if (!$this->beforeSave($model, $isNew)) {
            return false;
        }

        // Create event
        $event = new ModelEvent([
            'isNew' => $isNew
        ]);

        // Db transaction
        $transaction = Craft::$app->getDb()->beginTransaction();

        try {
            // The 'before' event
            if (!$model->beforeSave($event)) {
                $transaction->rollBack();
                return false;
            }

            $record = $this->modelToRecord($model, $mirrorScenario);

            // Insert record
            if (!$record->save($runValidation, $attributes)) {
                $model->addErrors($record->getErrors());
                $transaction->rollBack();
                return false;
            }

            // Transfer attributes to model
            $this->transferFromRecord(
                $model,
                $record,
                $isNew
            );

            // The 'after' event
            if (!$model->afterSave($event)) {
                $transaction->rollBack();
                return false;
            }
        } catch (\Exception $e) {
            $transaction->rollBack();

            throw $e;
        }

        $transaction->commit();
        $this->afterSave($model, $isNew);
        return true;
    }

    /**
     * @param Model $model
     * @param bool $isNew
     * @return bool
     */
    protected function beforeSave(Model $model, bool $isNew): bool
    {
        return true;
    }

    /**
     * @param Model $model
     * @param bool $isNew
     */
    protected function afterSave(Model $model, bool $isNew)
    {

        Craft::info(sprintf(
            "Model '%s' was saved successfully.",
            (string)get_class($model)
        ), __METHOD__);
    }

    /**
     * @param Model $model
     * @param Record $record
     * @param bool $isNew
     * @return void
     */
    protected function transferFromRecord(Model $model, Record $record, bool $isNew)
    {
        if ($isNew) {
            if ($model instanceof IdAttributeInterface && $record instanceof IdAttributeInterface) {
                $model->setId($record->getId());
            }
        }

        $this->transferAuditAttributes($model, $record, $isNew);
    }

    /**
     * @param Model $model
     * @param Record $record
     * @param bool $isNew
     */
    protected function transferAuditAttributes(Model $model, Record $record, bool $isNew)
    {
        if ($isNew) {
            if ($record->hasAttribute('dateCreated')) {
                $model->setDateCreated($record->getAttribute('dateCreated'));
            }

            if ($record->hasAttribute('uid')) {
                $model->uid = $record->getAttribute('uid');
            }
        }

        if ($record->hasAttribute('dateUpdated')) {
            $model->setDateUpdated($record->getAttribute('dateUpdated'));
        }
    }
}