vendor/doctrine/orm/lib/Doctrine/ORM/Query/Expr/From.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\ORM\Query\Expr;
  21
  22 /**
  23  * Expression class for DQL from
  24  *
  25  *
  26  * @link    www.doctrine-project.org
  27  * @since   2.0
  28  * @author  Guilherme Blanco <guilhermeblanco@hotmail.com>
  29  * @author  Jonathan Wage <jonwage@gmail.com>
  30  * @author  Roman Borschel <roman@code-factory.org>
  31  */
  32 class From
  33 {
  34     /**
  35      * @var string
  36      */
  37     protected $from;
  38
  39     /**
  40      * @var string
  41      */
  42     protected $alias;
  43
  44     /**
  45      * @var string
  46      */
  47     protected $indexBy;
  48
  49     /**
  50      * @param string $from      The class name.
  51      * @param string $alias     The alias of the class.
  52      * @param string $indexBy   The index for the from.
  53      */
  54     public function __construct($from, $alias, $indexBy = null)
  55     {
  56         $this->from    = $from;
  57         $this->alias   = $alias;
  58         $this->indexBy = $indexBy;
  59     }
  60
  61     /**
  62      * @return string
  63      */
  64     public function getFrom()
  65     {
  66         return $this->from;
  67     }
  68
  69     /**
  70      * @return string
  71      */
  72     public function getAlias()
  73     {
  74         return $this->alias;
  75     }
  76
  77     /**
  78      * @return string
  79      */
  80     public function getIndexBy()
  81     {
  82         return $this->indexBy;
  83     }
  84
  85     /**
  86      * @return string
  87      */
  88     public function __toString()
  89     {
  90         return $this->from . ' ' . $this->alias .
  91                 ($this->indexBy ? ' INDEX BY ' . $this->indexBy : '');
  92     }
  93 }