src/Propel/Generator/Manager/ModelManager.php
<?php
/**
* MIT License. This file is part of the Propel package.
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Propel\Generator\Manager;
use Propel\Generator\Builder\Om\AbstractOMBuilder;
use Propel\Generator\Builder\Om\TableMapLoaderScriptBuilder;
use SplFileInfo;
use Symfony\Component\Filesystem\Filesystem;
/**
* This manager creates the Object Model classes based on the XML schema file.
*
* @author Hans Lellelid <hans@xmpl.org>
*/
class ModelManager extends AbstractManager
{
/**
* A Filesystem object.
*
* @var \Symfony\Component\Filesystem\Filesystem
*/
private $filesystem;
/**
* Sets the filesystem object.
*
* @param \Symfony\Component\Filesystem\Filesystem $filesystem
*
* @return void
*/
public function setFilesystem(Filesystem $filesystem): void
{
$this->filesystem = $filesystem;
}
/**
* @return void
*/
public function build(): void
{
$this->validate();
$totalNbFiles = 0;
$dataModels = $this->getDataModels();
$generatorConfig = $this->getGeneratorConfig();
$this->log('Generating PHP files...');
foreach ($dataModels as $dataModel) {
$this->log('Datamodel: ' . $dataModel->getName());
foreach ($dataModel->getDatabases() as $database) {
$this->log(' - Database: ' . $database->getName());
foreach ($database->getTables() as $table) {
if (!$table->isForReferenceOnly()) {
$nbWrittenFiles = 0;
$this->log(' + Table: ' . $table->getName());
// -----------------------------------------------------------------------------------------
// Create Object, and TableMap classes
// -----------------------------------------------------------------------------------------
// these files are always created / overwrite any existing files
foreach (['object', 'tablemap', 'query'] as $target) {
$builder = $generatorConfig->getConfiguredBuilder($table, $target);
$nbWrittenFiles += $this->doBuild($builder);
}
// -----------------------------------------------------------------------------------------
// Create [empty] stub Object classes if they don't exist
// -----------------------------------------------------------------------------------------
// these classes are only generated if they don't already exist
foreach (['objectstub', 'querystub'] as $target) {
$builder = $generatorConfig->getConfiguredBuilder($table, $target);
$nbWrittenFiles += $this->doBuild($builder, false);
}
// -----------------------------------------------------------------------------------------
// Create [empty] stub child Object classes if they don't exist
// -----------------------------------------------------------------------------------------
// If table has enumerated children (uses inheritance) then create the empty child stub classes if they don't already exist.
$col = $table->getChildrenColumn();
if ($col) {
if ($col->isEnumeratedClasses()) {
foreach ($col->getChildren() as $child) {
foreach (['queryinheritance'] as $target) {
if (!$child->getAncestor() && $child->getClassName() === $table->getPhpName()) {
continue;
}
/** @var \Propel\Generator\Builder\Om\QueryInheritanceBuilder $builder */
$builder = $generatorConfig->getConfiguredBuilder($table, $target);
$builder->setChild($child);
$nbWrittenFiles += $this->doBuild($builder);
}
foreach (['objectmultiextend', 'queryinheritancestub'] as $target) {
/** @var \Propel\Generator\Builder\Om\MultiExtendObjectBuilder $builder */
$builder = $generatorConfig->getConfiguredBuilder($table, $target);
$builder->setChild($child);
$nbWrittenFiles += $this->doBuild($builder, false);
}
}
}
}
// -----------------------------------------------------------------------------------------
// Create [empty] Interface if it doesn't exist
// -----------------------------------------------------------------------------------------
// Create [empty] interface if it does not already exist
if ($table->getInterface()) {
$builder = $generatorConfig->getConfiguredBuilder($table, 'interface');
$nbWrittenFiles += $this->doBuild($builder, false);
}
// ----------------------------------
// Create classes added by behaviors
// ----------------------------------
if ($table->hasAdditionalBuilders()) {
foreach ($table->getAdditionalBuilders() as $builderClass) {
/** @var \Propel\Generator\Builder\Om\AbstractOMBuilder $builder */
$builder = new $builderClass($table);
$builder->setGeneratorConfig($generatorConfig);
$nbWrittenFiles += $this->doBuild($builder, $builder->overwrite ?? true);
}
}
$totalNbFiles += $nbWrittenFiles;
if ($nbWrittenFiles === 0) {
$this->log("\t\t(no change)");
}
}
}
}
}
$totalNbFiles += $this->createTableMapLoaderScript();
if ($totalNbFiles) {
$this->log(sprintf('Object model generation complete - %d files written', $totalNbFiles));
} else {
$this->log('Object model generation complete - All files already up to date');
}
}
/**
* Uses a builder class to create the output class.
* This method assumes that the DataModelBuilder class has been initialized
* with the build properties.
*
* @param \Propel\Generator\Builder\Om\AbstractOMBuilder $builder
* @param bool $overwrite
*
* @return int
*/
protected function doBuild(AbstractOMBuilder $builder, bool $overwrite = true): int
{
$path = $builder->getClassFilePath();
$file = new SplFileInfo($this->getWorkingDirectory() . DIRECTORY_SEPARATOR . $path);
$this->filesystem->mkdir($file->getPath());
// skip files already created once
if ($file->isFile() && !$overwrite) {
$this->log("\t-> (exists) " . $builder->getClassFilePath());
return 0;
}
$script = $builder->build();
foreach ($builder->getWarnings() as $warning) {
$this->log($warning);
}
// skip unchanged files
if ($file->isFile() && $script == file_get_contents($file->getPathname())) {
$this->log("\t-> (unchanged) " . $builder->getClassFilePath());
return 0;
}
// write / overwrite new / changed files
$action = $file->isFile() ? 'Updating' : 'Creating';
$this->log(sprintf("\t-> %s %s (table: %s, builder: %s)", $action, $builder->getClassFilePath(), $builder->getTable()->getName(), get_class($builder)));
file_put_contents($file->getPathname(), $script);
return 1;
}
/**
* Create script to import all table map files into database map.
*
* @return int Number of changed files
*/
protected function createTableMapLoaderScript(): int
{
$schemas = $this->getDataModels();
$builder = new TableMapLoaderScriptBuilder($this->getGeneratorConfig());
$fileContent = $builder->build($schemas);
$file = $builder->getFile();
$filePath = $file->getPathname();
$action = $file->isFile() ? 'Updating' : 'Creating';
$this->log("\t-> $action $filePath");
if ($file->isFile() && file_get_contents($filePath) === $fileContent) {
$this->log("\t\t(no change)");
return 0;
}
$this->log('Generating script for loading table maps at ' . $file->getRealPath());
$this->filesystem->mkdir($file->getPath());
file_put_contents($filePath, $fileContent);
return 1;
}
}