SqlResultSetMapping.php 1.9 KB

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