You are here

class ClassMetadataFactory in Zircon Profile 8

Same name in this branch
  1. 8 vendor/symfony/validator/Mapping/ClassMetadataFactory.php \Symfony\Component\Validator\Mapping\ClassMetadataFactory
  2. 8 vendor/symfony/serializer/Mapping/Factory/ClassMetadataFactory.php \Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory
Same name and namespace in other branches
  1. 8.0 vendor/symfony/serializer/Mapping/Factory/ClassMetadataFactory.php \Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory

Returns a {@link ClassMetadata}.

@author Kévin Dunglas <dunglas@gmail.com>

Hierarchy

Expanded class hierarchy of ClassMetadataFactory

4 files declare their use of ClassMetadataFactory
ClassMetadataFactoryTest.php in vendor/symfony/serializer/Tests/Mapping/Factory/ClassMetadataFactoryTest.php
GetSetMethodNormalizerTest.php in vendor/symfony/serializer/Tests/Normalizer/GetSetMethodNormalizerTest.php
ObjectNormalizerTest.php in vendor/symfony/serializer/Tests/Normalizer/ObjectNormalizerTest.php
PropertyNormalizerTest.php in vendor/symfony/serializer/Tests/Normalizer/PropertyNormalizerTest.php

File

vendor/symfony/serializer/Mapping/Factory/ClassMetadataFactory.php, line 24

Namespace

Symfony\Component\Serializer\Mapping\Factory
View source
class ClassMetadataFactory implements ClassMetadataFactoryInterface {

  /**
   * @var LoaderInterface
   */
  private $loader;

  /**
   * @var Cache
   */
  private $cache;

  /**
   * @var array
   */
  private $loadedClasses;

  /**
   * @param LoaderInterface $loader
   * @param Cache|null      $cache
   */
  public function __construct(LoaderInterface $loader, Cache $cache = null) {
    $this->loader = $loader;
    $this->cache = $cache;
  }

  /**
   * {@inheritdoc}
   */
  public function getMetadataFor($value) {
    $class = $this
      ->getClass($value);
    if (!$class) {
      throw new InvalidArgumentException(sprintf('Cannot create metadata for non-objects. Got: "%s"', gettype($value)));
    }
    if (isset($this->loadedClasses[$class])) {
      return $this->loadedClasses[$class];
    }
    if ($this->cache && ($this->loadedClasses[$class] = $this->cache
      ->fetch($class))) {
      return $this->loadedClasses[$class];
    }
    if (!class_exists($class) && !interface_exists($class)) {
      throw new InvalidArgumentException(sprintf('The class or interface "%s" does not exist.', $class));
    }
    $classMetadata = new ClassMetadata($class);
    $this->loader
      ->loadClassMetadata($classMetadata);
    $reflectionClass = $classMetadata
      ->getReflectionClass();

    // Include metadata from the parent class
    if ($parent = $reflectionClass
      ->getParentClass()) {
      $classMetadata
        ->merge($this
        ->getMetadataFor($parent->name));
    }

    // Include metadata from all implemented interfaces
    foreach ($reflectionClass
      ->getInterfaces() as $interface) {
      $classMetadata
        ->merge($this
        ->getMetadataFor($interface->name));
    }
    if ($this->cache) {
      $this->cache
        ->save($class, $classMetadata);
    }
    return $this->loadedClasses[$class] = $classMetadata;
  }

  /**
   * {@inheritdoc}
   */
  public function hasMetadataFor($value) {
    $class = $this
      ->getClass($value);
    return class_exists($class) || interface_exists($class);
  }

  /**
   * Gets a class name for a given class or instance.
   *
   * @param mixed $value
   *
   * @return string|bool
   */
  private function getClass($value) {
    if (!is_object($value) && !is_string($value)) {
      return false;
    }
    return ltrim(is_object($value) ? get_class($value) : $value, '\\');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ClassMetadataFactory::$cache private property
ClassMetadataFactory::$loadedClasses private property
ClassMetadataFactory::$loader private property
ClassMetadataFactory::getClass private function Gets a class name for a given class or instance.
ClassMetadataFactory::getMetadataFor public function If the method was called with the same class name (or an object of that class) before, the same metadata instance is returned. Overrides ClassMetadataFactoryInterface::getMetadataFor
ClassMetadataFactory::hasMetadataFor public function Checks if class has metadata. Overrides ClassMetadataFactoryInterface::hasMetadataFor
ClassMetadataFactory::__construct public function