setDescription('Create new model classes.'); } public function run(InputInterface $input, OutputInterface $output): int { $this->resolver = $this->container->get(ConnectionResolverInterface::class); $this->config = $this->container->get(ConfigInterface::class); $this->lexer = new Emulative([ 'usedAttributes' => [ 'comments', 'startLine', 'endLine', 'startTokenPos', 'endTokenPos', ], ]); $this->astParser = (new ParserFactory())->create(ParserFactory::ONLY_PHP7, $this->lexer); $this->printer = new Standard(); return parent::run($input, $output); } public function handle() { $table = $this->input->getArgument('table'); $pool = $this->input->getOption('pool'); $option = new ModelOption(); $option->setPool($pool) ->setPath($this->getOption('path', 'commands.gen:model.path', $pool, 'app/Model')) ->setPrefix($this->getOption('prefix', 'prefix', $pool, '')) ->setInheritance($this->getOption('inheritance', 'commands.gen:model.inheritance', $pool, 'Model')) ->setUses($this->getOption('uses', 'commands.gen:model.uses', $pool, 'Hyperf\DbConnection\Model\Model')) ->setForceCasts($this->getOption('force-casts', 'commands.gen:model.force_casts', $pool, false)) ->setRefreshFillable($this->getOption('refresh-fillable', 'commands.gen:model.refresh_fillable', $pool, false)) ->setTableMapping($this->getOption('table-mapping', 'commands.gen:model.table_mapping', $pool, [])) ->setIgnoreTables($this->getOption('ignore-tables', 'commands.gen:model.ignore_tables', $pool, [])) ->setWithComments($this->getOption('with-comments', 'commands.gen:model.with_comments', $pool, false)) ->setWithIde($this->getOption('with-ide', 'commands.gen:model.with_ide', $pool, false)) ->setVisitors($this->getOption('visitors', 'commands.gen:model.visitors', $pool, [])) ->setPropertyCase($this->getOption('property-case', 'commands.gen:model.property_case', $pool)); if ($table) { $this->createModel($table, $option); } else { $this->createModels($option); } } protected function configure() { $this->addArgument('table', InputArgument::OPTIONAL, 'Which table you want to associated with the Model.'); $this->addOption('pool', 'p', InputOption::VALUE_OPTIONAL, 'Which connection pool you want the Model use.', 'default'); $this->addOption('path', null, InputOption::VALUE_OPTIONAL, 'The path that you want the Model file to be generated.'); $this->addOption('force-casts', 'F', InputOption::VALUE_NONE, 'Whether force generate the casts for model.'); $this->addOption('prefix', 'P', InputOption::VALUE_OPTIONAL, 'What prefix that you want the Model set.'); $this->addOption('inheritance', 'i', InputOption::VALUE_OPTIONAL, 'The inheritance that you want the Model extends.'); $this->addOption('uses', 'U', InputOption::VALUE_OPTIONAL, 'The default class uses of the Model.'); $this->addOption('refresh-fillable', 'R', InputOption::VALUE_NONE, 'Whether generate fillable argument for model.'); $this->addOption('table-mapping', 'M', InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY, 'Table mappings for model.'); $this->addOption('ignore-tables', null, InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY, 'Ignore tables for creating models.'); $this->addOption('with-comments', null, InputOption::VALUE_NONE, 'Whether generate the property comments for model.'); $this->addOption('with-ide', null, InputOption::VALUE_NONE, 'Whether generate the ide file for model.'); $this->addOption('visitors', null, InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY, 'Custom visitors for ast traverser.'); $this->addOption('property-case', null, InputOption::VALUE_OPTIONAL, 'Which property case you want use, 0: snake case, 1: camel case.'); } protected function getSchemaBuilder(string $poolName): Builder { $connection = $this->resolver->connection($poolName); return $connection->getSchemaBuilder(); } protected function createModels(ModelOption $option) { $builder = $this->getSchemaBuilder($option->getPool()); $tables = []; foreach ($builder->getAllTables() as $row) { $row = (array) $row; $table = reset($row); if (! $this->isIgnoreTable($table, $option)) { $tables[] = $table; } } foreach ($tables as $table) { $this->createModel($table, $option); } } protected function isIgnoreTable(string $table, ModelOption $option): bool { if (in_array($table, $option->getIgnoreTables())) { return true; } return $table === $this->config->get('databases.migrations', 'migrations'); } protected function createModel(string $table, ModelOption $option): void { $builder = $this->getSchemaBuilder($option->getPool()); $table = Str::replaceFirst($option->getPrefix(), '', $table); $pureTable = Str::after($table, '.'); $databaseName = Str::contains($table, '.') ? Str::before($table, '.') : null; $driver = $this->resolver->connection($option->getPool())->getConfig('driver'); $columns = match ($driver) { 'pgsql' => $this->formatColumns($builder->getColumnTypeListing($table, $databaseName)), default => $this->formatColumns($builder->getColumnTypeListing($pureTable, $databaseName)), }; if (empty($columns)) { $this->output?->error( sprintf('Query columns are empty, maybe the table `%s` does not exist. You can check it in the database.', $table) ); } $project = new Project(); $class = $option->getTableMapping()[$table] ?? Str::studly(Str::singular($pureTable)); $class = $project->namespace($option->getPath()) . $class; $path = BASE_PATH . '/' . $project->path($class); if (! file_exists($path)) { $this->mkdir($path); file_put_contents($path, $this->buildClass($table, $class, $option)); } $columns = $this->getColumns($class, $columns, $option->isForceCasts()); $traverser = new NodeTraverser(); $traverser->addVisitor(make(ModelUpdateVisitor::class, [ 'class' => $class, 'columns' => $columns, 'option' => $option, ])); $traverser->addVisitor(make(ModelRewriteConnectionVisitor::class, [$class, $option->getPool()])); $data = make(ModelData::class, ['class' => $class, 'columns' => $columns]); foreach ($option->getVisitors() as $visitorClass) { $traverser->addVisitor(make($visitorClass, [$option, $data])); } $traverser->addVisitor(new CloningVisitor()); $originStmts = $this->astParser->parse(file_get_contents($path)); $originTokens = $this->lexer->getTokens(); $newStmts = $traverser->traverse($originStmts); $code = $this->printer->printFormatPreserving($newStmts, $originStmts, $originTokens); file_put_contents($path, $code); $this->output->writeln(sprintf('Model %s was created.', $class)); if ($option->isWithIde()) { $this->generateIDE($code, $option, $data); } } protected function generateIDE(string $code, ModelOption $option, ModelData $data) { $stmts = $this->astParser->parse($code); $traverser = new NodeTraverser(); $traverser->addVisitor(make(GenerateModelIDEVisitor::class, [$option, $data])); $stmts = $traverser->traverse($stmts); $code = $this->printer->prettyPrintFile($stmts); $class = str_replace('\\', '_', $data->getClass()); $path = BASE_PATH . '/runtime/ide/' . $class . '.php'; $this->mkdir($path); file_put_contents($path, $code); $this->output->writeln(sprintf('Model IDE %s was created.', $data->getClass())); } protected function mkdir(string $path): void { $dir = dirname($path); if (! is_dir($dir)) { @mkdir($dir, 0755, true); } } /** * Format column's key to lower case. */ protected function formatColumns(array $columns): array { return array_map(function ($item) { return array_change_key_case($item, CASE_LOWER); }, $columns); } protected function getColumns($className, $columns, $forceCasts): array { /** @var Model $model */ $model = new $className(); $dates = $model->getDates(); $casts = []; if (! $forceCasts) { $casts = $model->getCasts(); } foreach ($dates as $date) { if (! isset($casts[$date])) { $casts[$date] = 'datetime'; } } foreach ($columns as $key => $value) { $columns[$key]['cast'] = $casts[$value['column_name']] ?? null; } return $columns; } protected function getOption(string $name, string $key, string $pool = 'default', $default = null) { $result = $this->input->getOption($name); $nonInput = null; if (in_array($name, ['force-casts', 'refresh-fillable', 'with-comments', 'with-ide'])) { $nonInput = false; } if (in_array($name, ['table-mapping', 'ignore-tables', 'visitors'])) { $nonInput = []; } if ($result === $nonInput) { $result = $this->config->get("databases.{$pool}.{$key}", $default); } return $result; } /** * Build the class with the given name. */ protected function buildClass(string $table, string $name, ModelOption $option): string { $stub = file_get_contents(__DIR__ . '/stubs/Model.stub'); return $this->replaceNamespace($stub, $name) ->replaceInheritance($stub, $option->getInheritance()) ->replaceConnection($stub, $option->getPool()) ->replaceUses($stub, $option->getUses()) ->replaceClass($stub, $name) ->replaceTable($stub, $table); } /** * Replace the namespace for the given stub. */ protected function replaceNamespace(string &$stub, string $name): self { $stub = str_replace( ['%NAMESPACE%'], [$this->getNamespace($name)], $stub ); return $this; } /** * Get the full namespace for a given class, without the class name. */ protected function getNamespace(string $name): string { return trim(implode('\\', array_slice(explode('\\', $name), 0, -1)), '\\'); } protected function replaceInheritance(string &$stub, string $inheritance): self { $stub = str_replace( ['%INHERITANCE%'], [$inheritance], $stub ); return $this; } protected function replaceConnection(string &$stub, string $connection): self { $stub = str_replace( ['%CONNECTION%'], [$connection], $stub ); return $this; } protected function replaceUses(string &$stub, string $uses): self { $uses = $uses ? "use {$uses};" : ''; $stub = str_replace( ['%USES%'], [$uses], $stub ); return $this; } /** * Replace the class name for the given stub. */ protected function replaceClass(string &$stub, string $name): self { $class = str_replace($this->getNamespace($name) . '\\', '', $name); $stub = str_replace('%CLASS%', $class, $stub); return $this; } /** * Replace the table name for the given stub. */ protected function replaceTable(string $stub, string $table): string { return str_replace('%TABLE%', $table, $stub); } /** * Get the destination class path. */ protected function getPath(string $name): string { return BASE_PATH . '/' . str_replace('\\', '/', $name) . '.php'; } }