You are here

class Uuid in Plug 7

@author Colin O'Dell <colinodell@gmail.com> @author Bernhard Schussek <bschussek@gmail.com>

Hierarchy

  • class \Symfony\Component\Validator\Constraint
    • class \Symfony\Component\Validator\Constraints\Uuid

Expanded class hierarchy of Uuid

1 file declares its use of Uuid
UuidValidatorTest.php in lib/Symfony/validator/Symfony/Component/Validator/Tests/Constraints/UuidValidatorTest.php

File

lib/Symfony/validator/Symfony/Component/Validator/Constraints/Uuid.php, line 22

Namespace

Symfony\Component\Validator\Constraints
View source
class Uuid extends Constraint {
  const TOO_SHORT_ERROR = 1;
  const TOO_LONG_ERROR = 2;
  const INVALID_CHARACTERS_ERROR = 3;
  const INVALID_HYPHEN_PLACEMENT_ERROR = 4;
  const INVALID_VERSION_ERROR = 5;
  const INVALID_VARIANT_ERROR = 6;
  protected static $errorNames = array(
    self::TOO_SHORT_ERROR => 'TOO_SHORT_ERROR',
    self::TOO_LONG_ERROR => 'TOO_LONG_ERROR',
    self::INVALID_CHARACTERS_ERROR => 'INVALID_CHARACTERS_ERROR',
    self::INVALID_HYPHEN_PLACEMENT_ERROR => 'INVALID_HYPHEN_PLACEMENT_ERROR',
    self::INVALID_VERSION_ERROR => 'INVALID_VERSION_ERROR',
    self::INVALID_VARIANT_ERROR => 'INVALID_VARIANT_ERROR',
  );

  // Possible versions defined by RFC 4122
  const V1_MAC = 1;
  const V2_DCE = 2;
  const V3_MD5 = 3;
  const V4_RANDOM = 4;
  const V5_SHA1 = 5;

  /**
   * Message to display when validation fails
   *
   * @var string
   */
  public $message = 'This is not a valid UUID.';

  /**
   * Strict mode only allows UUIDs that meet the formal definition and formatting per RFC 4122
   *
   * Set this to `false` to allow legacy formats with different dash positioning or wrapping characters
   *
   * @var bool
   */
  public $strict = true;

  /**
   * Array of allowed versions (see version constants above)
   *
   * All UUID versions are allowed by default
   *
   * @var int[]
   */
  public $versions = array(
    self::V1_MAC,
    self::V2_DCE,
    self::V3_MD5,
    self::V4_RANDOM,
    self::V5_SHA1,
  );

}

Members

Namesort descending Modifiers Type Description Overrides
Constraint::$payload public property Domain-specific data attached to a constraint
Constraint::addImplicitGroupName public function Adds the given group if this constraint is in the Default group. 1
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::getRequiredOptions public function Returns the name of the required options. 7
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::__construct public function Initializes the constraint with options. 10
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.
Uuid::$errorNames protected static property Maps error codes to the names of their constants Overrides Constraint::$errorNames
Uuid::$message public property Message to display when validation fails
Uuid::$strict public property Strict mode only allows UUIDs that meet the formal definition and formatting per RFC 4122
Uuid::$versions public property Array of allowed versions (see version constants above)
Uuid::INVALID_CHARACTERS_ERROR constant
Uuid::INVALID_HYPHEN_PLACEMENT_ERROR constant
Uuid::INVALID_VARIANT_ERROR constant
Uuid::INVALID_VERSION_ERROR constant
Uuid::TOO_LONG_ERROR constant
Uuid::TOO_SHORT_ERROR constant
Uuid::V1_MAC constant
Uuid::V2_DCE constant
Uuid::V3_MD5 constant
Uuid::V4_RANDOM constant
Uuid::V5_SHA1 constant