diff --git a/scheduler_content_moderation_integration/scheduler_content_moderation_integration.module b/scheduler_content_moderation_integration/scheduler_content_moderation_integration.module index 552416d..83f5d33 100644 --- a/scheduler_content_moderation_integration/scheduler_content_moderation_integration.module +++ b/scheduler_content_moderation_integration/scheduler_content_moderation_integration.module @@ -94,7 +94,9 @@ function scheduler_content_moderation_integration_form_node_form_alter(&$form, F } /** - * Helper function to generate the options dynamically for the scheduler + * Helper function for the scheduler moderation widget. + * + * Helps on generating the options dynamically for the scheduler * moderation widget. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition diff --git a/scheduler_content_moderation_integration/src/Plugin/Field/FieldWidget/SchedulerModerationWidget.php b/scheduler_content_moderation_integration/src/Plugin/Field/FieldWidget/SchedulerModerationWidget.php index 6216c15..30e9c71 100644 --- a/scheduler_content_moderation_integration/src/Plugin/Field/FieldWidget/SchedulerModerationWidget.php +++ b/scheduler_content_moderation_integration/src/Plugin/Field/FieldWidget/SchedulerModerationWidget.php @@ -18,7 +18,6 @@ use Drupal\Core\Form\FormStateInterface; * } * ) */ - class SchedulerModerationWidget extends OptionsSelectWidget { /** @@ -70,4 +69,5 @@ class SchedulerModerationWidget extends OptionsSelectWidget { $element['#key_column'] => $element['#value'], ]); } + } diff --git a/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/ConstraintValidatorBase.php b/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/ConstraintValidatorBase.php index d01302d..7575af0 100644 --- a/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/ConstraintValidatorBase.php +++ b/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/ConstraintValidatorBase.php @@ -8,6 +8,11 @@ use Drupal\Core\Entity\ContentEntityInterface; use Symfony\Component\DependencyInjection\ContainerInterface; use Symfony\Component\Validator\ConstraintValidator; +/** + * Base class for Scheduler Content Moderation Integration validators. + * + * @package Drupal\scheduler_content_moderation_integration\Plugin\Validation\Constraint + */ abstract class ConstraintValidatorBase extends ConstraintValidator implements ContainerInjectionInterface { /** @@ -52,6 +57,8 @@ abstract class ConstraintValidatorBase extends ConstraintValidator implements Co } /** + * Validate transition. + * * Validate that the transition between the supplied states is a valid * transition for the supplied entity. * @@ -63,6 +70,7 @@ abstract class ConstraintValidatorBase extends ConstraintValidator implements Co * The state to transition to. * * @return bool + * TRUE if it's a valid transition. FALSE, otherwise. */ protected function isValidTransition(ContentEntityInterface $entity, $from_state, $to_state) { $workflow_type = $this->getEntityWorkflowType($entity); diff --git a/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/PublishStateConstraint.php b/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/PublishStateConstraint.php index 8263ff3..b415fee 100644 --- a/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/PublishStateConstraint.php +++ b/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/PublishStateConstraint.php @@ -16,6 +16,8 @@ use Symfony\Component\Validator\Constraint; class PublishStateConstraint extends Constraint { /** + * Publish state invalid transition message. + * * Message to display on invalid publishing transition between the nodes * current moderation state to the specified publishing state. * diff --git a/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/PublishStateConstraintValidator.php b/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/PublishStateConstraintValidator.php index a4f6329..e16d8da 100644 --- a/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/PublishStateConstraintValidator.php +++ b/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/PublishStateConstraintValidator.php @@ -13,8 +13,6 @@ class PublishStateConstraintValidator extends ConstraintValidatorBase { * {@inheritdoc} */ public function validate($value, Constraint $constraint) { - /** @var \Drupal\scheduler_content_moderation_integration\Plugin\Validation\Constraint\PublishStateConstraint$constraint */ - /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */ $entity = $value->getEntity(); diff --git a/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/SchedulerModerationConstraint.php b/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/SchedulerModerationConstraint.php index bb4c204..8baf1c0 100644 --- a/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/SchedulerModerationConstraint.php +++ b/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/SchedulerModerationConstraint.php @@ -16,8 +16,7 @@ use Drupal\Core\Entity\Plugin\Validation\Constraint\CompositeConstraintBase; class SchedulerModerationConstraint extends CompositeConstraintBase { /** - * Message shown when publishing/un-publishing to a specific moderation state - * is invalid. + * Message for invalid publishing/un-publishing to a moderation state. * * @var string */ diff --git a/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/SchedulerModerationConstraintValidator.php b/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/SchedulerModerationConstraintValidator.php index 3ff6513..15aa6ee 100644 --- a/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/SchedulerModerationConstraintValidator.php +++ b/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/SchedulerModerationConstraintValidator.php @@ -91,8 +91,7 @@ class SchedulerModerationConstraintValidator extends ConstraintValidator impleme } /** - * Checks if the supplied moderation state is a valid transition for the - * specified entity. + * Checks if it's a valid moderation states transition for provided entity. * * @param string $moderation_state * The moderation state to validate transition for. @@ -100,6 +99,7 @@ class SchedulerModerationConstraintValidator extends ConstraintValidator impleme * The entity to check the state against. * * @return bool + * TRUE if is a valid transition, FALSE otherwise. */ private function isValidTransition($moderation_state, ContentEntityInterface $entity) { $valid_transitions = $this->stateTransitionValidation diff --git a/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/UnPublishStateConstraint.php b/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/UnPublishStateConstraint.php index 99e5114..358bcf8 100644 --- a/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/UnPublishStateConstraint.php +++ b/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/UnPublishStateConstraint.php @@ -31,4 +31,5 @@ class UnPublishStateConstraint extends Constraint { * @var string */ public $invalidUnPublishTransitionMessage = 'The scheduled un-publishing state of %unpublish_state is not a valid transition from the current moderation state of %content_state for this content.'; + } diff --git a/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/UnPublishStateConstraintValidator.php b/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/UnPublishStateConstraintValidator.php index f22a766..058d999 100644 --- a/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/UnPublishStateConstraintValidator.php +++ b/scheduler_content_moderation_integration/src/Plugin/Validation/Constraint/UnPublishStateConstraintValidator.php @@ -13,7 +13,6 @@ class UnPublishStateConstraintValidator extends ConstraintValidatorBase { * {@inheritdoc} */ public function validate($value, Constraint $constraint) { - /** @var \Drupal\scheduler_content_moderation_integration\Plugin\Validation\Constraint\UnPublishStateConstraint$constraint */ /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */ $entity = $value->getEntity(); diff --git a/src/SchedulerManager.php b/src/SchedulerManager.php index 8f89417..2d5eb3c 100644 --- a/src/SchedulerManager.php +++ b/src/SchedulerManager.php @@ -200,8 +200,9 @@ class SchedulerManager { _scheduler_rules_integration_dispatch_cron_event($node, 'publish'); } - // If scheduler_content_moderation_integration is enabled, set to published state. - if ($this->moduleHandler->moduleExists('scheduler_content_moderation_integration') && $node->get('moderation_state')){ + // If scheduler_content_moderation_integration is enabled, set to + // published state. + if ($this->moduleHandler->moduleExists('scheduler_content_moderation_integration') && $node->get('moderation_state')) { $state = $node->publish_state->value; $node->set('moderation_state', $state); $node->publish_state->value = NULL;