EntityResult.php 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  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. * References an entity in the SELECT clause of a SQL query.
  22. * If this annotation is used, the SQL statement should select all of the columns that are mapped to the entity object.
  23. * This should include foreign key columns to related entities.
  24. * The results obtained when insufficient data is available are undefined.
  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 EntityResult implements Annotation
  33. {
  34. /**
  35. * The class of the result
  36. *
  37. * @var string
  38. */
  39. public $entityClass;
  40. /**
  41. * Maps the columns specified in the SELECT list of the query to the properties or fields of the entity class.
  42. *
  43. * @var array<\Doctrine\ORM\Mapping\FieldResult>
  44. */
  45. public $fields = array();
  46. /**
  47. * Specifies the column name of the column in the SELECT list that is used to determine the type of the entity instance.
  48. *
  49. * @var string
  50. */
  51. public $discriminatorColumn;
  52. }