class DevelCommands
Same name in this branch
- 5.x src/Drush/Commands/DevelCommands.php \Drupal\devel\Drush\Commands\DevelCommands
Same name in other branches
- 8.x-1.x src/Commands/DevelCommands.php \Drupal\devel\Commands\DevelCommands
- 4.x src/Commands/DevelCommands.php \Drupal\devel\Commands\DevelCommands
Class DevelCommands.
For commands that are parts of modules, Drush expects to find commandfiles in __MODULE__/src/Commands, and the namespace is Drupal/__MODULE__/Commands.
In addition to a commandfile like this one, you need to add a drush.services.yml in root of your module like this module does.
Hierarchy
- class \Drupal\devel\Commands\DevelCommands extends \Drush\Commands\DrushCommands implements \Drush\SiteAlias\SiteAliasManagerAwareInterface uses \Consolidation\SiteAlias\SiteAliasManagerAwareTrait, \Drush\Exec\ExecTrait
Expanded class hierarchy of DevelCommands
1 string reference to 'DevelCommands'
1 service uses DevelCommands
File
-
src/
Commands/ DevelCommands.php, line 30
Namespace
Drupal\devel\CommandsView source
class DevelCommands extends DrushCommands implements SiteAliasManagerAwareInterface {
use SiteAliasManagerAwareTrait;
use ExecTrait;
protected Token $token;
protected ContainerInterface $container;
protected EventDispatcherInterface $eventDispatcher;
protected ModuleHandlerInterface $moduleHandler;
/**
* Constructs a new DevelCommands object.
*/
public function __construct(Token $token, $container, $eventDispatcher, $moduleHandler) {
parent::__construct();
$this->token = $token;
$this->container = $container;
$this->eventDispatcher = $eventDispatcher;
$this->moduleHandler = $moduleHandler;
}
/**
* Gets the module handler.
*
* @return \Drupal\Core\Extension\ModuleHandlerInterface
* The moduleHandler.
*/
public function getModuleHandler() {
return $this->moduleHandler;
}
/**
* Gets the event dispatcher.
*
* @return mixed
* The eventDispatcher.
*/
public function getEventDispatcher() {
return $this->eventDispatcher;
}
/**
* Gets the container.
*
* @return mixed
* The container.
*/
public function getContainer() {
return $this->container;
}
/**
* Gets the token.
*
* @return \Drupal\Core\Utility\Token
* The token.
*/
public function getToken() {
return $this->token;
}
/**
* Uninstall, and Install modules.
*
* @command devel:reinstall
* @aliases dre,devel-reinstall
* @allow-additional-options pm-uninstall,pm-enable
*
* @param string $modules
* A comma-separated list of module names.
*/
public function reinstall($modules) {
$modules = StringUtils::csvToArray($modules);
$modules_str = implode(',', $modules);
$process = $this->processManager()
->drush($this->siteAliasManager()
->getSelf(), 'pm:uninstall', [
$modules_str,
]);
$process->mustRun();
$process = $this->processManager()
->drush($this->siteAliasManager()
->getSelf(), 'pm:enable', [
$modules_str,
]);
$process->mustRun();
}
/**
* List implementations of a given hook and optionally edit one.
*
* @command devel:hook
*
* @param string $hook
* The name of the hook to explore.
* @param string $implementation
* The name of the implementation to edit. Usually omitted.
*
* @usage devel-hook cron
* List implementations of hook_cron().
* @aliases fnh,fn-hook,hook,devel-hook
* @optionset_get_editor
*/
public function hook($hook, $implementation) {
// Get implementations in the .install files as well.
include_once './core/includes/install.inc';
drupal_load_updates();
$info = $this->codeLocate($implementation . "_{$hook}");
$exec = self::getEditor('');
$cmd = sprintf($exec, Escape::shellArg($info['file']));
$process = $this->processManager()
->shell($cmd);
$process->setTty(TRUE);
$process->mustRun();
}
/**
* Asks the user to select a hook implementation.
*
* @hook interact hook
*/
public function hookInteract(Input $input, Output $output) {
$hook_implementations = [];
if (!$input->getArgument('implementation')) {
foreach ($this->getModuleHandler()
->getModuleList() as $key => $extension) {
if ($this->getModuleHandler()
->hasImplementations($input->getArgument('hook'), [
$key,
])) {
$hook_implementations[] = $key;
}
}
if ($hook_implementations) {
if (!($choice = $this->io()
->choice('Enter the number of the hook implementation you wish to view.', array_combine($hook_implementations, $hook_implementations)))) {
throw new UserAbortException();
}
$input->setArgument('implementation', $choice);
}
else {
throw new \Exception(dt('No implementations'));
}
}
}
/**
* List implementations of a given event and optionally edit one.
*
* @command devel:event
*
* @param string $event
* The name of the event to explore. If omitted, a list of events is shown.
* @param string $implementation
* The name of the implementation to show. Usually omitted.
*
* @usage devel-event
* Pick a Kernel event, then pick an implementation, and then view its
* source code.
* @usage devel-event kernel.terminate
* Pick a terminate subscribers implementation and view its source code.
* @aliases fne,fn-event,event
*/
public function event($event, $implementation) {
$info = $this->codeLocate($implementation);
$exec = self::getEditor('');
$cmd = sprintf($exec, Escape::shellArg($info['file']));
$process = $this->processManager()
->shell($cmd);
$process->setTty(TRUE);
$process->mustRun();
}
/**
* Asks the user to select an event and the event's implementation.
*
* @hook interact devel:event
*/
public function interactEvent(Input $input, Output $output) {
$dispatcher = $this->getEventDispatcher();
$event = $input->getArgument('event');
if (!$event) {
// @todo Expand this list.
$events = [
'kernel.controller',
'kernel.exception',
'kernel.request',
'kernel.response',
'kernel.terminate',
'kernel.view',
];
$events = array_combine($events, $events);
if (!($event = $this->io()
->choice('Enter the event you wish to explore.', $events))) {
throw new UserAbortException();
}
$input->setArgument('event', $event);
}
if ($implementations = $dispatcher->getListeners($event)) {
foreach ($implementations as $implementation) {
$callable = get_class($implementation[0]) . '::' . $implementation[1];
$choices[$callable] = $callable;
}
if (!($choice = $this->io()
->choice('Enter the number of the implementation you wish to view.', $choices))) {
throw new UserAbortException();
}
$input->setArgument('implementation', $choice);
}
else {
throw new \Exception(dt('No implementations.'));
}
}
/**
* List available tokens.
*
* @command devel:token
* @aliases token,devel-token
* @field-labels
* group: Group
* token: Token
* name: Name
* @default-fields group,token,name
*
* @return \Consolidation\OutputFormatters\StructuredData\RowsOfFields
* The tokens structured in a RowsOfFields object.
*/
public function token($options = [
'format' => 'table',
]) {
$all = $this->getToken()
->getInfo();
foreach ($all['tokens'] as $group => $tokens) {
foreach ($tokens as $key => $token) {
$rows[] = [
'group' => $group,
'token' => $key,
'name' => $token['name'],
];
}
}
return new RowsOfFields($rows);
}
/**
* Generate a Universally Unique Identifier (UUID).
*
* @command devel:uuid
* @aliases uuid,devel-uuid
* @usage drush devel-uuid
*
* @return string
* The generated uuid.
*/
public function uuid() {
$uuid = new Php();
return $uuid->generate();
}
/**
* Get source code line for specified function or method.
*/
public function codeLocate($function_name) {
// Get implementations in the .install files as well.
include_once './core/includes/install.inc';
drupal_load_updates();
if (strpos($function_name, '::') === FALSE) {
if (!function_exists($function_name)) {
throw new \Exception(dt('Function not found'));
}
$reflect = new \ReflectionFunction($function_name);
}
else {
[
$class,
$method,
] = explode('::', $function_name);
if (!method_exists($class, $method)) {
throw new \Exception(dt('Method not found'));
}
$reflect = new \ReflectionMethod($class, $method);
}
return [
'file' => $reflect->getFileName(),
'startline' => $reflect->getStartLine(),
'endline' => $reflect->getEndLine(),
];
}
/**
* Get a list of available container services.
*
* @command devel:services
*
* @param string $prefix
* Optional prefix to filter the service list by.
* @param array $options
* An array of options (is this used?)
*
* @aliases devel-container-services,dcs,devel-services
* @usage drush devel-services
* Gets a list of all available container services
* @usage drush dcs plugin.manager
* Get all services containing "plugin.manager"
*
* @return array
* The container service ids.
*/
public function services($prefix = NULL, array $options = [
'format' => 'yaml',
]) {
$container = $this->getContainer();
// Get a list of all available service IDs.
$services = $container->getServiceIds();
// If there is a prefix, try to find matches.
if (isset($prefix)) {
$services = preg_grep("/{$prefix}/", $services);
}
if (empty($services)) {
throw new \Exception(dt('No container services found.'));
}
sort($services);
return $services;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
DevelCommands::$container | protected | property | |
DevelCommands::$eventDispatcher | protected | property | |
DevelCommands::$moduleHandler | protected | property | |
DevelCommands::$token | protected | property | |
DevelCommands::codeLocate | public | function | Get source code line for specified function or method. |
DevelCommands::event | public | function | List implementations of a given event and optionally edit one. |
DevelCommands::getContainer | public | function | Gets the container. |
DevelCommands::getEventDispatcher | public | function | Gets the event dispatcher. |
DevelCommands::getModuleHandler | public | function | Gets the module handler. |
DevelCommands::getToken | public | function | Gets the token. |
DevelCommands::hook | public | function | List implementations of a given hook and optionally edit one. |
DevelCommands::hookInteract | public | function | Asks the user to select a hook implementation. |
DevelCommands::interactEvent | public | function | Asks the user to select an event and the event's implementation. |
DevelCommands::reinstall | public | function | Uninstall, and Install modules. |
DevelCommands::services | public | function | Get a list of available container services. |
DevelCommands::token | public | function | List available tokens. |
DevelCommands::uuid | public | function | Generate a Universally Unique Identifier (UUID). |
DevelCommands::__construct | public | function | Constructs a new DevelCommands object. |