1<?php
2/*
3 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14 *
15 * This software consists of voluntary contributions made by many individuals
16 * and is licensed under the MIT license. For more information, see
17 * <http://www.doctrine-project.org>.
18 */
19
20namespace Doctrine\Common\Persistence;
21
22/**
23 * Contract covering connection for a Doctrine persistence layer ManagerRegistry class to implement.
24 *
25 * @link   www.doctrine-project.org
26 * @since  2.2
27 * @author Fabien Potencier <fabien@symfony.com>
28 * @author Benjamin Eberlei <kontakt@beberlei.de>
29 * @author Lukas Kahwe Smith <smith@pooteeweet.org>
30 */
31interface ConnectionRegistry
32{
33    /**
34     * Gets the default connection name.
35     *
36     * @return string The default connection name.
37     */
38    public function getDefaultConnectionName();
39
40    /**
41     * Gets the named connection.
42     *
43     * @param string $name The connection name (null for the default one).
44     *
45     * @return object
46     */
47    public function getConnection($name = null);
48
49    /**
50     * Gets an array of all registered connections.
51     *
52     * @return array An array of Connection instances.
53     */
54    public function getConnections();
55
56    /**
57     * Gets all connection names.
58     *
59     * @return array An array of connection names.
60     */
61    public function getConnectionNames();
62}
63