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

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