Doctrine\ODM\MongoDB\Aggregation\Stage\Facet

Complexity

Total Complexity

6

Size/Duplication

Total Lines	54
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getExpression()	0	8	1
A	field()	0	6	1
A	pipeline()	0	18	4

<?php

declare(strict_types=1);

namespace Doctrine\ODM\MongoDB\Aggregation\Stage;

use Doctrine\ODM\MongoDB\Aggregation\Builder;
use Doctrine\ODM\MongoDB\Aggregation\Stage;
use InvalidArgumentException;
use LogicException;
use function array_map;

/**
 * Fluent interface for adding a $facet stage to an aggregation pipeline.
 */
class Facet extends Stage
{
    /** @var Builder[] */
    private $pipelines = [];

    /** @var string */
    private $field;

    /**
     * {@inheritdoc}
     */
    public function getExpression() : array
    {
        return [
            '$facet' => array_map(static function (Builder $builder) {
                return $builder->getPipeline();
            }, $this->pipelines),
        ];
    }

    /**
     * Set the current field for building the pipeline stage.
     */
    public function field(string $field) : self
    {
        $this->field = $field;

        return $this;
    }

    /**
     * Use the given pipeline for the current field.
     *
     * @param Builder|Stage $builder
     */
    public function pipeline($builder) : self
    {
        if (! $this->field) {
            throw new LogicException(__METHOD__ . ' requires you set a current field using field().');
        }

        if ($builder instanceof Stage) {
            $builder = $builder->builder;
        }

        if (! $builder instanceof Builder) {
            throw new InvalidArgumentException(__METHOD__ . ' expects either an aggregation builder or an aggregation stage.');
        }

        $this->pipelines[$this->field] = $builder;

        return $this;
    }
}