Spiral\ODM\Traits\SourceTrait

Complexity

Total Complexity

5

Size/Duplication

Total Lines	96
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

5 Methods

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

<?php
/**
 * Spiral Framework.
 *
 * @license   MIT
 * @author    Anton Titov (Wolfy-J)
 */

namespace Spiral\ODM\Traits;

use Interop\Container\ContainerInterface;
use Spiral\Core\Component;
use Spiral\Core\Exceptions\ScopeException;
use Spiral\ODM\CompositableInterface;
use Spiral\ODM\Document;
use Spiral\ODM\Entities\DocumentSelector;
use Spiral\ODM\Entities\DocumentSource;
use Spiral\ODM\ODMInterface;

/**
 * Static record functionality including create and find methods.
 */
trait SourceTrait
{
    /**
     * Find multiple documents based on provided query.
     *
     * Example:
     * User::find(['status' => 'active'];
     *
     * @param array $query Selection WHERE statement.
     *
     * @return DocumentSelector
     *
     * @throws ScopeException
     */
    public static function find(array $query = []): DocumentSelector
    {
        return static::source()->find($query);
    }

    /**
     * Fetch one record based on provided query or return null. Make sure to specify sort by in
     * order to stabilize selection
     *
     * Example:
     * User::findOne(['name' => 'Wolfy-J'], ['id' => -1]);
     *
     * @param array $where  Selection WHERE statement.
     * @param array $sortBy Sort by.
     *
     * @return CompositableInterface|Document|null
     *
     * @throws ScopeException
     */
    public static function findOne($where = [], array $sortBy = [])
    {
        return static::source()->findOne($where, $sortBy);
    }

    /**
     * Find record using it's primary key.
     *
     * Example:
     * User::findByOK(1);
     *
     * @param mixed $primaryKey Primary key.
     *
     * @return CompositableInterface|Document|null
     *
     * @throws ScopeException
     */
    public static function findByPK($primaryKey)
    {
        return static::source()->findByPK($primaryKey);
    }

    /**
     * Instance of ODM Selector associated with specific document.
     *
     * @see   Component::staticContainer()
     **
     * @return DocumentSource
     *
     * @throws ScopeException
     */
    public static function source(): DocumentSource
    {
        /**
         * Container to be received via global scope.
         *
         * @var ContainerInterface $container
         */
        //Via global scope
        $container = self::staticContainer();

        if (empty($container)) {
            //Via global scope
            throw new ScopeException(sprintf(
                "Unable to get '%s' source, no container scope is available",
                static::class
            ));
        }

        return $container->get(ODMInterface::class)->source(static::class);
    }

    /**
     * Trait can ONLY be added to components.
     *
     * @see Component
     *
     * @param ContainerInterface|null $container
     *
     * @return ContainerInterface|null
     */
    abstract protected static function staticContainer(ContainerInterface $container = null);
}