vendor/doctrine/orm/lib/Doctrine/ORM/Mapping/SqlResultSetMapping.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  * The SqlResultSetMapping annotation is used to specify the mapping of the result of a native SQL query.
  24  * The SqlResultSetMapping annotation can be applied to an entity or mapped superclass.
  25  *
  26  * @author  Fabio B. Silva <fabio.bat.silva@gmail.com>
  27  * @since   2.3
  28  *
  29  * @Annotation
  30  * @Target("ANNOTATION")
  31  */
  32 final class SqlResultSetMapping implements Annotation
  33 {
  34
  35     /**
  36      * The name given to the result set mapping, and used to refer to it in the methods of the Query API.
  37      *
  38      * @var string
  39      */
  40     public $name;
  41
  42     /**
  43      * Specifies the result set mapping to entities.
  44      *
  45      * @var array<\Doctrine\ORM\Mapping\EntityResult>
  46      */
  47     public $entities = array();
  48
  49     /**
  50      * Specifies the result set mapping to scalar values.
  51      *
  52      * @var array<\Doctrine\ORM\Mapping\ColumnResult>
  53      */
  54     public $columns = array();
  55
  56 }