class Collection in Plug 7

@Target({"PROPERTY", "METHOD", "ANNOTATION"})

@author Bernhard Schussek <[e-mail]>

@api

Hierarchy

• class \Symfony\Component\Validator\Constraint
  • class \Symfony\Component\Validator\Constraints\Composite
    • class \Symfony\Component\Validator\Constraints\Collection

6 files declare their use of Collection

AnnotationLoaderTest.php in lib/Symfony/validator/Symfony/Component/Validator/Tests/Mapping/Loader/AnnotationLoaderTest.php

CollectionTest.php in lib/Symfony/validator/Symfony/Component/Validator/Tests/Constraints/CollectionTest.php

CollectionValidatorTest.php in lib/Symfony/validator/Symfony/Component/Validator/Tests/Constraints/CollectionValidatorTest.php

LegacyExecutionContextTest.php in lib/Symfony/validator/Symfony/Component/Validator/Tests/LegacyExecutionContextTest.php

XmlFileLoaderTest.php in lib/Symfony/validator/Symfony/Component/Validator/Tests/Mapping/Loader/XmlFileLoaderTest.php

... See full list

File

lib/Symfony/validator/Symfony/Component/Validator/Constraints/Collection.php, line 24

Namespace

Symfony\Component\Validator\Constraints

class Collection extends Composite {
  const MISSING_FIELD_ERROR = 1;
  const NO_SUCH_FIELD_ERROR = 2;
  protected static $errorNames = array(
    self::MISSING_FIELD_ERROR => 'MISSING_FIELD_ERROR',
    self::NO_SUCH_FIELD_ERROR => 'NO_SUCH_FIELD_ERROR',
  );
  public $fields = array();
  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);
  }

  /**
   * {@inheritdoc}
   */
  protected function initializeNestedConstraints() {
    parent::initializeNestedConstraints();
    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) {

      // the XmlFileLoader and YamlFileLoader pass the field Optional
      // and Required constraint as an array with exactly one element
      if (is_array($field) && count($field) == 1) {
        $this->fields[$fieldName] = $field = $field[0];
      }
      if (!$field instanceof Optional && !$field instanceof Required) {
        $this->fields[$fieldName] = $field = new Required($field);
      }
    }
  }
  public function getRequiredOptions() {
    return array(
      'fields',
    );
  }
  protected function getCompositeOption() {
    return 'fields';
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Collection::$allowExtraFields	public	property
Collection::$allowMissingFields	public	property
Collection::$errorNames	protected static	property	Maps error codes to the names of their constants Overrides Constraint::$errorNames
Collection::$extraFieldsMessage	public	property
Collection::$fields	public	property
Collection::$missingFieldsMessage	public	property
Collection::getCompositeOption	protected	function	Returns the name of the property that contains the nested constraints. Overrides Composite::getCompositeOption
Collection::getRequiredOptions	public	function	Returns the name of the required options. Overrides Constraint::getRequiredOptions
Collection::initializeNestedConstraints	protected	function	Initializes the nested constraints. Overrides Composite::initializeNestedConstraints
Collection::MISSING_FIELD_ERROR		constant
Collection::NO_SUCH_FIELD_ERROR		constant
Collection::__construct	public	function	The groups of the composite and its nested constraints are made consistent using the following strategy: Overrides Composite::__construct
Composite::addImplicitGroupName	public	function	Implicit group names are forwarded to nested constraints. Overrides Constraint::addImplicitGroupName
Constraint::$payload	public	property	Domain-specific data attached to a constraint
Constraint::CLASS_CONSTRAINT		constant	Marks a constraint that can be put onto classes.
Constraint::DEFAULT_GROUP		constant	The name of the group given to all constraints with no explicit group.
Constraint::getDefaultOption	public	function	Returns the name of the default option.	15
Constraint::getErrorName	public static	function	Returns the name of the given error code.
Constraint::getTargets	public	function	Returns whether the constraint can be put onto classes, properties or both.	11
Constraint::PROPERTY_CONSTRAINT		constant	Marks a constraint that can be put onto properties.
Constraint::validatedBy	public	function	Returns the name of the class that validates this constraint.	1
Constraint::__get	public	function	Returns the value of a lazily initialized option.
Constraint::__set	public	function	Sets the value of a lazily initialized option.
Constraint::__sleep	public	function	Optimizes the serialized value to minimize storage space.