flipbox\spark\services\traits\ModelSave

Complexity

Total Complexity

15

Size/Duplication

Total Lines	152
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Test Coverage

Coverage

0%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
	toRecord()	0	1	?
C	save()	0	80	9
A	beforeSave()	0	4	1
A	afterSave()	0	8	1
A	transferFromRecord()	0	14	4

<?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\services\traits;

use Craft;
use craft\events\ModelEvent;
use flipbox\spark\helpers\RecordHelper;
use flipbox\spark\models\Model;

This use statement conflicts with another class in this namespace, flipbox\spark\services\traits\Model.

use flipbox\spark\models\ModelWithId;
use flipbox\spark\records\Record;
use flipbox\spark\records\RecordWithId;

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

    /*******************************************
     * ABSTRACTS
     *******************************************/

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


    /*******************************************
     * 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)
    {

        // Validate
        if ($runValidation && !$model->validate($attributes)) {
            Craft::info('Model not saved due to validation error.', __METHOD__);
            return false;
        }

        $isNew = $model->isNew();

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

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

        // Db transaction
        $transaction = RecordHelper::beginTransaction();

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

                return false;
            }

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

            // Validate
            if (!$record->validate($attributes)) {
                $model->addErrors($record->getErrors());

                $transaction->rollBack();

                return false;
            }

            // Insert record
            if (!$record->save($attributes)) {

$attributes is of type null, but the function expects a boolean.

                // Transfer errors to model
                $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();

        // an 'afterSave' event
        $this->afterSave($model, $isNew);

        return true;
    }

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

The parameter $model is not used and could be removed.

The parameter $isNew is not used and could be removed.

    {
        return true;
    }

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

The parameter $isNew is not used and could be removed.

    {

        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)
    {

        // Transfer record to model
        if ($isNew) {
            if ($model instanceof ModelWithId && $record instanceof RecordWithId) {
                $model->id = $record->id;
            }

            $model->dateCreated = $record->dateCreated;
            $model->uid = $record->uid;
        }
        $model->dateUpdated = $record->dateUpdated;
    }
}