interface ManagerRegistry in Plug 7

Contract covering object managers for a Doctrine persistence layer ManagerRegistry class to implement.

@link www.doctrine-project.org @since 2.2 @author Fabien Potencier <[e-mail]> @author Benjamin Eberlei <[e-mail]> @author Lukas Kahwe Smith <[e-mail]>

Hierarchy

• interface \Doctrine\Common\Persistence\ConnectionRegistry
  • interface \Doctrine\Common\Persistence\ManagerRegistry

File

lib/doctrine/common/lib/Doctrine/Common/Persistence/ManagerRegistry.php, line 31

Namespace

Doctrine\Common\Persistence

interface ManagerRegistry extends ConnectionRegistry {

  /**
   * Gets the default object manager name.
   *
   * @return string The default object manager name.
   */
  public function getDefaultManagerName();

  /**
   * Gets a named object manager.
   *
   * @param string $name The object manager name (null for the default one).
   *
   * @return \Doctrine\Common\Persistence\ObjectManager
   */
  public function getManager($name = null);

  /**
   * Gets an array of all registered object managers.
   *
   * @return \Doctrine\Common\Persistence\ObjectManager[] An array of ObjectManager instances
   */
  public function getManagers();

  /**
   * Resets a named object manager.
   *
   * This method is useful when an object manager has been closed
   * because of a rollbacked transaction AND when you think that
   * it makes sense to get a new one to replace the closed one.
   *
   * Be warned that you will get a brand new object manager as
   * the existing one is not useable anymore. This means that any
   * other object with a dependency on this object manager will
   * hold an obsolete reference. You can inject the registry instead
   * to avoid this problem.
   *
   * @param string|null $name The object manager name (null for the default one).
   *
   * @return \Doctrine\Common\Persistence\ObjectManager
   */
  public function resetManager($name = null);

  /**
   * Resolves a registered namespace alias to the full namespace.
   *
   * This method looks for the alias in all registered object managers.
   *
   * @param string $alias The alias.
   *
   * @return string The full namespace.
   */
  public function getAliasNamespace($alias);

  /**
   * Gets all connection names.
   *
   * @return array An array of connection names.
   */
  public function getManagerNames();

  /**
   * Gets the ObjectRepository for an persistent object.
   *
   * @param string $persistentObject      The name of the persistent object.
   * @param string $persistentManagerName The object manager name (null for the default one).
   *
   * @return \Doctrine\Common\Persistence\ObjectRepository
   */
  public function getRepository($persistentObject, $persistentManagerName = null);

  /**
   * Gets the object manager associated with a given class.
   *
   * @param string $class A persistent object class name.
   *
   * @return \Doctrine\Common\Persistence\ObjectManager|null
   */
  public function getManagerForClass($class);

}

Members

Name	Modifiers	Type	Description	Overrides
ConnectionRegistry::getConnection	public	function	Gets the named connection.	1
ConnectionRegistry::getConnectionNames	public	function	Gets all connection names.	1
ConnectionRegistry::getConnections	public	function	Gets an array of all registered connections.	1
ConnectionRegistry::getDefaultConnectionName	public	function	Gets the default connection name.	1
ManagerRegistry::getAliasNamespace	public	function	Resolves a registered namespace alias to the full namespace.	1
ManagerRegistry::getDefaultManagerName	public	function	Gets the default object manager name.	1
ManagerRegistry::getManager	public	function	Gets a named object manager.	1
ManagerRegistry::getManagerForClass	public	function	Gets the object manager associated with a given class.	1
ManagerRegistry::getManagerNames	public	function	Gets all connection names.	1
ManagerRegistry::getManagers	public	function	Gets an array of all registered object managers.	1
ManagerRegistry::getRepository	public	function	Gets the ObjectRepository for an persistent object.	1
ManagerRegistry::resetManager	public	function	Resets a named object manager.	1