ConnectionRegistry.php 2.1 KB

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