vendor/doctrine/dbal/lib/Doctrine/DBAL/Tools/Console/Helper/ConnectionHelper.php

   1 <?php
   2 /*
   3  *  $Id$
   4  *
   5  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   6  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   7  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   8  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   9  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  10  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  11  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  12  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  13  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  14  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  15  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  16  *
  17  * This software consists of voluntary contributions made by many individuals
  18  * and is licensed under the MIT license. For more information, see
  19  * <http://www.doctrine-project.org>.
  20  */
  21
  22 namespace Doctrine\DBAL\Tools\Console\Helper;
  23
  24 use Symfony\Component\Console\Helper\Helper,
  25     Doctrine\DBAL\Connection;
  26
  27 /**
  28  * Doctrine CLI Connection Helper.
  29  *
  30  *
  31  * @link    www.doctrine-project.org
  32  * @since   2.0
  33  * @version $Revision$
  34  * @author  Benjamin Eberlei <kontakt@beberlei.de>
  35  * @author  Guilherme Blanco <guilhermeblanco@hotmail.com>
  36  * @author  Jonathan Wage <jonwage@gmail.com>
  37  * @author  Roman Borschel <roman@code-factory.org>
  38  */
  39 class ConnectionHelper extends Helper
  40 {
  41     /**
  42      * Doctrine Database Connection
  43      * @var Connection
  44      */
  45     protected $_connection;
  46
  47     /**
  48      * Constructor
  49      *
  50      * @param Connection $connection Doctrine Database Connection
  51      */
  52     public function __construct(Connection $connection)
  53     {
  54         $this->_connection = $connection;
  55     }
  56
  57     /**
  58      * Retrieves Doctrine Database Connection
  59      *
  60      * @return Connection
  61      */
  62     public function getConnection()
  63     {
  64         return $this->_connection;
  65     }
  66
  67     /**
  68      * @see Helper
  69      */
  70     public function getName()
  71     {
  72         return 'connection';
  73     }
  74 }