thecodingmachine / database.tdbm

src/Mouf/Database/TDBM/Utils/TDBMDaoGenerator.php

Unused Use Statements -1 removed lines

@@ -4,7 +4,6 @@
 
 use Doctrine\Common\Inflector\Inflector;
 use Doctrine\DBAL\Driver\Connection;
-use Doctrine\DBAL\Schema\Column;
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\DBAL\Schema\Table;
 use Doctrine\DBAL\Types\Type;

Doc Comments +5 added lines, -2 removed lines

@@ -147,7 +147,7 @@ 
     /**
      * Returns the name of the base bean class from the table name.
      *
-     * @param $tableName
+     * @param string $tableName
      *
      * @return string
      */
@@ -159,7 +159,7 @@ 
     /**
      * Returns the name of the base DAO class from the table name.
      *
-     * @param $tableName
+     * @param string $tableName
      *
      * @return string
      */
@@ -176,6 +176,7 @@ 
      * @param Table           $table           The table
      * @param string          $beannamespace   The namespace of the bean
      * @param ClassNameMapper $classNameMapper
+     * @param boolean $storeInUtc
      *
      * @throws TDBMException
      */
@@ -486,6 +487,8 @@ 
      * Generates the factory bean.
      *
      * @param Table[] $tableList
+     * @param string $daoFactoryClassName
+     * @param string $daoNamespace
      */
     private function generateFactory(array $tableList, $daoFactoryClassName, $daoNamespace, ClassNameMapper $classNameMapper)
     {

Indentation +466 added lines, -466 removed lines

@@ -17,201 +17,201 @@ 
  */
 class TDBMDaoGenerator
 {
-    /**
-     * @var SchemaAnalyzer
-     */
-    private $schemaAnalyzer;
-
-    /**
-     * @var Schema
-     */
-    private $schema;
-
-    /**
-     * The root directory of the project.
-     *
-     * @var string
-     */
-    private $rootPath;
-
-    /**
-     * Name of composer file.
-     *
-     * @var string
-     */
-    private $composerFile;
-
-    /**
-     * @var TDBMSchemaAnalyzer
-     */
-    private $tdbmSchemaAnalyzer;
-
-    /**
-     * Constructor.
-     *
-     * @param SchemaAnalyzer     $schemaAnalyzer
-     * @param Schema             $schema
-     * @param TDBMSchemaAnalyzer $tdbmSchemaAnalyzer
-     */
-    public function __construct(SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer)
-    {
-        $this->schemaAnalyzer = $schemaAnalyzer;
-        $this->schema = $schema;
-        $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer;
-        $this->rootPath = __DIR__.'/../../../../../../../../';
-        $this->composerFile = 'composer.json';
-    }
-
-    /**
-     * Generates all the daos and beans.
-     *
-     * @param string $daoFactoryClassName The classe name of the DAO factory
-     * @param string $daonamespace        The namespace for the DAOs, without trailing \
-     * @param string $beannamespace       The Namespace for the beans, without trailing \
-     * @param bool   $storeInUtc          If the generated daos should store the date in UTC timezone instead of user's timezone.
-     *
-     * @return \string[] the list of tables
-     *
-     * @throws TDBMException
-     */
-    public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc)
-    {
-        // TODO: extract ClassNameMapper in its own package!
-        $classNameMapper = ClassNameMapper::createFromComposerFile($this->rootPath.$this->composerFile);
-        // TODO: check that no class name ends with "Base". Otherwise, there will be name clash.
-
-        $tableList = $this->schema->getTables();
-
-        // Remove all beans and daos from junction tables
-        $junctionTables = $this->schemaAnalyzer->detectJunctionTables();
-        $junctionTableNames = array_map(function (Table $table) {
-            return $table->getName();
-        }, $junctionTables);
-
-        $tableList = array_filter($tableList, function (Table $table) use ($junctionTableNames) {
-            return !in_array($table->getName(), $junctionTableNames);
-        });
-
-        foreach ($tableList as $table) {
-            $this->generateDaoAndBean($table, $daonamespace, $beannamespace, $classNameMapper, $storeInUtc);
-        }
-
-        $this->generateFactory($tableList, $daoFactoryClassName, $daonamespace, $classNameMapper);
-
-        // Ok, let's return the list of all tables.
-        // These will be used by the calling script to create Mouf instances.
-
-        return array_map(function (Table $table) { return $table->getName(); }, $tableList);
-    }
-
-    /**
-     * Generates in one method call the daos and the beans for one table.
-     *
-     * @param Table           $table
-     * @param string          $daonamespace
-     * @param string          $beannamespace
-     * @param ClassNameMapper $classNameMapper
-     * @param bool            $storeInUtc
-     *
-     * @throws TDBMException
-     */
-    public function generateDaoAndBean(Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc)
-    {
-        $tableName = $table->getName();
-        $daoName = $this->getDaoNameFromTableName($tableName);
-        $beanName = $this->getBeanNameFromTableName($tableName);
-        $baseBeanName = $this->getBaseBeanNameFromTableName($tableName);
-        $baseDaoName = $this->getBaseDaoNameFromTableName($tableName);
-
-        $beanDescriptor = new BeanDescriptor($table, $this->schemaAnalyzer, $this->schema, $this->tdbmSchemaAnalyzer);
-        $this->generateBean($beanDescriptor, $beanName, $baseBeanName, $table, $beannamespace, $classNameMapper, $storeInUtc);
-        $this->generateDao($beanDescriptor, $daoName, $baseDaoName, $beanName, $table, $daonamespace, $beannamespace, $classNameMapper);
-    }
-
-    /**
-     * Returns the name of the bean class from the table name.
-     *
-     * @param $tableName
-     *
-     * @return string
-     */
-    public static function getBeanNameFromTableName($tableName)
-    {
-        return self::toSingular(self::toCamelCase($tableName)).'Bean';
-    }
-
-    /**
-     * Returns the name of the DAO class from the table name.
-     *
-     * @param $tableName
-     *
-     * @return string
-     */
-    public static function getDaoNameFromTableName($tableName)
-    {
-        return self::toSingular(self::toCamelCase($tableName)).'Dao';
-    }
-
-    /**
-     * Returns the name of the base bean class from the table name.
-     *
-     * @param $tableName
-     *
-     * @return string
-     */
-    public static function getBaseBeanNameFromTableName($tableName)
-    {
-        return self::toSingular(self::toCamelCase($tableName)).'BaseBean';
-    }
-
-    /**
-     * Returns the name of the base DAO class from the table name.
-     *
-     * @param $tableName
-     *
-     * @return string
-     */
-    public static function getBaseDaoNameFromTableName($tableName)
-    {
-        return self::toSingular(self::toCamelCase($tableName)).'BaseDao';
-    }
-
-    /**
-     * Writes the PHP bean file with all getters and setters from the table passed in parameter.
-     *
-     * @param BeanDescriptor  $beanDescriptor
-     * @param string          $className       The name of the class
-     * @param string          $baseClassName   The name of the base class which will be extended (name only, no directory)
-     * @param Table           $table           The table
-     * @param string          $beannamespace   The namespace of the bean
-     * @param ClassNameMapper $classNameMapper
-     *
-     * @throws TDBMException
-     */
-    public function generateBean(BeanDescriptor $beanDescriptor, $className, $baseClassName, Table $table, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc)
-    {
-        $str = $beanDescriptor->generatePhpCode($beannamespace);
-
-        $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\Generated\\'.$baseClassName);
-        if (empty($possibleBaseFileNames)) {
-            throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$baseClassName.'" is not autoloadable.');
-        }
-        $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0];
-
-        $this->ensureDirectoryExist($possibleBaseFileName);
-        file_put_contents($possibleBaseFileName, $str);
-        @chmod($possibleBaseFileName, 0664);
-
-        $possibleFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\'.$className);
-        if (empty($possibleFileNames)) {
-            // @codeCoverageIgnoreStart
-            throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$className.'" is not autoloadable.');
-            // @codeCoverageIgnoreEnd
-        }
-        $possibleFileName = $this->rootPath.$possibleFileNames[0];
-        if (!file_exists($possibleFileName)) {
-            $tableName = $table->getName();
-            $str = "<?php
+	/**
+	 * @var SchemaAnalyzer
+	 */
+	private $schemaAnalyzer;
+
+	/**
+	 * @var Schema
+	 */
+	private $schema;
+
+	/**
+	 * The root directory of the project.
+	 *
+	 * @var string
+	 */
+	private $rootPath;
+
+	/**
+	 * Name of composer file.
+	 *
+	 * @var string
+	 */
+	private $composerFile;
+
+	/**
+	 * @var TDBMSchemaAnalyzer
+	 */
+	private $tdbmSchemaAnalyzer;
+
+	/**
+	 * Constructor.
+	 *
+	 * @param SchemaAnalyzer     $schemaAnalyzer
+	 * @param Schema             $schema
+	 * @param TDBMSchemaAnalyzer $tdbmSchemaAnalyzer
+	 */
+	public function __construct(SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer)
+	{
+		$this->schemaAnalyzer = $schemaAnalyzer;
+		$this->schema = $schema;
+		$this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer;
+		$this->rootPath = __DIR__.'/../../../../../../../../';
+		$this->composerFile = 'composer.json';
+	}
+
+	/**
+	 * Generates all the daos and beans.
+	 *
+	 * @param string $daoFactoryClassName The classe name of the DAO factory
+	 * @param string $daonamespace        The namespace for the DAOs, without trailing \
+	 * @param string $beannamespace       The Namespace for the beans, without trailing \
+	 * @param bool   $storeInUtc          If the generated daos should store the date in UTC timezone instead of user's timezone.
+	 *
+	 * @return \string[] the list of tables
+	 *
+	 * @throws TDBMException
+	 */
+	public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc)
+	{
+		// TODO: extract ClassNameMapper in its own package!
+		$classNameMapper = ClassNameMapper::createFromComposerFile($this->rootPath.$this->composerFile);
+		// TODO: check that no class name ends with "Base". Otherwise, there will be name clash.
+
+		$tableList = $this->schema->getTables();
+
+		// Remove all beans and daos from junction tables
+		$junctionTables = $this->schemaAnalyzer->detectJunctionTables();
+		$junctionTableNames = array_map(function (Table $table) {
+			return $table->getName();
+		}, $junctionTables);
+
+		$tableList = array_filter($tableList, function (Table $table) use ($junctionTableNames) {
+			return !in_array($table->getName(), $junctionTableNames);
+		});
+
+		foreach ($tableList as $table) {
+			$this->generateDaoAndBean($table, $daonamespace, $beannamespace, $classNameMapper, $storeInUtc);
+		}
+
+		$this->generateFactory($tableList, $daoFactoryClassName, $daonamespace, $classNameMapper);
+
+		// Ok, let's return the list of all tables.
+		// These will be used by the calling script to create Mouf instances.
+
+		return array_map(function (Table $table) { return $table->getName(); }, $tableList);
+	}
+
+	/**
+	 * Generates in one method call the daos and the beans for one table.
+	 *
+	 * @param Table           $table
+	 * @param string          $daonamespace
+	 * @param string          $beannamespace
+	 * @param ClassNameMapper $classNameMapper
+	 * @param bool            $storeInUtc
+	 *
+	 * @throws TDBMException
+	 */
+	public function generateDaoAndBean(Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc)
+	{
+		$tableName = $table->getName();
+		$daoName = $this->getDaoNameFromTableName($tableName);
+		$beanName = $this->getBeanNameFromTableName($tableName);
+		$baseBeanName = $this->getBaseBeanNameFromTableName($tableName);
+		$baseDaoName = $this->getBaseDaoNameFromTableName($tableName);
+
+		$beanDescriptor = new BeanDescriptor($table, $this->schemaAnalyzer, $this->schema, $this->tdbmSchemaAnalyzer);
+		$this->generateBean($beanDescriptor, $beanName, $baseBeanName, $table, $beannamespace, $classNameMapper, $storeInUtc);
+		$this->generateDao($beanDescriptor, $daoName, $baseDaoName, $beanName, $table, $daonamespace, $beannamespace, $classNameMapper);
+	}
+
+	/**
+	 * Returns the name of the bean class from the table name.
+	 *
+	 * @param $tableName
+	 *
+	 * @return string
+	 */
+	public static function getBeanNameFromTableName($tableName)
+	{
+		return self::toSingular(self::toCamelCase($tableName)).'Bean';
+	}
+
+	/**
+	 * Returns the name of the DAO class from the table name.
+	 *
+	 * @param $tableName
+	 *
+	 * @return string
+	 */
+	public static function getDaoNameFromTableName($tableName)
+	{
+		return self::toSingular(self::toCamelCase($tableName)).'Dao';
+	}
+
+	/**
+	 * Returns the name of the base bean class from the table name.
+	 *
+	 * @param $tableName
+	 *
+	 * @return string
+	 */
+	public static function getBaseBeanNameFromTableName($tableName)
+	{
+		return self::toSingular(self::toCamelCase($tableName)).'BaseBean';
+	}
+
+	/**
+	 * Returns the name of the base DAO class from the table name.
+	 *
+	 * @param $tableName
+	 *
+	 * @return string
+	 */
+	public static function getBaseDaoNameFromTableName($tableName)
+	{
+		return self::toSingular(self::toCamelCase($tableName)).'BaseDao';
+	}
+
+	/**
+	 * Writes the PHP bean file with all getters and setters from the table passed in parameter.
+	 *
+	 * @param BeanDescriptor  $beanDescriptor
+	 * @param string          $className       The name of the class
+	 * @param string          $baseClassName   The name of the base class which will be extended (name only, no directory)
+	 * @param Table           $table           The table
+	 * @param string          $beannamespace   The namespace of the bean
+	 * @param ClassNameMapper $classNameMapper
+	 *
+	 * @throws TDBMException
+	 */
+	public function generateBean(BeanDescriptor $beanDescriptor, $className, $baseClassName, Table $table, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc)
+	{
+		$str = $beanDescriptor->generatePhpCode($beannamespace);
+
+		$possibleBaseFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\Generated\\'.$baseClassName);
+		if (empty($possibleBaseFileNames)) {
+			throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$baseClassName.'" is not autoloadable.');
+		}
+		$possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0];
+
+		$this->ensureDirectoryExist($possibleBaseFileName);
+		file_put_contents($possibleBaseFileName, $str);
+		@chmod($possibleBaseFileName, 0664);
+
+		$possibleFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\'.$className);
+		if (empty($possibleFileNames)) {
+			// @codeCoverageIgnoreStart
+			throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$className.'" is not autoloadable.');
+			// @codeCoverageIgnoreEnd
+		}
+		$possibleFileName = $this->rootPath.$possibleFileNames[0];
+		if (!file_exists($possibleFileName)) {
+			$tableName = $table->getName();
+			$str = "<?php
 /*
  * This file has been automatically generated by TDBM.
  * You can edit this file as it will not be overwritten.
@@ -228,76 +228,76 @@ 
 {
 
 }";
-            $this->ensureDirectoryExist($possibleFileName);
-            file_put_contents($possibleFileName, $str);
-            @chmod($possibleFileName, 0664);
-        }
-    }
-
-    /**
-     * Tries to find a @defaultSort annotation in one of the columns.
-     *
-     * @param Table $table
-     *
-     * @return array First item: column name, Second item: column order (asc/desc)
-     */
-    private function getDefaultSortColumnFromAnnotation(Table $table)
-    {
-        $defaultSort = null;
-        $defaultSortDirection = null;
-        foreach ($table->getColumns() as $column) {
-            $comments = $column->getComment();
-            $matches = [];
-            if (preg_match('/@defaultSort(\((desc|asc)\))*/', $comments, $matches) != 0) {
-                $defaultSort = $column->getName();
-                if (count($matches) === 3) {
-                    $defaultSortDirection = $matches[2];
-                } else {
-                    $defaultSortDirection = 'ASC';
-                }
-            }
-        }
-
-        return [$defaultSort, $defaultSortDirection];
-    }
-
-    /**
-     * Writes the PHP bean DAO with simple functions to create/get/save objects.
-     *
-     * @param BeanDescriptor  $beanDescriptor
-     * @param string          $className       The name of the class
-     * @param string          $baseClassName
-     * @param string          $beanClassName
-     * @param Table           $table
-     * @param string          $daonamespace
-     * @param string          $beannamespace
-     * @param ClassNameMapper $classNameMapper
-     *
-     * @throws TDBMException
-     */
-    public function generateDao(BeanDescriptor $beanDescriptor, $className, $baseClassName, $beanClassName, Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper)
-    {
-        $tableName = $table->getName();
-        $primaryKeyColumns = $table->getPrimaryKeyColumns();
-
-        list($defaultSort, $defaultSortDirection) = $this->getDefaultSortColumnFromAnnotation($table);
-
-        // FIXME: lowercase tables with _ in the name should work!
-        $tableCamel = self::toSingular(self::toCamelCase($tableName));
-
-        $beanClassWithoutNameSpace = $beanClassName;
-        $beanClassName = $beannamespace.'\\'.$beanClassName;
-
-        list($usedBeans, $findByDaoCode) = $beanDescriptor->generateFindByDaoCode($beannamespace, $beanClassWithoutNameSpace);
-
-        $usedBeans[] = $beanClassName;
-        // Let's suppress duplicates in used beans (if any)
-        $usedBeans = array_flip(array_flip($usedBeans));
-        $useStatements = array_map(function ($usedBean) {
-            return "use $usedBean;\n";
-        }, $usedBeans);
-
-        $str = "<?php
+			$this->ensureDirectoryExist($possibleFileName);
+			file_put_contents($possibleFileName, $str);
+			@chmod($possibleFileName, 0664);
+		}
+	}
+
+	/**
+	 * Tries to find a @defaultSort annotation in one of the columns.
+	 *
+	 * @param Table $table
+	 *
+	 * @return array First item: column name, Second item: column order (asc/desc)
+	 */
+	private function getDefaultSortColumnFromAnnotation(Table $table)
+	{
+		$defaultSort = null;
+		$defaultSortDirection = null;
+		foreach ($table->getColumns() as $column) {
+			$comments = $column->getComment();
+			$matches = [];
+			if (preg_match('/@defaultSort(\((desc|asc)\))*/', $comments, $matches) != 0) {
+				$defaultSort = $column->getName();
+				if (count($matches) === 3) {
+					$defaultSortDirection = $matches[2];
+				} else {
+					$defaultSortDirection = 'ASC';
+				}
+			}
+		}
+
+		return [$defaultSort, $defaultSortDirection];
+	}
+
+	/**
+	 * Writes the PHP bean DAO with simple functions to create/get/save objects.
+	 *
+	 * @param BeanDescriptor  $beanDescriptor
+	 * @param string          $className       The name of the class
+	 * @param string          $baseClassName
+	 * @param string          $beanClassName
+	 * @param Table           $table
+	 * @param string          $daonamespace
+	 * @param string          $beannamespace
+	 * @param ClassNameMapper $classNameMapper
+	 *
+	 * @throws TDBMException
+	 */
+	public function generateDao(BeanDescriptor $beanDescriptor, $className, $baseClassName, $beanClassName, Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper)
+	{
+		$tableName = $table->getName();
+		$primaryKeyColumns = $table->getPrimaryKeyColumns();
+
+		list($defaultSort, $defaultSortDirection) = $this->getDefaultSortColumnFromAnnotation($table);
+
+		// FIXME: lowercase tables with _ in the name should work!
+		$tableCamel = self::toSingular(self::toCamelCase($tableName));
+
+		$beanClassWithoutNameSpace = $beanClassName;
+		$beanClassName = $beannamespace.'\\'.$beanClassName;
+
+		list($usedBeans, $findByDaoCode) = $beanDescriptor->generateFindByDaoCode($beannamespace, $beanClassWithoutNameSpace);
+
+		$usedBeans[] = $beanClassName;
+		// Let's suppress duplicates in used beans (if any)
+		$usedBeans = array_flip(array_flip($usedBeans));
+		$useStatements = array_map(function ($usedBean) {
+			return "use $usedBean;\n";
+		}, $usedBeans);
+
+		$str = "<?php
 
 /*
  * This file has been automatically generated by TDBM.
@@ -374,9 +374,9 @@ 
     }
     ";
 
-        if (count($primaryKeyColumns) === 1) {
-            $primaryKeyColumn = $primaryKeyColumns[0];
-            $str .= "
+		if (count($primaryKeyColumns) === 1) {
+			$primaryKeyColumn = $primaryKeyColumns[0];
+			$str .= "
     /**
      * Get $beanClassWithoutNameSpace specified by its ID (its primary key)
      * If the primary key does not exist, an exception is thrown.
@@ -391,8 +391,8 @@ 
         return \$this->tdbmService->findObjectByPk('$tableName', ['$primaryKeyColumn' => \$id], [], \$lazyLoading);
     }
     ";
-        }
-        $str .= "
+		}
+		$str .= "
     /**
      * Deletes the $beanClassWithoutNameSpace passed in parameter.
      *
@@ -450,33 +450,33 @@ 
     }
 ";
 
-        $str .= $findByDaoCode;
-        $str .= '}
+		$str .= $findByDaoCode;
+		$str .= '}
 ';
 
-        $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\Generated\\'.$baseClassName);
-        if (empty($possibleBaseFileNames)) {
-            // @codeCoverageIgnoreStart
-            throw new TDBMException('Sorry, autoload namespace issue. The class "'.$baseClassName.'" is not autoloadable.');
-            // @codeCoverageIgnoreEnd
-        }
-        $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0];
-
-        $this->ensureDirectoryExist($possibleBaseFileName);
-        file_put_contents($possibleBaseFileName, $str);
-        @chmod($possibleBaseFileName, 0664);
-
-        $possibleFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\'.$className);
-        if (empty($possibleFileNames)) {
-            // @codeCoverageIgnoreStart
-            throw new TDBMException('Sorry, autoload namespace issue. The class "'.$className.'" is not autoloadable.');
-            // @codeCoverageIgnoreEnd
-        }
-        $possibleFileName = $this->rootPath.$possibleFileNames[0];
-
-        // Now, let's generate the "editable" class
-        if (!file_exists($possibleFileName)) {
-            $str = "<?php
+		$possibleBaseFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\Generated\\'.$baseClassName);
+		if (empty($possibleBaseFileNames)) {
+			// @codeCoverageIgnoreStart
+			throw new TDBMException('Sorry, autoload namespace issue. The class "'.$baseClassName.'" is not autoloadable.');
+			// @codeCoverageIgnoreEnd
+		}
+		$possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0];
+
+		$this->ensureDirectoryExist($possibleBaseFileName);
+		file_put_contents($possibleBaseFileName, $str);
+		@chmod($possibleBaseFileName, 0664);
+
+		$possibleFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\'.$className);
+		if (empty($possibleFileNames)) {
+			// @codeCoverageIgnoreStart
+			throw new TDBMException('Sorry, autoload namespace issue. The class "'.$className.'" is not autoloadable.');
+			// @codeCoverageIgnoreEnd
+		}
+		$possibleFileName = $this->rootPath.$possibleFileNames[0];
+
+		// Now, let's generate the "editable" class
+		if (!file_exists($possibleFileName)) {
+			$str = "<?php
 
 /*
  * This file has been automatically generated by TDBM.
@@ -495,22 +495,22 @@ 
 
 }
 ";
-            $this->ensureDirectoryExist($possibleFileName);
-            file_put_contents($possibleFileName, $str);
-            @chmod($possibleFileName, 0664);
-        }
-    }
-
-    /**
-     * Generates the factory bean.
-     *
-     * @param Table[] $tableList
-     */
-    private function generateFactory(array $tableList, $daoFactoryClassName, $daoNamespace, ClassNameMapper $classNameMapper)
-    {
-        // For each table, let's write a property.
-
-        $str = "<?php
+			$this->ensureDirectoryExist($possibleFileName);
+			file_put_contents($possibleFileName, $str);
+			@chmod($possibleFileName, 0664);
+		}
+	}
+
+	/**
+	 * Generates the factory bean.
+	 *
+	 * @param Table[] $tableList
+	 */
+	private function generateFactory(array $tableList, $daoFactoryClassName, $daoNamespace, ClassNameMapper $classNameMapper)
+	{
+		// For each table, let's write a property.
+
+		$str = "<?php
 
 /*
  * This file has been automatically generated by TDBM.
@@ -527,12 +527,12 @@ 
 {
 ";
 
-        foreach ($tableList as $table) {
-            $tableName = $table->getName();
-            $daoClassName = $this->getDaoNameFromTableName($tableName);
-            $daoInstanceName = self::toVariableName($daoClassName);
+		foreach ($tableList as $table) {
+			$tableName = $table->getName();
+			$daoClassName = $this->getDaoNameFromTableName($tableName);
+			$daoInstanceName = self::toVariableName($daoClassName);
 
-            $str .= '    /**
+			$str .= '    /**
      * @var '.$daoClassName.'
      */
     private $'.$daoInstanceName.';
@@ -557,158 +557,158 @@ 
     }
 
 ';
-        }
+		}
 
-        $str .= '
+		$str .= '
 }
 ';
 
-        $possibleFileNames = $classNameMapper->getPossibleFileNames($daoNamespace.'\\Generated\\'.$daoFactoryClassName);
-        if (empty($possibleFileNames)) {
-            throw new TDBMException('Sorry, autoload namespace issue. The class "'.$daoNamespace.'\\'.$daoFactoryClassName.'" is not autoloadable.');
-        }
-        $possibleFileName = $this->rootPath.$possibleFileNames[0];
-
-        $this->ensureDirectoryExist($possibleFileName);
-        file_put_contents($possibleFileName, $str);
-        @chmod($possibleFileName, 0664);
-    }
-
-    /**
-     * Transforms a string to camelCase (except the first letter will be uppercase too).
-     * Underscores and spaces are removed and the first letter after the underscore is uppercased.
-     *
-     * @param $str string
-     *
-     * @return string
-     */
-    public static function toCamelCase($str)
-    {
-        $str = strtoupper(substr($str, 0, 1)).substr($str, 1);
-        while (true) {
-            if (strpos($str, '_') === false && strpos($str, ' ') === false) {
-                break;
-            }
-
-            $pos = strpos($str, '_');
-            if ($pos === false) {
-                $pos = strpos($str, ' ');
-            }
-            $before = substr($str, 0, $pos);
-            $after = substr($str, $pos + 1);
-            $str = $before.strtoupper(substr($after, 0, 1)).substr($after, 1);
-        }
-
-        return $str;
-    }
-
-    /**
-     * Tries to put string to the singular form (if it is plural).
-     * We assume the table names are in english.
-     *
-     * @param $str string
-     *
-     * @return string
-     */
-    public static function toSingular($str)
-    {
-        return Inflector::singularize($str);
-    }
-
-    /**
-     * Put the first letter of the string in lower case.
-     * Very useful to transform a class name into a variable name.
-     *
-     * @param $str string
-     *
-     * @return string
-     */
-    public static function toVariableName($str)
-    {
-        return strtolower(substr($str, 0, 1)).substr($str, 1);
-    }
-
-    /**
-     * Ensures the file passed in parameter can be written in its directory.
-     *
-     * @param string $fileName
-     *
-     * @throws TDBMException
-     */
-    private function ensureDirectoryExist($fileName)
-    {
-        $dirName = dirname($fileName);
-        if (!file_exists($dirName)) {
-            $old = umask(0);
-            $result = mkdir($dirName, 0775, true);
-            umask($old);
-            if ($result === false) {
-                throw new TDBMException("Unable to create directory: '".$dirName."'.");
-            }
-        }
-    }
-
-    /**
-     * Absolute path to composer json file.
-     *
-     * @param string $composerFile
-     */
-    public function setComposerFile($composerFile)
-    {
-        $this->rootPath = dirname($composerFile).'/';
-        $this->composerFile = basename($composerFile);
-    }
-
-    /**
-     * Transforms a DBAL type into a PHP type (for PHPDoc purpose).
-     *
-     * @param Type $type The DBAL type
-     *
-     * @return string The PHP type
-     */
-    public static function dbalTypeToPhpType(Type $type)
-    {
-        $map = [
-            Type::TARRAY => 'array',
-            Type::SIMPLE_ARRAY => 'array',
-            Type::JSON_ARRAY => 'array',
-            Type::BIGINT => 'string',
-            Type::BOOLEAN => 'bool',
-            Type::DATETIME => '\DateTimeInterface',
-            Type::DATETIMETZ => '\DateTimeInterface',
-            Type::DATE => '\DateTimeInterface',
-            Type::TIME => '\DateTimeInterface',
-            Type::DECIMAL => 'float',
-            Type::INTEGER => 'int',
-            Type::OBJECT => 'string',
-            Type::SMALLINT => 'int',
-            Type::STRING => 'string',
-            Type::TEXT => 'string',
-            Type::BINARY => 'string',
-            Type::BLOB => 'string',
-            Type::FLOAT => 'float',
-            Type::GUID => 'string',
-        ];
-
-        return isset($map[$type->getName()]) ? $map[$type->getName()] : $type->getName();
-    }
-
-    /**
-     * @param string $beanNamespace
-     *
-     * @return \string[] Returns a map mapping table name to beans name
-     */
-    public function buildTableToBeanMap($beanNamespace)
-    {
-        $tableToBeanMap = [];
-
-        $tables = $this->schema->getTables();
-
-        foreach ($tables as $table) {
-            $tableName = $table->getName();
-            $tableToBeanMap[$tableName] = $beanNamespace.'\\'.self::getBeanNameFromTableName($tableName);
-        }
-
-        return $tableToBeanMap;
-    }
+		$possibleFileNames = $classNameMapper->getPossibleFileNames($daoNamespace.'\\Generated\\'.$daoFactoryClassName);
+		if (empty($possibleFileNames)) {
+			throw new TDBMException('Sorry, autoload namespace issue. The class "'.$daoNamespace.'\\'.$daoFactoryClassName.'" is not autoloadable.');
+		}
+		$possibleFileName = $this->rootPath.$possibleFileNames[0];
+
+		$this->ensureDirectoryExist($possibleFileName);
+		file_put_contents($possibleFileName, $str);
+		@chmod($possibleFileName, 0664);
+	}
+
+	/**
+	 * Transforms a string to camelCase (except the first letter will be uppercase too).
+	 * Underscores and spaces are removed and the first letter after the underscore is uppercased.
+	 *
+	 * @param $str string
+	 *
+	 * @return string
+	 */
+	public static function toCamelCase($str)
+	{
+		$str = strtoupper(substr($str, 0, 1)).substr($str, 1);
+		while (true) {
+			if (strpos($str, '_') === false && strpos($str, ' ') === false) {
+				break;
+			}
+
+			$pos = strpos($str, '_');
+			if ($pos === false) {
+				$pos = strpos($str, ' ');
+			}
+			$before = substr($str, 0, $pos);
+			$after = substr($str, $pos + 1);
+			$str = $before.strtoupper(substr($after, 0, 1)).substr($after, 1);
+		}
+
+		return $str;
+	}
+
+	/**
+	 * Tries to put string to the singular form (if it is plural).
+	 * We assume the table names are in english.
+	 *
+	 * @param $str string
+	 *
+	 * @return string
+	 */
+	public static function toSingular($str)
+	{
+		return Inflector::singularize($str);
+	}
+
+	/**
+	 * Put the first letter of the string in lower case.
+	 * Very useful to transform a class name into a variable name.
+	 *
+	 * @param $str string
+	 *
+	 * @return string
+	 */
+	public static function toVariableName($str)
+	{
+		return strtolower(substr($str, 0, 1)).substr($str, 1);
+	}
+
+	/**
+	 * Ensures the file passed in parameter can be written in its directory.
+	 *
+	 * @param string $fileName
+	 *
+	 * @throws TDBMException
+	 */
+	private function ensureDirectoryExist($fileName)
+	{
+		$dirName = dirname($fileName);
+		if (!file_exists($dirName)) {
+			$old = umask(0);
+			$result = mkdir($dirName, 0775, true);
+			umask($old);
+			if ($result === false) {
+				throw new TDBMException("Unable to create directory: '".$dirName."'.");
+			}
+		}
+	}
+
+	/**
+	 * Absolute path to composer json file.
+	 *
+	 * @param string $composerFile
+	 */
+	public function setComposerFile($composerFile)
+	{
+		$this->rootPath = dirname($composerFile).'/';
+		$this->composerFile = basename($composerFile);
+	}
+
+	/**
+	 * Transforms a DBAL type into a PHP type (for PHPDoc purpose).
+	 *
+	 * @param Type $type The DBAL type
+	 *
+	 * @return string The PHP type
+	 */
+	public static function dbalTypeToPhpType(Type $type)
+	{
+		$map = [
+			Type::TARRAY => 'array',
+			Type::SIMPLE_ARRAY => 'array',
+			Type::JSON_ARRAY => 'array',
+			Type::BIGINT => 'string',
+			Type::BOOLEAN => 'bool',
+			Type::DATETIME => '\DateTimeInterface',
+			Type::DATETIMETZ => '\DateTimeInterface',
+			Type::DATE => '\DateTimeInterface',
+			Type::TIME => '\DateTimeInterface',
+			Type::DECIMAL => 'float',
+			Type::INTEGER => 'int',
+			Type::OBJECT => 'string',
+			Type::SMALLINT => 'int',
+			Type::STRING => 'string',
+			Type::TEXT => 'string',
+			Type::BINARY => 'string',
+			Type::BLOB => 'string',
+			Type::FLOAT => 'float',
+			Type::GUID => 'string',
+		];
+
+		return isset($map[$type->getName()]) ? $map[$type->getName()] : $type->getName();
+	}
+
+	/**
+	 * @param string $beanNamespace
+	 *
+	 * @return \string[] Returns a map mapping table name to beans name
+	 */
+	public function buildTableToBeanMap($beanNamespace)
+	{
+		$tableToBeanMap = [];
+
+		$tables = $this->schema->getTables();
+
+		foreach ($tables as $table) {
+			$tableName = $table->getName();
+			$tableToBeanMap[$tableName] = $beanNamespace.'\\'.self::getBeanNameFromTableName($tableName);
+		}
+
+		return $tableToBeanMap;
+	}
 }

src/Mouf/Database/TDBM/Controllers/TdbmInstallController.php

Doc Comments +3 added lines

@@ -181,6 +181,9 @@
 
     protected $errorMsg;
 
+    /**
+     * @param string $msg
+     */
     private function displayErrorMsg($msg)
     {
         $this->errorMsg = $msg;

Indentation +168 added lines, -168 removed lines

@@ -15,172 +15,172 @@
  */
 class TdbmInstallController extends Controller
 {
-    /**
-     * @var HtmlBlock
-     */
-    public $content;
-
-    public $selfedit;
-
-    /**
-     * The active MoufManager to be edited/viewed.
-     *
-     * @var MoufManager
-     */
-    public $moufManager;
-
-    /**
-     * The template used by the main page for mouf.
-     *
-     * @Property
-     * @Compulsory
-     *
-     * @var TemplateInterface
-     */
-    public $template;
-
-    /**
-     * Displays the first install screen.
-     *
-     * @Action
-     * @Logged
-     *
-     * @param string $selfedit If true, the name of the component must be a component from the Mouf framework itself (internal use only)
-     */
-    public function defaultAction($selfedit = 'false')
-    {
-        $this->selfedit = $selfedit;
-
-        if ($selfedit == 'true') {
-            $this->moufManager = MoufManager::getMoufManager();
-        } else {
-            $this->moufManager = MoufManager::getMoufManagerHiddenInstance();
-        }
-
-        $this->content->addFile(dirname(__FILE__).'/../../../../views/installStep1.php', $this);
-        $this->template->toHtml();
-    }
-
-    /**
-     * Skips the install process.
-     *
-     * @Action
-     * @Logged
-     *
-     * @param string $selfedit If true, the name of the component must be a component from the Mouf framework itself (internal use only)
-     */
-    public function skip($selfedit = 'false')
-    {
-        InstallUtils::continueInstall($selfedit == 'true');
-    }
-
-    protected $daoNamespace;
-    protected $beanNamespace;
-    protected $autoloadDetected;
-    protected $storeInUtc;
-
-    /**
-     * Displays the second install screen.
-     *
-     * @Action
-     * @Logged
-     *
-     * @param string $selfedit If true, the name of the component must be a component from the Mouf framework itself (internal use only)
-     */
-    public function configure($selfedit = 'false')
-    {
-        $this->selfedit = $selfedit;
-
-        if ($selfedit == 'true') {
-            $this->moufManager = MoufManager::getMoufManager();
-        } else {
-            $this->moufManager = MoufManager::getMoufManagerHiddenInstance();
-        }
-
-        // Let's start by performing basic checks about the instances we assume to exist.
-        if (!$this->moufManager->instanceExists('dbalConnection')) {
-            $this->displayErrorMsg("The TDBM install process assumes your database connection instance is already created, and that the name of this instance is 'dbalConnection'. Could not find the 'dbalConnection' instance.");
-
-            return;
-        }
-
-        $this->daoNamespace = $this->moufManager->getVariable('tdbmDefaultDaoNamespace_tdbmService');
-        $this->beanNamespace = $this->moufManager->getVariable('tdbmDefaultBeanNamespace_tdbmService');
-
-        if ($this->daoNamespace == null && $this->beanNamespace == null) {
-            $classNameMapper = ClassNameMapper::createFromComposerFile(__DIR__.'/../../../../../../../../composer.json');
-
-            $autoloadNamespaces = $classNameMapper->getManagedNamespaces();
-            if ($autoloadNamespaces) {
-                $this->autoloadDetected = true;
-                $rootNamespace = $autoloadNamespaces[0];
-                $this->daoNamespace = $rootNamespace.'Model\\Dao';
-                $this->beanNamespace = $rootNamespace.'Model\\Bean';
-            } else {
-                $this->autoloadDetected = false;
-                $this->daoNamespace = 'YourApplication\\Model\\Dao';
-                $this->beanNamespace = 'YourApplication\\Model\\Bean';
-            }
-        } else {
-            $this->autoloadDetected = true;
-        }
-        $this->defaultPath = true;
-        $this->storePath = '';
-
-        $this->castDatesToDateTime = true;
-
-        $this->content->addFile(dirname(__FILE__).'/../../../../views/installStep2.php', $this);
-        $this->template->toHtml();
-    }
-
-    /**
-     * This action generates the TDBM instance, then the DAOs and Beans.
-     *
-     * @Action
-     *
-     * @param string $daonamespace
-     * @param string $beannamespace
-     * @param int    $storeInUtc
-     * @param string $selfedit
-     *
-     * @throws \Mouf\MoufException
-     */
-    public function generate($daonamespace, $beannamespace, $storeInUtc = 0, $selfedit = 'false', $defaultPath = false, $storePath = '')
-    {
-        $this->selfedit = $selfedit;
-
-        if ($selfedit == 'true') {
-            $this->moufManager = MoufManager::getMoufManager();
-        } else {
-            $this->moufManager = MoufManager::getMoufManagerHiddenInstance();
-        }
-
-        if (!$this->moufManager->instanceExists('doctrineApcCache')) {
-            $doctrineApcCache = $this->moufManager->createInstance('Doctrine\\Common\\Cache\\ApcCache')->setName('doctrineApcCache');
-            // TODO: set namespace
-        } else {
-            $doctrineApcCache = $this->moufManager->getInstanceDescriptor('doctrineApcCache');
-        }
-
-        if (!$this->moufManager->instanceExists('tdbmService')) {
-            $tdbmService = $this->moufManager->createInstance('Mouf\\Database\\TDBM\\TDBMService')->setName('tdbmService');
-            $tdbmService->getConstructorArgumentProperty('connection')->setValue($this->moufManager->getInstanceDescriptor('dbalConnection'));
-            $tdbmService->getConstructorArgumentProperty('cache')->setValue($doctrineApcCache);
-        }
-
-        $this->moufManager->rewriteMouf();
-
-        TdbmController::generateDaos($this->moufManager, 'tdbmService', $daonamespace, $beannamespace, 'DaoFactory', 'daoFactory', $selfedit, $storeInUtc, $defaultPath, $storePath);
-
-        InstallUtils::continueInstall($selfedit == 'true');
-    }
-
-    protected $errorMsg;
-
-    private function displayErrorMsg($msg)
-    {
-        $this->errorMsg = $msg;
-        $this->content->addFile(dirname(__FILE__).'/../../../../views/installError.php', $this);
-        $this->template->toHtml();
-    }
+	/**
+	 * @var HtmlBlock
+	 */
+	public $content;
+
+	public $selfedit;
+
+	/**
+	 * The active MoufManager to be edited/viewed.
+	 *
+	 * @var MoufManager
+	 */
+	public $moufManager;
+
+	/**
+	 * The template used by the main page for mouf.
+	 *
+	 * @Property
+	 * @Compulsory
+	 *
+	 * @var TemplateInterface
+	 */
+	public $template;
+
+	/**
+	 * Displays the first install screen.
+	 *
+	 * @Action
+	 * @Logged
+	 *
+	 * @param string $selfedit If true, the name of the component must be a component from the Mouf framework itself (internal use only)
+	 */
+	public function defaultAction($selfedit = 'false')
+	{
+		$this->selfedit = $selfedit;
+
+		if ($selfedit == 'true') {
+			$this->moufManager = MoufManager::getMoufManager();
+		} else {
+			$this->moufManager = MoufManager::getMoufManagerHiddenInstance();
+		}
+
+		$this->content->addFile(dirname(__FILE__).'/../../../../views/installStep1.php', $this);
+		$this->template->toHtml();
+	}
+
+	/**
+	 * Skips the install process.
+	 *
+	 * @Action
+	 * @Logged
+	 *
+	 * @param string $selfedit If true, the name of the component must be a component from the Mouf framework itself (internal use only)
+	 */
+	public function skip($selfedit = 'false')
+	{
+		InstallUtils::continueInstall($selfedit == 'true');
+	}
+
+	protected $daoNamespace;
+	protected $beanNamespace;
+	protected $autoloadDetected;
+	protected $storeInUtc;
+
+	/**
+	 * Displays the second install screen.
+	 *
+	 * @Action
+	 * @Logged
+	 *
+	 * @param string $selfedit If true, the name of the component must be a component from the Mouf framework itself (internal use only)
+	 */
+	public function configure($selfedit = 'false')
+	{
+		$this->selfedit = $selfedit;
+
+		if ($selfedit == 'true') {
+			$this->moufManager = MoufManager::getMoufManager();
+		} else {
+			$this->moufManager = MoufManager::getMoufManagerHiddenInstance();
+		}
+
+		// Let's start by performing basic checks about the instances we assume to exist.
+		if (!$this->moufManager->instanceExists('dbalConnection')) {
+			$this->displayErrorMsg("The TDBM install process assumes your database connection instance is already created, and that the name of this instance is 'dbalConnection'. Could not find the 'dbalConnection' instance.");
+
+			return;
+		}
+
+		$this->daoNamespace = $this->moufManager->getVariable('tdbmDefaultDaoNamespace_tdbmService');
+		$this->beanNamespace = $this->moufManager->getVariable('tdbmDefaultBeanNamespace_tdbmService');
+
+		if ($this->daoNamespace == null && $this->beanNamespace == null) {
+			$classNameMapper = ClassNameMapper::createFromComposerFile(__DIR__.'/../../../../../../../../composer.json');
+
+			$autoloadNamespaces = $classNameMapper->getManagedNamespaces();
+			if ($autoloadNamespaces) {
+				$this->autoloadDetected = true;
+				$rootNamespace = $autoloadNamespaces[0];
+				$this->daoNamespace = $rootNamespace.'Model\\Dao';
+				$this->beanNamespace = $rootNamespace.'Model\\Bean';
+			} else {
+				$this->autoloadDetected = false;
+				$this->daoNamespace = 'YourApplication\\Model\\Dao';
+				$this->beanNamespace = 'YourApplication\\Model\\Bean';
+			}
+		} else {
+			$this->autoloadDetected = true;
+		}
+		$this->defaultPath = true;
+		$this->storePath = '';
+
+		$this->castDatesToDateTime = true;
+
+		$this->content->addFile(dirname(__FILE__).'/../../../../views/installStep2.php', $this);
+		$this->template->toHtml();
+	}
+
+	/**
+	 * This action generates the TDBM instance, then the DAOs and Beans.
+	 *
+	 * @Action
+	 *
+	 * @param string $daonamespace
+	 * @param string $beannamespace
+	 * @param int    $storeInUtc
+	 * @param string $selfedit
+	 *
+	 * @throws \Mouf\MoufException
+	 */
+	public function generate($daonamespace, $beannamespace, $storeInUtc = 0, $selfedit = 'false', $defaultPath = false, $storePath = '')
+	{
+		$this->selfedit = $selfedit;
+
+		if ($selfedit == 'true') {
+			$this->moufManager = MoufManager::getMoufManager();
+		} else {
+			$this->moufManager = MoufManager::getMoufManagerHiddenInstance();
+		}
+
+		if (!$this->moufManager->instanceExists('doctrineApcCache')) {
+			$doctrineApcCache = $this->moufManager->createInstance('Doctrine\\Common\\Cache\\ApcCache')->setName('doctrineApcCache');
+			// TODO: set namespace
+		} else {
+			$doctrineApcCache = $this->moufManager->getInstanceDescriptor('doctrineApcCache');
+		}
+
+		if (!$this->moufManager->instanceExists('tdbmService')) {
+			$tdbmService = $this->moufManager->createInstance('Mouf\\Database\\TDBM\\TDBMService')->setName('tdbmService');
+			$tdbmService->getConstructorArgumentProperty('connection')->setValue($this->moufManager->getInstanceDescriptor('dbalConnection'));
+			$tdbmService->getConstructorArgumentProperty('cache')->setValue($doctrineApcCache);
+		}
+
+		$this->moufManager->rewriteMouf();
+
+		TdbmController::generateDaos($this->moufManager, 'tdbmService', $daonamespace, $beannamespace, 'DaoFactory', 'daoFactory', $selfedit, $storeInUtc, $defaultPath, $storePath);
+
+		InstallUtils::continueInstall($selfedit == 'true');
+	}
+
+	protected $errorMsg;
+
+	private function displayErrorMsg($msg)
+	{
+		$this->errorMsg = $msg;
+		$this->content->addFile(dirname(__FILE__).'/../../../../views/installError.php', $this);
+		$this->template->toHtml();
+	}
 }

src/Mouf/Database/TDBM/Controllers/TdbmController.php

Doc Comments +3 added lines, -1 removed lines

@@ -86,7 +86,7 @@ 
      * @Action
      *
      * @param string $name
-     * @param bool   $selfedit
+     * @param string|boolean   $selfedit
      */
     public function generate($name, $daonamespace, $beannamespace, $daofactoryclassname, $daofactoryinstancename, $storeInUtc = 0, $selfedit = 'false', $useCustomComposer = false, $composerFile = '')
     {
@@ -109,6 +109,8 @@ 
      * @param string      $daofactoryinstancename
      * @param string      $selfedit
      * @param bool        $storeInUtc
+     * @param boolean $useCustomComposer
+     * @param string $composerFile
      *
      * @throws \Mouf\MoufException
      */