class QuickStartCommand

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Command/QuickStartCommand.php \Drupal\Core\Command\QuickStartCommand
  2. 10 core/lib/Drupal/Core/Command/QuickStartCommand.php \Drupal\Core\Command\QuickStartCommand
  3. 9 core/lib/Drupal/Core/Command/QuickStartCommand.php \Drupal\Core\Command\QuickStartCommand
  4. 8.9.x core/lib/Drupal/Core/Command/QuickStartCommand.php \Drupal\Core\Command\QuickStartCommand

Installs a Drupal site and starts a webserver for local testing/development.

Wraps 'install' and 'server' commands.

This is not meant for production. It can be used as a quick and easy way to create a Drupal test site.

@internal This command makes no guarantee of an API for Drupal extensions.

Attributes

#[AsCommand(name: 'quick-start', description: 'Installs a Drupal site and starts a web server for local testing or development.', usages: [ 'demo_umami --langcode fr', 'standard --site-name QuickInstall --host localhost --port 8080', 'minimal --host my-site.com --port 80', 'core/recipes/standard --site-name MyDrupalRecipe', ])]

Hierarchy

Expanded class hierarchy of QuickStartCommand

See also

\Drupal\Core\Command\InstallCommand

\Drupal\Core\Command\ServerCommand

File

View on git.drupalcode.org

core/lib/Drupal/Core/Command/QuickStartCommand.php, line 28

Namespace

Drupal\Core\Command
View source 
class QuickStartCommand {
  
  /**
   * Installs a Drupal site and starts a webserver for local development.
   */
  public function __invoke(Application $application, OutputInterface $output, #[Argument('Install profile or recipe directory from which to install the site.')] #[Ask('Install profile or recipe directory', 'standard')] string $install_profile_or_recipe, #[Option('The language to install the site in. Defaults to \'en\'.')] string $langcode = 'en', #[Option('Set the administrator password. Defaults to a randomly generated password.')] ?string $password = NULL, #[Option('Set the site name.')] string $site_name = 'Drupal', #[Option('Provide a host for the server to run on.')] string $host = '127.0.0.1', #[Option('Provide a port for the server to run on (determined automatically if none is supplied).')] ?string $port = NULL, #[Option('Disable opening a login URL in a browser.', '', 's')] bool $suppress_login = FALSE) : int {
    $command = $application->find('install');
    $arguments = [
      'command' => 'install',
      'install-profile-or-recipe' => $install_profile_or_recipe,
      '--langcode' => $langcode,
      '--password' => $password,
      '--site-name' => $site_name,
    ];
    $installInput = new ArrayInput($arguments);
    $returnCode = $command->run($installInput, $output);
    if ($returnCode === 0) {
      $command = $application->find('server');
      $arguments = [
        'command' => 'server',
        '--host' => $host,
        '--port' => $port,
      ];
      if ($suppress_login) {
        $arguments['--suppress-login'] = TRUE;
      }
      $serverInput = new ArrayInput($arguments);
      $returnCode = $command->run($serverInput, $output);
    }
    return $returnCode;
  }

}

Members

Title Modifiers Object type Summary
QuickStartCommand::__invoke public function Installs a Drupal site and starts a webserver for local development.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.