vendor/doctrine/common/lib/Doctrine/Common/Persistence/ConnectionRegistry.php

   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
  20 namespace Doctrine\Common\Persistence;
  21
  22 /**
  23  * Contract covering connection for a Doctrine persistence layer ManagerRegistry class to implement.
  24  *
  25  * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
  26  * @link    www.doctrine-project.org
  27  * @since   2.2
  28  * @author  Fabien Potencier <fabien@symfony.com>
  29  * @author  Benjamin Eberlei <kontakt@beberlei.de>
  30  * @author  Lukas Kahwe Smith <smith@pooteeweet.org>
  31  */
  32 interface ConnectionRegistry
  33 {
  34     /**
  35      * Gets the default connection name.
  36      *
  37      * @return string The default connection name
  38      */
  39     function getDefaultConnectionName();
  40
  41     /**
  42      * Gets the named connection.
  43      *
  44      * @param string $name The connection name (null for the default one)
  45      *
  46      * @return object
  47      */
  48     function getConnection($name = null);
  49
  50     /**
  51      * Gets an array of all registered connections
  52      *
  53      * @return array An array of Connection instances
  54      */
  55     function getConnections();
  56
  57     /**
  58      * Gets all connection names.
  59      *
  60      * @return array An array of connection names
  61      */
  62     function getConnectionNames();
  63 }