1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
|
<?php
declare(strict_types=1);
namespace Doctrine\ORM\Tools\Console;
use Doctrine\DBAL\Tools\Console as DBALConsole;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\Tools\Console\EntityManagerProvider\ConnectionFromManagerProvider;
use Doctrine\ORM\Tools\Console\EntityManagerProvider\HelperSetManagerProvider;
use Doctrine\ORM\Tools\Console\Helper\EntityManagerHelper;
use Doctrine\ORM\Version;
use OutOfBoundsException;
use Symfony\Component\Console\Application;
use Symfony\Component\Console\Command\Command as SymfonyCommand;
use Symfony\Component\Console\Helper\HelperSet;
use function assert;
use function class_exists;
/**
* Handles running the Console Tools inside Symfony Console context.
*/
final class ConsoleRunner
{
/**
* Create a Symfony Console HelperSet
*
* @deprecated This method will be removed in ORM 3.0 without replacement.
*/
public static function createHelperSet(EntityManagerInterface $entityManager): HelperSet
{
$helpers = ['em' => new EntityManagerHelper($entityManager)];
if (class_exists(DBALConsole\Helper\ConnectionHelper::class)) {
$helpers['db'] = new DBALConsole\Helper\ConnectionHelper($entityManager->getConnection());
}
return new HelperSet($helpers);
}
/**
* Runs console with the given helper set.
*
* @param HelperSet|EntityManagerProvider $helperSetOrProvider
* @param SymfonyCommand[] $commands
*/
public static function run($helperSetOrProvider, array $commands = []): void
{
$cli = self::createApplication($helperSetOrProvider, $commands);
$cli->run();
}
/**
* Creates a console application with the given helperset and
* optional commands.
*
* @param HelperSet|EntityManagerProvider $helperSetOrProvider
* @param SymfonyCommand[] $commands
*
* @throws OutOfBoundsException
*/
public static function createApplication($helperSetOrProvider, array $commands = []): Application
{
$version = Version::VERSION;
assert($version !== null);
$cli = new Application('Doctrine Command Line Interface', $version);
$cli->setCatchExceptions(true);
if ($helperSetOrProvider instanceof HelperSet) {
$cli->setHelperSet($helperSetOrProvider);
$helperSetOrProvider = new HelperSetManagerProvider($helperSetOrProvider);
}
self::addCommands($cli, $helperSetOrProvider);
$cli->addCommands($commands);
return $cli;
}
public static function addCommands(Application $cli, ?EntityManagerProvider $entityManagerProvider = null): void
{
if ($entityManagerProvider === null) {
$entityManagerProvider = new HelperSetManagerProvider($cli->getHelperSet());
}
$connectionProvider = new ConnectionFromManagerProvider($entityManagerProvider);
if (class_exists(DBALConsole\Command\ImportCommand::class)) {
$cli->add(new DBALConsole\Command\ImportCommand());
}
$cli->addCommands(
[
// DBAL Commands
new DBALConsole\Command\ReservedWordsCommand($connectionProvider),
new DBALConsole\Command\RunSqlCommand($connectionProvider),
// ORM Commands
new Command\ClearCache\CollectionRegionCommand($entityManagerProvider),
new Command\ClearCache\EntityRegionCommand($entityManagerProvider),
new Command\ClearCache\MetadataCommand($entityManagerProvider),
new Command\ClearCache\QueryCommand($entityManagerProvider),
new Command\ClearCache\QueryRegionCommand($entityManagerProvider),
new Command\ClearCache\ResultCommand($entityManagerProvider),
new Command\SchemaTool\CreateCommand($entityManagerProvider),
new Command\SchemaTool\UpdateCommand($entityManagerProvider),
new Command\SchemaTool\DropCommand($entityManagerProvider),
new Command\EnsureProductionSettingsCommand($entityManagerProvider),
new Command\ConvertDoctrine1SchemaCommand(),
new Command\GenerateRepositoriesCommand($entityManagerProvider),
new Command\GenerateEntitiesCommand($entityManagerProvider),
new Command\GenerateProxiesCommand($entityManagerProvider),
new Command\ConvertMappingCommand($entityManagerProvider),
new Command\RunDqlCommand($entityManagerProvider),
new Command\ValidateSchemaCommand($entityManagerProvider),
new Command\InfoCommand($entityManagerProvider),
new Command\MappingDescribeCommand($entityManagerProvider),
]
);
}
/** @deprecated This method will be removed in ORM 3.0 without replacement. */
public static function printCliConfigTemplate(): void
{
echo <<<'HELP'
You are missing a "cli-config.php" or "config/cli-config.php" file in your
project, which is required to get the Doctrine Console working. You can use the
following sample as a template:
<?php
use Doctrine\ORM\Tools\Console\ConsoleRunner;
// replace with file to your own project bootstrap
require_once 'bootstrap.php';
// replace with mechanism to retrieve EntityManager in your app
$entityManager = GetEntityManager();
return ConsoleRunner::createHelperSet($entityManager);
HELP;
}
}
|