Chris@0: <?php
Chris@0: /*
Chris@0:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
Chris@0:  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
Chris@0:  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
Chris@0:  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
Chris@0:  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
Chris@0:  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
Chris@0:  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
Chris@0:  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
Chris@0:  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
Chris@0:  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Chris@0:  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Chris@0:  *
Chris@0:  * This software consists of voluntary contributions made by many individuals
Chris@0:  * and is licensed under the MIT license. For more information, see
Chris@0:  * <http://www.doctrine-project.org>.
Chris@0:  */
Chris@0: 
Chris@0: namespace Doctrine\Common\Persistence;
Chris@0: 
Chris@0: /**
Chris@0:  * Contract covering connection for a Doctrine persistence layer ManagerRegistry class to implement.
Chris@0:  *
Chris@0:  * @link   www.doctrine-project.org
Chris@0:  * @since  2.2
Chris@0:  * @author Fabien Potencier <fabien@symfony.com>
Chris@0:  * @author Benjamin Eberlei <kontakt@beberlei.de>
Chris@0:  * @author Lukas Kahwe Smith <smith@pooteeweet.org>
Chris@0:  */
Chris@0: interface ConnectionRegistry
Chris@0: {
Chris@0:     /**
Chris@0:      * Gets the default connection name.
Chris@0:      *
Chris@0:      * @return string The default connection name.
Chris@0:      */
Chris@0:     public function getDefaultConnectionName();
Chris@0: 
Chris@0:     /**
Chris@0:      * Gets the named connection.
Chris@0:      *
Chris@0:      * @param string $name The connection name (null for the default one).
Chris@0:      *
Chris@0:      * @return object
Chris@0:      */
Chris@0:     public function getConnection($name = null);
Chris@0: 
Chris@0:     /**
Chris@0:      * Gets an array of all registered connections.
Chris@0:      *
Chris@0:      * @return array An array of Connection instances.
Chris@0:      */
Chris@0:     public function getConnections();
Chris@0: 
Chris@0:     /**
Chris@0:      * Gets all connection names.
Chris@0:      *
Chris@0:      * @return array An array of connection names.
Chris@0:      */
Chris@0:     public function getConnectionNames();
Chris@0: }