GetterMetadata.php in Zircon Profile 8.0

Namespace

Symfony\Component\Validator\Mapping

File

vendor/symfony/validator/Mapping/GetterMetadata.php

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <[e-mail]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Symfony\Component\Validator\Mapping;

use Symfony\Component\Validator\Exception\ValidatorException;

/**
 * Stores all metadata needed for validating a class property via its getter
 * method.
 *
 * A property getter is any method that is equal to the property's name,
 * prefixed with either "get" or "is". That method will be used to access the
 * property's value.
 *
 * The getter will be invoked by reflection, so the access of private and
 * protected getters is supported.
 *
 * This class supports serialization and cloning.
 *
 * @author Bernhard Schussek <[e-mail]>
 *
 * @see PropertyMetadataInterface
 */
class GetterMetadata extends MemberMetadata {

  /**
   * Constructor.
   *
   * @param string $class    The class the getter is defined on
   * @param string $property The property which the getter returns
   *
   * @throws ValidatorException
   */
  public function __construct($class, $property) {
    $getMethod = 'get' . ucfirst($property);
    $isMethod = 'is' . ucfirst($property);
    $hasMethod = 'has' . ucfirst($property);
    if (method_exists($class, $getMethod)) {
      $method = $getMethod;
    }
    elseif (method_exists($class, $isMethod)) {
      $method = $isMethod;
    }
    elseif (method_exists($class, $hasMethod)) {
      $method = $hasMethod;
    }
    else {
      throw new ValidatorException(sprintf('Neither of these methods exist in class %s: %s, %s, %s', $class, $getMethod, $isMethod, $hasMethod));
    }
    parent::__construct($class, $method, $property);
  }

  /**
   * {@inheritdoc}
   */
  public function getPropertyValue($object) {
    return $this
      ->newReflectionMember($object)
      ->invoke($object);
  }

  /**
   * {@inheritdoc}
   */
  protected function newReflectionMember($objectOrClassName) {
    return new \ReflectionMethod($objectOrClassName, $this
      ->getName());
  }

}

Classes

Name	Description
GetterMetadata	Stores all metadata needed for validating a class property via its getter method.