vendor/doctrine/orm/lib/Doctrine/ORM/Mapping/EntityResult.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\Mapping;
  21
  22 /**
  23  * References an entity in the SELECT clause of a SQL query.
  24  * If this annotation is used, the SQL statement should select all of the columns that are mapped to the entity object.
  25  * This should include foreign key columns to related entities.
  26  * The results obtained when insufficient data is available are undefined.
  27  *
  28  * @author  Fabio B. Silva <fabio.bat.silva@gmail.com>
  29  * @since   2.3
  30  *
  31  * @Annotation
  32  * @Target("ANNOTATION")
  33  */
  34 final class EntityResult implements Annotation
  35 {
  36
  37     /**
  38      * The class of the result
  39      *
  40      * @var string
  41      */
  42     public $entityClass;
  43
  44     /**
  45      * Maps the columns specified in the SELECT list of the query to the properties or fields of the entity class.
  46      *
  47      * @var array<\Doctrine\ORM\Mapping\FieldResult>
  48      */
  49     public $fields = array();
  50
  51     /**
  52      * Specifies the column name of the column in the SELECT list that is used to determine the type of the entity instance.
  53      *
  54      * @var string
  55      */
  56     public $discriminatorColumn;
  57
  58 }