1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496 |
- <?php
- /*
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- * This software consists of voluntary contributions made by many individuals
- * and is licensed under the MIT license. For more information, see
- * <http://www.doctrine-project.org>.
- */
- namespace Doctrine\ORM\Mapping;
- use BadMethodCallException;
- use Doctrine\DBAL\Platforms\AbstractPlatform;
- use Doctrine\DBAL\Types\Type;
- use Doctrine\Instantiator\Instantiator;
- use Doctrine\Instantiator\InstantiatorInterface;
- use Doctrine\ORM\Cache\CacheException;
- use Doctrine\ORM\Id\AbstractIdGenerator;
- use Doctrine\Persistence\Mapping\ClassMetadata;
- use Doctrine\Persistence\Mapping\ReflectionService;
- use InvalidArgumentException;
- use ReflectionClass;
- use ReflectionProperty;
- use RuntimeException;
- use function array_diff;
- use function array_flip;
- use function array_intersect;
- use function array_keys;
- use function array_map;
- use function array_merge;
- use function array_pop;
- use function array_values;
- use function class_exists;
- use function count;
- use function explode;
- use function gettype;
- use function in_array;
- use function interface_exists;
- use function is_array;
- use function is_subclass_of;
- use function ltrim;
- use function method_exists;
- use function spl_object_hash;
- use function str_replace;
- use function strpos;
- use function strtolower;
- use function trait_exists;
- use function trim;
- /**
- * A <tt>ClassMetadata</tt> instance holds all the object-relational mapping metadata
- * of an entity and its associations.
- *
- * Once populated, ClassMetadata instances are usually cached in a serialized form.
- *
- * <b>IMPORTANT NOTE:</b>
- *
- * The fields of this class are only public for 2 reasons:
- * 1) To allow fast READ access.
- * 2) To drastically reduce the size of a serialized instance (private/protected members
- * get the whole class name, namespace inclusive, prepended to every property in
- * the serialized representation).
- */
- class ClassMetadataInfo implements ClassMetadata
- {
- /* The inheritance mapping types */
- /**
- * NONE means the class does not participate in an inheritance hierarchy
- * and therefore does not need an inheritance mapping type.
- */
- public const INHERITANCE_TYPE_NONE = 1;
- /**
- * JOINED means the class will be persisted according to the rules of
- * <tt>Class Table Inheritance</tt>.
- */
- public const INHERITANCE_TYPE_JOINED = 2;
- /**
- * SINGLE_TABLE means the class will be persisted according to the rules of
- * <tt>Single Table Inheritance</tt>.
- */
- public const INHERITANCE_TYPE_SINGLE_TABLE = 3;
- /**
- * TABLE_PER_CLASS means the class will be persisted according to the rules
- * of <tt>Concrete Table Inheritance</tt>.
- */
- public const INHERITANCE_TYPE_TABLE_PER_CLASS = 4;
- /* The Id generator types. */
- /**
- * AUTO means the generator type will depend on what the used platform prefers.
- * Offers full portability.
- */
- public const GENERATOR_TYPE_AUTO = 1;
- /**
- * SEQUENCE means a separate sequence object will be used. Platforms that do
- * not have native sequence support may emulate it. Full portability is currently
- * not guaranteed.
- */
- public const GENERATOR_TYPE_SEQUENCE = 2;
- /**
- * TABLE means a separate table is used for id generation.
- * Offers full portability.
- */
- public const GENERATOR_TYPE_TABLE = 3;
- /**
- * IDENTITY means an identity column is used for id generation. The database
- * will fill in the id column on insertion. Platforms that do not support
- * native identity columns may emulate them. Full portability is currently
- * not guaranteed.
- */
- public const GENERATOR_TYPE_IDENTITY = 4;
- /**
- * NONE means the class does not have a generated id. That means the class
- * must have a natural, manually assigned id.
- */
- public const GENERATOR_TYPE_NONE = 5;
- /**
- * UUID means that a UUID/GUID expression is used for id generation. Full
- * portability is currently not guaranteed.
- */
- public const GENERATOR_TYPE_UUID = 6;
- /**
- * CUSTOM means that customer will use own ID generator that supposedly work
- */
- public const GENERATOR_TYPE_CUSTOM = 7;
- /**
- * DEFERRED_IMPLICIT means that changes of entities are calculated at commit-time
- * by doing a property-by-property comparison with the original data. This will
- * be done for all entities that are in MANAGED state at commit-time.
- *
- * This is the default change tracking policy.
- */
- public const CHANGETRACKING_DEFERRED_IMPLICIT = 1;
- /**
- * DEFERRED_EXPLICIT means that changes of entities are calculated at commit-time
- * by doing a property-by-property comparison with the original data. This will
- * be done only for entities that were explicitly saved (through persist() or a cascade).
- */
- public const CHANGETRACKING_DEFERRED_EXPLICIT = 2;
- /**
- * NOTIFY means that Doctrine relies on the entities sending out notifications
- * when their properties change. Such entity classes must implement
- * the <tt>NotifyPropertyChanged</tt> interface.
- */
- public const CHANGETRACKING_NOTIFY = 3;
- /**
- * Specifies that an association is to be fetched when it is first accessed.
- */
- public const FETCH_LAZY = 2;
- /**
- * Specifies that an association is to be fetched when the owner of the
- * association is fetched.
- */
- public const FETCH_EAGER = 3;
- /**
- * Specifies that an association is to be fetched lazy (on first access) and that
- * commands such as Collection#count, Collection#slice are issued directly against
- * the database if the collection is not yet initialized.
- */
- public const FETCH_EXTRA_LAZY = 4;
- /**
- * Identifies a one-to-one association.
- */
- public const ONE_TO_ONE = 1;
- /**
- * Identifies a many-to-one association.
- */
- public const MANY_TO_ONE = 2;
- /**
- * Identifies a one-to-many association.
- */
- public const ONE_TO_MANY = 4;
- /**
- * Identifies a many-to-many association.
- */
- public const MANY_TO_MANY = 8;
- /**
- * Combined bitmask for to-one (single-valued) associations.
- */
- public const TO_ONE = 3;
- /**
- * Combined bitmask for to-many (collection-valued) associations.
- */
- public const TO_MANY = 12;
- /**
- * ReadOnly cache can do reads, inserts and deletes, cannot perform updates or employ any locks,
- */
- public const CACHE_USAGE_READ_ONLY = 1;
- /**
- * Nonstrict Read Write Cache doesn’t employ any locks but can do inserts, update and deletes.
- */
- public const CACHE_USAGE_NONSTRICT_READ_WRITE = 2;
- /**
- * Read Write Attempts to lock the entity before update/delete.
- */
- public const CACHE_USAGE_READ_WRITE = 3;
- /**
- * READ-ONLY: The name of the entity class.
- *
- * @var string
- */
- public $name;
- /**
- * READ-ONLY: The namespace the entity class is contained in.
- *
- * @var string
- * @todo Not really needed. Usage could be localized.
- */
- public $namespace;
- /**
- * READ-ONLY: The name of the entity class that is at the root of the mapped entity inheritance
- * hierarchy. If the entity is not part of a mapped inheritance hierarchy this is the same
- * as {@link $name}.
- *
- * @var string
- */
- public $rootEntityName;
- /**
- * READ-ONLY: The definition of custom generator. Only used for CUSTOM
- * generator type
- *
- * The definition has the following structure:
- * <code>
- * array(
- * 'class' => 'ClassName',
- * )
- * </code>
- *
- * @todo Merge with tableGeneratorDefinition into generic generatorDefinition
- * @var array<string, string>|null
- */
- public $customGeneratorDefinition;
- /**
- * The name of the custom repository class used for the entity class.
- * (Optional).
- *
- * @var string|null
- * @psalm-var ?class-string
- */
- public $customRepositoryClassName;
- /**
- * READ-ONLY: Whether this class describes the mapping of a mapped superclass.
- *
- * @var bool
- */
- public $isMappedSuperclass = false;
- /**
- * READ-ONLY: Whether this class describes the mapping of an embeddable class.
- *
- * @var bool
- */
- public $isEmbeddedClass = false;
- /**
- * READ-ONLY: The names of the parent classes (ancestors).
- *
- * @psalm-var list<class-string>
- */
- public $parentClasses = [];
- /**
- * READ-ONLY: The names of all subclasses (descendants).
- *
- * @psalm-var list<class-string>
- */
- public $subClasses = [];
- /**
- * READ-ONLY: The names of all embedded classes based on properties.
- *
- * @psalm-var array<string, mixed[]>
- */
- public $embeddedClasses = [];
- /**
- * READ-ONLY: The named queries allowed to be called directly from Repository.
- *
- * @psalm-var array<string, array<string, mixed>>
- */
- public $namedQueries = [];
- /**
- * READ-ONLY: The named native queries allowed to be called directly from Repository.
- *
- * A native SQL named query definition has the following structure:
- * <pre>
- * array(
- * 'name' => <query name>,
- * 'query' => <sql query>,
- * 'resultClass' => <class of the result>,
- * 'resultSetMapping' => <name of a SqlResultSetMapping>
- * )
- * </pre>
- *
- * @psalm-var array<string, array<string, mixed>>
- */
- public $namedNativeQueries = [];
- /**
- * READ-ONLY: The mappings of the results of native SQL queries.
- *
- * A native result mapping definition has the following structure:
- * <pre>
- * array(
- * 'name' => <result name>,
- * 'entities' => array(<entity result mapping>),
- * 'columns' => array(<column result mapping>)
- * )
- * </pre>
- *
- * @psalm-var array<string, array{
- * name: string,
- * entities: mixed[],
- * columns: mixed[]
- * }>
- */
- public $sqlResultSetMappings = [];
- /**
- * READ-ONLY: The field names of all fields that are part of the identifier/primary key
- * of the mapped entity class.
- *
- * @psalm-var list<string>
- */
- public $identifier = [];
- /**
- * READ-ONLY: The inheritance mapping type used by the class.
- *
- * @var int
- */
- public $inheritanceType = self::INHERITANCE_TYPE_NONE;
- /**
- * READ-ONLY: The Id generator type used by the class.
- *
- * @var int
- */
- public $generatorType = self::GENERATOR_TYPE_NONE;
- /**
- * READ-ONLY: The field mappings of the class.
- * Keys are field names and values are mapping definitions.
- *
- * The mapping definition array has the following values:
- *
- * - <b>fieldName</b> (string)
- * The name of the field in the Entity.
- *
- * - <b>type</b> (string)
- * The type name of the mapped field. Can be one of Doctrine's mapping types
- * or a custom mapping type.
- *
- * - <b>columnName</b> (string, optional)
- * The column name. Optional. Defaults to the field name.
- *
- * - <b>length</b> (integer, optional)
- * The database length of the column. Optional. Default value taken from
- * the type.
- *
- * - <b>id</b> (boolean, optional)
- * Marks the field as the primary key of the entity. Multiple fields of an
- * entity can have the id attribute, forming a composite key.
- *
- * - <b>nullable</b> (boolean, optional)
- * Whether the column is nullable. Defaults to FALSE.
- *
- * - <b>columnDefinition</b> (string, optional, schema-only)
- * The SQL fragment that is used when generating the DDL for the column.
- *
- * - <b>precision</b> (integer, optional, schema-only)
- * The precision of a decimal column. Only valid if the column type is decimal.
- *
- * - <b>scale</b> (integer, optional, schema-only)
- * The scale of a decimal column. Only valid if the column type is decimal.
- *
- * - <b>'unique'</b> (string, optional, schema-only)
- * Whether a unique constraint should be generated for the column.
- *
- * @psalm-var array<string, array{
- * type: string,
- * fieldName: string,
- * columnName?: string,
- * length?: int,
- * id?: bool,
- * nullable?: bool,
- * columnDefinition?: string,
- * precision?: int,
- * scale?: int,
- * unique?: string,
- * inherited?: class-string,
- * originalClass?: class-string,
- * originalField?: string,
- * quoted?: bool,
- * requireSQLConversion?: bool,
- * }>
- */
- public $fieldMappings = [];
- /**
- * READ-ONLY: An array of field names. Used to look up field names from column names.
- * Keys are column names and values are field names.
- *
- * @psalm-var array<string, string>
- */
- public $fieldNames = [];
- /**
- * READ-ONLY: A map of field names to column names. Keys are field names and values column names.
- * Used to look up column names from field names.
- * This is the reverse lookup map of $_fieldNames.
- *
- * @deprecated 3.0 Remove this.
- *
- * @var mixed[]
- */
- public $columnNames = [];
- /**
- * READ-ONLY: The discriminator value of this class.
- *
- * <b>This does only apply to the JOINED and SINGLE_TABLE inheritance mapping strategies
- * where a discriminator column is used.</b>
- *
- * @see discriminatorColumn
- *
- * @var mixed
- */
- public $discriminatorValue;
- /**
- * READ-ONLY: The discriminator map of all mapped classes in the hierarchy.
- *
- * <b>This does only apply to the JOINED and SINGLE_TABLE inheritance mapping strategies
- * where a discriminator column is used.</b>
- *
- * @see discriminatorColumn
- *
- * @var mixed
- */
- public $discriminatorMap = [];
- /**
- * READ-ONLY: The definition of the discriminator column used in JOINED and SINGLE_TABLE
- * inheritance mappings.
- *
- * @psalm-var array<string, mixed>
- */
- public $discriminatorColumn;
- /**
- * READ-ONLY: The primary table definition. The definition is an array with the
- * following entries:
- *
- * name => <tableName>
- * schema => <schemaName>
- * indexes => array
- * uniqueConstraints => array
- *
- * @psalm-var array<string, mixed>
- */
- public $table;
- /**
- * READ-ONLY: The registered lifecycle callbacks for entities of this class.
- *
- * @psalm-var array<string, list<string>>
- */
- public $lifecycleCallbacks = [];
- /**
- * READ-ONLY: The registered entity listeners.
- *
- * @psalm-var array<string, list<array{class: class-string, method: string}>>
- */
- public $entityListeners = [];
- /**
- * READ-ONLY: The association mappings of this class.
- *
- * The mapping definition array supports the following keys:
- *
- * - <b>fieldName</b> (string)
- * The name of the field in the entity the association is mapped to.
- *
- * - <b>targetEntity</b> (string)
- * The class name of the target entity. If it is fully-qualified it is used as is.
- * If it is a simple, unqualified class name the namespace is assumed to be the same
- * as the namespace of the source entity.
- *
- * - <b>mappedBy</b> (string, required for bidirectional associations)
- * The name of the field that completes the bidirectional association on the owning side.
- * This key must be specified on the inverse side of a bidirectional association.
- *
- * - <b>inversedBy</b> (string, required for bidirectional associations)
- * The name of the field that completes the bidirectional association on the inverse side.
- * This key must be specified on the owning side of a bidirectional association.
- *
- * - <b>cascade</b> (array, optional)
- * The names of persistence operations to cascade on the association. The set of possible
- * values are: "persist", "remove", "detach", "merge", "refresh", "all" (implies all others).
- *
- * - <b>orderBy</b> (array, one-to-many/many-to-many only)
- * A map of field names (of the target entity) to sorting directions (ASC/DESC).
- * Example: array('priority' => 'desc')
- *
- * - <b>fetch</b> (integer, optional)
- * The fetching strategy to use for the association, usually defaults to FETCH_LAZY.
- * Possible values are: ClassMetadata::FETCH_EAGER, ClassMetadata::FETCH_LAZY.
- *
- * - <b>joinTable</b> (array, optional, many-to-many only)
- * Specification of the join table and its join columns (foreign keys).
- * Only valid for many-to-many mappings. Note that one-to-many associations can be mapped
- * through a join table by simply mapping the association as many-to-many with a unique
- * constraint on the join table.
- *
- * - <b>indexBy</b> (string, optional, to-many only)
- * Specification of a field on target-entity that is used to index the collection by.
- * This field HAS to be either the primary key or a unique column. Otherwise the collection
- * does not contain all the entities that are actually related.
- *
- * A join table definition has the following structure:
- * <pre>
- * array(
- * 'name' => <join table name>,
- * 'joinColumns' => array(<join column mapping from join table to source table>),
- * 'inverseJoinColumns' => array(<join column mapping from join table to target table>)
- * )
- * </pre>
- *
- * @psalm-var array<string, array<string, mixed>>
- */
- public $associationMappings = [];
- /**
- * READ-ONLY: Flag indicating whether the identifier/primary key of the class is composite.
- *
- * @var bool
- */
- public $isIdentifierComposite = false;
- /**
- * READ-ONLY: Flag indicating whether the identifier/primary key contains at least one foreign key association.
- *
- * This flag is necessary because some code blocks require special treatment of this cases.
- *
- * @var bool
- */
- public $containsForeignIdentifier = false;
- /**
- * READ-ONLY: The ID generator used for generating IDs for this class.
- *
- * @var AbstractIdGenerator
- * @todo Remove!
- */
- public $idGenerator;
- /**
- * READ-ONLY: The definition of the sequence generator of this class. Only used for the
- * SEQUENCE generation strategy.
- *
- * The definition has the following structure:
- * <code>
- * array(
- * 'sequenceName' => 'name',
- * 'allocationSize' => 20,
- * 'initialValue' => 1
- * )
- * </code>
- *
- * @psalm-var array<string, mixed>
- * @todo Merge with tableGeneratorDefinition into generic generatorDefinition
- */
- public $sequenceGeneratorDefinition;
- /**
- * READ-ONLY: The definition of the table generator of this class. Only used for the
- * TABLE generation strategy.
- *
- * @var array<string, mixed>
- * @todo Merge with tableGeneratorDefinition into generic generatorDefinition
- */
- public $tableGeneratorDefinition;
- /**
- * READ-ONLY: The policy used for change-tracking on entities of this class.
- *
- * @var int
- */
- public $changeTrackingPolicy = self::CHANGETRACKING_DEFERRED_IMPLICIT;
- /**
- * READ-ONLY: A flag for whether or not instances of this class are to be versioned
- * with optimistic locking.
- *
- * @var bool
- */
- public $isVersioned;
- /**
- * READ-ONLY: The name of the field which is used for versioning in optimistic locking (if any).
- *
- * @var mixed
- */
- public $versionField;
- /** @var mixed[] */
- public $cache = null;
- /**
- * The ReflectionClass instance of the mapped class.
- *
- * @var ReflectionClass
- */
- public $reflClass;
- /**
- * Is this entity marked as "read-only"?
- *
- * That means it is never considered for change-tracking in the UnitOfWork. It is a very helpful performance
- * optimization for entities that are immutable, either in your domain or through the relation database
- * (coming from a view, or a history table for example).
- *
- * @var bool
- */
- public $isReadOnly = false;
- /**
- * NamingStrategy determining the default column and table names.
- *
- * @var NamingStrategy
- */
- protected $namingStrategy;
- /**
- * The ReflectionProperty instances of the mapped class.
- *
- * @var ReflectionProperty[]|null[]
- */
- public $reflFields = [];
- /** @var InstantiatorInterface|null */
- private $instantiator;
- /**
- * Initializes a new ClassMetadata instance that will hold the object-relational mapping
- * metadata of the class with the given name.
- *
- * @param string $entityName The name of the entity class the new instance is used for.
- */
- public function __construct($entityName, ?NamingStrategy $namingStrategy = null)
- {
- $this->name = $entityName;
- $this->rootEntityName = $entityName;
- $this->namingStrategy = $namingStrategy ?: new DefaultNamingStrategy();
- $this->instantiator = new Instantiator();
- }
- /**
- * Gets the ReflectionProperties of the mapped class.
- *
- * @return ReflectionProperty[]|null[] An array of ReflectionProperty instances.
- *
- * @psalm-return array<ReflectionProperty|null>
- */
- public function getReflectionProperties()
- {
- return $this->reflFields;
- }
- /**
- * Gets a ReflectionProperty for a specific field of the mapped class.
- *
- * @param string $name
- *
- * @return ReflectionProperty
- */
- public function getReflectionProperty($name)
- {
- return $this->reflFields[$name];
- }
- /**
- * Gets the ReflectionProperty for the single identifier field.
- *
- * @return ReflectionProperty
- *
- * @throws BadMethodCallException If the class has a composite identifier.
- */
- public function getSingleIdReflectionProperty()
- {
- if ($this->isIdentifierComposite) {
- throw new BadMethodCallException('Class ' . $this->name . ' has a composite identifier.');
- }
- return $this->reflFields[$this->identifier[0]];
- }
- /**
- * Extracts the identifier values of an entity of this class.
- *
- * For composite identifiers, the identifier values are returned as an array
- * with the same order as the field order in {@link identifier}.
- *
- * @param object $entity
- *
- * @return array<string, mixed>
- */
- public function getIdentifierValues($entity)
- {
- if ($this->isIdentifierComposite) {
- $id = [];
- foreach ($this->identifier as $idField) {
- $value = $this->reflFields[$idField]->getValue($entity);
- if ($value !== null) {
- $id[$idField] = $value;
- }
- }
- return $id;
- }
- $id = $this->identifier[0];
- $value = $this->reflFields[$id]->getValue($entity);
- if ($value === null) {
- return [];
- }
- return [$id => $value];
- }
- /**
- * Populates the entity identifier of an entity.
- *
- * @param object $entity
- *
- * @return void
- *
- * @psalm-param array<string, mixed> $id
- * @todo Rename to assignIdentifier()
- */
- public function setIdentifierValues($entity, array $id)
- {
- foreach ($id as $idField => $idValue) {
- $this->reflFields[$idField]->setValue($entity, $idValue);
- }
- }
- /**
- * Sets the specified field to the specified value on the given entity.
- *
- * @param object $entity
- * @param string $field
- * @param mixed $value
- *
- * @return void
- */
- public function setFieldValue($entity, $field, $value)
- {
- $this->reflFields[$field]->setValue($entity, $value);
- }
- /**
- * Gets the specified field's value off the given entity.
- *
- * @param object $entity
- * @param string $field
- *
- * @return mixed
- */
- public function getFieldValue($entity, $field)
- {
- return $this->reflFields[$field]->getValue($entity);
- }
- /**
- * Creates a string representation of this instance.
- *
- * @return string The string representation of this instance.
- *
- * @todo Construct meaningful string representation.
- */
- public function __toString()
- {
- return self::class . '@' . spl_object_hash($this);
- }
- /**
- * Determines which fields get serialized.
- *
- * It is only serialized what is necessary for best unserialization performance.
- * That means any metadata properties that are not set or empty or simply have
- * their default value are NOT serialized.
- *
- * Parts that are also NOT serialized because they can not be properly unserialized:
- * - reflClass (ReflectionClass)
- * - reflFields (ReflectionProperty array)
- *
- * @return string[] The names of all the fields that should be serialized.
- */
- public function __sleep()
- {
- // This metadata is always serialized/cached.
- $serialized = [
- 'associationMappings',
- 'columnNames', //TODO: 3.0 Remove this. Can use fieldMappings[$fieldName]['columnName']
- 'fieldMappings',
- 'fieldNames',
- 'embeddedClasses',
- 'identifier',
- 'isIdentifierComposite', // TODO: REMOVE
- 'name',
- 'namespace', // TODO: REMOVE
- 'table',
- 'rootEntityName',
- 'idGenerator', //TODO: Does not really need to be serialized. Could be moved to runtime.
- ];
- // The rest of the metadata is only serialized if necessary.
- if ($this->changeTrackingPolicy !== self::CHANGETRACKING_DEFERRED_IMPLICIT) {
- $serialized[] = 'changeTrackingPolicy';
- }
- if ($this->customRepositoryClassName) {
- $serialized[] = 'customRepositoryClassName';
- }
- if ($this->inheritanceType !== self::INHERITANCE_TYPE_NONE) {
- $serialized[] = 'inheritanceType';
- $serialized[] = 'discriminatorColumn';
- $serialized[] = 'discriminatorValue';
- $serialized[] = 'discriminatorMap';
- $serialized[] = 'parentClasses';
- $serialized[] = 'subClasses';
- }
- if ($this->generatorType !== self::GENERATOR_TYPE_NONE) {
- $serialized[] = 'generatorType';
- if ($this->generatorType === self::GENERATOR_TYPE_SEQUENCE) {
- $serialized[] = 'sequenceGeneratorDefinition';
- }
- }
- if ($this->isMappedSuperclass) {
- $serialized[] = 'isMappedSuperclass';
- }
- if ($this->isEmbeddedClass) {
- $serialized[] = 'isEmbeddedClass';
- }
- if ($this->containsForeignIdentifier) {
- $serialized[] = 'containsForeignIdentifier';
- }
- if ($this->isVersioned) {
- $serialized[] = 'isVersioned';
- $serialized[] = 'versionField';
- }
- if ($this->lifecycleCallbacks) {
- $serialized[] = 'lifecycleCallbacks';
- }
- if ($this->entityListeners) {
- $serialized[] = 'entityListeners';
- }
- if ($this->namedQueries) {
- $serialized[] = 'namedQueries';
- }
- if ($this->namedNativeQueries) {
- $serialized[] = 'namedNativeQueries';
- }
- if ($this->sqlResultSetMappings) {
- $serialized[] = 'sqlResultSetMappings';
- }
- if ($this->isReadOnly) {
- $serialized[] = 'isReadOnly';
- }
- if ($this->customGeneratorDefinition) {
- $serialized[] = 'customGeneratorDefinition';
- }
- if ($this->cache) {
- $serialized[] = 'cache';
- }
- return $serialized;
- }
- /**
- * Creates a new instance of the mapped class, without invoking the constructor.
- *
- * @return object
- */
- public function newInstance()
- {
- return $this->instantiator->instantiate($this->name);
- }
- /**
- * Restores some state that can not be serialized/unserialized.
- *
- * @param ReflectionService $reflService
- *
- * @return void
- */
- public function wakeupReflection($reflService)
- {
- // Restore ReflectionClass and properties
- $this->reflClass = $reflService->getClass($this->name);
- $this->instantiator = $this->instantiator ?: new Instantiator();
- $parentReflFields = [];
- foreach ($this->embeddedClasses as $property => $embeddedClass) {
- if (isset($embeddedClass['declaredField'])) {
- $parentReflFields[$property] = new ReflectionEmbeddedProperty(
- $parentReflFields[$embeddedClass['declaredField']],
- $reflService->getAccessibleProperty(
- $this->embeddedClasses[$embeddedClass['declaredField']]['class'],
- $embeddedClass['originalField']
- ),
- $this->embeddedClasses[$embeddedClass['declaredField']]['class']
- );
- continue;
- }
- $fieldRefl = $reflService->getAccessibleProperty(
- $embeddedClass['declared'] ?? $this->name,
- $property
- );
- $parentReflFields[$property] = $fieldRefl;
- $this->reflFields[$property] = $fieldRefl;
- }
- foreach ($this->fieldMappings as $field => $mapping) {
- if (isset($mapping['declaredField']) && isset($parentReflFields[$mapping['declaredField']])) {
- $this->reflFields[$field] = new ReflectionEmbeddedProperty(
- $parentReflFields[$mapping['declaredField']],
- $reflService->getAccessibleProperty($mapping['originalClass'], $mapping['originalField']),
- $mapping['originalClass']
- );
- continue;
- }
- $this->reflFields[$field] = isset($mapping['declared'])
- ? $reflService->getAccessibleProperty($mapping['declared'], $field)
- : $reflService->getAccessibleProperty($this->name, $field);
- }
- foreach ($this->associationMappings as $field => $mapping) {
- $this->reflFields[$field] = isset($mapping['declared'])
- ? $reflService->getAccessibleProperty($mapping['declared'], $field)
- : $reflService->getAccessibleProperty($this->name, $field);
- }
- }
- /**
- * Initializes a new ClassMetadata instance that will hold the object-relational mapping
- * metadata of the class with the given name.
- *
- * @param ReflectionService $reflService The reflection service.
- *
- * @return void
- */
- public function initializeReflection($reflService)
- {
- $this->reflClass = $reflService->getClass($this->name);
- $this->namespace = $reflService->getClassNamespace($this->name);
- if ($this->reflClass) {
- $this->name = $this->rootEntityName = $this->reflClass->getName();
- }
- $this->table['name'] = $this->namingStrategy->classToTableName($this->name);
- }
- /**
- * Validates Identifier.
- *
- * @return void
- *
- * @throws MappingException
- */
- public function validateIdentifier()
- {
- if ($this->isMappedSuperclass || $this->isEmbeddedClass) {
- return;
- }
- // Verify & complete identifier mapping
- if (! $this->identifier) {
- throw MappingException::identifierRequired($this->name);
- }
- if ($this->usesIdGenerator() && $this->isIdentifierComposite) {
- throw MappingException::compositeKeyAssignedIdGeneratorRequired($this->name);
- }
- }
- /**
- * Validates association targets actually exist.
- *
- * @return void
- *
- * @throws MappingException
- */
- public function validateAssociations()
- {
- foreach ($this->associationMappings as $mapping) {
- if (
- ! class_exists($mapping['targetEntity'])
- && ! interface_exists($mapping['targetEntity'])
- && ! trait_exists($mapping['targetEntity'])
- ) {
- throw MappingException::invalidTargetEntityClass($mapping['targetEntity'], $this->name, $mapping['fieldName']);
- }
- }
- }
- /**
- * Validates lifecycle callbacks.
- *
- * @param ReflectionService $reflService
- *
- * @return void
- *
- * @throws MappingException
- */
- public function validateLifecycleCallbacks($reflService)
- {
- foreach ($this->lifecycleCallbacks as $callbacks) {
- foreach ($callbacks as $callbackFuncName) {
- if (! $reflService->hasPublicMethod($this->name, $callbackFuncName)) {
- throw MappingException::lifecycleCallbackMethodNotFound($this->name, $callbackFuncName);
- }
- }
- }
- }
- /**
- * {@inheritDoc}
- */
- public function getReflectionClass()
- {
- return $this->reflClass;
- }
- /**
- * @return void
- *
- * @psalm-param array{usage?: mixed, region?: mixed} $cache
- */
- public function enableCache(array $cache)
- {
- if (! isset($cache['usage'])) {
- $cache['usage'] = self::CACHE_USAGE_READ_ONLY;
- }
- if (! isset($cache['region'])) {
- $cache['region'] = strtolower(str_replace('\\', '_', $this->rootEntityName));
- }
- $this->cache = $cache;
- }
- /**
- * @param string $fieldName
- *
- * @return void
- *
- * @psalm-param array{usage?: mixed, region?: mixed} $cache
- */
- public function enableAssociationCache($fieldName, array $cache)
- {
- $this->associationMappings[$fieldName]['cache'] = $this->getAssociationCacheDefaults($fieldName, $cache);
- }
- /**
- * @param string $fieldName
- * @param array $cache
- *
- * @return mixed[]
- *
- * @psalm-param array{usage?: mixed, region?: mixed} $cache
- * @psalm-return array{usage: mixed, region: mixed}
- */
- public function getAssociationCacheDefaults($fieldName, array $cache)
- {
- if (! isset($cache['usage'])) {
- $cache['usage'] = $this->cache['usage'] ?? self::CACHE_USAGE_READ_ONLY;
- }
- if (! isset($cache['region'])) {
- $cache['region'] = strtolower(str_replace('\\', '_', $this->rootEntityName)) . '__' . $fieldName;
- }
- return $cache;
- }
- /**
- * Sets the change tracking policy used by this class.
- *
- * @param int $policy
- *
- * @return void
- */
- public function setChangeTrackingPolicy($policy)
- {
- $this->changeTrackingPolicy = $policy;
- }
- /**
- * Whether the change tracking policy of this class is "deferred explicit".
- *
- * @return bool
- */
- public function isChangeTrackingDeferredExplicit()
- {
- return $this->changeTrackingPolicy === self::CHANGETRACKING_DEFERRED_EXPLICIT;
- }
- /**
- * Whether the change tracking policy of this class is "deferred implicit".
- *
- * @return bool
- */
- public function isChangeTrackingDeferredImplicit()
- {
- return $this->changeTrackingPolicy === self::CHANGETRACKING_DEFERRED_IMPLICIT;
- }
- /**
- * Whether the change tracking policy of this class is "notify".
- *
- * @return bool
- */
- public function isChangeTrackingNotify()
- {
- return $this->changeTrackingPolicy === self::CHANGETRACKING_NOTIFY;
- }
- /**
- * Checks whether a field is part of the identifier/primary key field(s).
- *
- * @param string $fieldName The field name.
- *
- * @return bool TRUE if the field is part of the table identifier/primary key field(s),
- * FALSE otherwise.
- */
- public function isIdentifier($fieldName)
- {
- if (! $this->identifier) {
- return false;
- }
- if (! $this->isIdentifierComposite) {
- return $fieldName === $this->identifier[0];
- }
- return in_array($fieldName, $this->identifier, true);
- }
- /**
- * Checks if the field is unique.
- *
- * @param string $fieldName The field name.
- *
- * @return bool TRUE if the field is unique, FALSE otherwise.
- */
- public function isUniqueField($fieldName)
- {
- $mapping = $this->getFieldMapping($fieldName);
- return $mapping !== false && isset($mapping['unique']) && $mapping['unique'];
- }
- /**
- * Checks if the field is not null.
- *
- * @param string $fieldName The field name.
- *
- * @return bool TRUE if the field is not null, FALSE otherwise.
- */
- public function isNullable($fieldName)
- {
- $mapping = $this->getFieldMapping($fieldName);
- return $mapping !== false && isset($mapping['nullable']) && $mapping['nullable'];
- }
- /**
- * Gets a column name for a field name.
- * If the column name for the field cannot be found, the given field name
- * is returned.
- *
- * @param string $fieldName The field name.
- *
- * @return string The column name.
- */
- public function getColumnName($fieldName)
- {
- return $this->columnNames[$fieldName] ?? $fieldName;
- }
- /**
- * Gets the mapping of a (regular) field that holds some data but not a
- * reference to another object.
- *
- * @param string $fieldName The field name.
- *
- * @throws MappingException
- *
- * @psalm-return array<string, mixed> The field mapping.
- */
- public function getFieldMapping($fieldName)
- {
- if (! isset($this->fieldMappings[$fieldName])) {
- throw MappingException::mappingNotFound($this->name, $fieldName);
- }
- return $this->fieldMappings[$fieldName];
- }
- /**
- * Gets the mapping of an association.
- *
- * @see ClassMetadataInfo::$associationMappings
- *
- * @param string $fieldName The field name that represents the association in
- * the object model.
- *
- * @throws MappingException
- *
- * @psalm-return array<string, mixed> The mapping.
- */
- public function getAssociationMapping($fieldName)
- {
- if (! isset($this->associationMappings[$fieldName])) {
- throw MappingException::mappingNotFound($this->name, $fieldName);
- }
- return $this->associationMappings[$fieldName];
- }
- /**
- * Gets all association mappings of the class.
- *
- * @psalm-return array<string, array<string, mixed>>
- */
- public function getAssociationMappings()
- {
- return $this->associationMappings;
- }
- /**
- * Gets the field name for a column name.
- * If no field name can be found the column name is returned.
- *
- * @param string $columnName The column name.
- *
- * @return string The column alias.
- */
- public function getFieldName($columnName)
- {
- return $this->fieldNames[$columnName] ?? $columnName;
- }
- /**
- * Gets the named query.
- *
- * @see ClassMetadataInfo::$namedQueries
- *
- * @param string $queryName The query name.
- *
- * @return string
- *
- * @throws MappingException
- */
- public function getNamedQuery($queryName)
- {
- if (! isset($this->namedQueries[$queryName])) {
- throw MappingException::queryNotFound($this->name, $queryName);
- }
- return $this->namedQueries[$queryName]['dql'];
- }
- /**
- * Gets all named queries of the class.
- *
- * @psalm-return array<string, mixed>
- */
- public function getNamedQueries()
- {
- return $this->namedQueries;
- }
- /**
- * Gets the named native query.
- *
- * @see ClassMetadataInfo::$namedNativeQueries
- *
- * @param string $queryName The query name.
- *
- * @throws MappingException
- *
- * @psalm-return array<string, mixed>
- */
- public function getNamedNativeQuery($queryName)
- {
- if (! isset($this->namedNativeQueries[$queryName])) {
- throw MappingException::queryNotFound($this->name, $queryName);
- }
- return $this->namedNativeQueries[$queryName];
- }
- /**
- * Gets all named native queries of the class.
- *
- * @psalm-return array<string, array<string, mixed>>
- */
- public function getNamedNativeQueries()
- {
- return $this->namedNativeQueries;
- }
- /**
- * Gets the result set mapping.
- *
- * @see ClassMetadataInfo::$sqlResultSetMappings
- *
- * @param string $name The result set mapping name.
- *
- * @throws MappingException
- *
- * @psalm-return array<string, mixed>
- */
- public function getSqlResultSetMapping($name)
- {
- if (! isset($this->sqlResultSetMappings[$name])) {
- throw MappingException::resultMappingNotFound($this->name, $name);
- }
- return $this->sqlResultSetMappings[$name];
- }
- /**
- * Gets all sql result set mappings of the class.
- *
- * @psalm-return array<string, array<string, mixed>>
- */
- public function getSqlResultSetMappings()
- {
- return $this->sqlResultSetMappings;
- }
- /**
- * Validates & completes the given field mapping.
- *
- * @return void
- *
- * @throws MappingException
- *
- * @psalm-param array<string, mixed> $mapping The field mapping to validate & complete.
- */
- protected function _validateAndCompleteFieldMapping(array &$mapping)
- {
- // Check mandatory fields
- if (! isset($mapping['fieldName']) || ! $mapping['fieldName']) {
- throw MappingException::missingFieldName($this->name);
- }
- if (! isset($mapping['type'])) {
- // Default to string
- $mapping['type'] = 'string';
- }
- // Complete fieldName and columnName mapping
- if (! isset($mapping['columnName'])) {
- $mapping['columnName'] = $this->namingStrategy->propertyToColumnName($mapping['fieldName'], $this->name);
- }
- if ($mapping['columnName'][0] === '`') {
- $mapping['columnName'] = trim($mapping['columnName'], '`');
- $mapping['quoted'] = true;
- }
- $this->columnNames[$mapping['fieldName']] = $mapping['columnName'];
- if (isset($this->fieldNames[$mapping['columnName']]) || ($this->discriminatorColumn && $this->discriminatorColumn['name'] === $mapping['columnName'])) {
- throw MappingException::duplicateColumnName($this->name, $mapping['columnName']);
- }
- $this->fieldNames[$mapping['columnName']] = $mapping['fieldName'];
- // Complete id mapping
- if (isset($mapping['id']) && $mapping['id'] === true) {
- if ($this->versionField === $mapping['fieldName']) {
- throw MappingException::cannotVersionIdField($this->name, $mapping['fieldName']);
- }
- if (! in_array($mapping['fieldName'], $this->identifier)) {
- $this->identifier[] = $mapping['fieldName'];
- }
- // Check for composite key
- if (! $this->isIdentifierComposite && count($this->identifier) > 1) {
- $this->isIdentifierComposite = true;
- }
- }
- if (Type::hasType($mapping['type']) && Type::getType($mapping['type'])->canRequireSQLConversion()) {
- if (isset($mapping['id']) && $mapping['id'] === true) {
- throw MappingException::sqlConversionNotAllowedForIdentifiers($this->name, $mapping['fieldName'], $mapping['type']);
- }
- $mapping['requireSQLConversion'] = true;
- }
- }
- /**
- * Validates & completes the basic mapping information that is common to all
- * association mappings (one-to-one, many-ot-one, one-to-many, many-to-many).
- *
- * @return mixed[] The updated mapping.
- *
- * @throws MappingException If something is wrong with the mapping.
- *
- * @psalm-param array<string, mixed> $mapping The mapping.
- * @psalm-return array{
- * mappedBy: mixed,
- * inversedBy: mixed,
- * isOwningSide: bool,
- * sourceEntity: string,
- * targetEntity: string,
- * fieldName: mixed,
- * fetch: mixed,
- * cascade: array<array-key,string>,
- * isCascadeRemove: bool,
- * isCascadePersist: bool,
- * isCascadeRefresh: bool,
- * isCascadeMerge: bool,
- * isCascadeDetach: bool,
- * ?orphanRemoval: bool
- * }
- */
- protected function _validateAndCompleteAssociationMapping(array $mapping)
- {
- if (! isset($mapping['mappedBy'])) {
- $mapping['mappedBy'] = null;
- }
- if (! isset($mapping['inversedBy'])) {
- $mapping['inversedBy'] = null;
- }
- $mapping['isOwningSide'] = true; // assume owning side until we hit mappedBy
- if (empty($mapping['indexBy'])) {
- unset($mapping['indexBy']);
- }
- // If targetEntity is unqualified, assume it is in the same namespace as
- // the sourceEntity.
- $mapping['sourceEntity'] = $this->name;
- if (isset($mapping['targetEntity'])) {
- $mapping['targetEntity'] = $this->fullyQualifiedClassName($mapping['targetEntity']);
- $mapping['targetEntity'] = ltrim($mapping['targetEntity'], '\\');
- }
- if (($mapping['type'] & self::MANY_TO_ONE) > 0 && isset($mapping['orphanRemoval']) && $mapping['orphanRemoval']) {
- throw MappingException::illegalOrphanRemoval($this->name, $mapping['fieldName']);
- }
- // Complete id mapping
- if (isset($mapping['id']) && $mapping['id'] === true) {
- if (isset($mapping['orphanRemoval']) && $mapping['orphanRemoval']) {
- throw MappingException::illegalOrphanRemovalOnIdentifierAssociation($this->name, $mapping['fieldName']);
- }
- if (! in_array($mapping['fieldName'], $this->identifier)) {
- if (isset($mapping['joinColumns']) && count($mapping['joinColumns']) >= 2) {
- throw MappingException::cannotMapCompositePrimaryKeyEntitiesAsForeignId(
- $mapping['targetEntity'],
- $this->name,
- $mapping['fieldName']
- );
- }
- $this->identifier[] = $mapping['fieldName'];
- $this->containsForeignIdentifier = true;
- }
- // Check for composite key
- if (! $this->isIdentifierComposite && count($this->identifier) > 1) {
- $this->isIdentifierComposite = true;
- }
- if ($this->cache && ! isset($mapping['cache'])) {
- throw CacheException::nonCacheableEntityAssociation($this->name, $mapping['fieldName']);
- }
- }
- // Mandatory attributes for both sides
- // Mandatory: fieldName, targetEntity
- if (! isset($mapping['fieldName']) || ! $mapping['fieldName']) {
- throw MappingException::missingFieldName($this->name);
- }
- if (! isset($mapping['targetEntity'])) {
- throw MappingException::missingTargetEntity($mapping['fieldName']);
- }
- // Mandatory and optional attributes for either side
- if (! $mapping['mappedBy']) {
- if (isset($mapping['joinTable']) && $mapping['joinTable']) {
- if (isset($mapping['joinTable']['name']) && $mapping['joinTable']['name'][0] === '`') {
- $mapping['joinTable']['name'] = trim($mapping['joinTable']['name'], '`');
- $mapping['joinTable']['quoted'] = true;
- }
- }
- } else {
- $mapping['isOwningSide'] = false;
- }
- if (isset($mapping['id']) && $mapping['id'] === true && $mapping['type'] & self::TO_MANY) {
- throw MappingException::illegalToManyIdentifierAssociation($this->name, $mapping['fieldName']);
- }
- // Fetch mode. Default fetch mode to LAZY, if not set.
- if (! isset($mapping['fetch'])) {
- $mapping['fetch'] = self::FETCH_LAZY;
- }
- // Cascades
- $cascades = isset($mapping['cascade']) ? array_map('strtolower', $mapping['cascade']) : [];
- $allCascades = ['remove', 'persist', 'refresh', 'merge', 'detach'];
- if (in_array('all', $cascades)) {
- $cascades = $allCascades;
- } elseif (count($cascades) !== count(array_intersect($cascades, $allCascades))) {
- throw MappingException::invalidCascadeOption(
- array_diff($cascades, $allCascades),
- $this->name,
- $mapping['fieldName']
- );
- }
- $mapping['cascade'] = $cascades;
- $mapping['isCascadeRemove'] = in_array('remove', $cascades);
- $mapping['isCascadePersist'] = in_array('persist', $cascades);
- $mapping['isCascadeRefresh'] = in_array('refresh', $cascades);
- $mapping['isCascadeMerge'] = in_array('merge', $cascades);
- $mapping['isCascadeDetach'] = in_array('detach', $cascades);
- return $mapping;
- }
- /**
- * Validates & completes a one-to-one association mapping.
- *
- * @return mixed[] The validated & completed mapping.
- *
- * @throws RuntimeException
- * @throws MappingException
- *
- * @psalm-param array<string, mixed> $mapping The mapping to validate & complete.
- * @psalm-return array{isOwningSide: mixed, orphanRemoval: bool, isCascadeRemove: bool}
- */
- protected function _validateAndCompleteOneToOneMapping(array $mapping)
- {
- $mapping = $this->_validateAndCompleteAssociationMapping($mapping);
- if (isset($mapping['joinColumns']) && $mapping['joinColumns']) {
- $mapping['isOwningSide'] = true;
- }
- if ($mapping['isOwningSide']) {
- if (empty($mapping['joinColumns'])) {
- // Apply default join column
- $mapping['joinColumns'] = [
- [
- 'name' => $this->namingStrategy->joinColumnName($mapping['fieldName'], $this->name),
- 'referencedColumnName' => $this->namingStrategy->referenceColumnName(),
- ],
- ];
- }
- $uniqueConstraintColumns = [];
- foreach ($mapping['joinColumns'] as &$joinColumn) {
- if ($mapping['type'] === self::ONE_TO_ONE && ! $this->isInheritanceTypeSingleTable()) {
- if (count($mapping['joinColumns']) === 1) {
- if (empty($mapping['id'])) {
- $joinColumn['unique'] = true;
- }
- } else {
- $uniqueConstraintColumns[] = $joinColumn['name'];
- }
- }
- if (empty($joinColumn['name'])) {
- $joinColumn['name'] = $this->namingStrategy->joinColumnName($mapping['fieldName'], $this->name);
- }
- if (empty($joinColumn['referencedColumnName'])) {
- $joinColumn['referencedColumnName'] = $this->namingStrategy->referenceColumnName();
- }
- if ($joinColumn['name'][0] === '`') {
- $joinColumn['name'] = trim($joinColumn['name'], '`');
- $joinColumn['quoted'] = true;
- }
- if ($joinColumn['referencedColumnName'][0] === '`') {
- $joinColumn['referencedColumnName'] = trim($joinColumn['referencedColumnName'], '`');
- $joinColumn['quoted'] = true;
- }
- $mapping['sourceToTargetKeyColumns'][$joinColumn['name']] = $joinColumn['referencedColumnName'];
- $mapping['joinColumnFieldNames'][$joinColumn['name']] = $joinColumn['fieldName'] ?? $joinColumn['name'];
- }
- if ($uniqueConstraintColumns) {
- if (! $this->table) {
- throw new RuntimeException('ClassMetadataInfo::setTable() has to be called before defining a one to one relationship.');
- }
- $this->table['uniqueConstraints'][$mapping['fieldName'] . '_uniq'] = ['columns' => $uniqueConstraintColumns];
- }
- $mapping['targetToSourceKeyColumns'] = array_flip($mapping['sourceToTargetKeyColumns']);
- }
- $mapping['orphanRemoval'] = isset($mapping['orphanRemoval']) && $mapping['orphanRemoval'];
- $mapping['isCascadeRemove'] = $mapping['orphanRemoval'] || $mapping['isCascadeRemove'];
- if ($mapping['orphanRemoval']) {
- unset($mapping['unique']);
- }
- if (isset($mapping['id']) && $mapping['id'] === true && ! $mapping['isOwningSide']) {
- throw MappingException::illegalInverseIdentifierAssociation($this->name, $mapping['fieldName']);
- }
- return $mapping;
- }
- /**
- * Validates & completes a one-to-many association mapping.
- *
- * @return mixed[] The validated and completed mapping.
- *
- * @throws MappingException
- * @throws InvalidArgumentException
- *
- * @psalm-param array<string, mixed> $mapping The mapping to validate and complete.
- * @psalm-return array{
- * mappedBy: mixed,
- * inversedBy: mixed,
- * isOwningSide: bool,
- * sourceEntity: string,
- * targetEntity: string,
- * fieldName: mixed,
- * fetch: int|mixed,
- * cascade: array<array-key,string>,
- * isCascadeRemove: bool,
- * isCascadePersist: bool,
- * isCascadeRefresh: bool,
- * isCascadeMerge: bool,
- * isCascadeDetach: bool,
- * orphanRemoval: bool
- * }
- */
- protected function _validateAndCompleteOneToManyMapping(array $mapping)
- {
- $mapping = $this->_validateAndCompleteAssociationMapping($mapping);
- // OneToMany-side MUST be inverse (must have mappedBy)
- if (! isset($mapping['mappedBy'])) {
- throw MappingException::oneToManyRequiresMappedBy($mapping['fieldName']);
- }
- $mapping['orphanRemoval'] = isset($mapping['orphanRemoval']) && $mapping['orphanRemoval'];
- $mapping['isCascadeRemove'] = $mapping['orphanRemoval'] || $mapping['isCascadeRemove'];
- $this->assertMappingOrderBy($mapping);
- return $mapping;
- }
- /**
- * Validates & completes a many-to-many association mapping.
- *
- * @return mixed[] The validated & completed mapping.
- *
- * @throws InvalidArgumentException
- *
- * @psalm-param array<string, mixed> $mapping The mapping to validate & complete.
- * @psalm-return array{isOwningSide: mixed, orphanRemoval: bool}
- */
- protected function _validateAndCompleteManyToManyMapping(array $mapping)
- {
- $mapping = $this->_validateAndCompleteAssociationMapping($mapping);
- if ($mapping['isOwningSide']) {
- // owning side MUST have a join table
- if (! isset($mapping['joinTable']['name'])) {
- $mapping['joinTable']['name'] = $this->namingStrategy->joinTableName($mapping['sourceEntity'], $mapping['targetEntity'], $mapping['fieldName']);
- }
- $selfReferencingEntityWithoutJoinColumns = $mapping['sourceEntity'] === $mapping['targetEntity']
- && (! (isset($mapping['joinTable']['joinColumns']) || isset($mapping['joinTable']['inverseJoinColumns'])));
- if (! isset($mapping['joinTable']['joinColumns'])) {
- $mapping['joinTable']['joinColumns'] = [
- [
- 'name' => $this->namingStrategy->joinKeyColumnName($mapping['sourceEntity'], $selfReferencingEntityWithoutJoinColumns ? 'source' : null),
- 'referencedColumnName' => $this->namingStrategy->referenceColumnName(),
- 'onDelete' => 'CASCADE',
- ],
- ];
- }
- if (! isset($mapping['joinTable']['inverseJoinColumns'])) {
- $mapping['joinTable']['inverseJoinColumns'] = [
- [
- 'name' => $this->namingStrategy->joinKeyColumnName($mapping['targetEntity'], $selfReferencingEntityWithoutJoinColumns ? 'target' : null),
- 'referencedColumnName' => $this->namingStrategy->referenceColumnName(),
- 'onDelete' => 'CASCADE',
- ],
- ];
- }
- $mapping['joinTableColumns'] = [];
- foreach ($mapping['joinTable']['joinColumns'] as &$joinColumn) {
- if (empty($joinColumn['name'])) {
- $joinColumn['name'] = $this->namingStrategy->joinKeyColumnName($mapping['sourceEntity'], $joinColumn['referencedColumnName']);
- }
- if (empty($joinColumn['referencedColumnName'])) {
- $joinColumn['referencedColumnName'] = $this->namingStrategy->referenceColumnName();
- }
- if ($joinColumn['name'][0] === '`') {
- $joinColumn['name'] = trim($joinColumn['name'], '`');
- $joinColumn['quoted'] = true;
- }
- if ($joinColumn['referencedColumnName'][0] === '`') {
- $joinColumn['referencedColumnName'] = trim($joinColumn['referencedColumnName'], '`');
- $joinColumn['quoted'] = true;
- }
- if (isset($joinColumn['onDelete']) && strtolower($joinColumn['onDelete']) === 'cascade') {
- $mapping['isOnDeleteCascade'] = true;
- }
- $mapping['relationToSourceKeyColumns'][$joinColumn['name']] = $joinColumn['referencedColumnName'];
- $mapping['joinTableColumns'][] = $joinColumn['name'];
- }
- foreach ($mapping['joinTable']['inverseJoinColumns'] as &$inverseJoinColumn) {
- if (empty($inverseJoinColumn['name'])) {
- $inverseJoinColumn['name'] = $this->namingStrategy->joinKeyColumnName($mapping['targetEntity'], $inverseJoinColumn['referencedColumnName']);
- }
- if (empty($inverseJoinColumn['referencedColumnName'])) {
- $inverseJoinColumn['referencedColumnName'] = $this->namingStrategy->referenceColumnName();
- }
- if ($inverseJoinColumn['name'][0] === '`') {
- $inverseJoinColumn['name'] = trim($inverseJoinColumn['name'], '`');
- $inverseJoinColumn['quoted'] = true;
- }
- if ($inverseJoinColumn['referencedColumnName'][0] === '`') {
- $inverseJoinColumn['referencedColumnName'] = trim($inverseJoinColumn['referencedColumnName'], '`');
- $inverseJoinColumn['quoted'] = true;
- }
- if (isset($inverseJoinColumn['onDelete']) && strtolower($inverseJoinColumn['onDelete']) === 'cascade') {
- $mapping['isOnDeleteCascade'] = true;
- }
- $mapping['relationToTargetKeyColumns'][$inverseJoinColumn['name']] = $inverseJoinColumn['referencedColumnName'];
- $mapping['joinTableColumns'][] = $inverseJoinColumn['name'];
- }
- }
- $mapping['orphanRemoval'] = isset($mapping['orphanRemoval']) && $mapping['orphanRemoval'];
- $this->assertMappingOrderBy($mapping);
- return $mapping;
- }
- /**
- * {@inheritDoc}
- */
- public function getIdentifierFieldNames()
- {
- return $this->identifier;
- }
- /**
- * Gets the name of the single id field. Note that this only works on
- * entity classes that have a single-field pk.
- *
- * @return string
- *
- * @throws MappingException If the class doesn't have an identifier or it has a composite primary key.
- */
- public function getSingleIdentifierFieldName()
- {
- if ($this->isIdentifierComposite) {
- throw MappingException::singleIdNotAllowedOnCompositePrimaryKey($this->name);
- }
- if (! isset($this->identifier[0])) {
- throw MappingException::noIdDefined($this->name);
- }
- return $this->identifier[0];
- }
- /**
- * Gets the column name of the single id column. Note that this only works on
- * entity classes that have a single-field pk.
- *
- * @return string
- *
- * @throws MappingException If the class doesn't have an identifier or it has a composite primary key.
- */
- public function getSingleIdentifierColumnName()
- {
- return $this->getColumnName($this->getSingleIdentifierFieldName());
- }
- /**
- * INTERNAL:
- * Sets the mapped identifier/primary key fields of this class.
- * Mainly used by the ClassMetadataFactory to assign inherited identifiers.
- *
- * @return void
- *
- * @psalm-param list<mixed> $identifier
- */
- public function setIdentifier(array $identifier)
- {
- $this->identifier = $identifier;
- $this->isIdentifierComposite = (count($this->identifier) > 1);
- }
- /**
- * {@inheritDoc}
- */
- public function getIdentifier()
- {
- return $this->identifier;
- }
- /**
- * {@inheritDoc}
- */
- public function hasField($fieldName)
- {
- return isset($this->fieldMappings[$fieldName]) || isset($this->embeddedClasses[$fieldName]);
- }
- /**
- * Gets an array containing all the column names.
- *
- * @return mixed[]
- *
- * @psalm-param list<string>|null $fieldNames
- * @psalm-return list<string>
- */
- public function getColumnNames(?array $fieldNames = null)
- {
- if ($fieldNames === null) {
- return array_keys($this->fieldNames);
- }
- return array_values(array_map([$this, 'getColumnName'], $fieldNames));
- }
- /**
- * Returns an array with all the identifier column names.
- *
- * @psalm-return list<string>
- */
- public function getIdentifierColumnNames()
- {
- $columnNames = [];
- foreach ($this->identifier as $idProperty) {
- if (isset($this->fieldMappings[$idProperty])) {
- $columnNames[] = $this->fieldMappings[$idProperty]['columnName'];
- continue;
- }
- // Association defined as Id field
- $joinColumns = $this->associationMappings[$idProperty]['joinColumns'];
- $assocColumnNames = array_map(static function ($joinColumn) {
- return $joinColumn['name'];
- }, $joinColumns);
- $columnNames = array_merge($columnNames, $assocColumnNames);
- }
- return $columnNames;
- }
- /**
- * Sets the type of Id generator to use for the mapped class.
- *
- * @param int $generatorType
- *
- * @return void
- */
- public function setIdGeneratorType($generatorType)
- {
- $this->generatorType = $generatorType;
- }
- /**
- * Checks whether the mapped class uses an Id generator.
- *
- * @return bool TRUE if the mapped class uses an Id generator, FALSE otherwise.
- */
- public function usesIdGenerator()
- {
- return $this->generatorType !== self::GENERATOR_TYPE_NONE;
- }
- /**
- * @return bool
- */
- public function isInheritanceTypeNone()
- {
- return $this->inheritanceType === self::INHERITANCE_TYPE_NONE;
- }
- /**
- * Checks whether the mapped class uses the JOINED inheritance mapping strategy.
- *
- * @return bool TRUE if the class participates in a JOINED inheritance mapping,
- * FALSE otherwise.
- */
- public function isInheritanceTypeJoined()
- {
- return $this->inheritanceType === self::INHERITANCE_TYPE_JOINED;
- }
- /**
- * Checks whether the mapped class uses the SINGLE_TABLE inheritance mapping strategy.
- *
- * @return bool TRUE if the class participates in a SINGLE_TABLE inheritance mapping,
- * FALSE otherwise.
- */
- public function isInheritanceTypeSingleTable()
- {
- return $this->inheritanceType === self::INHERITANCE_TYPE_SINGLE_TABLE;
- }
- /**
- * Checks whether the mapped class uses the TABLE_PER_CLASS inheritance mapping strategy.
- *
- * @return bool TRUE if the class participates in a TABLE_PER_CLASS inheritance mapping,
- * FALSE otherwise.
- */
- public function isInheritanceTypeTablePerClass()
- {
- return $this->inheritanceType === self::INHERITANCE_TYPE_TABLE_PER_CLASS;
- }
- /**
- * Checks whether the class uses an identity column for the Id generation.
- *
- * @return bool TRUE if the class uses the IDENTITY generator, FALSE otherwise.
- */
- public function isIdGeneratorIdentity()
- {
- return $this->generatorType === self::GENERATOR_TYPE_IDENTITY;
- }
- /**
- * Checks whether the class uses a sequence for id generation.
- *
- * @return bool TRUE if the class uses the SEQUENCE generator, FALSE otherwise.
- */
- public function isIdGeneratorSequence()
- {
- return $this->generatorType === self::GENERATOR_TYPE_SEQUENCE;
- }
- /**
- * Checks whether the class uses a table for id generation.
- *
- * @return bool TRUE if the class uses the TABLE generator, FALSE otherwise.
- */
- public function isIdGeneratorTable()
- {
- return $this->generatorType === self::GENERATOR_TYPE_TABLE;
- }
- /**
- * Checks whether the class has a natural identifier/pk (which means it does
- * not use any Id generator.
- *
- * @return bool
- */
- public function isIdentifierNatural()
- {
- return $this->generatorType === self::GENERATOR_TYPE_NONE;
- }
- /**
- * Checks whether the class use a UUID for id generation.
- *
- * @return bool
- */
- public function isIdentifierUuid()
- {
- return $this->generatorType === self::GENERATOR_TYPE_UUID;
- }
- /**
- * Gets the type of a field.
- *
- * @param string $fieldName
- *
- * @return string|null
- *
- * @todo 3.0 Remove this. PersisterHelper should fix it somehow
- */
- public function getTypeOfField($fieldName)
- {
- return isset($this->fieldMappings[$fieldName])
- ? $this->fieldMappings[$fieldName]['type']
- : null;
- }
- /**
- * Gets the type of a column.
- *
- * @deprecated 3.0 remove this. this method is bogus and unreliable, since it cannot resolve the type of a column
- * that is derived by a referenced field on a different entity.
- *
- * @param string $columnName
- *
- * @return string|null
- */
- public function getTypeOfColumn($columnName)
- {
- return $this->getTypeOfField($this->getFieldName($columnName));
- }
- /**
- * Gets the name of the primary table.
- *
- * @return string
- */
- public function getTableName()
- {
- return $this->table['name'];
- }
- /**
- * Gets primary table's schema name.
- *
- * @return string|null
- */
- public function getSchemaName()
- {
- return $this->table['schema'] ?? null;
- }
- /**
- * Gets the table name to use for temporary identifier tables of this class.
- *
- * @return string
- */
- public function getTemporaryIdTableName()
- {
- // replace dots with underscores because PostgreSQL creates temporary tables in a special schema
- return str_replace('.', '_', $this->getTableName() . '_id_tmp');
- }
- /**
- * Sets the mapped subclasses of this class.
- *
- * @return void
- *
- * @psalm-param list<string> $subclasses The names of all mapped subclasses.
- */
- public function setSubclasses(array $subclasses)
- {
- foreach ($subclasses as $subclass) {
- $this->subClasses[] = $this->fullyQualifiedClassName($subclass);
- }
- }
- /**
- * Sets the parent class names.
- * Assumes that the class names in the passed array are in the order:
- * directParent -> directParentParent -> directParentParentParent ... -> root.
- *
- * @return void
- *
- * @psalm-param list<class-string> $classNames
- */
- public function setParentClasses(array $classNames)
- {
- $this->parentClasses = $classNames;
- if (count($classNames) > 0) {
- $this->rootEntityName = array_pop($classNames);
- }
- }
- /**
- * Sets the inheritance type used by the class and its subclasses.
- *
- * @param int $type
- *
- * @return void
- *
- * @throws MappingException
- */
- public function setInheritanceType($type)
- {
- if (! $this->isInheritanceType($type)) {
- throw MappingException::invalidInheritanceType($this->name, $type);
- }
- $this->inheritanceType = $type;
- }
- /**
- * Sets the association to override association mapping of property for an entity relationship.
- *
- * @param string $fieldName
- *
- * @return void
- *
- * @throws MappingException
- *
- * @psalm-param array<string, mixed> $overrideMapping
- */
- public function setAssociationOverride($fieldName, array $overrideMapping)
- {
- if (! isset($this->associationMappings[$fieldName])) {
- throw MappingException::invalidOverrideFieldName($this->name, $fieldName);
- }
- $mapping = $this->associationMappings[$fieldName];
- //if (isset($mapping['inherited']) && (count($overrideMapping) !== 1 || ! isset($overrideMapping['fetch']))) {
- // TODO: Deprecate overriding the fetch mode via association override for 3.0,
- // users should do this with a listener and a custom attribute/annotation
- // TODO: Enable this exception in 2.8
- //throw MappingException::illegalOverrideOfInheritedProperty($this->name, $fieldName);
- //}
- if (isset($overrideMapping['joinColumns'])) {
- $mapping['joinColumns'] = $overrideMapping['joinColumns'];
- }
- if (isset($overrideMapping['inversedBy'])) {
- $mapping['inversedBy'] = $overrideMapping['inversedBy'];
- }
- if (isset($overrideMapping['joinTable'])) {
- $mapping['joinTable'] = $overrideMapping['joinTable'];
- }
- if (isset($overrideMapping['fetch'])) {
- $mapping['fetch'] = $overrideMapping['fetch'];
- }
- $mapping['joinColumnFieldNames'] = null;
- $mapping['joinTableColumns'] = null;
- $mapping['sourceToTargetKeyColumns'] = null;
- $mapping['relationToSourceKeyColumns'] = null;
- $mapping['relationToTargetKeyColumns'] = null;
- switch ($mapping['type']) {
- case self::ONE_TO_ONE:
- $mapping = $this->_validateAndCompleteOneToOneMapping($mapping);
- break;
- case self::ONE_TO_MANY:
- $mapping = $this->_validateAndCompleteOneToManyMapping($mapping);
- break;
- case self::MANY_TO_ONE:
- $mapping = $this->_validateAndCompleteOneToOneMapping($mapping);
- break;
- case self::MANY_TO_MANY:
- $mapping = $this->_validateAndCompleteManyToManyMapping($mapping);
- break;
- }
- $this->associationMappings[$fieldName] = $mapping;
- }
- /**
- * Sets the override for a mapped field.
- *
- * @param string $fieldName
- *
- * @return void
- *
- * @throws MappingException
- *
- * @psalm-param array<string, mixed> $overrideMapping
- */
- public function setAttributeOverride($fieldName, array $overrideMapping)
- {
- if (! isset($this->fieldMappings[$fieldName])) {
- throw MappingException::invalidOverrideFieldName($this->name, $fieldName);
- }
- $mapping = $this->fieldMappings[$fieldName];
- //if (isset($mapping['inherited'])) {
- // TODO: Enable this exception in 2.8
- //throw MappingException::illegalOverrideOfInheritedProperty($this->name, $fieldName);
- //}
- if (isset($mapping['id'])) {
- $overrideMapping['id'] = $mapping['id'];
- }
- if (! isset($overrideMapping['type'])) {
- $overrideMapping['type'] = $mapping['type'];
- }
- if (! isset($overrideMapping['fieldName'])) {
- $overrideMapping['fieldName'] = $mapping['fieldName'];
- }
- if ($overrideMapping['type'] !== $mapping['type']) {
- throw MappingException::invalidOverrideFieldType($this->name, $fieldName);
- }
- unset($this->fieldMappings[$fieldName]);
- unset($this->fieldNames[$mapping['columnName']]);
- unset($this->columnNames[$mapping['fieldName']]);
- $this->_validateAndCompleteFieldMapping($overrideMapping);
- $this->fieldMappings[$fieldName] = $overrideMapping;
- }
- /**
- * Checks whether a mapped field is inherited from an entity superclass.
- *
- * @param string $fieldName
- *
- * @return bool TRUE if the field is inherited, FALSE otherwise.
- */
- public function isInheritedField($fieldName)
- {
- return isset($this->fieldMappings[$fieldName]['inherited']);
- }
- /**
- * Checks if this entity is the root in any entity-inheritance-hierarchy.
- *
- * @return bool
- */
- public function isRootEntity()
- {
- return $this->name === $this->rootEntityName;
- }
- /**
- * Checks whether a mapped association field is inherited from a superclass.
- *
- * @param string $fieldName
- *
- * @return bool TRUE if the field is inherited, FALSE otherwise.
- */
- public function isInheritedAssociation($fieldName)
- {
- return isset($this->associationMappings[$fieldName]['inherited']);
- }
- /**
- * @param string $fieldName
- *
- * @return bool
- */
- public function isInheritedEmbeddedClass($fieldName)
- {
- return isset($this->embeddedClasses[$fieldName]['inherited']);
- }
- /**
- * Sets the name of the primary table the class is mapped to.
- *
- * @deprecated Use {@link setPrimaryTable}.
- *
- * @param string $tableName The table name.
- *
- * @return void
- */
- public function setTableName($tableName)
- {
- $this->table['name'] = $tableName;
- }
- /**
- * Sets the primary table definition. The provided array supports the
- * following structure:
- *
- * name => <tableName> (optional, defaults to class name)
- * indexes => array of indexes (optional)
- * uniqueConstraints => array of constraints (optional)
- *
- * If a key is omitted, the current value is kept.
- *
- * @return void
- *
- * @psalm-param array<string, mixed> $table The table description.
- */
- public function setPrimaryTable(array $table)
- {
- if (isset($table['name'])) {
- // Split schema and table name from a table name like "myschema.mytable"
- if (strpos($table['name'], '.') !== false) {
- [$this->table['schema'], $table['name']] = explode('.', $table['name'], 2);
- }
- if ($table['name'][0] === '`') {
- $table['name'] = trim($table['name'], '`');
- $this->table['quoted'] = true;
- }
- $this->table['name'] = $table['name'];
- }
- if (isset($table['quoted'])) {
- $this->table['quoted'] = $table['quoted'];
- }
- if (isset($table['schema'])) {
- $this->table['schema'] = $table['schema'];
- }
- if (isset($table['indexes'])) {
- $this->table['indexes'] = $table['indexes'];
- }
- if (isset($table['uniqueConstraints'])) {
- $this->table['uniqueConstraints'] = $table['uniqueConstraints'];
- }
- if (isset($table['options'])) {
- $this->table['options'] = $table['options'];
- }
- }
- /**
- * Checks whether the given type identifies an inheritance type.
- *
- * @param int $type
- *
- * @return bool TRUE if the given type identifies an inheritance type, FALSe otherwise.
- */
- private function isInheritanceType($type)
- {
- return $type === self::INHERITANCE_TYPE_NONE ||
- $type === self::INHERITANCE_TYPE_SINGLE_TABLE ||
- $type === self::INHERITANCE_TYPE_JOINED ||
- $type === self::INHERITANCE_TYPE_TABLE_PER_CLASS;
- }
- /**
- * Adds a mapped field to the class.
- *
- * @return void
- *
- * @throws MappingException
- *
- * @psalm-param array<string, mixed> $mapping The field mapping.
- */
- public function mapField(array $mapping)
- {
- $this->_validateAndCompleteFieldMapping($mapping);
- $this->assertFieldNotMapped($mapping['fieldName']);
- $this->fieldMappings[$mapping['fieldName']] = $mapping;
- }
- /**
- * INTERNAL:
- * Adds an association mapping without completing/validating it.
- * This is mainly used to add inherited association mappings to derived classes.
- *
- * @return void
- *
- * @throws MappingException
- *
- * @psalm-param array<string, mixed> $mapping
- */
- public function addInheritedAssociationMapping(array $mapping/*, $owningClassName = null*/)
- {
- if (isset($this->associationMappings[$mapping['fieldName']])) {
- throw MappingException::duplicateAssociationMapping($this->name, $mapping['fieldName']);
- }
- $this->associationMappings[$mapping['fieldName']] = $mapping;
- }
- /**
- * INTERNAL:
- * Adds a field mapping without completing/validating it.
- * This is mainly used to add inherited field mappings to derived classes.
- *
- * @return void
- *
- * @psalm-param array<string, mixed> $fieldMapping
- */
- public function addInheritedFieldMapping(array $fieldMapping)
- {
- $this->fieldMappings[$fieldMapping['fieldName']] = $fieldMapping;
- $this->columnNames[$fieldMapping['fieldName']] = $fieldMapping['columnName'];
- $this->fieldNames[$fieldMapping['columnName']] = $fieldMapping['fieldName'];
- }
- /**
- * INTERNAL:
- * Adds a named query to this class.
- *
- * @return void
- *
- * @throws MappingException
- *
- * @psalm-param array<string, mixed> $queryMapping
- */
- public function addNamedQuery(array $queryMapping)
- {
- if (! isset($queryMapping['name'])) {
- throw MappingException::nameIsMandatoryForQueryMapping($this->name);
- }
- if (isset($this->namedQueries[$queryMapping['name']])) {
- throw MappingException::duplicateQueryMapping($this->name, $queryMapping['name']);
- }
- if (! isset($queryMapping['query'])) {
- throw MappingException::emptyQueryMapping($this->name, $queryMapping['name']);
- }
- $name = $queryMapping['name'];
- $query = $queryMapping['query'];
- $dql = str_replace('__CLASS__', $this->name, $query);
- $this->namedQueries[$name] = [
- 'name' => $name,
- 'query' => $query,
- 'dql' => $dql,
- ];
- }
- /**
- * INTERNAL:
- * Adds a named native query to this class.
- *
- * @return void
- *
- * @throws MappingException
- *
- * @psalm-param array<string, mixed> $queryMapping
- */
- public function addNamedNativeQuery(array $queryMapping)
- {
- if (! isset($queryMapping['name'])) {
- throw MappingException::nameIsMandatoryForQueryMapping($this->name);
- }
- if (isset($this->namedNativeQueries[$queryMapping['name']])) {
- throw MappingException::duplicateQueryMapping($this->name, $queryMapping['name']);
- }
- if (! isset($queryMapping['query'])) {
- throw MappingException::emptyQueryMapping($this->name, $queryMapping['name']);
- }
- if (! isset($queryMapping['resultClass']) && ! isset($queryMapping['resultSetMapping'])) {
- throw MappingException::missingQueryMapping($this->name, $queryMapping['name']);
- }
- $queryMapping['isSelfClass'] = false;
- if (isset($queryMapping['resultClass'])) {
- if ($queryMapping['resultClass'] === '__CLASS__') {
- $queryMapping['isSelfClass'] = true;
- $queryMapping['resultClass'] = $this->name;
- }
- $queryMapping['resultClass'] = $this->fullyQualifiedClassName($queryMapping['resultClass']);
- $queryMapping['resultClass'] = ltrim($queryMapping['resultClass'], '\\');
- }
- $this->namedNativeQueries[$queryMapping['name']] = $queryMapping;
- }
- /**
- * INTERNAL:
- * Adds a sql result set mapping to this class.
- *
- * @return void
- *
- * @throws MappingException
- *
- * @psalm-param array<string, mixed> $resultMapping
- */
- public function addSqlResultSetMapping(array $resultMapping)
- {
- if (! isset($resultMapping['name'])) {
- throw MappingException::nameIsMandatoryForSqlResultSetMapping($this->name);
- }
- if (isset($this->sqlResultSetMappings[$resultMapping['name']])) {
- throw MappingException::duplicateResultSetMapping($this->name, $resultMapping['name']);
- }
- if (isset($resultMapping['entities'])) {
- foreach ($resultMapping['entities'] as $key => $entityResult) {
- if (! isset($entityResult['entityClass'])) {
- throw MappingException::missingResultSetMappingEntity($this->name, $resultMapping['name']);
- }
- $entityResult['isSelfClass'] = false;
- if ($entityResult['entityClass'] === '__CLASS__') {
- $entityResult['isSelfClass'] = true;
- $entityResult['entityClass'] = $this->name;
- }
- $entityResult['entityClass'] = $this->fullyQualifiedClassName($entityResult['entityClass']);
- $resultMapping['entities'][$key]['entityClass'] = ltrim($entityResult['entityClass'], '\\');
- $resultMapping['entities'][$key]['isSelfClass'] = $entityResult['isSelfClass'];
- if (isset($entityResult['fields'])) {
- foreach ($entityResult['fields'] as $k => $field) {
- if (! isset($field['name'])) {
- throw MappingException::missingResultSetMappingFieldName($this->name, $resultMapping['name']);
- }
- if (! isset($field['column'])) {
- $fieldName = $field['name'];
- if (strpos($fieldName, '.')) {
- [, $fieldName] = explode('.', $fieldName);
- }
- $resultMapping['entities'][$key]['fields'][$k]['column'] = $fieldName;
- }
- }
- }
- }
- }
- $this->sqlResultSetMappings[$resultMapping['name']] = $resultMapping;
- }
- /**
- * Adds a one-to-one mapping.
- *
- * @param array<string, mixed> $mapping The mapping.
- *
- * @return void
- */
- public function mapOneToOne(array $mapping)
- {
- $mapping['type'] = self::ONE_TO_ONE;
- $mapping = $this->_validateAndCompleteOneToOneMapping($mapping);
- $this->_storeAssociationMapping($mapping);
- }
- /**
- * Adds a one-to-many mapping.
- *
- * @return void
- *
- * @psalm-param array<string, mixed> $mapping The mapping.
- */
- public function mapOneToMany(array $mapping)
- {
- $mapping['type'] = self::ONE_TO_MANY;
- $mapping = $this->_validateAndCompleteOneToManyMapping($mapping);
- $this->_storeAssociationMapping($mapping);
- }
- /**
- * Adds a many-to-one mapping.
- *
- * @return void
- *
- * @psalm-param array<string, mixed> $mapping The mapping.
- */
- public function mapManyToOne(array $mapping)
- {
- $mapping['type'] = self::MANY_TO_ONE;
- // A many-to-one mapping is essentially a one-one backreference
- $mapping = $this->_validateAndCompleteOneToOneMapping($mapping);
- $this->_storeAssociationMapping($mapping);
- }
- /**
- * Adds a many-to-many mapping.
- *
- * @return void
- *
- * @psalm-param array<string, mixed> $mapping The mapping.
- */
- public function mapManyToMany(array $mapping)
- {
- $mapping['type'] = self::MANY_TO_MANY;
- $mapping = $this->_validateAndCompleteManyToManyMapping($mapping);
- $this->_storeAssociationMapping($mapping);
- }
- /**
- * Stores the association mapping.
- *
- * @return void
- *
- * @throws MappingException
- *
- * @psalm-param array<string, mixed> $assocMapping
- */
- protected function _storeAssociationMapping(array $assocMapping)
- {
- $sourceFieldName = $assocMapping['fieldName'];
- $this->assertFieldNotMapped($sourceFieldName);
- $this->associationMappings[$sourceFieldName] = $assocMapping;
- }
- /**
- * Registers a custom repository class for the entity class.
- *
- * @param string $repositoryClassName The class name of the custom mapper.
- *
- * @return void
- *
- * @psalm-param class-string $repositoryClassName
- */
- public function setCustomRepositoryClass($repositoryClassName)
- {
- $this->customRepositoryClassName = $this->fullyQualifiedClassName($repositoryClassName);
- }
- /**
- * Dispatches the lifecycle event of the given entity to the registered
- * lifecycle callbacks and lifecycle listeners.
- *
- * @deprecated Deprecated since version 2.4 in favor of \Doctrine\ORM\Event\ListenersInvoker
- *
- * @param string $lifecycleEvent The lifecycle event.
- * @param object $entity The Entity on which the event occurred.
- *
- * @return void
- */
- public function invokeLifecycleCallbacks($lifecycleEvent, $entity)
- {
- foreach ($this->lifecycleCallbacks[$lifecycleEvent] as $callback) {
- $entity->$callback();
- }
- }
- /**
- * Whether the class has any attached lifecycle listeners or callbacks for a lifecycle event.
- *
- * @param string $lifecycleEvent
- *
- * @return bool
- */
- public function hasLifecycleCallbacks($lifecycleEvent)
- {
- return isset($this->lifecycleCallbacks[$lifecycleEvent]);
- }
- /**
- * Gets the registered lifecycle callbacks for an event.
- *
- * @param string $event
- *
- * @psalm-return list<string>
- */
- public function getLifecycleCallbacks($event)
- {
- return $this->lifecycleCallbacks[$event] ?? [];
- }
- /**
- * Adds a lifecycle callback for entities of this class.
- *
- * @param string $callback
- * @param string $event
- *
- * @return void
- */
- public function addLifecycleCallback($callback, $event)
- {
- if (isset($this->lifecycleCallbacks[$event]) && in_array($callback, $this->lifecycleCallbacks[$event])) {
- return;
- }
- $this->lifecycleCallbacks[$event][] = $callback;
- }
- /**
- * Sets the lifecycle callbacks for entities of this class.
- * Any previously registered callbacks are overwritten.
- *
- * @return void
- *
- * @psalm-param array<string, list<string>> $callbacks
- */
- public function setLifecycleCallbacks(array $callbacks)
- {
- $this->lifecycleCallbacks = $callbacks;
- }
- /**
- * Adds a entity listener for entities of this class.
- *
- * @param string $eventName The entity lifecycle event.
- * @param string $class The listener class.
- * @param string $method The listener callback method.
- *
- * @throws MappingException
- */
- public function addEntityListener($eventName, $class, $method)
- {
- $class = $this->fullyQualifiedClassName($class);
- $listener = [
- 'class' => $class,
- 'method' => $method,
- ];
- if (! class_exists($class)) {
- throw MappingException::entityListenerClassNotFound($class, $this->name);
- }
- if (! method_exists($class, $method)) {
- throw MappingException::entityListenerMethodNotFound($class, $method, $this->name);
- }
- if (isset($this->entityListeners[$eventName]) && in_array($listener, $this->entityListeners[$eventName])) {
- throw MappingException::duplicateEntityListener($class, $method, $this->name);
- }
- $this->entityListeners[$eventName][] = $listener;
- }
- /**
- * Sets the discriminator column definition.
- *
- * @see getDiscriminatorColumn()
- *
- * @return void
- *
- * @throws MappingException
- *
- * @psalm-param array<string, mixed> $columnDef
- */
- public function setDiscriminatorColumn($columnDef)
- {
- if ($columnDef !== null) {
- if (! isset($columnDef['name'])) {
- throw MappingException::nameIsMandatoryForDiscriminatorColumns($this->name);
- }
- if (isset($this->fieldNames[$columnDef['name']])) {
- throw MappingException::duplicateColumnName($this->name, $columnDef['name']);
- }
- if (! isset($columnDef['fieldName'])) {
- $columnDef['fieldName'] = $columnDef['name'];
- }
- if (! isset($columnDef['type'])) {
- $columnDef['type'] = 'string';
- }
- if (in_array($columnDef['type'], ['boolean', 'array', 'object', 'datetime', 'time', 'date'])) {
- throw MappingException::invalidDiscriminatorColumnType($this->name, $columnDef['type']);
- }
- $this->discriminatorColumn = $columnDef;
- }
- }
- /**
- * Sets the discriminator values used by this class.
- * Used for JOINED and SINGLE_TABLE inheritance mapping strategies.
- *
- * @return void
- *
- * @psalm-param array<string, class-string> $map
- */
- public function setDiscriminatorMap(array $map)
- {
- foreach ($map as $value => $className) {
- $this->addDiscriminatorMapClass($value, $className);
- }
- }
- /**
- * Adds one entry of the discriminator map with a new class and corresponding name.
- *
- * @param string $name
- *
- * @return void
- *
- * @throws MappingException
- *
- * @psalm-param class-string $className
- */
- public function addDiscriminatorMapClass($name, $className)
- {
- $className = $this->fullyQualifiedClassName($className);
- $className = ltrim($className, '\\');
- $this->discriminatorMap[$name] = $className;
- if ($this->name === $className) {
- $this->discriminatorValue = $name;
- return;
- }
- if (! (class_exists($className) || interface_exists($className))) {
- throw MappingException::invalidClassInDiscriminatorMap($className, $this->name);
- }
- if (is_subclass_of($className, $this->name) && ! in_array($className, $this->subClasses)) {
- $this->subClasses[] = $className;
- }
- }
- /**
- * Checks whether the class has a named query with the given query name.
- *
- * @param string $queryName
- *
- * @return bool
- */
- public function hasNamedQuery($queryName)
- {
- return isset($this->namedQueries[$queryName]);
- }
- /**
- * Checks whether the class has a named native query with the given query name.
- *
- * @param string $queryName
- *
- * @return bool
- */
- public function hasNamedNativeQuery($queryName)
- {
- return isset($this->namedNativeQueries[$queryName]);
- }
- /**
- * Checks whether the class has a named native query with the given query name.
- *
- * @param string $name
- *
- * @return bool
- */
- public function hasSqlResultSetMapping($name)
- {
- return isset($this->sqlResultSetMappings[$name]);
- }
- /**
- * {@inheritDoc}
- */
- public function hasAssociation($fieldName)
- {
- return isset($this->associationMappings[$fieldName]);
- }
- /**
- * {@inheritDoc}
- */
- public function isSingleValuedAssociation($fieldName)
- {
- return isset($this->associationMappings[$fieldName])
- && ($this->associationMappings[$fieldName]['type'] & self::TO_ONE);
- }
- /**
- * {@inheritDoc}
- */
- public function isCollectionValuedAssociation($fieldName)
- {
- return isset($this->associationMappings[$fieldName])
- && ! ($this->associationMappings[$fieldName]['type'] & self::TO_ONE);
- }
- /**
- * Is this an association that only has a single join column?
- *
- * @param string $fieldName
- *
- * @return bool
- */
- public function isAssociationWithSingleJoinColumn($fieldName)
- {
- return isset($this->associationMappings[$fieldName])
- && isset($this->associationMappings[$fieldName]['joinColumns'][0])
- && ! isset($this->associationMappings[$fieldName]['joinColumns'][1]);
- }
- /**
- * Returns the single association join column (if any).
- *
- * @param string $fieldName
- *
- * @return string
- *
- * @throws MappingException
- */
- public function getSingleAssociationJoinColumnName($fieldName)
- {
- if (! $this->isAssociationWithSingleJoinColumn($fieldName)) {
- throw MappingException::noSingleAssociationJoinColumnFound($this->name, $fieldName);
- }
- return $this->associationMappings[$fieldName]['joinColumns'][0]['name'];
- }
- /**
- * Returns the single association referenced join column name (if any).
- *
- * @param string $fieldName
- *
- * @return string
- *
- * @throws MappingException
- */
- public function getSingleAssociationReferencedJoinColumnName($fieldName)
- {
- if (! $this->isAssociationWithSingleJoinColumn($fieldName)) {
- throw MappingException::noSingleAssociationJoinColumnFound($this->name, $fieldName);
- }
- return $this->associationMappings[$fieldName]['joinColumns'][0]['referencedColumnName'];
- }
- /**
- * Used to retrieve a fieldname for either field or association from a given column.
- *
- * This method is used in foreign-key as primary-key contexts.
- *
- * @param string $columnName
- *
- * @return string
- *
- * @throws MappingException
- */
- public function getFieldForColumn($columnName)
- {
- if (isset($this->fieldNames[$columnName])) {
- return $this->fieldNames[$columnName];
- }
- foreach ($this->associationMappings as $assocName => $mapping) {
- if (
- $this->isAssociationWithSingleJoinColumn($assocName) &&
- $this->associationMappings[$assocName]['joinColumns'][0]['name'] === $columnName
- ) {
- return $assocName;
- }
- }
- throw MappingException::noFieldNameFoundForColumn($this->name, $columnName);
- }
- /**
- * Sets the ID generator used to generate IDs for instances of this class.
- *
- * @param AbstractIdGenerator $generator
- *
- * @return void
- */
- public function setIdGenerator($generator)
- {
- $this->idGenerator = $generator;
- }
- /**
- * Sets definition.
- *
- * @return void
- *
- * @psalm-param array<string, string> $definition
- */
- public function setCustomGeneratorDefinition(array $definition)
- {
- $this->customGeneratorDefinition = $definition;
- }
- /**
- * Sets the definition of the sequence ID generator for this class.
- *
- * The definition must have the following structure:
- * <code>
- * array(
- * 'sequenceName' => 'name',
- * 'allocationSize' => 20,
- * 'initialValue' => 1
- * 'quoted' => 1
- * )
- * </code>
- *
- * @return void
- *
- * @throws MappingException
- *
- * @psalm-param array<string, string> $definition
- */
- public function setSequenceGeneratorDefinition(array $definition)
- {
- if (! isset($definition['sequenceName']) || trim($definition['sequenceName']) === '') {
- throw MappingException::missingSequenceName($this->name);
- }
- if ($definition['sequenceName'][0] === '`') {
- $definition['sequenceName'] = trim($definition['sequenceName'], '`');
- $definition['quoted'] = true;
- }
- if (! isset($definition['allocationSize']) || trim($definition['allocationSize']) === '') {
- $definition['allocationSize'] = '1';
- }
- if (! isset($definition['initialValue']) || trim($definition['initialValue']) === '') {
- $definition['initialValue'] = '1';
- }
- $this->sequenceGeneratorDefinition = $definition;
- }
- /**
- * Sets the version field mapping used for versioning. Sets the default
- * value to use depending on the column type.
- *
- * @return void
- *
- * @throws MappingException
- *
- * @psalm-param array<string, mixed> $mapping The version field mapping array.
- */
- public function setVersionMapping(array &$mapping)
- {
- $this->isVersioned = true;
- $this->versionField = $mapping['fieldName'];
- if (! isset($mapping['default'])) {
- if (in_array($mapping['type'], ['integer', 'bigint', 'smallint'])) {
- $mapping['default'] = 1;
- } elseif ($mapping['type'] === 'datetime') {
- $mapping['default'] = 'CURRENT_TIMESTAMP';
- } else {
- throw MappingException::unsupportedOptimisticLockingType($this->name, $mapping['fieldName'], $mapping['type']);
- }
- }
- }
- /**
- * Sets whether this class is to be versioned for optimistic locking.
- *
- * @param bool $bool
- *
- * @return void
- */
- public function setVersioned($bool)
- {
- $this->isVersioned = $bool;
- }
- /**
- * Sets the name of the field that is to be used for versioning if this class is
- * versioned for optimistic locking.
- *
- * @param string $versionField
- *
- * @return void
- */
- public function setVersionField($versionField)
- {
- $this->versionField = $versionField;
- }
- /**
- * Marks this class as read only, no change tracking is applied to it.
- *
- * @return void
- */
- public function markReadOnly()
- {
- $this->isReadOnly = true;
- }
- /**
- * {@inheritDoc}
- */
- public function getFieldNames()
- {
- return array_keys($this->fieldMappings);
- }
- /**
- * {@inheritDoc}
- */
- public function getAssociationNames()
- {
- return array_keys($this->associationMappings);
- }
- /**
- * {@inheritDoc}
- *
- * @throws InvalidArgumentException
- */
- public function getAssociationTargetClass($assocName)
- {
- if (! isset($this->associationMappings[$assocName])) {
- throw new InvalidArgumentException("Association name expected, '" . $assocName . "' is not an association.");
- }
- return $this->associationMappings[$assocName]['targetEntity'];
- }
- /**
- * {@inheritDoc}
- */
- public function getName()
- {
- return $this->name;
- }
- /**
- * Gets the (possibly quoted) identifier column names for safe use in an SQL statement.
- *
- * @deprecated Deprecated since version 2.3 in favor of \Doctrine\ORM\Mapping\QuoteStrategy
- *
- * @param AbstractPlatform $platform
- *
- * @psalm-return list<string>
- */
- public function getQuotedIdentifierColumnNames($platform)
- {
- $quotedColumnNames = [];
- foreach ($this->identifier as $idProperty) {
- if (isset($this->fieldMappings[$idProperty])) {
- $quotedColumnNames[] = isset($this->fieldMappings[$idProperty]['quoted'])
- ? $platform->quoteIdentifier($this->fieldMappings[$idProperty]['columnName'])
- : $this->fieldMappings[$idProperty]['columnName'];
- continue;
- }
- // Association defined as Id field
- $joinColumns = $this->associationMappings[$idProperty]['joinColumns'];
- $assocQuotedColumnNames = array_map(
- static function ($joinColumn) use ($platform) {
- return isset($joinColumn['quoted'])
- ? $platform->quoteIdentifier($joinColumn['name'])
- : $joinColumn['name'];
- },
- $joinColumns
- );
- $quotedColumnNames = array_merge($quotedColumnNames, $assocQuotedColumnNames);
- }
- return $quotedColumnNames;
- }
- /**
- * Gets the (possibly quoted) column name of a mapped field for safe use in an SQL statement.
- *
- * @deprecated Deprecated since version 2.3 in favor of \Doctrine\ORM\Mapping\QuoteStrategy
- *
- * @param string $field
- * @param AbstractPlatform $platform
- *
- * @return string
- */
- public function getQuotedColumnName($field, $platform)
- {
- return isset($this->fieldMappings[$field]['quoted'])
- ? $platform->quoteIdentifier($this->fieldMappings[$field]['columnName'])
- : $this->fieldMappings[$field]['columnName'];
- }
- /**
- * Gets the (possibly quoted) primary table name of this class for safe use in an SQL statement.
- *
- * @deprecated Deprecated since version 2.3 in favor of \Doctrine\ORM\Mapping\QuoteStrategy
- *
- * @param AbstractPlatform $platform
- *
- * @return string
- */
- public function getQuotedTableName($platform)
- {
- return isset($this->table['quoted'])
- ? $platform->quoteIdentifier($this->table['name'])
- : $this->table['name'];
- }
- /**
- * Gets the (possibly quoted) name of the join table.
- *
- * @deprecated Deprecated since version 2.3 in favor of \Doctrine\ORM\Mapping\QuoteStrategy
- *
- * @param mixed[] $assoc
- * @param AbstractPlatform $platform
- *
- * @return string
- */
- public function getQuotedJoinTableName(array $assoc, $platform)
- {
- return isset($assoc['joinTable']['quoted'])
- ? $platform->quoteIdentifier($assoc['joinTable']['name'])
- : $assoc['joinTable']['name'];
- }
- /**
- * {@inheritDoc}
- */
- public function isAssociationInverseSide($fieldName)
- {
- return isset($this->associationMappings[$fieldName])
- && ! $this->associationMappings[$fieldName]['isOwningSide'];
- }
- /**
- * {@inheritDoc}
- */
- public function getAssociationMappedByTargetField($fieldName)
- {
- return $this->associationMappings[$fieldName]['mappedBy'];
- }
- /**
- * @param string $targetClass
- *
- * @psalm-return array<string, array<string, mixed>>
- */
- public function getAssociationsByTargetClass($targetClass)
- {
- $relations = [];
- foreach ($this->associationMappings as $mapping) {
- if ($mapping['targetEntity'] === $targetClass) {
- $relations[$mapping['fieldName']] = $mapping;
- }
- }
- return $relations;
- }
- /**
- * @param string|null $className
- *
- * @return string|null null if the input value is null
- *
- * @psalm-param ?class-string $className
- */
- public function fullyQualifiedClassName($className)
- {
- if (empty($className)) {
- return $className;
- }
- if ($className !== null && strpos($className, '\\') === false && $this->namespace) {
- return $this->namespace . '\\' . $className;
- }
- return $className;
- }
- /**
- * @param string $name
- *
- * @return mixed
- */
- public function getMetadataValue($name)
- {
- if (isset($this->$name)) {
- return $this->$name;
- }
- return null;
- }
- /**
- * Map Embedded Class
- *
- * @return void
- *
- * @throws MappingException
- *
- * @psalm-param array<string, mixed> $mapping
- */
- public function mapEmbedded(array $mapping)
- {
- $this->assertFieldNotMapped($mapping['fieldName']);
- $this->embeddedClasses[$mapping['fieldName']] = [
- 'class' => $this->fullyQualifiedClassName($mapping['class']),
- 'columnPrefix' => $mapping['columnPrefix'],
- 'declaredField' => $mapping['declaredField'] ?? null,
- 'originalField' => $mapping['originalField'] ?? null,
- ];
- }
- /**
- * Inline the embeddable class
- *
- * @param string $property
- */
- public function inlineEmbeddable($property, ClassMetadataInfo $embeddable)
- {
- foreach ($embeddable->fieldMappings as $fieldMapping) {
- $fieldMapping['originalClass'] = $fieldMapping['originalClass'] ?? $embeddable->name;
- $fieldMapping['declaredField'] = isset($fieldMapping['declaredField'])
- ? $property . '.' . $fieldMapping['declaredField']
- : $property;
- $fieldMapping['originalField'] = $fieldMapping['originalField'] ?? $fieldMapping['fieldName'];
- $fieldMapping['fieldName'] = $property . '.' . $fieldMapping['fieldName'];
- if (! empty($this->embeddedClasses[$property]['columnPrefix'])) {
- $fieldMapping['columnName'] = $this->embeddedClasses[$property]['columnPrefix'] . $fieldMapping['columnName'];
- } elseif ($this->embeddedClasses[$property]['columnPrefix'] !== false) {
- $fieldMapping['columnName'] = $this->namingStrategy
- ->embeddedFieldToColumnName(
- $property,
- $fieldMapping['columnName'],
- $this->reflClass->name,
- $embeddable->reflClass->name
- );
- }
- $this->mapField($fieldMapping);
- }
- }
- /**
- * @throws MappingException
- */
- private function assertFieldNotMapped(string $fieldName): void
- {
- if (
- isset($this->fieldMappings[$fieldName]) ||
- isset($this->associationMappings[$fieldName]) ||
- isset($this->embeddedClasses[$fieldName])
- ) {
- throw MappingException::duplicateFieldMapping($this->name, $fieldName);
- }
- }
- /**
- * Gets the sequence name based on class metadata.
- *
- * @return string
- *
- * @todo Sequence names should be computed in DBAL depending on the platform
- */
- public function getSequenceName(AbstractPlatform $platform)
- {
- $sequencePrefix = $this->getSequencePrefix($platform);
- $columnName = $this->getSingleIdentifierColumnName();
- return $sequencePrefix . '_' . $columnName . '_seq';
- }
- /**
- * Gets the sequence name prefix based on class metadata.
- *
- * @return string
- *
- * @todo Sequence names should be computed in DBAL depending on the platform
- */
- public function getSequencePrefix(AbstractPlatform $platform)
- {
- $tableName = $this->getTableName();
- $sequencePrefix = $tableName;
- // Prepend the schema name to the table name if there is one
- $schemaName = $this->getSchemaName();
- if ($schemaName) {
- $sequencePrefix = $schemaName . '.' . $tableName;
- if (! $platform->supportsSchemas() && $platform->canEmulateSchemas()) {
- $sequencePrefix = $schemaName . '__' . $tableName;
- }
- }
- return $sequencePrefix;
- }
- /**
- * @psalm-param array<string, mixed> $mapping
- */
- private function assertMappingOrderBy(array $mapping): void
- {
- if (isset($mapping['orderBy']) && ! is_array($mapping['orderBy'])) {
- throw new InvalidArgumentException("'orderBy' is expected to be an array, not " . gettype($mapping['orderBy']));
- }
- }
- }
|