Skip to content

D
doctrine-dbal
Commit 67665aa5 authored by guilhermeblanco's avatar guilhermeblanco
Browse files
Options

[2.0] Major refactorings to CLI. New documentation applied. Missing validation and tests

parent ea4f5c17
Expand all Show whitespace changes
Inline Side-by-side
Showing with 1031 additions and 239 deletions
UPGRADE_TO_2_0
View file @ 67665aa5
...@@ -40,6 +40,12 @@ The new behavior is as if the option were set to FALSE all the time, basically d ...@@ -40,6 +40,12 @@ The new behavior is as if the option were set to FALSE all the time, basically d
# Upgrade from 2.0-ALPHA3 to 2.0-ALPHA4 # Upgrade from 2.0-ALPHA3 to 2.0-ALPHA4
- ## CLI Controller changes
CLI main object changed its name and namespace. Renamed from Doctrine\ORM\Tools\Cli to Doctrine\ORM\Tools\Cli\CliController.
Doctrine\ORM\Tools\Cli\CliController methods addTasks and addTask are now fluent.
## CLI Tasks documentation
Tasks have implemented a new way to build documentation. Although it is still possible to define the help manually by extending the basicHelp and extendedHelp, they are now optional.
With new required method AbstractTask::buildDocumentation, its implementation defines the TaskDocumentation instance (accessible through AbstractTask::getDocumentation()), basicHelp and extendedHelp are now not necessary to be implemented.
lib/Doctrine/Common/Cli/Option.php 0 → 100644
View file @ 67665aa5
<?php
/*
* $Id$
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software consists of voluntary contributions made by many individuals
* and is licensed under the LGPL. For more information, see
* <http://www.doctrine-project.org>.
*/
namespace Doctrine\Common\Cli;
/**
* CLI Option definition
*
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @link www.doctrine-project.org
* @since 2.0
* @version $Revision$
* @author Guilherme Blanco <guilhermeblanco@hotmail.com>
* @author Jonathan Wage <jonwage@gmail.com>
* @author Roman Borschel <roman@code-factory.org>
*/
class Option
{
/** @var string Option name */
private $_name;
/** @var string Option default value */
/** @var string Option description */
private $description;
/**
* Constructs a CLI Option
*
* @param string Option name
* @param integer Option type
* @param string Option description
*/
public function __construct($name, $defaultValue, $description)
{
$this->_name = $name;
$this->_defaultValue = $defaultValue;
$this->_description = $description;
}
/**
* Retrieves the CLI Option name
*
* @return string Option name
*/
public function getName()
{
return $this->_name;
}
/**
* Retrieves the CLI Option default value
*
* @return string|null Option default value
*/
public function getDefaultValue()
{
return $this->_defaultValue;
}
/**
* Retrieves the CLI Option description
*
* @return string Option description
*/
public function getDescription()
{
return $this->_description;
}
/**
* Converts the Option instance into a string representation
*
* @return string CLI Option representation in string
*/
public function __toString()
{
return '--' . $this->_name
. (( ! is_null($this->_defaultValue)) ? '=' . $this->_defaultValue : '');
}
}
\ No newline at end of file
lib/Doctrine/Common/Cli/OptionGroup.php 0 → 100644
View file @ 67665aa5
This diff is collapsed.
lib/Doctrine/ORM/Tools/Cli/Printers/AbstractPrinter.php → lib/Doctrine/Common/Cli/Printers/AbstractPrinter.php
View file @ 67665aa5
...@@ -19,9 +19,9 @@ ...@@ -19,9 +19,9 @@
* <http://www.doctrine-project.org>. * <http://www.doctrine-project.org>.
*/ */
namespace Doctrine\ORM\Tools\Cli\Printers; namespace Doctrine\Common\Cli\Printers;
use Doctrine\ORM\Tools\Cli\Style; use Doctrine\Common\Cli\Style;
/** /**
* CLI Output Printer. * CLI Output Printer.
...@@ -142,14 +142,26 @@ abstract class AbstractPrinter ...@@ -142,14 +142,26 @@ abstract class AbstractPrinter
} }
/** /**
* Writes to the output stream, formatting it by applying the defined style. * Writes to the output stream.
*
* @param string $message Message to be outputted
*/
public function output($message)
{
fwrite($this->_stream, $message);
return $this;
}
/**
* Formats message applying the defined style and writes to the output stream.
* *
* @param string $message Message to be outputted * @param string $message Message to be outputted
* @param mixed $style Optional style to be applied in message * @param mixed $style Optional style to be applied in message
*/ */
public function write($message, $style = 'NONE') public function write($message, $style = 'NONE')
{ {
fwrite($this->_stream, $this->format($message, $style)); $this->output($this->format($message, $style));
return $this; return $this;
} }
......
lib/Doctrine/ORM/Tools/Cli/Printers/AnsiColorPrinter.php → lib/Doctrine/Common/Cli/Printers/AnsiColorPrinter.php
View file @ 67665aa5
...@@ -19,9 +19,9 @@ ...@@ -19,9 +19,9 @@
* <http://www.doctrine-project.org>. * <http://www.doctrine-project.org>.
*/ */
namespace Doctrine\ORM\Tools\Cli\Printers; namespace Doctrine\Common\Cli\Printers;
use Doctrine\ORM\Tools\Cli\Style; use Doctrine\Common\Cli\Style;
/** /**
* CLI Output Printer for ANSI Color terminal * CLI Output Printer for ANSI Color terminal
...@@ -57,11 +57,12 @@ class AnsiColorPrinter extends AbstractPrinter ...@@ -57,11 +57,12 @@ class AnsiColorPrinter extends AbstractPrinter
/** /**
* @inheritdoc * @inheritdoc
*/ */
public function format($message, $style) public function format($message, $style = 'NONE')
{ {
if ( ! $this->_supportsColor()) { if ( ! $this->_supportsColor()) {
return $message; return $message;
} }
$style = $this->getStyle($style); $style = $this->getStyle($style);
$str = $this->_getForegroundString($style->getForeground()) $str = $this->_getForegroundString($style->getForeground())
. $this->_getBackgroundString($style->getBackground()) . $this->_getBackgroundString($style->getBackground())
......
lib/Doctrine/ORM/Tools/Cli/Printers/NormalPrinter.php → lib/Doctrine/Common/Cli/Printers/NormalPrinter.php
View file @ 67665aa5
...@@ -19,9 +19,9 @@ ...@@ -19,9 +19,9 @@
* <http://www.doctrine-project.org>. * <http://www.doctrine-project.org>.
*/ */
namespace Doctrine\ORM\Tools\Cli\Printers; namespace Doctrine\Common\Cli\Printers;
use Doctrine\ORM\Tools\Cli\Style; use Doctrine\Common\Cli\Style;
/** /**
* CLI Output Printer for Normal terminal * CLI Output Printer for Normal terminal
......
lib/Doctrine/ORM/Tools/Cli/Style.php → lib/Doctrine/Common/Cli/Style.php
View file @ 67665aa5
...@@ -19,7 +19,7 @@ ...@@ -19,7 +19,7 @@
* <http://www.doctrine-project.org>. * <http://www.doctrine-project.org>.
*/ */
namespace Doctrine\ORM\Tools\Cli; namespace Doctrine\Common\Cli;
/** /**
* CLI Output Style * CLI Output Style
......
lib/Doctrine/Common/Cli/TaskDocumentation.php 0 → 100644
View file @ 67665aa5
<?php
/*
* $Id$
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software consists of voluntary contributions made by many individuals
* and is licensed under the LGPL. For more information, see
* <http://www.doctrine-project.org>.
*/
namespace Doctrine\Common\Cli;
use Doctrine\Common\Cli\Printers\AbstractPrinter,
Doctrine\Common\Cli\OptionGroup,
Doctrine\Common\Cli\Option;
/**
* CLI Task documentation
*
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @link www.doctrine-project.org
* @since 2.0
* @version $Revision$
* @author Guilherme Blanco <guilhermeblanco@hotmail.com>
* @author Jonathan Wage <jonwage@gmail.com>
* @author Roman Borschel <roman@code-factory.org>
*/
class TaskDocumentation
{
/** @var AbstractPrinter CLI Printer */
private $_printer;
/** @var string CLI Task name */
private $_name;
/** @var string CLI Task description */
private $_description;
/** @var array CLI Task Option Group */
private $_optionGroup;
/**
* Constructs a new CLI Task Documentation
*
* @param AbstractPrinter CLI Printer
*/
public function __construct(AbstractPrinter $printer)
{
$this->_printer = $printer;
$this->_optionGroup = new OptionGroup(OptionGroup::CARDINALITY_M_N);
}
/**
* Defines the CLI Task name
*
* @param string Task name
* @return TaskDocumentation This object instance
*/
public function setName($name)
{
$this->_name = $name;
return $this;
}
/**
* Retrieves the CLI Task name
*
* @return string Task name
*/
public function getName()
{
return $this->_name;
}
/**
* Defines the CLI Task description
*
* @param string Task description
* @return TaskDocumentation This object instance
*/
public function setDescription($description)
{
$this->_description = $description;
return $this;
}
/**
* Retrieves the CLI Task description
*
* @var string Task description
*/
public function getDescription()
{
return $this->_description;
}
/**
* Retrieves the CLI Task Option Group
*
* @return OptionGroup CLI Task Option Group
*/
public function getOptionGroup()
{
return $this->_optionGroup;
}
/**
* Includes a new CLI Option Group to the CLI Task documentation
*
* @param OptionGroup CLI Option Group
* @return TaskDocumentation This object instance
*/
public function addOption($option)
{
if ($option instanceof OptionGroup) {
$this->_optionGroup->addOption($option);
}
return $this;
}
/**
* Retrieves the synopsis of associated CLI Task
*
* @return string CLI Task synopsis
*/
public function getSynopsis()
{
return $this->_printer->format($this->_name, 'KEYWORD') . ' '
. trim($this->_optionGroup->formatPlain($this->_printer));
}
/**
* Retrieve the complete documentation of associated CLI Task
*
* @return string CLI Task complete documentation
*/
public function getCompleteDocumentation()
{
$printer = $this->_printer;
return $printer->format('Task: ')
. $printer->format($this->_name, 'KEYWORD')
. $printer->format(PHP_EOL)
. $printer->format('Synopsis: ')
. $this->getSynopsis()
. $printer->format(PHP_EOL)
. $printer->format('Description: ')
. $printer->format($this->_description)
. $printer->format(PHP_EOL)
. $printer->format('Options: ')
. $printer->format(PHP_EOL)
. $this->_optionGroup->formatWithDescription($printer);
}
}
lib/Doctrine/ORM/Tools/Cli.php → lib/Doctrine/ORM/Tools/Cli/CliController.php
View file @ 67665aa5
...@@ -19,20 +19,20 @@ ...@@ -19,20 +19,20 @@
* <http://www.doctrine-project.org>. * <http://www.doctrine-project.org>.
*/ */
namespace Doctrine\ORM\Tools; namespace Doctrine\ORM\Tools\Cli;
use Doctrine\Common\Util\Inflector, use Doctrine\Common\Util\Inflector,
Doctrine\ORM\Tools\Cli\Printers\AbstractPrinter, Doctrine\Common\Cli\Printers\AbstractPrinter,
Doctrine\ORM\Tools\Cli\Tasks\AbstractTask, Doctrine\Common\Cli\Printers\AnsiColorPrinter,
Doctrine\ORM\Tools\Cli\Printers\AnsiColorPrinter; Doctrine\ORM\Tools\Cli\Tasks\AbstractTask;
/** /**
* Generic CLI Runner of Tasks * Generic CLI Controller of Tasks execution
* *
* To include a new Task support, create a task: * To include a new Task support, create a task:
* *
* [php] * [php]
* class MyProject\Tools\Cli\Tasks\MyTask extends Doctrine\ORM\Tools\Cli\AbstractTask * class MyProject\Tools\Cli\Tasks\MyTask extends Doctrine\ORM\Tools\Cli\Tasks\AbstractTask
* { * {
* public function run(); * public function run();
* public function basicHelp(); * public function basicHelp();
...@@ -43,7 +43,7 @@ use Doctrine\Common\Util\Inflector, ...@@ -43,7 +43,7 @@ use Doctrine\Common\Util\Inflector,
* And then, include the support to it in your command-line script: * And then, include the support to it in your command-line script:
* *
* [php] * [php]
* $cli = new Doctrine\ORM\Tools\Cli(); * $cli = new Doctrine\ORM\Tools\Cli\CliController();
* $cli->addTask('myTask', 'MyProject\Tools\Cli\Tasks\MyTask'); * $cli->addTask('myTask', 'MyProject\Tools\Cli\Tasks\MyTask');
* *
* To execute, just type any classify-able name: * To execute, just type any classify-able name:
...@@ -58,7 +58,7 @@ use Doctrine\Common\Util\Inflector, ...@@ -58,7 +58,7 @@ use Doctrine\Common\Util\Inflector,
* @author Jonathan Wage <jonwage@gmail.com> * @author Jonathan Wage <jonwage@gmail.com>
* @author Roman Borschel <roman@code-factory.org> * @author Roman Borschel <roman@code-factory.org>
*/ */
class Cli class CliController
{ {
/** /**
* @var AbstractPrinter CLI Printer instance * @var AbstractPrinter CLI Printer instance
...@@ -107,12 +107,15 @@ class Cli ...@@ -107,12 +107,15 @@ class Cli
* )); * ));
* *
* @param array $tasks CLI Tasks to be included * @param array $tasks CLI Tasks to be included
* @return CliController This object instance
*/ */
public function addTasks($tasks) public function addTasks($tasks)
{ {
foreach ($tasks as $name => $class) { foreach ($tasks as $name => $class) {
$this->addTask($name, $class); $this->addTask($name, $class);
} }
return $this;
} }
/** /**
...@@ -124,6 +127,7 @@ class Cli ...@@ -124,6 +127,7 @@ class Cli
* *
* @param string $name CLI Task name * @param string $name CLI Task name
* @param string $class CLI Task class (FQCN - Fully Qualified Class Name) * @param string $class CLI Task class (FQCN - Fully Qualified Class Name)
* @return CliController This object instance
*/ */
public function addTask($name, $class) public function addTask($name, $class)
{ {
...@@ -132,6 +136,8 @@ class Cli ...@@ -132,6 +136,8 @@ class Cli
$name = $this->_processTaskName($name); $name = $this->_processTaskName($name);
$this->_tasks[$name] = $class; $this->_tasks[$name] = $class;
return $this;
} }
/** /**
...@@ -170,10 +176,9 @@ class Cli ...@@ -170,10 +176,9 @@ class Cli
$em = $this->_initializeEntityManager($processedArgs, $taskArguments); $em = $this->_initializeEntityManager($processedArgs, $taskArguments);
// Instantiate and execute the task // Instantiate and execute the task
$task = new $this->_tasks[$taskName](); $task = new $this->_tasks[$taskName]($this->_printer);
$task->setAvailableTasks($this->_tasks); $task->setAvailableTasks($this->_tasks);
$task->setEntityManager($em); $task->setEntityManager($em);
$task->setPrinter($this->_printer);
$task->setArguments($taskArguments); $task->setArguments($taskArguments);
if ( if (
......
lib/Doctrine/ORM/Tools/Cli/Tasks/AbstractTask.php
View file @ 67665aa5
...@@ -21,7 +21,10 @@ ...@@ -21,7 +21,10 @@
namespace Doctrine\ORM\Tools\Cli\Tasks; namespace Doctrine\ORM\Tools\Cli\Tasks;
use Doctrine\ORM\Tools\Cli\Printers\AbstractPrinter; use Doctrine\Common\Cli\Printers\AbstractPrinter,
Doctrine\Common\Cli\TaskDocumentation,
Doctrine\Common\Cli\OptionGroup,
Doctrine\Common\Cli\Option;
/** /**
* Base class for CLI Tasks. * Base class for CLI Tasks.
...@@ -50,6 +53,11 @@ abstract class AbstractTask ...@@ -50,6 +53,11 @@ abstract class AbstractTask
*/ */
protected $_printer; protected $_printer;
/**
* @var TaskDocumentation CLI Task Documentation
*/
protected $_documentation;
/** /**
* @var array CLI argument options * @var array CLI argument options
*/ */
...@@ -66,13 +74,24 @@ abstract class AbstractTask ...@@ -66,13 +74,24 @@ abstract class AbstractTask
protected $_em; protected $_em;
/** /**
* Defines a CLI Output Printer * Constructor of CLI Task
* *
* @param AbstractPrinter CLI Output Printer * @param AbstractPrinter CLI Output Printer
*/ */
public function setPrinter(AbstractPrinter $printer) public function __construct(AbstractPrinter $printer)
{ {
$this->_printer = $printer; $this->_printer = $printer;
$this->_documentation = new TaskDocumentation($printer);
// Include configuration option
$configGroup = new OptionGroup(OptionGroup::CARDINALITY_0_1);
$configGroup->addOption(
new Option('config', '<FILE_PATH>', 'Configuration file for EntityManager.')
);
$this->_documentation->addOption($configGroup);
// Complete the CLI Task Documentation creation
$this->buildDocumentation();
} }
/** /**
...@@ -145,6 +164,16 @@ abstract class AbstractTask ...@@ -145,6 +164,16 @@ abstract class AbstractTask
return $this->_em; return $this->_em;
} }
/**
* Retrieves the CLI Task Documentation
*
* @return TaskDocumentation
*/
public function getDocumentation()
{
return $this->_documentation;
}
/** /**
* Expose to CLI Output Printer the extended help of the given task. * Expose to CLI Output Printer the extended help of the given task.
* This means it should detail all parameters, options and the meaning * This means it should detail all parameters, options and the meaning
...@@ -155,7 +184,10 @@ abstract class AbstractTask ...@@ -155,7 +184,10 @@ abstract class AbstractTask
* ./doctrine task --help * ./doctrine task --help
* *
*/ */
abstract public function extendedHelp(); public function extendedHelp()
{
$this->_printer->output($this->_documentation->getCompleteDocumentation());
}
/** /**
* Expose to CLI Output Printer the basic help of the given task. * Expose to CLI Output Printer the basic help of the given task.
...@@ -173,7 +205,14 @@ abstract class AbstractTask ...@@ -173,7 +205,14 @@ abstract class AbstractTask
* ./doctrine --help * ./doctrine --help
* *
*/ */
abstract public function basicHelp(); public function basicHelp()
{
$this->_printer
->output($this->_documentation->getSynopsis())
->output(PHP_EOL)
->output(' ' . $this->_documentation->getDescription())
->output(PHP_EOL . PHP_EOL);
}
/** /**
* Assures the given arguments matches with required/optional ones. * Assures the given arguments matches with required/optional ones.
...@@ -190,4 +229,9 @@ abstract class AbstractTask ...@@ -190,4 +229,9 @@ abstract class AbstractTask
* what is supposed to do. * what is supposed to do.
*/ */
abstract public function run(); abstract public function run();
/**
* Generate the CLI Task Documentation
*/
abstract public function buildDocumentation();
} }
\ No newline at end of file
lib/Doctrine/ORM/Tools/Cli/Tasks/ClearCacheTask.php
View file @ 67665aa5
...@@ -21,7 +21,11 @@ ...@@ -21,7 +21,11 @@
namespace Doctrine\ORM\Tools\Cli\Tasks; namespace Doctrine\ORM\Tools\Cli\Tasks;
use Doctrine\Common\Cache\AbstractDriver; use Doctrine\Common\DoctrineException,
Doctrine\Common\Util\Debug,
Doctrine\Common\Cli\Option,
Doctrine\Common\Cli\OptionGroup,
Doctrine\Common\Cache\AbstractDriver;
/** /**
* CLI Task to clear the cache of the various cache drivers * CLI Task to clear the cache of the various cache drivers
...@@ -36,45 +40,32 @@ use Doctrine\Common\Cache\AbstractDriver; ...@@ -36,45 +40,32 @@ use Doctrine\Common\Cache\AbstractDriver;
*/ */
class ClearCacheTask extends AbstractTask class ClearCacheTask extends AbstractTask
{ {
public function basicHelp() /**
{ * @inheritdoc
$this->_writeSynopsis($this->getPrinter()); */
} public function buildDocumentation()
public function extendedHelp()
{
$printer = $this->getPrinter();
$printer->write('Task: ')->writeln('clear-cache', 'KEYWORD')
->write('Synopsis: ');
$this->_writeSynopsis($printer);
$printer->writeln('Description: Clear cache from configured query, result and metadata drivers.')
->writeln('Options:')
->write('--query', 'OPT_ARG')
->writeln("\t\t\tClear the query cache.")
->write('--result', 'OPT_ARG')
->writeln("\t\tClear the result cache.")
->write('--metadata', 'OPT_ARG')
->writeln("\t\tClear the metadata cache.")
->write('--id=<ID>', 'REQ_ARG')
->writeln("\t\tThe id of the cache entry to delete (accepts * wildcards).")
->write('--regex=<REGEX>', 'REQ_ARG')
->writeln("\t\tDelete cache entries that match the given regular expression.")
->write('--prefix=<PREFIX>', 'REQ_ARG')
->writeln("\tDelete cache entries that have the given prefix.")
->write('--suffix=<SUFFIX>', 'REQ_ARG')
->writeln("\tDelete cache entries that have the given suffix.");
}
private function _writeSynopsis($printer)
{ {
$printer->write('clear-cache', 'KEYWORD') $cacheOptions = new OptionGroup(OptionGroup::CARDINALITY_1_1, array(
->write(' (--query | --result | --metadata)', 'OPT_ARG') new Option('query', null, 'Clear the query cache.'),
->write(' [--id=<ID>]', 'REQ_ARG') new Option('metadata', null, 'Clear the metadata cache.'),
->write(' [--regex=<REGEX>]', 'REQ_ARG') new OptionGroup(OptionGroup::CARDINALITY_M_N, array(
->write(' [--prefix=<PREFIX>]', 'REQ_ARG') new OptionGroup(OptionGroup::CARDINALITY_1_1, array(
->writeln(' [--suffix=<SUFFIX>]', 'REQ_ARG'); new Option('result', null, 'Clear the result cache.')
)),
new OptionGroup(OptionGroup::CARDINALITY_0_N, array(
new Option('id', '<ID>', 'The id of the cache entry to delete (accepts * wildcards).'),
new Option('regex', '<REGEX>', 'Delete cache entries that match the given regular expression.'),
new Option('prefix', '<PREFIX>', 'Delete cache entries that have the given prefix.'),
new Option('suffic', '<SUFFIX>', 'Delete cache entries that have the given suffix.')
))
))
));
$doc = $this->getDocumentation();
$doc->setName('clear-cache')
->setDescription('Clear cache from configured query, result and metadata drivers.')
->getOptionGroup()
->addOption($cacheOptions);
} }
public function validate() public function validate()
...@@ -90,7 +81,11 @@ class ClearCacheTask extends AbstractTask ...@@ -90,7 +81,11 @@ class ClearCacheTask extends AbstractTask
|| isset($args['prefix']) || isset($args['prefix'])
|| isset($args['suffix']))) { || isset($args['suffix']))) {
$printer->writeln('When clearing the query or metadata cache do not specify any --id, --regex, --prefix or --suffix.', 'ERROR'); $printer->writeln(
'When clearing the query or metadata cache do not ' .
'specify any --id, --regex, --prefix or --suffix.',
'ERROR'
);
return false; return false;
} }
...@@ -112,6 +107,7 @@ class ClearCacheTask extends AbstractTask ...@@ -112,6 +107,7 @@ class ClearCacheTask extends AbstractTask
$suffix = isset($args['suffix']) ? $args['suffix'] : null; $suffix = isset($args['suffix']) ? $args['suffix'] : null;
$all = false; $all = false;
if ( ! $query && ! $result && ! $metadata) { if ( ! $query && ! $result && ! $metadata) {
$all = true; $all = true;
} }
...@@ -206,6 +202,7 @@ class ClearCacheTask extends AbstractTask ...@@ -206,6 +202,7 @@ class ClearCacheTask extends AbstractTask
} else { } else {
$printer->writeln('No ' . $type . ' cache entries found', 'ERROR'); $printer->writeln('No ' . $type . ' cache entries found', 'ERROR');
} }
$printer->writeln("");
$printer->write(PHP_EOL);
} }
} }
\ No newline at end of file
lib/Doctrine/ORM/Tools/Cli/Tasks/ConvertMappingTask.php
View file @ 67665aa5
...@@ -21,8 +21,10 @@ ...@@ -21,8 +21,10 @@
namespace Doctrine\ORM\Tools\Cli\Tasks; namespace Doctrine\ORM\Tools\Cli\Tasks;
use Doctrine\ORM\Tools\Export\ClassMetadataExporter, use Doctrine\Common\DoctrineException,
Doctrine\Common\DoctrineException; Doctrine\Common\Cli\Option,
Doctrine\Common\Cli\OptionGroup,
Doctrine\ORM\Tools\Export\ClassMetadataExporter;
if ( ! class_exists('sfYaml', false)) { if ( ! class_exists('sfYaml', false)) {
require_once __DIR__ . '/../../../../../vendor/sfYaml/sfYaml.class.php'; require_once __DIR__ . '/../../../../../vendor/sfYaml/sfYaml.class.php';
...@@ -47,42 +49,22 @@ class ConvertMappingTask extends AbstractTask ...@@ -47,42 +49,22 @@ class ConvertMappingTask extends AbstractTask
/** /**
* @inheritdoc * @inheritdoc
*/ */
public function extendedHelp() public function buildDocumentation()
{ {
$printer = $this->getPrinter(); $convertOptions = new OptionGroup(OptionGroup::CARDINALITY_N_N, array(
new OptionGroup(OptionGroup::CARDINALITY_1_1, array(
$printer->write('Task: ')->writeln('convert-mapping', 'KEYWORD') new Option('from', '<SOURCE>', 'The path to the mapping information to convert from (yml, xml, php, annotation).'),
->write('Synopsis: '); new Option('from-database', null, 'Use this option if you wish to reverse engineer your database to a set of Doctrine mapping files.')
$this->_writeSynopsis($printer); )),
new Option('to', '<TYPE>', 'The format to convert to (yml, xml, php, annotation).'),
$printer->writeln('Description: Convert mapping information between supported formats.') new Option('dest', '<PATH>', 'The path to write the converted mapping information.')
->writeln('Options:') ));
->write('--from=<SOURCE>', 'REQ_ARG')
->writeln("\tThe path to the mapping information to convert from (yml, xml, php, annotation).") $doc = $this->getDocumentation();
->write('--from-database', 'REQ_ARG') $doc->setName('convert-mapping')
->writeln("\tUse this option if you wish to reverse engineer your database to a set of Doctrine mapping files.") ->setDescription('Convert mapping information between supported formats.')
->write('--to=<TYPE>', 'REQ_ARG') ->getOptionGroup()
->writeln("\tThe format to convert to (yml, xml, php, annotation).") ->addOption($convertOptions);
->write(PHP_EOL)
->write('--dest=<PATH>', 'REQ_ARG')
->writeln("\tThe path to write the converted mapping information.");
}
/**
* @inheritdoc
*/
public function basicHelp()
{
$this->_writeSynopsis($this->getPrinter());
}
private function _writeSynopsis($printer)
{
$printer->write('convert-mapping', 'KEYWORD')
->write(' --from=<SOURCE>', 'REQ_ARG')
->write(' --to=<TYPE>', 'REQ_ARG')
->write(' --dest=<PATH>', 'REQ_ARG')
->writeln(' --from-database', 'OPT_ARG');
} }
/** /**
......
lib/Doctrine/ORM/Tools/Cli/Tasks/EnsureProductionSettingsTask.php
View file @ 67665aa5
...@@ -36,27 +36,19 @@ use Doctrine\Common\Cache\AbstractDriver; ...@@ -36,27 +36,19 @@ use Doctrine\Common\Cache\AbstractDriver;
*/ */
class EnsureProductionSettingsTask extends AbstractTask class EnsureProductionSettingsTask extends AbstractTask
{ {
public function basicHelp() /**
{ * @inheritdoc
$this->_writeSynopsis($this->getPrinter()); */
} public function buildDocumentation()
public function extendedHelp()
{
$printer = $this->getPrinter();
$printer->write('Task: ')->writeln('ensure-production-settings', 'KEYWORD')
->write('Synopsis: ');
$this->_writeSynopsis($printer);
$printer->writeln('Description: Verify that Doctrine is properly configured for a production environment.');
}
private function _writeSynopsis($printer)
{ {
$printer->writeln('ensure-production-settings', 'KEYWORD'); $doc = $this->getDocumentation();
$doc->setName('ensure-production-settings')
->setDescription('Verify that Doctrine is properly configured for a production environment.');
} }
/**
* @inheritdoc
*/
public function validate() public function validate()
{ {
return true; return true;
...@@ -65,6 +57,7 @@ class EnsureProductionSettingsTask extends AbstractTask ...@@ -65,6 +57,7 @@ class EnsureProductionSettingsTask extends AbstractTask
public function run() public function run()
{ {
$printer = $this->getPrinter(); $printer = $this->getPrinter();
try { try {
$this->getEntityManager()->getConfiguration()->ensureProductionSettings(); $this->getEntityManager()->getConfiguration()->ensureProductionSettings();
} catch (\Doctrine\Common\DoctrineException $e) { } catch (\Doctrine\Common\DoctrineException $e) {
......
lib/Doctrine/ORM/Tools/Cli/Tasks/GenerateProxiesTask.php
View file @ 67665aa5
...@@ -2,6 +2,10 @@ ...@@ -2,6 +2,10 @@
namespace Doctrine\ORM\Tools\Cli\Tasks; namespace Doctrine\ORM\Tools\Cli\Tasks;
use Doctrine\Common\DoctrineException,
Doctrine\Common\Cli\Option,
Doctrine\Common\Cli\OptionGroup;
/** /**
* Task to (re)generate the proxy classes used by doctrine. * Task to (re)generate the proxy classes used by doctrine.
* *
...@@ -18,33 +22,17 @@ class GenerateProxiesTask extends AbstractTask ...@@ -18,33 +22,17 @@ class GenerateProxiesTask extends AbstractTask
/** /**
* @inheritdoc * @inheritdoc
*/ */
public function extendedHelp() public function buildDocumentation()
{
$printer = $this->getPrinter();
$printer->write('Task: ')->writeln('generate-proxies', 'KEYWORD')
->write('Synopsis: ');
$this->_writeSynopsis($printer);
$printer->writeln('Description: Generates proxy classes for entity classes.')
->writeln('Options:')
->write('--to-dir', 'OPT_ARG')
->writeln("\t\tGenerates the classes in the specified directory.")
->write(PHP_EOL);
}
/**
* @inheritdoc
*/
public function basicHelp()
{
$this->_writeSynopsis($this->getPrinter());
}
private function _writeSynopsis($printer)
{ {
$printer->write('generate-proxies', 'KEYWORD') $toDir = new OptionGroup(OptionGroup::CARDINALITY_0_1, array(
->writeln(' [--to-dir=<PATH>]', 'OPT_ARG'); new Option('to-dir', '<PATH>', 'Generates the classes in the specified directory.')
));
$doc = $this->getDocumentation();
$doc->setName('generate-proxies')
->setDescription('Generates proxy classes for entity classes.')
->getOptionGroup()
->addOption($toDir);
} }
/** /**
......
lib/Doctrine/ORM/Tools/Cli/Tasks/HelpTask.php
View file @ 67665aa5
...@@ -36,6 +36,14 @@ use Doctrine\Common\Util\Inflector; ...@@ -36,6 +36,14 @@ use Doctrine\Common\Util\Inflector;
*/ */
class HelpTask extends AbstractTask class HelpTask extends AbstractTask
{ {
/**
* @inheritdoc
*/
public function buildDocumentation()
{
// Does nothing
}
/** /**
* @inheritdoc * @inheritdoc
*/ */
...@@ -77,11 +85,10 @@ class HelpTask extends AbstractTask ...@@ -77,11 +85,10 @@ class HelpTask extends AbstractTask
ksort($availableTasks); ksort($availableTasks);
foreach ($availableTasks as $taskName => $taskClass) { foreach ($availableTasks as $taskName => $taskClass) {
$task = new $taskClass(); $task = new $taskClass($this->getPrinter());
$task->setAvailableTasks($availableTasks); $task->setAvailableTasks($availableTasks);
$task->setEntityManager($this->getEntityManager()); $task->setEntityManager($this->getEntityManager());
$task->setPrinter($this->getPrinter());
$task->setArguments($this->getArguments()); $task->setArguments($this->getArguments());
$task->basicHelp(); $task->basicHelp();
......
lib/Doctrine/ORM/Tools/Cli/Tasks/RunDqlTask.php
View file @ 67665aa5
...@@ -22,7 +22,9 @@ ...@@ -22,7 +22,9 @@
namespace Doctrine\ORM\Tools\Cli\Tasks; namespace Doctrine\ORM\Tools\Cli\Tasks;
use Doctrine\Common\DoctrineException, use Doctrine\Common\DoctrineException,
Doctrine\Common\Util\Debug; Doctrine\Common\Util\Debug,
Doctrine\Common\Cli\Option,
Doctrine\Common\Cli\OptionGroup;
/** /**
* Task for executing DQL in passed EntityManager. * Task for executing DQL in passed EntityManager.
...@@ -40,36 +42,22 @@ class RunDqlTask extends AbstractTask ...@@ -40,36 +42,22 @@ class RunDqlTask extends AbstractTask
/** /**
* @inheritdoc * @inheritdoc
*/ */
public function extendedHelp() public function buildDocumentation()
{ {
$printer = $this->getPrinter(); $dql = new OptionGroup(OptionGroup::CARDINALITY_1_1, array(
new Option('dql', '<DQL>', 'The DQL to execute.')
$printer->write('Task: ')->writeln('run-dql', 'KEYWORD') ));
->write('Synopsis: ');
$this->_writeSynopsis($printer);
$printer->writeln('Description: Executes DQL in requested EntityManager.') $depth = new OptionGroup(OptionGroup::CARDINALITY_0_1, array(
->writeln('Options:') new Option('depth', '<DEPTH>', 'Dumping depth of Entities graph.')
->write('--dql=<DQL>', 'REQ_ARG') ));
->writeln("\tThe DQL to execute.")
->write(PHP_EOL)
->write('--depth=<DEPTH>', 'OPT_ARG')
->writeln("\tDumping depth of Entities graph.");
}
/**
* @inheritdoc
*/
public function basicHelp()
{
$this->_writeSynopsis($this->getPrinter());
}
private function _writeSynopsis($printer) $doc = $this->getDocumentation();
{ $doc->setName('run-dql')
$printer->write('run-dql', 'KEYWORD') ->setDescription('Executes arbitrary DQL directly from the command line.')
->write(' --dql=<DQL>', 'REQ_ARG') ->getOptionGroup()
->writeln(' --depth=<DEPTH>', 'OPT_ARG'); ->addOption($dql)
->addOption($depth);
} }
/** /**
......
lib/Doctrine/ORM/Tools/Cli/Tasks/RunSqlTask.php
View file @ 67665aa5
...@@ -22,7 +22,9 @@ ...@@ -22,7 +22,9 @@
namespace Doctrine\ORM\Tools\Cli\Tasks; namespace Doctrine\ORM\Tools\Cli\Tasks;
use Doctrine\Common\DoctrineException, use Doctrine\Common\DoctrineException,
Doctrine\Common\Util\Debug; Doctrine\Common\Util\Debug,
Doctrine\Common\Cli\Option,
Doctrine\Common\Cli\OptionGroup;
/** /**
* Task for executing arbitrary SQL that can come from a file or directly from * Task for executing arbitrary SQL that can come from a file or directly from
...@@ -41,41 +43,31 @@ class RunSqlTask extends AbstractTask ...@@ -41,41 +43,31 @@ class RunSqlTask extends AbstractTask
/** /**
* @inheritdoc * @inheritdoc
*/ */
public function extendedHelp() public function buildDocumentation()
{ {
$printer = $this->getPrinter(); $dqlAndFile = new OptionGroup(OptionGroup::CARDINALITY_1_1, array(
new Option(
$printer->write('Task: ')->writeln('run-sql', 'KEYWORD') 'sql', '<DQL>',
->write('Synopsis: '); 'The SQL to execute.' . PHP_EOL .
$this->_writeSynopsis($printer); 'If defined, --file can not be requested on same task.'
),
$printer->writeln('Description: Executes arbitrary SQL from a file or directly from the command line.') new Option(
->writeln('Options:') 'file', '<FILE_PATH>',
->write('--sql=<SQL>', 'REQ_ARG') 'The path to the file with the SQL to execute.' . PHP_EOL .
->writeln("\tThe SQL to execute.") 'If defined, --sql can not be requested on same task.'
->writeln("\t\tIf defined, --file can not be requested on same task") )
->write(PHP_EOL) ));
->write('--file=<path>', 'REQ_ARG')
->writeln("\tThe path to the file with the SQL to execute.") $depth = new OptionGroup(OptionGroup::CARDINALITY_0_1, array(
->writeln("\t\tIf defined, --sql can not be requested on same task") new Option('depth', '<DEPTH>', 'Dumping depth of Entities graph.')
->write(PHP_EOL) ));
->write('--depth=<DEPTH>', 'OPT_ARG')
->writeln("\tDumping depth of ResultSet graph."); $doc = $this->getDocumentation();
} $doc->setName('run-sql')
->setDescription('Executes arbitrary SQL from a file or directly from the command line.')
/** ->getOptionGroup()
* @inheritdoc ->addOption($dqlAndFile)
*/ ->addOption($depth);
public function basicHelp()
{
$this->_writeSynopsis($this->getPrinter());
}
private function _writeSynopsis($printer)
{
$printer->write('run-sql', 'KEYWORD')
->write(' (--file=<path> | --sql=<SQL>)', 'REQ_ARG')
->writeln(' --depth=<DEPTH>', 'OPT_ARG');
} }
/** /**
......
lib/Doctrine/ORM/Tools/Cli/Tasks/SchemaToolTask.php
View file @ 67665aa5
...@@ -3,6 +3,8 @@ ...@@ -3,6 +3,8 @@
namespace Doctrine\ORM\Tools\Cli\Tasks; namespace Doctrine\ORM\Tools\Cli\Tasks;
use Doctrine\Common\DoctrineException, use Doctrine\Common\DoctrineException,
Doctrine\Common\Cli\Option,
Doctrine\Common\Cli\OptionGroup,
Doctrine\ORM\Tools\SchemaTool, Doctrine\ORM\Tools\SchemaTool,
Doctrine\Common\Annotations\AnnotationReader, Doctrine\Common\Annotations\AnnotationReader,
Doctrine\ORM\Mapping\Driver\AnnotationDriver, Doctrine\ORM\Mapping\Driver\AnnotationDriver,
...@@ -46,7 +48,49 @@ class SchemaToolTask extends AbstractTask ...@@ -46,7 +48,49 @@ class SchemaToolTask extends AbstractTask
/** /**
* @inheritdoc * @inheritdoc
*/ */
public function extendedHelp() public function buildDocumentation()
{
$schemaOption = new OptionGroup(OptionGroup::CARDINALITY_1_1, array(
new Option(
'create', null,
'Creates the schema in EntityManager (create tables on Database).' . PHP_EOL .
'If defined, --drop, --update and --re-create can not be requested on same task.'
),
new Option(
'drop', '<metadata|database>',
'Drops the schema of EntityManager (drop tables on Database).' . PHP_EOL .
'Defaults to "metadata" if only --drop is specified.' . PHP_EOL .
'If defined, --create, --update and --re-create can not be requested on same task.'
),
new Option(
'update', null,
'Updates the schema in EntityManager (update tables on Database).' . PHP_EOL .
'If defined, --create, --drop and --re-create can not be requested on same task.'
),
new Option(
're-create', null,
'Runs --drop then --create to re-create the database.' . PHP_EOL .
'If defined, --create, --update and --drop can not be requested on same task.'
)
));
$optionalOptions = new OptionGroup(OptionGroup::CARDINALITY_0_N, array(
new Option('dump-sql', null, 'Instead of try to apply generated SQLs into EntityManager, output them.'),
new Option('class-dir', '<PATH>', 'Optional class directory to fetch for Entities.')
));
$doc = $this->getDocumentation();
$doc->setName('schema-tool')
->setDescription('Processes the schema and either apply it directly on EntityManager or generate the SQL output.')
->getOptionGroup()
->addOption($schemaOption)
->addOption($optionalOptions);
}
/**
* @inheritdoc
*/
/*public function extendedHelp()
{ {
$printer = $this->getPrinter(); $printer = $this->getPrinter();
...@@ -78,12 +122,12 @@ class SchemaToolTask extends AbstractTask ...@@ -78,12 +122,12 @@ class SchemaToolTask extends AbstractTask
->write('--class-dir=<path>', 'OPT_ARG') ->write('--class-dir=<path>', 'OPT_ARG')
->writeln("\tOptional class directory to fetch for Entities.") ->writeln("\tOptional class directory to fetch for Entities.")
->write(PHP_EOL); ->write(PHP_EOL);
} }*/
/** /**
* @inheritdoc * @inheritdoc
*/ */
public function basicHelp() /*public function basicHelp()
{ {
$this->_writeSynopsis($this->getPrinter()); $this->_writeSynopsis($this->getPrinter());
} }
...@@ -93,7 +137,7 @@ class SchemaToolTask extends AbstractTask ...@@ -93,7 +137,7 @@ class SchemaToolTask extends AbstractTask
$printer->write('schema-tool', 'KEYWORD') $printer->write('schema-tool', 'KEYWORD')
->write(' (--create | --drop=<metadata|database> | --update | --re-create)', 'REQ_ARG') ->write(' (--create | --drop=<metadata|database> | --update | --re-create)', 'REQ_ARG')
->writeln(' [--dump-sql] [--class-dir=<path>]', 'OPT_ARG'); ->writeln(' [--dump-sql] [--class-dir=<path>]', 'OPT_ARG');
} }*/
/** /**
* @inheritdoc * @inheritdoc
......
lib/Doctrine/ORM/Tools/Cli/Tasks/VersionTask.php
View file @ 67665aa5
...@@ -37,30 +37,14 @@ class VersionTask extends AbstractTask ...@@ -37,30 +37,14 @@ class VersionTask extends AbstractTask
/** /**
* @inheritdoc * @inheritdoc
*/ */
public function extendedHelp() public function buildDocumentation()
{ {
$printer = $this->getPrinter(); // There're no options on this task
$this->getDocumentation()->getOptionGroup()->clear();
$printer->write('Task: ')->writeln('version', 'KEYWORD') $doc = $this->getDocumentation();
->write('Synopsis: '); $doc->setName('version')
$this->_writeSynopsis($printer); ->setDescription('Displays the current installed Doctrine version.');
$printer->writeln('Description: Displays the current installed Doctrine version.')
->writeln('Options:')
->writeln('No available options', 'INFO');
}
/**
* @inheritdoc
*/
public function basicHelp()
{
$this->_writeSynopsis($this->getPrinter());
}
private function _writeSynopsis($printer)
{
$printer->writeln('version', 'KEYWORD');
} }
/** /**
...@@ -77,6 +61,6 @@ class VersionTask extends AbstractTask ...@@ -77,6 +61,6 @@ class VersionTask extends AbstractTask
*/ */
public function run() public function run()
{ {
$this->getPrinter()->writeln('You are currently running Doctrine 2.0.0 Alpha 3', 'INFO'); $this->getPrinter()->writeln('You are currently running Doctrine 2.0.0 Alpha 4', 'INFO');
} }
} }
\ No newline at end of file
tools/sandbox/doctrine.php
View file @ 67665aa5
...@@ -6,5 +6,5 @@ $classLoader = new \Doctrine\Common\IsolatedClassLoader('Doctrine'); ...@@ -6,5 +6,5 @@ $classLoader = new \Doctrine\Common\IsolatedClassLoader('Doctrine');
$classLoader->setBasePath(__DIR__ . '/../../lib'); $classLoader->setBasePath(__DIR__ . '/../../lib');
$classLoader->register(); $classLoader->register();
$cli = new \Doctrine\ORM\Tools\Cli(); $cli = new \Doctrine\ORM\Tools\Cli\CliController();
$cli->run($_SERVER['argv']); $cli->run($_SERVER['argv']);
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment