. */ namespace Doctrine\ORM\Tools\Cli\Tasks; use Doctrine\Common\Cli\Tasks\AbstractTask, Doctrine\Common\Cli\CliException, Doctrine\Common\Util\Debug, Doctrine\Common\Cli\Option, Doctrine\Common\Cli\OptionGroup, Doctrine\ORM\Query; /** * Task for executing DQL in passed EntityManager. * * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * @link www.doctrine-project.org * @since 2.0 * @version $Revision$ * @author Guilherme Blanco * @author Jonathan Wage * @author Roman Borschel */ class RunDqlTask extends AbstractTask { /** * @inheritdoc */ public function buildDocumentation() { $dql = new OptionGroup(OptionGroup::CARDINALITY_1_1, array( new Option('dql', '', 'The DQL to execute.') )); $hydrate = new OptionGroup(OptionGroup::CARDINALITY_0_1, array( new Option( 'hydrate', '', 'Hydration mode of result set.' . PHP_EOL . 'Should be either: object, array, scalar or single-scalar.' ) )); $firstResult = new OptionGroup(OptionGroup::CARDINALITY_0_1, array( new Option('first-result', '', 'The first result in the result set.') )); $maxResults = new OptionGroup(OptionGroup::CARDINALITY_0_1, array( new Option('max-results', '', 'The maximum number of results in the result set.') )); $depth = new OptionGroup(OptionGroup::CARDINALITY_0_1, array( new Option('depth', '', 'Dumping depth of Entities graph.') )); $doc = $this->getDocumentation(); $doc->setName('run-dql') ->setDescription('Executes arbitrary DQL directly from the command line.') ->getOptionGroup() ->addOption($dql) ->addOption($hydrate) ->addOption($firstResult) ->addOption($maxResults) ->addOption($depth); } /** * @inheritdoc */ public function validate() { $arguments = $this->getArguments(); $em = $this->getConfiguration()->getAttribute('em'); if ($em === null) { throw new CliException( "Attribute 'em' of CLI Configuration is not defined or it is not a valid EntityManager." ); } if ( ! isset($arguments['dql'])) { throw new CliException('Argument --dql must be defined.'); } if (isset($arguments['hydrate'])) { $hydrationModeName = 'Doctrine\ORM\Query::HYDRATE_' . strtoupper(str_replace('-', '_', $arguments['hydrate'])); if ( ! defined($hydrationModeName)) { throw new CliException("Argument --hydrate must be either 'object', 'array', 'scalar' or 'single-scalar'."); } } if (isset($arguments['first-result']) && ! ctype_digit($arguments['first-result'])) { throw new CliException('Argument --first-result must be an integer value.'); } if (isset($arguments['max-results']) && ! ctype_digit($arguments['max-results'])) { throw new CliException('Argument --max-results must be an integer value.'); } return true; } /** * @inheritdoc */ public function run() { $arguments = $this->getArguments(); $em = $this->getConfiguration()->getAttribute('em'); $query = $em->createQuery($arguments['dql']); $hydrationMode = isset($arguments['hydrate']) ? constant('Doctrine\ORM\Query::HYDRATE_' . strtoupper(str_replace('-', '_', $arguments['hydrate']))) : Query::HYDRATE_OBJECT; if (isset($arguments['first-result'])) { $query->setFirstResult($arguments['first-result']); } if (isset($arguments['max-results'])) { $query->setMaxResults($arguments['max-results']); } $resultSet = $query->getResult($hydrationMode); $maxDepth = isset($arguments['depth']) ? $arguments['depth'] : 7; Debug::dump($resultSet, $maxDepth); } }