vendor/symfony/web-server-bundle/Command/ServerStatusCommand.php line 37

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Bundle\WebServerBundle\Command;
  14. use Symfony\Bundle\WebServerBundle\WebServer;
  15. use Symfony\Component\Console\Command\Command;
  16. use Symfony\Component\Console\Exception\InvalidArgumentException;
  17. use Symfony\Component\Console\Input\InputInterface;
  18. use Symfony\Component\Console\Input\InputOption;
  19. use Symfony\Component\Console\Output\ConsoleOutputInterface;
  20. use Symfony\Component\Console\Output\OutputInterface;
  21. use Symfony\Component\Console\Style\SymfonyStyle;
  23. /**
  24.  * Shows the status of a process that is running PHP's built-in web server in
  25.  * the background.
  26.  *
  27.  * @author Christian Flothmann <christian.flothmann@xabbuh.de>
  28.  *
  29.  * @deprecated since Symfony 4.4, to be removed in 5.0; the new Symfony local server has more features, you can use it instead.
  30.  */
  31. class ServerStatusCommand extends Command
  32. {
  33.     protected static $defaultName = 'server:status';
  35.     private $pidFileDirectory;
  37.     public function __construct(string $pidFileDirectory = null)
  38.     {
  39.         $this->pidFileDirectory = $pidFileDirectory;
  41.         parent::__construct();
  42.     }
  44.     /**
  45.      * {@inheritdoc}
  46.      */
  47.     protected function configure()
  48.     {
  49.         $this
  50.             ->setDefinition([
  51.                 new InputOption('pidfile', null, InputOption::VALUE_REQUIRED, 'PID file'),
  52.                 new InputOption('filter', null, InputOption::VALUE_REQUIRED, 'The value to display (one of port, host, or address)'),
  53.             ])
  54.             ->setDescription('Output the status of the local web server')
  55.             ->setHelp(<<<'EOF'
  56. <info>%command.name%</info> shows the details of the given local web
  57. server, such as the address and port where it is listening to:
  59.   <info>php %command.full_name%</info>
  61. To get the information as a machine readable format, use the
  62. <comment>--filter</> option:
  64. <info>php %command.full_name% --filter=port</info>
  66. Supported values are <comment>port</>, <comment>host</>, and <comment>address</>.
  67. EOF
  68.             )
  69.         ;
  70.     }
  72.     /**
  73.      * {@inheritdoc}
  74.      */
  75.     protected function execute(InputInterface $input, OutputInterface $output)
  76.     {
  77.         @trigger_error('Using the WebserverBundle is deprecated since Symfony 4.4. The new Symfony local server has more features, you can use it instead.', \E_USER_DEPRECATED);
  79.         $io = new SymfonyStyle($input, $output instanceof ConsoleOutputInterface ? $output->getErrorOutput() : $output);
  80.         $server = new WebServer($this->pidFileDirectory);
  81.         if ($filter = $input->getOption('filter')) {
  82.             if ($server->isRunning($input->getOption('pidfile'))) {
  83.                 [$host, $port] = explode(':', $address = $server->getAddress($input->getOption('pidfile')));
  84.                 if ('address' === $filter) {
  85.                     $output->write($address);
  86.                 } elseif ('host' === $filter) {
  87.                     $output->write($host);
  88.                 } elseif ('port' === $filter) {
  89.                     $output->write($port);
  90.                 } else {
  91.                     throw new InvalidArgumentException(sprintf('"%s" is not a valid filter.', $filter));
  92.                 }
  93.             } else {
  94.                 return 1;
  95.             }
  96.         } else {
  97.             if ($server->isRunning($input->getOption('pidfile'))) {
  98.                 $io->success(sprintf('Web server still listening on http://%s', $server->getAddress($input->getOption('pidfile'))));
  99.             } else {
  100.                 $io->warning('No web server is listening.');
  102.                 return 1;
  103.             }
  104.         }
  106.         return 0;
  107.     }
  108. }