1 files changed, 149 insertions, 0 deletions

diff --git a/vendor/symfony/form/Symfony/Component/Form/Extension/Core/ChoiceList/ChoiceListInterface.php b/vendor/symfony/form/Symfony/Component/Form/Extension/Core/ChoiceList/ChoiceListInterface.php
new file mode 100644
index 00000000..099ace82
--- /dev/null
+++ b/vendor/symfony/form/Symfony/Component/Form/Extension/Core/ChoiceList/ChoiceListInterface.php
@@ -0,0 +1,149 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Form\Extension\Core\ChoiceList;
+
+/**
+ * Contains choices that can be selected in a form field.
+ *
+ * Each choice has three different properties:
+ *
+ *    - Choice: The choice that should be returned to the application by the
+ *              choice field. Can be any scalar value or an object, but no
+ *              array.
+ *    - Label:  A text representing the choice that is displayed to the user.
+ *    - Value:  A uniquely identifying value that can contain arbitrary
+ *              characters, but no arrays or objects. This value is displayed
+ *              in the HTML "value" attribute.
+ *
+ * @author Bernhard Schussek <bschussek@gmail.com>
+ */
+interface ChoiceListInterface
+{
+    /**
+     * Returns the list of choices
+     *
+     * @return array The choices with their indices as keys
+     */
+    public function getChoices();
+
+    /**
+     * Returns the values for the choices
+     *
+     * @return array The values with the corresponding choice indices as keys
+     */
+    public function getValues();
+
+    /**
+     * Returns the choice views of the preferred choices as nested array with
+     * the choice groups as top-level keys.
+     *
+     * Example:
+     *
+     * <source>
+     * array(
+     *     'Group 1' => array(
+     *         10 => ChoiceView object,
+     *         20 => ChoiceView object,
+     *     ),
+     *     'Group 2' => array(
+     *         30 => ChoiceView object,
+     *     ),
+     * )
+     * </source>
+     *
+     * @return array A nested array containing the views with the corresponding
+     *               choice indices as keys on the lowest levels and the choice
+     *               group names in the keys of the higher levels
+     */
+    public function getPreferredViews();
+
+    /**
+     * Returns the choice views of the choices that are not preferred as nested
+     * array with the choice groups as top-level keys.
+     *
+     * Example:
+     *
+     * <source>
+     * array(
+     *     'Group 1' => array(
+     *         10 => ChoiceView object,
+     *         20 => ChoiceView object,
+     *     ),
+     *     'Group 2' => array(
+     *         30 => ChoiceView object,
+     *     ),
+     * )
+     * </source>
+     *
+     * @return array A nested array containing the views with the corresponding
+     *               choice indices as keys on the lowest levels and the choice
+     *               group names in the keys of the higher levels
+     *
+     * @see getPreferredValues
+     */
+    public function getRemainingViews();
+
+    /**
+     * Returns the choices corresponding to the given values.
+     *
+     * The choices can have any data type.
+     *
+     * @param array $values An array of choice values. Not existing values in
+     *                      this array are ignored
+     *
+     * @return array An array of choices with ascending, 0-based numeric keys
+     */
+    public function getChoicesForValues(array $values);
+
+    /**
+     * Returns the values corresponding to the given choices.
+     *
+     * The values must be strings.
+     *
+     * @param array $choices An array of choices. Not existing choices in this
+     *                       array are ignored
+     *
+     * @return array An array of choice values with ascending, 0-based numeric
+     *               keys
+     */
+    public function getValuesForChoices(array $choices);
+
+    /**
+     * Returns the indices corresponding to the given choices.
+     *
+     * The indices must be positive integers or strings accepted by
+     * {@link FormConfigBuilder::validateName()}.
+     *
+     * The index "placeholder" is internally reserved.
+     *
+     * @param array $choices An array of choices. Not existing choices in this
+     *                       array are ignored
+     *
+     * @return array An array of indices with ascending, 0-based numeric keys
+     */
+    public function getIndicesForChoices(array $choices);
+
+    /**
+     * Returns the indices corresponding to the given values.
+     *
+     * The indices must be positive integers or strings accepted by
+     * {@link FormConfigBuilder::validateName()}.
+     *
+     * The index "placeholder" is internally reserved.
+     *
+     * @param array $values An array of choice values. Not existing values in
+     *                      this array are ignored
+     *
+     * @return array An array of indices with ascending, 0-based numeric keys
+     */
+    public function getIndicesForValues(array $values);
+}