flipbox\ember\services\traits\records\ActiveRecord

Complexity

Total Complexity

5

Size/Duplication

Total Lines	74
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

0%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
	recordClass()	0	1	?
A	getDb()	0	7	1
A	create()	0	15	2
A	getQuery()	0	14	1
A	prepareQueryConfig()	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\ember\services\traits\records;

use flipbox\ember\helpers\QueryHelper;
use yii\db\ActiveQuery;
use yii\db\ActiveRecord as Record;
use yii\db\Connection;

/**
 * @author Flipbox Factory <hello@flipboxfactory.com>
 * @since 1.0.0
 */
trait ActiveRecord
{
    /**
     * @return string
     */
    public abstract static function recordClass(): string;

    /**
     * @return Connection
     */
    protected static function getDb(): Connection
    {
        /** @var Record $recordClass */
        $recordClass = static::recordClass();

        return $recordClass::getDb();
    }

    /*******************************************
     * CREATE
     *******************************************/

    /**
     * @param array $attributes
     * @return Record
     */
    public function create(array $attributes = []): Record
    {
        /** @var string $recordClass */
        $recordClass = static::recordClass();

        /** @var Record $record */
        $record = new $recordClass();

        // Do we need to set properties too
        if (!empty($attributes)) {
            $record->setAttributes($attributes);
        }

        return $record;
    }

    /*******************************************
     * QUERY
     *******************************************/

    /**
     * @param array $config
     * @return \yii\db\ActiveQuery
     */
    public function getQuery($config = []): ActiveQuery
    {
        /** @var Record $recordClass */
        $recordClass = static::recordClass();

        $query = $recordClass::find();

        QueryHelper::configure(
            $query,
            $this->prepareQueryConfig($config)
        );

        return $query;
    }

    /**
     * @param array $config
     * @return array
     */
    protected function prepareQueryConfig($config = [])
    {
        return $config;
    }
}