flipbox\craft\ember\actions\models\CreateModel

Complexity

Total Complexity

3

Size/Duplication

Total Lines	53
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Test Coverage

Coverage

0%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
	newModel()	0	1	?
A	run()	0	4	1
A	validBodyParams()	0	4	1
A	populate()	0	9	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\models;

use yii\base\Action;
use yii\base\Model;

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

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

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

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

    /**
     * @return Model|null
     * @throws \yii\web\UnauthorizedHttpException
     */
    public function run()
    {
        return $this->runInternal($this->newModel());
    }

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

    /**
     * @param Model $model
     * @return Model
     */
    protected function populate(Model $model): Model
    {
        // Valid attribute values
        $model->setAttributes(
            $this->attributeValuesFromBody()
        );

        return $model;
    }
}