-
-
Notifications
You must be signed in to change notification settings - Fork 85
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
12 changed files
with
220 additions
and
181 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,166 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /* | ||
| * This file is part of the zenstruck/foundry package. | ||
| * | ||
| * (c) Kevin Bond <kevinbond@gmail.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Zenstruck\Foundry; | ||
|
|
||
| use Zenstruck\Foundry\Exception\FoundryBootException; | ||
| use Zenstruck\Foundry\Factory; | ||
| use Zenstruck\Foundry\Persistence\PersistentObjectFactory; | ||
|
|
||
| /** | ||
| * @template TModel of object | ||
| * @template-extends Factory<TModel> | ||
| * | ||
| * @method static TModel[] createMany(int $number, array|callable $attributes = []) | ||
| * @phpstan-method static list<TModel> createMany(int $number, array|callable $attributes = []) | ||
| * | ||
| * @author Kevin Bond <kevinbond@gmail.com> | ||
| */ | ||
| abstract class ObjectFactory extends Factory | ||
| { | ||
| public function __construct() | ||
| { | ||
| parent::__construct(static::class()); | ||
| } | ||
|
|
||
| /** | ||
| * @phpstan-return list<TModel> | ||
| */ | ||
| public static function __callStatic(string $name, array $arguments): array | ||
| { | ||
| if ('createMany' !== $name) { | ||
| throw new \BadMethodCallException(\sprintf('Call to undefined static method "%s::%s".', static::class, $name)); | ||
| } | ||
|
|
||
| return static::new()->many($arguments[0])->create($arguments[1] ?? [], noProxy: true); | ||
| } | ||
|
|
||
|
|
||
| /** | ||
| * @final | ||
| * | ||
| * @param array|callable|string $defaultAttributes If string, assumes state | ||
| * @param string ...$states Optionally pass default states (these must be methods on your ObjectFactory with no arguments) | ||
| */ | ||
| public static function new(array|callable|string $defaultAttributes = [], string ...$states): static | ||
| { | ||
| if (\is_string($defaultAttributes)) { | ||
| $states = \array_merge([$defaultAttributes], $states); | ||
| $defaultAttributes = []; | ||
| } | ||
|
|
||
| try { | ||
| $factory = self::isBooted() ? self::configuration()->factories()->create(static::class) : new static(); | ||
| } catch (\ArgumentCountError $e) { | ||
| throw new \RuntimeException('Model Factories with dependencies (Model Factory services) cannot be created before foundry is booted.', 0, $e); | ||
| } | ||
|
|
||
| $factory = $factory | ||
| ->with(static fn(): array|callable => $factory->defaults()) | ||
| ->with($defaultAttributes); | ||
|
|
||
| try { | ||
| if (!is_a(static::class, PersistentObjectFactory::class, true) || !Factory::configuration()->isPersistEnabled()) { | ||
| $factory = $factory->withoutPersisting(calledInternally: true); | ||
| } | ||
| } catch (FoundryBootException) { | ||
| } | ||
|
|
||
| $factory = $factory->initialize(); | ||
|
|
||
| if (!$factory instanceof static) { | ||
| throw new \TypeError(\sprintf('"%1$s::initialize()" must return an instance of "%1$s".', static::class)); | ||
| } | ||
|
|
||
| foreach ($states as $state) { | ||
| $factory = $factory->{$state}(); | ||
| } | ||
|
|
||
| return $factory; | ||
| } | ||
|
|
||
| /** | ||
| * @final | ||
| * | ||
| * @return TModel | ||
| */ | ||
| public function create( | ||
| array|callable $attributes = [], | ||
| /** | ||
| * @deprecated | ||
| * @internal | ||
| */ | ||
| bool $noProxy = false | ||
| ): object { | ||
| if (2 === \count(\func_get_args()) && !\str_starts_with(\debug_backtrace(options: \DEBUG_BACKTRACE_IGNORE_ARGS, limit: 1)[0]['class'] ?? '', 'Zenstruck\Foundry')) { | ||
| trigger_deprecation('zenstruck\foundry', '1.37.0', \sprintf('Parameter "$noProxy" of method "%s()" is deprecated and will be removed in Foundry 2.0.', __METHOD__)); | ||
| } | ||
|
|
||
| return parent::create( | ||
| $attributes, | ||
| noProxy: true | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * @final | ||
| * | ||
| * A shortcut to create a single model without states. | ||
| * | ||
| * @return TModel | ||
| */ | ||
| public static function createOne(array $attributes = []): object | ||
| { | ||
| return static::new()->create($attributes, noProxy: true); | ||
| } | ||
|
|
||
| /** | ||
| * @final | ||
| * | ||
| * A shortcut to create multiple models, based on a sequence, without states. | ||
| * | ||
| * @param iterable<array<string, mixed>>|callable(): iterable<array<string, mixed>> $sequence | ||
| * | ||
| * @return list<TModel> | ||
| */ | ||
| public static function createSequence(iterable|callable $sequence): array | ||
| { | ||
| return static::new()->sequence($sequence)->create(noProxy: true); | ||
| } | ||
|
|
||
| /** @phpstan-return class-string<TModel> */ | ||
| abstract public static function class(): string; | ||
|
|
||
| /** | ||
| * Override to add default instantiator and default afterInstantiate/afterPersist events. | ||
| * | ||
| * @return static | ||
| */ | ||
| #[\ReturnTypeWillChange] | ||
| protected function initialize() | ||
| { | ||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * @deprecated use with() instead | ||
| */ | ||
| final protected function addState(array|callable $attributes = []): static | ||
| { | ||
| trigger_deprecation('zenstruck\foundry', '1.37.0', \sprintf('Method "%s()" is deprecated and will be removed in version 2.0. Use "%s::with()" instead.', __METHOD__, Factory::class)); | ||
|
|
||
| return $this->with($attributes); | ||
| } | ||
|
|
||
| abstract protected function defaults(): array|callable; | ||
| } |
Oops, something went wrong.