Issue #3220309 by jrockowitz: [Drupal 9.x] Only support Drush 10 for Drupal 9.x+ and Webform 6.x+ (5dc76927) · Commits · project / webform

drush.services.yml

+25 −4

Original line number	Diff line number	Diff line
		services:
		webform.commands:
		class: \Drupal\webform\Commands\WebformCommands
		arguments: ['@webform.cli_service']
		webform.submission.commands:
		class: \Drupal\webform\Commands\WebformSubmissionCommands
		arguments: ['@file_system', '@module_handler', '@entity_type.manager', '@webform_submission.exporter']
		tags:
		- { name: drush.command }
		webform.sanitize.submissions.commands:
		webform.libraries.commands:
		class: \Drupal\webform\Commands\WebformLibrariesCommands
		arguments: ['@http_client', '@webform.libraries_manager']
		tags:
		- { name: drush.command }
		webform.utilities.commands:
		class: \Drupal\webform\Commands\WebformUtilityCommands
		arguments: ['@file_system', '@module_handler', '@extension.list.module']
		tags:
		- { name: drush.command }
		webform.documentation.commands:
		class: \Drupal\webform\Commands\WebformDocumentationCommands
		arguments: ['@file_system', '@module_handler', '@renderer', '@webform.help_manager']
		tags:
		- { name: drush.command }
		webform.devel.commands:
		class: \Drupal\webform\Commands\WebformDevelCommands
		arguments: ['@database', '@module_handler', '@config.factory', '@cache.discovery', '@renderer', '@webform.elements_validator']
		tags:
		- { name: drush.command }

		webform.sanitize.commands:
		class: \Drupal\webform\Commands\WebformSanitizeSubmissionsCommands
		arguments: ['@database', '@module_handler', '@entity_type.manager']
		tags:

drush/webform.drush.hooks.inc

deleted100644 → 0

+0 −34

Original line number	Diff line number	Diff line
		<?php

		/**
		* @file
		* Drush 8 hooks.
		*/

		/**
		* Implements hook_drush_sql_sync_sanitize().
		*
		* @see sql_drush_sql_sync_sanitize()
		* @see \Drush\Commands\core\SanitizeCommands::sanitizeSessions
		*/
		function webform_drush_sql_sync_sanitize($site) {
		$wrap_table_name = drush_get_option('db-prefix');

		$tables = array_intersect([
		'webform_submission',
		'webform_submission_data',
		'webform_submission_log',
		], drush_sql_get_class()->listTables());

		$query = [];
		foreach ($tables as $table) {
		if ($wrap_table_name) {
		$table = "{{$table}}";
		}
		$query[] = 'TRUNCATE ' . $table . ';';
		}

		drush_sql_register_post_sync_op('webform_submission',
		dt('Truncate webform submission tables.'),
		implode(' ', $query));
		}

drush/webform.drush.inc

deleted100644 → 0

+0 −479

Original line number	Diff line number	Diff line
		<?php

		// @codingStandardsIgnoreFile

		/**
		* This is file was generated using Drush. DO NOT EDIT.
		*
		* @see drush webform-generate-commands
		* @see \Drupal\webform\Commands\DrushCliServiceBase::generate_commands_drush8
		*/

		require_once __DIR__ . '/webform.drush.hooks.inc';

		/**
		* Implements hook_drush_command().
		*/
		function webform_drush_command() {
		return array(
		'webform-export' => array(
		'description' => 'Exports webform submissions to a file.',
		'core' => array(
		'8+',
		),
		'bootstrap' => 2,
		'arguments' => array(
		'webform' => 'The webform ID you want to export (required unless --entity-type and --entity-id are specified)',
		),
		'options' => array(
		'exporter' => 'The type of export. (delimited, table, yaml, or json)',
		'delimiter' => 'Delimiter between columns (defaults to site-wide setting). This option may need to be wrapped in quotes. i.e. --delimiter="\t".',
		'multiple-delimiter' => 'Delimiter between an element with multiple values (defaults to site-wide setting).',
		'file-name' => 'File name used to export submission and uploaded filed. You may use tokens.',
		'archive-type' => 'Archive file type for submission file uploadeds and generated records. (tar or zip)',
		'header-format' => 'Set to "label" (default) or "key"',
		'options-item-format' => 'Set to "label" (default) or "key". Set to "key" to print select list values by their keys instead of labels.',
		'options-single-format' => 'Set to "separate" (default) or "compact" to determine how single select list values are exported.',
		'options-multiple-format' => 'Set to "separate" (default) or "compact" to determine how multiple select list values are exported.',
		'entity-reference-items' => 'Comma-separated list of entity reference items (id, title, and/or url) to be exported.',
		'excluded-columns' => 'Comma-separated list of component IDs or webform keys to exclude.',
		'uuid' => ' Use UUIDs for all entity references. (Only applies to CSV download)',
		'entity-type' => 'The entity type to which this submission was submitted from.',
		'entity-id' => 'The ID of the entity of which this webform submission was submitted from.',
		'range-type' => 'Range of submissions to export: "all", "latest", "serial", "sid", or "date".',
		'range-latest' => 'Integer specifying the latest X submissions will be downloaded. Used if "range-type" is "latest" or no other range options are provided.',
		'range-start' => 'The submission ID or start date at which to start exporting.',
		'range-end' => 'The submission ID or end date at which to end exporting.',
		'uid' => 'The ID of the user who submitted the form.',
		'order' => 'The submission order "asc" (default) or "desc".',
		'state' => 'Submission state to be included: "completed", "draft" or "all" (default).',
		'sticky' => 'Flagged/starred submission status.',
		'files' => 'Download files: "1" or "0" (default). If set to 1, the exported CSV file and any submission file uploads will be download in a gzipped tar file.',
		'destination' => 'The full path and filename in which the CSV or archive should be stored. If omitted the CSV file or archive will be outputted to the command line.',
		),
		'aliases' => array(
		'wfx',
		'webform:export',
		),
		),
		'webform-import' => array(
		'description' => 'Imports webform submissions from a CSV file.',
		'core' => array(
		'8+',
		),
		'bootstrap' => 2,
		'arguments' => array(
		'webform' => 'The webform ID you want to import (required unless --entity-type and --entity-id are specified)',
		'import_uri' => 'The path or URI for the CSV file to be imported.',
		),
		'options' => array(
		'skip_validation' => 'Skip form validation.',
		'treat_warnings_as_errors' => 'Treat all warnings as errors.',
		'entity-type' => 'The entity type to which this submission was submitted from.',
		'entity-id' => 'The ID of the entity of which this webform submission was submitted from.',
		),
		'aliases' => array(
		'wfi',
		'webform:import',
		),
		),
		'webform-purge' => array(
		'description' => 'Purge webform submissions from the databases',
		'core' => array(
		'8+',
		),
		'bootstrap' => 2,
		'arguments' => array(
		'webform_id' => 'A webform machine name. If not provided, user may choose from a list of names.',
		),
		'options' => array(
		'all' => 'Flush all submissions',
		'entity-type' => 'The entity type for webform submissions to be purged',
		'entity-id' => 'The ID of the entity for webform submissions to be purged',
		),
		'examples' => array(
		'drush webform-purge' => 'Pick a webform and then purge its submissions.',
		'drush webform-purge contact' => "Delete 'Contact' webform submissions.",
		'drush webform-purge --all' => 'Purge all webform submissions.',
		),
		'aliases' => array(
		'wfp',
		'webform:purge',
		),
		),
		'webform-tidy' => array(
		'description' => 'Tidy export webform configuration files',
		'core' => array(
		'8+',
		),
		'bootstrap' => 1,
		'options' => array(
		'dependencies' => 'Add module dependencies to installed webform and options configuration entities.',
		'prefix' => 'Prefix for file names to be tidied. (Defaults to webform)',
		),
		'arguments' => array(
		'target' => 'The module (config/install), config directory (sync), or path (/some/path) that needs its YAML configuration files tidied. (Defaults to webform)',
		),
		'examples' => array(
		'drush webform-tidy webform' => "Tidies YAML configuration files in 'webform/config' for the Webform module",
		),
		'aliases' => array(
		'wft',
		'webform:tidy',
		),
		),
		'webform-libraries-status' => array(
		'description' => 'Displays the status of third party libraries required by the Webform module.',
		'core' => array(
		'8+',
		),
		'bootstrap' => 1,
		'examples' => array(
		'webform-libraries-status' => 'Displays the status of third party libraries required by the Webform module.',
		),
		'aliases' => array(
		'wfls',
		'webform:libraries:status',
		),
		),
		'webform-libraries-composer' => array(
		'description' => "Generates the Webform module's composer.json with libraries as repositories.",
		'core' => array(
		'8+',
		),
		'bootstrap' => 1,
		'options' => array(
		'disable-tls' => 'If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed.',
		),
		'examples' => array(
		'webform-libraries-composer' => "Generates the Webform module's composer.json with libraries as repositories.",
		),
		'aliases' => array(
		'wflc',
		'webform:libraries:composer',
		),
		),
		'webform-libraries-download' => array(
		'description' => 'Download third party libraries required by the Webform module.',
		'core' => array(
		'8+',
		),
		'bootstrap' => 1,
		'examples' => array(
		'webform-libraries-download' => 'Download third party libraries required by the Webform module.',
		),
		'aliases' => array(
		'wfld',
		'webform:libraries:download',
		),
		),
		'webform-libraries-remove' => array(
		'description' => 'Removes all downloaded third party libraries required by the Webform module.',
		'core' => array(
		'8+',
		),
		'bootstrap' => 1,
		'examples' => array(
		'webform-libraries-remove' => 'Removes all downloaded third party libraries required by the Webform module.',
		),
		'aliases' => array(
		'wflr',
		'webform:libraries:remove',
		),
		),
		'webform-generate' => array(
		'description' => 'Create submissions in specified webform.',
		'arguments' => array(
		'webform_id' => 'Webform id into which new submissions will be inserted.',
		'num' => 'Number of submissions to insert. Defaults to 50.',
		),
		'options' => array(
		'kill' => 'Delete all submissions in specified webform before generating.',
		'feedback' => 'An integer representing interval for insertion rate logging. Defaults to 1000',
		'entity-type' => 'The entity type to which this submission was submitted from.',
		'entity-id' => 'The ID of the entity of which this webform submission was submitted from.',
		),
		'aliases' => array(
		'wfg',
		'webform:generate',
		),
		),
		'webform-repair' => array(
		'description' => 'Makes sure all Webform admin configuration and webform settings are up-to-date.',
		'core' => array(
		'8+',
		),
		'bootstrap' => 1,
		'examples' => array(
		'webform-repair' => 'Repairs admin configuration and webform settings are up-to-date.',
		),
		'aliases' => array(
		'wfr',
		'webform:repair',
		),
		),
		'webform-remove-orphans' => array(
		'description' => "Removes orphaned submissions where the submission's webform was deleted.",
		'core' => array(
		'8+',
		),
		'bootstrap' => 1,
		'examples' => array(
		'webform-remove-orphans' => "Removes orphaned submissions where the submission's webform was deleted.",
		),
		'aliases' => array(
		'wfro',
		'webform:remove:orphans',
		),
		),
		'webform-docs' => array(
		'description' => 'Generates HTML documentation.',
		'core' => array(
		'8+',
		),
		'bootstrap' => 1,
		'examples' => array(
		'webform-docs' => "Generates HTML documentation used by the Webform module's documentation pages.",
		),
		'aliases' => array(
		'wfd',
		'webform:docs',
		),
		),
		'webform-composer-update' => array(
		'description' => "Updates the Drupal installation's composer.json to include the Webform module's selected libraries as repositories.",
		'core' => array(
		'8+',
		),
		'bootstrap' => 1,
		'options' => array(
		'disable-tls' => 'If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed.',
		),
		'examples' => array(
		'webform-composer-update' => "Updates the Drupal installation's composer.json to include the Webform module's selected libraries as repositories.",
		),
		'aliases' => array(
		'wfcu',
		'webform:composer:update',
		),
		),
		'webform-generate-commands' => array(
		'description' => 'Generate Drush commands from webform.drush.inc for Drush 8.x to WebformCommands for Drush 9.x.',
		'core' => array(
		'8+',
		),
		'bootstrap' => 2,
		'examples' => array(
		'drush webform-generate-commands' => 'Generate Drush commands from webform.drush.inc for Drush 8.x to WebformCommands for Drush 9.x.',
		),
		'aliases' => array(
		'wfgc',
		'webform:generate:commands',
		),
		),
		);
		}

		/* ************************************************************************** */
		// drush webform-export. DO NOT EDIT.
		/* ************************************************************************** */

		/**
		* Implements drush_hook_COMMAND_validate().
		*/
		function drush_webform_export_validate() {
		return call_user_func_array([\Drupal::service('webform.cli_service'), 'drush_webform_export_validate'], func_get_args());
		}

		/**
		* Implements drush_hook_COMMAND().
		*/
		function drush_webform_export() {
		return call_user_func_array([\Drupal::service('webform.cli_service'), 'drush_webform_export'], func_get_args());
		}

		/* ************************************************************************** */
		// drush webform-import. DO NOT EDIT.
		/* ************************************************************************** */

		/**
		* Implements drush_hook_COMMAND_validate().
		*/
		function drush_webform_import_validate() {
		return call_user_func_array([\Drupal::service('webform.cli_service'), 'drush_webform_import_validate'], func_get_args());
		}

		/**
		* Implements drush_hook_COMMAND().
		*/
		function drush_webform_import() {
		return call_user_func_array([\Drupal::service('webform.cli_service'), 'drush_webform_import'], func_get_args());
		}

		/* ************************************************************************** */
		// drush webform-purge. DO NOT EDIT.
		/* ************************************************************************** */

		/**
		* Implements drush_hook_COMMAND_validate().
		*/
		function drush_webform_purge_validate() {
		return call_user_func_array([\Drupal::service('webform.cli_service'), 'drush_webform_purge_validate'], func_get_args());
		}

		/**
		* Implements drush_hook_COMMAND().
		*/
		function drush_webform_purge() {
		return call_user_func_array([\Drupal::service('webform.cli_service'), 'drush_webform_purge'], func_get_args());
		}

		/* ************************************************************************** */
		// drush webform-tidy. DO NOT EDIT.
		/* ************************************************************************** */

		/**
		* Implements drush_hook_COMMAND_validate().
		*/
		function drush_webform_tidy_validate() {
		return call_user_func_array([\Drupal::service('webform.cli_service'), 'drush_webform_tidy_validate'], func_get_args());
		}

		/**
		* Implements drush_hook_COMMAND().
		*/
		function drush_webform_tidy() {
		return call_user_func_array([\Drupal::service('webform.cli_service'), 'drush_webform_tidy'], func_get_args());
		}

		/* ************************************************************************** */
		// drush webform-libraries-status. DO NOT EDIT.
		/* ************************************************************************** */

		/**
		* Implements drush_hook_COMMAND().
		*/
		function drush_webform_libraries_status() {
		return call_user_func_array([\Drupal::service('webform.cli_service'), 'drush_webform_libraries_status'], func_get_args());
		}

		/* ************************************************************************** */
		// drush webform-libraries-composer. DO NOT EDIT.
		/* ************************************************************************** */

		/**
		* Implements drush_hook_COMMAND().
		*/
		function drush_webform_libraries_composer() {
		return call_user_func_array([\Drupal::service('webform.cli_service'), 'drush_webform_libraries_composer'], func_get_args());
		}

		/* ************************************************************************** */
		// drush webform-libraries-download. DO NOT EDIT.
		/* ************************************************************************** */

		/**
		* Implements drush_hook_COMMAND().
		*/
		function drush_webform_libraries_download() {
		return call_user_func_array([\Drupal::service('webform.cli_service'), 'drush_webform_libraries_download'], func_get_args());
		}

		/* ************************************************************************** */
		// drush webform-libraries-remove. DO NOT EDIT.
		/* ************************************************************************** */

		/**
		* Implements drush_hook_COMMAND().
		*/
		function drush_webform_libraries_remove() {
		return call_user_func_array([\Drupal::service('webform.cli_service'), 'drush_webform_libraries_remove'], func_get_args());
		}

		/* ************************************************************************** */
		// drush webform-generate. DO NOT EDIT.
		/* ************************************************************************** */

		/**
		* Implements drush_hook_COMMAND_validate().
		*/
		function drush_webform_generate_validate() {
		return call_user_func_array([\Drupal::service('webform.cli_service'), 'drush_webform_generate_validate'], func_get_args());
		}

		/**
		* Implements drush_hook_COMMAND().
		*/
		function drush_webform_generate() {
		return call_user_func_array([\Drupal::service('webform.cli_service'), 'drush_webform_generate'], func_get_args());
		}

		/* ************************************************************************** */
		// drush webform-repair. DO NOT EDIT.
		/* ************************************************************************** */

		/**
		* Implements drush_hook_COMMAND().
		*/
		function drush_webform_repair() {
		return call_user_func_array([\Drupal::service('webform.cli_service'), 'drush_webform_repair'], func_get_args());
		}

		/* ************************************************************************** */
		// drush webform-remove-orphans. DO NOT EDIT.
		/* ************************************************************************** */

		/**
		* Implements drush_hook_COMMAND().
		*/
		function drush_webform_remove_orphans() {
		return call_user_func_array([\Drupal::service('webform.cli_service'), 'drush_webform_remove_orphans'], func_get_args());
		}

		/* ************************************************************************** */
		// drush webform-docs. DO NOT EDIT.
		/* ************************************************************************** */

		/**
		* Implements drush_hook_COMMAND_validate().
		*/
		function drush_webform_docs_validate() {
		return call_user_func_array([\Drupal::service('webform.cli_service'), 'drush_webform_docs_validate'], func_get_args());
		}

		/**
		* Implements drush_hook_COMMAND().
		*/
		function drush_webform_docs() {
		return call_user_func_array([\Drupal::service('webform.cli_service'), 'drush_webform_docs'], func_get_args());
		}

		/* ************************************************************************** */
		// drush webform-composer-update. DO NOT EDIT.
		/* ************************************************************************** */

		/**
		* Implements drush_hook_COMMAND_validate().
		*/
		function drush_webform_composer_update_validate() {
		return call_user_func_array([\Drupal::service('webform.cli_service'), 'drush_webform_composer_update_validate'], func_get_args());
		}

		/**
		* Implements drush_hook_COMMAND().
		*/
		function drush_webform_composer_update() {
		return call_user_func_array([\Drupal::service('webform.cli_service'), 'drush_webform_composer_update'], func_get_args());
		}

		/* ************************************************************************** */
		// drush webform-generate-commands. DO NOT EDIT.
		/* ************************************************************************** */

		/**
		* Implements drush_hook_COMMAND().
		*/
		function drush_webform_generate_commands() {
		return call_user_func_array([\Drupal::service('webform.cli_service'), 'drush_webform_generate_commands'], func_get_args());
		}

modules/webform_devel/drush.services.yml

+1 −1

Original line number	Diff line number	Diff line
		services:
		webform_devel.commands:
		class: \Drupal\webform_devel\Commands\WebformDevelCommands
		arguments: ['@state', '@user.data']
		arguments: ['@file_system', '@state', '@user.data']
		tags:
		- { name: drush.command }

modules/webform_devel/src/Commands/WebformDevelCommands.php

+15 −6

Original line number	Diff line number	Diff line
		<?php

		// phpcs:ignoreFile

		namespace Drupal\webform_devel\Commands;

		use Drupal\Core\File\FileSystemInterface;
		use Drupal\Core\Serialization\Yaml;
		use Drupal\Core\State\StateInterface;
		use Drupal\user\UserDataInterface;
		@@ -17,6 +16,13 @@ use Psr\Log\LogLevel;
		*/
		class WebformDevelCommands extends DrushCommands {

		/**
		* The file system service.
		*
		* @var \Drupal\Core\File\FileSystemInterface
		*/
		protected $fileSystem;

		/**
		* Provides the state system.
		*
		@@ -34,13 +40,16 @@ class WebformDevelCommands extends DrushCommands {
		/**
		* The construct method.
		*
		* @param \Drupal\Core\File\FileSystemInterface $file_system
		* File system service.
		* @param \Drupal\Core\State\StateInterface $state
		* Provides the state system.
		* @param \Drupal\user\UserDataInterface $user_data
		* The user data service.
		*/
		public function __construct(StateInterface $state, UserDataInterface $user_data) {
		public function __construct(FileSystemInterface $file_system, StateInterface $state, UserDataInterface $user_data) {
		parent::__construct();
		$this->fileSystem = $file_system;
		$this->state = $state;
		$this->userData = $user_data;
		}
		@@ -51,10 +60,10 @@ class WebformDevelCommands extends DrushCommands {
		* @command webform:devel:config:update
		* @aliases wfdcu,webform-devel-reset
		*/
		public function drush_webform_devel_config_update() {
		public function develConfigUpdate() {
		module_load_include('inc', 'webform', 'includes/webform.install');

		$files = \Drupal::service('file_system')->scanDirectory(__DIR__ . '/../../../../', '/^webform\.webform\..*\.yml$/');
		$files = $this->fileSystem->scanDirectory(__DIR__ . '/../../../../', '/^webform\.webform\..*\.yml$/');
		$total = 0;
		foreach ($files as $filename => $file) {
		try {
		@@ -104,7 +113,7 @@ class WebformDevelCommands extends DrushCommands {
		*
		* @see drush_webform_devel_reset()
		*/
		public function drush_webform_devel_reset() {
		public function develReset() {
		if (!$this->io()->confirm(dt("Are you sure you want repair the Webform module's admin settings and webforms?"))) {
		throw new UserAbortException();
		}