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

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