vendor/doctrine/orm/lib/Doctrine/ORM/Query/Expr/From.php line 31

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