FindTrait::findByPK() - Code Metrics - Inspection of "CS" - spiral/components - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — develop (f7dc53)

by Anton

created 2015-12-14 20:59 UTC

FindTrait::findByPK() A

↳ Parent: FindTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	2

<?php
/**
 * Spiral Framework.
 *
 * @license   MIT
 * @author    Anton Titov (Wolfy-J)
 */
namespace Spiral\ORM\Traits;

use Spiral\ORM\Entities\RecordSelector;
use Spiral\ORM\Entities\RecordSource;
use Spiral\ORM\Exceptions\ORMException;
use Spiral\ORM\ORM;
use Spiral\ORM\RecordEntity;

/**
 * Static record functionality including create and find methods.
 */
trait FindTrait
{
    /**
     * Find multiple records based on provided query.
     *
     * Example:
     * User::find(['status' => 'active'], ['profile']);
     *
     * @param array $where Selection WHERE statement.
     * @param array $load  Array or relations to be pre-loaded.
     * @return RecordSelector
     */
    public static function find($where = [], array $load = [])
    {
        return static::source()->find($where)->load($load);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Fetch one record based on provided query or return null. Use second argument to specify
     * relations to be loaded.
     *
     * Example:
     * User::findOne(['name' => 'Wolfy-J'], ['profile'], ['id' => 'DESC']);
     *
     * @param array $where   Selection WHERE statement.
     * @param array $load    Array or relations to be pre-loaded.
     * @param array $orderBy Sort by conditions.
     * @return RecordEntity|null
     */
    public static function findOne($where = [], array $load = [], array $orderBy = [])
    {
        $source = static::find($where, $load);
        foreach ($orderBy as $column => $direction) {
            $source->orderBy($column, $direction);
        }

        return $source->findOne();
    }

    /**
     * Find record using it's primary key. Relation data can be preloaded with found record.
     *
     * Example:
     * User::findByID(1, ['profile']);
     *
     * @param mixed $primaryKey Primary key.
     * @param array $load       Array or relations to be pre-loaded.
     * @return RecordEntity|null
     */
    public static function findByPK($primaryKey, array $load = [])
    {
        return static::source()->find()->load($load)->findByPK($primaryKey);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Instance of ORM Selector associated with specific document.
     *
     * @see   Component::staticContainer()
     * @param ORM $orm ORM component, global container will be called if not instance provided.
     * @return RecordSource
     * @throws ORMException
     */
    public static function source(ORM $orm = null)

    {
        /**
         * Using global container as fallback.
         *
         * @var ORM $orm
         */
        if (empty($orm)) {
            //Using global container as fallback
            $orm = self::staticContainer()->get(ORM::class);
        }

        return $orm->source(static::class);
    }
}

1		<?php
2		/**
3		* Spiral Framework.
4		*
5		* @license MIT
6		* @author Anton Titov (Wolfy-J)
7		*/
8		namespace Spiral\ORM\Traits;
9
10		use Spiral\ORM\Entities\RecordSelector;
11		use Spiral\ORM\Entities\RecordSource;
12		use Spiral\ORM\Exceptions\ORMException;
13		use Spiral\ORM\ORM;
14		use Spiral\ORM\RecordEntity;
15
16		/**
17		* Static record functionality including create and find methods.
18		*/
19		trait FindTrait
20		{
21		/**
22		* Find multiple records based on provided query.
23		*
24		* Example:
25		* User::find(['status' => 'active'], ['profile']);
26		*
27		* @param array $where Selection WHERE statement.
28		* @param array $load Array or relations to be pre-loaded.
29		* @return RecordSelector
30		*/
31		public static function find($where = [], array $load = [])
32		{
33		return static::source()->find($where)->load($load);
		0 ignored issues – show Documentation introduced 2015-11-21 12:38 UTC by Report Bug Copy Issue Report `$load` is of type `array`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
34		}
35
36		/**
37		* Fetch one record based on provided query or return null. Use second argument to specify
38		* relations to be loaded.
39		*
40		* Example:
41		* User::findOne(['name' => 'Wolfy-J'], ['profile'], ['id' => 'DESC']);
42		*
43		* @param array $where Selection WHERE statement.
44		* @param array $load Array or relations to be pre-loaded.
45		* @param array $orderBy Sort by conditions.
46		* @return RecordEntity\|null
47		*/
48		public static function findOne($where = [], array $load = [], array $orderBy = [])
49		{
50		$source = static::find($where, $load);
51		foreach ($orderBy as $column => $direction) {
52		$source->orderBy($column, $direction);
53		}
54
55		return $source->findOne();
56		}
57
58		/**
59		* Find record using it's primary key. Relation data can be preloaded with found record.
60		*
61		* Example:
62		* User::findByID(1, ['profile']);
63		*
64		* @param mixed $primaryKey Primary key.
65		* @param array $load Array or relations to be pre-loaded.
66		* @return RecordEntity\|null
67		*/
68		public static function findByPK($primaryKey, array $load = [])
69		{
70		return static::source()->find()->load($load)->findByPK($primaryKey);
		0 ignored issues – show Documentation introduced 2015-11-21 12:38 UTC by Report Bug Copy Issue Report `$load` is of type `array`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
71		}
72
73		/**
74		* Instance of ORM Selector associated with specific document.
75		*
76		* @see Component::staticContainer()
77		* @param ORM $orm ORM component, global container will be called if not instance provided.
78		* @return RecordSource
79		* @throws ORMException
80		*/
81	View Code Duplication	public static function source(ORM $orm = null)
		0 ignored issues – show Duplication introduced 2015-11-21 12:38 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
82		{
83		/**
84		* Using global container as fallback.
85		*
86		* @var ORM $orm
87		*/
88		if (empty($orm)) {
89		//Using global container as fallback
90		$orm = self::staticContainer()->get(ORM::class);
91		}
92
93		return $orm->source(static::class);
94		}
95		}

spiral / components

Branch — develop (f7dc53)

FindTrait::findByPK() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like