QtModel::setOrm() - Code Metrics - Inspection of "Model hidden section" - softberg/quantum-php-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#125)

unknown

created 2022-12-21 14:11 UTC

QtModel::setOrm() A

↳ Parent: QtModel

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	3
rs	10
c	2
b	0
f	0

<?php

/**
 * Quantum PHP Framework
 *
 * An open source software development framework for PHP
 *
 * @package Quantum
 * @author Arman Ag. <[email protected]>
 * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
 * @link http://quantum.softberg.org/
 * @since 2.9.0
 */

namespace Quantum\Mvc;

use Quantum\Libraries\Database\DbalInterface;
use Quantum\Exceptions\ModelException;

/**
 * Class QtModel
 * @package Quantum\Mvc
 * @method string getTable()
 * @method DbalInterface select(...$columns)
 * @method DbalInterface findOne(int $id)
 * @method DbalInterface findOneBy(string $column, $value)
 * @method DbalInterface first()
 * @method DbalInterface criteria(string $column, string $operator, $value = null)
 * @method DbalInterface criterias(...$criterias)
 * @method DbalInterface having(string $column, string $operator, string $value = null)
 * @method DbalInterface orderBy(string $column, string $direction)
 * @method DbalInterface limit(int $limit)
 * @method mixed get()
 * @method array asArray()
 * @method DbalInterface create()
 * @method bool save()
 * @method bool delete()
 * @method bool deleteMany()
 * @method DbalInterface joinTo(QtModel $model, bool $switch = true)
 * @method DbalInterface joinThrough(QtModel $model, bool $switch = true)
 */
abstract class QtModel
{

    /**
     * The database table associated with model
     * @var string
     */
    public $table;

    /**
     * Id column of table
     * @var string
     */
    public $idColumn = 'id';

    /**
     * Foreign keys
     * @var array
     */
    public $foreignKeys = [];

    /**
     * Models fillable properties
     * @var array
     */
    protected $fillable = [];

    /**
     * Models hidden properties
     * @var array
     */
    protected $hidden = [];

    /**
     * ORM database abstract layer object
     * @var \Quantum\Libraries\Database\DbalInterface
     */
    private $orm;

    /**
     * Sets the ORM
     * @param \Quantum\Libraries\Database\DbalInterface $orm
     */
    public function setOrm(DbalInterface $orm)
    {
        $this->orm = $orm;
    }

    /**
     * Fills the object properties
     * @param array $props
     * @return \Quantum\Mvc\QtModel
     * @throws \Quantum\Exceptions\ModelException
     */
    public function fillObjectProps(array $props): QtModel
    {
        foreach ($props as $key => $value) {
            if ($key == $this->idColumn) {
                continue;
            }

            if (!in_array($key, $this->fillable)) {
                throw ModelException::inappropriateProperty($key);
            }

            $this->prop($key, $value);
        }

        return $this;
    }

    /**
     * @inheritDoc
     * @throws DatabaseException
     */
    public function get(?int $returnType = DbalInterface::TYPE_ARRAY)
    {
        $result = $this->orm->get($returnType);

        $resultCount = count($result);

        if (count($this->hidden) > 0) {
            for ($i = 0; $i < $resultCount; $i++) {
                $result[$i] = array_diff_key($result[$i], array_flip($this->hidden));
            }
        }

        return $result;
    }

    /**
     * Sets or gets the model property
     * @param string $property
     * @param mixed|null $value
     * @return mixed
     */
    public function prop(string $property, $value = null)
    {
        return $this->orm->prop(...func_get_args());
        return $this->orm->prop(/** @scrutinizer ignore-type */ ...func_get_args());
    }

    /**
     * Gets the model property with magic
     * @param string $property
     * @return mixed
     */
    public function __get(string $property)
    {
        return $this->prop($property);
    }

    /**
     * Sets a value to the model property with magic
     * @param string $property
     * @param mixed $value
     */
    public function __set(string $property, $value)
    {
        $this->prop($property, $value);
    }

    /**
     * Allows calling the model methods
     * @param string $method
     * @param mixed|null $args
     * @return $this|array|int|string
     * @throws \Quantum\Exceptions\ModelException
     */
    public function __call(string $method, $args = null)
    {
        if (!method_exists($this->orm, $method)) {
            throw ModelException::undefinedMethod($method);
        }

        $result = $this->orm->{$method}(...$args);

        if (!is_object($result)) {
            return $result;
        }

        return $this;
    }

    /**
     * Keeps only relevant props at serialization
     * @return string[]
     */
    public function __sleep()
    {
        return [
            'table',
            'idColumn',
            'foreignKeys'
        ];
    }
}


softberg / quantum-php-core

Pull Request — master (#125)

QtModel::setOrm() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like