ClassMetadataFactoryInterface.php in Zircon Profile 8

Namespace

Symfony\Component\Serializer\Mapping\Factory

File

vendor/symfony/serializer/Mapping/Factory/ClassMetadataFactoryInterface.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\Serializer\Mapping\Factory;

use Symfony\Component\Serializer\Exception\InvalidArgumentException;
use Symfony\Component\Serializer\Mapping\ClassMetadataInterface;

/**
 * Returns a {@see ClassMetadataInterface}.
 *
 * @author Kévin Dunglas <[e-mail]>
 */
interface ClassMetadataFactoryInterface {

  /**
   * If the method was called with the same class name (or an object of that
   * class) before, the same metadata instance is returned.
   *
   * If the factory was configured with a cache, this method will first look
   * for an existing metadata instance in the cache. If an existing instance
   * is found, it will be returned without further ado.
   *
   * Otherwise, a new metadata instance is created. If the factory was
   * configured with a loader, the metadata is passed to the
   * {@link \Symfony\Component\Serializer\Mapping\Loader\LoaderInterface::loadClassMetadata()} method for further
   * configuration. At last, the new object is returned.
   *
   * @param string|object $value
   *
   * @return ClassMetadataInterface
   *
   * @throws InvalidArgumentException
   */
  public function getMetadataFor($value);

  /**
   * Checks if class has metadata.
   *
   * @param mixed $value
   *
   * @return bool
   */
  public function hasMetadataFor($value);

}

Interfaces

Name	Description
ClassMetadataFactoryInterface	Returns a { @author Kévin Dunglas <[e-mail]>