diff --git a/src/EventSubscriber/ContentModerationStateChangedEvent.php b/src/EventSubscriber/ContentModerationStateChangedEvent.php index b0848d6..edbad36 100644 --- a/src/EventSubscriber/ContentModerationStateChangedEvent.php +++ b/src/EventSubscriber/ContentModerationStateChangedEvent.php @@ -29,7 +29,7 @@ class ContentModerationStateChangedEvent extends Event { /** * The state the content was before, or FALSE if none existed. * - * @var string|FALSE + * @var string|false */ protected $originalState; diff --git a/src/EventSubscriber/WorkbenchTransitionEventSubscriber.php b/src/EventSubscriber/WorkbenchTransitionEventSubscriber.php index 4901097..2a2633c 100644 --- a/src/EventSubscriber/WorkbenchTransitionEventSubscriber.php +++ b/src/EventSubscriber/WorkbenchTransitionEventSubscriber.php @@ -54,7 +54,7 @@ class WorkbenchTransitionEventSubscriber implements EventSubscriberInterface { * @param \Drupal\content_moderation\Event\ContentModerationStateChangedEvent $event * The event listened to. */ - public function onContentModerationTransition($event) { + public function onContentModerationTransition(ContentModerationStateChangedEvent $event) { $entity = $event->getModeratedEntity(); /** @var \Drupal\workflows\WorkflowInterface $workflow */ $workflow = $this->entityTypeManager->getStorage('workflow')->load($event->getWorkflow()); diff --git a/src/Form/TemplateForm.php b/src/Form/TemplateForm.php index cb620ce..e7ec894 100644 --- a/src/Form/TemplateForm.php +++ b/src/Form/TemplateForm.php @@ -15,12 +15,11 @@ use Drupal\Core\Form\SubformState; use Drupal\Core\Link; use Drupal\Core\Messenger\Messenger; use Drupal\Core\Url; -use Drupal\workbench_email\TemplateInterface; use Drupal\workflows\Entity\Workflow; use Symfony\Component\DependencyInjection\ContainerInterface; /** - * Class TemplateForm. + * Form controller for template form. * * @package Drupal\workbench_email\Form */ @@ -79,6 +78,10 @@ class TemplateForm extends EntityForm { * The entity type bundle info. * @param \Drupal\content_moderation\ModerationInformationInterface $moderation_info * The moderation info service. + * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler + * The module handler. + * @param \Drupal\Core\Messenger\MessengerInterface $messenger + * The messenger service. */ public function __construct(EntityTypeManagerInterface $entity_type_manager, EntityFieldManagerInterface $entity_field_manager, EntityTypeBundleInfoInterface $entity_bundle_info, $moderation_info, ModuleHandlerInterface $module_handler, Messenger $messenger) { $this->entityTypeManager = $entity_type_manager; diff --git a/src/Plugin/Derivative/WorkbenchEmailDeriver.php b/src/Plugin/Derivative/WorkbenchEmailDeriver.php index 72fdb75..30f1fa1 100644 --- a/src/Plugin/Derivative/WorkbenchEmailDeriver.php +++ b/src/Plugin/Derivative/WorkbenchEmailDeriver.php @@ -25,7 +25,7 @@ class WorkbenchEmailDeriver extends DeriverBase implements ContainerDeriverInter /** * Moderation info service. * - * @var \Drupal\content_moderation\ModerationInformationInterface $moderation_information + * @var \Drupal\content_moderation\ModerationInformationInterface */ protected $moderationInfo; diff --git a/src/Plugin/QueueWorker/WorkbenchEmailProcessor.php b/src/Plugin/QueueWorker/WorkbenchEmailProcessor.php index 0e71523..435faec 100644 --- a/src/Plugin/QueueWorker/WorkbenchEmailProcessor.php +++ b/src/Plugin/QueueWorker/WorkbenchEmailProcessor.php @@ -123,7 +123,7 @@ class WorkbenchEmailProcessor extends QueueWorkerBase implements ContainerFactor if ($entity = $this->entityRepository->loadEntityByUuid($this->targetEntityType, $uuid)) { $format = $template->getFormat(); $body = $template->getBody(); - /* @var \Drupal\Core\Entity\RevisionableStorageInterface $entity_storage */ + /** @var \Drupal\Core\Entity\RevisionableStorageInterface $entity_storage */ $entity_storage = $this->entityTypeManager->getStorage($this->targetEntityType); $latest_revision_id = $entity_storage->getLatestRevisionId($entity->id()); $entity = $entity_storage->loadRevision($latest_revision_id); diff --git a/src/Plugin/RecipientType/EmailField.php b/src/Plugin/RecipientType/EmailField.php index cfde443..3828cad 100644 --- a/src/Plugin/RecipientType/EmailField.php +++ b/src/Plugin/RecipientType/EmailField.php @@ -138,11 +138,11 @@ class EmailField extends RecipientTypeBase implements ContainerFactoryPluginInte public function prepareRecipients(ContentEntityInterface $entity, TemplateInterface $template) { $recipients = []; $fields = array_filter($this->getFields(), function ($field_name) use ($entity) { - list($entity_type, $field_name) = explode(':', $field_name, 2); + [$entity_type, $field_name] = explode(':', $field_name, 2); return $entity_type === $entity->getEntityTypeId() && $entity->hasField($field_name) && !$entity->{$field_name}->isEmpty(); }); foreach ($fields as $field) { - list(, $field_name) = explode(':', $field, 2); + [, $field_name] = explode(':', $field, 2); /** @var \Drupal\Core\Field\FieldItemInterface $field_item */ foreach ($entity->{$field_name} as $field_item) { $recipients[] = $this->getEmailFromFieldItem($field_item); @@ -165,7 +165,7 @@ class EmailField extends RecipientTypeBase implements ContainerFactoryPluginInte $dependencies = []; $field_storage = $this->entityTypeManager->getStorage('field_storage_config'); foreach ($this->getFields() as $identifier) { - list ($entity_type_id, $field_name) = explode(':', $identifier, 2); + [$entity_type_id, $field_name] = explode(':', $identifier, 2); if ($field = $field_storage->load("$entity_type_id.$field_name")) { $dependencies[$field->getConfigDependencyKey()][] = $field->getConfigDependencyName(); } diff --git a/src/Plugin/RecipientType/FixedEmail.php b/src/Plugin/RecipientType/FixedEmail.php index b6c2416..d3a64e1 100644 --- a/src/Plugin/RecipientType/FixedEmail.php +++ b/src/Plugin/RecipientType/FixedEmail.php @@ -2,18 +2,13 @@ namespace Drupal\workbench_email\Plugin\RecipientType; -use Drupal\Component\Utility\NestedArray; use Drupal\Core\Entity\ContentEntityInterface; -use Drupal\Core\Entity\EntityTypeManagerInterface; use Drupal\Core\Form\FormStateInterface; -use Drupal\Core\Plugin\ContainerFactoryPluginInterface; -use Drupal\user\RoleInterface; use Drupal\workbench_email\Plugin\RecipientTypeBase; use Drupal\workbench_email\TemplateInterface; -use Symfony\Component\DependencyInjection\ContainerInterface; /** - * Provides a recipient type of fixed email field + * Provides a recipient type of fixed email field. * * @RecipientType( * id = "fixed_email", diff --git a/src/Plugin/RecipientType/RolesWithAccess.php b/src/Plugin/RecipientType/RolesWithAccess.php index f03b701..60d8979 100644 --- a/src/Plugin/RecipientType/RolesWithAccess.php +++ b/src/Plugin/RecipientType/RolesWithAccess.php @@ -3,13 +3,9 @@ namespace Drupal\workbench_email\Plugin\RecipientType; use Drupal\Core\Entity\ContentEntityInterface; -use Drupal\Core\Entity\EntityTypeManagerInterface; use Drupal\Core\Form\FormStateInterface; -use Drupal\Core\StringTranslation\TranslatableMarkup; -use Drupal\user\RoleInterface; use Drupal\workbench_email\TemplateInterface; - /** * Provides a recipient type for Workbench Access Sections. * @@ -22,7 +18,6 @@ use Drupal\workbench_email\TemplateInterface; * }, * ) */ - class RolesWithAccess extends Role { /** @@ -51,4 +46,5 @@ class RolesWithAccess extends Role { } return $recipients; } + } diff --git a/src/Plugin/RecipientTypeBase.php b/src/Plugin/RecipientTypeBase.php index 6417d0b..0e6a2bf 100644 --- a/src/Plugin/RecipientTypeBase.php +++ b/src/Plugin/RecipientTypeBase.php @@ -35,7 +35,8 @@ abstract class RecipientTypeBase extends PluginBase implements RecipientTypeInte public $status = FALSE; /** - * An associative array containing the configured settings of this recipient type. + * An associative array containing the configured settings of this + * recipient type. * * @var array */ diff --git a/src/Plugin/RecipientTypeInterface.php b/src/Plugin/RecipientTypeInterface.php index 0bb3bd4..285e3de 100644 --- a/src/Plugin/RecipientTypeInterface.php +++ b/src/Plugin/RecipientTypeInterface.php @@ -14,7 +14,6 @@ use Drupal\Core\Plugin\PluginWithFormsInterface; /** * Defines the interface for Recipient type plugins. * - * TODO Docs. * * @see \Drupal\workbench_email\Annotation\RecipientType * @see \Drupal\workbench_email\RecipientTypePluginManager diff --git a/src/TemplateInterface.php b/src/TemplateInterface.php index b75febb..952443f 100644 --- a/src/TemplateInterface.php +++ b/src/TemplateInterface.php @@ -96,7 +96,8 @@ interface TemplateInterface extends ConfigEntityInterface, EntityWithPluginColle public function setTransitions(array $transitions): TemplateInterface; /** - * Returns the ordered collection of recipient type plugin instances or an individual plugin instance. + * Returns the ordered collection of recipient type plugin + * instances or an individual plugin instance. * * @param string $instance_id * (optional) The ID of a recipient type plugin instance to return. diff --git a/tests/src/Functional/WorkbenchEmailTest.php b/tests/src/Functional/WorkbenchEmailTest.php index 234b116..ca4c36d 100644 --- a/tests/src/Functional/WorkbenchEmailTest.php +++ b/tests/src/Functional/WorkbenchEmailTest.php @@ -16,6 +16,7 @@ use Drupal\Tests\node\Traits\NodeCreationTrait; use Drupal\user\UserInterface; use Drupal\workbench_email\Entity\Template; use Drupal\workflows\Entity\Workflow; +use Drupal\Core\StringTranslation\StringTranslationTrait; /** * Defines a class for testing workbench email with content moderation. @@ -24,6 +25,7 @@ use Drupal\workflows\Entity\Workflow; */ final class WorkbenchEmailTest extends BrowserTestBase { + use StringTranslationTrait; use AssertMailTrait; use NodeCreationTrait; use BlockCreationTrait; @@ -69,38 +71,52 @@ final class WorkbenchEmailTest extends BrowserTestBase { /** * Test node type. + * + * @var \Drupal\node\NodeTypeInterface */ - protected NodeTypeInterface $nodeType; + protected $nodeType; /** * Approver 1. + * + * @var \Drupal\user\UserInterface */ - protected UserInterface $approver1; + protected $approver1; /** * Approver 2. + * + * @var \Drupal\user\UserInterface */ - protected UserInterface $approver2; + protected $approver2; /** * Approver 3 - blocked. + * + * @var \Drupal\user\UserInterface */ - protected UserInterface $approver3; + protected $approver3; /** * Approver 4 - no email address. + * + * @var \Drupal\user\UserInterface */ - protected UserInterface $approver4; + protected $approver4; /** * Editor. + * + * @var \Drupal\user\UserInterface */ - protected UserInterface $editor; + protected $editor; /** * Admin. + * + * @var \Drupal\user\UserInterface */ - protected UserInterface $admin; + protected $admin; /** * {@inheritdoc} @@ -299,7 +315,7 @@ final class WorkbenchEmailTest extends BrowserTestBase { $field_name = 'transitions[editorial][' . $transition_name . ']'; $this->submitForm([ $field_name => $transition_name, - ], t('Save')); + ], $this->t('Save')); $entityStorage = \Drupal::entityTypeManager()->getStorage('workbench_email_template'); $entityStorage->resetCache(); $template = $entityStorage->load($template_name); @@ -333,7 +349,7 @@ final class WorkbenchEmailTest extends BrowserTestBase { 'enabled_recipient_types[role]' => TRUE, 'recipient_types[email][settings][fields][node:field_email]' => TRUE, 'recipient_types[role][settings][roles][editor]' => TRUE, - ], t('Save')); + ], $this->t('Save')); $assert->pageTextContains('Created the Content approved Email Template'); $page->clickLink('Add Email Template'); $this->submitForm([ @@ -345,7 +361,7 @@ final class WorkbenchEmailTest extends BrowserTestBase { 'enabled_recipient_types[role]' => TRUE, 'recipient_types[role][settings][roles][approver]' => TRUE, 'bundles[node:test]' => TRUE, - ], t('Save')); + ], $this->t('Save')); $assert->pageTextContains('Created the Content needs review Email Template'); // Test dependencies. $approver = Template::load('needs_review'); @@ -367,7 +383,7 @@ final class WorkbenchEmailTest extends BrowserTestBase { 'body[value]' => 'Content with[node:field_does_not_exist] title [node:title] needs review. You can view it at [node:url].[node:field_does_not_exist]', 'subject' => 'Content needs[node:field_does_not_exist] review: [node:title][node:field_does_not_exist]', 'replyTo' => '[node:author:mail]', - ], t('Save')); + ], $this->t('Save')); $assert->pageTextContains('Saved the Content needs review Email Template'); // Edit the transition from needs review to published and use the // needs_review email template. diff --git a/workbench_email.module b/workbench_email.module index e1bf52e..b5b02a0 100644 --- a/workbench_email.module +++ b/workbench_email.module @@ -96,9 +96,8 @@ function workbench_email_content_moderation_state_update(ContentModerationState * @todo Remove when https://www.drupal.org/project/drupal/issues/2873287 is in. * * @see https://www.drupal.org/project/drupal/issues/2873287#comment-12619624 - * */ -function _workbench_email_content_moderation_event_shim(ContentModerationState $entity) { +function _workbench_email_content_moderation_event_shim(EntityInterface $entity) { if (class_exists('\Drupal\content_moderation\Event\ContentModerationStateChangedEvent')) { // https://www.drupal.org/project/drupal/issues/2873287 will add this class // to core. @@ -110,7 +109,7 @@ function _workbench_email_content_moderation_event_shim(ContentModerationState $ /** @var \Drupal\content_moderation\ModerationInformationInterface $moderation_info */ $moderation_info = Drupal::service('content_moderation.moderation_information'); - // Check to see if the content is moderated or not + // Check to see if the content is moderated or not. $is_moderated = $moderation_info->isModeratedEntity($moderated_entity); if (!$is_moderated) { return; diff --git a/workbench_email.post_update.php b/workbench_email.post_update.php index 08abda1..a35b1ae 100644 --- a/workbench_email.post_update.php +++ b/workbench_email.post_update.php @@ -38,7 +38,8 @@ function workbench_email_post_update_add_template_format(&$sandbox = NULL) { /** * Update the config schema to make email body translatable. */ -function workbench_email_post_update_make_email_body_translatable(&$sandbox = NULL) { } +function workbench_email_post_update_make_email_body_translatable(&$sandbox = NULL) { +} /** * Migrate transition mapping from workflow to template.