Collection.php

Namespace

Symfony\Component\Validator\Constraints

File

drupal/core/vendor/symfony/validator/Symfony/Component/Validator/Constraints/Collection.php
View source
<?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\Validator\Constraints;

use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\Constraints\Required;
use Symfony\Component\Validator\Constraints\Optional;
use Symfony\Component\Validator\Exception\ConstraintDefinitionException;

/**
 * @Annotation
 *
 * @author Bernhard Schussek <bschussek@gmail.com>
 *
 * @api
 */
class Collection extends Constraint {
  public $fields;
  public $allowExtraFields = false;
  public $allowMissingFields = false;
  public $extraFieldsMessage = 'This field was not expected.';
  public $missingFieldsMessage = 'This field is missing.';

  /**
   * {@inheritDoc}
   */
  public function __construct($options = null) {

    // no known options set? $options is the fields array
    if (is_array($options) && !array_intersect(array_keys($options), array(
      'groups',
      'fields',
      'allowExtraFields',
      'allowMissingFields',
      'extraFieldsMessage',
      'missingFieldsMessage',
    ))) {
      $options = array(
        'fields' => $options,
      );
    }
    parent::__construct($options);
    if (!is_array($this->fields)) {
      throw new ConstraintDefinitionException(sprintf('The option "fields" is expected to be an array in constraint %s', __CLASS__));
    }
    foreach ($this->fields as $fieldName => $field) {
      if (!$field instanceof Optional && !$field instanceof Required) {
        $this->fields[$fieldName] = $field = new Required($field);
      }
      if (!is_array($field->constraints)) {
        $field->constraints = array(
          $field->constraints,
        );
      }
      foreach ($field->constraints as $constraint) {
        if (!$constraint instanceof Constraint) {
          throw new ConstraintDefinitionException(sprintf('The value %s of the field %s is not an instance of Constraint in constraint %s', $constraint, $fieldName, __CLASS__));
        }
        if ($constraint instanceof Valid) {
          throw new ConstraintDefinitionException(sprintf('The constraint Valid cannot be nested inside constraint %s. You can only declare the Valid constraint directly on a field or method.', __CLASS__));
        }
      }
    }
  }
  public function getRequiredOptions() {
    return array(
      'fields',
    );
  }

}

Classes

Namesort descending Description
Collection @author Bernhard Schussek <bschussek@gmail.com>