summaryrefslogtreecommitdiff
path: root/vendor/ruflin/elastica/lib/Elastica/ScriptFields.php
blob: 0a8b48711a25c36fa43257e7076e745638dd3c92 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
<?php

namespace Elastica;
use Elastica\Exception\InvalidException;

/**
 * Container for scripts as fields
 *
 * @category Xodoa
 * @package Elastica
 * @author Sebastien Lavoie <github@lavoie.sl>
 * @link http://www.elasticsearch.org/guide/reference/api/search/script-fields.html
 */
class ScriptFields extends Param
{
    /**
     * @param \Elastica\Script[]|array $scripts OPTIONAL
     */
    public function __construct(array $scripts = array())
    {
        if ($scripts) {
            $this->setScripts($scripts);
        }
    }

    /**
     * @param  string                              $name   Name of the Script field
     * @param  \Elastica\Script                     $script
     * @throws \Elastica\Exception\InvalidException
     * @return \Elastica\ScriptFields
     */
    public function addScript($name, Script $script)
    {
        if (!is_string($name) || !strlen($name)) {
            throw new InvalidException('The name of a Script is required and must be a string');
        }
        $this->setParam($name, $script->toArray());

        return $this;
    }

    /**
     * @param  \Elastica\Script[]|array $scripts Associative array of string => Elastica\Script
     * @return \Elastica\ScriptFields
     */
    public function setScripts(array $scripts)
    {
        $this->_params = array();
        foreach ($scripts as $name => $script) {
            $this->addScript($name, $script);
        }

        return $this;
    }

    /**
     * @return array
     */
    public function toArray()
    {
        return $this->_params;
    }
}