metadata/ChoiceBuilderInterface.php at main · klipperdev/metadata · GitHub

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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
<?php

/*
 * This file is part of the Klipper package.
 *
 * (c) François Pluchino <francois.pluchino@klipper.dev>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Klipper\Component\Metadata;

use Symfony\Component\Config\Resource\ResourceInterface;

/**
 * @author François Pluchino <francois.pluchino@klipper.dev>
 */
interface ChoiceBuilderInterface
{
    /**
     * Get the unique name of the choice.
     */
    public function getName(): string;

    /**
     * Get the list of choice.
     */
    public function getListIdentifiers(): ?array;

    /**
     * Set the list identifiers.
     *
     * @param array $identifiers the map of values and labels or the map wrapped by the group labels
     *
     * @return static
     */
    public function setListIdentifiers(array $identifiers);

    /**
     * Get all values.
     *
     * @return null|string[]
     */
    public function getValues(): ?array;

    /**
     * Set the values.
     *
     * @param null|array $values The values
     *
     * @return static
     */
    public function setValues(?array $values);

    /**
     * Get the translation domain name.
     */
    public function getTranslationDomain(): ?string;

    /**
     * Set the translation domain.
     *
     * @param string $translationDomain The translation domain
     *
     * @return static
     */
    public function setTranslationDomain(?string $translationDomain);

    /**
     * Get the placeholder.
     */
    public function getPlaceholder(): ?string;

    /**
     * Set the placeholder.
     *
     * @param string $placeholder The placeholder
     *
     * @return static
     */
    public function setPlaceholder(?string $placeholder);

    /**
     * Returns an array of resources loaded to build this choice.
     *
     * @return ResourceInterface[] An array of resources
     */
    public function getResources(): array;

    /**
     * Adds a resource for this choice. If the resource already exists
     * it is not added.
     *
     * @param ResourceInterface $resource The resource instance
     */
    public function addResource(ResourceInterface $resource);

    /**
     * Merge the choice builder.
     *
     * @param ChoiceBuilderInterface $builder The new choice builder
     *
     * @return static
     */
    public function merge(ChoiceBuilderInterface $builder);

    /**
     * Build the choice.
     */
    public function build(): ChoiceInterface;
}