thecodingmachine / database.tdbm

src/Mouf/Database/TDBM/Commands/GenerateCommand.php

Indentation +32 added lines, -32 removed lines

@@ -12,48 +12,48 @@
 class GenerateCommand extends Command
 {
 
-    /**
-     * @var ConfigurationInterface
-     */
-    private $configuration;
+	/**
+	 * @var ConfigurationInterface
+	 */
+	private $configuration;
 
-    public function __construct(ConfigurationInterface $configuration)
-    {
-        parent::__construct();
-        $this->configuration = $configuration;
-    }
+	public function __construct(ConfigurationInterface $configuration)
+	{
+		parent::__construct();
+		$this->configuration = $configuration;
+	}
 
-    protected function configure()
-    {
-        $this->setName('tdbm:generate')
-            ->setDescription('Generates DAOs and beans.')
-            ->setHelp('Use this command to generate or regenerate the DAOs and beans for your project.')
-        ;
-    }
+	protected function configure()
+	{
+		$this->setName('tdbm:generate')
+			->setDescription('Generates DAOs and beans.')
+			->setHelp('Use this command to generate or regenerate the DAOs and beans for your project.')
+		;
+	}
 
-    protected function execute(InputInterface $input, OutputInterface $output)
-    {
-        // TODO: externalize composer.json file for autoloading (no more parameters for generateAllDaosAndBeans)
+	protected function execute(InputInterface $input, OutputInterface $output)
+	{
+		// TODO: externalize composer.json file for autoloading (no more parameters for generateAllDaosAndBeans)
 
-        $alteredConf = new AlteredConfiguration($this->configuration);
+		$alteredConf = new AlteredConfiguration($this->configuration);
 
 
-        $loggers = [ new ConsoleLogger($output) ];
+		$loggers = [ new ConsoleLogger($output) ];
 
-        $logger = $alteredConf->getLogger();
-        if ($logger) {
-            $loggers[] = $logger;
-        }
+		$logger = $alteredConf->getLogger();
+		if ($logger) {
+			$loggers[] = $logger;
+		}
 
-        $multiLogger = new MultiLogger($loggers);
+		$multiLogger = new MultiLogger($loggers);
 
-        $alteredConf->setLogger($multiLogger);
+		$alteredConf->setLogger($multiLogger);
 
-        $multiLogger->notice('Starting regenerating DAOs and beans');
+		$multiLogger->notice('Starting regenerating DAOs and beans');
 
-        $tdbmService = new TDBMService($this->configuration);
-        $tdbmService->generateAllDaosAndBeans();
+		$tdbmService = new TDBMService($this->configuration);
+		$tdbmService->generateAllDaosAndBeans();
 
-        $multiLogger->notice('Finished regenerating DAOs and beans');
-    }
+		$multiLogger->notice('Finished regenerating DAOs and beans');
+	}
 }

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

Indentation +130 added lines, -130 removed lines

@@ -19,134 +19,134 @@
  */
 class TdbmController extends AbstractMoufInstanceController
 {
-    /**
-     * @var HtmlBlock
-     */
-    public $content;
-
-    protected $daoNamespace;
-    protected $beanNamespace;
-    protected $daoFactoryInstanceName;
-    protected $autoloadDetected;
-    ///protected $storeInUtc;
-    protected $useCustomComposer;
-    protected $composerFile;
-
-    /**
-     * Admin page used to display the DAO generation form.
-     *
-     * @Action
-     */
-    public function defaultAction($name, $selfedit = 'false')
-    {
-        $this->initController($name, $selfedit);
-
-        // Fill variables
-        $this->daoNamespace = self::getFromConfiguration($this->moufManager, $name, 'daoNamespace');
-        $this->beanNamespace = self::getFromConfiguration($this->moufManager, $name, 'beanNamespace');
-        $this->daoFactoryInstanceName = self::getFromConfiguration($this->moufManager, $name, 'daoFactoryInstanceName');
-        //$this->storeInUtc = self::getFromConfiguration($this->moufManager, $name, 'storeInUtc');
-        $pathFinder = self::getFromConfiguration($this->moufManager, $name, 'pathFinder');
-        if ($pathFinder !== null) {
-            $this->composerFile = $pathFinder->getConstructorArgumentProperty('composerFile')->getValue();
-        } else {
-            $this->composerFile = null;
-        }
-        $this->useCustomComposer = $this->composerFile ? true : false;
-
-        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.'Dao';
-                $this->beanNamespace = $rootNamespace.'Dao\\Bean';
-            } else {
-                $this->autoloadDetected = false;
-                $this->daoNamespace = 'YourApplication\\Dao';
-                $this->beanNamespace = 'YourApplication\\Dao\\Bean';
-            }
-        } else {
-            $this->autoloadDetected = true;
-        }
-
-        $this->content->addFile(__DIR__.'/../../../../views/tdbmGenerate.php', $this);
-        $this->template->toHtml();
-    }
-
-    /**
-     * This action generates the DAOs and Beans for the TDBM service passed in parameter.
-     *
-     * @Action
-     *
-     * @param string $name
-     * @param bool   $selfedit
-     */
-    public function generate($name, $daonamespace, $beannamespace, $daofactoryinstancename, /*$storeInUtc = 0,*/ $selfedit = 'false', $useCustomComposer = false, $composerFile = '')
-    {
-        $this->initController($name, $selfedit);
-
-        self::generateDaos($this->moufManager, $name, $daonamespace, $beannamespace, $daofactoryinstancename, $selfedit, /*$storeInUtc,*/ $useCustomComposer, $composerFile);
-
-        // TODO: better: we should redirect to a screen that list the number of DAOs generated, etc...
-        header('Location: '.ROOT_URL.'ajaxinstance/?name='.urlencode($name).'&selfedit='.$selfedit);
-    }
-
-    /**
-     * This function generates the DAOs and Beans for the TDBM service passed in parameter.
-     *
-     * @param MoufManager $moufManager
-     * @param string      $name
-     * @param string      $daonamespace
-     * @param string      $beannamespace
-     * @param string      $selfedit
-     *
-     * @throws \Mouf\MoufException
-     */
-    public static function generateDaos(MoufManager $moufManager, $name, $daonamespace, $beannamespace, $daofactoryinstancename, $selfedit = 'false', /*$storeInUtc = null,*/ $useCustomComposer = null, $composerFile = null)
-    {
-        self::setInConfiguration($moufManager, $name, 'daoNamespace', $daonamespace);
-        self::setInConfiguration($moufManager, $name, 'beanNamespace', $beannamespace);
-        self::setInConfiguration($moufManager, $name, 'daoFactoryInstanceName', $daofactoryinstancename);
-        //self::setInConfiguration($moufManager, $name, 'storeInUtc', $storeInUtc);
-        if ($useCustomComposer) {
-            $pathFinder = $moufManager->createInstance(PathFinder::class);
-            $pathFinder->getConstructorArgumentProperty('composerFile')->setValue($composerFile);
-            self::setInConfiguration($moufManager, $name, 'pathFinder', $pathFinder);
-        } else {
-            self::setInConfiguration($moufManager, $name, 'pathFinder', null);
-        }
-        // Let's rewrite before calling the DAO generator
-        $moufManager->rewriteMouf();
-
-
-        $tdbmService = new InstanceProxy($name);
-        /* @var $tdbmService TDBMService */
-        $tdbmService->generateAllDaosAndBeans();
-    }
-
-    private static function getConfigurationDescriptor(MoufManager $moufManager, string $tdbmInstanceName)
-    {
-        return $moufManager->getInstanceDescriptor($tdbmInstanceName)->getConstructorArgumentProperty('configuration')->getValue();
-    }
-
-    private static function getFromConfiguration(MoufManager $moufManager, string $tdbmInstanceName, string $property)
-    {
-        $configuration = self::getConfigurationDescriptor($moufManager, $tdbmInstanceName);
-        if ($configuration === null) {
-            throw new \RuntimeException('Unable to find the configuration object linked to TDBMService.');
-        }
-        return $configuration->getProperty($property)->getValue();
-    }
-
-    private static function setInConfiguration(MoufManager $moufManager, string $tdbmInstanceName, string $property, ?string $value)
-    {
-        $configuration = self::getConfigurationDescriptor($moufManager, $tdbmInstanceName);
-        if ($configuration === null) {
-            throw new \RuntimeException('Unable to find the configuration object linked to TDBMService.');
-        }
-        $configuration->getProperty($property)->setValue($value);
-    }
+	/**
+	 * @var HtmlBlock
+	 */
+	public $content;
+
+	protected $daoNamespace;
+	protected $beanNamespace;
+	protected $daoFactoryInstanceName;
+	protected $autoloadDetected;
+	///protected $storeInUtc;
+	protected $useCustomComposer;
+	protected $composerFile;
+
+	/**
+	 * Admin page used to display the DAO generation form.
+	 *
+	 * @Action
+	 */
+	public function defaultAction($name, $selfedit = 'false')
+	{
+		$this->initController($name, $selfedit);
+
+		// Fill variables
+		$this->daoNamespace = self::getFromConfiguration($this->moufManager, $name, 'daoNamespace');
+		$this->beanNamespace = self::getFromConfiguration($this->moufManager, $name, 'beanNamespace');
+		$this->daoFactoryInstanceName = self::getFromConfiguration($this->moufManager, $name, 'daoFactoryInstanceName');
+		//$this->storeInUtc = self::getFromConfiguration($this->moufManager, $name, 'storeInUtc');
+		$pathFinder = self::getFromConfiguration($this->moufManager, $name, 'pathFinder');
+		if ($pathFinder !== null) {
+			$this->composerFile = $pathFinder->getConstructorArgumentProperty('composerFile')->getValue();
+		} else {
+			$this->composerFile = null;
+		}
+		$this->useCustomComposer = $this->composerFile ? true : false;
+
+		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.'Dao';
+				$this->beanNamespace = $rootNamespace.'Dao\\Bean';
+			} else {
+				$this->autoloadDetected = false;
+				$this->daoNamespace = 'YourApplication\\Dao';
+				$this->beanNamespace = 'YourApplication\\Dao\\Bean';
+			}
+		} else {
+			$this->autoloadDetected = true;
+		}
+
+		$this->content->addFile(__DIR__.'/../../../../views/tdbmGenerate.php', $this);
+		$this->template->toHtml();
+	}
+
+	/**
+	 * This action generates the DAOs and Beans for the TDBM service passed in parameter.
+	 *
+	 * @Action
+	 *
+	 * @param string $name
+	 * @param bool   $selfedit
+	 */
+	public function generate($name, $daonamespace, $beannamespace, $daofactoryinstancename, /*$storeInUtc = 0,*/ $selfedit = 'false', $useCustomComposer = false, $composerFile = '')
+	{
+		$this->initController($name, $selfedit);
+
+		self::generateDaos($this->moufManager, $name, $daonamespace, $beannamespace, $daofactoryinstancename, $selfedit, /*$storeInUtc,*/ $useCustomComposer, $composerFile);
+
+		// TODO: better: we should redirect to a screen that list the number of DAOs generated, etc...
+		header('Location: '.ROOT_URL.'ajaxinstance/?name='.urlencode($name).'&selfedit='.$selfedit);
+	}
+
+	/**
+	 * This function generates the DAOs and Beans for the TDBM service passed in parameter.
+	 *
+	 * @param MoufManager $moufManager
+	 * @param string      $name
+	 * @param string      $daonamespace
+	 * @param string      $beannamespace
+	 * @param string      $selfedit
+	 *
+	 * @throws \Mouf\MoufException
+	 */
+	public static function generateDaos(MoufManager $moufManager, $name, $daonamespace, $beannamespace, $daofactoryinstancename, $selfedit = 'false', /*$storeInUtc = null,*/ $useCustomComposer = null, $composerFile = null)
+	{
+		self::setInConfiguration($moufManager, $name, 'daoNamespace', $daonamespace);
+		self::setInConfiguration($moufManager, $name, 'beanNamespace', $beannamespace);
+		self::setInConfiguration($moufManager, $name, 'daoFactoryInstanceName', $daofactoryinstancename);
+		//self::setInConfiguration($moufManager, $name, 'storeInUtc', $storeInUtc);
+		if ($useCustomComposer) {
+			$pathFinder = $moufManager->createInstance(PathFinder::class);
+			$pathFinder->getConstructorArgumentProperty('composerFile')->setValue($composerFile);
+			self::setInConfiguration($moufManager, $name, 'pathFinder', $pathFinder);
+		} else {
+			self::setInConfiguration($moufManager, $name, 'pathFinder', null);
+		}
+		// Let's rewrite before calling the DAO generator
+		$moufManager->rewriteMouf();
+
+
+		$tdbmService = new InstanceProxy($name);
+		/* @var $tdbmService TDBMService */
+		$tdbmService->generateAllDaosAndBeans();
+	}
+
+	private static function getConfigurationDescriptor(MoufManager $moufManager, string $tdbmInstanceName)
+	{
+		return $moufManager->getInstanceDescriptor($tdbmInstanceName)->getConstructorArgumentProperty('configuration')->getValue();
+	}
+
+	private static function getFromConfiguration(MoufManager $moufManager, string $tdbmInstanceName, string $property)
+	{
+		$configuration = self::getConfigurationDescriptor($moufManager, $tdbmInstanceName);
+		if ($configuration === null) {
+			throw new \RuntimeException('Unable to find the configuration object linked to TDBMService.');
+		}
+		return $configuration->getProperty($property)->getValue();
+	}
+
+	private static function setInConfiguration(MoufManager $moufManager, string $tdbmInstanceName, string $property, ?string $value)
+	{
+		$configuration = self::getConfigurationDescriptor($moufManager, $tdbmInstanceName);
+		if ($configuration === null) {
+			throw new \RuntimeException('Unable to find the configuration object linked to TDBMService.');
+		}
+		$configuration->getProperty($property)->setValue($value);
+	}
 }

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

Indentation +215 added lines, -215 removed lines

@@ -21,219 +21,219 @@
  */
 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;
-    protected $useCustomComposer = false;
-    protected $composerFile;
-
-    /**
-     * 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;
-        }
-
-        if ($this->moufManager->has('tdbmConfiguration')) {
-            $tdbmConfiguration = $this->moufManager->getInstanceDescriptor('tdbmConfiguration');
-
-            $this->beanNamespace = $tdbmConfiguration->getConstructorArgumentProperty('beanNamespace')->getValue();
-            $this->daoNamespace = $tdbmConfiguration->getConstructorArgumentProperty('daoNamespace')->getValue();
-        } else {
-            // Old TDBM 4.2 fallback
-            $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.'Dao';
-                $this->beanNamespace = $rootNamespace.'Model';
-            } else {
-                $this->autoloadDetected = false;
-                $this->daoNamespace = 'YourApplication\\Dao';
-                $this->beanNamespace = 'YourApplication\\Model';
-            }
-        } else {
-            $this->autoloadDetected = true;
-        }
-        $this->defaultPath = true;
-        $this->storePath = '';
-
-        $this->castDatesToDateTime = true;
-
-        $this->content->addFile(__DIR__.'/../../../../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 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();
-        }
-
-        $doctrineCache = $this->moufManager->getInstanceDescriptor('defaultDoctrineCache');
-
-        $migratingFrom42 = false;
-        if ($this->moufManager->has('tdbmService') && !$this->moufManager->has('tdbmConfiguration')) {
-            $migratingFrom42 = true;
-        }
-
-        $namingStrategy = InstallUtils::getOrCreateInstance('namingStrategy', DefaultNamingStrategy::class, $this->moufManager);
-        if ($migratingFrom42) {
-            // Let's setup the naming strategy for compatibility
-            $namingStrategy->getSetterProperty('setBeanPrefix')->setValue('');
-            $namingStrategy->getSetterProperty('setBeanSuffix')->setValue('Bean');
-            $namingStrategy->getSetterProperty('setBaseBeanPrefix')->setValue('');
-            $namingStrategy->getSetterProperty('setBaseBeanSuffix')->setValue('BaseBean');
-            $namingStrategy->getSetterProperty('setDaoPrefix')->setValue('');
-            $namingStrategy->getSetterProperty('setDaoSuffix')->setValue('Dao');
-            $namingStrategy->getSetterProperty('setBaseDaoPrefix')->setValue('');
-            $namingStrategy->getSetterProperty('setBaseDaoSuffix')->setValue('BaseDao');
-        }
-
-        if (!$this->moufManager->instanceExists('tdbmConfiguration')) {
-            $moufListener = InstallUtils::getOrCreateInstance(MoufDiListener::class, MoufDiListener::class, $this->moufManager);
-
-            $tdbmConfiguration = $this->moufManager->createInstance(MoufConfiguration::class)->setName('tdbmConfiguration');
-            $tdbmConfiguration->getConstructorArgumentProperty('connection')->setValue($this->moufManager->getInstanceDescriptor('dbalConnection'));
-            $tdbmConfiguration->getConstructorArgumentProperty('cache')->setValue($doctrineCache);
-            $tdbmConfiguration->getConstructorArgumentProperty('namingStrategy')->setValue($namingStrategy);
-            $tdbmConfiguration->getProperty('daoFactoryInstanceName')->setValue('daoFactory');
-            $tdbmConfiguration->getConstructorArgumentProperty('generatorListeners')->setValue([$moufListener]);
-
-            // Let's also delete the tdbmService if migrating versions <= 4.2
-            if ($migratingFrom42) {
-                $this->moufManager->removeComponent('tdbmService');
-            }
-        } else {
-            $tdbmConfiguration = $this->moufManager->getInstanceDescriptor('tdbmConfiguration');
-        }
-
-        if (!$this->moufManager->instanceExists('tdbmService')) {
-            $tdbmService = $this->moufManager->createInstance('Mouf\\Database\\TDBM\\TDBMService')->setName('tdbmService');
-            $tdbmService->getConstructorArgumentProperty('configuration')->setValue($tdbmConfiguration);
-        }
-
-        // We declare our instance of the Symfony command as a Mouf instance
-        $generateCommand = InstallUtils::getOrCreateInstance('generateCommand', GenerateCommand::class, $this->moufManager);
-        $generateCommand->getConstructorArgumentProperty('configuration')->setValue($tdbmConfiguration);
-
-        // We register that instance descriptor using "ConsoleUtils"
-        $consoleUtils = new ConsoleUtils($this->moufManager);
-        $consoleUtils->registerCommand($generateCommand);
-
-        $this->moufManager->rewriteMouf();
-
-        TdbmController::generateDaos($this->moufManager, 'tdbmService', $daonamespace, $beannamespace, 'daoFactory', $selfedit, /*$storeInUtc,*/ $defaultPath, $storePath);
-
-        InstallUtils::continueInstall($selfedit == 'true');
-    }
-
-    protected $errorMsg;
-
-    private function displayErrorMsg($msg)
-    {
-        $this->errorMsg = $msg;
-        $this->content->addFile(__DIR__.'/../../../../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;
+	protected $useCustomComposer = false;
+	protected $composerFile;
+
+	/**
+	 * 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;
+		}
+
+		if ($this->moufManager->has('tdbmConfiguration')) {
+			$tdbmConfiguration = $this->moufManager->getInstanceDescriptor('tdbmConfiguration');
+
+			$this->beanNamespace = $tdbmConfiguration->getConstructorArgumentProperty('beanNamespace')->getValue();
+			$this->daoNamespace = $tdbmConfiguration->getConstructorArgumentProperty('daoNamespace')->getValue();
+		} else {
+			// Old TDBM 4.2 fallback
+			$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.'Dao';
+				$this->beanNamespace = $rootNamespace.'Model';
+			} else {
+				$this->autoloadDetected = false;
+				$this->daoNamespace = 'YourApplication\\Dao';
+				$this->beanNamespace = 'YourApplication\\Model';
+			}
+		} else {
+			$this->autoloadDetected = true;
+		}
+		$this->defaultPath = true;
+		$this->storePath = '';
+
+		$this->castDatesToDateTime = true;
+
+		$this->content->addFile(__DIR__.'/../../../../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 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();
+		}
+
+		$doctrineCache = $this->moufManager->getInstanceDescriptor('defaultDoctrineCache');
+
+		$migratingFrom42 = false;
+		if ($this->moufManager->has('tdbmService') && !$this->moufManager->has('tdbmConfiguration')) {
+			$migratingFrom42 = true;
+		}
+
+		$namingStrategy = InstallUtils::getOrCreateInstance('namingStrategy', DefaultNamingStrategy::class, $this->moufManager);
+		if ($migratingFrom42) {
+			// Let's setup the naming strategy for compatibility
+			$namingStrategy->getSetterProperty('setBeanPrefix')->setValue('');
+			$namingStrategy->getSetterProperty('setBeanSuffix')->setValue('Bean');
+			$namingStrategy->getSetterProperty('setBaseBeanPrefix')->setValue('');
+			$namingStrategy->getSetterProperty('setBaseBeanSuffix')->setValue('BaseBean');
+			$namingStrategy->getSetterProperty('setDaoPrefix')->setValue('');
+			$namingStrategy->getSetterProperty('setDaoSuffix')->setValue('Dao');
+			$namingStrategy->getSetterProperty('setBaseDaoPrefix')->setValue('');
+			$namingStrategy->getSetterProperty('setBaseDaoSuffix')->setValue('BaseDao');
+		}
+
+		if (!$this->moufManager->instanceExists('tdbmConfiguration')) {
+			$moufListener = InstallUtils::getOrCreateInstance(MoufDiListener::class, MoufDiListener::class, $this->moufManager);
+
+			$tdbmConfiguration = $this->moufManager->createInstance(MoufConfiguration::class)->setName('tdbmConfiguration');
+			$tdbmConfiguration->getConstructorArgumentProperty('connection')->setValue($this->moufManager->getInstanceDescriptor('dbalConnection'));
+			$tdbmConfiguration->getConstructorArgumentProperty('cache')->setValue($doctrineCache);
+			$tdbmConfiguration->getConstructorArgumentProperty('namingStrategy')->setValue($namingStrategy);
+			$tdbmConfiguration->getProperty('daoFactoryInstanceName')->setValue('daoFactory');
+			$tdbmConfiguration->getConstructorArgumentProperty('generatorListeners')->setValue([$moufListener]);
+
+			// Let's also delete the tdbmService if migrating versions <= 4.2
+			if ($migratingFrom42) {
+				$this->moufManager->removeComponent('tdbmService');
+			}
+		} else {
+			$tdbmConfiguration = $this->moufManager->getInstanceDescriptor('tdbmConfiguration');
+		}
+
+		if (!$this->moufManager->instanceExists('tdbmService')) {
+			$tdbmService = $this->moufManager->createInstance('Mouf\\Database\\TDBM\\TDBMService')->setName('tdbmService');
+			$tdbmService->getConstructorArgumentProperty('configuration')->setValue($tdbmConfiguration);
+		}
+
+		// We declare our instance of the Symfony command as a Mouf instance
+		$generateCommand = InstallUtils::getOrCreateInstance('generateCommand', GenerateCommand::class, $this->moufManager);
+		$generateCommand->getConstructorArgumentProperty('configuration')->setValue($tdbmConfiguration);
+
+		// We register that instance descriptor using "ConsoleUtils"
+		$consoleUtils = new ConsoleUtils($this->moufManager);
+		$consoleUtils->registerCommand($generateCommand);
+
+		$this->moufManager->rewriteMouf();
+
+		TdbmController::generateDaos($this->moufManager, 'tdbmService', $daonamespace, $beannamespace, 'daoFactory', $selfedit, /*$storeInUtc,*/ $defaultPath, $storePath);
+
+		InstallUtils::continueInstall($selfedit == 'true');
+	}
+
+	protected $errorMsg;
+
+	private function displayErrorMsg($msg)
+	{
+		$this->errorMsg = $msg;
+		$this->content->addFile(__DIR__.'/../../../../views/installError.php', $this);
+		$this->template->toHtml();
+	}
 }

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

Indentation +356 added lines, -356 removed lines

@@ -17,132 +17,132 @@ 
  */
 class TDBMDaoGenerator
 {
-    /**
-     * @var Schema
-     */
-    private $schema;
-
-    /**
-     * Name of composer file.
-     *
-     * @var string
-     */
-    private $composerFile;
-
-    /**
-     * @var TDBMSchemaAnalyzer
-     */
-    private $tdbmSchemaAnalyzer;
-
-    /**
-     * @var GeneratorListenerInterface
-     */
-    private $eventDispatcher;
-
-    /**
-     * @var NamingStrategyInterface
-     */
-    private $namingStrategy;
-    /**
-     * @var ConfigurationInterface
-     */
-    private $configuration;
-
-    /**
-     * Constructor.
-     *
-     * @param ConfigurationInterface $configuration
-     * @param TDBMSchemaAnalyzer $tdbmSchemaAnalyzer
-     */
-    public function __construct(ConfigurationInterface $configuration, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer)
-    {
-        $this->configuration = $configuration;
-        $this->schema = $tdbmSchemaAnalyzer->getSchema();
-        $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer;
-        $this->namingStrategy = $configuration->getNamingStrategy();
-        $this->eventDispatcher = $configuration->getGeneratorEventDispatcher();
-    }
-
-    /**
-     * Generates all the daos and beans.
-     *
-     * @throws TDBMException
-     */
-    public function generateAllDaosAndBeans(): void
-    {
-        // 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->configuration->getSchemaAnalyzer()->detectJunctionTables(true);
-        $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);
-        });
-
-        $beanDescriptors = [];
-
-        foreach ($tableList as $table) {
-            $beanDescriptors[] = $this->generateDaoAndBean($table);
-        }
-
-
-        $this->generateFactory($tableList);
-
-        // Let's call the list of listeners
-        $this->eventDispatcher->onGenerate($this->configuration, $beanDescriptors);
-    }
-
-    /**
-     * Generates in one method call the daos and the beans for one table.
-     *
-     * @param Table $table
-     *
-     * @return BeanDescriptor
-     * @throws TDBMException
-     */
-    private function generateDaoAndBean(Table $table) : BeanDescriptor
-    {
-        $tableName = $table->getName();
-        $daoName = $this->namingStrategy->getDaoClassName($tableName);
-        $beanName = $this->namingStrategy->getBeanClassName($tableName);
-        $baseBeanName = $this->namingStrategy->getBaseBeanClassName($tableName);
-        $baseDaoName = $this->namingStrategy->getBaseDaoClassName($tableName);
-
-        $beanDescriptor = new BeanDescriptor($table, $this->configuration->getSchemaAnalyzer(), $this->schema, $this->tdbmSchemaAnalyzer, $this->namingStrategy);
-        $this->generateBean($beanDescriptor, $beanName, $baseBeanName, $table);
-        $this->generateDao($beanDescriptor, $daoName, $baseDaoName, $beanName, $table);
-        return $beanDescriptor;
-    }
-
-    /**
-     * 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
-     *
-     * @throws TDBMException
-     */
-    public function generateBean(BeanDescriptor $beanDescriptor, $className, $baseClassName, Table $table)
-    {
-        $beannamespace = $this->configuration->getBeanNamespace();
-        $str = $beanDescriptor->generatePhpCode($beannamespace);
-
-        $possibleBaseFileName = $this->configuration->getPathFinder()->getPath($beannamespace.'\\Generated\\'.$baseClassName)->getPathname();
-
-        $this->dumpFile($possibleBaseFileName, $str);
-
-        $possibleFileName = $this->configuration->getPathFinder()->getPath($beannamespace.'\\'.$className)->getPathname();
-
-        if (!file_exists($possibleFileName)) {
-            $tableName = $table->getName();
-            $str = "<?php
+	/**
+	 * @var Schema
+	 */
+	private $schema;
+
+	/**
+	 * Name of composer file.
+	 *
+	 * @var string
+	 */
+	private $composerFile;
+
+	/**
+	 * @var TDBMSchemaAnalyzer
+	 */
+	private $tdbmSchemaAnalyzer;
+
+	/**
+	 * @var GeneratorListenerInterface
+	 */
+	private $eventDispatcher;
+
+	/**
+	 * @var NamingStrategyInterface
+	 */
+	private $namingStrategy;
+	/**
+	 * @var ConfigurationInterface
+	 */
+	private $configuration;
+
+	/**
+	 * Constructor.
+	 *
+	 * @param ConfigurationInterface $configuration
+	 * @param TDBMSchemaAnalyzer $tdbmSchemaAnalyzer
+	 */
+	public function __construct(ConfigurationInterface $configuration, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer)
+	{
+		$this->configuration = $configuration;
+		$this->schema = $tdbmSchemaAnalyzer->getSchema();
+		$this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer;
+		$this->namingStrategy = $configuration->getNamingStrategy();
+		$this->eventDispatcher = $configuration->getGeneratorEventDispatcher();
+	}
+
+	/**
+	 * Generates all the daos and beans.
+	 *
+	 * @throws TDBMException
+	 */
+	public function generateAllDaosAndBeans(): void
+	{
+		// 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->configuration->getSchemaAnalyzer()->detectJunctionTables(true);
+		$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);
+		});
+
+		$beanDescriptors = [];
+
+		foreach ($tableList as $table) {
+			$beanDescriptors[] = $this->generateDaoAndBean($table);
+		}
+
+
+		$this->generateFactory($tableList);
+
+		// Let's call the list of listeners
+		$this->eventDispatcher->onGenerate($this->configuration, $beanDescriptors);
+	}
+
+	/**
+	 * Generates in one method call the daos and the beans for one table.
+	 *
+	 * @param Table $table
+	 *
+	 * @return BeanDescriptor
+	 * @throws TDBMException
+	 */
+	private function generateDaoAndBean(Table $table) : BeanDescriptor
+	{
+		$tableName = $table->getName();
+		$daoName = $this->namingStrategy->getDaoClassName($tableName);
+		$beanName = $this->namingStrategy->getBeanClassName($tableName);
+		$baseBeanName = $this->namingStrategy->getBaseBeanClassName($tableName);
+		$baseDaoName = $this->namingStrategy->getBaseDaoClassName($tableName);
+
+		$beanDescriptor = new BeanDescriptor($table, $this->configuration->getSchemaAnalyzer(), $this->schema, $this->tdbmSchemaAnalyzer, $this->namingStrategy);
+		$this->generateBean($beanDescriptor, $beanName, $baseBeanName, $table);
+		$this->generateDao($beanDescriptor, $daoName, $baseDaoName, $beanName, $table);
+		return $beanDescriptor;
+	}
+
+	/**
+	 * 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
+	 *
+	 * @throws TDBMException
+	 */
+	public function generateBean(BeanDescriptor $beanDescriptor, $className, $baseClassName, Table $table)
+	{
+		$beannamespace = $this->configuration->getBeanNamespace();
+		$str = $beanDescriptor->generatePhpCode($beannamespace);
+
+		$possibleBaseFileName = $this->configuration->getPathFinder()->getPath($beannamespace.'\\Generated\\'.$baseClassName)->getPathname();
+
+		$this->dumpFile($possibleBaseFileName, $str);
+
+		$possibleFileName = $this->configuration->getPathFinder()->getPath($beannamespace.'\\'.$className)->getPathname();
+
+		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.
@@ -160,73 +160,73 @@ 
 }
 ";
 
-            $this->dumpFile($possibleFileName, $str);
-        }
-    }
-
-    /**
-     * 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
-     *
-     * @throws TDBMException
-     */
-    private function generateDao(BeanDescriptor $beanDescriptor, string $className, string $baseClassName, string $beanClassName, Table $table)
-    {
-        $daonamespace = $this->configuration->getDaoNamespace();
-        $beannamespace = $this->configuration->getBeanNamespace();
-        $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->dumpFile($possibleFileName, $str);
+		}
+	}
+
+	/**
+	 * 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
+	 *
+	 * @throws TDBMException
+	 */
+	private function generateDao(BeanDescriptor $beanDescriptor, string $className, string $baseClassName, string $beanClassName, Table $table)
+	{
+		$daonamespace = $this->configuration->getDaoNamespace();
+		$beannamespace = $this->configuration->getBeanNamespace();
+		$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.
@@ -302,10 +302,10 @@ 
     }
     ";
 
-        if (count($primaryKeyColumns) === 1) {
-            $primaryKeyColumn = $primaryKeyColumns[0];
-            $primaryKeyPhpType = self::dbalTypeToPhpType($table->getColumn($primaryKeyColumn)->getType());
-            $str .= "
+		if (count($primaryKeyColumns) === 1) {
+			$primaryKeyColumn = $primaryKeyColumns[0];
+			$primaryKeyPhpType = self::dbalTypeToPhpType($table->getColumn($primaryKeyColumn)->getType());
+			$str .= "
     /**
      * Get $beanClassWithoutNameSpace specified by its ID (its primary key)
      * If the primary key does not exist, an exception is thrown.
@@ -320,8 +320,8 @@ 
         return \$this->tdbmService->findObjectByPk('$tableName', ['$primaryKeyColumn' => \$id], [], \$lazyLoading);
     }
     ";
-        }
-        $str .= "
+		}
+		$str .= "
     /**
      * Deletes the $beanClassWithoutNameSpace passed in parameter.
      *
@@ -421,19 +421,19 @@ 
     }
 ";
 
-        $str .= $findByDaoCode;
-        $str .= '}
+		$str .= $findByDaoCode;
+		$str .= '}
 ';
 
-        $possibleBaseFileName = $this->configuration->getPathFinder()->getPath($daonamespace.'\\Generated\\'.$baseClassName)->getPathname();
+		$possibleBaseFileName = $this->configuration->getPathFinder()->getPath($daonamespace.'\\Generated\\'.$baseClassName)->getPathname();
 
-        $this->dumpFile($possibleBaseFileName, $str);
+		$this->dumpFile($possibleBaseFileName, $str);
 
-        $possibleFileName = $this->configuration->getPathFinder()->getPath($daonamespace.'\\'.$className)->getPathname();
+		$possibleFileName = $this->configuration->getPathFinder()->getPath($daonamespace.'\\'.$className)->getPathname();
 
-        // Now, let's generate the "editable" class
-        if (!file_exists($possibleFileName)) {
-            $str = "<?php
+		// Now, let's generate the "editable" class
+		if (!file_exists($possibleFileName)) {
+			$str = "<?php
 
 /*
  * This file has been automatically generated by TDBM.
@@ -451,24 +451,24 @@ 
 {
 }
 ";
-            $this->dumpFile($possibleFileName, $str);
-        }
-    }
+			$this->dumpFile($possibleFileName, $str);
+		}
+	}
 
-    /**
-     * Generates the factory bean.
-     *
-     * @param Table[] $tableList
-     * @throws TDBMException
-     */
-    private function generateFactory(array $tableList) : void
-    {
-        $daoNamespace = $this->configuration->getDaoNamespace();
-        $daoFactoryClassName = $this->namingStrategy->getDaoFactoryClassName();
+	/**
+	 * Generates the factory bean.
+	 *
+	 * @param Table[] $tableList
+	 * @throws TDBMException
+	 */
+	private function generateFactory(array $tableList) : void
+	{
+		$daoNamespace = $this->configuration->getDaoNamespace();
+		$daoFactoryClassName = $this->namingStrategy->getDaoFactoryClassName();
 
-        // For each table, let's write a property.
+		// For each table, let's write a property.
 
-        $str = "<?php
+		$str = "<?php
 
 /*
  * This file has been automatically generated by TDBM.
@@ -478,13 +478,13 @@ 
 namespace {$daoNamespace}\\Generated;
 
 ";
-        foreach ($tableList as $table) {
-            $tableName = $table->getName();
-            $daoClassName = $this->namingStrategy->getDaoClassName($tableName);
-            $str .= "use {$daoNamespace}\\".$daoClassName.";\n";
-        }
+		foreach ($tableList as $table) {
+			$tableName = $table->getName();
+			$daoClassName = $this->namingStrategy->getDaoClassName($tableName);
+			$str .= "use {$daoNamespace}\\".$daoClassName.";\n";
+		}
 
-        $str .= "
+		$str .= "
 /**
  * The $daoFactoryClassName provides an easy access to all DAOs generated by TDBM.
  *
@@ -493,12 +493,12 @@ 
 {
 ";
 
-        foreach ($tableList as $table) {
-            $tableName = $table->getName();
-            $daoClassName = $this->namingStrategy->getDaoClassName($tableName);
-            $daoInstanceName = self::toVariableName($daoClassName);
+		foreach ($tableList as $table) {
+			$tableName = $table->getName();
+			$daoClassName = $this->namingStrategy->getDaoClassName($tableName);
+			$daoInstanceName = self::toVariableName($daoClassName);
 
-            $str .= '    /**
+			$str .= '    /**
      * @var '.$daoClassName.'
      */
     private $'.$daoInstanceName.';
@@ -522,131 +522,131 @@ 
     {
         $this->'.$daoInstanceName.' = $'.$daoInstanceName.';
     }';
-        }
+		}
 
-        $str .= '
+		$str .= '
 }
 ';
 
-        $possibleFileName = $this->configuration->getPathFinder()->getPath($daoNamespace.'\\Generated\\'.$daoFactoryClassName)->getPathname();
-
-        $this->dumpFile($possibleFileName, $str);
-    }
-
-    /**
-     * 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(string $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."'.");
-            }
-        }
-    }
-
-    private function dumpFile(string $fileName, string $content) : void
-    {
-        $this->ensureDirectoryExist($fileName);
-        $fileSystem = new Filesystem();
-        $fileSystem->dumpFile($fileName, $content);
-        @chmod($fileName, 0664);
-    }
-
-    /**
-     * 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',
-            'json' => 'array',  // 'json' is supported from Doctrine DBAL 2.6 only.
-            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();
-    }
+		$possibleFileName = $this->configuration->getPathFinder()->getPath($daoNamespace.'\\Generated\\'.$daoFactoryClassName)->getPathname();
+
+		$this->dumpFile($possibleFileName, $str);
+	}
+
+	/**
+	 * 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(string $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."'.");
+			}
+		}
+	}
+
+	private function dumpFile(string $fileName, string $content) : void
+	{
+		$this->ensureDirectoryExist($fileName);
+		$fileSystem = new Filesystem();
+		$fileSystem->dumpFile($fileName, $content);
+		@chmod($fileName, 0664);
+	}
+
+	/**
+	 * 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',
+			'json' => 'array',  // 'json' is supported from Doctrine DBAL 2.6 only.
+			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();
+	}
 }

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

Indentation +54 added lines, -54 removed lines

@@ -5,58 +5,58 @@
 
 class PathFinder implements PathFinderInterface
 {
-    /**
-     * @var string
-     */
-    private $composerFile;
-
-    /**
-     * @var string
-     */
-    private $rootPath;
-
-    /**
-     * @var bool
-     */
-    private $useAutoloadDev;
-
-    /**
-     * @var ClassNameMapper
-     */
-    private $classNameMapper;
-
-    public function __construct(string $composerFile = null, string $rootPath = null, bool $useAutoloadDev = false)
-    {
-        $this->composerFile = $composerFile;
-        $this->useAutoloadDev = $useAutoloadDev;
-        if ($rootPath === null) {
-            $this->rootPath = dirname(__DIR__, 9);
-        } else {
-            $this->rootPath = $rootPath;
-        }
-    }
-
-    private function getClassNameMapper() : ClassNameMapper
-    {
-        if ($this->classNameMapper === null) {
-            $this->classNameMapper = ClassNameMapper::createFromComposerFile($this->composerFile, $this->rootPath, $this->useAutoloadDev);
-        }
-        return $this->classNameMapper;
-    }
-
-    /**
-     * Returns the path of a class file given the fully qualified class name.
-     *
-     * @param string $className
-     * @return \SplFileInfo
-     * @throws NoPathFoundException
-     */
-    public function getPath(string $className): \SplFileInfo
-    {
-        $paths = $this->getClassNameMapper()->getPossibleFileNames($className);
-        if (empty($paths)) {
-            throw NoPathFoundException::create($className);
-        }
-        return new \SplFileInfo($this->rootPath.'/'.$paths[0]);
-    }
+	/**
+	 * @var string
+	 */
+	private $composerFile;
+
+	/**
+	 * @var string
+	 */
+	private $rootPath;
+
+	/**
+	 * @var bool
+	 */
+	private $useAutoloadDev;
+
+	/**
+	 * @var ClassNameMapper
+	 */
+	private $classNameMapper;
+
+	public function __construct(string $composerFile = null, string $rootPath = null, bool $useAutoloadDev = false)
+	{
+		$this->composerFile = $composerFile;
+		$this->useAutoloadDev = $useAutoloadDev;
+		if ($rootPath === null) {
+			$this->rootPath = dirname(__DIR__, 9);
+		} else {
+			$this->rootPath = $rootPath;
+		}
+	}
+
+	private function getClassNameMapper() : ClassNameMapper
+	{
+		if ($this->classNameMapper === null) {
+			$this->classNameMapper = ClassNameMapper::createFromComposerFile($this->composerFile, $this->rootPath, $this->useAutoloadDev);
+		}
+		return $this->classNameMapper;
+	}
+
+	/**
+	 * Returns the path of a class file given the fully qualified class name.
+	 *
+	 * @param string $className
+	 * @return \SplFileInfo
+	 * @throws NoPathFoundException
+	 */
+	public function getPath(string $className): \SplFileInfo
+	{
+		$paths = $this->getClassNameMapper()->getPossibleFileNames($className);
+		if (empty($paths)) {
+			throw NoPathFoundException::create($className);
+		}
+		return new \SplFileInfo($this->rootPath.'/'.$paths[0]);
+	}
 }

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

Indentation +189 added lines, -189 removed lines

@@ -7,193 +7,193 @@
 
 class DefaultNamingStrategy implements NamingStrategyInterface
 {
-    private $beanPrefix = '';
-    private $beanSuffix = '';
-    private $baseBeanPrefix = 'Abstract';
-    private $baseBeanSuffix = '';
-    private $daoPrefix = '';
-    private $daoSuffix = 'Dao';
-    private $baseDaoPrefix = 'Abstract';
-    private $baseDaoSuffix = 'Dao';
-    private $exceptions = [];
-
-    /**
-     * Sets the string prefix to any bean class name.
-     *
-     * @param string $beanPrefix
-     */
-    public function setBeanPrefix(string $beanPrefix)
-    {
-        $this->beanPrefix = $beanPrefix;
-    }
-
-    /**
-     * Sets the string suffix to any bean class name.
-     *
-     * @param string $beanSuffix
-     */
-    public function setBeanSuffix(string $beanSuffix)
-    {
-        $this->beanSuffix = $beanSuffix;
-    }
-
-    /**
-     * Sets the string prefix to any base bean class name.
-     *
-     * @param string $baseBeanPrefix
-     */
-    public function setBaseBeanPrefix(string $baseBeanPrefix)
-    {
-        $this->baseBeanPrefix = $baseBeanPrefix;
-    }
-
-    /**
-     * Sets the string suffix to any base bean class name.
-     *
-     * @param string $baseBeanSuffix
-     */
-    public function setBaseBeanSuffix(string $baseBeanSuffix)
-    {
-        $this->baseBeanSuffix = $baseBeanSuffix;
-    }
-
-    /**
-     * Sets the string prefix to any DAO class name.
-     *
-     * @param string $daoPrefix
-     */
-    public function setDaoPrefix(string $daoPrefix)
-    {
-        $this->daoPrefix = $daoPrefix;
-    }
-
-    /**
-     * Sets the string suffix to any DAO class name.
-     *
-     * @param string $daoSuffix
-     */
-    public function setDaoSuffix(string $daoSuffix)
-    {
-        $this->daoSuffix = $daoSuffix;
-    }
-
-    /**
-     * Sets the string prefix to any base DAO class name.
-     *
-     * @param string $baseDaoPrefix
-     */
-    public function setBaseDaoPrefix(string $baseDaoPrefix)
-    {
-        $this->baseDaoPrefix = $baseDaoPrefix;
-    }
-
-    /**
-     * Sets the string suffix to any base DAO class name.
-     *
-     * @param string $baseDaoSuffix
-     */
-    public function setBaseDaoSuffix(string $baseDaoSuffix)
-    {
-        $this->baseDaoSuffix = $baseDaoSuffix;
-    }
-
-
-    /**
-     * Returns the bean class name from the table name (excluding the namespace).
-     *
-     * @param string $tableName
-     * @return string
-     */
-    public function getBeanClassName(string $tableName): string
-    {
-        return $this->beanPrefix.$this->toSingularCamelCase($tableName).$this->beanSuffix;
-    }
-
-    /**
-     * Returns the base bean class name from the table name (excluding the namespace).
-     *
-     * @param string $tableName
-     * @return string
-     */
-    public function getBaseBeanClassName(string $tableName): string
-    {
-        return $this->baseBeanPrefix.$this->toSingularCamelCase($tableName).$this->baseBeanSuffix;
-    }
-
-    /**
-     * Returns the name of the DAO class from the table name (excluding the namespace).
-     *
-     * @param string $tableName
-     * @return string
-     */
-    public function getDaoClassName(string $tableName): string
-    {
-        return $this->daoPrefix.$this->toSingularCamelCase($tableName).$this->daoSuffix;
-    }
-
-    /**
-     * Returns the name of the base DAO class from the table name (excluding the namespace).
-     *
-     * @param string $tableName
-     * @return string
-     */
-    public function getBaseDaoClassName(string $tableName): string
-    {
-        return $this->baseDaoPrefix.$this->toSingularCamelCase($tableName).$this->baseDaoSuffix;
-    }
-
-    /**
-     * Tries to put string to the singular form (if it is plural) and camel case form.
-     * We assume the table names are in english.
-     *
-     * @param $str string
-     *
-     * @return string
-     */
-    private function toSingularCamelCase(string $str): string
-    {
-        // Let's first check if this is not in the exceptions directory.
-        if (isset($this->exceptions[$str])) {
-            return $this->exceptions[$str];
-        }
-
-        $tokens = preg_split("/[_ ]+/", $str);
-        $tokens = array_map([Inflector::class, 'singularize'], $tokens);
-
-        $str = '';
-        foreach ($tokens as $token) {
-            $str .= ucfirst(Inflector::singularize($token));
-        }
-
-        return $str;
-    }
-
-    /**
-     * Returns the class name for the DAO factory.
-     *
-     * @return string
-     */
-    public function getDaoFactoryClassName(): string
-    {
-        return 'DaoFactory';
-    }
-
-    /**
-     * Sets exceptions in the naming of classes.
-     * The key is the name of the table, the value the "base" name of beans and DAOs.
-     *
-     * This is very useful for dealing with plural to singular translations in non english table names.
-     *
-     * For instance if you are dealing with a table containing horses in French ("chevaux" that has a singular "cheval"):
-     *
-     * [
-     *     "chevaux" => "Cheval"
-     * ]
-     *
-     * @param array<string,string> $exceptions
-     */
-    public function setExceptions(array $exceptions)
-    {
-        $this->exceptions = $exceptions;
-    }
+	private $beanPrefix = '';
+	private $beanSuffix = '';
+	private $baseBeanPrefix = 'Abstract';
+	private $baseBeanSuffix = '';
+	private $daoPrefix = '';
+	private $daoSuffix = 'Dao';
+	private $baseDaoPrefix = 'Abstract';
+	private $baseDaoSuffix = 'Dao';
+	private $exceptions = [];
+
+	/**
+	 * Sets the string prefix to any bean class name.
+	 *
+	 * @param string $beanPrefix
+	 */
+	public function setBeanPrefix(string $beanPrefix)
+	{
+		$this->beanPrefix = $beanPrefix;
+	}
+
+	/**
+	 * Sets the string suffix to any bean class name.
+	 *
+	 * @param string $beanSuffix
+	 */
+	public function setBeanSuffix(string $beanSuffix)
+	{
+		$this->beanSuffix = $beanSuffix;
+	}
+
+	/**
+	 * Sets the string prefix to any base bean class name.
+	 *
+	 * @param string $baseBeanPrefix
+	 */
+	public function setBaseBeanPrefix(string $baseBeanPrefix)
+	{
+		$this->baseBeanPrefix = $baseBeanPrefix;
+	}
+
+	/**
+	 * Sets the string suffix to any base bean class name.
+	 *
+	 * @param string $baseBeanSuffix
+	 */
+	public function setBaseBeanSuffix(string $baseBeanSuffix)
+	{
+		$this->baseBeanSuffix = $baseBeanSuffix;
+	}
+
+	/**
+	 * Sets the string prefix to any DAO class name.
+	 *
+	 * @param string $daoPrefix
+	 */
+	public function setDaoPrefix(string $daoPrefix)
+	{
+		$this->daoPrefix = $daoPrefix;
+	}
+
+	/**
+	 * Sets the string suffix to any DAO class name.
+	 *
+	 * @param string $daoSuffix
+	 */
+	public function setDaoSuffix(string $daoSuffix)
+	{
+		$this->daoSuffix = $daoSuffix;
+	}
+
+	/**
+	 * Sets the string prefix to any base DAO class name.
+	 *
+	 * @param string $baseDaoPrefix
+	 */
+	public function setBaseDaoPrefix(string $baseDaoPrefix)
+	{
+		$this->baseDaoPrefix = $baseDaoPrefix;
+	}
+
+	/**
+	 * Sets the string suffix to any base DAO class name.
+	 *
+	 * @param string $baseDaoSuffix
+	 */
+	public function setBaseDaoSuffix(string $baseDaoSuffix)
+	{
+		$this->baseDaoSuffix = $baseDaoSuffix;
+	}
+
+
+	/**
+	 * Returns the bean class name from the table name (excluding the namespace).
+	 *
+	 * @param string $tableName
+	 * @return string
+	 */
+	public function getBeanClassName(string $tableName): string
+	{
+		return $this->beanPrefix.$this->toSingularCamelCase($tableName).$this->beanSuffix;
+	}
+
+	/**
+	 * Returns the base bean class name from the table name (excluding the namespace).
+	 *
+	 * @param string $tableName
+	 * @return string
+	 */
+	public function getBaseBeanClassName(string $tableName): string
+	{
+		return $this->baseBeanPrefix.$this->toSingularCamelCase($tableName).$this->baseBeanSuffix;
+	}
+
+	/**
+	 * Returns the name of the DAO class from the table name (excluding the namespace).
+	 *
+	 * @param string $tableName
+	 * @return string
+	 */
+	public function getDaoClassName(string $tableName): string
+	{
+		return $this->daoPrefix.$this->toSingularCamelCase($tableName).$this->daoSuffix;
+	}
+
+	/**
+	 * Returns the name of the base DAO class from the table name (excluding the namespace).
+	 *
+	 * @param string $tableName
+	 * @return string
+	 */
+	public function getBaseDaoClassName(string $tableName): string
+	{
+		return $this->baseDaoPrefix.$this->toSingularCamelCase($tableName).$this->baseDaoSuffix;
+	}
+
+	/**
+	 * Tries to put string to the singular form (if it is plural) and camel case form.
+	 * We assume the table names are in english.
+	 *
+	 * @param $str string
+	 *
+	 * @return string
+	 */
+	private function toSingularCamelCase(string $str): string
+	{
+		// Let's first check if this is not in the exceptions directory.
+		if (isset($this->exceptions[$str])) {
+			return $this->exceptions[$str];
+		}
+
+		$tokens = preg_split("/[_ ]+/", $str);
+		$tokens = array_map([Inflector::class, 'singularize'], $tokens);
+
+		$str = '';
+		foreach ($tokens as $token) {
+			$str .= ucfirst(Inflector::singularize($token));
+		}
+
+		return $str;
+	}
+
+	/**
+	 * Returns the class name for the DAO factory.
+	 *
+	 * @return string
+	 */
+	public function getDaoFactoryClassName(): string
+	{
+		return 'DaoFactory';
+	}
+
+	/**
+	 * Sets exceptions in the naming of classes.
+	 * The key is the name of the table, the value the "base" name of beans and DAOs.
+	 *
+	 * This is very useful for dealing with plural to singular translations in non english table names.
+	 *
+	 * For instance if you are dealing with a table containing horses in French ("chevaux" that has a singular "cheval"):
+	 *
+	 * [
+	 *     "chevaux" => "Cheval"
+	 * ]
+	 *
+	 * @param array<string,string> $exceptions
+	 */
+	public function setExceptions(array $exceptions)
+	{
+		$this->exceptions = $exceptions;
+	}
 }

src/Mouf/Database/TDBM/QueryFactory/FindObjectsFromSqlQueryFactory.php

Indentation +164 added lines, -164 removed lines

@@ -15,168 +15,168 @@
  */
 class FindObjectsFromSqlQueryFactory extends AbstractQueryFactory
 {
-    private $mainTable;
-    private $from;
-    private $filterString;
-    private $cache;
-    private $cachePrefix;
-
-    public function __construct(string $mainTable, string $from, $filterString, $orderBy, TDBMService $tdbmService, Schema $schema, OrderByAnalyzer $orderByAnalyzer, SchemaAnalyzer $schemaAnalyzer, Cache $cache, string $cachePrefix)
-    {
-        parent::__construct($tdbmService, $schema, $orderByAnalyzer, $orderBy);
-        $this->mainTable = $mainTable;
-        $this->from = $from;
-        $this->filterString = $filterString;
-        $this->schemaAnalyzer = $schemaAnalyzer;
-        $this->cache = $cache;
-        $this->cachePrefix = $cachePrefix;
-    }
-
-    protected function compute()
-    {
-        $connection = $this->tdbmService->getConnection();
-
-        $columnsList = null;
-
-        $allFetchedTables = $this->tdbmService->_getRelatedTablesByInheritance($this->mainTable);
-
-        list($columnDescList, $columnsList, $orderString) = $this->getColumnsList($this->mainTable, [], $this->orderBy);
-
-        $sql = 'SELECT DISTINCT '.implode(', ', $columnsList).' FROM '.$this->from;
-
-        // Let's compute the COUNT.
-        $pkColumnNames = $this->schema->getTable($this->mainTable)->getPrimaryKeyColumns();
-        $pkColumnNames = array_map(function ($pkColumn) {
-            return $this->tdbmService->getConnection()->quoteIdentifier($this->mainTable).'.'.$this->tdbmService->getConnection()->quoteIdentifier($pkColumn);
-        }, $pkColumnNames);
-
-        $countSql = 'SELECT COUNT(DISTINCT '.implode(', ', $pkColumnNames).') FROM '.$this->from;
-
-        // Add joins on inherited tables if necessary
-        if (count($allFetchedTables) > 1) {
-            $joinSql = '';
-            $parentFks = $this->getParentRelationshipForeignKeys($this->mainTable);
-            foreach ($parentFks as $fk) {
-                $joinSql .= sprintf(' JOIN %s ON (%s.%s = %s.%s)',
-                    $connection->quoteIdentifier($fk->getForeignTableName()),
-                    $connection->quoteIdentifier($fk->getLocalTableName()),
-                    $connection->quoteIdentifier($fk->getLocalColumns()[0]),
-                    $connection->quoteIdentifier($fk->getForeignTableName()),
-                    $connection->quoteIdentifier($fk->getForeignColumns()[0])
-                );
-            }
-
-            $childrenFks = $this->getChildrenRelationshipForeignKeys($this->mainTable);
-            foreach ($childrenFks as $fk) {
-                $joinSql .= sprintf(' LEFT JOIN %s ON (%s.%s = %s.%s)',
-                    $connection->quoteIdentifier($fk->getLocalTableName()),
-                    $connection->quoteIdentifier($fk->getForeignTableName()),
-                    $connection->quoteIdentifier($fk->getForeignColumns()[0]),
-                    $connection->quoteIdentifier($fk->getLocalTableName()),
-                    $connection->quoteIdentifier($fk->getLocalColumns()[0])
-                );
-            }
-
-            $sql .= $joinSql;
-        }
-
-        if (!empty($this->filterString)) {
-            $sql .= ' WHERE '.$this->filterString;
-            $countSql .= ' WHERE '.$this->filterString;
-        }
-
-        if (!empty($orderString)) {
-            $sql .= ' ORDER BY '.$orderString;
-        }
-
-        if (stripos($countSql, 'GROUP BY') !== false) {
-            throw new TDBMException('Unsupported use of GROUP BY in SQL request.');
-        }
-
-        $this->magicSql = $sql;
-        $this->magicSqlCount = $countSql;
-        $this->columnDescList = $columnDescList;
-    }
-
-    /**
-     * @param string $tableName
-     *
-     * @return ForeignKeyConstraint[]
-     */
-    private function getParentRelationshipForeignKeys($tableName)
-    {
-        return $this->fromCache($this->cachePrefix.'_parentrelationshipfks_'.$tableName, function () use ($tableName) {
-            return $this->getParentRelationshipForeignKeysWithoutCache($tableName);
-        });
-    }
-
-    /**
-     * @param string $tableName
-     *
-     * @return ForeignKeyConstraint[]
-     */
-    private function getParentRelationshipForeignKeysWithoutCache($tableName)
-    {
-        $parentFks = [];
-        $currentTable = $tableName;
-        while ($currentFk = $this->schemaAnalyzer->getParentRelationship($currentTable)) {
-            $currentTable = $currentFk->getForeignTableName();
-            $parentFks[] = $currentFk;
-        }
-
-        return $parentFks;
-    }
-
-    /**
-     * @param string $tableName
-     *
-     * @return ForeignKeyConstraint[]
-     */
-    private function getChildrenRelationshipForeignKeys(string $tableName) : array
-    {
-        return $this->fromCache($this->cachePrefix.'_childrenrelationshipfks_'.$tableName, function () use ($tableName) {
-            return $this->getChildrenRelationshipForeignKeysWithoutCache($tableName);
-        });
-    }
-
-    /**
-     * @param string $tableName
-     *
-     * @return ForeignKeyConstraint[]
-     */
-    private function getChildrenRelationshipForeignKeysWithoutCache(string $tableName) : array
-    {
-        $children = $this->schemaAnalyzer->getChildrenRelationships($tableName);
-
-        if (!empty($children)) {
-            $fksTables = array_map(function (ForeignKeyConstraint $fk) {
-                return $this->getChildrenRelationshipForeignKeys($fk->getLocalTableName());
-            }, $children);
-
-            $fks = array_merge($children, call_user_func_array('array_merge', $fksTables));
-
-            return $fks;
-        } else {
-            return [];
-        }
-    }
-
-    /**
-     * Returns an item from cache or computes it using $closure and puts it in cache.
-     *
-     * @param string   $key
-     * @param callable $closure
-     *
-     * @return mixed
-     */
-    protected function fromCache(string $key, callable $closure)
-    {
-        $item = $this->cache->fetch($key);
-        if ($item === false) {
-            $item = $closure();
-            $this->cache->save($key, $item);
-        }
-
-        return $item;
-    }
+	private $mainTable;
+	private $from;
+	private $filterString;
+	private $cache;
+	private $cachePrefix;
+
+	public function __construct(string $mainTable, string $from, $filterString, $orderBy, TDBMService $tdbmService, Schema $schema, OrderByAnalyzer $orderByAnalyzer, SchemaAnalyzer $schemaAnalyzer, Cache $cache, string $cachePrefix)
+	{
+		parent::__construct($tdbmService, $schema, $orderByAnalyzer, $orderBy);
+		$this->mainTable = $mainTable;
+		$this->from = $from;
+		$this->filterString = $filterString;
+		$this->schemaAnalyzer = $schemaAnalyzer;
+		$this->cache = $cache;
+		$this->cachePrefix = $cachePrefix;
+	}
+
+	protected function compute()
+	{
+		$connection = $this->tdbmService->getConnection();
+
+		$columnsList = null;
+
+		$allFetchedTables = $this->tdbmService->_getRelatedTablesByInheritance($this->mainTable);
+
+		list($columnDescList, $columnsList, $orderString) = $this->getColumnsList($this->mainTable, [], $this->orderBy);
+
+		$sql = 'SELECT DISTINCT '.implode(', ', $columnsList).' FROM '.$this->from;
+
+		// Let's compute the COUNT.
+		$pkColumnNames = $this->schema->getTable($this->mainTable)->getPrimaryKeyColumns();
+		$pkColumnNames = array_map(function ($pkColumn) {
+			return $this->tdbmService->getConnection()->quoteIdentifier($this->mainTable).'.'.$this->tdbmService->getConnection()->quoteIdentifier($pkColumn);
+		}, $pkColumnNames);
+
+		$countSql = 'SELECT COUNT(DISTINCT '.implode(', ', $pkColumnNames).') FROM '.$this->from;
+
+		// Add joins on inherited tables if necessary
+		if (count($allFetchedTables) > 1) {
+			$joinSql = '';
+			$parentFks = $this->getParentRelationshipForeignKeys($this->mainTable);
+			foreach ($parentFks as $fk) {
+				$joinSql .= sprintf(' JOIN %s ON (%s.%s = %s.%s)',
+					$connection->quoteIdentifier($fk->getForeignTableName()),
+					$connection->quoteIdentifier($fk->getLocalTableName()),
+					$connection->quoteIdentifier($fk->getLocalColumns()[0]),
+					$connection->quoteIdentifier($fk->getForeignTableName()),
+					$connection->quoteIdentifier($fk->getForeignColumns()[0])
+				);
+			}
+
+			$childrenFks = $this->getChildrenRelationshipForeignKeys($this->mainTable);
+			foreach ($childrenFks as $fk) {
+				$joinSql .= sprintf(' LEFT JOIN %s ON (%s.%s = %s.%s)',
+					$connection->quoteIdentifier($fk->getLocalTableName()),
+					$connection->quoteIdentifier($fk->getForeignTableName()),
+					$connection->quoteIdentifier($fk->getForeignColumns()[0]),
+					$connection->quoteIdentifier($fk->getLocalTableName()),
+					$connection->quoteIdentifier($fk->getLocalColumns()[0])
+				);
+			}
+
+			$sql .= $joinSql;
+		}
+
+		if (!empty($this->filterString)) {
+			$sql .= ' WHERE '.$this->filterString;
+			$countSql .= ' WHERE '.$this->filterString;
+		}
+
+		if (!empty($orderString)) {
+			$sql .= ' ORDER BY '.$orderString;
+		}
+
+		if (stripos($countSql, 'GROUP BY') !== false) {
+			throw new TDBMException('Unsupported use of GROUP BY in SQL request.');
+		}
+
+		$this->magicSql = $sql;
+		$this->magicSqlCount = $countSql;
+		$this->columnDescList = $columnDescList;
+	}
+
+	/**
+	 * @param string $tableName
+	 *
+	 * @return ForeignKeyConstraint[]
+	 */
+	private function getParentRelationshipForeignKeys($tableName)
+	{
+		return $this->fromCache($this->cachePrefix.'_parentrelationshipfks_'.$tableName, function () use ($tableName) {
+			return $this->getParentRelationshipForeignKeysWithoutCache($tableName);
+		});
+	}
+
+	/**
+	 * @param string $tableName
+	 *
+	 * @return ForeignKeyConstraint[]
+	 */
+	private function getParentRelationshipForeignKeysWithoutCache($tableName)
+	{
+		$parentFks = [];
+		$currentTable = $tableName;
+		while ($currentFk = $this->schemaAnalyzer->getParentRelationship($currentTable)) {
+			$currentTable = $currentFk->getForeignTableName();
+			$parentFks[] = $currentFk;
+		}
+
+		return $parentFks;
+	}
+
+	/**
+	 * @param string $tableName
+	 *
+	 * @return ForeignKeyConstraint[]
+	 */
+	private function getChildrenRelationshipForeignKeys(string $tableName) : array
+	{
+		return $this->fromCache($this->cachePrefix.'_childrenrelationshipfks_'.$tableName, function () use ($tableName) {
+			return $this->getChildrenRelationshipForeignKeysWithoutCache($tableName);
+		});
+	}
+
+	/**
+	 * @param string $tableName
+	 *
+	 * @return ForeignKeyConstraint[]
+	 */
+	private function getChildrenRelationshipForeignKeysWithoutCache(string $tableName) : array
+	{
+		$children = $this->schemaAnalyzer->getChildrenRelationships($tableName);
+
+		if (!empty($children)) {
+			$fksTables = array_map(function (ForeignKeyConstraint $fk) {
+				return $this->getChildrenRelationshipForeignKeys($fk->getLocalTableName());
+			}, $children);
+
+			$fks = array_merge($children, call_user_func_array('array_merge', $fksTables));
+
+			return $fks;
+		} else {
+			return [];
+		}
+	}
+
+	/**
+	 * Returns an item from cache or computes it using $closure and puts it in cache.
+	 *
+	 * @param string   $key
+	 * @param callable $closure
+	 *
+	 * @return mixed
+	 */
+	protected function fromCache(string $key, callable $closure)
+	{
+		$item = $this->cache->fetch($key);
+		if ($item === false) {
+			$item = $closure();
+			$this->cache->save($key, $item);
+		}
+
+		return $item;
+	}
 }

src/Mouf/Database/TDBM/InnerResultIterator.php

Indentation +267 added lines, -267 removed lines

@@ -29,271 +29,271 @@
  */
 class InnerResultIterator implements \Iterator, \Countable, \ArrayAccess
 {
-    /**
-     * @var Statement
-     */
-    protected $statement;
-
-    protected $fetchStarted = false;
-    private $objectStorage;
-    private $className;
-
-    private $tdbmService;
-    private $magicSql;
-    private $parameters;
-    private $limit;
-    private $offset;
-    private $columnDescriptors;
-    private $magicQuery;
-
-    /**
-     * The key of the current retrieved object.
-     *
-     * @var int
-     */
-    protected $key = -1;
-
-    protected $current = null;
-
-    private $databasePlatform;
-
-    /**
-     * @var LoggerInterface
-     */
-    private $logger;
-
-    public function __construct($magicSql, array $parameters, $limit, $offset, array $columnDescriptors, $objectStorage, $className, TDBMService $tdbmService, MagicQuery $magicQuery, LoggerInterface $logger)
-    {
-        $this->magicSql = $magicSql;
-        $this->objectStorage = $objectStorage;
-        $this->className = $className;
-        $this->tdbmService = $tdbmService;
-        $this->parameters = $parameters;
-        $this->limit = $limit;
-        $this->offset = $offset;
-        $this->columnDescriptors = $columnDescriptors;
-        $this->magicQuery = $magicQuery;
-        $this->databasePlatform = $this->tdbmService->getConnection()->getDatabasePlatform();
-        $this->logger = $logger;
-    }
-
-    protected function executeQuery()
-    {
-        $sql = $this->magicQuery->build($this->magicSql, $this->parameters);
-        $sql = $this->tdbmService->getConnection()->getDatabasePlatform()->modifyLimitQuery($sql, $this->limit, $this->offset);
-
-        $this->logger->debug('Running SQL request: '.$sql);
-
-        $this->statement = $this->tdbmService->getConnection()->executeQuery($sql, $this->parameters);
-
-        $this->fetchStarted = true;
-    }
-
-    /**
-     * Counts found records (this is the number of records fetched, taking into account the LIMIT and OFFSET settings).
-     *
-     * @return int
-     */
-    public function count()
-    {
-        if (!$this->fetchStarted) {
-            $this->executeQuery();
-        }
-
-        return $this->statement->rowCount();
-    }
-
-    /**
-     * Fetches record at current cursor.
-     *
-     * @return AbstractTDBMObject|null
-     */
-    public function current()
-    {
-        return $this->current;
-    }
-
-    /**
-     * Returns the current result's key.
-     *
-     * @return int
-     */
-    public function key()
-    {
-        return $this->key;
-    }
-
-    /**
-     * Advances the cursor to the next result.
-     * Casts the database result into one (or several) beans.
-     */
-    public function next()
-    {
-        $row = $this->statement->fetch(\PDO::FETCH_LAZY);
-        if ($row) {
-
-            // array<tablegroup, array<table, array<column, value>>>
-            $beansData = [];
-            foreach ($row as $key => $value) {
-                if (!isset($this->columnDescriptors[$key])) {
-                    continue;
-                }
-
-                $columnDescriptor = $this->columnDescriptors[$key];
-
-                if ($columnDescriptor['tableGroup'] === null) {
-                    // A column can have no tableGroup (if it comes from an ORDER BY expression)
-                    continue;
-                }
-
-                // Let's cast the value according to its type
-                $value = $columnDescriptor['type']->convertToPHPValue($value, $this->databasePlatform);
-
-                $beansData[$columnDescriptor['tableGroup']][$columnDescriptor['table']][$columnDescriptor['column']] = $value;
-            }
-
-            $reflectionClassCache = [];
-            $firstBean = true;
-            foreach ($beansData as $beanData) {
-
-                // Let's find the bean class name associated to the bean.
-
-                list($actualClassName, $mainBeanTableName, $tablesUsed) = $this->tdbmService->_getClassNameFromBeanData($beanData);
-
-                if ($this->className !== null) {
-                    $actualClassName = $this->className;
-                }
-
-                // Let's filter out the beanData that is not used (because it belongs to a part of the hierarchy that is not fetched:
-                foreach ($beanData as $tableName => $descriptors) {
-                    if (!in_array($tableName, $tablesUsed)) {
-                        unset($beanData[$tableName]);
-                    }
-                }
-
-                // Must we create the bean? Let's see in the cache if we have a mapping DbRow?
-                // Let's get the first object mapping a row:
-                // We do this loop only for the first table
-
-                $primaryKeys = $this->tdbmService->_getPrimaryKeysFromObjectData($mainBeanTableName, $beanData[$mainBeanTableName]);
-                $hash = $this->tdbmService->getObjectHash($primaryKeys);
-
-                if ($this->objectStorage->has($mainBeanTableName, $hash)) {
-                    $dbRow = $this->objectStorage->get($mainBeanTableName, $hash);
-                    $bean = $dbRow->getTDBMObject();
-                } else {
-                    // Let's construct the bean
-                    if (!isset($reflectionClassCache[$actualClassName])) {
-                        $reflectionClassCache[$actualClassName] = new \ReflectionClass($actualClassName);
-                    }
-                    // Let's bypass the constructor when creating the bean!
-                    $bean = $reflectionClassCache[$actualClassName]->newInstanceWithoutConstructor();
-                    $bean->_constructFromData($beanData, $this->tdbmService);
-                }
-
-                // The first bean is the one containing the main table.
-                if ($firstBean) {
-                    $firstBean = false;
-                    $this->current = $bean;
-                }
-            }
-
-            ++$this->key;
-        } else {
-            $this->current = null;
-        }
-    }
-
-    /**
-     * Moves the cursor to the beginning of the result set.
-     */
-    public function rewind()
-    {
-        $this->executeQuery();
-        $this->key = -1;
-        $this->next();
-    }
-    /**
-     * Checks if the cursor is reading a valid result.
-     *
-     * @return bool
-     */
-    public function valid()
-    {
-        return $this->current !== null;
-    }
-
-    /**
-     * Whether a offset exists.
-     *
-     * @link http://php.net/manual/en/arrayaccess.offsetexists.php
-     *
-     * @param mixed $offset <p>
-     *                      An offset to check for.
-     *                      </p>
-     *
-     * @return bool true on success or false on failure.
-     *              </p>
-     *              <p>
-     *              The return value will be casted to boolean if non-boolean was returned
-     *
-     * @since 5.0.0
-     */
-    public function offsetExists($offset)
-    {
-        throw new TDBMInvalidOperationException('You cannot access this result set via index because it was fetched in CURSOR mode. Use ARRAY_MODE instead.');
-    }
-
-    /**
-     * Offset to retrieve.
-     *
-     * @link http://php.net/manual/en/arrayaccess.offsetget.php
-     *
-     * @param mixed $offset <p>
-     *                      The offset to retrieve.
-     *                      </p>
-     *
-     * @return mixed Can return all value types
-     *
-     * @since 5.0.0
-     */
-    public function offsetGet($offset)
-    {
-        throw new TDBMInvalidOperationException('You cannot access this result set via index because it was fetched in CURSOR mode. Use ARRAY_MODE instead.');
-    }
-
-    /**
-     * Offset to set.
-     *
-     * @link http://php.net/manual/en/arrayaccess.offsetset.php
-     *
-     * @param mixed $offset <p>
-     *                      The offset to assign the value to.
-     *                      </p>
-     * @param mixed $value  <p>
-     *                      The value to set.
-     *                      </p>
-     *
-     * @since 5.0.0
-     */
-    public function offsetSet($offset, $value)
-    {
-        throw new TDBMInvalidOperationException('You can set values in a TDBM result set.');
-    }
-
-    /**
-     * Offset to unset.
-     *
-     * @link http://php.net/manual/en/arrayaccess.offsetunset.php
-     *
-     * @param mixed $offset <p>
-     *                      The offset to unset.
-     *                      </p>
-     *
-     * @since 5.0.0
-     */
-    public function offsetUnset($offset)
-    {
-        throw new TDBMInvalidOperationException('You can unset values in a TDBM result set.');
-    }
+	/**
+	 * @var Statement
+	 */
+	protected $statement;
+
+	protected $fetchStarted = false;
+	private $objectStorage;
+	private $className;
+
+	private $tdbmService;
+	private $magicSql;
+	private $parameters;
+	private $limit;
+	private $offset;
+	private $columnDescriptors;
+	private $magicQuery;
+
+	/**
+	 * The key of the current retrieved object.
+	 *
+	 * @var int
+	 */
+	protected $key = -1;
+
+	protected $current = null;
+
+	private $databasePlatform;
+
+	/**
+	 * @var LoggerInterface
+	 */
+	private $logger;
+
+	public function __construct($magicSql, array $parameters, $limit, $offset, array $columnDescriptors, $objectStorage, $className, TDBMService $tdbmService, MagicQuery $magicQuery, LoggerInterface $logger)
+	{
+		$this->magicSql = $magicSql;
+		$this->objectStorage = $objectStorage;
+		$this->className = $className;
+		$this->tdbmService = $tdbmService;
+		$this->parameters = $parameters;
+		$this->limit = $limit;
+		$this->offset = $offset;
+		$this->columnDescriptors = $columnDescriptors;
+		$this->magicQuery = $magicQuery;
+		$this->databasePlatform = $this->tdbmService->getConnection()->getDatabasePlatform();
+		$this->logger = $logger;
+	}
+
+	protected function executeQuery()
+	{
+		$sql = $this->magicQuery->build($this->magicSql, $this->parameters);
+		$sql = $this->tdbmService->getConnection()->getDatabasePlatform()->modifyLimitQuery($sql, $this->limit, $this->offset);
+
+		$this->logger->debug('Running SQL request: '.$sql);
+
+		$this->statement = $this->tdbmService->getConnection()->executeQuery($sql, $this->parameters);
+
+		$this->fetchStarted = true;
+	}
+
+	/**
+	 * Counts found records (this is the number of records fetched, taking into account the LIMIT and OFFSET settings).
+	 *
+	 * @return int
+	 */
+	public function count()
+	{
+		if (!$this->fetchStarted) {
+			$this->executeQuery();
+		}
+
+		return $this->statement->rowCount();
+	}
+
+	/**
+	 * Fetches record at current cursor.
+	 *
+	 * @return AbstractTDBMObject|null
+	 */
+	public function current()
+	{
+		return $this->current;
+	}
+
+	/**
+	 * Returns the current result's key.
+	 *
+	 * @return int
+	 */
+	public function key()
+	{
+		return $this->key;
+	}
+
+	/**
+	 * Advances the cursor to the next result.
+	 * Casts the database result into one (or several) beans.
+	 */
+	public function next()
+	{
+		$row = $this->statement->fetch(\PDO::FETCH_LAZY);
+		if ($row) {
+
+			// array<tablegroup, array<table, array<column, value>>>
+			$beansData = [];
+			foreach ($row as $key => $value) {
+				if (!isset($this->columnDescriptors[$key])) {
+					continue;
+				}
+
+				$columnDescriptor = $this->columnDescriptors[$key];
+
+				if ($columnDescriptor['tableGroup'] === null) {
+					// A column can have no tableGroup (if it comes from an ORDER BY expression)
+					continue;
+				}
+
+				// Let's cast the value according to its type
+				$value = $columnDescriptor['type']->convertToPHPValue($value, $this->databasePlatform);
+
+				$beansData[$columnDescriptor['tableGroup']][$columnDescriptor['table']][$columnDescriptor['column']] = $value;
+			}
+
+			$reflectionClassCache = [];
+			$firstBean = true;
+			foreach ($beansData as $beanData) {
+
+				// Let's find the bean class name associated to the bean.
+
+				list($actualClassName, $mainBeanTableName, $tablesUsed) = $this->tdbmService->_getClassNameFromBeanData($beanData);
+
+				if ($this->className !== null) {
+					$actualClassName = $this->className;
+				}
+
+				// Let's filter out the beanData that is not used (because it belongs to a part of the hierarchy that is not fetched:
+				foreach ($beanData as $tableName => $descriptors) {
+					if (!in_array($tableName, $tablesUsed)) {
+						unset($beanData[$tableName]);
+					}
+				}
+
+				// Must we create the bean? Let's see in the cache if we have a mapping DbRow?
+				// Let's get the first object mapping a row:
+				// We do this loop only for the first table
+
+				$primaryKeys = $this->tdbmService->_getPrimaryKeysFromObjectData($mainBeanTableName, $beanData[$mainBeanTableName]);
+				$hash = $this->tdbmService->getObjectHash($primaryKeys);
+
+				if ($this->objectStorage->has($mainBeanTableName, $hash)) {
+					$dbRow = $this->objectStorage->get($mainBeanTableName, $hash);
+					$bean = $dbRow->getTDBMObject();
+				} else {
+					// Let's construct the bean
+					if (!isset($reflectionClassCache[$actualClassName])) {
+						$reflectionClassCache[$actualClassName] = new \ReflectionClass($actualClassName);
+					}
+					// Let's bypass the constructor when creating the bean!
+					$bean = $reflectionClassCache[$actualClassName]->newInstanceWithoutConstructor();
+					$bean->_constructFromData($beanData, $this->tdbmService);
+				}
+
+				// The first bean is the one containing the main table.
+				if ($firstBean) {
+					$firstBean = false;
+					$this->current = $bean;
+				}
+			}
+
+			++$this->key;
+		} else {
+			$this->current = null;
+		}
+	}
+
+	/**
+	 * Moves the cursor to the beginning of the result set.
+	 */
+	public function rewind()
+	{
+		$this->executeQuery();
+		$this->key = -1;
+		$this->next();
+	}
+	/**
+	 * Checks if the cursor is reading a valid result.
+	 *
+	 * @return bool
+	 */
+	public function valid()
+	{
+		return $this->current !== null;
+	}
+
+	/**
+	 * Whether a offset exists.
+	 *
+	 * @link http://php.net/manual/en/arrayaccess.offsetexists.php
+	 *
+	 * @param mixed $offset <p>
+	 *                      An offset to check for.
+	 *                      </p>
+	 *
+	 * @return bool true on success or false on failure.
+	 *              </p>
+	 *              <p>
+	 *              The return value will be casted to boolean if non-boolean was returned
+	 *
+	 * @since 5.0.0
+	 */
+	public function offsetExists($offset)
+	{
+		throw new TDBMInvalidOperationException('You cannot access this result set via index because it was fetched in CURSOR mode. Use ARRAY_MODE instead.');
+	}
+
+	/**
+	 * Offset to retrieve.
+	 *
+	 * @link http://php.net/manual/en/arrayaccess.offsetget.php
+	 *
+	 * @param mixed $offset <p>
+	 *                      The offset to retrieve.
+	 *                      </p>
+	 *
+	 * @return mixed Can return all value types
+	 *
+	 * @since 5.0.0
+	 */
+	public function offsetGet($offset)
+	{
+		throw new TDBMInvalidOperationException('You cannot access this result set via index because it was fetched in CURSOR mode. Use ARRAY_MODE instead.');
+	}
+
+	/**
+	 * Offset to set.
+	 *
+	 * @link http://php.net/manual/en/arrayaccess.offsetset.php
+	 *
+	 * @param mixed $offset <p>
+	 *                      The offset to assign the value to.
+	 *                      </p>
+	 * @param mixed $value  <p>
+	 *                      The value to set.
+	 *                      </p>
+	 *
+	 * @since 5.0.0
+	 */
+	public function offsetSet($offset, $value)
+	{
+		throw new TDBMInvalidOperationException('You can set values in a TDBM result set.');
+	}
+
+	/**
+	 * Offset to unset.
+	 *
+	 * @link http://php.net/manual/en/arrayaccess.offsetunset.php
+	 *
+	 * @param mixed $offset <p>
+	 *                      The offset to unset.
+	 *                      </p>
+	 *
+	 * @since 5.0.0
+	 */
+	public function offsetUnset($offset)
+	{
+		throw new TDBMInvalidOperationException('You can unset values in a TDBM result set.');
+	}
 }

src/Mouf/Database/TDBM/QueryFactory/AbstractQueryFactory.php

Indentation +210 added lines, -210 removed lines

@@ -10,214 +10,214 @@
 
 abstract class AbstractQueryFactory implements QueryFactory
 {
-    /**
-     * @var TDBMService
-     */
-    protected $tdbmService;
-
-    /**
-     * @var Schema
-     */
-    protected $schema;
-
-    /**
-     * @var OrderByAnalyzer
-     */
-    protected $orderByAnalyzer;
-
-    /**
-     * @var string|UncheckedOrderBy|null
-     */
-    protected $orderBy;
-
-    protected $magicSql;
-    protected $magicSqlCount;
-    protected $columnDescList;
-
-    /**
-     * @param TDBMService $tdbmService
-     */
-    public function __construct(TDBMService $tdbmService, Schema $schema, OrderByAnalyzer $orderByAnalyzer, $orderBy)
-    {
-        $this->tdbmService = $tdbmService;
-        $this->schema = $schema;
-        $this->orderByAnalyzer = $orderByAnalyzer;
-        $this->orderBy = $orderBy;
-    }
-
-    /**
-     * Returns the column list that must be fetched for the SQL request.
-     *
-     * Note: MySQL dictates that ORDER BYed columns should appear in the SELECT clause.
-     *
-     * @param string                       $mainTable
-     * @param array                        $additionalTablesFetch
-     * @param string|UncheckedOrderBy|null $orderBy
-     *
-     * @return array
-     *
-     * @throws \Doctrine\DBAL\Schema\SchemaException
-     */
-    protected function getColumnsList(string $mainTable, array $additionalTablesFetch = array(), $orderBy = null)
-    {
-        // From the table name and the additional tables we want to fetch, let's build a list of all tables
-        // that must be part of the select columns.
-
-        $connection = $this->tdbmService->getConnection();
-
-        $tableGroups = [];
-        $allFetchedTables = $this->tdbmService->_getRelatedTablesByInheritance($mainTable);
-        $tableGroupName = $this->getTableGroupName($allFetchedTables);
-        foreach ($allFetchedTables as $table) {
-            $tableGroups[$table] = $tableGroupName;
-        }
-
-        $columnsList = [];
-        $columnDescList = [];
-        $sortColumn = 0;
-        $reconstructedOrderBy = null;
-
-        if (is_string($orderBy)) {
-            $orderBy = trim($orderBy);
-            if ($orderBy === '') {
-                $orderBy = null;
-            }
-        }
-
-        // Now, let's deal with "order by columns"
-        if ($orderBy !== null) {
-            if ($orderBy instanceof UncheckedOrderBy) {
-                $securedOrderBy = false;
-                $orderBy = $orderBy->getOrderBy();
-                $reconstructedOrderBy = $orderBy;
-            } else {
-                $securedOrderBy = true;
-                $reconstructedOrderBys = [];
-            }
-            $orderByColumns = $this->orderByAnalyzer->analyzeOrderBy($orderBy);
-
-            // If we sort by a column, there is a high chance we will fetch the bean containing this column.
-            // Hence, we should add the table to the $additionalTablesFetch
-            foreach ($orderByColumns as $orderByColumn) {
-                if ($orderByColumn['type'] === 'colref') {
-                    if ($orderByColumn['table'] !== null) {
-                        $additionalTablesFetch[] = $orderByColumn['table'];
-                    }
-                    if ($securedOrderBy) {
-                        $reconstructedOrderBys[] = ($orderByColumn['table'] !== null ? $connection->quoteIdentifier($orderByColumn['table']).'.' : '').$connection->quoteIdentifier($orderByColumn['column']).' '.$orderByColumn['direction'];
-                    }
-                } elseif ($orderByColumn['type'] === 'expr') {
-                    $sortColumnName = 'sort_column_'.$sortColumn;
-                    $columnsList[] = $orderByColumn['expr'].' as '.$sortColumnName;
-                    $columnDescList[$sortColumnName] = [
-                        'tableGroup' => null,
-                    ];
-                    ++$sortColumn;
-
-                    if ($securedOrderBy) {
-                        throw new TDBMInvalidArgumentException('Invalid ORDER BY column: "'.$orderByColumn['expr'].'". If you want to use expression in your ORDER BY clause, you must wrap them in a UncheckedOrderBy object. For instance: new UncheckedOrderBy("col1 + col2 DESC")');
-                    }
-                }
-            }
-
-            if ($reconstructedOrderBy === null) {
-                $reconstructedOrderBy = implode(', ', $reconstructedOrderBys);
-            }
-        }
-
-        foreach ($additionalTablesFetch as $additionalTable) {
-            $relatedTables = $this->tdbmService->_getRelatedTablesByInheritance($additionalTable);
-            $tableGroupName = $this->getTableGroupName($relatedTables);
-            foreach ($relatedTables as $table) {
-                $tableGroups[$table] = $tableGroupName;
-            }
-            $allFetchedTables = array_merge($allFetchedTables, $relatedTables);
-        }
-
-        // Let's remove any duplicate
-        $allFetchedTables = array_flip(array_flip($allFetchedTables));
-
-        // Now, let's build the column list
-        foreach ($allFetchedTables as $table) {
-            foreach ($this->schema->getTable($table)->getColumns() as $column) {
-                $columnName = $column->getName();
-                $columnDescList[$table.'____'.$columnName] = [
-                    'as' => $table.'____'.$columnName,
-                    'table' => $table,
-                    'column' => $columnName,
-                    'type' => $column->getType(),
-                    'tableGroup' => $tableGroups[$table],
-                ];
-                $columnsList[] = $connection->quoteIdentifier($table).'.'.$connection->quoteIdentifier($columnName).' as '.
-                    $connection->quoteIdentifier($table.'____'.$columnName);
-            }
-        }
-
-        return [$columnDescList, $columnsList, $reconstructedOrderBy];
-    }
-
-    abstract protected function compute();
-
-    /**
-     * Returns an identifier for the group of tables passed in parameter.
-     *
-     * @param string[] $relatedTables
-     *
-     * @return string
-     */
-    protected function getTableGroupName(array $relatedTables)
-    {
-        sort($relatedTables);
-
-        return implode('_``_', $relatedTables);
-    }
-
-    public function getMagicSql() : string
-    {
-        if ($this->magicSql === null) {
-            $this->compute();
-        }
-
-        return $this->magicSql;
-    }
-
-    public function getMagicSqlCount() : string
-    {
-        if ($this->magicSqlCount === null) {
-            $this->compute();
-        }
-
-        return $this->magicSqlCount;
-    }
-
-    public function getColumnDescriptors() : array
-    {
-        if ($this->columnDescList === null) {
-            $this->compute();
-        }
-
-        return $this->columnDescList;
-    }
-
-    /**
-     * Sets the ORDER BY directive executed in SQL.
-     *
-     * For instance:
-     *
-     *  $queryFactory->sort('label ASC, status DESC');
-     *
-     * **Important:** TDBM does its best to protect you from SQL injection. In particular, it will only allow column names in the "ORDER BY" clause. This means you are safe to pass input from the user directly in the ORDER BY parameter.
-     * If you want to pass an expression to the ORDER BY clause, you will need to tell TDBM to stop checking for SQL injections. You do this by passing a `UncheckedOrderBy` object as a parameter:
-     *
-     *  $queryFactory->sort(new UncheckedOrderBy('RAND()'))
-     *
-     * @param string|UncheckedOrderBy|null $orderBy
-     */
-    public function sort($orderBy)
-    {
-        $this->orderBy = $orderBy;
-        $this->magicSql = null;
-        $this->magicSqlCount = null;
-        $this->columnDescList = null;
-    }
+	/**
+	 * @var TDBMService
+	 */
+	protected $tdbmService;
+
+	/**
+	 * @var Schema
+	 */
+	protected $schema;
+
+	/**
+	 * @var OrderByAnalyzer
+	 */
+	protected $orderByAnalyzer;
+
+	/**
+	 * @var string|UncheckedOrderBy|null
+	 */
+	protected $orderBy;
+
+	protected $magicSql;
+	protected $magicSqlCount;
+	protected $columnDescList;
+
+	/**
+	 * @param TDBMService $tdbmService
+	 */
+	public function __construct(TDBMService $tdbmService, Schema $schema, OrderByAnalyzer $orderByAnalyzer, $orderBy)
+	{
+		$this->tdbmService = $tdbmService;
+		$this->schema = $schema;
+		$this->orderByAnalyzer = $orderByAnalyzer;
+		$this->orderBy = $orderBy;
+	}
+
+	/**
+	 * Returns the column list that must be fetched for the SQL request.
+	 *
+	 * Note: MySQL dictates that ORDER BYed columns should appear in the SELECT clause.
+	 *
+	 * @param string                       $mainTable
+	 * @param array                        $additionalTablesFetch
+	 * @param string|UncheckedOrderBy|null $orderBy
+	 *
+	 * @return array
+	 *
+	 * @throws \Doctrine\DBAL\Schema\SchemaException
+	 */
+	protected function getColumnsList(string $mainTable, array $additionalTablesFetch = array(), $orderBy = null)
+	{
+		// From the table name and the additional tables we want to fetch, let's build a list of all tables
+		// that must be part of the select columns.
+
+		$connection = $this->tdbmService->getConnection();
+
+		$tableGroups = [];
+		$allFetchedTables = $this->tdbmService->_getRelatedTablesByInheritance($mainTable);
+		$tableGroupName = $this->getTableGroupName($allFetchedTables);
+		foreach ($allFetchedTables as $table) {
+			$tableGroups[$table] = $tableGroupName;
+		}
+
+		$columnsList = [];
+		$columnDescList = [];
+		$sortColumn = 0;
+		$reconstructedOrderBy = null;
+
+		if (is_string($orderBy)) {
+			$orderBy = trim($orderBy);
+			if ($orderBy === '') {
+				$orderBy = null;
+			}
+		}
+
+		// Now, let's deal with "order by columns"
+		if ($orderBy !== null) {
+			if ($orderBy instanceof UncheckedOrderBy) {
+				$securedOrderBy = false;
+				$orderBy = $orderBy->getOrderBy();
+				$reconstructedOrderBy = $orderBy;
+			} else {
+				$securedOrderBy = true;
+				$reconstructedOrderBys = [];
+			}
+			$orderByColumns = $this->orderByAnalyzer->analyzeOrderBy($orderBy);
+
+			// If we sort by a column, there is a high chance we will fetch the bean containing this column.
+			// Hence, we should add the table to the $additionalTablesFetch
+			foreach ($orderByColumns as $orderByColumn) {
+				if ($orderByColumn['type'] === 'colref') {
+					if ($orderByColumn['table'] !== null) {
+						$additionalTablesFetch[] = $orderByColumn['table'];
+					}
+					if ($securedOrderBy) {
+						$reconstructedOrderBys[] = ($orderByColumn['table'] !== null ? $connection->quoteIdentifier($orderByColumn['table']).'.' : '').$connection->quoteIdentifier($orderByColumn['column']).' '.$orderByColumn['direction'];
+					}
+				} elseif ($orderByColumn['type'] === 'expr') {
+					$sortColumnName = 'sort_column_'.$sortColumn;
+					$columnsList[] = $orderByColumn['expr'].' as '.$sortColumnName;
+					$columnDescList[$sortColumnName] = [
+						'tableGroup' => null,
+					];
+					++$sortColumn;
+
+					if ($securedOrderBy) {
+						throw new TDBMInvalidArgumentException('Invalid ORDER BY column: "'.$orderByColumn['expr'].'". If you want to use expression in your ORDER BY clause, you must wrap them in a UncheckedOrderBy object. For instance: new UncheckedOrderBy("col1 + col2 DESC")');
+					}
+				}
+			}
+
+			if ($reconstructedOrderBy === null) {
+				$reconstructedOrderBy = implode(', ', $reconstructedOrderBys);
+			}
+		}
+
+		foreach ($additionalTablesFetch as $additionalTable) {
+			$relatedTables = $this->tdbmService->_getRelatedTablesByInheritance($additionalTable);
+			$tableGroupName = $this->getTableGroupName($relatedTables);
+			foreach ($relatedTables as $table) {
+				$tableGroups[$table] = $tableGroupName;
+			}
+			$allFetchedTables = array_merge($allFetchedTables, $relatedTables);
+		}
+
+		// Let's remove any duplicate
+		$allFetchedTables = array_flip(array_flip($allFetchedTables));
+
+		// Now, let's build the column list
+		foreach ($allFetchedTables as $table) {
+			foreach ($this->schema->getTable($table)->getColumns() as $column) {
+				$columnName = $column->getName();
+				$columnDescList[$table.'____'.$columnName] = [
+					'as' => $table.'____'.$columnName,
+					'table' => $table,
+					'column' => $columnName,
+					'type' => $column->getType(),
+					'tableGroup' => $tableGroups[$table],
+				];
+				$columnsList[] = $connection->quoteIdentifier($table).'.'.$connection->quoteIdentifier($columnName).' as '.
+					$connection->quoteIdentifier($table.'____'.$columnName);
+			}
+		}
+
+		return [$columnDescList, $columnsList, $reconstructedOrderBy];
+	}
+
+	abstract protected function compute();
+
+	/**
+	 * Returns an identifier for the group of tables passed in parameter.
+	 *
+	 * @param string[] $relatedTables
+	 *
+	 * @return string
+	 */
+	protected function getTableGroupName(array $relatedTables)
+	{
+		sort($relatedTables);
+
+		return implode('_``_', $relatedTables);
+	}
+
+	public function getMagicSql() : string
+	{
+		if ($this->magicSql === null) {
+			$this->compute();
+		}
+
+		return $this->magicSql;
+	}
+
+	public function getMagicSqlCount() : string
+	{
+		if ($this->magicSqlCount === null) {
+			$this->compute();
+		}
+
+		return $this->magicSqlCount;
+	}
+
+	public function getColumnDescriptors() : array
+	{
+		if ($this->columnDescList === null) {
+			$this->compute();
+		}
+
+		return $this->columnDescList;
+	}
+
+	/**
+	 * Sets the ORDER BY directive executed in SQL.
+	 *
+	 * For instance:
+	 *
+	 *  $queryFactory->sort('label ASC, status DESC');
+	 *
+	 * **Important:** TDBM does its best to protect you from SQL injection. In particular, it will only allow column names in the "ORDER BY" clause. This means you are safe to pass input from the user directly in the ORDER BY parameter.
+	 * If you want to pass an expression to the ORDER BY clause, you will need to tell TDBM to stop checking for SQL injections. You do this by passing a `UncheckedOrderBy` object as a parameter:
+	 *
+	 *  $queryFactory->sort(new UncheckedOrderBy('RAND()'))
+	 *
+	 * @param string|UncheckedOrderBy|null $orderBy
+	 */
+	public function sort($orderBy)
+	{
+		$this->orderBy = $orderBy;
+		$this->magicSql = null;
+		$this->magicSqlCount = null;
+		$this->columnDescList = null;
+	}
 }