Seed.php

<?php

declare(strict_types=1);
/**
 * This file is part of Hyperf.
 *
 * @link     https://www.hyperf.io
 * @document https://hyperf.wiki
 * @contact  group@hyperf.io
 * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
 */
namespace Hyperf\Database\Seeders;

use Hyperf\Database\Connection;
use Hyperf\Database\ConnectionResolverInterface as Resolver;
use Hyperf\Database\Model\Model;
use Hyperf\Database\Schema\Grammars\Grammar;
use Hyperf\Utils\Collection;
use Hyperf\Utils\Filesystem\Filesystem;
use Hyperf\Utils\Str;
use Symfony\Component\Console\Output\OutputInterface;

class Seed
{
    /**
     * The filesystem instance.
     *
     * @var \Hyperf\Utils\Filesystem\Filesystem
     */
    protected $files;

    /**
     * The connection resolver instance.
     *
     * @var \Hyperf\Database\ConnectionResolverInterface
     */
    protected $resolver;

    /**
     * The name of the default connection.
     *
     * @var string
     */
    protected $connection;

    /**
     * The paths to all of the seeder files.
     *
     * @var array
     */
    protected $paths = [];

    /**
     * The output interface implementation.
     *
     * @var OutputInterface
     */
    protected $output;

    /**
     * Create a new seed instance.
     */
    public function __construct(Resolver $resolver, Filesystem $files)
    {
        $this->files = $files;
        $this->resolver = $resolver;
    }

    /**
     * Run the pending seeders at a given path.
     *
     * @param array|string $paths
     * @return array
     */
    public function run($paths = [], array $options = [])
    {
        $files = $this->getSeederFiles($paths);

        $this->requireFiles($files);

        $this->runSeeders($files, $options);

        return $files;
    }

    /**
     * Set the default connection name.
     */
    public function setConnection(string $name): void
    {
        if (! is_null($name)) {
            $this->resolver->setDefaultConnection($name);
        }

        $this->connection = $name;
    }

    /**
     * Run an array of seeders.
     */
    public function runSeeders(array $seeders, array $options = [])
    {
        if (count($seeders) === 0) {
            return;
        }

        foreach ($seeders as $file) {
            $this->runSeeder($file);
        }
    }

    /**
     * Run a seeder.
     *
     * @param string $file
     */
    public function runSeeder($file)
    {
        Model::unguarded(function () use ($file) {
            $seeder = $this->resolve(
                $name = $this->getSeederName($file)
            );

            $this->note("<comment>Seed:</comment> {$name}");

            $connection = $this->resolveConnection(
                $seeder->getConnection()
            );

            $callback = function () use ($seeder) {
                if (method_exists($seeder, 'run')) {
                    $seeder->run();
                }
            };

            if ($this->getSchemaGrammar($connection)->supportsSchemaTransactions() && $seeder->withinTransaction) {
                $connection->transaction($callback);
            } else {
                $callback();
            }

            $this->note("<info>Seeded:</info> {$name}");
        });
    }

    /**
     * Resolve a seeder instance from a file.
     */
    public function resolve(string $file): object
    {
        $class = Str::studly($file);

        return new $class();
    }

    /**
     * Resolve the database connection instance.
     *
     * @return Connection
     */
    public function resolveConnection(string $connection)
    {
        return $this->resolver->connection($connection ?: $this->connection);
    }

    /**
     * Get all of the seeder files in a given path.
     *
     * @param array|string $paths
     * @return array
     */
    public function getSeederFiles($paths)
    {
        return Collection::make($paths)->flatMap(function ($path) {
            return Str::endsWith($path, '.php') ? [$path] : $this->files->glob($path . '/*.php');
        })->filter()->sortBy(function ($file) {
            return $this->getSeederName($file);
        })->values()->keyBy(function ($file) {
            return $this->getSeederName($file);
        })->all();
    }

    /**
     * Get the name of the seeder.
     *
     * @param string $path
     * @return string
     */
    public function getSeederName($path)
    {
        return str_replace('.php', '', basename($path));
    }

    /**
     * Require in all the seeder files in a given path.
     */
    public function requireFiles(array $files)
    {
        foreach ($files as $file) {
            $this->files->requireOnce($file);
        }
    }

    /**
     * Set the output implementation that should be used by the console.
     *
     * @return $this
     */
    public function setOutput(OutputInterface $output)
    {
        $this->output = $output;

        return $this;
    }

    /**
     * Get the schema grammar out of a migration connection.
     *
     * @param Connection $connection
     */
    protected function getSchemaGrammar($connection): Grammar
    {
        if (is_null($grammar = $connection->getSchemaGrammar())) {
            $connection->useDefaultSchemaGrammar();

            $grammar = $connection->getSchemaGrammar();
        }

        return $grammar;
    }

    /**
     * Write a note to the console's output.
     *
     * @param string $message
     */
    protected function note($message)
    {
        if ($this->output) {
            $this->output->writeln($message);
        }
    }
}