Doctrine\ODM\CouchDB\Proxy\ProxyFactory

Size/Duplication

Total Lines	46
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
	generateProxyClasses()	0	1	?
	getProxy()	0	1	?

<?php

declare(strict_types=1);

namespace Doctrine\ODM\CouchDB\Proxy;

use Doctrine\ODM\CouchDB\Mapping\ClassMetadata;
use ProxyManager\Proxy\GhostObjectInterface;

interface ProxyFactory
{
	/**
	 * Never autogenerate a proxy and rely that it was generated by some
	 * process before deployment.
	 */
	public const AUTOGENERATE_NEVER = 0;
	/**
	 * Always generates a new proxy in every request.
	 *
	 * This is only sane during development.
	 */
	public const AUTOGENERATE_ALWAYS = 1;
	/**
	 * Autogenerate the proxy class when the proxy file does not exist.
	 *
	 * This strategy causes a file exists call whenever any proxy is used the
	 * first time in a request.
	 */
	public const AUTOGENERATE_FILE_NOT_EXISTS = 2;
	/**
	 * Generate the proxy classes using eval().
	 *
	 * This strategy is only sane for development, and even then it gives me
	 * the creeps a little.
	 */
	public const AUTOGENERATE_EVAL = 3;

	/**
	 * @param ClassMetadata[] $classes
	 *
	 * @return int
	 */
	public function generateProxyClasses(array $classes) : int;

	/**
	 * Gets a reference proxy instance for the entity of the given type and identified by
	 * the given identifier.
	 *
	 * @param ClassMetadata $metadata
	 * @param string $identifier
	 *
	 * @return GhostObjectInterface
	 */
	public function getProxy(ClassMetadata $metadata, string $identifier) : GhostObjectInterface;
}