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

Open in your IDE?
  1. <?php
  3. /*
  4.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  5.  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  6.  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  7.  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  8.  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  9.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  10.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  11.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  12.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  13.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  14.  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  15.  *
  16.  * This software consists of voluntary contributions made by many individuals
  17.  * and is licensed under the MIT license. For more information, see
  18.  * <http://www.doctrine-project.org>.
  19.  */
  21. namespace Doctrine\ORM\Query\Expr;
  23. /**
  24.  * Expression class for DQL from.
  25.  *
  26.  * @link    www.doctrine-project.org
  27.  */
  28. class From
  29. {
  30.     /** @var string */
  31.     protected $from;
  33.     /** @var string */
  34.     protected $alias;
  36.     /** @var string */
  37.     protected $indexBy;
  39.     /**
  40.      * @param string $from    The class name.
  41.      * @param string $alias   The alias of the class.
  42.      * @param string $indexBy The index for the from.
  43.      */
  44.     public function __construct($from, $alias, $indexBy = null)
  45.     {
  46.         $this->from    = $from;
  47.         $this->alias   = $alias;
  48.         $this->indexBy = $indexBy;
  49.     }
  51.     /**
  52.      * @return string
  53.      */
  54.     public function getFrom()
  55.     {
  56.         return $this->from;
  57.     }
  59.     /**
  60.      * @return string
  61.      */
  62.     public function getAlias()
  63.     {
  64.         return $this->alias;
  65.     }
  67.     /**
  68.      * @return string
  69.      */
  70.     public function getIndexBy()
  71.     {
  72.         return $this->indexBy;
  73.     }
  75.     /**
  76.      * @return string
  77.      */
  78.     public function __toString()
  79.     {
  80.         return $this->from . ' ' . $this->alias .
  81.                 ($this->indexBy ? ' INDEX BY ' . $this->indexBy : '');
  82.     }
  83. }