Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. HomeCommand.php

class HomeCommand

@author Robert Schönthal <seroscho@googlemail.com>

Hierarchy

  • class \Symfony\Component\Console\Command\Command
    • class \Composer\Command\BaseCommand extends \Symfony\Component\Console\Command\Command
      • class \Composer\Command\HomeCommand extends \Composer\Command\BaseCommand uses \Composer\Command\CompletionTrait

Expanded class hierarchy of HomeCommand

File

vendor/composer/composer/src/Composer/Command/HomeCommand.php, line 29

Namespace

Composer\Command
View source
class HomeCommand extends BaseCommand {
    use CompletionTrait;
    
    /**
     * @inheritDoc
     */
    protected function configure() : void {
        $this->setName('browse')
            ->setAliases([
            'home',
        ])
            ->setDescription('Opens the package\'s repository URL or homepage in your browser')
            ->setDefinition([
            new InputArgument('packages', InputArgument::IS_ARRAY, 'Package(s) to browse to.', null, $this->suggestInstalledPackage()),
            new InputOption('homepage', 'H', InputOption::VALUE_NONE, 'Open the homepage instead of the repository URL.'),
            new InputOption('show', 's', InputOption::VALUE_NONE, 'Only show the homepage or repository URL.'),
        ])
            ->setHelp(<<<EOT
The home command opens or shows a package's repository URL or
homepage in your default browser.

To open the homepage by default, use -H or --homepage.
To show instead of open the repository or homepage URL, use -s or --show.

Read more at https://getcomposer.org/doc/03-cli.md#browse-home
EOT
);
    }
    protected function execute(InputInterface $input, OutputInterface $output) : int {
        $repos = $this->initializeRepos();
        $io = $this->getIO();
        $return = 0;
        $packages = $input->getArgument('packages');
        if (count($packages) === 0) {
            $io->writeError('No package specified, opening homepage for the root package');
            $packages = [
                $this->requireComposer()
                    ->getPackage()
                    ->getName(),
            ];
        }
        foreach ($packages as $packageName) {
            $handled = false;
            $packageExists = false;
            foreach ($repos as $repo) {
                foreach ($repo->findPackages($packageName) as $package) {
                    $packageExists = true;
                    if ($package instanceof CompletePackageInterface && $this->handlePackage($package, $input->getOption('homepage'), $input->getOption('show'))) {
                        $handled = true;
                        break 2;
                    }
                }
            }
            if (!$packageExists) {
                $return = 1;
                $io->writeError('<warning>Package ' . $packageName . ' not found</warning>');
            }
            if (!$handled) {
                $return = 1;
                $io->writeError('<warning>' . ($input->getOption('homepage') ? 'Invalid or missing homepage' : 'Invalid or missing repository URL') . ' for ' . $packageName . '</warning>');
            }
        }
        return $return;
    }
    private function handlePackage(CompletePackageInterface $package, bool $showHomepage, bool $showOnly) : bool {
        $support = $package->getSupport();
        $url = $support['source'] ?? $package->getSourceUrl();
        if (!$url || $showHomepage) {
            $url = $package->getHomepage();
        }
        if (!$url || !filter_var($url, FILTER_VALIDATE_URL)) {
            return false;
        }
        if ($showOnly) {
            $this->getIO()
                ->write(sprintf('<info>%s</info>', $url));
        }
        else {
            $this->openBrowser($url);
        }
        return true;
    }
    
    /**
     * opens a url in your system default browser
     */
    private function openBrowser(string $url) : void {
        $process = new ProcessExecutor($this->getIO());
        if (Platform::isWindows()) {
            $process->execute([
                'start',
                '"web"',
                'explorer',
                $url,
            ], $output);
            return;
        }
        $linux = $process->execute([
            'which',
            'xdg-open',
        ], $output);
        $osx = $process->execute([
            'which',
            'open',
        ], $output);
        if (0 === $linux) {
            $process->execute([
                'xdg-open',
                $url,
            ], $output);
        }
        elseif (0 === $osx) {
            $process->execute([
                'open',
                $url,
            ], $output);
        }
        else {
            $this->getIO()
                ->writeError('No suitable browser opening command found, open yourself: ' . $url);
        }
    }
    
    /**
     * Initializes repositories
     *
     * Returns an array of repos in order they should be checked in
     *
     * @return RepositoryInterface[]
     */
    private function initializeRepos() : array {
        $composer = $this->tryComposer();
        if ($composer) {
            return array_merge([
                new RootPackageRepository(clone $composer->getPackage()),
            ], [
                $composer->getRepositoryManager()
                    ->getLocalRepository(),
            ], $composer->getRepositoryManager()
                ->getRepositories());
        }
        return RepositoryFactory::defaultReposWithDefaultManager($this->getIO());
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
BaseCommand::$composer private property
BaseCommand::$io private property
BaseCommand::complete public function @inheritdoc Overrides Command::complete 1
BaseCommand::createComposerInstance protected function Calls {
BaseCommand::formatRequirements protected function
BaseCommand::getApplication public function Gets the application instance for this command. Overrides Command::getApplication
BaseCommand::getAuditFormat protected function @internal
BaseCommand::getComposer Deprecated public function
BaseCommand::getIO public function
BaseCommand::getPlatformRequirementFilter protected function
BaseCommand::getPreferredInstallOptions protected function Returns preferSource and preferDist values based on the configuration.
BaseCommand::getTerminalWidth protected function
BaseCommand::initialize protected function @inheritDoc Overrides Command::initialize 1
BaseCommand::isProxyCommand public function Whether or not this command is meant to call another command. 2
BaseCommand::normalizeRequirements protected function
BaseCommand::renderTable protected function
BaseCommand::resetComposer public function Removes the cached composer instance
BaseCommand::setComposer public function
BaseCommand::setIO public function
BaseCommand::tryComposer public function Retrieves the default Composer\Composer instance or null
Command::$aliases private property 1
Command::$application private property
Command::$code private property
Command::$definition private property
Command::$description private property 1
Command::$fullDefinition private property
Command::$help private property
Command::$helperSet private property
Command::$hidden private property
Command::$ignoreValidationErrors private property 2
Command::$name private property
Command::$processTitle private property
Command::$synopsis private property
Command::$usages private property
Command::addArgument public function Adds an argument. 2
Command::addOption public function Adds an option. 2
Command::addUsage public function Add a command usage example, it&#039;ll be prefixed with the command name. 2
Command::FAILURE public constant
Command::getAliases public function Returns the aliases for the command.
Command::getDefaultDescription public static function
Command::getDefaultName public static function
Command::getDefinition public function Gets the InputDefinition attached to this Command. 2
Command::getDescription public function Returns the description for the command.
Command::getHelp public function Returns the help for the command. 2
Command::getHelper public function Gets a helper instance by name. 2
Command::getHelperSet public function Gets the helper set. 1
Command::getName public function Returns the command name.
Command::getNativeDefinition public function Gets the InputDefinition to be used to create representations of this Command. 2
Command::getProcessedHelp public function Returns the processed help for the command replacing the %command.name% and
%command.full_name% patterns with the real values dynamically.
2
Command::getSynopsis public function Returns the synopsis for the command. 2
Command::getUsages public function Returns alternative usages of the command. 2
Command::ignoreValidationErrors public function Ignores validation errors. 2
Command::interact protected function Interacts with the user. 5
Command::INVALID public constant
Command::isEnabled public function Checks whether the command is enabled or not in the current environment. 2
Command::isHidden public function
Command::mergeApplicationDefinition public function Merges the application definition with the command definition. 2
Command::run public function Runs the command. 4
Command::setAliases public function Sets the aliases for the command.
Command::setApplication public function 2
Command::setCode public function Sets the code to execute when running this command. 2
Command::setDefinition public function Sets an array of argument and option instances. 2
Command::setDescription public function Sets the description for the command.
Command::setHelp public function Sets the help for the command. 2
Command::setHelperSet public function 2
Command::setHidden public function
Command::setName public function Sets the name of the command.
Command::setProcessTitle public function Sets the process title of the command. 2
Command::SUCCESS public constant
Command::validateName private function Validates a command name.
Command::__construct public function 15
CompletionTrait::requireComposer abstract public function
CompletionTrait::suggestAvailablePackage private function Suggest package names available on all configured repositories.
CompletionTrait::suggestAvailablePackageInclPlatform private function Suggest package names available on all configured repositories or
platform packages from the ones available on the currently-running PHP
CompletionTrait::suggestInstalledPackage private function Suggest package names from installed.
CompletionTrait::suggestInstalledPackageTypes private function Suggest package names from installed.
CompletionTrait::suggestPlatformPackage private function Suggest platform packages from the ones available on the currently-running PHP
CompletionTrait::suggestPreferInstall private function Suggestion values for &quot;prefer-install&quot; option
CompletionTrait::suggestRootRequirement private function Suggest package names from root requirements.
HomeCommand::configure protected function @inheritDoc Overrides Command::configure
HomeCommand::execute protected function Executes the current command. Overrides Command::execute
HomeCommand::handlePackage private function
HomeCommand::initializeRepos private function Initializes repositories
HomeCommand::openBrowser private function opens a url in your system default browser

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal