Documentation

AbstractManagerRegistry
in package

Application

implements ManagerRegistry

Abstract implementation of the ManagerRegistry contract.

Interfaces, Classes and Traits

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

$connections : array<string|int, mixed>
$defaultConnection : string
$defaultManager : string
$managers : array<string|int, mixed>
$name : string
$proxyInterfaceName : string
__construct() : mixed: Constructor.
getConnection() : mixed: {@inheritdoc}
getConnectionNames() : mixed: {@inheritdoc}
getConnections() : mixed: {@inheritdoc}
getDefaultConnectionName() : mixed: {@inheritdoc}
getDefaultManagerName() : string: Gets the default object manager name.
getManager() : ObjectManager: Gets a named object manager.
getManagerForClass() : ObjectManager|null: Gets the object manager associated with a given class.
getManagerNames() : array<string|int, mixed>: Gets all connection names.
getManagers() : array<string|int, ObjectManager>: Gets an array of all registered object managers.
getName() : string: Gets the name of the registry.
getRepository() : ObjectRepository: Gets the ObjectRepository for an persistent object.
resetManager() : ObjectManager: Resets a named object manager.
getService() : object: Fetches/creates the given services.
resetService() : void: Resets the given services.

$connections


    private
        array<string|int, mixed>
    $connections

$defaultConnection


    private
        string
    $defaultConnection

$defaultManager


    private
        string
    $defaultManager

$managers


    private
        array<string|int, mixed>
    $managers

$name


    private
        string
    $name

$proxyInterfaceName


    private
        string
    $proxyInterfaceName

__construct()

Constructor.


    public
                __construct(string $name, array<string|int, mixed> $connections, array<string|int, mixed> $managers, string $defaultConnection, string $defaultManager, string $proxyInterfaceName) : mixed

Parameters

$name : string
$connections : array<string|int, mixed>
$managers : array<string|int, mixed>
$defaultConnection : string
$defaultManager : string
$proxyInterfaceName : string

Return values

mixed —

getConnection()

{@inheritdoc}


    public
                getConnection([mixed $name = null ]) : mixed

Parameters

$name : mixed = null

Return values

mixed —

getConnectionNames()

{@inheritdoc}


    public
                getConnectionNames() : mixed

Return values

mixed —

getConnections()

{@inheritdoc}


    public
                getConnections() : mixed

Return values

mixed —

getDefaultConnectionName()

{@inheritdoc}


    public
                getDefaultConnectionName() : mixed

Return values

mixed —

getDefaultManagerName()

Gets the default object manager name.


    public
                getDefaultManagerName() : string

Return values

string —

The default object manager name.

getManager()

Gets a named object manager.


    public
                getManager([mixed $name = null ]) : ObjectManager

Parameters

$name : mixed = null: The object manager name (null for the default one).

Return values

ObjectManager —

getManagerForClass()

Gets the object manager associated with a given class.


    public
                getManagerForClass(mixed $class) : ObjectManager|null

Parameters

$class : mixed: A persistent object class name.

Return values

ObjectManager|null —

getManagerNames()

Gets all connection names.


    public
                getManagerNames() : array<string|int, mixed>

Return values

array<string|int, mixed> —

An array of connection names.

getManagers()

Gets an array of all registered object managers.


    public
                getManagers() : array<string|int, ObjectManager>

Return values

array<string|int, ObjectManager> —

An array of ObjectManager instances

getName()

Gets the name of the registry.


    public
                getName() : string

Return values

string —

getRepository()

Gets the ObjectRepository for an persistent object.


    public
                getRepository(mixed $persistentObjectName[, mixed $persistentManagerName = null ]) : ObjectRepository

Parameters

$persistentObjectName : mixed
$persistentManagerName : mixed = null: The object manager name (null for the default one).

Return values

ObjectRepository —

resetManager()

Resets a named object manager.


    public
                resetManager([mixed $name = null ]) : ObjectManager

Parameters

$name : mixed = null: The object manager name (null for the default one).

Return values

ObjectManager —

getService()

Fetches/creates the given services.


    protected
    abstract            getService(string $name) : object

A service in this context is connection or a manager instance.

Parameters

$name : string: The name of the service.

Return values

object —

The instance of the given service.

resetService()

Resets the given services.


    protected
    abstract            resetService(string $name) : void

A service in this context is connection or a manager instance.

Parameters

$name : string: The name of the service.

Return values

void —