Spiral\ODM\Traits\FindTrait

Complexity

Total Complexity

38

Size/Duplication

Total Lines	69
Duplicated Lines	20.29 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	3
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	find()	0	4	1
A	findOne()	0	4	1
A	findByPK()	0	4	1
A	source()	14	14	2

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

use Spiral\ODM\Document;
use Spiral\ODM\Entities\DocumentSelector;
use Spiral\ODM\Entities\DocumentSource;
use Spiral\ODM\ODM;
use Spiral\ORM\Exceptions\ORMException;
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|\Closure $where Selection WHERE statement.
     * @return DocumentSelector
     */
    public static function find($where = [])
    {
        return static::source()->find($where);

It seems like $where defined by parameter $where on line 31 can also be of type object<Closure>; however, Spiral\ODM\Entities\DocumentSource::find() does only seem to accept array, maybe add an additional type check?

    }

    /**
     * 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|\Closure $where  Selection WHERE statement.
     * @param array          $sortBy Sort by.
     * @return RecordEntity|null
     */
    public static function findOne($where = [], array $sortBy = [])
    {
        return static::source()->findOne($where, $sortBy);

It seems like $where defined by parameter $where on line 47 can also be of type object<Closure>; however, Spiral\ODM\Entities\DocumentSource::findOne() does only seem to accept array, maybe add an additional type check?

    }

    /**
     * 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.
     * @return Document|null
     */
    public static function findByPK($primaryKey)
    {
        return static::source()->findByPK($primaryKey);
    }

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

This method seems to be duplicated in your project.

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

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