Elastica\Processor\ForeachProcessor

Complexity

Total Complexity

5

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	setField()	0	4	1
A	setProcessor()	0	4	1
A	setRawProcessor()	0	4	1
A	setIgnoreMissing()	0	4	1
A	_getBaseName()	0	4	1

<?php

namespace Elastica\Processor;

/**
 * Elastica Foreach Processor.
 *
 * @author Federico Panini <fpanini@gmail.com>
 * @author Thibaut Simon-Fine <tsimonfine@gmail.com>
 *
 * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/foreach-processor.html
 */
class ForeachProcessor extends AbstractProcessor
{
    public const DEFAULT_IGNORE_MISSING_VALUE = false;
    protected const PROCESSOR_NAME = 'foreach';

    /**
     * Set field.
     *
     * @return $this
     */
    public function setField(string $field): self
    {
        return $this->setParam('field', $field);
    }

    /**
     * Set processor.
     *
     * @param AbstractProcessor
     *
     * @return $this
     */
    public function setProcessor(AbstractProcessor $processor): self
    {
        return $this->setParam('processor', $processor);
    }

    /**
     * Set raw processor.
     * Example : ['remove' => ['field' => 'user_agent']].
     *
     * @return $this
     */
    public function setRawProcessor(array $processor): self
    {
        return $this->setParam('processor', $processor);
    }

    /**
     * Set ignore_missing. Default value false.
     *
     * If true and field does not exist or is null, the processor quietly exits without modifying the document
     *
     * @return $this
     */
    public function setIgnoreMissing(bool $ignoreMissing): self
    {
        return $this->setParam('ignore_missing', $ignoreMissing);
    }

    /**
     * Param's name
     * Picks the last part of the class name and makes it snake_case
     * You can override this method if you want to change the name.
     *
     * @return string name
     */
    protected function _getBaseName()
    {
        return self::PROCESSOR_NAME;
    }
}