Update Composer, update everything
This commit is contained in:
Oliver Davies
parent
ea3e94409f
commit
dda5c284b6
19527 changed files with 1135420 additions and 351004 deletions
|
|
@ -13,10 +13,10 @@
|
|||
/**
|
||||
* Alter the information provided in \Drupal\webform\Annotation\WebformElement.
|
||||
*
|
||||
* @param array $elements
|
||||
* @param array $definitions
|
||||
* The array of webform handlers, keyed on the machine-readable element name.
|
||||
*/
|
||||
function hook_webform_element_info_alter(array &$elements) {
|
||||
function hook_webform_element_info_alter(array &$definitions) {
|
||||
|
||||
}
|
||||
|
||||
|
|
@ -30,6 +30,18 @@ function hook_webform_handler_info_alter(array &$handlers) {
|
|||
|
||||
}
|
||||
|
||||
/**
|
||||
* Alter definition of WebformSourceEntity plugins.
|
||||
*
|
||||
* @param array $definitions
|
||||
* The array of plugin definitions.
|
||||
*/
|
||||
function hook_webform_source_entity_info_alter(array &$definitions) {
|
||||
if (isset($definitions['some_plugin_whose_weight_i_wanna_change'])) {
|
||||
$definitions['some_plugin_whose_weight_i_wanna_change']['weight'] = -1000;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Alter webform elements.
|
||||
*
|
||||
|
|
@ -39,10 +51,10 @@ function hook_webform_handler_info_alter(array &$handlers) {
|
|||
* The current state of the form.
|
||||
* @param array $context
|
||||
* An associative array containing the following key-value pairs:
|
||||
* - webform: The webform structure to which elements is being attached.
|
||||
* - form: The form structure to which elements is being attached.
|
||||
*
|
||||
* @see \Drupal\webform\WebformSubmissionForm::prepareElements()
|
||||
* @see hook_webform_element_ELEMENT_TYPE_form_alter()
|
||||
* @see hook_webform_element_ELEMENT_TYPE_alter()
|
||||
*/
|
||||
function hook_webform_element_alter(array &$element, \Drupal\Core\Form\FormStateInterface $form_state, array $context) {
|
||||
// Code here acts on all elements included in a webform.
|
||||
|
|
@ -60,7 +72,7 @@ function hook_webform_element_alter(array &$element, \Drupal\Core\Form\FormState
|
|||
/**
|
||||
* Alter webform elements for a specific type.
|
||||
*
|
||||
* Modules can implement hook_webform_element_ELEMENT_TYPE_form_alter() to
|
||||
* Modules can implement hook_webform_element_ELEMENT_TYPE_alter() to
|
||||
* modify a specific webform element, rather than using
|
||||
* hook_webform_element_alter() and checking the element type.
|
||||
*
|
||||
|
|
@ -69,13 +81,13 @@ function hook_webform_element_alter(array &$element, \Drupal\Core\Form\FormState
|
|||
* @param \Drupal\Core\Form\FormStateInterface $form_state
|
||||
* The current state of the form.
|
||||
* @param array $context
|
||||
* An associative array. See hook_field_widget_form_alter() for the structure
|
||||
* An associative array. See hook_field_widget_alter() for the structure
|
||||
* and content of the array.
|
||||
*
|
||||
* @see \Drupal\webform\WebformSubmissionForm::prepareElements()
|
||||
* @see hook_webform_element_alter(()
|
||||
*/
|
||||
function hook_webform_element_ELEMENT_TYPE_form_alter(array &$element, \Drupal\Core\Form\FormStateInterface $form_state, array $context) {
|
||||
function hook_webform_element_ELEMENT_TYPE_alter(array &$element, \Drupal\Core\Form\FormStateInterface $form_state, array $context) {
|
||||
// Add custom data attributes to a specific element type.
|
||||
$element['#attributes']['data-custom'] = '{custom data goes here}';
|
||||
|
||||
|
|
@ -84,28 +96,28 @@ function hook_webform_element_ELEMENT_TYPE_form_alter(array &$element, \Drupal\C
|
|||
}
|
||||
|
||||
/**
|
||||
* Alter form options by id.
|
||||
* Alter webform options.
|
||||
*
|
||||
* @param array $options
|
||||
* An associative array of options.
|
||||
* @param array $element
|
||||
* The form element that the options is for.
|
||||
* The webform element that the options is for.
|
||||
* @param string $options_id
|
||||
* The form options id. Set to NULL if the options are custom.
|
||||
* The webform options id. Set to NULL if the options are custom.
|
||||
*/
|
||||
function hook_webform_options_alter(array &$options, array &$element, $options_id = NULL) {
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Alter the webform options by id.
|
||||
* Alter webform options by id.
|
||||
*
|
||||
* @param array $options
|
||||
* An associative array of options.
|
||||
* @param array $element
|
||||
* The webform element that the options is for.
|
||||
*/
|
||||
function hook_webform_options_WEBFORM_OPTIONS_ID_alter(array &$options, array &$element = []) {
|
||||
function hook_webform_options_WEBFORM_OPTIONS_ID_alter(array &$options, array &$element) {
|
||||
|
||||
}
|
||||
|
||||
|
|
@ -136,6 +148,348 @@ function hook_webform_submission_form_alter(array &$form, \Drupal\Core\Form\Form
|
|||
|
||||
}
|
||||
|
||||
/**
|
||||
* Perform alterations on webform admin third party settings form.
|
||||
*
|
||||
* This hook is identical to hook_form_alter() but allows contrib and custom
|
||||
* modules to define third party settings.
|
||||
*
|
||||
* @param array $form
|
||||
* Nested array of form elements that comprise the webform.
|
||||
* @param \Drupal\Core\Form\FormStateInterface $form_state
|
||||
* The current state of the form.
|
||||
*
|
||||
* @see \Drupal\webform\Form\WebformAdminSettingsForm
|
||||
* @see webform.honeypot.inc
|
||||
*
|
||||
* @ingroup form_api
|
||||
*/
|
||||
function hook_webform_admin_third_party_settings_form_alter(array &$form, \Drupal\Core\Form\FormStateInterface $form_state) {
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Perform alterations on webform third party settings form.
|
||||
*
|
||||
* This hook is identical to hook_form_alter() but allows contrib and custom
|
||||
* modules to define third party settings.
|
||||
*
|
||||
* @param array $form
|
||||
* Nested array of form elements that comprise the webform.
|
||||
* @param \Drupal\Core\Form\FormStateInterface $form_state
|
||||
* The current state of the form.
|
||||
*
|
||||
* @see \Drupal\webform\WebformEntitySettingsForm
|
||||
* @see webform.honeypot.inc
|
||||
*
|
||||
* @ingroup form_api
|
||||
*/
|
||||
function hook_webform_third_party_settings_form_alter(array &$form, \Drupal\Core\Form\FormStateInterface $form_state) {
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Act on a webform handler when a method is invoked.
|
||||
*
|
||||
* Allows module developers to implement custom logic that can executed before
|
||||
* any webform handler method is invoked.
|
||||
*
|
||||
* This hook can be used to…
|
||||
* - Conditionally enable or disable a handler.
|
||||
* - Alter a handler's configuration.
|
||||
* - Preprocess submission data being passed to a webform handler.
|
||||
*
|
||||
* @param \Drupal\webform\Plugin\WebformHandlerInterface $handler
|
||||
* A webform handler attached to a webform.
|
||||
* @param string $method_name
|
||||
* The invoked method name converted to snake case.
|
||||
* @param array $args
|
||||
* Argument being passed to the handler's method.
|
||||
*
|
||||
* @see \Drupal\webform\Plugin\WebformHandlerInterface
|
||||
*/
|
||||
function hook_webform_handler_invoke_alter(\Drupal\webform\Plugin\WebformHandlerInterface $handler, $method_name, array &$args) {
|
||||
$webform = $handler->getWebform();
|
||||
$webform_submission = $handler->getWebformSubmission();
|
||||
|
||||
$webform_id = $handler->getWebform()->id();
|
||||
$handler_id = $handler->getHandlerId();
|
||||
$state = $webform_submission->getState();
|
||||
}
|
||||
|
||||
/**
|
||||
* Act on a webform handler when a specific method is invoked.
|
||||
*
|
||||
* Allows module developers to implement custom logic that can executed before
|
||||
* a specified webform handler method is invoked.
|
||||
*
|
||||
* This hook can be used to…
|
||||
* - Conditionally enable or disable a handler.
|
||||
* - Alter a handler's configuration.
|
||||
* - Preprocess submission data being passed to a webform handler.
|
||||
*
|
||||
* @param \Drupal\webform\Plugin\WebformHandlerInterface $handler
|
||||
* A webform handler attached to a webform.
|
||||
* @param array $args
|
||||
* Argument being passed to the handler's method.
|
||||
*
|
||||
* @see \Drupal\webform\Plugin\WebformHandlerInterface
|
||||
*/
|
||||
function hook_webform_handler_invoke_METHOD_NAME_alter(\Drupal\webform\Plugin\WebformHandlerInterface $handler, array &$args) {
|
||||
$webform = $handler->getWebform();
|
||||
$webform_submission = $handler->getWebformSubmission();
|
||||
|
||||
$webform_id = $handler->getWebform()->id();
|
||||
$handler_id = $handler->getHandlerId();
|
||||
$state = $webform_submission->getState();
|
||||
}
|
||||
|
||||
/**
|
||||
* Return information about external webform libraries.
|
||||
*
|
||||
* @internal
|
||||
* This hook will most likely be removed once there is a
|
||||
* stable release of Libraries API for Drupal 8.
|
||||
*
|
||||
* @see https://www.drupal.org/project/libraries
|
||||
* @see \Drupal\webform\WebformLibrariesManager::initLibraries
|
||||
*/
|
||||
function hook_webform_libraries_info() {
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Alter the webform module's libraries information.
|
||||
*
|
||||
* @internal
|
||||
* This hook will most likely be removed once there is a
|
||||
* stable release of Libraries API for Drupal 8.
|
||||
*
|
||||
* @see https://www.drupal.org/project/libraries
|
||||
* @see \Drupal\webform\WebformLibrariesManager::initLibraries
|
||||
*/
|
||||
function hook_webform_libraries_info_alter(&$libraries) {
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Collect extra webform help from modules.
|
||||
*
|
||||
* To help on-boarding new users, there is a robust help system developed. If
|
||||
* you would like to add extra webform help, you are free to implement this
|
||||
* hook.
|
||||
*
|
||||
* @return array
|
||||
* Extra webform help your module is providing to the users. The return array
|
||||
* should be keyed by help ID (a unique machine-name) and each sub array
|
||||
* should have the following structure:
|
||||
* - access: (bool) Whether the current user is granted access to this help.
|
||||
* Defaults to TRUE.
|
||||
* - routes: (array) Array of route names where your help should be displayed.
|
||||
* - paths: (array) Array of paths where your help should be displayed. You
|
||||
* can use any syntax supported by the "path.matcher" service.
|
||||
* - video_id: (string) Optional video to include in the help message. Allowed
|
||||
* values are the keys of WebformHelpManager::videos array.
|
||||
* - attached: (array) Optional #attached array to attach to your help
|
||||
* renderable array.
|
||||
* - group: (string) Group where your help belongs. Allowed values are the
|
||||
* keys of WebformHelpManager::groups array.
|
||||
* - title: (string) Title of your help
|
||||
* - content: (array) Renderable array of your help
|
||||
* - message_id: (string) Optional message ID that will be supplied into
|
||||
* 'webform_message' element. You are free to use 'message_*' keys if you
|
||||
* want to additionally display a message when your help is displayed. These
|
||||
* keyes will be supplied into 'webform_message' element. Refer to the docs
|
||||
* of this element for their meaning.
|
||||
* - message_type: (string) Will be supplied into 'webform_message' element.
|
||||
* - message_close: (bool) Will be supplied into 'webform_message' element.
|
||||
* - message_storage: (string) Will be supplied into 'webform_message'
|
||||
* element.
|
||||
*/
|
||||
function hook_webform_help_info() {
|
||||
$help = [];
|
||||
|
||||
$help['my_custom_help'] = [
|
||||
'access' => \Drupal::currentUser()->hasPermission('my cool permission'),
|
||||
'routes' => [
|
||||
'my_module.route_where_i_show_this_help',
|
||||
],
|
||||
'paths' => [
|
||||
'/path/where/*/i-wanna/show-help',
|
||||
],
|
||||
'video_id' => 'blocks',
|
||||
'attached' => [],
|
||||
'group' => 'messages',
|
||||
'title' => t('Message: Webform UI Disabled'),
|
||||
'content' => t('Please enable the <strong>Webform UI</strong> module if you would like to add easily add and manage elements using a drag-n-drop user interface.'),
|
||||
'message_id' => '',
|
||||
'message_type' => 'warning',
|
||||
'message_close' => TRUE,
|
||||
'message_storage' => \Drupal\webform\Element\WebformMessage::STORAGE_STATE,
|
||||
];
|
||||
|
||||
return $help;
|
||||
}
|
||||
|
||||
/**
|
||||
* Alter the webform help.
|
||||
*
|
||||
* @param array $help
|
||||
* Webform help data as collected from hook_webform_help_info().
|
||||
*/
|
||||
function hook_webform_help_info_alter(array &$help) {
|
||||
if (isset($help['some_help_i_wanna_change'])) {
|
||||
$help['title'] = t('This is a really cool help message. Do read it thorough!');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Supply additional access rules that should be managed on per-webform level.
|
||||
*
|
||||
* If your module defines any additional access logic that should be managed on
|
||||
* per webform level, this hook is likely to be of use. Provide additional
|
||||
* access rules into the webform access system through this hook. Then website
|
||||
* administrators can assign appropriate grants to your rules for each webform
|
||||
* via admin UI. Whenever you need to check if a user has access to execute a
|
||||
* certain operation you should do the following:
|
||||
*
|
||||
* \Drupal::entityTypeManager()
|
||||
* ->getAccessControlHandler('webform_submission')
|
||||
* ->access($webform_submission, $some_operation, $account);
|
||||
*
|
||||
* This will return either a positive or a negative result depending on what
|
||||
* website administrator has supplied in access settings for the webform in
|
||||
* question.
|
||||
*
|
||||
* @return array
|
||||
* Array of metadata about additional access rules to be managed on per
|
||||
* webform basis. Keys should be machine names whereas values are sub arrays
|
||||
* with the following structure:
|
||||
* - title: (string) Human friendly title of the rule.
|
||||
* - description: (array) Renderable array that explains what this access rule
|
||||
* stands for. Defaults to an empty array.
|
||||
* - weight: (int) Sorting order of this access rule. Defaults to 0.
|
||||
* - roles: (string[]) Array of role IDs that should be granted this access
|
||||
* rule by default. Defaults to an empty array.
|
||||
* - permissions: (string[]) Array of permissions that should be granted this
|
||||
* access rule by default. Defaults to an empty array.
|
||||
*/
|
||||
function hook_webform_access_rules() {
|
||||
return [
|
||||
// A custom operation.
|
||||
'some_operation' => [
|
||||
'title' => t('Some operation'),
|
||||
'weight' => -100,
|
||||
'roles' => ['authenticated'],
|
||||
'permissions' => ['some permission', 'another permission'],
|
||||
],
|
||||
|
||||
// Custom any and own operations using hook_submission_access().
|
||||
//
|
||||
// - _any: means to grant access to all webform submissions independently
|
||||
// of authorship
|
||||
// - _own: means to grant access only if the user requesting access is
|
||||
// the author of the webform submission on which the operation is
|
||||
// being requested.
|
||||
//
|
||||
// The below 2 operations can be queried together as following:
|
||||
//
|
||||
// \Drupal::entityTypeManager()
|
||||
// ->getAccessControlHandler('webform_submission')
|
||||
// ->access($webform_submission, 'some_operation', $account);
|
||||
//
|
||||
// This will return TRUE as long as the $account is has either
|
||||
// 'some_operation_any' or has 'some_operation_own' and is author of
|
||||
// the $webform_submission.
|
||||
//
|
||||
// Note, to implement *_own and *_any you will need to implement
|
||||
// hook_webform_submission_access().
|
||||
//
|
||||
// @see hook_webform_submission_access()
|
||||
'some_operation_any' => [
|
||||
'title' => t('Some operation on ALL webform submissions'),
|
||||
'description' => ['#markup' => t('Allow users to execute such particular operation on all webform submissions independently of whether they are authors of those submissions.')],
|
||||
],
|
||||
'some_operation_own' => [
|
||||
'title' => t('Some operation on own webform submissions'),
|
||||
],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Alter list of access rules that should be managed on per webform level.
|
||||
*
|
||||
* @param array $access_rules
|
||||
* Array of known access rules. Its structure is identical to the return of
|
||||
* hook_webform_access_rules().
|
||||
*/
|
||||
function hook_webform_access_rules_alter(array &$access_rules) {
|
||||
if (isset($access_rules['some_specific_rule_i_want_to_alter'])) {
|
||||
$access_rules['some_specific_rule_i_want_to_alter']['title'] = t('My very cool altered title!');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Implement hook_webform_submission_access().
|
||||
*
|
||||
* Implements *_any and *_own operations for a module.
|
||||
*/
|
||||
function hook_webform_submission_access(\Drupal\webform\WebformSubmissionInterface $webform_submission, $operation, \Drupal\Core\Session\AccountInterface $account) {
|
||||
/** @var \Drupal\webform\WebformAccessRulesManagerInterface $access_rules_manager */
|
||||
$access_rules_manager = \Drupal::service('webform.access_rules_manager');
|
||||
|
||||
// Add support for some module *_any and *_own access rules.
|
||||
$access_rules = \Drupal::moduleHandler()->invoke('MY_MODULE', 'webform_access_rules');
|
||||
$access_any = isset($access_rules[$operation . '_any']) ? $access_rules_manager->checkWebformSubmissionAccess($operation . '_any', $account, $webform_submission) : \Drupal\Core\Access\AccessResult::forbidden();
|
||||
$access_own = (isset($access_rules[$operation . '_own']) && $webform_submission->isOwner($account)) ? $access_rules_manager->checkWebformSubmissionAccess($operation . '_own', $account, $webform_submission) : \Drupal\Core\Access\AccessResult::forbidden();
|
||||
$access = $access_any->orIf($access_own);
|
||||
if ($access->isAllowed()) {
|
||||
return $access;
|
||||
}
|
||||
else {
|
||||
return \Drupal\Core\Access\AccessResult::neutral();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Act on a custom message being displayed, closed or reset.
|
||||
*
|
||||
* @param string $operation
|
||||
* closed: Returns TRUE if the message is closed.
|
||||
* close: Sets the message's state to closed.
|
||||
* reset: Resets the message's closed state.
|
||||
* @param string $id
|
||||
* The message id.
|
||||
*
|
||||
* @return mixed|bool
|
||||
* TRUE if message is closed, else NULL
|
||||
*
|
||||
* @internal
|
||||
* This is an experimental hook whose definition may change.
|
||||
*
|
||||
* @see \Drupal\webform\Element\WebformMessage::isClosed
|
||||
* @see \Drupal\webform\Element\WebformMessage::setClosed
|
||||
* @see \Drupal\webform\Element\WebformMessage::resetClosed
|
||||
*/
|
||||
function hook_webform_message_custom($operation, $id) {
|
||||
// Handle 'webform_test_message_custom' defined in
|
||||
// webform.webform.test_element_message.yml.
|
||||
if ($id === 'webform_test_message_custom') {
|
||||
switch ($operation) {
|
||||
case 'closed':
|
||||
return \Drupal::state()->get($id, FALSE);
|
||||
|
||||
case 'close':
|
||||
\Drupal::state()->set($id, TRUE);
|
||||
return NULL;
|
||||
|
||||
case 'reset':
|
||||
\Drupal::state()->delete($id);
|
||||
return NULL;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @} End of "addtogroup hooks".
|
||||
*/
|
||||
|
|
|
|||
Reference in a new issue