ConsoleRunner.php 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  1. <?php
  2. /*
  3. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  4. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  5. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  6. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  7. * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  8. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  9. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  10. * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  11. * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  12. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  13. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. *
  15. * This software consists of voluntary contributions made by many individuals
  16. * and is licensed under the MIT license. For more information, see
  17. * <http://www.doctrine-project.org>.
  18. */
  19. namespace Doctrine\DBAL\Tools\Console;
  20. use Doctrine\DBAL\Connection;
  21. use Doctrine\DBAL\Tools\Console\Command\ImportCommand;
  22. use Doctrine\DBAL\Tools\Console\Command\ReservedWordsCommand;
  23. use Doctrine\DBAL\Tools\Console\Command\RunSqlCommand;
  24. use Symfony\Component\Console\Helper\HelperSet;
  25. use Doctrine\DBAL\Tools\Console\Helper\ConnectionHelper;
  26. use Symfony\Component\Console\Application;
  27. use Doctrine\DBAL\Version;
  28. /**
  29. * Handles running the Console Tools inside Symfony Console context.
  30. */
  31. class ConsoleRunner
  32. {
  33. /**
  34. * Create a Symfony Console HelperSet
  35. *
  36. * @param Connection $connection
  37. *
  38. * @return HelperSet
  39. */
  40. static public function createHelperSet(Connection $connection)
  41. {
  42. return new HelperSet(array(
  43. 'db' => new ConnectionHelper($connection)
  44. ));
  45. }
  46. /**
  47. * Runs console with the given helperset.
  48. *
  49. * @param \Symfony\Component\Console\Helper\HelperSet $helperSet
  50. * @param \Symfony\Component\Console\Command\Command[] $commands
  51. *
  52. * @return void
  53. */
  54. static public function run(HelperSet $helperSet, $commands = array())
  55. {
  56. $cli = new Application('Doctrine Command Line Interface', Version::VERSION);
  57. $cli->setCatchExceptions(true);
  58. $cli->setHelperSet($helperSet);
  59. self::addCommands($cli);
  60. $cli->addCommands($commands);
  61. $cli->run();
  62. }
  63. /**
  64. * @param Application $cli
  65. *
  66. * @return void
  67. */
  68. static public function addCommands(Application $cli)
  69. {
  70. $cli->addCommands(array(
  71. new RunSqlCommand(),
  72. new ImportCommand(),
  73. new ReservedWordsCommand(),
  74. ));
  75. }
  76. /**
  77. * Prints the instructions to create a configuration file
  78. */
  79. static public function printCliConfigTemplate()
  80. {
  81. echo <<<'HELP'
  82. You are missing a "cli-config.php" or "config/cli-config.php" file in your
  83. project, which is required to get the Doctrine-DBAL Console working. You can use the
  84. following sample as a template:
  85. <?php
  86. use Doctrine\DBAL\Tools\Console\ConsoleRunner;
  87. // replace with the mechanism to retrieve DBAL connection in your app
  88. $connection = getDBALConnection();
  89. // You can append new commands to $commands array, if needed
  90. return ConsoleRunner::createHelperSet($connection);
  91. HELP;
  92. }
  93. }