edmondscommerce/doctrine-static-meta

View on GitHub
src/Entity/Fields/FakerData/AbstractFakerDataProvider.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php

declare(strict_types=1);

namespace EdmondsCommerce\DoctrineStaticMeta\Entity\Fields\FakerData;

use Faker\Generator;

/**
 * @SuppressWarnings(PHPMD.NumberOfChildren)
 */
abstract class AbstractFakerDataProvider implements FakerDataProviderInterface
{
    /**
     * @var Generator
     */
    protected $generator;

    public function __construct(Generator $generator)
    {
        $this->generator = $generator;
    }

    /**
     * This magic method means that the object is callable like a closure,
     * and when that happens this invoke method is called.
     *
     * This method should return your fake data. You can use the generator to pull fake data from if that is useful
     *
     * @return mixed
     */
    abstract public function __invoke();
}