/**
* Validate the given module name or ask the user to select a module from a list of installed modules.
*
* <p>This method is available to console tasks only.
*
* @param string $moduleName A variable reference. If empty, it will be set to the selected module name.
* @param callable $filter Display only modules that match a filtering condition.
* <p>Callback syntax: <code>function (ModuleInfo $module):bool</code>
* @param bool $suppressErrors Do not abort execution with an error message if the module name is not valid.
* @return bool false if the specified module name does not match an installed module
* @internal param bool $onlyEnabled Display only modules that are enabled.
*/
function selectModule(&$moduleName, callable $filter = null, $suppressErrors = false)
{
if ($moduleName) {
if (!ModulesRegistry::validateModuleName($moduleName)) {
if ($suppressErrors) {
return false;
}
$this->io->error("Invalid module name {$moduleName}. Correct syntax: vendor-name/product-name");
}
if (!$this->registry->isInstalled($moduleName)) {
if ($suppressErrors) {
return false;
}
$this->io->error("Module {$moduleName} is not installed");
}
if ($filter && !$filter($this->registry->getModule($moduleName))) {
if ($suppressErrors) {
return false;
}
$this->io->error("Module {$moduleName} can't be renamed");
}
} else {
$modules = $this->registry->onlyPrivateOrPlugins()->only($filter)->getModuleNames();
if ($modules) {
$i = $this->io->menu("Select a module:", $modules);
if ($i < 0) {
$this->io->cancel();
}
$moduleName = $modules[$i];
} else {
if ($suppressErrors) {
return false;
}
$this->io->error("No modules are available");
}
}
return true;
}
