ConnectionRegistry.php in Plug 7

Namespace

Doctrine\Common\Persistence

File

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

<?php

/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license. For more information, see
 * <http://www.doctrine-project.org>.
 */
namespace Doctrine\Common\Persistence;


/**
 * Contract covering connection 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]>
 */
interface ConnectionRegistry {

  /**
   * Gets the default connection name.
   *
   * @return string The default connection name.
   */
  public function getDefaultConnectionName();

  /**
   * Gets the named connection.
   *
   * @param string $name The connection name (null for the default one).
   *
   * @return object
   */
  public function getConnection($name = null);

  /**
   * Gets an array of all registered connections.
   *
   * @return array An array of Connection instances.
   */
  public function getConnections();

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

}

Interfaces

Name	Description
ConnectionRegistry	Contract covering connection for a Doctrine persistence layer ManagerRegistry class to implement.