vendor/doctrine/couchdb/lib/Doctrine/CouchDB/Tools/Console/Helper/CouchDBHelper.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\CouchDB\Tools\Console\Helper;
  21
  22 use Symfony\Component\Console\Helper\Helper;
  23 use Doctrine\CouchDB\CouchDBClient;
  24 use Doctrine\ODM\CouchDB\DocumentManager;
  25
  26 /**
  27  * Doctrine CLI Connection Helper.
  28  *
  29  * @license http://www.opensource.org/licenses/mit-license.php MIT
  30  * @link    www.doctrine-project.org
  31  * @since   2.0
  32  * @author  Benjamin Eberlei <kontakt@beberlei.de>
  33  */
  34 class CouchDBHelper extends Helper
  35 {
  36     protected $couchDBClient;
  37
  38     /**
  39      * @var DocumentManager
  40      */
  41     protected $dm;
  42
  43     /**
  44      * Constructor
  45      *
  46      * @param CouchDBClient $couchDBClient
  47      * @param DocumentManager $dm
  48      */
  49     public function __construct(CouchDBClient $couchDBClient = null, DocumentManager $dm = null)
  50     {
  51         if (!$couchDBClient && $dm) {
  52             $couchDBClient = $dm->getCouchDBClient();
  53         }
  54
  55         $this->couchDBClient = $couchDBClient;
  56         $this->dm = $dm;
  57     }
  58
  59     /**
  60      * Retrieves Doctrine ODM CouchDB Manager
  61      *
  62      * @return \Doctrine\ODM\CouchDB\DocumentManager
  63      */
  64     public function getDocumentManager()
  65     {
  66         return $this->dm;
  67     }
  68
  69     /**
  70      * @return CouchDBClient
  71      */
  72     public function getCouchDBClient()
  73     {
  74         return $this->couchDBClient;
  75     }
  76
  77     /**
  78      * @see Helper
  79      */
  80     public function getName()
  81     {
  82         return 'couchdb';
  83     }
  84 }