flipbox\craft\ember\actions\records\CreateRecord

Complexity

Total Complexity

4

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Test Coverage

Coverage

0%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
	newRecord()	0	1	?
A	validBodyParams()	0	4	1
A	populate()	0	8	1
A	run()	0	6	1
A	performAction()	0	4	1

<?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\craft\ember\actions\records;

use yii\base\Action;
use yii\db\ActiveRecord;

/**
 * @author Flipbox Factory <hello@flipboxfactory.com>
 * @since 2.0.0
 */
abstract class CreateRecord extends Action
{
    use SaveRecordTrait;

    /**
     * @var array
     */
    public $validBodyParams = [];

    /**
     * @inheritdoc
     */
    public $statusCodeSuccess = 201;

    /**
     * @param array $config
     * @return ActiveRecord
     */
    abstract protected function newRecord(array $config = []): ActiveRecord;

    /**
     * Body params that should be set on the record.
     *
     * @return array
     */
    protected function validBodyParams(): array
    {
        return $this->validBodyParams;
    }

    /**
     * @param ActiveRecord $record
     * @return ActiveRecord
     */
    protected function populate(ActiveRecord $record): ActiveRecord
    {
        $record->setAttributes(
            $this->attributeValuesFromBody()
        );

        return $record;
    }

    /**
     * @return ActiveRecord
     * @throws \yii\web\HttpException
     */
    public function run()
    {
        return $this->runInternal(
            $this->newRecord()
        );
    }

    /**
     * @inheritdoc
     * @param ActiveRecord $record
     */
    protected function performAction(ActiveRecord $record): bool
    {
        return $record->save();
    }
}