annotate vendor/symfony/validator/Constraints/Collection.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents af1871eacc83
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /*
Chris@0 4 * This file is part of the Symfony package.
Chris@0 5 *
Chris@0 6 * (c) Fabien Potencier <fabien@symfony.com>
Chris@0 7 *
Chris@0 8 * For the full copyright and license information, please view the LICENSE
Chris@0 9 * file that was distributed with this source code.
Chris@0 10 */
Chris@0 11
Chris@0 12 namespace Symfony\Component\Validator\Constraints;
Chris@0 13
Chris@0 14 use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
Chris@0 15
Chris@0 16 /**
Chris@0 17 * @Annotation
Chris@0 18 * @Target({"PROPERTY", "METHOD", "ANNOTATION"})
Chris@0 19 *
Chris@0 20 * @author Bernhard Schussek <bschussek@gmail.com>
Chris@0 21 */
Chris@0 22 class Collection extends Composite
Chris@0 23 {
Chris@0 24 const MISSING_FIELD_ERROR = '2fa2158c-2a7f-484b-98aa-975522539ff8';
Chris@0 25 const NO_SUCH_FIELD_ERROR = '7703c766-b5d5-4cef-ace7-ae0dd82304e9';
Chris@0 26
Chris@17 27 protected static $errorNames = [
Chris@0 28 self::MISSING_FIELD_ERROR => 'MISSING_FIELD_ERROR',
Chris@0 29 self::NO_SUCH_FIELD_ERROR => 'NO_SUCH_FIELD_ERROR',
Chris@17 30 ];
Chris@0 31
Chris@17 32 public $fields = [];
Chris@0 33 public $allowExtraFields = false;
Chris@0 34 public $allowMissingFields = false;
Chris@0 35 public $extraFieldsMessage = 'This field was not expected.';
Chris@0 36 public $missingFieldsMessage = 'This field is missing.';
Chris@0 37
Chris@0 38 /**
Chris@0 39 * {@inheritdoc}
Chris@0 40 */
Chris@0 41 public function __construct($options = null)
Chris@0 42 {
Chris@0 43 // no known options set? $options is the fields array
Chris@17 44 if (\is_array($options)
Chris@17 45 && !array_intersect(array_keys($options), ['groups', 'fields', 'allowExtraFields', 'allowMissingFields', 'extraFieldsMessage', 'missingFieldsMessage'])) {
Chris@17 46 $options = ['fields' => $options];
Chris@0 47 }
Chris@0 48
Chris@0 49 parent::__construct($options);
Chris@0 50 }
Chris@0 51
Chris@0 52 /**
Chris@0 53 * {@inheritdoc}
Chris@0 54 */
Chris@0 55 protected function initializeNestedConstraints()
Chris@0 56 {
Chris@0 57 parent::initializeNestedConstraints();
Chris@0 58
Chris@17 59 if (!\is_array($this->fields)) {
Chris@0 60 throw new ConstraintDefinitionException(sprintf('The option "fields" is expected to be an array in constraint %s', __CLASS__));
Chris@0 61 }
Chris@0 62
Chris@0 63 foreach ($this->fields as $fieldName => $field) {
Chris@0 64 // the XmlFileLoader and YamlFileLoader pass the field Optional
Chris@0 65 // and Required constraint as an array with exactly one element
Chris@17 66 if (\is_array($field) && 1 == \count($field)) {
Chris@0 67 $this->fields[$fieldName] = $field = $field[0];
Chris@0 68 }
Chris@0 69
Chris@0 70 if (!$field instanceof Optional && !$field instanceof Required) {
Chris@18 71 $this->fields[$fieldName] = new Required($field);
Chris@0 72 }
Chris@0 73 }
Chris@0 74 }
Chris@0 75
Chris@0 76 public function getRequiredOptions()
Chris@0 77 {
Chris@17 78 return ['fields'];
Chris@0 79 }
Chris@0 80
Chris@0 81 protected function getCompositeOption()
Chris@0 82 {
Chris@0 83 return 'fields';
Chris@0 84 }
Chris@0 85 }