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

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