vendor/doctrine/orm/lib/Doctrine/ORM/Mapping/ClassMetadataInfo.php line 1210

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Doctrine\ORM\Mapping;
  7. use BackedEnum;
  8. use BadMethodCallException;
  9. use DateInterval;
  10. use DateTime;
  11. use DateTimeImmutable;
  12. use Doctrine\DBAL\Platforms\AbstractPlatform;
  13. use Doctrine\DBAL\Types\Type;
  14. use Doctrine\DBAL\Types\Types;
  15. use Doctrine\Deprecations\Deprecation;
  16. use Doctrine\Instantiator\Instantiator;
  17. use Doctrine\Instantiator\InstantiatorInterface;
  18. use Doctrine\ORM\Cache\Exception\NonCacheableEntityAssociation;
  19. use Doctrine\ORM\EntityRepository;
  20. use Doctrine\ORM\Id\AbstractIdGenerator;
  21. use Doctrine\Persistence\Mapping\ClassMetadata;
  22. use Doctrine\Persistence\Mapping\ReflectionService;
  23. use InvalidArgumentException;
  24. use LogicException;
  25. use ReflectionClass;
  26. use ReflectionEnum;
  27. use ReflectionNamedType;
  28. use ReflectionProperty;
  29. use RuntimeException;
  31. use function array_diff;
  32. use function array_flip;
  33. use function array_intersect;
  34. use function array_keys;
  35. use function array_map;
  36. use function array_merge;
  37. use function array_pop;
  38. use function array_values;
  39. use function assert;
  40. use function class_exists;
  41. use function count;
  42. use function enum_exists;
  43. use function explode;
  44. use function gettype;
  45. use function in_array;
  46. use function interface_exists;
  47. use function is_array;
  48. use function is_subclass_of;
  49. use function ltrim;
  50. use function method_exists;
  51. use function spl_object_id;
  52. use function str_contains;
  53. use function str_replace;
  54. use function strtolower;
  55. use function trait_exists;
  56. use function trim;
  58. use const PHP_VERSION_ID;
  60. /**
  61.  * A <tt>ClassMetadata</tt> instance holds all the object-relational mapping metadata
  62.  * of an entity and its associations.
  63.  *
  64.  * Once populated, ClassMetadata instances are usually cached in a serialized form.
  65.  *
  66.  * <b>IMPORTANT NOTE:</b>
  67.  *
  68.  * The fields of this class are only public for 2 reasons:
  69.  * 1) To allow fast READ access.
  70.  * 2) To drastically reduce the size of a serialized instance (private/protected members
  71.  *    get the whole class name, namespace inclusive, prepended to every property in
  72.  *    the serialized representation).
  73.  *
  74.  * @template-covariant T of object
  75.  * @template-implements ClassMetadata<T>
  76.  * @psalm-type FieldMapping = array{
  77.  *      type: string,
  78.  *      fieldName: string,
  79.  *      columnName: string,
  80.  *      length?: int,
  81.  *      id?: bool,
  82.  *      nullable?: bool,
  83.  *      notInsertable?: bool,
  84.  *      notUpdatable?: bool,
  85.  *      generated?: string,
  86.  *      enumType?: class-string<BackedEnum>,
  87.  *      columnDefinition?: string,
  88.  *      precision?: int,
  89.  *      scale?: int,
  90.  *      unique?: string,
  91.  *      inherited?: class-string,
  92.  *      originalClass?: class-string,
  93.  *      originalField?: string,
  94.  *      quoted?: bool,
  95.  *      requireSQLConversion?: bool,
  96.  *      declared?: class-string,
  97.  *      declaredField?: string,
  98.  *      options?: array<string, mixed>
  99.  * }
  100.  * @psalm-type JoinColumnData = array{
  101.  *     name: string,
  102.  *     referencedColumnName: string,
  103.  *     unique?: bool,
  104.  *     quoted?: bool,
  105.  *     fieldName?: string,
  106.  *     onDelete?: string,
  107.  *     columnDefinition?: string,
  108.  *     nullable?: bool,
  109.  * }
  110.  * @psalm-type AssociationMapping = array{
  111.  *     cache?: array,
  112.  *     cascade: array<string>,
  113.  *     declared?: class-string,
  114.  *     fetch: mixed,
  115.  *     fieldName: string,
  116.  *     id?: bool,
  117.  *     inherited?: class-string,
  118.  *     indexBy?: string,
  119.  *     inversedBy: string|null,
  120.  *     isCascadeRemove: bool,
  121.  *     isCascadePersist: bool,
  122.  *     isCascadeRefresh: bool,
  123.  *     isCascadeMerge: bool,
  124.  *     isCascadeDetach: bool,
  125.  *     isOnDeleteCascade?: bool,
  126.  *     isOwningSide: bool,
  127.  *     joinColumns?: array<JoinColumnData>,
  128.  *     joinColumnFieldNames?: array<string, string>,
  129.  *     joinTable?: array,
  130.  *     joinTableColumns?: list<mixed>,
  131.  *     mappedBy: string|null,
  132.  *     orderBy?: array,
  133.  *     originalClass?: class-string,
  134.  *     originalField?: string,
  135.  *     orphanRemoval?: bool,
  136.  *     relationToSourceKeyColumns?: array,
  137.  *     relationToTargetKeyColumns?: array,
  138.  *     sourceEntity: class-string,
  139.  *     sourceToTargetKeyColumns?: array<string, string>,
  140.  *     targetEntity: class-string,
  141.  *     targetToSourceKeyColumns?: array<string, string>,
  142.  *     type: int,
  143.  *     unique?: bool,
  144.  * }
  145.  */
  146. class ClassMetadataInfo implements ClassMetadata
  147. {
  148.     /* The inheritance mapping types */
  149.     /**
  150.      * NONE means the class does not participate in an inheritance hierarchy
  151.      * and therefore does not need an inheritance mapping type.
  152.      */
  153.     public const INHERITANCE_TYPE_NONE = 1;
  155.     /**
  156.      * JOINED means the class will be persisted according to the rules of
  157.      * <tt>Class Table Inheritance</tt>.
  158.      */
  159.     public const INHERITANCE_TYPE_JOINED = 2;
  161.     /**
  162.      * SINGLE_TABLE means the class will be persisted according to the rules of
  163.      * <tt>Single Table Inheritance</tt>.
  164.      */
  165.     public const INHERITANCE_TYPE_SINGLE_TABLE = 3;
  167.     /**
  168.      * TABLE_PER_CLASS means the class will be persisted according to the rules
  169.      * of <tt>Concrete Table Inheritance</tt>.
  170.      */
  171.     public const INHERITANCE_TYPE_TABLE_PER_CLASS = 4;
  173.     /* The Id generator types. */
  174.     /**
  175.      * AUTO means the generator type will depend on what the used platform prefers.
  176.      * Offers full portability.
  177.      */
  178.     public const GENERATOR_TYPE_AUTO = 1;
  180.     /**
  181.      * SEQUENCE means a separate sequence object will be used. Platforms that do
  182.      * not have native sequence support may emulate it. Full portability is currently
  183.      * not guaranteed.
  184.      */
  185.     public const GENERATOR_TYPE_SEQUENCE = 2;
  187.     /**
  188.      * TABLE means a separate table is used for id generation.
  189.      * Offers full portability (in that it results in an exception being thrown
  190.      * no matter the platform).
  191.      *
  192.      * @deprecated no replacement planned
  193.      */
  194.     public const GENERATOR_TYPE_TABLE = 3;
  196.     /**
  197.      * IDENTITY means an identity column is used for id generation. The database
  198.      * will fill in the id column on insertion. Platforms that do not support
  199.      * native identity columns may emulate them. Full portability is currently
  200.      * not guaranteed.
  201.      */
  202.     public const GENERATOR_TYPE_IDENTITY = 4;
  204.     /**
  205.      * NONE means the class does not have a generated id. That means the class
  206.      * must have a natural, manually assigned id.
  207.      */
  208.     public const GENERATOR_TYPE_NONE = 5;
  210.     /**
  211.      * UUID means that a UUID/GUID expression is used for id generation. Full
  212.      * portability is currently not guaranteed.
  213.      *
  214.      * @deprecated use an application-side generator instead
  215.      */
  216.     public const GENERATOR_TYPE_UUID = 6;
  218.     /**
  219.      * CUSTOM means that customer will use own ID generator that supposedly work
  220.      */
  221.     public const GENERATOR_TYPE_CUSTOM = 7;
  223.     /**
  224.      * DEFERRED_IMPLICIT means that changes of entities are calculated at commit-time
  225.      * by doing a property-by-property comparison with the original data. This will
  226.      * be done for all entities that are in MANAGED state at commit-time.
  227.      *
  228.      * This is the default change tracking policy.
  229.      */
  230.     public const CHANGETRACKING_DEFERRED_IMPLICIT = 1;
  232.     /**
  233.      * DEFERRED_EXPLICIT means that changes of entities are calculated at commit-time
  234.      * by doing a property-by-property comparison with the original data. This will
  235.      * be done only for entities that were explicitly saved (through persist() or a cascade).
  236.      */
  237.     public const CHANGETRACKING_DEFERRED_EXPLICIT = 2;
  239.     /**
  240.      * NOTIFY means that Doctrine relies on the entities sending out notifications
  241.      * when their properties change. Such entity classes must implement
  242.      * the <tt>NotifyPropertyChanged</tt> interface.
  243.      */
  244.     public const CHANGETRACKING_NOTIFY = 3;
  246.     /**
  247.      * Specifies that an association is to be fetched when it is first accessed.
  248.      */
  249.     public const FETCH_LAZY = 2;
  251.     /**
  252.      * Specifies that an association is to be fetched when the owner of the
  253.      * association is fetched.
  254.      */
  255.     public const FETCH_EAGER = 3;
  257.     /**
  258.      * Specifies that an association is to be fetched lazy (on first access) and that
  259.      * commands such as Collection#count, Collection#slice are issued directly against
  260.      * the database if the collection is not yet initialized.
  261.      */
  262.     public const FETCH_EXTRA_LAZY = 4;
  264.     /**
  265.      * Identifies a one-to-one association.
  266.      */
  267.     public const ONE_TO_ONE = 1;
  269.     /**
  270.      * Identifies a many-to-one association.
  271.      */
  272.     public const MANY_TO_ONE = 2;
  274.     /**
  275.      * Identifies a one-to-many association.
  276.      */
  277.     public const ONE_TO_MANY = 4;
  279.     /**
  280.      * Identifies a many-to-many association.
  281.      */
  282.     public const MANY_TO_MANY = 8;
  284.     /**
  285.      * Combined bitmask for to-one (single-valued) associations.
  286.      */
  287.     public const TO_ONE = 3;
  289.     /**
  290.      * Combined bitmask for to-many (collection-valued) associations.
  291.      */
  292.     public const TO_MANY = 12;
  294.     /**
  295.      * ReadOnly cache can do reads, inserts and deletes, cannot perform updates or employ any locks,
  296.      */
  297.     public const CACHE_USAGE_READ_ONLY = 1;
  299.     /**
  300.      * Nonstrict Read Write Cache doesn’t employ any locks but can do inserts, update and deletes.
  301.      */
  302.     public const CACHE_USAGE_NONSTRICT_READ_WRITE = 2;
  304.     /**
  305.      * Read Write Attempts to lock the entity before update/delete.
  306.      */
  307.     public const CACHE_USAGE_READ_WRITE = 3;
  309.     /**
  310.      * The value of this column is never generated by the database.
  311.      */
  312.     public const GENERATED_NEVER = 0;
  314.     /**
  315.      * The value of this column is generated by the database on INSERT, but not on UPDATE.
  316.      */
  317.     public const GENERATED_INSERT = 1;
  319.     /**
  320.      * The value of this column is generated by the database on both INSERT and UDPATE statements.
  321.      */
  322.     public const GENERATED_ALWAYS = 2;
  324.     /**
  325.      * READ-ONLY: The name of the entity class.
  326.      *
  327.      * @var string
  328.      * @psalm-var class-string<T>
  329.      */
  330.     public $name;
  332.     /**
  333.      * READ-ONLY: The namespace the entity class is contained in.
  334.      *
  335.      * @var string
  336.      * @todo Not really needed. Usage could be localized.
  337.      */
  338.     public $namespace;
  340.     /**
  341.      * READ-ONLY: The name of the entity class that is at the root of the mapped entity inheritance
  342.      * hierarchy. If the entity is not part of a mapped inheritance hierarchy this is the same
  343.      * as {@link $name}.
  344.      *
  345.      * @var string
  346.      * @psalm-var class-string
  347.      */
  348.     public $rootEntityName;
  350.     /**
  351.      * READ-ONLY: The definition of custom generator. Only used for CUSTOM
  352.      * generator type
  353.      *
  354.      * The definition has the following structure:
  355.      * <code>
  356.      * array(
  357.      *     'class' => 'ClassName',
  358.      * )
  359.      * </code>
  360.      *
  361.      * @todo Merge with tableGeneratorDefinition into generic generatorDefinition
  362.      * @var array<string, string>|null
  363.      */
  364.     public $customGeneratorDefinition;
  366.     /**
  367.      * The name of the custom repository class used for the entity class.
  368.      * (Optional).
  369.      *
  370.      * @var string|null
  371.      * @psalm-var ?class-string<EntityRepository>
  372.      */
  373.     public $customRepositoryClassName;
  375.     /**
  376.      * READ-ONLY: Whether this class describes the mapping of a mapped superclass.
  377.      *
  378.      * @var bool
  379.      */
  380.     public $isMappedSuperclass = false;
  382.     /**
  383.      * READ-ONLY: Whether this class describes the mapping of an embeddable class.
  384.      *
  385.      * @var bool
  386.      */
  387.     public $isEmbeddedClass = false;
  389.     /**
  390.      * READ-ONLY: The names of the parent classes (ancestors).
  391.      *
  392.      * @psalm-var list<class-string>
  393.      */
  394.     public $parentClasses = [];
  396.     /**
  397.      * READ-ONLY: The names of all subclasses (descendants).
  398.      *
  399.      * @psalm-var list<class-string>
  400.      */
  401.     public $subClasses = [];
  403.     /**
  404.      * READ-ONLY: The names of all embedded classes based on properties.
  405.      *
  406.      * @psalm-var array<string, mixed[]>
  407.      */
  408.     public $embeddedClasses = [];
  410.     /**
  411.      * READ-ONLY: The named queries allowed to be called directly from Repository.
  412.      *
  413.      * @psalm-var array<string, array<string, mixed>>
  414.      */
  415.     public $namedQueries = [];
  417.     /**
  418.      * READ-ONLY: The named native queries allowed to be called directly from Repository.
  419.      *
  420.      * A native SQL named query definition has the following structure:
  421.      * <pre>
  422.      * array(
  423.      *     'name'               => <query name>,
  424.      *     'query'              => <sql query>,
  425.      *     'resultClass'        => <class of the result>,
  426.      *     'resultSetMapping'   => <name of a SqlResultSetMapping>
  427.      * )
  428.      * </pre>
  429.      *
  430.      * @psalm-var array<string, array<string, mixed>>
  431.      */
  432.     public $namedNativeQueries = [];
  434.     /**
  435.      * READ-ONLY: The mappings of the results of native SQL queries.
  436.      *
  437.      * A native result mapping definition has the following structure:
  438.      * <pre>
  439.      * array(
  440.      *     'name'               => <result name>,
  441.      *     'entities'           => array(<entity result mapping>),
  442.      *     'columns'            => array(<column result mapping>)
  443.      * )
  444.      * </pre>
  445.      *
  446.      * @psalm-var array<string, array{
  447.      *                name: string,
  448.      *                entities: mixed[],
  449.      *                columns: mixed[]
  450.      *            }>
  451.      */
  452.     public $sqlResultSetMappings = [];
  454.     /**
  455.      * READ-ONLY: The field names of all fields that are part of the identifier/primary key
  456.      * of the mapped entity class.
  457.      *
  458.      * @psalm-var list<string>
  459.      */
  460.     public $identifier = [];
  462.     /**
  463.      * READ-ONLY: The inheritance mapping type used by the class.
  464.      *
  465.      * @var int
  466.      * @psalm-var self::INHERITANCE_TYPE_*
  467.      */
  468.     public $inheritanceType = self::INHERITANCE_TYPE_NONE;
  470.     /**
  471.      * READ-ONLY: The Id generator type used by the class.
  472.      *
  473.      * @var int
  474.      * @psalm-var self::GENERATOR_TYPE_*
  475.      */
  476.     public $generatorType = self::GENERATOR_TYPE_NONE;
  478.     /**
  479.      * READ-ONLY: The field mappings of the class.
  480.      * Keys are field names and values are mapping definitions.
  481.      *
  482.      * The mapping definition array has the following values:
  483.      *
  484.      * - <b>fieldName</b> (string)
  485.      * The name of the field in the Entity.
  486.      *
  487.      * - <b>type</b> (string)
  488.      * The type name of the mapped field. Can be one of Doctrine's mapping types
  489.      * or a custom mapping type.
  490.      *
  491.      * - <b>columnName</b> (string, optional)
  492.      * The column name. Optional. Defaults to the field name.
  493.      *
  494.      * - <b>length</b> (integer, optional)
  495.      * The database length of the column. Optional. Default value taken from
  496.      * the type.
  497.      *
  498.      * - <b>id</b> (boolean, optional)
  499.      * Marks the field as the primary key of the entity. Multiple fields of an
  500.      * entity can have the id attribute, forming a composite key.
  501.      *
  502.      * - <b>nullable</b> (boolean, optional)
  503.      * Whether the column is nullable. Defaults to FALSE.
  504.      *
  505.      * - <b>'notInsertable'</b> (boolean, optional)
  506.      * Whether the column is not insertable. Optional. Is only set if value is TRUE.
  507.      *
  508.      * - <b>'notUpdatable'</b> (boolean, optional)
  509.      * Whether the column is updatable. Optional. Is only set if value is TRUE.
  510.      *
  511.      * - <b>columnDefinition</b> (string, optional, schema-only)
  512.      * The SQL fragment that is used when generating the DDL for the column.
  513.      *
  514.      * - <b>precision</b> (integer, optional, schema-only)
  515.      * The precision of a decimal column. Only valid if the column type is decimal.
  516.      *
  517.      * - <b>scale</b> (integer, optional, schema-only)
  518.      * The scale of a decimal column. Only valid if the column type is decimal.
  519.      *
  520.      * - <b>'unique'</b> (string, optional, schema-only)
  521.      * Whether a unique constraint should be generated for the column.
  522.      *
  523.      * @var mixed[]
  524.      * @psalm-var array<string, FieldMapping>
  525.      */
  526.     public $fieldMappings = [];
  528.     /**
  529.      * READ-ONLY: An array of field names. Used to look up field names from column names.
  530.      * Keys are column names and values are field names.
  531.      *
  532.      * @psalm-var array<string, string>
  533.      */
  534.     public $fieldNames = [];
  536.     /**
  537.      * READ-ONLY: A map of field names to column names. Keys are field names and values column names.
  538.      * Used to look up column names from field names.
  539.      * This is the reverse lookup map of $_fieldNames.
  540.      *
  541.      * @deprecated 3.0 Remove this.
  542.      *
  543.      * @var mixed[]
  544.      */
  545.     public $columnNames = [];
  547.     /**
  548.      * READ-ONLY: The discriminator value of this class.
  549.      *
  550.      * <b>This does only apply to the JOINED and SINGLE_TABLE inheritance mapping strategies
  551.      * where a discriminator column is used.</b>
  552.      *
  553.      * @see discriminatorColumn
  554.      *
  555.      * @var mixed
  556.      */
  557.     public $discriminatorValue;
  559.     /**
  560.      * READ-ONLY: The discriminator map of all mapped classes in the hierarchy.
  561.      *
  562.      * <b>This does only apply to the JOINED and SINGLE_TABLE inheritance mapping strategies
  563.      * where a discriminator column is used.</b>
  564.      *
  565.      * @see discriminatorColumn
  566.      *
  567.      * @var array<int|string, string>
  568.      *
  569.      * @psalm-var array<int|string, class-string>
  570.      */
  571.     public $discriminatorMap = [];
  573.     /**
  574.      * READ-ONLY: The definition of the discriminator column used in JOINED and SINGLE_TABLE
  575.      * inheritance mappings.
  576.      *
  577.      * @psalm-var array<string, mixed>|null
  578.      */
  579.     public $discriminatorColumn;
  581.     /**
  582.      * READ-ONLY: The primary table definition. The definition is an array with the
  583.      * following entries:
  584.      *
  585.      * name => <tableName>
  586.      * schema => <schemaName>
  587.      * indexes => array
  588.      * uniqueConstraints => array
  589.      *
  590.      * @var mixed[]
  591.      * @psalm-var array{
  592.      *               name: string,
  593.      *               schema?: string,
  594.      *               indexes?: array,
  595.      *               uniqueConstraints?: array,
  596.      *               options?: array<string, mixed>,
  597.      *               quoted?: bool
  598.      *           }
  599.      */
  600.     public $table;
  602.     /**
  603.      * READ-ONLY: The registered lifecycle callbacks for entities of this class.
  604.      *
  605.      * @psalm-var array<string, list<string>>
  606.      */
  607.     public $lifecycleCallbacks = [];
  609.     /**
  610.      * READ-ONLY: The registered entity listeners.
  611.      *
  612.      * @psalm-var array<string, list<array{class: class-string, method: string}>>
  613.      */
  614.     public $entityListeners = [];
  616.     /**
  617.      * READ-ONLY: The association mappings of this class.
  618.      *
  619.      * The mapping definition array supports the following keys:
  620.      *
  621.      * - <b>fieldName</b> (string)
  622.      * The name of the field in the entity the association is mapped to.
  623.      *
  624.      * - <b>targetEntity</b> (string)
  625.      * The class name of the target entity. If it is fully-qualified it is used as is.
  626.      * If it is a simple, unqualified class name the namespace is assumed to be the same
  627.      * as the namespace of the source entity.
  628.      *
  629.      * - <b>mappedBy</b> (string, required for bidirectional associations)
  630.      * The name of the field that completes the bidirectional association on the owning side.
  631.      * This key must be specified on the inverse side of a bidirectional association.
  632.      *
  633.      * - <b>inversedBy</b> (string, required for bidirectional associations)
  634.      * The name of the field that completes the bidirectional association on the inverse side.
  635.      * This key must be specified on the owning side of a bidirectional association.
  636.      *
  637.      * - <b>cascade</b> (array, optional)
  638.      * The names of persistence operations to cascade on the association. The set of possible
  639.      * values are: "persist", "remove", "detach", "merge", "refresh", "all" (implies all others).
  640.      *
  641.      * - <b>orderBy</b> (array, one-to-many/many-to-many only)
  642.      * A map of field names (of the target entity) to sorting directions (ASC/DESC).
  643.      * Example: array('priority' => 'desc')
  644.      *
  645.      * - <b>fetch</b> (integer, optional)
  646.      * The fetching strategy to use for the association, usually defaults to FETCH_LAZY.
  647.      * Possible values are: ClassMetadata::FETCH_EAGER, ClassMetadata::FETCH_LAZY.
  648.      *
  649.      * - <b>joinTable</b> (array, optional, many-to-many only)
  650.      * Specification of the join table and its join columns (foreign keys).
  651.      * Only valid for many-to-many mappings. Note that one-to-many associations can be mapped
  652.      * through a join table by simply mapping the association as many-to-many with a unique
  653.      * constraint on the join table.
  654.      *
  655.      * - <b>indexBy</b> (string, optional, to-many only)
  656.      * Specification of a field on target-entity that is used to index the collection by.
  657.      * This field HAS to be either the primary key or a unique column. Otherwise the collection
  658.      * does not contain all the entities that are actually related.
  659.      *
  660.      * A join table definition has the following structure:
  661.      * <pre>
  662.      * array(
  663.      *     'name' => <join table name>,
  664.      *      'joinColumns' => array(<join column mapping from join table to source table>),
  665.      *      'inverseJoinColumns' => array(<join column mapping from join table to target table>)
  666.      * )
  667.      * </pre>
  668.      *
  669.      * @psalm-var array<string, AssociationMapping>
  670.      */
  671.     public $associationMappings = [];
  673.     /**
  674.      * READ-ONLY: Flag indicating whether the identifier/primary key of the class is composite.
  675.      *
  676.      * @var bool
  677.      */
  678.     public $isIdentifierComposite = false;
  680.     /**
  681.      * READ-ONLY: Flag indicating whether the identifier/primary key contains at least one foreign key association.
  682.      *
  683.      * This flag is necessary because some code blocks require special treatment of this cases.
  684.      *
  685.      * @var bool
  686.      */
  687.     public $containsForeignIdentifier = false;
  689.     /**
  690.      * READ-ONLY: Flag indicating whether the identifier/primary key contains at least one ENUM type.
  691.      *
  692.      * This flag is necessary because some code blocks require special treatment of this cases.
  693.      *
  694.      * @var bool
  695.      */
  696.     public $containsEnumIdentifier = false;
  698.     /**
  699.      * READ-ONLY: The ID generator used for generating IDs for this class.
  700.      *
  701.      * @var AbstractIdGenerator
  702.      * @todo Remove!
  703.      */
  704.     public $idGenerator;
  706.     /**
  707.      * READ-ONLY: The definition of the sequence generator of this class. Only used for the
  708.      * SEQUENCE generation strategy.
  709.      *
  710.      * The definition has the following structure:
  711.      * <code>
  712.      * array(
  713.      *     'sequenceName' => 'name',
  714.      *     'allocationSize' => '20',
  715.      *     'initialValue' => '1'
  716.      * )
  717.      * </code>
  718.      *
  719.      * @var array<string, mixed>
  720.      * @psalm-var array{sequenceName: string, allocationSize: string, initialValue: string, quoted?: mixed}
  721.      * @todo Merge with tableGeneratorDefinition into generic generatorDefinition
  722.      */
  723.     public $sequenceGeneratorDefinition;
  725.     /**
  726.      * READ-ONLY: The definition of the table generator of this class. Only used for the
  727.      * TABLE generation strategy.
  728.      *
  729.      * @deprecated
  730.      *
  731.      * @var array<string, mixed>
  732.      */
  733.     public $tableGeneratorDefinition;
  735.     /**
  736.      * READ-ONLY: The policy used for change-tracking on entities of this class.
  737.      *
  738.      * @var int
  739.      */
  740.     public $changeTrackingPolicy = self::CHANGETRACKING_DEFERRED_IMPLICIT;
  742.     /**
  743.      * READ-ONLY: A Flag indicating whether one or more columns of this class
  744.      * have to be reloaded after insert / update operations.
  745.      *
  746.      * @var bool
  747.      */
  748.     public $requiresFetchAfterChange = false;
  750.     /**
  751.      * READ-ONLY: A flag for whether or not instances of this class are to be versioned
  752.      * with optimistic locking.
  753.      *
  754.      * @var bool
  755.      */
  756.     public $isVersioned = false;
  758.     /**
  759.      * READ-ONLY: The name of the field which is used for versioning in optimistic locking (if any).
  760.      *
  761.      * @var string|null
  762.      */
  763.     public $versionField;
  765.     /** @var mixed[]|null */
  766.     public $cache;
  768.     /**
  769.      * The ReflectionClass instance of the mapped class.
  770.      *
  771.      * @var ReflectionClass|null
  772.      */
  773.     public $reflClass;
  775.     /**
  776.      * Is this entity marked as "read-only"?
  777.      *
  778.      * That means it is never considered for change-tracking in the UnitOfWork. It is a very helpful performance
  779.      * optimization for entities that are immutable, either in your domain or through the relation database
  780.      * (coming from a view, or a history table for example).
  781.      *
  782.      * @var bool
  783.      */
  784.     public $isReadOnly = false;
  786.     /**
  787.      * NamingStrategy determining the default column and table names.
  788.      *
  789.      * @var NamingStrategy
  790.      */
  791.     protected $namingStrategy;
  793.     /**
  794.      * The ReflectionProperty instances of the mapped class.
  795.      *
  796.      * @var array<string, ReflectionProperty|null>
  797.      */
  798.     public $reflFields = [];
  800.     /** @var InstantiatorInterface|null */
  801.     private $instantiator;
  803.     /**
  804.      * Initializes a new ClassMetadata instance that will hold the object-relational mapping
  805.      * metadata of the class with the given name.
  806.      *
  807.      * @param string $entityName The name of the entity class the new instance is used for.
  808.      * @psalm-param class-string<T> $entityName
  809.      */
  810.     public function __construct($entityName, ?NamingStrategy $namingStrategy = null)
  811.     {
  812.         $this->name           = $entityName;
  813.         $this->rootEntityName = $entityName;
  814.         $this->namingStrategy = $namingStrategy ?: new DefaultNamingStrategy();
  815.         $this->instantiator   = new Instantiator();
  816.     }
  818.     /**
  819.      * Gets the ReflectionProperties of the mapped class.
  820.      *
  821.      * @return ReflectionProperty[]|null[] An array of ReflectionProperty instances.
  822.      * @psalm-return array<ReflectionProperty|null>
  823.      */
  824.     public function getReflectionProperties()
  825.     {
  826.         return $this->reflFields;
  827.     }
  829.     /**
  830.      * Gets a ReflectionProperty for a specific field of the mapped class.
  831.      *
  832.      * @param string $name
  833.      *
  834.      * @return ReflectionProperty
  835.      */
  836.     public function getReflectionProperty($name)
  837.     {
  838.         return $this->reflFields[$name];
  839.     }
  841.     /**
  842.      * Gets the ReflectionProperty for the single identifier field.
  843.      *
  844.      * @return ReflectionProperty
  845.      *
  846.      * @throws BadMethodCallException If the class has a composite identifier.
  847.      */
  848.     public function getSingleIdReflectionProperty()
  849.     {
  850.         if ($this->isIdentifierComposite) {
  851.             throw new BadMethodCallException('Class ' . $this->name . ' has a composite identifier.');
  852.         }
  854.         return $this->reflFields[$this->identifier[0]];
  855.     }
  857.     /**
  858.      * Extracts the identifier values of an entity of this class.
  859.      *
  860.      * For composite identifiers, the identifier values are returned as an array
  861.      * with the same order as the field order in {@link identifier}.
  862.      *
  863.      * @param object $entity
  864.      *
  865.      * @return array<string, mixed>
  866.      */
  867.     public function getIdentifierValues($entity)
  868.     {
  869.         if ($this->isIdentifierComposite) {
  870.             $id = [];
  872.             foreach ($this->identifier as $idField) {
  873.                 $value = $this->reflFields[$idField]->getValue($entity);
  875.                 if ($value !== null) {
  876.                     $id[$idField] = $value;
  877.                 }
  878.             }
  880.             return $id;
  881.         }
  883.         $id    = $this->identifier[0];
  884.         $value = $this->reflFields[$id]->getValue($entity);
  886.         if ($value === null) {
  887.             return [];
  888.         }
  890.         return [$id => $value];
  891.     }
  893.     /**
  894.      * Populates the entity identifier of an entity.
  895.      *
  896.      * @param object $entity
  897.      * @psalm-param array<string, mixed> $id
  898.      *
  899.      * @return void
  900.      *
  901.      * @todo Rename to assignIdentifier()
  902.      */
  903.     public function setIdentifierValues($entity, array $id)
  904.     {
  905.         foreach ($id as $idField => $idValue) {
  906.             $this->reflFields[$idField]->setValue($entity, $idValue);
  907.         }
  908.     }
  910.     /**
  911.      * Sets the specified field to the specified value on the given entity.
  912.      *
  913.      * @param object $entity
  914.      * @param string $field
  915.      * @param mixed  $value
  916.      *
  917.      * @return void
  918.      */
  919.     public function setFieldValue($entity, $field, $value)
  920.     {
  921.         $this->reflFields[$field]->setValue($entity, $value);
  922.     }
  924.     /**
  925.      * Gets the specified field's value off the given entity.
  926.      *
  927.      * @param object $entity
  928.      * @param string $field
  929.      *
  930.      * @return mixed
  931.      */
  932.     public function getFieldValue($entity, $field)
  933.     {
  934.         return $this->reflFields[$field]->getValue($entity);
  935.     }
  937.     /**
  938.      * Creates a string representation of this instance.
  939.      *
  940.      * @return string The string representation of this instance.
  941.      *
  942.      * @todo Construct meaningful string representation.
  943.      */
  944.     public function __toString()
  945.     {
  946.         return self::class . '@' . spl_object_id($this);
  947.     }
  949.     /**
  950.      * Determines which fields get serialized.
  951.      *
  952.      * It is only serialized what is necessary for best unserialization performance.
  953.      * That means any metadata properties that are not set or empty or simply have
  954.      * their default value are NOT serialized.
  955.      *
  956.      * Parts that are also NOT serialized because they can not be properly unserialized:
  957.      *      - reflClass (ReflectionClass)
  958.      *      - reflFields (ReflectionProperty array)
  959.      *
  960.      * @return string[] The names of all the fields that should be serialized.
  961.      */
  962.     public function __sleep()
  963.     {
  964.         // This metadata is always serialized/cached.
  965.         $serialized = [
  966.             'associationMappings',
  967.             'columnNames', //TODO: 3.0 Remove this. Can use fieldMappings[$fieldName]['columnName']
  968.             'fieldMappings',
  969.             'fieldNames',
  970.             'embeddedClasses',
  971.             'identifier',
  972.             'isIdentifierComposite', // TODO: REMOVE
  973.             'name',
  974.             'namespace', // TODO: REMOVE
  975.             'table',
  976.             'rootEntityName',
  977.             'idGenerator', //TODO: Does not really need to be serialized. Could be moved to runtime.
  978.         ];
  980.         // The rest of the metadata is only serialized if necessary.
  981.         if ($this->changeTrackingPolicy !== self::CHANGETRACKING_DEFERRED_IMPLICIT) {
  982.             $serialized[] = 'changeTrackingPolicy';
  983.         }
  985.         if ($this->customRepositoryClassName) {
  986.             $serialized[] = 'customRepositoryClassName';
  987.         }
  989.         if ($this->inheritanceType !== self::INHERITANCE_TYPE_NONE) {
  990.             $serialized[] = 'inheritanceType';
  991.             $serialized[] = 'discriminatorColumn';
  992.             $serialized[] = 'discriminatorValue';
  993.             $serialized[] = 'discriminatorMap';
  994.             $serialized[] = 'parentClasses';
  995.             $serialized[] = 'subClasses';
  996.         }
  998.         if ($this->generatorType !== self::GENERATOR_TYPE_NONE) {
  999.             $serialized[] = 'generatorType';
  1000.             if ($this->generatorType === self::GENERATOR_TYPE_SEQUENCE) {
  1001.                 $serialized[] = 'sequenceGeneratorDefinition';
  1002.             }
  1003.         }
  1005.         if ($this->isMappedSuperclass) {
  1006.             $serialized[] = 'isMappedSuperclass';
  1007.         }
  1009.         if ($this->isEmbeddedClass) {
  1010.             $serialized[] = 'isEmbeddedClass';
  1011.         }
  1013.         if ($this->containsForeignIdentifier) {
  1014.             $serialized[] = 'containsForeignIdentifier';
  1015.         }
  1017.         if ($this->containsEnumIdentifier) {
  1018.             $serialized[] = 'containsEnumIdentifier';
  1019.         }
  1021.         if ($this->isVersioned) {
  1022.             $serialized[] = 'isVersioned';
  1023.             $serialized[] = 'versionField';
  1024.         }
  1026.         if ($this->lifecycleCallbacks) {
  1027.             $serialized[] = 'lifecycleCallbacks';
  1028.         }
  1030.         if ($this->entityListeners) {
  1031.             $serialized[] = 'entityListeners';
  1032.         }
  1034.         if ($this->namedQueries) {
  1035.             $serialized[] = 'namedQueries';
  1036.         }
  1038.         if ($this->namedNativeQueries) {
  1039.             $serialized[] = 'namedNativeQueries';
  1040.         }
  1042.         if ($this->sqlResultSetMappings) {
  1043.             $serialized[] = 'sqlResultSetMappings';
  1044.         }
  1046.         if ($this->isReadOnly) {
  1047.             $serialized[] = 'isReadOnly';
  1048.         }
  1050.         if ($this->customGeneratorDefinition) {
  1051.             $serialized[] = 'customGeneratorDefinition';
  1052.         }
  1054.         if ($this->cache) {
  1055.             $serialized[] = 'cache';
  1056.         }
  1058.         if ($this->requiresFetchAfterChange) {
  1059.             $serialized[] = 'requiresFetchAfterChange';
  1060.         }
  1062.         return $serialized;
  1063.     }
  1065.     /**
  1066.      * Creates a new instance of the mapped class, without invoking the constructor.
  1067.      *
  1068.      * @return object
  1069.      */
  1070.     public function newInstance()
  1071.     {
  1072.         return $this->instantiator->instantiate($this->name);
  1073.     }
  1075.     /**
  1076.      * Restores some state that can not be serialized/unserialized.
  1077.      *
  1078.      * @param ReflectionService $reflService
  1079.      *
  1080.      * @return void
  1081.      */
  1082.     public function wakeupReflection($reflService)
  1083.     {
  1084.         // Restore ReflectionClass and properties
  1085.         $this->reflClass    = $reflService->getClass($this->name);
  1086.         $this->instantiator = $this->instantiator ?: new Instantiator();
  1088.         $parentReflFields = [];
  1090.         foreach ($this->embeddedClasses as $property => $embeddedClass) {
  1091.             if (isset($embeddedClass['declaredField'])) {
  1092.                 $childProperty = $this->getAccessibleProperty(
  1093.                     $reflService,
  1094.                     $this->embeddedClasses[$embeddedClass['declaredField']]['class'],
  1095.                     $embeddedClass['originalField']
  1096.                 );
  1097.                 assert($childProperty !== null);
  1098.                 $parentReflFields[$property] = new ReflectionEmbeddedProperty(
  1099.                     $parentReflFields[$embeddedClass['declaredField']],
  1100.                     $childProperty,
  1101.                     $this->embeddedClasses[$embeddedClass['declaredField']]['class']
  1102.                 );
  1104.                 continue;
  1105.             }
  1107.             $fieldRefl = $this->getAccessibleProperty(
  1108.                 $reflService,
  1109.                 $embeddedClass['declared'] ?? $this->name,
  1110.                 $property
  1111.             );
  1113.             $parentReflFields[$property] = $fieldRefl;
  1114.             $this->reflFields[$property] = $fieldRefl;
  1115.         }
  1117.         foreach ($this->fieldMappings as $field => $mapping) {
  1118.             if (isset($mapping['declaredField']) && isset($parentReflFields[$mapping['declaredField']])) {
  1119.                 $childProperty = $this->getAccessibleProperty($reflService, $mapping['originalClass'], $mapping['originalField']);
  1120.                 assert($childProperty !== null);
  1122.                 if (isset($mapping['enumType'])) {
  1123.                     $childProperty = new ReflectionEnumProperty(
  1124.                         $childProperty,
  1125.                         $mapping['enumType']
  1126.                     );
  1127.                 }
  1129.                 $this->reflFields[$field] = new ReflectionEmbeddedProperty(
  1130.                     $parentReflFields[$mapping['declaredField']],
  1131.                     $childProperty,
  1132.                     $mapping['originalClass']
  1133.                 );
  1134.                 continue;
  1135.             }
  1137.             $this->reflFields[$field] = isset($mapping['declared'])
  1138.                 ? $this->getAccessibleProperty($reflService, $mapping['declared'], $field)
  1139.                 : $this->getAccessibleProperty($reflService, $this->name, $field);
  1141.             if (isset($mapping['enumType']) && $this->reflFields[$field] !== null) {
  1142.                 $this->reflFields[$field] = new ReflectionEnumProperty(
  1143.                     $this->reflFields[$field],
  1144.                     $mapping['enumType']
  1145.                 );
  1146.             }
  1147.         }
  1149.         foreach ($this->associationMappings as $field => $mapping) {
  1150.             $this->reflFields[$field] = isset($mapping['declared'])
  1151.                 ? $this->getAccessibleProperty($reflService, $mapping['declared'], $field)
  1152.                 : $this->getAccessibleProperty($reflService, $this->name, $field);
  1153.         }
  1154.     }
  1156.     /**
  1157.      * Initializes a new ClassMetadata instance that will hold the object-relational mapping
  1158.      * metadata of the class with the given name.
  1159.      *
  1160.      * @param ReflectionService $reflService The reflection service.
  1161.      *
  1162.      * @return void
  1163.      */
  1164.     public function initializeReflection($reflService)
  1165.     {
  1166.         $this->reflClass = $reflService->getClass($this->name);
  1167.         $this->namespace = $reflService->getClassNamespace($this->name);
  1169.         if ($this->reflClass) {
  1170.             $this->name = $this->rootEntityName = $this->reflClass->getName();
  1171.         }
  1173.         $this->table['name'] = $this->namingStrategy->classToTableName($this->name);
  1174.     }
  1176.     /**
  1177.      * Validates Identifier.
  1178.      *
  1179.      * @return void
  1180.      *
  1181.      * @throws MappingException
  1182.      */
  1183.     public function validateIdentifier()
  1184.     {
  1185.         if ($this->isMappedSuperclass || $this->isEmbeddedClass) {
  1186.             return;
  1187.         }
  1189.         // Verify & complete identifier mapping
  1190.         if (! $this->identifier) {
  1191.             throw MappingException::identifierRequired($this->name);
  1192.         }
  1194.         if ($this->usesIdGenerator() && $this->isIdentifierComposite) {
  1195.             throw MappingException::compositeKeyAssignedIdGeneratorRequired($this->name);
  1196.         }
  1197.     }
  1199.     /**
  1200.      * Validates association targets actually exist.
  1201.      *
  1202.      * @return void
  1203.      *
  1204.      * @throws MappingException
  1205.      */
  1206.     public function validateAssociations()
  1207.     {
  1208.         foreach ($this->associationMappings as $mapping) {
  1209.             if (
  1210.                 ! class_exists($mapping['targetEntity'])
  1211.                 && ! interface_exists($mapping['targetEntity'])
  1212.                 && ! trait_exists($mapping['targetEntity'])
  1213.             ) {
  1214.                 throw MappingException::invalidTargetEntityClass($mapping['targetEntity'], $this->name, $mapping['fieldName']);
  1215.             }
  1216.         }
  1217.     }
  1219.     /**
  1220.      * Validates lifecycle callbacks.
  1221.      *
  1222.      * @param ReflectionService $reflService
  1223.      *
  1224.      * @return void
  1225.      *
  1226.      * @throws MappingException
  1227.      */
  1228.     public function validateLifecycleCallbacks($reflService)
  1229.     {
  1230.         foreach ($this->lifecycleCallbacks as $callbacks) {
  1231.             foreach ($callbacks as $callbackFuncName) {
  1232.                 if (! $reflService->hasPublicMethod($this->name, $callbackFuncName)) {
  1233.                     throw MappingException::lifecycleCallbackMethodNotFound($this->name, $callbackFuncName);
  1234.                 }
  1235.             }
  1236.         }
  1237.     }
  1239.     /**
  1240.      * {@inheritDoc}
  1241.      */
  1242.     public function getReflectionClass()
  1243.     {
  1244.         return $this->reflClass;
  1245.     }
  1247.     /**
  1248.      * @psalm-param array{usage?: mixed, region?: mixed} $cache
  1249.      *
  1250.      * @return void
  1251.      */
  1252.     public function enableCache(array $cache)
  1253.     {
  1254.         if (! isset($cache['usage'])) {
  1255.             $cache['usage'] = self::CACHE_USAGE_READ_ONLY;
  1256.         }
  1258.         if (! isset($cache['region'])) {
  1259.             $cache['region'] = strtolower(str_replace('\\', '_', $this->rootEntityName));
  1260.         }
  1262.         $this->cache = $cache;
  1263.     }
  1265.     /**
  1266.      * @param string $fieldName
  1267.      * @psalm-param array{usage?: int, region?: string} $cache
  1268.      *
  1269.      * @return void
  1270.      */
  1271.     public function enableAssociationCache($fieldName, array $cache)
  1272.     {
  1273.         $this->associationMappings[$fieldName]['cache'] = $this->getAssociationCacheDefaults($fieldName, $cache);
  1274.     }
  1276.     /**
  1277.      * @param string $fieldName
  1278.      * @param array  $cache
  1279.      * @psalm-param array{usage?: int, region?: string|null} $cache
  1280.      *
  1281.      * @return int[]|string[]
  1282.      * @psalm-return array{usage: int, region: string|null}
  1283.      */
  1284.     public function getAssociationCacheDefaults($fieldName, array $cache)
  1285.     {
  1286.         if (! isset($cache['usage'])) {
  1287.             $cache['usage'] = $this->cache['usage'] ?? self::CACHE_USAGE_READ_ONLY;
  1288.         }
  1290.         if (! isset($cache['region'])) {
  1291.             $cache['region'] = strtolower(str_replace('\\', '_', $this->rootEntityName)) . '__' . $fieldName;
  1292.         }
  1294.         return $cache;
  1295.     }
  1297.     /**
  1298.      * Sets the change tracking policy used by this class.
  1299.      *
  1300.      * @param int $policy
  1301.      *
  1302.      * @return void
  1303.      */
  1304.     public function setChangeTrackingPolicy($policy)
  1305.     {
  1306.         $this->changeTrackingPolicy = $policy;
  1307.     }
  1309.     /**
  1310.      * Whether the change tracking policy of this class is "deferred explicit".
  1311.      *
  1312.      * @return bool
  1313.      */
  1314.     public function isChangeTrackingDeferredExplicit()
  1315.     {
  1316.         return $this->changeTrackingPolicy === self::CHANGETRACKING_DEFERRED_EXPLICIT;
  1317.     }
  1319.     /**
  1320.      * Whether the change tracking policy of this class is "deferred implicit".
  1321.      *
  1322.      * @return bool
  1323.      */
  1324.     public function isChangeTrackingDeferredImplicit()
  1325.     {
  1326.         return $this->changeTrackingPolicy === self::CHANGETRACKING_DEFERRED_IMPLICIT;
  1327.     }
  1329.     /**
  1330.      * Whether the change tracking policy of this class is "notify".
  1331.      *
  1332.      * @return bool
  1333.      */
  1334.     public function isChangeTrackingNotify()
  1335.     {
  1336.         return $this->changeTrackingPolicy === self::CHANGETRACKING_NOTIFY;
  1337.     }
  1339.     /**
  1340.      * Checks whether a field is part of the identifier/primary key field(s).
  1341.      *
  1342.      * @param string $fieldName The field name.
  1343.      *
  1344.      * @return bool TRUE if the field is part of the table identifier/primary key field(s),
  1345.      * FALSE otherwise.
  1346.      */
  1347.     public function isIdentifier($fieldName)
  1348.     {
  1349.         if (! $this->identifier) {
  1350.             return false;
  1351.         }
  1353.         if (! $this->isIdentifierComposite) {
  1354.             return $fieldName === $this->identifier[0];
  1355.         }
  1357.         return in_array($fieldName, $this->identifier, true);
  1358.     }
  1360.     /**
  1361.      * Checks if the field is unique.
  1362.      *
  1363.      * @param string $fieldName The field name.
  1364.      *
  1365.      * @return bool TRUE if the field is unique, FALSE otherwise.
  1366.      */
  1367.     public function isUniqueField($fieldName)
  1368.     {
  1369.         $mapping = $this->getFieldMapping($fieldName);
  1371.         return $mapping !== false && isset($mapping['unique']) && $mapping['unique'];
  1372.     }
  1374.     /**
  1375.      * Checks if the field is not null.
  1376.      *
  1377.      * @param string $fieldName The field name.
  1378.      *
  1379.      * @return bool TRUE if the field is not null, FALSE otherwise.
  1380.      */
  1381.     public function isNullable($fieldName)
  1382.     {
  1383.         $mapping = $this->getFieldMapping($fieldName);
  1385.         return $mapping !== false && isset($mapping['nullable']) && $mapping['nullable'];
  1386.     }
  1388.     /**
  1389.      * Gets a column name for a field name.
  1390.      * If the column name for the field cannot be found, the given field name
  1391.      * is returned.
  1392.      *
  1393.      * @param string $fieldName The field name.
  1394.      *
  1395.      * @return string The column name.
  1396.      */
  1397.     public function getColumnName($fieldName)
  1398.     {
  1399.         return $this->columnNames[$fieldName] ?? $fieldName;
  1400.     }
  1402.     /**
  1403.      * Gets the mapping of a (regular) field that holds some data but not a
  1404.      * reference to another object.
  1405.      *
  1406.      * @param string $fieldName The field name.
  1407.      *
  1408.      * @return mixed[] The field mapping.
  1409.      * @psalm-return FieldMapping
  1410.      *
  1411.      * @throws MappingException
  1412.      */
  1413.     public function getFieldMapping($fieldName)
  1414.     {
  1415.         if (! isset($this->fieldMappings[$fieldName])) {
  1416.             throw MappingException::mappingNotFound($this->name, $fieldName);
  1417.         }
  1419.         return $this->fieldMappings[$fieldName];
  1420.     }
  1422.     /**
  1423.      * Gets the mapping of an association.
  1424.      *
  1425.      * @see ClassMetadataInfo::$associationMappings
  1426.      *
  1427.      * @param string $fieldName The field name that represents the association in
  1428.      *                          the object model.
  1429.      *
  1430.      * @return mixed[] The mapping.
  1431.      * @psalm-return AssociationMapping
  1432.      *
  1433.      * @throws MappingException
  1434.      */
  1435.     public function getAssociationMapping($fieldName)
  1436.     {
  1437.         if (! isset($this->associationMappings[$fieldName])) {
  1438.             throw MappingException::mappingNotFound($this->name, $fieldName);
  1439.         }
  1441.         return $this->associationMappings[$fieldName];
  1442.     }
  1444.     /**
  1445.      * Gets all association mappings of the class.
  1446.      *
  1447.      * @psalm-return array<string, AssociationMapping>
  1448.      */
  1449.     public function getAssociationMappings()
  1450.     {
  1451.         return $this->associationMappings;
  1452.     }
  1454.     /**
  1455.      * Gets the field name for a column name.
  1456.      * If no field name can be found the column name is returned.
  1457.      *
  1458.      * @param string $columnName The column name.
  1459.      *
  1460.      * @return string The column alias.
  1461.      */
  1462.     public function getFieldName($columnName)
  1463.     {
  1464.         return $this->fieldNames[$columnName] ?? $columnName;
  1465.     }
  1467.     /**
  1468.      * Gets the named query.
  1469.      *
  1470.      * @see ClassMetadataInfo::$namedQueries
  1471.      *
  1472.      * @param string $queryName The query name.
  1473.      *
  1474.      * @return string
  1475.      *
  1476.      * @throws MappingException
  1477.      */
  1478.     public function getNamedQuery($queryName)
  1479.     {
  1480.         if (! isset($this->namedQueries[$queryName])) {
  1481.             throw MappingException::queryNotFound($this->name, $queryName);
  1482.         }
  1484.         return $this->namedQueries[$queryName]['dql'];
  1485.     }
  1487.     /**
  1488.      * Gets all named queries of the class.
  1489.      *
  1490.      * @return mixed[][]
  1491.      * @psalm-return array<string, array<string, mixed>>
  1492.      */
  1493.     public function getNamedQueries()
  1494.     {
  1495.         return $this->namedQueries;
  1496.     }
  1498.     /**
  1499.      * Gets the named native query.
  1500.      *
  1501.      * @see ClassMetadataInfo::$namedNativeQueries
  1502.      *
  1503.      * @param string $queryName The query name.
  1504.      *
  1505.      * @return mixed[]
  1506.      * @psalm-return array<string, mixed>
  1507.      *
  1508.      * @throws MappingException
  1509.      */
  1510.     public function getNamedNativeQuery($queryName)
  1511.     {
  1512.         if (! isset($this->namedNativeQueries[$queryName])) {
  1513.             throw MappingException::queryNotFound($this->name, $queryName);
  1514.         }
  1516.         return $this->namedNativeQueries[$queryName];
  1517.     }
  1519.     /**
  1520.      * Gets all named native queries of the class.
  1521.      *
  1522.      * @psalm-return array<string, array<string, mixed>>
  1523.      */
  1524.     public function getNamedNativeQueries()
  1525.     {
  1526.         return $this->namedNativeQueries;
  1527.     }
  1529.     /**
  1530.      * Gets the result set mapping.
  1531.      *
  1532.      * @see ClassMetadataInfo::$sqlResultSetMappings
  1533.      *
  1534.      * @param string $name The result set mapping name.
  1535.      *
  1536.      * @return mixed[]
  1537.      * @psalm-return array{name: string, entities: array, columns: array}
  1538.      *
  1539.      * @throws MappingException
  1540.      */
  1541.     public function getSqlResultSetMapping($name)
  1542.     {
  1543.         if (! isset($this->sqlResultSetMappings[$name])) {
  1544.             throw MappingException::resultMappingNotFound($this->name, $name);
  1545.         }
  1547.         return $this->sqlResultSetMappings[$name];
  1548.     }
  1550.     /**
  1551.      * Gets all sql result set mappings of the class.
  1552.      *
  1553.      * @return mixed[]
  1554.      * @psalm-return array<string, array{name: string, entities: array, columns: array}>
  1555.      */
  1556.     public function getSqlResultSetMappings()
  1557.     {
  1558.         return $this->sqlResultSetMappings;
  1559.     }
  1561.     /**
  1562.      * Checks whether given property has type
  1563.      *
  1564.      * @param string $name Property name
  1565.      */
  1566.     private function isTypedProperty(string $name): bool
  1567.     {
  1568.         return PHP_VERSION_ID >= 70400
  1569.                && isset($this->reflClass)
  1570.                && $this->reflClass->hasProperty($name)
  1571.                && $this->reflClass->getProperty($name)->hasType();
  1572.     }
  1574.     /**
  1575.      * Validates & completes the given field mapping based on typed property.
  1576.      *
  1577.      * @param  mixed[] $mapping The field mapping to validate & complete.
  1578.      *
  1579.      * @return mixed[] The updated mapping.
  1580.      */
  1581.     private function validateAndCompleteTypedFieldMapping(array $mapping): array
  1582.     {
  1583.         $type = $this->reflClass->getProperty($mapping['fieldName'])->getType();
  1585.         if ($type) {
  1586.             if (
  1587.                 ! isset($mapping['type'])
  1588.                 && ($type instanceof ReflectionNamedType)
  1589.             ) {
  1590.                 if (PHP_VERSION_ID >= 80100 && ! $type->isBuiltin() && enum_exists($type->getName())) {
  1591.                     $mapping['enumType'] = $type->getName();
  1593.                     $reflection = new ReflectionEnum($type->getName());
  1594.                     $type       = $reflection->getBackingType();
  1596.                     assert($type instanceof ReflectionNamedType);
  1597.                 }
  1599.                 switch ($type->getName()) {
  1600.                     case DateInterval::class:
  1601.                         $mapping['type'] = Types::DATEINTERVAL;
  1602.                         break;
  1603.                     case DateTime::class:
  1604.                         $mapping['type'] = Types::DATETIME_MUTABLE;
  1605.                         break;
  1606.                     case DateTimeImmutable::class:
  1607.                         $mapping['type'] = Types::DATETIME_IMMUTABLE;
  1608.                         break;
  1609.                     case 'array':
  1610.                         $mapping['type'] = Types::JSON;
  1611.                         break;
  1612.                     case 'bool':
  1613.                         $mapping['type'] = Types::BOOLEAN;
  1614.                         break;
  1615.                     case 'float':
  1616.                         $mapping['type'] = Types::FLOAT;
  1617.                         break;
  1618.                     case 'int':
  1619.                         $mapping['type'] = Types::INTEGER;
  1620.                         break;
  1621.                     case 'string':
  1622.                         $mapping['type'] = Types::STRING;
  1623.                         break;
  1624.                 }
  1625.             }
  1626.         }
  1628.         return $mapping;
  1629.     }
  1631.     /**
  1632.      * Validates & completes the basic mapping information based on typed property.
  1633.      *
  1634.      * @param mixed[] $mapping The mapping.
  1635.      *
  1636.      * @return mixed[] The updated mapping.
  1637.      */
  1638.     private function validateAndCompleteTypedAssociationMapping(array $mapping): array
  1639.     {
  1640.         $type = $this->reflClass->getProperty($mapping['fieldName'])->getType();
  1642.         if ($type === null || ($mapping['type'] & self::TO_ONE) === 0) {
  1643.             return $mapping;
  1644.         }
  1646.         if (! isset($mapping['targetEntity']) && $type instanceof ReflectionNamedType) {
  1647.             $mapping['targetEntity'] = $type->getName();
  1648.         }
  1650.         return $mapping;
  1651.     }
  1653.     /**
  1654.      * Validates & completes the given field mapping.
  1655.      *
  1656.      * @psalm-param array<string, mixed> $mapping The field mapping to validate & complete.
  1657.      *
  1658.      * @return mixed[] The updated mapping.
  1659.      *
  1660.      * @throws MappingException
  1661.      */
  1662.     protected function validateAndCompleteFieldMapping(array $mapping): array
  1663.     {
  1664.         // Check mandatory fields
  1665.         if (! isset($mapping['fieldName']) || ! $mapping['fieldName']) {
  1666.             throw MappingException::missingFieldName($this->name);
  1667.         }
  1669.         if ($this->isTypedProperty($mapping['fieldName'])) {
  1670.             $mapping = $this->validateAndCompleteTypedFieldMapping($mapping);
  1671.         }
  1673.         if (! isset($mapping['type'])) {
  1674.             // Default to string
  1675.             $mapping['type'] = 'string';
  1676.         }
  1678.         // Complete fieldName and columnName mapping
  1679.         if (! isset($mapping['columnName'])) {
  1680.             $mapping['columnName'] = $this->namingStrategy->propertyToColumnName($mapping['fieldName'], $this->name);
  1681.         }
  1683.         if ($mapping['columnName'][0] === '`') {
  1684.             $mapping['columnName'] = trim($mapping['columnName'], '`');
  1685.             $mapping['quoted']     = true;
  1686.         }
  1688.         $this->columnNames[$mapping['fieldName']] = $mapping['columnName'];
  1690.         if (isset($this->fieldNames[$mapping['columnName']]) || ($this->discriminatorColumn && $this->discriminatorColumn['name'] === $mapping['columnName'])) {
  1691.             throw MappingException::duplicateColumnName($this->name, $mapping['columnName']);
  1692.         }
  1694.         $this->fieldNames[$mapping['columnName']] = $mapping['fieldName'];
  1696.         // Complete id mapping
  1697.         if (isset($mapping['id']) && $mapping['id'] === true) {
  1698.             if ($this->versionField === $mapping['fieldName']) {
  1699.                 throw MappingException::cannotVersionIdField($this->name, $mapping['fieldName']);
  1700.             }
  1702.             if (! in_array($mapping['fieldName'], $this->identifier, true)) {
  1703.                 $this->identifier[] = $mapping['fieldName'];
  1704.             }
  1706.             // Check for composite key
  1707.             if (! $this->isIdentifierComposite && count($this->identifier) > 1) {
  1708.                 $this->isIdentifierComposite = true;
  1709.             }
  1710.         }
  1712.         if (Type::hasType($mapping['type']) && Type::getType($mapping['type'])->canRequireSQLConversion()) {
  1713.             if (isset($mapping['id']) && $mapping['id'] === true) {
  1714.                  throw MappingException::sqlConversionNotAllowedForIdentifiers($this->name, $mapping['fieldName'], $mapping['type']);
  1715.             }
  1717.             $mapping['requireSQLConversion'] = true;
  1718.         }
  1720.         if (isset($mapping['generated'])) {
  1721.             if (! in_array($mapping['generated'], [self::GENERATED_NEVER, self::GENERATED_INSERT, self::GENERATED_ALWAYS])) {
  1722.                 throw MappingException::invalidGeneratedMode($mapping['generated']);
  1723.             }
  1725.             if ($mapping['generated'] === self::GENERATED_NEVER) {
  1726.                 unset($mapping['generated']);
  1727.             }
  1728.         }
  1730.         if (isset($mapping['enumType'])) {
  1731.             if (PHP_VERSION_ID < 80100) {
  1732.                 throw MappingException::enumsRequirePhp81($this->name, $mapping['fieldName']);
  1733.             }
  1735.             if (! enum_exists($mapping['enumType'])) {
  1736.                 throw MappingException::nonEnumTypeMapped($this->name, $mapping['fieldName'], $mapping['enumType']);
  1737.             }
  1739.             if (! empty($mapping['id'])) {
  1740.                 $this->containsEnumIdentifier = true;
  1741.             }
  1742.         }
  1744.         return $mapping;
  1745.     }
  1747.     /**
  1748.      * Validates & completes the basic mapping information that is common to all
  1749.      * association mappings (one-to-one, many-ot-one, one-to-many, many-to-many).
  1750.      *
  1751.      * @psalm-param array<string, mixed> $mapping The mapping.
  1752.      *
  1753.      * @return mixed[] The updated mapping.
  1754.      * @psalm-return array{
  1755.      *                   mappedBy: mixed|null,
  1756.      *                   inversedBy: mixed|null,
  1757.      *                   isOwningSide: bool,
  1758.      *                   sourceEntity: class-string,
  1759.      *                   targetEntity: string,
  1760.      *                   fieldName: mixed,
  1761.      *                   fetch: mixed,
  1762.      *                   cascade: array<array-key,string>,
  1763.      *                   isCascadeRemove: bool,
  1764.      *                   isCascadePersist: bool,
  1765.      *                   isCascadeRefresh: bool,
  1766.      *                   isCascadeMerge: bool,
  1767.      *                   isCascadeDetach: bool,
  1768.      *                   type: int,
  1769.      *                   originalField: string,
  1770.      *                   originalClass: class-string,
  1771.      *                   ?orphanRemoval: bool
  1772.      *               }
  1773.      *
  1774.      * @throws MappingException If something is wrong with the mapping.
  1775.      */
  1776.     protected function _validateAndCompleteAssociationMapping(array $mapping)
  1777.     {
  1778.         if (! isset($mapping['mappedBy'])) {
  1779.             $mapping['mappedBy'] = null;
  1780.         }
  1782.         if (! isset($mapping['inversedBy'])) {
  1783.             $mapping['inversedBy'] = null;
  1784.         }
  1786.         $mapping['isOwningSide'] = true; // assume owning side until we hit mappedBy
  1788.         if (empty($mapping['indexBy'])) {
  1789.             unset($mapping['indexBy']);
  1790.         }
  1792.         // If targetEntity is unqualified, assume it is in the same namespace as
  1793.         // the sourceEntity.
  1794.         $mapping['sourceEntity'] = $this->name;
  1796.         if ($this->isTypedProperty($mapping['fieldName'])) {
  1797.             $mapping = $this->validateAndCompleteTypedAssociationMapping($mapping);
  1798.         }
  1800.         if (isset($mapping['targetEntity'])) {
  1801.             $mapping['targetEntity'] = $this->fullyQualifiedClassName($mapping['targetEntity']);
  1802.             $mapping['targetEntity'] = ltrim($mapping['targetEntity'], '\\');
  1803.         }
  1805.         if (($mapping['type'] & self::MANY_TO_ONE) > 0 && isset($mapping['orphanRemoval']) && $mapping['orphanRemoval']) {
  1806.             throw MappingException::illegalOrphanRemoval($this->name, $mapping['fieldName']);
  1807.         }
  1809.         // Complete id mapping
  1810.         if (isset($mapping['id']) && $mapping['id'] === true) {
  1811.             if (isset($mapping['orphanRemoval']) && $mapping['orphanRemoval']) {
  1812.                 throw MappingException::illegalOrphanRemovalOnIdentifierAssociation($this->name, $mapping['fieldName']);
  1813.             }
  1815.             if (! in_array($mapping['fieldName'], $this->identifier, true)) {
  1816.                 if (isset($mapping['joinColumns']) && count($mapping['joinColumns']) >= 2) {
  1817.                     throw MappingException::cannotMapCompositePrimaryKeyEntitiesAsForeignId(
  1818.                         $mapping['targetEntity'],
  1819.                         $this->name,
  1820.                         $mapping['fieldName']
  1821.                     );
  1822.                 }
  1824.                 $this->identifier[]              = $mapping['fieldName'];
  1825.                 $this->containsForeignIdentifier = true;
  1826.             }
  1828.             // Check for composite key
  1829.             if (! $this->isIdentifierComposite && count($this->identifier) > 1) {
  1830.                 $this->isIdentifierComposite = true;
  1831.             }
  1833.             if ($this->cache && ! isset($mapping['cache'])) {
  1834.                 throw NonCacheableEntityAssociation::fromEntityAndField(
  1835.                     $this->name,
  1836.                     $mapping['fieldName']
  1837.                 );
  1838.             }
  1839.         }
  1841.         // Mandatory attributes for both sides
  1842.         // Mandatory: fieldName, targetEntity
  1843.         if (! isset($mapping['fieldName']) || ! $mapping['fieldName']) {
  1844.             throw MappingException::missingFieldName($this->name);
  1845.         }
  1847.         if (! isset($mapping['targetEntity'])) {
  1848.             throw MappingException::missingTargetEntity($mapping['fieldName']);
  1849.         }
  1851.         // Mandatory and optional attributes for either side
  1852.         if (! $mapping['mappedBy']) {
  1853.             if (isset($mapping['joinTable']) && $mapping['joinTable']) {
  1854.                 if (isset($mapping['joinTable']['name']) && $mapping['joinTable']['name'][0] === '`') {
  1855.                     $mapping['joinTable']['name']   = trim($mapping['joinTable']['name'], '`');
  1856.                     $mapping['joinTable']['quoted'] = true;
  1857.                 }
  1858.             }
  1859.         } else {
  1860.             $mapping['isOwningSide'] = false;
  1861.         }
  1863.         if (isset($mapping['id']) && $mapping['id'] === true && $mapping['type'] & self::TO_MANY) {
  1864.             throw MappingException::illegalToManyIdentifierAssociation($this->name, $mapping['fieldName']);
  1865.         }
  1867.         // Fetch mode. Default fetch mode to LAZY, if not set.
  1868.         if (! isset($mapping['fetch'])) {
  1869.             $mapping['fetch'] = self::FETCH_LAZY;
  1870.         }
  1872.         // Cascades
  1873.         $cascades = isset($mapping['cascade']) ? array_map('strtolower', $mapping['cascade']) : [];
  1875.         $allCascades = ['remove', 'persist', 'refresh', 'merge', 'detach'];
  1876.         if (in_array('all', $cascades, true)) {
  1877.             $cascades = $allCascades;
  1878.         } elseif (count($cascades) !== count(array_intersect($cascades, $allCascades))) {
  1879.             throw MappingException::invalidCascadeOption(
  1880.                 array_diff($cascades, $allCascades),
  1881.                 $this->name,
  1882.                 $mapping['fieldName']
  1883.             );
  1884.         }
  1886.         $mapping['cascade']          = $cascades;
  1887.         $mapping['isCascadeRemove']  = in_array('remove', $cascades, true);
  1888.         $mapping['isCascadePersist'] = in_array('persist', $cascades, true);
  1889.         $mapping['isCascadeRefresh'] = in_array('refresh', $cascades, true);
  1890.         $mapping['isCascadeMerge']   = in_array('merge', $cascades, true);
  1891.         $mapping['isCascadeDetach']  = in_array('detach', $cascades, true);
  1893.         return $mapping;
  1894.     }
  1896.     /**
  1897.      * Validates & completes a one-to-one association mapping.
  1898.      *
  1899.      * @psalm-param array<string, mixed> $mapping The mapping to validate & complete.
  1900.      * @psalm-param array<string, mixed> $mapping The mapping to validate & complete.
  1901.      *
  1902.      * @return mixed[] The validated & completed mapping.
  1903.      * @psalm-return array{isOwningSide: mixed, orphanRemoval: bool, isCascadeRemove: bool}
  1904.      * @psalm-return array{
  1905.      *      mappedBy: mixed|null,
  1906.      *      inversedBy: mixed|null,
  1907.      *      isOwningSide: bool,
  1908.      *      sourceEntity: class-string,
  1909.      *      targetEntity: string,
  1910.      *      fieldName: mixed,
  1911.      *      fetch: mixed,
  1912.      *      cascade: array<string>,
  1913.      *      isCascadeRemove: bool,
  1914.      *      isCascadePersist: bool,
  1915.      *      isCascadeRefresh: bool,
  1916.      *      isCascadeMerge: bool,
  1917.      *      isCascadeDetach: bool,
  1918.      *      type: int,
  1919.      *      originalField: string,
  1920.      *      originalClass: class-string,
  1921.      *      joinColumns?: array{0: array{name: string, referencedColumnName: string}}|mixed,
  1922.      *      id?: mixed,
  1923.      *      sourceToTargetKeyColumns?: array<string, string>,
  1924.      *      joinColumnFieldNames?: array<string, string>,
  1925.      *      targetToSourceKeyColumns?: array<string, string>,
  1926.      *      orphanRemoval: bool
  1927.      * }
  1928.      *
  1929.      * @throws RuntimeException
  1930.      * @throws MappingException
  1931.      */
  1932.     protected function _validateAndCompleteOneToOneMapping(array $mapping)
  1933.     {
  1934.         $mapping = $this->_validateAndCompleteAssociationMapping($mapping);
  1936.         if (isset($mapping['joinColumns']) && $mapping['joinColumns']) {
  1937.             $mapping['isOwningSide'] = true;
  1938.         }
  1940.         if ($mapping['isOwningSide']) {
  1941.             if (empty($mapping['joinColumns'])) {
  1942.                 // Apply default join column
  1943.                 $mapping['joinColumns'] = [
  1944.                     [
  1945.                         'name' => $this->namingStrategy->joinColumnName($mapping['fieldName'], $this->name),
  1946.                         'referencedColumnName' => $this->namingStrategy->referenceColumnName(),
  1947.                     ],
  1948.                 ];
  1949.             }
  1951.             $uniqueConstraintColumns = [];
  1953.             foreach ($mapping['joinColumns'] as &$joinColumn) {
  1954.                 if ($mapping['type'] === self::ONE_TO_ONE && ! $this->isInheritanceTypeSingleTable()) {
  1955.                     if (count($mapping['joinColumns']) === 1) {
  1956.                         if (empty($mapping['id'])) {
  1957.                             $joinColumn['unique'] = true;
  1958.                         }
  1959.                     } else {
  1960.                         $uniqueConstraintColumns[] = $joinColumn['name'];
  1961.                     }
  1962.                 }
  1964.                 if (empty($joinColumn['name'])) {
  1965.                     $joinColumn['name'] = $this->namingStrategy->joinColumnName($mapping['fieldName'], $this->name);
  1966.                 }
  1968.                 if (empty($joinColumn['referencedColumnName'])) {
  1969.                     $joinColumn['referencedColumnName'] = $this->namingStrategy->referenceColumnName();
  1970.                 }
  1972.                 if ($joinColumn['name'][0] === '`') {
  1973.                     $joinColumn['name']   = trim($joinColumn['name'], '`');
  1974.                     $joinColumn['quoted'] = true;
  1975.                 }
  1977.                 if ($joinColumn['referencedColumnName'][0] === '`') {
  1978.                     $joinColumn['referencedColumnName'] = trim($joinColumn['referencedColumnName'], '`');
  1979.                     $joinColumn['quoted']               = true;
  1980.                 }
  1982.                 $mapping['sourceToTargetKeyColumns'][$joinColumn['name']] = $joinColumn['referencedColumnName'];
  1983.                 $mapping['joinColumnFieldNames'][$joinColumn['name']]     = $joinColumn['fieldName'] ?? $joinColumn['name'];
  1984.             }
  1986.             if ($uniqueConstraintColumns) {
  1987.                 if (! $this->table) {
  1988.                     throw new RuntimeException('ClassMetadataInfo::setTable() has to be called before defining a one to one relationship.');
  1989.                 }
  1991.                 $this->table['uniqueConstraints'][$mapping['fieldName'] . '_uniq'] = ['columns' => $uniqueConstraintColumns];
  1992.             }
  1994.             $mapping['targetToSourceKeyColumns'] = array_flip($mapping['sourceToTargetKeyColumns']);
  1995.         }
  1997.         $mapping['orphanRemoval']   = isset($mapping['orphanRemoval']) && $mapping['orphanRemoval'];
  1998.         $mapping['isCascadeRemove'] = $mapping['orphanRemoval'] || $mapping['isCascadeRemove'];
  2000.         if ($mapping['orphanRemoval']) {
  2001.             unset($mapping['unique']);
  2002.         }
  2004.         if (isset($mapping['id']) && $mapping['id'] === true && ! $mapping['isOwningSide']) {
  2005.             throw MappingException::illegalInverseIdentifierAssociation($this->name, $mapping['fieldName']);
  2006.         }
  2008.         return $mapping;
  2009.     }
  2011.     /**
  2012.      * Validates & completes a one-to-many association mapping.
  2013.      *
  2014.      * @psalm-param array<string, mixed> $mapping The mapping to validate and complete.
  2015.      *
  2016.      * @return mixed[] The validated and completed mapping.
  2017.      * @psalm-return array{
  2018.      *                   mappedBy: mixed,
  2019.      *                   inversedBy: mixed,
  2020.      *                   isOwningSide: bool,
  2021.      *                   sourceEntity: string,
  2022.      *                   targetEntity: string,
  2023.      *                   fieldName: mixed,
  2024.      *                   fetch: int|mixed,
  2025.      *                   cascade: array<array-key,string>,
  2026.      *                   isCascadeRemove: bool,
  2027.      *                   isCascadePersist: bool,
  2028.      *                   isCascadeRefresh: bool,
  2029.      *                   isCascadeMerge: bool,
  2030.      *                   isCascadeDetach: bool,
  2031.      *                   orphanRemoval: bool
  2032.      *               }
  2033.      *
  2034.      * @throws MappingException
  2035.      * @throws InvalidArgumentException
  2036.      */
  2037.     protected function _validateAndCompleteOneToManyMapping(array $mapping)
  2038.     {
  2039.         $mapping = $this->_validateAndCompleteAssociationMapping($mapping);
  2041.         // OneToMany-side MUST be inverse (must have mappedBy)
  2042.         if (! isset($mapping['mappedBy'])) {
  2043.             throw MappingException::oneToManyRequiresMappedBy($this->name, $mapping['fieldName']);
  2044.         }
  2046.         $mapping['orphanRemoval']   = isset($mapping['orphanRemoval']) && $mapping['orphanRemoval'];
  2047.         $mapping['isCascadeRemove'] = $mapping['orphanRemoval'] || $mapping['isCascadeRemove'];
  2049.         $this->assertMappingOrderBy($mapping);
  2051.         return $mapping;
  2052.     }
  2054.     /**
  2055.      * Validates & completes a many-to-many association mapping.
  2056.      *
  2057.      * @psalm-param array<string, mixed> $mapping The mapping to validate & complete.
  2058.      * @psalm-param array<string, mixed> $mapping The mapping to validate & complete.
  2059.      *
  2060.      * @return mixed[] The validated & completed mapping.
  2061.      * @psalm-return array{
  2062.      *      mappedBy: mixed,
  2063.      *      inversedBy: mixed,
  2064.      *      isOwningSide: bool,
  2065.      *      sourceEntity: class-string,
  2066.      *      targetEntity: string,
  2067.      *      fieldName: mixed,
  2068.      *      fetch: mixed,
  2069.      *      cascade: array<string>,
  2070.      *      isCascadeRemove: bool,
  2071.      *      isCascadePersist: bool,
  2072.      *      isCascadeRefresh: bool,
  2073.      *      isCascadeMerge: bool,
  2074.      *      isCascadeDetach: bool,
  2075.      *      type: int,
  2076.      *      originalField: string,
  2077.      *      originalClass: class-string,
  2078.      *      joinTable?: array{inverseJoinColumns: mixed}|mixed,
  2079.      *      joinTableColumns?: list<mixed>,
  2080.      *      isOnDeleteCascade?: true,
  2081.      *      relationToSourceKeyColumns?: array,
  2082.      *      relationToTargetKeyColumns?: array,
  2083.      *      orphanRemoval: bool
  2084.      * }
  2085.      *
  2086.      * @throws InvalidArgumentException
  2087.      */
  2088.     protected function _validateAndCompleteManyToManyMapping(array $mapping)
  2089.     {
  2090.         $mapping = $this->_validateAndCompleteAssociationMapping($mapping);
  2092.         if ($mapping['isOwningSide']) {
  2093.             // owning side MUST have a join table
  2094.             if (! isset($mapping['joinTable']['name'])) {
  2095.                 $mapping['joinTable']['name'] = $this->namingStrategy->joinTableName($mapping['sourceEntity'], $mapping['targetEntity'], $mapping['fieldName']);
  2096.             }
  2098.             $selfReferencingEntityWithoutJoinColumns = $mapping['sourceEntity'] === $mapping['targetEntity']
  2099.                 && (! (isset($mapping['joinTable']['joinColumns']) || isset($mapping['joinTable']['inverseJoinColumns'])));
  2101.             if (! isset($mapping['joinTable']['joinColumns'])) {
  2102.                 $mapping['joinTable']['joinColumns'] = [
  2103.                     [
  2104.                         'name' => $this->namingStrategy->joinKeyColumnName($mapping['sourceEntity'], $selfReferencingEntityWithoutJoinColumns ? 'source' : null),
  2105.                         'referencedColumnName' => $this->namingStrategy->referenceColumnName(),
  2106.                         'onDelete' => 'CASCADE',
  2107.                     ],
  2108.                 ];
  2109.             }
  2111.             if (! isset($mapping['joinTable']['inverseJoinColumns'])) {
  2112.                 $mapping['joinTable']['inverseJoinColumns'] = [
  2113.                     [
  2114.                         'name' => $this->namingStrategy->joinKeyColumnName($mapping['targetEntity'], $selfReferencingEntityWithoutJoinColumns ? 'target' : null),
  2115.                         'referencedColumnName' => $this->namingStrategy->referenceColumnName(),
  2116.                         'onDelete' => 'CASCADE',
  2117.                     ],
  2118.                 ];
  2119.             }
  2121.             $mapping['joinTableColumns'] = [];
  2123.             foreach ($mapping['joinTable']['joinColumns'] as &$joinColumn) {
  2124.                 if (empty($joinColumn['name'])) {
  2125.                     $joinColumn['name'] = $this->namingStrategy->joinKeyColumnName($mapping['sourceEntity'], $joinColumn['referencedColumnName']);
  2126.                 }
  2128.                 if (empty($joinColumn['referencedColumnName'])) {
  2129.                     $joinColumn['referencedColumnName'] = $this->namingStrategy->referenceColumnName();
  2130.                 }
  2132.                 if ($joinColumn['name'][0] === '`') {
  2133.                     $joinColumn['name']   = trim($joinColumn['name'], '`');
  2134.                     $joinColumn['quoted'] = true;
  2135.                 }
  2137.                 if ($joinColumn['referencedColumnName'][0] === '`') {
  2138.                     $joinColumn['referencedColumnName'] = trim($joinColumn['referencedColumnName'], '`');
  2139.                     $joinColumn['quoted']               = true;
  2140.                 }
  2142.                 if (isset($joinColumn['onDelete']) && strtolower($joinColumn['onDelete']) === 'cascade') {
  2143.                     $mapping['isOnDeleteCascade'] = true;
  2144.                 }
  2146.                 $mapping['relationToSourceKeyColumns'][$joinColumn['name']] = $joinColumn['referencedColumnName'];
  2147.                 $mapping['joinTableColumns'][]                              = $joinColumn['name'];
  2148.             }
  2150.             foreach ($mapping['joinTable']['inverseJoinColumns'] as &$inverseJoinColumn) {
  2151.                 if (empty($inverseJoinColumn['name'])) {
  2152.                     $inverseJoinColumn['name'] = $this->namingStrategy->joinKeyColumnName($mapping['targetEntity'], $inverseJoinColumn['referencedColumnName']);
  2153.                 }
  2155.                 if (empty($inverseJoinColumn['referencedColumnName'])) {
  2156.                     $inverseJoinColumn['referencedColumnName'] = $this->namingStrategy->referenceColumnName();
  2157.                 }
  2159.                 if ($inverseJoinColumn['name'][0] === '`') {
  2160.                     $inverseJoinColumn['name']   = trim($inverseJoinColumn['name'], '`');
  2161.                     $inverseJoinColumn['quoted'] = true;
  2162.                 }
  2164.                 if ($inverseJoinColumn['referencedColumnName'][0] === '`') {
  2165.                     $inverseJoinColumn['referencedColumnName'] = trim($inverseJoinColumn['referencedColumnName'], '`');
  2166.                     $inverseJoinColumn['quoted']               = true;
  2167.                 }
  2169.                 if (isset($inverseJoinColumn['onDelete']) && strtolower($inverseJoinColumn['onDelete']) === 'cascade') {
  2170.                     $mapping['isOnDeleteCascade'] = true;
  2171.                 }
  2173.                 $mapping['relationToTargetKeyColumns'][$inverseJoinColumn['name']] = $inverseJoinColumn['referencedColumnName'];
  2174.                 $mapping['joinTableColumns'][]                                     = $inverseJoinColumn['name'];
  2175.             }
  2176.         }
  2178.         $mapping['orphanRemoval'] = isset($mapping['orphanRemoval']) && $mapping['orphanRemoval'];
  2180.         $this->assertMappingOrderBy($mapping);
  2182.         return $mapping;
  2183.     }
  2185.     /**
  2186.      * {@inheritDoc}
  2187.      */
  2188.     public function getIdentifierFieldNames()
  2189.     {
  2190.         return $this->identifier;
  2191.     }
  2193.     /**
  2194.      * Gets the name of the single id field. Note that this only works on
  2195.      * entity classes that have a single-field pk.
  2196.      *
  2197.      * @return string
  2198.      *
  2199.      * @throws MappingException If the class doesn't have an identifier or it has a composite primary key.
  2200.      */
  2201.     public function getSingleIdentifierFieldName()
  2202.     {
  2203.         if ($this->isIdentifierComposite) {
  2204.             throw MappingException::singleIdNotAllowedOnCompositePrimaryKey($this->name);
  2205.         }
  2207.         if (! isset($this->identifier[0])) {
  2208.             throw MappingException::noIdDefined($this->name);
  2209.         }
  2211.         return $this->identifier[0];
  2212.     }
  2214.     /**
  2215.      * Gets the column name of the single id column. Note that this only works on
  2216.      * entity classes that have a single-field pk.
  2217.      *
  2218.      * @return string
  2219.      *
  2220.      * @throws MappingException If the class doesn't have an identifier or it has a composite primary key.
  2221.      */
  2222.     public function getSingleIdentifierColumnName()
  2223.     {
  2224.         return $this->getColumnName($this->getSingleIdentifierFieldName());
  2225.     }
  2227.     /**
  2228.      * INTERNAL:
  2229.      * Sets the mapped identifier/primary key fields of this class.
  2230.      * Mainly used by the ClassMetadataFactory to assign inherited identifiers.
  2231.      *
  2232.      * @psalm-param list<mixed> $identifier
  2233.      *
  2234.      * @return void
  2235.      */
  2236.     public function setIdentifier(array $identifier)
  2237.     {
  2238.         $this->identifier            = $identifier;
  2239.         $this->isIdentifierComposite = (count($this->identifier) > 1);
  2240.     }
  2242.     /**
  2243.      * {@inheritDoc}
  2244.      */
  2245.     public function getIdentifier()
  2246.     {
  2247.         return $this->identifier;
  2248.     }
  2250.     /**
  2251.      * {@inheritDoc}
  2252.      */
  2253.     public function hasField($fieldName)
  2254.     {
  2255.         return isset($this->fieldMappings[$fieldName]) || isset($this->embeddedClasses[$fieldName]);
  2256.     }
  2258.     /**
  2259.      * Gets an array containing all the column names.
  2260.      *
  2261.      * @psalm-param list<string>|null $fieldNames
  2262.      *
  2263.      * @return mixed[]
  2264.      * @psalm-return list<string>
  2265.      */
  2266.     public function getColumnNames(?array $fieldNames = null)
  2267.     {
  2268.         if ($fieldNames === null) {
  2269.             return array_keys($this->fieldNames);
  2270.         }
  2272.         return array_values(array_map([$this, 'getColumnName'], $fieldNames));
  2273.     }
  2275.     /**
  2276.      * Returns an array with all the identifier column names.
  2277.      *
  2278.      * @psalm-return list<string>
  2279.      */
  2280.     public function getIdentifierColumnNames()
  2281.     {
  2282.         $columnNames = [];
  2284.         foreach ($this->identifier as $idProperty) {
  2285.             if (isset($this->fieldMappings[$idProperty])) {
  2286.                 $columnNames[] = $this->fieldMappings[$idProperty]['columnName'];
  2288.                 continue;
  2289.             }
  2291.             // Association defined as Id field
  2292.             $joinColumns      = $this->associationMappings[$idProperty]['joinColumns'];
  2293.             $assocColumnNames = array_map(static function ($joinColumn) {
  2294.                 return $joinColumn['name'];
  2295.             }, $joinColumns);
  2297.             $columnNames = array_merge($columnNames, $assocColumnNames);
  2298.         }
  2300.         return $columnNames;
  2301.     }
  2303.     /**
  2304.      * Sets the type of Id generator to use for the mapped class.
  2305.      *
  2306.      * @param int $generatorType
  2307.      * @psalm-param self::GENERATOR_TYPE_* $generatorType
  2308.      *
  2309.      * @return void
  2310.      */
  2311.     public function setIdGeneratorType($generatorType)
  2312.     {
  2313.         $this->generatorType = $generatorType;
  2314.     }
  2316.     /**
  2317.      * Checks whether the mapped class uses an Id generator.
  2318.      *
  2319.      * @return bool TRUE if the mapped class uses an Id generator, FALSE otherwise.
  2320.      */
  2321.     public function usesIdGenerator()
  2322.     {
  2323.         return $this->generatorType !== self::GENERATOR_TYPE_NONE;
  2324.     }
  2326.     /**
  2327.      * @return bool
  2328.      */
  2329.     public function isInheritanceTypeNone()
  2330.     {
  2331.         return $this->inheritanceType === self::INHERITANCE_TYPE_NONE;
  2332.     }
  2334.     /**
  2335.      * Checks whether the mapped class uses the JOINED inheritance mapping strategy.
  2336.      *
  2337.      * @return bool TRUE if the class participates in a JOINED inheritance mapping,
  2338.      * FALSE otherwise.
  2339.      */
  2340.     public function isInheritanceTypeJoined()
  2341.     {
  2342.         return $this->inheritanceType === self::INHERITANCE_TYPE_JOINED;
  2343.     }
  2345.     /**
  2346.      * Checks whether the mapped class uses the SINGLE_TABLE inheritance mapping strategy.
  2347.      *
  2348.      * @return bool TRUE if the class participates in a SINGLE_TABLE inheritance mapping,
  2349.      * FALSE otherwise.
  2350.      */
  2351.     public function isInheritanceTypeSingleTable()
  2352.     {
  2353.         return $this->inheritanceType === self::INHERITANCE_TYPE_SINGLE_TABLE;
  2354.     }
  2356.     /**
  2357.      * Checks whether the mapped class uses the TABLE_PER_CLASS inheritance mapping strategy.
  2358.      *
  2359.      * @return bool TRUE if the class participates in a TABLE_PER_CLASS inheritance mapping,
  2360.      * FALSE otherwise.
  2361.      */
  2362.     public function isInheritanceTypeTablePerClass()
  2363.     {
  2364.         return $this->inheritanceType === self::INHERITANCE_TYPE_TABLE_PER_CLASS;
  2365.     }
  2367.     /**
  2368.      * Checks whether the class uses an identity column for the Id generation.
  2369.      *
  2370.      * @return bool TRUE if the class uses the IDENTITY generator, FALSE otherwise.
  2371.      */
  2372.     public function isIdGeneratorIdentity()
  2373.     {
  2374.         return $this->generatorType === self::GENERATOR_TYPE_IDENTITY;
  2375.     }
  2377.     /**
  2378.      * Checks whether the class uses a sequence for id generation.
  2379.      *
  2380.      * @return bool TRUE if the class uses the SEQUENCE generator, FALSE otherwise.
  2381.      */
  2382.     public function isIdGeneratorSequence()
  2383.     {
  2384.         return $this->generatorType === self::GENERATOR_TYPE_SEQUENCE;
  2385.     }
  2387.     /**
  2388.      * Checks whether the class uses a table for id generation.
  2389.      *
  2390.      * @deprecated
  2391.      *
  2392.      * @return false
  2393.      */
  2394.     public function isIdGeneratorTable()
  2395.     {
  2396.         Deprecation::trigger(
  2397.             'doctrine/orm',
  2398.             'https://github.com/doctrine/orm/pull/9046',
  2399.             '%s is deprecated',
  2400.             __METHOD__
  2401.         );
  2403.         return false;
  2404.     }
  2406.     /**
  2407.      * Checks whether the class has a natural identifier/pk (which means it does
  2408.      * not use any Id generator.
  2409.      *
  2410.      * @return bool
  2411.      */
  2412.     public function isIdentifierNatural()
  2413.     {
  2414.         return $this->generatorType === self::GENERATOR_TYPE_NONE;
  2415.     }
  2417.     /**
  2418.      * Checks whether the class use a UUID for id generation.
  2419.      *
  2420.      * @deprecated
  2421.      *
  2422.      * @return bool
  2423.      */
  2424.     public function isIdentifierUuid()
  2425.     {
  2426.         Deprecation::trigger(
  2427.             'doctrine/orm',
  2428.             'https://github.com/doctrine/orm/pull/9046',
  2429.             '%s is deprecated',
  2430.             __METHOD__
  2431.         );
  2433.         return $this->generatorType === self::GENERATOR_TYPE_UUID;
  2434.     }
  2436.     /**
  2437.      * Gets the type of a field.
  2438.      *
  2439.      * @param string $fieldName
  2440.      *
  2441.      * @return string|null
  2442.      *
  2443.      * @todo 3.0 Remove this. PersisterHelper should fix it somehow
  2444.      */
  2445.     public function getTypeOfField($fieldName)
  2446.     {
  2447.         return isset($this->fieldMappings[$fieldName])
  2448.             ? $this->fieldMappings[$fieldName]['type']
  2449.             : null;
  2450.     }
  2452.     /**
  2453.      * Gets the type of a column.
  2454.      *
  2455.      * @deprecated 3.0 remove this. this method is bogus and unreliable, since it cannot resolve the type of a column
  2456.      *             that is derived by a referenced field on a different entity.
  2457.      *
  2458.      * @param string $columnName
  2459.      *
  2460.      * @return string|null
  2461.      */
  2462.     public function getTypeOfColumn($columnName)
  2463.     {
  2464.         return $this->getTypeOfField($this->getFieldName($columnName));
  2465.     }
  2467.     /**
  2468.      * Gets the name of the primary table.
  2469.      *
  2470.      * @return string
  2471.      */
  2472.     public function getTableName()
  2473.     {
  2474.         return $this->table['name'];
  2475.     }
  2477.     /**
  2478.      * Gets primary table's schema name.
  2479.      *
  2480.      * @return string|null
  2481.      */
  2482.     public function getSchemaName()
  2483.     {
  2484.         return $this->table['schema'] ?? null;
  2485.     }
  2487.     /**
  2488.      * Gets the table name to use for temporary identifier tables of this class.
  2489.      *
  2490.      * @return string
  2491.      */
  2492.     public function getTemporaryIdTableName()
  2493.     {
  2494.         // replace dots with underscores because PostgreSQL creates temporary tables in a special schema
  2495.         return str_replace('.', '_', $this->getTableName() . '_id_tmp');
  2496.     }
  2498.     /**
  2499.      * Sets the mapped subclasses of this class.
  2500.      *
  2501.      * @psalm-param list<string> $subclasses The names of all mapped subclasses.
  2502.      *
  2503.      * @return void
  2504.      */
  2505.     public function setSubclasses(array $subclasses)
  2506.     {
  2507.         foreach ($subclasses as $subclass) {
  2508.             $this->subClasses[] = $this->fullyQualifiedClassName($subclass);
  2509.         }
  2510.     }
  2512.     /**
  2513.      * Sets the parent class names.
  2514.      * Assumes that the class names in the passed array are in the order:
  2515.      * directParent -> directParentParent -> directParentParentParent ... -> root.
  2516.      *
  2517.      * @psalm-param list<class-string> $classNames
  2518.      *
  2519.      * @return void
  2520.      */
  2521.     public function setParentClasses(array $classNames)
  2522.     {
  2523.         $this->parentClasses = $classNames;
  2525.         if (count($classNames) > 0) {
  2526.             $this->rootEntityName = array_pop($classNames);
  2527.         }
  2528.     }
  2530.     /**
  2531.      * Sets the inheritance type used by the class and its subclasses.
  2532.      *
  2533.      * @param int $type
  2534.      * @psalm-param self::INHERITANCE_TYPE_* $type
  2535.      *
  2536.      * @return void
  2537.      *
  2538.      * @throws MappingException
  2539.      */
  2540.     public function setInheritanceType($type)
  2541.     {
  2542.         if (! $this->isInheritanceType($type)) {
  2543.             throw MappingException::invalidInheritanceType($this->name, $type);
  2544.         }
  2546.         $this->inheritanceType = $type;
  2547.     }
  2549.     /**
  2550.      * Sets the association to override association mapping of property for an entity relationship.
  2551.      *
  2552.      * @param string $fieldName
  2553.      * @psalm-param array<string, mixed> $overrideMapping
  2554.      *
  2555.      * @return void
  2556.      *
  2557.      * @throws MappingException
  2558.      */
  2559.     public function setAssociationOverride($fieldName, array $overrideMapping)
  2560.     {
  2561.         if (! isset($this->associationMappings[$fieldName])) {
  2562.             throw MappingException::invalidOverrideFieldName($this->name, $fieldName);
  2563.         }
  2565.         $mapping = $this->associationMappings[$fieldName];
  2567.         //if (isset($mapping['inherited']) && (count($overrideMapping) !== 1 || ! isset($overrideMapping['fetch']))) {
  2568.             // TODO: Deprecate overriding the fetch mode via association override for 3.0,
  2569.             // users should do this with a listener and a custom attribute/annotation
  2570.             // TODO: Enable this exception in 2.8
  2571.             //throw MappingException::illegalOverrideOfInheritedProperty($this->name, $fieldName);
  2572.         //}
  2574.         if (isset($overrideMapping['joinColumns'])) {
  2575.             $mapping['joinColumns'] = $overrideMapping['joinColumns'];
  2576.         }
  2578.         if (isset($overrideMapping['inversedBy'])) {
  2579.             $mapping['inversedBy'] = $overrideMapping['inversedBy'];
  2580.         }
  2582.         if (isset($overrideMapping['joinTable'])) {
  2583.             $mapping['joinTable'] = $overrideMapping['joinTable'];
  2584.         }
  2586.         if (isset($overrideMapping['fetch'])) {
  2587.             $mapping['fetch'] = $overrideMapping['fetch'];
  2588.         }
  2590.         $mapping['joinColumnFieldNames']       = null;
  2591.         $mapping['joinTableColumns']           = null;
  2592.         $mapping['sourceToTargetKeyColumns']   = null;
  2593.         $mapping['relationToSourceKeyColumns'] = null;
  2594.         $mapping['relationToTargetKeyColumns'] = null;
  2596.         switch ($mapping['type']) {
  2597.             case self::ONE_TO_ONE:
  2598.                 $mapping = $this->_validateAndCompleteOneToOneMapping($mapping);
  2599.                 break;
  2600.             case self::ONE_TO_MANY:
  2601.                 $mapping = $this->_validateAndCompleteOneToManyMapping($mapping);
  2602.                 break;
  2603.             case self::MANY_TO_ONE:
  2604.                 $mapping = $this->_validateAndCompleteOneToOneMapping($mapping);
  2605.                 break;
  2606.             case self::MANY_TO_MANY:
  2607.                 $mapping = $this->_validateAndCompleteManyToManyMapping($mapping);
  2608.                 break;
  2609.         }
  2611.         $this->associationMappings[$fieldName] = $mapping;
  2612.     }
  2614.     /**
  2615.      * Sets the override for a mapped field.
  2616.      *
  2617.      * @param string $fieldName
  2618.      * @psalm-param array<string, mixed> $overrideMapping
  2619.      *
  2620.      * @return void
  2621.      *
  2622.      * @throws MappingException
  2623.      */
  2624.     public function setAttributeOverride($fieldName, array $overrideMapping)
  2625.     {
  2626.         if (! isset($this->fieldMappings[$fieldName])) {
  2627.             throw MappingException::invalidOverrideFieldName($this->name, $fieldName);
  2628.         }
  2630.         $mapping = $this->fieldMappings[$fieldName];
  2632.         //if (isset($mapping['inherited'])) {
  2633.             // TODO: Enable this exception in 2.8
  2634.             //throw MappingException::illegalOverrideOfInheritedProperty($this->name, $fieldName);
  2635.         //}
  2637.         if (isset($mapping['id'])) {
  2638.             $overrideMapping['id'] = $mapping['id'];
  2639.         }
  2641.         if (! isset($overrideMapping['type'])) {
  2642.             $overrideMapping['type'] = $mapping['type'];
  2643.         }
  2645.         if (! isset($overrideMapping['fieldName'])) {
  2646.             $overrideMapping['fieldName'] = $mapping['fieldName'];
  2647.         }
  2649.         if ($overrideMapping['type'] !== $mapping['type']) {
  2650.             throw MappingException::invalidOverrideFieldType($this->name, $fieldName);
  2651.         }
  2653.         unset($this->fieldMappings[$fieldName]);
  2654.         unset($this->fieldNames[$mapping['columnName']]);
  2655.         unset($this->columnNames[$mapping['fieldName']]);
  2657.         $overrideMapping = $this->validateAndCompleteFieldMapping($overrideMapping);
  2659.         $this->fieldMappings[$fieldName] = $overrideMapping;
  2660.     }
  2662.     /**
  2663.      * Checks whether a mapped field is inherited from an entity superclass.
  2664.      *
  2665.      * @param string $fieldName
  2666.      *
  2667.      * @return bool TRUE if the field is inherited, FALSE otherwise.
  2668.      */
  2669.     public function isInheritedField($fieldName)
  2670.     {
  2671.         return isset($this->fieldMappings[$fieldName]['inherited']);
  2672.     }
  2674.     /**
  2675.      * Checks if this entity is the root in any entity-inheritance-hierarchy.
  2676.      *
  2677.      * @return bool
  2678.      */
  2679.     public function isRootEntity()
  2680.     {
  2681.         return $this->name === $this->rootEntityName;
  2682.     }
  2684.     /**
  2685.      * Checks whether a mapped association field is inherited from a superclass.
  2686.      *
  2687.      * @param string $fieldName
  2688.      *
  2689.      * @return bool TRUE if the field is inherited, FALSE otherwise.
  2690.      */
  2691.     public function isInheritedAssociation($fieldName)
  2692.     {
  2693.         return isset($this->associationMappings[$fieldName]['inherited']);
  2694.     }
  2696.     /**
  2697.      * @param string $fieldName
  2698.      *
  2699.      * @return bool
  2700.      */
  2701.     public function isInheritedEmbeddedClass($fieldName)
  2702.     {
  2703.         return isset($this->embeddedClasses[$fieldName]['inherited']);
  2704.     }
  2706.     /**
  2707.      * Sets the name of the primary table the class is mapped to.
  2708.      *
  2709.      * @deprecated Use {@link setPrimaryTable}.
  2710.      *
  2711.      * @param string $tableName The table name.
  2712.      *
  2713.      * @return void
  2714.      */
  2715.     public function setTableName($tableName)
  2716.     {
  2717.         $this->table['name'] = $tableName;
  2718.     }
  2720.     /**
  2721.      * Sets the primary table definition. The provided array supports the
  2722.      * following structure:
  2723.      *
  2724.      * name => <tableName> (optional, defaults to class name)
  2725.      * indexes => array of indexes (optional)
  2726.      * uniqueConstraints => array of constraints (optional)
  2727.      *
  2728.      * If a key is omitted, the current value is kept.
  2729.      *
  2730.      * @psalm-param array<string, mixed> $table The table description.
  2731.      *
  2732.      * @return void
  2733.      */
  2734.     public function setPrimaryTable(array $table)
  2735.     {
  2736.         if (isset($table['name'])) {
  2737.             // Split schema and table name from a table name like "myschema.mytable"
  2738.             if (str_contains($table['name'], '.')) {
  2739.                 [$this->table['schema'], $table['name']] = explode('.', $table['name'], 2);
  2740.             }
  2742.             if ($table['name'][0] === '`') {
  2743.                 $table['name']         = trim($table['name'], '`');
  2744.                 $this->table['quoted'] = true;
  2745.             }
  2747.             $this->table['name'] = $table['name'];
  2748.         }
  2750.         if (isset($table['quoted'])) {
  2751.             $this->table['quoted'] = $table['quoted'];
  2752.         }
  2754.         if (isset($table['schema'])) {
  2755.             $this->table['schema'] = $table['schema'];
  2756.         }
  2758.         if (isset($table['indexes'])) {
  2759.             $this->table['indexes'] = $table['indexes'];
  2760.         }
  2762.         if (isset($table['uniqueConstraints'])) {
  2763.             $this->table['uniqueConstraints'] = $table['uniqueConstraints'];
  2764.         }
  2766.         if (isset($table['options'])) {
  2767.             $this->table['options'] = $table['options'];
  2768.         }
  2769.     }
  2771.     /**
  2772.      * Checks whether the given type identifies an inheritance type.
  2773.      *
  2774.      * @return bool TRUE if the given type identifies an inheritance type, FALSE otherwise.
  2775.      */
  2776.     private function isInheritanceType(int $type): bool
  2777.     {
  2778.         return $type === self::INHERITANCE_TYPE_NONE ||
  2779.                 $type === self::INHERITANCE_TYPE_SINGLE_TABLE ||
  2780.                 $type === self::INHERITANCE_TYPE_JOINED ||
  2781.                 $type === self::INHERITANCE_TYPE_TABLE_PER_CLASS;
  2782.     }
  2784.     /**
  2785.      * Adds a mapped field to the class.
  2786.      *
  2787.      * @psalm-param array<string, mixed> $mapping The field mapping.
  2788.      *
  2789.      * @return void
  2790.      *
  2791.      * @throws MappingException
  2792.      */
  2793.     public function mapField(array $mapping)
  2794.     {
  2795.         $mapping = $this->validateAndCompleteFieldMapping($mapping);
  2796.         $this->assertFieldNotMapped($mapping['fieldName']);
  2798.         if (isset($mapping['generated'])) {
  2799.             $this->requiresFetchAfterChange = true;
  2800.         }
  2802.         $this->fieldMappings[$mapping['fieldName']] = $mapping;
  2803.     }
  2805.     /**
  2806.      * INTERNAL:
  2807.      * Adds an association mapping without completing/validating it.
  2808.      * This is mainly used to add inherited association mappings to derived classes.
  2809.      *
  2810.      * @psalm-param AssociationMapping $mapping
  2811.      *
  2812.      * @return void
  2813.      *
  2814.      * @throws MappingException
  2815.      */
  2816.     public function addInheritedAssociationMapping(array $mapping/*, $owningClassName = null*/)
  2817.     {
  2818.         if (isset($this->associationMappings[$mapping['fieldName']])) {
  2819.             throw MappingException::duplicateAssociationMapping($this->name, $mapping['fieldName']);
  2820.         }
  2822.         $this->associationMappings[$mapping['fieldName']] = $mapping;
  2823.     }
  2825.     /**
  2826.      * INTERNAL:
  2827.      * Adds a field mapping without completing/validating it.
  2828.      * This is mainly used to add inherited field mappings to derived classes.
  2829.      *
  2830.      * @psalm-param array<string, mixed> $fieldMapping
  2831.      *
  2832.      * @return void
  2833.      */
  2834.     public function addInheritedFieldMapping(array $fieldMapping)
  2835.     {
  2836.         $this->fieldMappings[$fieldMapping['fieldName']] = $fieldMapping;
  2837.         $this->columnNames[$fieldMapping['fieldName']]   = $fieldMapping['columnName'];
  2838.         $this->fieldNames[$fieldMapping['columnName']]   = $fieldMapping['fieldName'];
  2839.     }
  2841.     /**
  2842.      * INTERNAL:
  2843.      * Adds a named query to this class.
  2844.      *
  2845.      * @deprecated
  2846.      *
  2847.      * @psalm-param array<string, mixed> $queryMapping
  2848.      *
  2849.      * @return void
  2850.      *
  2851.      * @throws MappingException
  2852.      */
  2853.     public function addNamedQuery(array $queryMapping)
  2854.     {
  2855.         if (! isset($queryMapping['name'])) {
  2856.             throw MappingException::nameIsMandatoryForQueryMapping($this->name);
  2857.         }
  2859.         Deprecation::trigger(
  2860.             'doctrine/orm',
  2861.             'https://github.com/doctrine/orm/issues/8592',
  2862.             'Named Queries are deprecated, here "%s" on entity %s. Move the query logic into EntityRepository',
  2863.             $queryMapping['name'],
  2864.             $this->name
  2865.         );
  2867.         if (isset($this->namedQueries[$queryMapping['name']])) {
  2868.             throw MappingException::duplicateQueryMapping($this->name, $queryMapping['name']);
  2869.         }
  2871.         if (! isset($queryMapping['query'])) {
  2872.             throw MappingException::emptyQueryMapping($this->name, $queryMapping['name']);
  2873.         }
  2875.         $name  = $queryMapping['name'];
  2876.         $query = $queryMapping['query'];
  2877.         $dql   = str_replace('__CLASS__', $this->name, $query);
  2879.         $this->namedQueries[$name] = [
  2880.             'name'  => $name,
  2881.             'query' => $query,
  2882.             'dql'   => $dql,
  2883.         ];
  2884.     }
  2886.     /**
  2887.      * INTERNAL:
  2888.      * Adds a named native query to this class.
  2889.      *
  2890.      * @deprecated
  2891.      *
  2892.      * @psalm-param array<string, mixed> $queryMapping
  2893.      *
  2894.      * @return void
  2895.      *
  2896.      * @throws MappingException
  2897.      */
  2898.     public function addNamedNativeQuery(array $queryMapping)
  2899.     {
  2900.         if (! isset($queryMapping['name'])) {
  2901.             throw MappingException::nameIsMandatoryForQueryMapping($this->name);
  2902.         }
  2904.         Deprecation::trigger(
  2905.             'doctrine/orm',
  2906.             'https://github.com/doctrine/orm/issues/8592',
  2907.             'Named Native Queries are deprecated, here "%s" on entity %s. Move the query logic into EntityRepository',
  2908.             $queryMapping['name'],
  2909.             $this->name
  2910.         );
  2912.         if (isset($this->namedNativeQueries[$queryMapping['name']])) {
  2913.             throw MappingException::duplicateQueryMapping($this->name, $queryMapping['name']);
  2914.         }
  2916.         if (! isset($queryMapping['query'])) {
  2917.             throw MappingException::emptyQueryMapping($this->name, $queryMapping['name']);
  2918.         }
  2920.         if (! isset($queryMapping['resultClass']) && ! isset($queryMapping['resultSetMapping'])) {
  2921.             throw MappingException::missingQueryMapping($this->name, $queryMapping['name']);
  2922.         }
  2924.         $queryMapping['isSelfClass'] = false;
  2926.         if (isset($queryMapping['resultClass'])) {
  2927.             if ($queryMapping['resultClass'] === '__CLASS__') {
  2928.                 $queryMapping['isSelfClass'] = true;
  2929.                 $queryMapping['resultClass'] = $this->name;
  2930.             }
  2932.             $queryMapping['resultClass'] = $this->fullyQualifiedClassName($queryMapping['resultClass']);
  2933.             $queryMapping['resultClass'] = ltrim($queryMapping['resultClass'], '\\');
  2934.         }
  2936.         $this->namedNativeQueries[$queryMapping['name']] = $queryMapping;
  2937.     }
  2939.     /**
  2940.      * INTERNAL:
  2941.      * Adds a sql result set mapping to this class.
  2942.      *
  2943.      * @psalm-param array<string, mixed> $resultMapping
  2944.      *
  2945.      * @return void
  2946.      *
  2947.      * @throws MappingException
  2948.      */
  2949.     public function addSqlResultSetMapping(array $resultMapping)
  2950.     {
  2951.         if (! isset($resultMapping['name'])) {
  2952.             throw MappingException::nameIsMandatoryForSqlResultSetMapping($this->name);
  2953.         }
  2955.         if (isset($this->sqlResultSetMappings[$resultMapping['name']])) {
  2956.             throw MappingException::duplicateResultSetMapping($this->name, $resultMapping['name']);
  2957.         }
  2959.         if (isset($resultMapping['entities'])) {
  2960.             foreach ($resultMapping['entities'] as $key => $entityResult) {
  2961.                 if (! isset($entityResult['entityClass'])) {
  2962.                     throw MappingException::missingResultSetMappingEntity($this->name, $resultMapping['name']);
  2963.                 }
  2965.                 $entityResult['isSelfClass'] = false;
  2966.                 if ($entityResult['entityClass'] === '__CLASS__') {
  2967.                     $entityResult['isSelfClass'] = true;
  2968.                     $entityResult['entityClass'] = $this->name;
  2969.                 }
  2971.                 $entityResult['entityClass'] = $this->fullyQualifiedClassName($entityResult['entityClass']);
  2973.                 $resultMapping['entities'][$key]['entityClass'] = ltrim($entityResult['entityClass'], '\\');
  2974.                 $resultMapping['entities'][$key]['isSelfClass'] = $entityResult['isSelfClass'];
  2976.                 if (isset($entityResult['fields'])) {
  2977.                     foreach ($entityResult['fields'] as $k => $field) {
  2978.                         if (! isset($field['name'])) {
  2979.                             throw MappingException::missingResultSetMappingFieldName($this->name, $resultMapping['name']);
  2980.                         }
  2982.                         if (! isset($field['column'])) {
  2983.                             $fieldName = $field['name'];
  2984.                             if (str_contains($fieldName, '.')) {
  2985.                                 [, $fieldName] = explode('.', $fieldName);
  2986.                             }
  2988.                             $resultMapping['entities'][$key]['fields'][$k]['column'] = $fieldName;
  2989.                         }
  2990.                     }
  2991.                 }
  2992.             }
  2993.         }
  2995.         $this->sqlResultSetMappings[$resultMapping['name']] = $resultMapping;
  2996.     }
  2998.     /**
  2999.      * Adds a one-to-one mapping.
  3000.      *
  3001.      * @param array<string, mixed> $mapping The mapping.
  3002.      *
  3003.      * @return void
  3004.      */
  3005.     public function mapOneToOne(array $mapping)
  3006.     {
  3007.         $mapping['type'] = self::ONE_TO_ONE;
  3009.         $mapping = $this->_validateAndCompleteOneToOneMapping($mapping);
  3011.         $this->_storeAssociationMapping($mapping);
  3012.     }
  3014.     /**
  3015.      * Adds a one-to-many mapping.
  3016.      *
  3017.      * @psalm-param array<string, mixed> $mapping The mapping.
  3018.      *
  3019.      * @return void
  3020.      */
  3021.     public function mapOneToMany(array $mapping)
  3022.     {
  3023.         $mapping['type'] = self::ONE_TO_MANY;
  3025.         $mapping = $this->_validateAndCompleteOneToManyMapping($mapping);
  3027.         $this->_storeAssociationMapping($mapping);
  3028.     }
  3030.     /**
  3031.      * Adds a many-to-one mapping.
  3032.      *
  3033.      * @psalm-param array<string, mixed> $mapping The mapping.
  3034.      *
  3035.      * @return void
  3036.      */
  3037.     public function mapManyToOne(array $mapping)
  3038.     {
  3039.         $mapping['type'] = self::MANY_TO_ONE;
  3041.         // A many-to-one mapping is essentially a one-one backreference
  3042.         $mapping = $this->_validateAndCompleteOneToOneMapping($mapping);
  3044.         $this->_storeAssociationMapping($mapping);
  3045.     }
  3047.     /**
  3048.      * Adds a many-to-many mapping.
  3049.      *
  3050.      * @psalm-param array<string, mixed> $mapping The mapping.
  3051.      *
  3052.      * @return void
  3053.      */
  3054.     public function mapManyToMany(array $mapping)
  3055.     {
  3056.         $mapping['type'] = self::MANY_TO_MANY;
  3058.         $mapping = $this->_validateAndCompleteManyToManyMapping($mapping);
  3060.         $this->_storeAssociationMapping($mapping);
  3061.     }
  3063.     /**
  3064.      * Stores the association mapping.
  3065.      *
  3066.      * @psalm-param array<string, mixed> $assocMapping
  3067.      *
  3068.      * @return void
  3069.      *
  3070.      * @throws MappingException
  3071.      */
  3072.     protected function _storeAssociationMapping(array $assocMapping)
  3073.     {
  3074.         $sourceFieldName = $assocMapping['fieldName'];
  3076.         $this->assertFieldNotMapped($sourceFieldName);
  3078.         $this->associationMappings[$sourceFieldName] = $assocMapping;
  3079.     }
  3081.     /**
  3082.      * Registers a custom repository class for the entity class.
  3083.      *
  3084.      * @param string|null $repositoryClassName The class name of the custom mapper.
  3085.      * @psalm-param class-string<EntityRepository>|null $repositoryClassName
  3086.      *
  3087.      * @return void
  3088.      */
  3089.     public function setCustomRepositoryClass($repositoryClassName)
  3090.     {
  3091.         $this->customRepositoryClassName = $this->fullyQualifiedClassName($repositoryClassName);
  3092.     }
  3094.     /**
  3095.      * Dispatches the lifecycle event of the given entity to the registered
  3096.      * lifecycle callbacks and lifecycle listeners.
  3097.      *
  3098.      * @deprecated Deprecated since version 2.4 in favor of \Doctrine\ORM\Event\ListenersInvoker
  3099.      *
  3100.      * @param string $lifecycleEvent The lifecycle event.
  3101.      * @param object $entity         The Entity on which the event occurred.
  3102.      *
  3103.      * @return void
  3104.      */
  3105.     public function invokeLifecycleCallbacks($lifecycleEvent, $entity)
  3106.     {
  3107.         foreach ($this->lifecycleCallbacks[$lifecycleEvent] as $callback) {
  3108.             $entity->$callback();
  3109.         }
  3110.     }
  3112.     /**
  3113.      * Whether the class has any attached lifecycle listeners or callbacks for a lifecycle event.
  3114.      *
  3115.      * @param string $lifecycleEvent
  3116.      *
  3117.      * @return bool
  3118.      */
  3119.     public function hasLifecycleCallbacks($lifecycleEvent)
  3120.     {
  3121.         return isset($this->lifecycleCallbacks[$lifecycleEvent]);
  3122.     }
  3124.     /**
  3125.      * Gets the registered lifecycle callbacks for an event.
  3126.      *
  3127.      * @param string $event
  3128.      *
  3129.      * @return string[]
  3130.      * @psalm-return list<string>
  3131.      */
  3132.     public function getLifecycleCallbacks($event)
  3133.     {
  3134.         return $this->lifecycleCallbacks[$event] ?? [];
  3135.     }
  3137.     /**
  3138.      * Adds a lifecycle callback for entities of this class.
  3139.      *
  3140.      * @param string $callback
  3141.      * @param string $event
  3142.      *
  3143.      * @return void
  3144.      */
  3145.     public function addLifecycleCallback($callback, $event)
  3146.     {
  3147.         if ($this->isEmbeddedClass) {
  3148.             Deprecation::trigger(
  3149.                 'doctrine/orm',
  3150.                 'https://github.com/doctrine/orm/pull/8381',
  3151.                 'Registering lifecycle callback %s on Embedded class %s is not doing anything and will throw exception in 3.0',
  3152.                 $event,
  3153.                 $this->name
  3154.             );
  3155.         }
  3157.         if (isset($this->lifecycleCallbacks[$event]) && in_array($callback, $this->lifecycleCallbacks[$event], true)) {
  3158.             return;
  3159.         }
  3161.         $this->lifecycleCallbacks[$event][] = $callback;
  3162.     }
  3164.     /**
  3165.      * Sets the lifecycle callbacks for entities of this class.
  3166.      * Any previously registered callbacks are overwritten.
  3167.      *
  3168.      * @psalm-param array<string, list<string>> $callbacks
  3169.      *
  3170.      * @return void
  3171.      */
  3172.     public function setLifecycleCallbacks(array $callbacks)
  3173.     {
  3174.         $this->lifecycleCallbacks = $callbacks;
  3175.     }
  3177.     /**
  3178.      * Adds a entity listener for entities of this class.
  3179.      *
  3180.      * @param string $eventName The entity lifecycle event.
  3181.      * @param string $class     The listener class.
  3182.      * @param string $method    The listener callback method.
  3183.      *
  3184.      * @return void
  3185.      *
  3186.      * @throws MappingException
  3187.      */
  3188.     public function addEntityListener($eventName, $class, $method)
  3189.     {
  3190.         $class = $this->fullyQualifiedClassName($class);
  3192.         $listener = [
  3193.             'class'  => $class,
  3194.             'method' => $method,
  3195.         ];
  3197.         if (! class_exists($class)) {
  3198.             throw MappingException::entityListenerClassNotFound($class, $this->name);
  3199.         }
  3201.         if (! method_exists($class, $method)) {
  3202.             throw MappingException::entityListenerMethodNotFound($class, $method, $this->name);
  3203.         }
  3205.         if (isset($this->entityListeners[$eventName]) && in_array($listener, $this->entityListeners[$eventName], true)) {
  3206.             throw MappingException::duplicateEntityListener($class, $method, $this->name);
  3207.         }
  3209.         $this->entityListeners[$eventName][] = $listener;
  3210.     }
  3212.     /**
  3213.      * Sets the discriminator column definition.
  3214.      *
  3215.      * @see getDiscriminatorColumn()
  3216.      *
  3217.      * @param mixed[]|null $columnDef
  3218.      * @psalm-param array<string, mixed>|null $columnDef
  3219.      *
  3220.      * @return void
  3221.      *
  3222.      * @throws MappingException
  3223.      */
  3224.     public function setDiscriminatorColumn($columnDef)
  3225.     {
  3226.         if ($columnDef !== null) {
  3227.             if (! isset($columnDef['name'])) {
  3228.                 throw MappingException::nameIsMandatoryForDiscriminatorColumns($this->name);
  3229.             }
  3231.             if (isset($this->fieldNames[$columnDef['name']])) {
  3232.                 throw MappingException::duplicateColumnName($this->name, $columnDef['name']);
  3233.             }
  3235.             if (! isset($columnDef['fieldName'])) {
  3236.                 $columnDef['fieldName'] = $columnDef['name'];
  3237.             }
  3239.             if (! isset($columnDef['type'])) {
  3240.                 $columnDef['type'] = 'string';
  3241.             }
  3243.             if (in_array($columnDef['type'], ['boolean', 'array', 'object', 'datetime', 'time', 'date'], true)) {
  3244.                 throw MappingException::invalidDiscriminatorColumnType($this->name, $columnDef['type']);
  3245.             }
  3247.             $this->discriminatorColumn = $columnDef;
  3248.         }
  3249.     }
  3251.     /**
  3252.      * @return array<string, mixed>
  3253.      */
  3254.     final public function getDiscriminatorColumn(): array
  3255.     {
  3256.         if ($this->discriminatorColumn === null) {
  3257.             throw new LogicException('The discriminator column was not set.');
  3258.         }
  3260.         return $this->discriminatorColumn;
  3261.     }
  3263.     /**
  3264.      * Sets the discriminator values used by this class.
  3265.      * Used for JOINED and SINGLE_TABLE inheritance mapping strategies.
  3266.      *
  3267.      * @param array<int|string, string> $map
  3268.      *
  3269.      * @return void
  3270.      */
  3271.     public function setDiscriminatorMap(array $map)
  3272.     {
  3273.         foreach ($map as $value => $className) {
  3274.             $this->addDiscriminatorMapClass($value, $className);
  3275.         }
  3276.     }
  3278.     /**
  3279.      * Adds one entry of the discriminator map with a new class and corresponding name.
  3280.      *
  3281.      * @param int|string $name
  3282.      * @param string     $className
  3283.      *
  3284.      * @return void
  3285.      *
  3286.      * @throws MappingException
  3287.      */
  3288.     public function addDiscriminatorMapClass($name, $className)
  3289.     {
  3290.         $className = $this->fullyQualifiedClassName($className);
  3291.         $className = ltrim($className, '\\');
  3293.         $this->discriminatorMap[$name] = $className;
  3295.         if ($this->name === $className) {
  3296.             $this->discriminatorValue = $name;
  3298.             return;
  3299.         }
  3301.         if (! (class_exists($className) || interface_exists($className))) {
  3302.             throw MappingException::invalidClassInDiscriminatorMap($className, $this->name);
  3303.         }
  3305.         if (is_subclass_of($className, $this->name) && ! in_array($className, $this->subClasses, true)) {
  3306.             $this->subClasses[] = $className;
  3307.         }
  3308.     }
  3310.     /**
  3311.      * Checks whether the class has a named query with the given query name.
  3312.      *
  3313.      * @param string $queryName
  3314.      *
  3315.      * @return bool
  3316.      */
  3317.     public function hasNamedQuery($queryName)
  3318.     {
  3319.         return isset($this->namedQueries[$queryName]);
  3320.     }
  3322.     /**
  3323.      * Checks whether the class has a named native query with the given query name.
  3324.      *
  3325.      * @param string $queryName
  3326.      *
  3327.      * @return bool
  3328.      */
  3329.     public function hasNamedNativeQuery($queryName)
  3330.     {
  3331.         return isset($this->namedNativeQueries[$queryName]);
  3332.     }
  3334.     /**
  3335.      * Checks whether the class has a named native query with the given query name.
  3336.      *
  3337.      * @param string $name
  3338.      *
  3339.      * @return bool
  3340.      */
  3341.     public function hasSqlResultSetMapping($name)
  3342.     {
  3343.         return isset($this->sqlResultSetMappings[$name]);
  3344.     }
  3346.     /**
  3347.      * {@inheritDoc}
  3348.      */
  3349.     public function hasAssociation($fieldName)
  3350.     {
  3351.         return isset($this->associationMappings[$fieldName]);
  3352.     }
  3354.     /**
  3355.      * {@inheritDoc}
  3356.      */
  3357.     public function isSingleValuedAssociation($fieldName)
  3358.     {
  3359.         return isset($this->associationMappings[$fieldName])
  3360.             && ($this->associationMappings[$fieldName]['type'] & self::TO_ONE);
  3361.     }
  3363.     /**
  3364.      * {@inheritDoc}
  3365.      */
  3366.     public function isCollectionValuedAssociation($fieldName)
  3367.     {
  3368.         return isset($this->associationMappings[$fieldName])
  3369.             && ! ($this->associationMappings[$fieldName]['type'] & self::TO_ONE);
  3370.     }
  3372.     /**
  3373.      * Is this an association that only has a single join column?
  3374.      *
  3375.      * @param string $fieldName
  3376.      *
  3377.      * @return bool
  3378.      */
  3379.     public function isAssociationWithSingleJoinColumn($fieldName)
  3380.     {
  3381.         return isset($this->associationMappings[$fieldName])
  3382.             && isset($this->associationMappings[$fieldName]['joinColumns'][0])
  3383.             && ! isset($this->associationMappings[$fieldName]['joinColumns'][1]);
  3384.     }
  3386.     /**
  3387.      * Returns the single association join column (if any).
  3388.      *
  3389.      * @param string $fieldName
  3390.      *
  3391.      * @return string
  3392.      *
  3393.      * @throws MappingException
  3394.      */
  3395.     public function getSingleAssociationJoinColumnName($fieldName)
  3396.     {
  3397.         if (! $this->isAssociationWithSingleJoinColumn($fieldName)) {
  3398.             throw MappingException::noSingleAssociationJoinColumnFound($this->name, $fieldName);
  3399.         }
  3401.         return $this->associationMappings[$fieldName]['joinColumns'][0]['name'];
  3402.     }
  3404.     /**
  3405.      * Returns the single association referenced join column name (if any).
  3406.      *
  3407.      * @param string $fieldName
  3408.      *
  3409.      * @return string
  3410.      *
  3411.      * @throws MappingException
  3412.      */
  3413.     public function getSingleAssociationReferencedJoinColumnName($fieldName)
  3414.     {
  3415.         if (! $this->isAssociationWithSingleJoinColumn($fieldName)) {
  3416.             throw MappingException::noSingleAssociationJoinColumnFound($this->name, $fieldName);
  3417.         }
  3419.         return $this->associationMappings[$fieldName]['joinColumns'][0]['referencedColumnName'];
  3420.     }
  3422.     /**
  3423.      * Used to retrieve a fieldname for either field or association from a given column.
  3424.      *
  3425.      * This method is used in foreign-key as primary-key contexts.
  3426.      *
  3427.      * @param string $columnName
  3428.      *
  3429.      * @return string
  3430.      *
  3431.      * @throws MappingException
  3432.      */
  3433.     public function getFieldForColumn($columnName)
  3434.     {
  3435.         if (isset($this->fieldNames[$columnName])) {
  3436.             return $this->fieldNames[$columnName];
  3437.         }
  3439.         foreach ($this->associationMappings as $assocName => $mapping) {
  3440.             if (
  3441.                 $this->isAssociationWithSingleJoinColumn($assocName) &&
  3442.                 $this->associationMappings[$assocName]['joinColumns'][0]['name'] === $columnName
  3443.             ) {
  3444.                 return $assocName;
  3445.             }
  3446.         }
  3448.         throw MappingException::noFieldNameFoundForColumn($this->name, $columnName);
  3449.     }
  3451.     /**
  3452.      * Sets the ID generator used to generate IDs for instances of this class.
  3453.      *
  3454.      * @param AbstractIdGenerator $generator
  3455.      *
  3456.      * @return void
  3457.      */
  3458.     public function setIdGenerator($generator)
  3459.     {
  3460.         $this->idGenerator = $generator;
  3461.     }
  3463.     /**
  3464.      * Sets definition.
  3465.      *
  3466.      * @psalm-param array<string, string|null> $definition
  3467.      *
  3468.      * @return void
  3469.      */
  3470.     public function setCustomGeneratorDefinition(array $definition)
  3471.     {
  3472.         $this->customGeneratorDefinition = $definition;
  3473.     }
  3475.     /**
  3476.      * Sets the definition of the sequence ID generator for this class.
  3477.      *
  3478.      * The definition must have the following structure:
  3479.      * <code>
  3480.      * array(
  3481.      *     'sequenceName'   => 'name',
  3482.      *     'allocationSize' => 20,
  3483.      *     'initialValue'   => 1
  3484.      *     'quoted'         => 1
  3485.      * )
  3486.      * </code>
  3487.      *
  3488.      * @psalm-param array{sequenceName?: string, allocationSize?: int|string, initialValue?: int|string, quoted?: mixed} $definition
  3489.      *
  3490.      * @return void
  3491.      *
  3492.      * @throws MappingException
  3493.      */
  3494.     public function setSequenceGeneratorDefinition(array $definition)
  3495.     {
  3496.         if (! isset($definition['sequenceName']) || trim($definition['sequenceName']) === '') {
  3497.             throw MappingException::missingSequenceName($this->name);
  3498.         }
  3500.         if ($definition['sequenceName'][0] === '`') {
  3501.             $definition['sequenceName'] = trim($definition['sequenceName'], '`');
  3502.             $definition['quoted']       = true;
  3503.         }
  3505.         if (! isset($definition['allocationSize']) || trim((string) $definition['allocationSize']) === '') {
  3506.             $definition['allocationSize'] = '1';
  3507.         }
  3509.         if (! isset($definition['initialValue']) || trim((string) $definition['initialValue']) === '') {
  3510.             $definition['initialValue'] = '1';
  3511.         }
  3513.         $definition['allocationSize'] = (string) $definition['allocationSize'];
  3514.         $definition['initialValue']   = (string) $definition['initialValue'];
  3516.         $this->sequenceGeneratorDefinition = $definition;
  3517.     }
  3519.     /**
  3520.      * Sets the version field mapping used for versioning. Sets the default
  3521.      * value to use depending on the column type.
  3522.      *
  3523.      * @psalm-param array<string, mixed> $mapping The version field mapping array.
  3524.      *
  3525.      * @return void
  3526.      *
  3527.      * @throws MappingException
  3528.      */
  3529.     public function setVersionMapping(array &$mapping)
  3530.     {
  3531.         $this->isVersioned              = true;
  3532.         $this->versionField             = $mapping['fieldName'];
  3533.         $this->requiresFetchAfterChange = true;
  3535.         if (! isset($mapping['default'])) {
  3536.             if (in_array($mapping['type'], ['integer', 'bigint', 'smallint'], true)) {
  3537.                 $mapping['default'] = 1;
  3538.             } elseif ($mapping['type'] === 'datetime') {
  3539.                 $mapping['default'] = 'CURRENT_TIMESTAMP';
  3540.             } else {
  3541.                 throw MappingException::unsupportedOptimisticLockingType($this->name, $mapping['fieldName'], $mapping['type']);
  3542.             }
  3543.         }
  3544.     }
  3546.     /**
  3547.      * Sets whether this class is to be versioned for optimistic locking.
  3548.      *
  3549.      * @param bool $bool
  3550.      *
  3551.      * @return void
  3552.      */
  3553.     public function setVersioned($bool)
  3554.     {
  3555.         $this->isVersioned = $bool;
  3557.         if ($bool) {
  3558.             $this->requiresFetchAfterChange = true;
  3559.         }
  3560.     }
  3562.     /**
  3563.      * Sets the name of the field that is to be used for versioning if this class is
  3564.      * versioned for optimistic locking.
  3565.      *
  3566.      * @param string|null $versionField
  3567.      *
  3568.      * @return void
  3569.      */
  3570.     public function setVersionField($versionField)
  3571.     {
  3572.         $this->versionField = $versionField;
  3573.     }
  3575.     /**
  3576.      * Marks this class as read only, no change tracking is applied to it.
  3577.      *
  3578.      * @return void
  3579.      */
  3580.     public function markReadOnly()
  3581.     {
  3582.         $this->isReadOnly = true;
  3583.     }
  3585.     /**
  3586.      * {@inheritDoc}
  3587.      */
  3588.     public function getFieldNames()
  3589.     {
  3590.         return array_keys($this->fieldMappings);
  3591.     }
  3593.     /**
  3594.      * {@inheritDoc}
  3595.      */
  3596.     public function getAssociationNames()
  3597.     {
  3598.         return array_keys($this->associationMappings);
  3599.     }
  3601.     /**
  3602.      * {@inheritDoc}
  3603.      *
  3604.      * @param string $assocName
  3605.      *
  3606.      * @return string
  3607.      * @psalm-return class-string
  3608.      *
  3609.      * @throws InvalidArgumentException
  3610.      */
  3611.     public function getAssociationTargetClass($assocName)
  3612.     {
  3613.         if (! isset($this->associationMappings[$assocName])) {
  3614.             throw new InvalidArgumentException("Association name expected, '" . $assocName . "' is not an association.");
  3615.         }
  3617.         return $this->associationMappings[$assocName]['targetEntity'];
  3618.     }
  3620.     /**
  3621.      * {@inheritDoc}
  3622.      */
  3623.     public function getName()
  3624.     {
  3625.         return $this->name;
  3626.     }
  3628.     /**
  3629.      * Gets the (possibly quoted) identifier column names for safe use in an SQL statement.
  3630.      *
  3631.      * @deprecated Deprecated since version 2.3 in favor of \Doctrine\ORM\Mapping\QuoteStrategy
  3632.      *
  3633.      * @param AbstractPlatform $platform
  3634.      *
  3635.      * @return string[]
  3636.      * @psalm-return list<string>
  3637.      */
  3638.     public function getQuotedIdentifierColumnNames($platform)
  3639.     {
  3640.         $quotedColumnNames = [];
  3642.         foreach ($this->identifier as $idProperty) {
  3643.             if (isset($this->fieldMappings[$idProperty])) {
  3644.                 $quotedColumnNames[] = isset($this->fieldMappings[$idProperty]['quoted'])
  3645.                     ? $platform->quoteIdentifier($this->fieldMappings[$idProperty]['columnName'])
  3646.                     : $this->fieldMappings[$idProperty]['columnName'];
  3648.                 continue;
  3649.             }
  3651.             // Association defined as Id field
  3652.             $joinColumns            = $this->associationMappings[$idProperty]['joinColumns'];
  3653.             $assocQuotedColumnNames = array_map(
  3654.                 static function ($joinColumn) use ($platform) {
  3655.                     return isset($joinColumn['quoted'])
  3656.                         ? $platform->quoteIdentifier($joinColumn['name'])
  3657.                         : $joinColumn['name'];
  3658.                 },
  3659.                 $joinColumns
  3660.             );
  3662.             $quotedColumnNames = array_merge($quotedColumnNames, $assocQuotedColumnNames);
  3663.         }
  3665.         return $quotedColumnNames;
  3666.     }
  3668.     /**
  3669.      * Gets the (possibly quoted) column name of a mapped field for safe use  in an SQL statement.
  3670.      *
  3671.      * @deprecated Deprecated since version 2.3 in favor of \Doctrine\ORM\Mapping\QuoteStrategy
  3672.      *
  3673.      * @param string           $field
  3674.      * @param AbstractPlatform $platform
  3675.      *
  3676.      * @return string
  3677.      */
  3678.     public function getQuotedColumnName($field, $platform)
  3679.     {
  3680.         return isset($this->fieldMappings[$field]['quoted'])
  3681.             ? $platform->quoteIdentifier($this->fieldMappings[$field]['columnName'])
  3682.             : $this->fieldMappings[$field]['columnName'];
  3683.     }
  3685.     /**
  3686.      * Gets the (possibly quoted) primary table name of this class for safe use in an SQL statement.
  3687.      *
  3688.      * @deprecated Deprecated since version 2.3 in favor of \Doctrine\ORM\Mapping\QuoteStrategy
  3689.      *
  3690.      * @param AbstractPlatform $platform
  3691.      *
  3692.      * @return string
  3693.      */
  3694.     public function getQuotedTableName($platform)
  3695.     {
  3696.         return isset($this->table['quoted'])
  3697.             ? $platform->quoteIdentifier($this->table['name'])
  3698.             : $this->table['name'];
  3699.     }
  3701.     /**
  3702.      * Gets the (possibly quoted) name of the join table.
  3703.      *
  3704.      * @deprecated Deprecated since version 2.3 in favor of \Doctrine\ORM\Mapping\QuoteStrategy
  3705.      *
  3706.      * @param mixed[]          $assoc
  3707.      * @param AbstractPlatform $platform
  3708.      *
  3709.      * @return string
  3710.      */
  3711.     public function getQuotedJoinTableName(array $assoc, $platform)
  3712.     {
  3713.         return isset($assoc['joinTable']['quoted'])
  3714.             ? $platform->quoteIdentifier($assoc['joinTable']['name'])
  3715.             : $assoc['joinTable']['name'];
  3716.     }
  3718.     /**
  3719.      * {@inheritDoc}
  3720.      */
  3721.     public function isAssociationInverseSide($fieldName)
  3722.     {
  3723.         return isset($this->associationMappings[$fieldName])
  3724.             && ! $this->associationMappings[$fieldName]['isOwningSide'];
  3725.     }
  3727.     /**
  3728.      * {@inheritDoc}
  3729.      */
  3730.     public function getAssociationMappedByTargetField($fieldName)
  3731.     {
  3732.         return $this->associationMappings[$fieldName]['mappedBy'];
  3733.     }
  3735.     /**
  3736.      * @param string $targetClass
  3737.      *
  3738.      * @return mixed[][]
  3739.      * @psalm-return array<string, array<string, mixed>>
  3740.      */
  3741.     public function getAssociationsByTargetClass($targetClass)
  3742.     {
  3743.         $relations = [];
  3745.         foreach ($this->associationMappings as $mapping) {
  3746.             if ($mapping['targetEntity'] === $targetClass) {
  3747.                 $relations[$mapping['fieldName']] = $mapping;
  3748.             }
  3749.         }
  3751.         return $relations;
  3752.     }
  3754.     /**
  3755.      * @param string|null $className
  3756.      *
  3757.      * @return string|null null if the input value is null
  3758.      * @psalm-return class-string|null
  3759.      */
  3760.     public function fullyQualifiedClassName($className)
  3761.     {
  3762.         if (empty($className)) {
  3763.             return $className;
  3764.         }
  3766.         if (! str_contains($className, '\\') && $this->namespace) {
  3767.             return $this->namespace . '\\' . $className;
  3768.         }
  3770.         return $className;
  3771.     }
  3773.     /**
  3774.      * @param string $name
  3775.      *
  3776.      * @return mixed
  3777.      */
  3778.     public function getMetadataValue($name)
  3779.     {
  3780.         if (isset($this->$name)) {
  3781.             return $this->$name;
  3782.         }
  3784.         return null;
  3785.     }
  3787.     /**
  3788.      * Map Embedded Class
  3789.      *
  3790.      * @psalm-param array<string, mixed> $mapping
  3791.      *
  3792.      * @return void
  3793.      *
  3794.      * @throws MappingException
  3795.      */
  3796.     public function mapEmbedded(array $mapping)
  3797.     {
  3798.         $this->assertFieldNotMapped($mapping['fieldName']);
  3800.         if (! isset($mapping['class']) && $this->isTypedProperty($mapping['fieldName'])) {
  3801.             $type = $this->reflClass->getProperty($mapping['fieldName'])->getType();
  3802.             if ($type instanceof ReflectionNamedType) {
  3803.                 $mapping['class'] = $type->getName();
  3804.             }
  3805.         }
  3807.         $this->embeddedClasses[$mapping['fieldName']] = [
  3808.             'class' => $this->fullyQualifiedClassName($mapping['class']),
  3809.             'columnPrefix' => $mapping['columnPrefix'] ?? null,
  3810.             'declaredField' => $mapping['declaredField'] ?? null,
  3811.             'originalField' => $mapping['originalField'] ?? null,
  3812.         ];
  3813.     }
  3815.     /**
  3816.      * Inline the embeddable class
  3817.      *
  3818.      * @param string $property
  3819.      *
  3820.      * @return void
  3821.      */
  3822.     public function inlineEmbeddable($property, ClassMetadataInfo $embeddable)
  3823.     {
  3824.         foreach ($embeddable->fieldMappings as $fieldMapping) {
  3825.             $fieldMapping['originalClass'] = $fieldMapping['originalClass'] ?? $embeddable->name;
  3826.             $fieldMapping['declaredField'] = isset($fieldMapping['declaredField'])
  3827.                 ? $property . '.' . $fieldMapping['declaredField']
  3828.                 : $property;
  3829.             $fieldMapping['originalField'] = $fieldMapping['originalField'] ?? $fieldMapping['fieldName'];
  3830.             $fieldMapping['fieldName']     = $property . '.' . $fieldMapping['fieldName'];
  3832.             if (! empty($this->embeddedClasses[$property]['columnPrefix'])) {
  3833.                 $fieldMapping['columnName'] = $this->embeddedClasses[$property]['columnPrefix'] . $fieldMapping['columnName'];
  3834.             } elseif ($this->embeddedClasses[$property]['columnPrefix'] !== false) {
  3835.                 $fieldMapping['columnName'] = $this->namingStrategy
  3836.                     ->embeddedFieldToColumnName(
  3837.                         $property,
  3838.                         $fieldMapping['columnName'],
  3839.                         $this->reflClass->name,
  3840.                         $embeddable->reflClass->name
  3841.                     );
  3842.             }
  3844.             $this->mapField($fieldMapping);
  3845.         }
  3846.     }
  3848.     /**
  3849.      * @throws MappingException
  3850.      */
  3851.     private function assertFieldNotMapped(string $fieldName): void
  3852.     {
  3853.         if (
  3854.             isset($this->fieldMappings[$fieldName]) ||
  3855.             isset($this->associationMappings[$fieldName]) ||
  3856.             isset($this->embeddedClasses[$fieldName])
  3857.         ) {
  3858.             throw MappingException::duplicateFieldMapping($this->name, $fieldName);
  3859.         }
  3860.     }
  3862.     /**
  3863.      * Gets the sequence name based on class metadata.
  3864.      *
  3865.      * @return string
  3866.      *
  3867.      * @todo Sequence names should be computed in DBAL depending on the platform
  3868.      */
  3869.     public function getSequenceName(AbstractPlatform $platform)
  3870.     {
  3871.         $sequencePrefix = $this->getSequencePrefix($platform);
  3872.         $columnName     = $this->getSingleIdentifierColumnName();
  3874.         return $sequencePrefix . '_' . $columnName . '_seq';
  3875.     }
  3877.     /**
  3878.      * Gets the sequence name prefix based on class metadata.
  3879.      *
  3880.      * @return string
  3881.      *
  3882.      * @todo Sequence names should be computed in DBAL depending on the platform
  3883.      */
  3884.     public function getSequencePrefix(AbstractPlatform $platform)
  3885.     {
  3886.         $tableName      = $this->getTableName();
  3887.         $sequencePrefix = $tableName;
  3889.         // Prepend the schema name to the table name if there is one
  3890.         $schemaName = $this->getSchemaName();
  3891.         if ($schemaName) {
  3892.             $sequencePrefix = $schemaName . '.' . $tableName;
  3894.             if (! $platform->supportsSchemas() && $platform->canEmulateSchemas()) {
  3895.                 $sequencePrefix = $schemaName . '__' . $tableName;
  3896.             }
  3897.         }
  3899.         return $sequencePrefix;
  3900.     }
  3902.     /**
  3903.      * @psalm-param array<string, mixed> $mapping
  3904.      */
  3905.     private function assertMappingOrderBy(array $mapping): void
  3906.     {
  3907.         if (isset($mapping['orderBy']) && ! is_array($mapping['orderBy'])) {
  3908.             throw new InvalidArgumentException("'orderBy' is expected to be an array, not " . gettype($mapping['orderBy']));
  3909.         }
  3910.     }
  3912.     /**
  3913.      * @psalm-param class-string $class
  3914.      */
  3915.     private function getAccessibleProperty(ReflectionService $reflService, string $class, string $field): ?ReflectionProperty
  3916.     {
  3917.         $reflectionProperty = $reflService->getAccessibleProperty($class, $field);
  3918.         if ($reflectionProperty !== null && PHP_VERSION_ID >= 80100 && $reflectionProperty->isReadOnly()) {
  3919.             $reflectionProperty = new ReflectionReadonlyProperty($reflectionProperty);
  3920.         }
  3922.         return $reflectionProperty;
  3923.     }
  3924. }