├── .github ├── funding.yml └── workflows │ └── php.yml ├── .php-cs-fixer.php ├── CHANGELOG.md ├── LICENSE ├── README.md ├── composer.json ├── phpstan.neon └── src └── ArrayFixture.php /.github/funding.yml: -------------------------------------------------------------------------------- 1 | github: pierstoval 2 | -------------------------------------------------------------------------------- /.github/workflows/php.yml: -------------------------------------------------------------------------------- 1 | name: PHP CI 2 | 3 | on: [push] 4 | 5 | jobs: 6 | build-test: 7 | runs-on: ubuntu-latest 8 | 9 | strategy: 10 | matrix: 11 | include: 12 | - { php-version: '7.3', orm-version: '2.7', fixtures-version: '1.4' } 13 | - { php-version: '7.4', orm-version: '2.7', fixtures-version: '1.4' } 14 | - { php-version: '8.0', orm-version: '2.7', fixtures-version: '1.4' } 15 | - { php-version: '8.1', orm-version: '2.7', fixtures-version: '1.4' } 16 | - { php-version: '8.2', orm-version: '2.7', fixtures-version: '1.4' } 17 | - { php-version: '8.3', orm-version: '2.7', fixtures-version: '1.4' } 18 | - { php-version: '8.4', orm-version: '2.7', fixtures-version: '1.4' } 19 | 20 | - { php-version: '8.1', orm-version: '3.0', fixtures-version: '1.4' } 21 | - { php-version: '8.2', orm-version: '3.0', fixtures-version: '1.4' } 22 | - { php-version: '8.4', orm-version: '3.0', fixtures-version: '1.4' } 23 | 24 | - { php-version: '8.1', orm-version: '2.7', fixtures-version: '2.0' } 25 | - { php-version: '8.2', orm-version: '2.7', fixtures-version: '2.0' } 26 | - { php-version: '8.3', orm-version: '2.7', fixtures-version: '2.0' } 27 | - { php-version: '8.4', orm-version: '2.7', fixtures-version: '2.0' } 28 | 29 | - { php-version: '8.1', orm-version: '3.0', fixtures-version: '2.0' } 30 | - { php-version: '8.2', orm-version: '3.0', fixtures-version: '2.0' } 31 | - { php-version: '8.4', orm-version: '3.0', fixtures-version: '2.0' } 32 | 33 | name: PHP ${{ matrix.php-version }} / ORM ${{ matrix.orm-version }} / Fixtures ${{ matrix.fixtures-version }} 34 | steps: 35 | - uses: actions/checkout@v2 36 | 37 | - uses: shivammathur/setup-php@v2 38 | with: 39 | php-version: "${{ matrix.php-version }}" 40 | extensions: gd, zip, mongodb 41 | 42 | - run: composer validate 43 | 44 | - id: composer-cache 45 | run: echo "::set-output name=dir::$(composer config cache-files-dir)" 46 | 47 | - uses: actions/cache@v1 48 | with: 49 | path: ${{ steps.composer-cache.outputs.dir }} 50 | key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }} 51 | restore-keys: ${{ runner.os }}-composer- 52 | 53 | - run: | 54 | composer require --dev --no-update \ 55 | "doctrine/orm:^${{ matrix.orm-version }}" \ 56 | "doctrine/data-fixtures:^${{ matrix.fixtures-version }}" 57 | 58 | - run: composer install 59 | 60 | - run: vendor/bin/phpunit 61 | -------------------------------------------------------------------------------- /.php-cs-fixer.php: -------------------------------------------------------------------------------- 1 | and Studio Agate. 9 | * 10 | * For the full copyright and license information, please view the LICENSE 11 | * file that was distributed with this source code. 12 | */ 13 | 14 | $header = <<<'HEADER' 15 | This file is part of the Orbitale ArrayFixture package. 16 | 17 | (c) Alexandre Rock Ancelet 18 | 19 | For the full copyright and license information, please view the LICENSE 20 | file that was distributed with this source code. 21 | HEADER; 22 | 23 | $finder = PhpCsFixer\Finder::create() 24 | ->exclude([ 25 | '.php_cs', 26 | 'public', 27 | 'vendor', 28 | 'var', 29 | ]) 30 | ->in([ 31 | __DIR__.'/src/', 32 | __DIR__.'/tests/', 33 | ]) 34 | ; 35 | 36 | return (new PhpCsFixer\Config()) 37 | ->setRules([ 38 | 'header_comment' => [ 39 | 'header' => $header, 40 | ], 41 | '@DoctrineAnnotation' => true, 42 | '@Symfony' => true, 43 | '@Symfony:risky' => true, 44 | '@PhpCsFixer' => true, 45 | '@PhpCsFixer:risky' => true, 46 | '@PHP70Migration' => true, 47 | '@PHP70Migration:risky' => true, 48 | '@PHP71Migration' => true, 49 | '@PHP71Migration:risky' => true, 50 | '@PHP73Migration' => true, 51 | 52 | // Rules in no set 53 | 'linebreak_after_opening_tag' => true, // More readability. 54 | 'no_php4_constructor' => true, // These are deprecated, so... 55 | 'simplified_null_return' => true, // Removes useless code. 56 | 'global_namespace_import' => true, // Add a "use" statement for everything in the global namespace. 57 | 'native_constant_invocation' => [ 58 | 'include' => ['@all'], 59 | 'scope' => 'namespaced', 60 | ], 61 | 'native_function_invocation' => [ 62 | 'include' => ['@all'], 63 | 'scope' => 'namespaced', 64 | ], 65 | 66 | // Some overrides of existing sets 67 | 'yoda_style' => false, 68 | 'mb_str_functions' => false, // mbstring can be much slower than native str functions. 69 | 'increment_style' => false, // It's quite pointless and reduces readability. Unless executed billions of times in one row. 70 | 'non_printable_character' => false, // Sometimes they're really useful. And it allows writing non-breakable spaces in test names! 71 | 'php_unit_test_class_requires_covers' => false, // From the @PhpCsFixer set, adds "@coversNothing" annots in all tests, so to avoid phpdoc pollution and "proper" coverage, it needs to be disabled. 72 | 'php_unit_internal_class' => false, // From the @PhpCsFixer set, adds "@internal" to all tests. Even though it's a good practice, it's not really useful for most projects. 73 | 'php_unit_dedicate_assert' => ['target' => 'newest'], // Changes assertions like "assertTrue(is_nan($a))" to "assertNan()", etc. 74 | 'php_unit_dedicate_assert_internal_type' => ['target' => 'newest'], // Changes assertions like "assertInternalType("array", ...)" to "assertIsArray()", etc. 75 | ]) 76 | ->setRiskyAllowed(true) 77 | ->setIndent(' ') 78 | ->setLineEnding("\n") 79 | ->setUsingCache(true) 80 | ->setFinder($finder) 81 | ; 82 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # v1.3.6 2 | 3 | * Ensure PHP 8.4 compatibility 4 | * Add doctrine/persistence 4.0 compatibility 5 | * Add doctrine/data-fixtures 2.0 compatibility 6 | 7 | # v1.3.5 8 | 9 | * Ensure PHP 8.3 compatibility 10 | * Add doctrine/orm 3.0 compatibility 11 | * Test over doctrine orm 2 and 3 12 | 13 | # v1.3.4 14 | 15 | * Allow using doctrine/instantiator ^2.0 16 | * Fix a test with latest DataFixtures versions 17 | 18 | # v1.3.3 19 | 20 | * Allow using doctrine/persistence ^3.0 21 | 22 | # v1.3.2 23 | 24 | * Test the package on PHP 8.1 25 | * Fix phpstan issues 26 | * Migrate to phpstan 1.0 27 | * Fix PHPUnit's XSD path and use local one 28 | 29 | # v1.3.1 30 | 31 | * Fix compatibility with Doctrine ODM 32 | 33 | # v1.3.0 34 | 35 | * Remove php 7.2 support 36 | * Update wrongly license after latest release (I updated the LICENSE file but forgot to update it in Composer, bly me). 37 | * Refresh & clean the test suite with latest PHPUnit version 38 | 39 | # v1.2.0 40 | 41 | * Change license from AGPL-3.0 to LGPL-2.1 42 | 43 | # v1.1.1 44 | 45 | * Widen `doctrine/persistence` version dependency. 46 | 47 | # v1.1.0 48 | 49 | * Removed `OrderedFixtureInterface` implementation, because it conflicts with `DependentFixtureInterface`. 50 | * Deprecated `getOrder` method: it has to be implemented manually if needed. 51 | 52 | # v1.0.2 53 | 54 | * Instead of PHP 7.4, now supporting 7.3, 7.2 and 8.0 as well. 55 | * Refactored entire CI to make tests on all OSes and supported PHP versions. 56 | 57 | # v1.0.1 58 | 59 | * Fixed `ArrayFixture::getObjects()` return type's documentation to `array[]` instead of `object[]` 60 | * Added `phpstan` rules to add some code quality documentation and typing. 61 | 62 | # v1.0.0 63 | 64 | First release 65 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 2.1, February 1999 3 | 4 | Copyright (C) 1991, 1999 Free Software Foundation, Inc. 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | [This is the first released version of the Lesser GPL. It also counts 10 | as the successor of the GNU Library Public License, version 2, hence 11 | the version number 2.1.] 12 | 13 | Preamble 14 | 15 | The licenses for most software are designed to take away your 16 | freedom to share and change it. By contrast, the GNU General Public 17 | Licenses are intended to guarantee your freedom to share and change 18 | free software--to make sure the software is free for all its users. 19 | 20 | This license, the Lesser General Public License, applies to some 21 | specially designated software packages--typically libraries--of the 22 | Free Software Foundation and other authors who decide to use it. You 23 | can use it too, but we suggest you first think carefully about whether 24 | this license or the ordinary General Public License is the better 25 | strategy to use in any particular case, based on the explanations below. 26 | 27 | When we speak of free software, we are referring to freedom of use, 28 | not price. Our General Public Licenses are designed to make sure that 29 | you have the freedom to distribute copies of free software (and charge 30 | for this service if you wish); that you receive source code or can get 31 | it if you want it; that you can change the software and use pieces of 32 | it in new free programs; and that you are informed that you can do 33 | these things. 34 | 35 | To protect your rights, we need to make restrictions that forbid 36 | distributors to deny you these rights or to ask you to surrender these 37 | rights. These restrictions translate to certain responsibilities for 38 | you if you distribute copies of the library or if you modify it. 39 | 40 | For example, if you distribute copies of the library, whether gratis 41 | or for a fee, you must give the recipients all the rights that we gave 42 | you. You must make sure that they, too, receive or can get the source 43 | code. If you link other code with the library, you must provide 44 | complete object files to the recipients, so that they can relink them 45 | with the library after making changes to the library and recompiling 46 | it. And you must show them these terms so they know their rights. 47 | 48 | We protect your rights with a two-step method: (1) we copyright the 49 | library, and (2) we offer you this license, which gives you legal 50 | permission to copy, distribute and/or modify the library. 51 | 52 | To protect each distributor, we want to make it very clear that 53 | there is no warranty for the free library. Also, if the library is 54 | modified by someone else and passed on, the recipients should know 55 | that what they have is not the original version, so that the original 56 | author's reputation will not be affected by problems that might be 57 | introduced by others. 58 | 59 | Finally, software patents pose a constant threat to the existence of 60 | any free program. We wish to make sure that a company cannot 61 | effectively restrict the users of a free program by obtaining a 62 | restrictive license from a patent holder. Therefore, we insist that 63 | any patent license obtained for a version of the library must be 64 | consistent with the full freedom of use specified in this license. 65 | 66 | Most GNU software, including some libraries, is covered by the 67 | ordinary GNU General Public License. This license, the GNU Lesser 68 | General Public License, applies to certain designated libraries, and 69 | is quite different from the ordinary General Public License. We use 70 | this license for certain libraries in order to permit linking those 71 | libraries into non-free programs. 72 | 73 | When a program is linked with a library, whether statically or using 74 | a shared library, the combination of the two is legally speaking a 75 | combined work, a derivative of the original library. The ordinary 76 | General Public License therefore permits such linking only if the 77 | entire combination fits its criteria of freedom. The Lesser General 78 | Public License permits more lax criteria for linking other code with 79 | the library. 80 | 81 | We call this license the "Lesser" General Public License because it 82 | does Less to protect the user's freedom than the ordinary General 83 | Public License. It also provides other free software developers Less 84 | of an advantage over competing non-free programs. These disadvantages 85 | are the reason we use the ordinary General Public License for many 86 | libraries. However, the Lesser license provides advantages in certain 87 | special circumstances. 88 | 89 | For example, on rare occasions, there may be a special need to 90 | encourage the widest possible use of a certain library, so that it becomes 91 | a de-facto standard. To achieve this, non-free programs must be 92 | allowed to use the library. A more frequent case is that a free 93 | library does the same job as widely used non-free libraries. In this 94 | case, there is little to gain by limiting the free library to free 95 | software only, so we use the Lesser General Public License. 96 | 97 | In other cases, permission to use a particular library in non-free 98 | programs enables a greater number of people to use a large body of 99 | free software. For example, permission to use the GNU C Library in 100 | non-free programs enables many more people to use the whole GNU 101 | operating system, as well as its variant, the GNU/Linux operating 102 | system. 103 | 104 | Although the Lesser General Public License is Less protective of the 105 | users' freedom, it does ensure that the user of a program that is 106 | linked with the Library has the freedom and the wherewithal to run 107 | that program using a modified version of the Library. 108 | 109 | The precise terms and conditions for copying, distribution and 110 | modification follow. Pay close attention to the difference between a 111 | "work based on the library" and a "work that uses the library". The 112 | former contains code derived from the library, whereas the latter must 113 | be combined with the library in order to run. 114 | 115 | GNU LESSER GENERAL PUBLIC LICENSE 116 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 117 | 118 | 0. This License Agreement applies to any software library or other 119 | program which contains a notice placed by the copyright holder or 120 | other authorized party saying it may be distributed under the terms of 121 | this Lesser General Public License (also called "this License"). 122 | Each licensee is addressed as "you". 123 | 124 | A "library" means a collection of software functions and/or data 125 | prepared so as to be conveniently linked with application programs 126 | (which use some of those functions and data) to form executables. 127 | 128 | The "Library", below, refers to any such software library or work 129 | which has been distributed under these terms. A "work based on the 130 | Library" means either the Library or any derivative work under 131 | copyright law: that is to say, a work containing the Library or a 132 | portion of it, either verbatim or with modifications and/or translated 133 | straightforwardly into another language. (Hereinafter, translation is 134 | included without limitation in the term "modification".) 135 | 136 | "Source code" for a work means the preferred form of the work for 137 | making modifications to it. For a library, complete source code means 138 | all the source code for all modules it contains, plus any associated 139 | interface definition files, plus the scripts used to control compilation 140 | and installation of the library. 141 | 142 | Activities other than copying, distribution and modification are not 143 | covered by this License; they are outside its scope. The act of 144 | running a program using the Library is not restricted, and output from 145 | such a program is covered only if its contents constitute a work based 146 | on the Library (independent of the use of the Library in a tool for 147 | writing it). Whether that is true depends on what the Library does 148 | and what the program that uses the Library does. 149 | 150 | 1. You may copy and distribute verbatim copies of the Library's 151 | complete source code as you receive it, in any medium, provided that 152 | you conspicuously and appropriately publish on each copy an 153 | appropriate copyright notice and disclaimer of warranty; keep intact 154 | all the notices that refer to this License and to the absence of any 155 | warranty; and distribute a copy of this License along with the 156 | Library. 157 | 158 | You may charge a fee for the physical act of transferring a copy, 159 | and you may at your option offer warranty protection in exchange for a 160 | fee. 161 | 162 | 2. You may modify your copy or copies of the Library or any portion 163 | of it, thus forming a work based on the Library, and copy and 164 | distribute such modifications or work under the terms of Section 1 165 | above, provided that you also meet all of these conditions: 166 | 167 | a) The modified work must itself be a software library. 168 | 169 | b) You must cause the files modified to carry prominent notices 170 | stating that you changed the files and the date of any change. 171 | 172 | c) You must cause the whole of the work to be licensed at no 173 | charge to all third parties under the terms of this License. 174 | 175 | d) If a facility in the modified Library refers to a function or a 176 | table of data to be supplied by an application program that uses 177 | the facility, other than as an argument passed when the facility 178 | is invoked, then you must make a good faith effort to ensure that, 179 | in the event an application does not supply such function or 180 | table, the facility still operates, and performs whatever part of 181 | its purpose remains meaningful. 182 | 183 | (For example, a function in a library to compute square roots has 184 | a purpose that is entirely well-defined independent of the 185 | application. Therefore, Subsection 2d requires that any 186 | application-supplied function or table used by this function must 187 | be optional: if the application does not supply it, the square 188 | root function must still compute square roots.) 189 | 190 | These requirements apply to the modified work as a whole. If 191 | identifiable sections of that work are not derived from the Library, 192 | and can be reasonably considered independent and separate works in 193 | themselves, then this License, and its terms, do not apply to those 194 | sections when you distribute them as separate works. But when you 195 | distribute the same sections as part of a whole which is a work based 196 | on the Library, the distribution of the whole must be on the terms of 197 | this License, whose permissions for other licensees extend to the 198 | entire whole, and thus to each and every part regardless of who wrote 199 | it. 200 | 201 | Thus, it is not the intent of this section to claim rights or contest 202 | your rights to work written entirely by you; rather, the intent is to 203 | exercise the right to control the distribution of derivative or 204 | collective works based on the Library. 205 | 206 | In addition, mere aggregation of another work not based on the Library 207 | with the Library (or with a work based on the Library) on a volume of 208 | a storage or distribution medium does not bring the other work under 209 | the scope of this License. 210 | 211 | 3. You may opt to apply the terms of the ordinary GNU General Public 212 | License instead of this License to a given copy of the Library. To do 213 | this, you must alter all the notices that refer to this License, so 214 | that they refer to the ordinary GNU General Public License, version 2, 215 | instead of to this License. (If a newer version than version 2 of the 216 | ordinary GNU General Public License has appeared, then you can specify 217 | that version instead if you wish.) Do not make any other change in 218 | these notices. 219 | 220 | Once this change is made in a given copy, it is irreversible for 221 | that copy, so the ordinary GNU General Public License applies to all 222 | subsequent copies and derivative works made from that copy. 223 | 224 | This option is useful when you wish to copy part of the code of 225 | the Library into a program that is not a library. 226 | 227 | 4. You may copy and distribute the Library (or a portion or 228 | derivative of it, under Section 2) in object code or executable form 229 | under the terms of Sections 1 and 2 above provided that you accompany 230 | it with the complete corresponding machine-readable source code, which 231 | must be distributed under the terms of Sections 1 and 2 above on a 232 | medium customarily used for software interchange. 233 | 234 | If distribution of object code is made by offering access to copy 235 | from a designated place, then offering equivalent access to copy the 236 | source code from the same place satisfies the requirement to 237 | distribute the source code, even though third parties are not 238 | compelled to copy the source along with the object code. 239 | 240 | 5. A program that contains no derivative of any portion of the 241 | Library, but is designed to work with the Library by being compiled or 242 | linked with it, is called a "work that uses the Library". Such a 243 | work, in isolation, is not a derivative work of the Library, and 244 | therefore falls outside the scope of this License. 245 | 246 | However, linking a "work that uses the Library" with the Library 247 | creates an executable that is a derivative of the Library (because it 248 | contains portions of the Library), rather than a "work that uses the 249 | library". The executable is therefore covered by this License. 250 | Section 6 states terms for distribution of such executables. 251 | 252 | When a "work that uses the Library" uses material from a header file 253 | that is part of the Library, the object code for the work may be a 254 | derivative work of the Library even though the source code is not. 255 | Whether this is true is especially significant if the work can be 256 | linked without the Library, or if the work is itself a library. The 257 | threshold for this to be true is not precisely defined by law. 258 | 259 | If such an object file uses only numerical parameters, data 260 | structure layouts and accessors, and small macros and small inline 261 | functions (ten lines or less in length), then the use of the object 262 | file is unrestricted, regardless of whether it is legally a derivative 263 | work. (Executables containing this object code plus portions of the 264 | Library will still fall under Section 6.) 265 | 266 | Otherwise, if the work is a derivative of the Library, you may 267 | distribute the object code for the work under the terms of Section 6. 268 | Any executables containing that work also fall under Section 6, 269 | whether or not they are linked directly with the Library itself. 270 | 271 | 6. As an exception to the Sections above, you may also combine or 272 | link a "work that uses the Library" with the Library to produce a 273 | work containing portions of the Library, and distribute that work 274 | under terms of your choice, provided that the terms permit 275 | modification of the work for the customer's own use and reverse 276 | engineering for debugging such modifications. 277 | 278 | You must give prominent notice with each copy of the work that the 279 | Library is used in it and that the Library and its use are covered by 280 | this License. You must supply a copy of this License. If the work 281 | during execution displays copyright notices, you must include the 282 | copyright notice for the Library among them, as well as a reference 283 | directing the user to the copy of this License. Also, you must do one 284 | of these things: 285 | 286 | a) Accompany the work with the complete corresponding 287 | machine-readable source code for the Library including whatever 288 | changes were used in the work (which must be distributed under 289 | Sections 1 and 2 above); and, if the work is an executable linked 290 | with the Library, with the complete machine-readable "work that 291 | uses the Library", as object code and/or source code, so that the 292 | user can modify the Library and then relink to produce a modified 293 | executable containing the modified Library. (It is understood 294 | that the user who changes the contents of definitions files in the 295 | Library will not necessarily be able to recompile the application 296 | to use the modified definitions.) 297 | 298 | b) Use a suitable shared library mechanism for linking with the 299 | Library. A suitable mechanism is one that (1) uses at run time a 300 | copy of the library already present on the user's computer system, 301 | rather than copying library functions into the executable, and (2) 302 | will operate properly with a modified version of the library, if 303 | the user installs one, as long as the modified version is 304 | interface-compatible with the version that the work was made with. 305 | 306 | c) Accompany the work with a written offer, valid for at 307 | least three years, to give the same user the materials 308 | specified in Subsection 6a, above, for a charge no more 309 | than the cost of performing this distribution. 310 | 311 | d) If distribution of the work is made by offering access to copy 312 | from a designated place, offer equivalent access to copy the above 313 | specified materials from the same place. 314 | 315 | e) Verify that the user has already received a copy of these 316 | materials or that you have already sent this user a copy. 317 | 318 | For an executable, the required form of the "work that uses the 319 | Library" must include any data and utility programs needed for 320 | reproducing the executable from it. However, as a special exception, 321 | the materials to be distributed need not include anything that is 322 | normally distributed (in either source or binary form) with the major 323 | components (compiler, kernel, and so on) of the operating system on 324 | which the executable runs, unless that component itself accompanies 325 | the executable. 326 | 327 | It may happen that this requirement contradicts the license 328 | restrictions of other proprietary libraries that do not normally 329 | accompany the operating system. Such a contradiction means you cannot 330 | use both them and the Library together in an executable that you 331 | distribute. 332 | 333 | 7. You may place library facilities that are a work based on the 334 | Library side-by-side in a single library together with other library 335 | facilities not covered by this License, and distribute such a combined 336 | library, provided that the separate distribution of the work based on 337 | the Library and of the other library facilities is otherwise 338 | permitted, and provided that you do these two things: 339 | 340 | a) Accompany the combined library with a copy of the same work 341 | based on the Library, uncombined with any other library 342 | facilities. This must be distributed under the terms of the 343 | Sections above. 344 | 345 | b) Give prominent notice with the combined library of the fact 346 | that part of it is a work based on the Library, and explaining 347 | where to find the accompanying uncombined form of the same work. 348 | 349 | 8. You may not copy, modify, sublicense, link with, or distribute 350 | the Library except as expressly provided under this License. Any 351 | attempt otherwise to copy, modify, sublicense, link with, or 352 | distribute the Library is void, and will automatically terminate your 353 | rights under this License. However, parties who have received copies, 354 | or rights, from you under this License will not have their licenses 355 | terminated so long as such parties remain in full compliance. 356 | 357 | 9. You are not required to accept this License, since you have not 358 | signed it. However, nothing else grants you permission to modify or 359 | distribute the Library or its derivative works. These actions are 360 | prohibited by law if you do not accept this License. Therefore, by 361 | modifying or distributing the Library (or any work based on the 362 | Library), you indicate your acceptance of this License to do so, and 363 | all its terms and conditions for copying, distributing or modifying 364 | the Library or works based on it. 365 | 366 | 10. Each time you redistribute the Library (or any work based on the 367 | Library), the recipient automatically receives a license from the 368 | original licensor to copy, distribute, link with or modify the Library 369 | subject to these terms and conditions. You may not impose any further 370 | restrictions on the recipients' exercise of the rights granted herein. 371 | You are not responsible for enforcing compliance by third parties with 372 | this License. 373 | 374 | 11. If, as a consequence of a court judgment or allegation of patent 375 | infringement or for any other reason (not limited to patent issues), 376 | conditions are imposed on you (whether by court order, agreement or 377 | otherwise) that contradict the conditions of this License, they do not 378 | excuse you from the conditions of this License. If you cannot 379 | distribute so as to satisfy simultaneously your obligations under this 380 | License and any other pertinent obligations, then as a consequence you 381 | may not distribute the Library at all. For example, if a patent 382 | license would not permit royalty-free redistribution of the Library by 383 | all those who receive copies directly or indirectly through you, then 384 | the only way you could satisfy both it and this License would be to 385 | refrain entirely from distribution of the Library. 386 | 387 | If any portion of this section is held invalid or unenforceable under any 388 | particular circumstance, the balance of the section is intended to apply, 389 | and the section as a whole is intended to apply in other circumstances. 390 | 391 | It is not the purpose of this section to induce you to infringe any 392 | patents or other property right claims or to contest validity of any 393 | such claims; this section has the sole purpose of protecting the 394 | integrity of the free software distribution system which is 395 | implemented by public license practices. Many people have made 396 | generous contributions to the wide range of software distributed 397 | through that system in reliance on consistent application of that 398 | system; it is up to the author/donor to decide if he or she is willing 399 | to distribute software through any other system and a licensee cannot 400 | impose that choice. 401 | 402 | This section is intended to make thoroughly clear what is believed to 403 | be a consequence of the rest of this License. 404 | 405 | 12. If the distribution and/or use of the Library is restricted in 406 | certain countries either by patents or by copyrighted interfaces, the 407 | original copyright holder who places the Library under this License may add 408 | an explicit geographical distribution limitation excluding those countries, 409 | so that distribution is permitted only in or among countries not thus 410 | excluded. In such case, this License incorporates the limitation as if 411 | written in the body of this License. 412 | 413 | 13. The Free Software Foundation may publish revised and/or new 414 | versions of the Lesser General Public License from time to time. 415 | Such new versions will be similar in spirit to the present version, 416 | but may differ in detail to address new problems or concerns. 417 | 418 | Each version is given a distinguishing version number. If the Library 419 | specifies a version number of this License which applies to it and 420 | "any later version", you have the option of following the terms and 421 | conditions either of that version or of any later version published by 422 | the Free Software Foundation. If the Library does not specify a 423 | license version number, you may choose any version ever published by 424 | the Free Software Foundation. 425 | 426 | 14. If you wish to incorporate parts of the Library into other free 427 | programs whose distribution conditions are incompatible with these, 428 | write to the author to ask for permission. For software which is 429 | copyrighted by the Free Software Foundation, write to the Free 430 | Software Foundation; we sometimes make exceptions for this. Our 431 | decision will be guided by the two goals of preserving the free status 432 | of all derivatives of our free software and of promoting the sharing 433 | and reuse of software generally. 434 | 435 | NO WARRANTY 436 | 437 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 438 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 439 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 440 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY 441 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 442 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 443 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 444 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME 445 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 446 | 447 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 448 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 449 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU 450 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR 451 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 452 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING 453 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A 454 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF 455 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 456 | DAMAGES. 457 | 458 | END OF TERMS AND CONDITIONS 459 | 460 | How to Apply These Terms to Your New Libraries 461 | 462 | If you develop a new library, and you want it to be of the greatest 463 | possible use to the public, we recommend making it free software that 464 | everyone can redistribute and change. You can do so by permitting 465 | redistribution under these terms (or, alternatively, under the terms of the 466 | ordinary General Public License). 467 | 468 | To apply these terms, attach the following notices to the library. It is 469 | safest to attach them to the start of each source file to most effectively 470 | convey the exclusion of warranty; and each file should have at least the 471 | "copyright" line and a pointer to where the full notice is found. 472 | 473 | 474 | Copyright (C) 475 | 476 | This library is free software; you can redistribute it and/or 477 | modify it under the terms of the GNU Lesser General Public 478 | License as published by the Free Software Foundation; either 479 | version 2.1 of the License, or (at your option) any later version. 480 | 481 | This library is distributed in the hope that it will be useful, 482 | but WITHOUT ANY WARRANTY; without even the implied warranty of 483 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 484 | Lesser General Public License for more details. 485 | 486 | You should have received a copy of the GNU Lesser General Public 487 | License along with this library; if not, write to the Free Software 488 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 489 | USA 490 | 491 | Also add information on how to contact you by electronic and paper mail. 492 | 493 | You should also get your employer (if you work as a programmer) or your 494 | school, if any, to sign a "copyright disclaimer" for the library, if 495 | necessary. Here is a sample; alter the names: 496 | 497 | Yoyodyne, Inc., hereby disclaims all copyright interest in the 498 | library `Frob' (a library for tweaking knobs) written by James Random 499 | Hacker. 500 | 501 | , 1 April 1990 502 | Ty Coon, President of Vice 503 | 504 | That's all there is to it! 505 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Orbitale Array Fixture 2 | ====================== 3 | 4 | A Doctrine Data Fixture service that allow you to write your fixtures as PHP arrays. 5 | 6 | ## Installation 7 | 8 | Install the library in your project with [Composer](https://getcomposer.org): 9 | 10 | ```php 11 | composer require orbitale/array-fixture 12 | ``` 13 | 14 | ## Why? 15 | 16 | Doctrine Fixtures examples across the web mostly look like this: 17 | 18 | ```php 19 | setTitle('First post'); 33 | $post->setDescription('Lorem ipsum'); 34 | 35 | $manager->persist($post); 36 | $manager->flush(); 37 | } 38 | } 39 | ``` 40 | 41 | This example contains two main issues: 42 | 43 | * It is **very verbose**: you do everything by hand. 44 | * Your entities **must** have setters, and therefore expose an [anemic model](https://en.wikipedia.org/wiki/Anemic_domain_model). 45 | 46 | This package provides a Fixture class you can use (with or without the [DoctrineBundle](https://github.com/doctrine/DoctrineBundle)) that allows you to write **PHP arrays** instead of objects and manual instructions. 47 | 48 | The biggest advantage is that you can easily get a raw PHP export of your database (such as with PhpMyAdmin) and put it inside the fixture (this requires checking fields names, but search/replace will handily help making this fast), or you can also fetch data from any source (Fixtures are registered as services when using them in Symfony, so you could inject any service in their constructor) and return it as a PHP array (such as fetching from an API, a CSV file, a Yaml file, etc.). 49 | 50 | There are some specific features that are however only available in pure PHP mode (like getting references and using a `Closure` to populate the field). 51 | 52 | ## Usage 53 | 54 | Here is an example of a standard fixtures class: 55 | 56 | ```php 57 | 'First post', 'description' => 'Lorem ipsum']; 75 | yield ['title' => 'Second post', 'description' => 'muspi meroL']; 76 | } 77 | } 78 | ``` 79 | 80 | Let's explain: 81 | 82 | * We are extending the `ArrayFixture` class from this package 83 | * You must implement `ORMFixtureInterface` yourself to allow Symfony to autoconfigure this fixture as a service. This is **mandatory when using Symfony and the DoctrineBundle**. 84 | * The `getEntityClass()` method needs to know which Entity will be managed by this Fixture class. 85 | * The `getObjects()` method must return an `iterable`, so it could either be an `array` or a `Generator`, since the fixture will only loop on it.
86 | Every array in `getObjects()` will be hydrated in an instance of the Entity class, **without the need for setters**. Bye anemic entities!
87 | Then, new entity is persisted. 88 | 89 | After all entities are hydrated and persisted, the Entity Manager will be flushed, and entities will be saved in your database. 90 | 91 | ### References 92 | 93 | Sometimes, an entity depends on another to be populated. 94 | 95 | With this Fixture class, it becomes much simpler since a few methods can be overriden in order to simplify the understanding on how our entities are persisted. 96 | 97 | **ℹ Note:** For this, you must determine in which order these fixtures must be executed, by implementing either the `Doctrine\Common\DataFixtures\OrderedFixtureInterface` or `Doctrine\Common\DataFixtures\DependentFixtureInterface` interfaces (but not both!). 98 | 99 | See the examples: 100 | 101 | ```php 102 | 'Some tag'], 131 | ]; 132 | } 133 | } 134 | ``` 135 | 136 | Thanks to the overrides of `getReferencePrefix` and `getMethodNameForReference`, after each `Tag` is persisted, the Fixture will add a reference of the tag in the memory by calling this: 137 | 138 | ```php 139 | $this->addReference($this->getReferencePrefix().$tag->getName(), $tag); 140 | ``` 141 | 142 | Then, we can create the `PostFixtures` and fetch the reference just like we would do with any common Fixture: 143 | 144 | ```php 145 | 'First post', 165 | 'tags' => [ 166 | $this->getReference('tags-Some tag'), 167 | ], 168 | ], 169 | ]; 170 | } 171 | } 172 | ``` 173 | 174 | Here, we reuse the `Some tag` tag name and the `tags-` prefix that were specified in the `TagFixtures`! 175 | 176 | **🚀Pro tip:** You can also use a **class constant** in `TagFixtures` (or any other class) for the tag name (`"Some tag"` here) and reuse it in your tests, this will allow you to change `Some Tag` to something else without breaking your tests! 177 | 178 | ### Using a callable to get a self-referenced entity 179 | 180 | When you have self-referencing relationships, you may need a reference of an object that may have already been persisted. 181 | 182 | For this, first, you should set the `flushEveryXIterations` option to `1` (view below) to allow flushing every entity. **Be careful, because flushing every time is more time-consuming.** Don't do this if you have a lot of entities to process in your fixture (like hundreds). 183 | 184 | Next, you can set a `callable` element as the value of your object so you can interact manually with the injected object 185 | as 1st argument, and the `AbstractFixture` object as 2nd argument. 186 | 187 | The `EntityManagerInterface` is also injected as 3rd argument in case you need to do some specific requests or query through another 188 | table. 189 | 190 | Example here: 191 | 192 | ```php 193 | getReference('posts-1'); 212 | * where '1' is the post id. 213 | */ 214 | public function getReferencePrefix(): ?string 215 | { 216 | return 'posts-'; 217 | } 218 | 219 | protected function flushEveryXIterations(): int 220 | { 221 | return 1; 222 | } 223 | 224 | public function getObjects(): array 225 | { 226 | return [ 227 | ['id' => 1, 'title' => 'First post', 'parent' => null], 228 | [ 229 | 'title' => 'Second post', 230 | 'parent' => function(Post $object, ArrayFixture $fixture, EntityManagerInterface $manager) { 231 | return $fixture->getReference('posts-1'); 232 | }, 233 | ], 234 | ]; 235 | } 236 | } 237 | ``` 238 | 239 | This allows perfect synchronicity when dealing with self-referencing relations. 240 | 241 | The advantage of closures is that you can also use external references by using a `use (...)` directive in the closure definition, or you can also call the entity itself, the fixture or the entity manager since they are passed as arguments (as in the example) to the closure at runtime. 242 | 243 | ### Insert primary keys 244 | 245 | If you want, you can specify the primary key field of your entity, like this: 246 | 247 | ```php 248 | public function getObjects(): array 249 | { 250 | return [ 251 | ['id' => 1, 'title' => 'Post 1'], 252 | ['id' => 2, 'title' => 'Post 2'], 253 | ]; 254 | } 255 | ``` 256 | 257 | If your primary key name is different than `id`, it's fine: the fixture class uses Doctrine's `Metadata` in order to detect your primary key. 258 | 259 | This is really efficient when using `uuid` as field type for your entities, as UUIDs can be generated either from the database or from your code itself, and Doctrine will take it in account, contrary to auto-increment-integer fields that need a feedback from the database to generate the ID. 260 | 261 | Note that this feature is not yet compatible with composite primary keys (yet, feel free to help if you know some about this!). 262 | 263 | ## `ArrayFixture` class reference 264 | 265 | The `ArrayFixture` class contains several `protected` methods you can override for your needs: 266 | 267 | * `getReferencePrefix()` (default `null`)
268 | Used to make the Fixture class call `$this->addReference()` after each entity is persisted.
269 | References are stored as `{referencePrefix}-{id|__toString()|specific method name}`. 270 | * `getMethodNameForReference()` (default `getId`)
271 | Used to specify which method on the object is used to specify the reference.
272 | Defaults to `getId`, always falls back to `__toString()` if exists, throws an exception in case method doesn't exist. 273 | * `flushEveryXIterations()` (default `0`)
274 | Used to flush in batches instead of flushing only once at the end of all fixtures persist. 275 | * `disableLogger()` (default `true`)
276 | Used to disable SQL queries logging, useful to save memory at runtime when you have hundreds of entities to save. 277 | * `clearEntityManagerOnFlush()` (default `true`)
278 | Used to make sure the Entity manager is totally cleared after a `flush()`, this saves Doctrine from potential memory leaks or high memory consumption, but at the cost of needing to make more queries if you need to fetch objects from the database, even though this is supposed to be a really rare and edgy case. 279 | * `createNewInstance(array $data)`
280 | This method is here to automatically instantiate your object **without constructor** and populate its properties **without setters**.
281 | You can override it in case you have a very custom way of handling object creation, even though this library should be sufficient. 282 | 283 | ## License and Copyright 284 | 285 | This project is licensed under LGPL-2.1. Check the [LICENSE](./LICENSE) file for more details. 286 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "orbitale/array-fixture", 3 | "description": "A Doctrine Data Fixture service based on PHP arrays.", 4 | "keywords": ["doctrine", "orm", "fixtures"], 5 | "type": "library", 6 | "license": "LGPL-2.1-or-later", 7 | "homepage": "https://github.com/Orbitale/ArrayFixture", 8 | "authors": [ 9 | { 10 | "name": "Alex Rock", 11 | "email": "alex@orbitale.io", 12 | "homepage": "http://www.orbitale.io/" 13 | } 14 | ], 15 | "require": { 16 | "php": "^7.3|^8.0", 17 | "doctrine/data-fixtures": "^1.4|^2.0", 18 | "doctrine/instantiator": "^1.3|^2.0", 19 | "doctrine/persistence": "^1.3|^2.0|^3.0|^4.0" 20 | }, 21 | "require-dev": { 22 | "doctrine/orm": "^2.7|^3.0", 23 | "doctrine/mongodb-odm": "^2.2", 24 | "phpunit/phpunit": "^9.5", 25 | "phpstan/phpstan": "^1.11", 26 | "phpstan/phpstan-deprecation-rules": "^1.2", 27 | "phpstan/phpstan-doctrine": "^1.4", 28 | "phpstan/phpstan-phpunit": "^1.4", 29 | "phpstan/phpstan-symfony": "^1.4" 30 | }, 31 | "suggest": { 32 | "doctrine/doctrine-fixtures-bundle": "To use with ORMFixtureInterface and register fixtures automatically in the Dependency Injection container." 33 | }, 34 | "autoload": { 35 | "psr-4": { 36 | "Orbitale\\Component\\ArrayFixture\\" : "src/" 37 | } 38 | }, 39 | "autoload-dev": { 40 | "psr-4": { 41 | "Tests\\Orbitale\\Component\\ArrayFixture\\" : "tests/" 42 | } 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /phpstan.neon: -------------------------------------------------------------------------------- 1 | includes: 2 | - %currentWorkingDirectory%/vendor/phpstan/phpstan-phpunit/extension.neon 3 | - %currentWorkingDirectory%/vendor/phpstan/phpstan-phpunit/rules.neon 4 | - %currentWorkingDirectory%/vendor/phpstan/phpstan-deprecation-rules/rules.neon 5 | 6 | parameters: 7 | level: max 8 | 9 | inferPrivatePropertyTypeFromConstructor: true 10 | 11 | paths: 12 | - %currentWorkingDirectory%/src/ 13 | 14 | ignoreErrors: 15 | # These actions are so complex that we sometimes need dirty hacks. That's life... 16 | - { message: '#.*#', path: %currentWorkingDirectory%/tests/Stubs/EntityManagerStub.php } 17 | -------------------------------------------------------------------------------- /src/ArrayFixture.php: -------------------------------------------------------------------------------- 1 | 9 | * 10 | * For the full copyright and license information, please view the LICENSE 11 | * file that was distributed with this source code. 12 | */ 13 | 14 | namespace Orbitale\Component\ArrayFixture; 15 | 16 | use Closure; 17 | use Doctrine\Common\DataFixtures\AbstractFixture as BaseAbstractFixture; 18 | use Doctrine\Common\DataFixtures\DependentFixtureInterface; 19 | use Doctrine\Common\DataFixtures\OrderedFixtureInterface; 20 | use Doctrine\Instantiator\Instantiator; 21 | use Doctrine\ODM\MongoDB\DocumentManager; 22 | use Doctrine\ODM\MongoDB\Id\AutoGenerator; 23 | use Doctrine\ODM\MongoDB\Mapping\ClassMetadata as ClassMetadataODM; 24 | use Doctrine\ORM\EntityManagerInterface; 25 | use Doctrine\ORM\Id\AssignedGenerator; 26 | use Doctrine\ORM\Mapping\ClassMetadata as ClassMetadataORM; 27 | use Doctrine\Persistence\ObjectManager; 28 | use Generator; 29 | use InvalidArgumentException; 30 | use ReflectionMethod; 31 | use RuntimeException; 32 | 33 | use const E_USER_DEPRECATED; 34 | 35 | /** 36 | * When used alongside with Doctrine FixturesBundle, 37 | * you may need to implement the ORMFixtureInterface interface too. 38 | * 39 | * @template T of object 40 | */ 41 | abstract class ArrayFixture extends BaseAbstractFixture 42 | { 43 | /** @var ObjectManager */ 44 | private $manager; 45 | 46 | /** @var int */ 47 | private $numberOfIteratedObjects = 0; 48 | 49 | /** @var bool */ 50 | private $clearEMOnFlush; 51 | 52 | /** @var null|Closure */ 53 | private $setter; 54 | 55 | /** @var null|Instantiator */ 56 | private static $instantiator; 57 | 58 | public function __construct() 59 | { 60 | $this->clearEMOnFlush = $this->clearEntityManagerOnFlush(); 61 | 62 | if ( 63 | !($this instanceof OrderedFixtureInterface) 64 | && self::class !== (new ReflectionMethod($this, 'getOrder'))->getDeclaringClass()->getName() 65 | ) { 66 | @\trigger_error(\sprintf( 67 | "The \"%s\" method is overridden on the \"%s\" class, but it does not implement the \"%s\" interface.\n". 68 | 'ArrayFixture stopped implementing this interface in v1.1.0 to ensure compatibility with the "%s" interface.'. 69 | 'If you want ordered fixtures, you should implement either of these interfaces manually in your code.', 70 | 'getOrder', 71 | static::class, 72 | OrderedFixtureInterface::class, 73 | DependentFixtureInterface::class 74 | ), E_USER_DEPRECATED); 75 | } 76 | } 77 | 78 | public function load(ObjectManager $manager): void 79 | { 80 | $this->manager = $manager; 81 | 82 | if ( 83 | $this->manager instanceof EntityManagerInterface 84 | && $this->disableLogger() 85 | && \method_exists($dbConfiguration = $this->manager->getConnection()->getConfiguration(), 'setSQLLogger') 86 | ) { 87 | $dbConfiguration->setSQLLogger(null); 88 | } 89 | 90 | $objects = $this->getObjects(); 91 | 92 | $this->numberOfIteratedObjects = 0; 93 | foreach ($objects as $data) { 94 | $this->numberOfIteratedObjects++; 95 | $this->fixtureObject($data); 96 | } 97 | 98 | // Flush if we performed a "whole" fixture load, 99 | // or if we flushed with batches but have not flushed all items. 100 | $this->manager->flush(); 101 | if ($this->clearEMOnFlush) { 102 | $this->manager->clear(); 103 | } 104 | } 105 | 106 | /** 107 | * @deprecated 108 | */ 109 | public function getOrder(): int 110 | { 111 | @\trigger_error( 112 | \sprintf( 113 | "The \"%s\" method is deprecated since v1.1.0 and will be removed in v2.0, as the \"%s\" interface conflicts with \"%s\".\n". 114 | 'You should implement it in your own class instead', 115 | __METHOD__, 116 | OrderedFixtureInterface::class, 117 | DependentFixtureInterface::class 118 | ), 119 | E_USER_DEPRECATED 120 | ); 121 | 122 | return 0; 123 | } 124 | 125 | /** 126 | * Returns the class of the entity you're managing. 127 | * 128 | * @phpstan-return class-string 129 | */ 130 | abstract protected function getEntityClass(): string; 131 | 132 | /** 133 | * Returns an iterable containing the list of objects that should be persisted. 134 | * 135 | * @return array[]|Generator 136 | */ 137 | abstract protected function getObjects(): iterable; 138 | 139 | /** 140 | * If true, the SQL logger will be disabled, and therefore will avoid memory leaks and save memory during execution. 141 | * Very useful for big batches of entities. 142 | */ 143 | protected function disableLogger(): bool 144 | { 145 | return true; 146 | } 147 | 148 | /** 149 | * Returns the prefix used to create fixtures reference. 150 | * If returns `null`, no reference will be created for the object. 151 | * NOTE: To create references of an object, it must have an ID, and if not, implement __toString(), because 152 | * each object is referenced BEFORE flushing the database. 153 | * NOTE2: If you specified a "flushEveryXIterations" value, then the object will be provided with an ID every time. 154 | */ 155 | protected function getReferencePrefix(): ?string 156 | { 157 | return null; 158 | } 159 | 160 | /** 161 | * When set, you can customize the method that will be used 162 | * to determine the second part of the reference prefix. 163 | * For example, if reference prefix is "my-entity-" and the 164 | * method is "getIdentifier()", the reference will be: 165 | * "$reference = 'my-entity-'.$obj->getIdentifier()". 166 | * 167 | * Only used when getReferencePrefix() returns non-empty value. 168 | * 169 | * Always tries to fall back to "__toString()". 170 | */ 171 | protected function getMethodNameForReference(): string 172 | { 173 | return 'getId'; 174 | } 175 | 176 | /** 177 | * If specified, the entity manager will be flushed every X times, depending on your specified values. 178 | * Default is null, so the database is flushed only at the end of all persists. 179 | */ 180 | protected function flushEveryXIterations(): int 181 | { 182 | return 0; 183 | } 184 | 185 | /** 186 | * If true, will run $em->clear() after having run $em->flush(). 187 | * This allows saving some memory when using huge sets of non-referenced fixtures. 188 | */ 189 | protected function clearEntityManagerOnFlush(): bool 190 | { 191 | return true; 192 | } 193 | 194 | /** 195 | * Creates a new instance of the class associated with the fixture. 196 | * Override this method if you have constructor arguments to manage yourself depending on input data. 197 | * 198 | * @param mixed[] $data 199 | */ 200 | protected function createNewInstance(array $data): object 201 | { 202 | /** @var class-string $entityClass */ 203 | $entityClass = $this->getEntityClass(); 204 | 205 | $instance = self::getInstantiator()->instantiate($entityClass); 206 | 207 | $setter = $this->getSetter(); 208 | 209 | foreach ($data as $key => $value) { 210 | if ($value instanceof Closure) { 211 | // Allow specifying values as closures in order to customize field population. 212 | $value = $value($instance, $this, $this->manager); 213 | } 214 | 215 | /** @var callable $valueSetter */ 216 | $valueSetter = $setter->bindTo($instance, $entityClass); 217 | $valueSetter($key, $value); 218 | } 219 | 220 | return $instance; 221 | } 222 | 223 | /** 224 | * Creates the object and persist it in database. 225 | * 226 | * @param mixed[] $data 227 | */ 228 | private function fixtureObject(array $data): void 229 | { 230 | $obj = $this->createNewInstance($data); 231 | 232 | // Sometimes, primary keys are specified in fixtures. 233 | // We must make sure Doctrine will force them to be saved. 234 | // Support for non-composite primary keys only. 235 | // /!\ Be careful, this will override the generator type for ALL objects of the same entity class! 236 | // This means that it _may_ break objects for which ids are not provided in the fixtures. 237 | // The solution for the user: don't specify any ID, or specify ALL of them. 238 | /** @var ClassMetadataODM|ClassMetadataORM $metadata */ 239 | $metadata = $this->manager->getClassMetadata($this->getEntityClass()); 240 | 241 | $primaryKey = $metadata->getIdentifierFieldNames(); 242 | if (1 === \count($primaryKey) && isset($data[$primaryKey[0]])) { 243 | $metadata->setIdGeneratorType($metadata::GENERATOR_TYPE_NONE); 244 | if ($this->manager instanceof EntityManagerInterface) { 245 | \assert($metadata instanceof ClassMetadataORM); 246 | $metadata->setIdGenerator(new AssignedGenerator()); 247 | } elseif ($this->manager instanceof DocumentManager) { 248 | \assert($metadata instanceof ClassMetadataODM); 249 | $metadata->setIdGenerator(new AutoGenerator()); 250 | } 251 | } 252 | 253 | $this->manager->persist($obj); 254 | 255 | if ( 256 | $this->flushEveryXIterations() > 0 257 | && 0 === $this->numberOfIteratedObjects % $this->flushEveryXIterations() 258 | ) { 259 | $this->manager->flush(); 260 | if ($this->clearEMOnFlush) { 261 | $this->manager->clear(); 262 | } 263 | } 264 | 265 | // If we have to add a reference, we do it 266 | if ($prefix = $this->getReferencePrefix()) { 267 | $methodName = $this->getMethodNameForReference(); 268 | 269 | $reference = null; 270 | 271 | if (\method_exists($obj, $methodName)) { 272 | $reference = $obj->{$methodName}(); 273 | } elseif (\method_exists($obj, '__toString')) { 274 | $reference = (string) $obj; 275 | } 276 | 277 | if (!$reference) { 278 | throw new RuntimeException( 279 | \sprintf( 280 | 'If you want to specify a reference with prefix "%s", method "%s" or "%s" must exist in the class, or you can override the "%s" method and add your own.', 281 | $prefix, 282 | $methodName, 283 | '__toString()', 284 | 'getMethodNameForReference' 285 | ) 286 | ); 287 | } 288 | $this->addReference($prefix.$reference, $obj); 289 | } 290 | } 291 | 292 | private function getSetter(): Closure 293 | { 294 | if (!$this->setter) { 295 | $class = $this->getEntityClass(); 296 | 297 | return $this->setter = function (string $property, $value) use ($class): void { 298 | if (!\property_exists($this, $property)) { 299 | throw new InvalidArgumentException( 300 | \sprintf( 301 | 'Cannot set property "%s" to "%s" object since this property does not exist.', 302 | $property, 303 | $class 304 | ) 305 | ); 306 | } 307 | 308 | $this->{$property} = $value; 309 | }; 310 | } 311 | 312 | return $this->setter; 313 | } 314 | 315 | private static function getInstantiator(): Instantiator 316 | { 317 | if (!self::$instantiator) { 318 | return self::$instantiator = new Instantiator(); 319 | } 320 | 321 | return self::$instantiator; 322 | } 323 | } 324 | --------------------------------------------------------------------------------