Facile\MongoDbBundle\Services\Explain\ExplainQueryService

Complexity

Total Complexity

3

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	1

2 Methods

Rating	Name	Duplication	Size	Complexity
A	execute()	0	14	2
A	__construct()	0	3	1

<?php

namespace Facile\MongoDbBundle\Services\Explain;

use Facile\MongoDbBundle\Models\Query;
use Facile\MongoDbBundle\Services\ClientRegistry;
use MongoDB\Driver\Command;
use MongoDB\Driver\Cursor;

class ExplainQueryService
{
    const VERBOSITY_QUERY_PLANNER = 'queryPlanner';

    const VERBOSITY_EXECUTION_STATS = 'executionStats';

    const VERBOSITY_ALL_PLAN_EXECUTION = 'allPlansExecution';

    public const ACCEPTED_METHODS = [
        'count',
        'distinct',
        'find',
        'findOne',
        'findOneAndUpdate',
        'findOneAndDelete',
        'deleteOne',
        'deleteMany',
        'aggregate',
    ];

    /** @var ClientRegistry */
    private $clientRegistry;

    /**
     * Constructs a explain command.
     *
     * Supported options:
     * verbosity : queryPlanner | executionStats Mode | allPlansExecution (default)
     * The explain command provides information on the execution of the following commands:
     * count, distinct, group, find, findAndModify, delete, and update.
     *
     * @param ClientRegistry $clientRegistry
     */
    public function __construct(ClientRegistry $clientRegistry)
    {
        $this->clientRegistry = $clientRegistry;
    }

    /**
     * Execute the operation.
     *
     * @param Query $query
     * @param string $verbosity
     *
     * @throws \Exception
     *
     * @return Cursor
     */
    public function execute(Query $query, string $verbosity = self::VERBOSITY_ALL_PLAN_EXECUTION): Cursor
    {
        if (! \in_array($query->getMethod(), self::ACCEPTED_METHODS, true)) {
            throw new \InvalidArgumentException(
                'Cannot explain the method \'' . $query->getMethod() . '\'. Allowed methods: ' . implode(', ', self::ACCEPTED_METHODS)
            );
        }

        $manager = $this->clientRegistry->getClient($query->getClient(), $query->getDatabase())->__debugInfo()['manager'];

        return $manager
            ->executeCommand(
                $query->getDatabase(),
                new Command(ExplainCommandBuilder::createCommandArgs($query, $verbosity))
            );
    }
}