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

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