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

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