ConnectionRegistry.php 2.0 KB

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