You are here

Home » API reference » Content Planner 8 » KanbanController.php

class KanbanController in Content Planner 8

Class KanbanController.

Hierarchy

Expanded class hierarchy of KanbanController

File

modules/content_kanban/src/Controller/KanbanController.php, line 21

Namespace

Drupal\content_kanban\Controller
View source 
class KanbanController extends ControllerBase {

  /**
   * The current user service.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

  /**
   * The Kanban Service.
   *
   * @var \Drupal\content_kanban\KanbanService
   */
  protected $kanbanService;

  /**
   * The Moderation information service.
   *
   * @var \Drupal\content_moderation\ModerationInformation
   */
  protected $moderationInformation;

  /**
   * The State Transition Validation.
   *
   * @var \Drupal\content_moderation\StateTransitionValidation
   */
  protected $stateTransitionValidation;

  /**
   * Constructs a new KanbanController object.
   */
  public function __construct(AccountInterface $current_user, KanbanService $kanban_service, ModerationInformation $moderation_information, StateTransitionValidation $state_transition_validation) {
    $this->currentUser = $current_user;
    $this->kanbanService = $kanban_service;
    $this->moderationInformation = $moderation_information;
    $this->stateTransitionValidation = $state_transition_validation;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('current_user'), $container
      ->get('content_kanban.kanban_service'), $container
      ->get('content_moderation.moderation_information'), $container
      ->get('content_moderation.state_transition_validation'));
  }

  /**
   * Show Kanbans.
   *
   * @return array
   *   A renderable array with the Kanbans.
   *
   * @throws \Exception
   */
  public function showKanbans() {
    $build = [];
    $workflows = Workflow::loadMultiple();
    if (!$workflows) {
      $this
        ->messenger()
        ->addMessage($this
        ->t('There are no Workflows configured yet.'), 'error');
      return [];
    }
    foreach ($workflows as $workflow) {
      if (Kanban::isValidContentModerationWorkflow($workflow)) {
        $kanban = new Kanban($this->currentUser, $this->kanbanService, $workflow);
        $build[] = $kanban
          ->build();
      }
    }

    // If there are no Kanbans, display a message.
    if (!$build) {
      $link = Url::fromRoute('entity.workflow.collection')
        ->toString();
      $message = $this
        ->t('To use Content Kanban, you need to have a valid Content Moderation workflow with at least one Entity Type configured. Please go to the <a href="@link">Workflow</a> configuration.', [
        '@link' => $link,
      ]);
      $this
        ->messenger()
        ->addMessage($message, 'error');
    }
    return $build;
  }

  /**
   * Updates the Workflow state of a given Entity.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
   *   The current entity.
   * @param string $state_id
   *   The target state id for the current entity.
   *
   * @return \Symfony\Component\HttpFoundation\JsonResponse
   *   Returns a JSON response with the result of the update process.
   *
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  public function updateEntityWorkflowState(ContentEntityInterface $entity, $state_id) {
    $data = [
      'success' => FALSE,
      'message' => NULL,
    ];

    // Check if entity is moderated.
    if (!$this->moderationInformation
      ->isModeratedEntity($entity)) {
      $data['message'] = $this
        ->t('Entity @type with ID @id is not a moderated entity.', [
        '@id' => $entity
          ->id(),
        '@type' => $entity
          ->getEntityTypeId(),
      ]);
      return new JsonResponse($data);
    }

    // Get Workflow from entity.
    $workflow = $this->moderationInformation
      ->getWorkflowForEntity($entity);

    // If Workflow does not exist.
    if (!$workflow) {
      $data['message'] = $this
        ->t('Workflow not found for Entity @type with ID @id.', [
        '@id' => $entity
          ->id(),
        '@type' => $entity
          ->getEntityTypeId(),
      ]);
      return new JsonResponse($data);
    }

    // Get Workflow States.
    $workflow_states = KanbanWorkflowService::getWorkflowStates($workflow);

    // Check if state given by request matches any of the Workflow's states.
    if (!array_key_exists($state_id, $workflow_states)) {
      $data['message'] = $this
        ->t('Workflow State @state_id is not a valid state of Workflow @workflow_id.', [
        '@state_id' => $state_id,
        '@workflow_id' => $workflow
          ->id(),
      ]);
      return new JsonResponse($data);
    }

    // Load current workflow state of entity.
    $current_state = $entity
      ->get('moderation_state')
      ->getValue()[0]['value'];

    // Load all valid transitions.a1
    $allowed_transitions = $this->stateTransitionValidation
      ->getValidTransitions($entity, $this->currentUser);

    // Load all available transitions.
    $transitions = $workflow
      ->get('type_settings')['transitions'];
    foreach ($transitions as $key => $transition) {
      if (in_array($current_state, $transition['from']) && $transition['to'] == $state_id) {
        $transition_id = $key;
        continue;
      }
    }
    if (empty($transition_id)) {
      $data['message'] = $this
        ->t('Invalid transition');
      return new JsonResponse($data);
    }
    if (!array_key_exists($transition_id, $allowed_transitions)) {
      $data['message'] = $this
        ->t('You do not have permissions to perform the action @transition_id for this content. Please contact the site administrator.', [
        '@transition_id' => $transition_id,
      ]);
      return new JsonResponse($data);
    }

    // Set new state.
    $entity->moderation_state->value = $state_id;

    // Save.
    if ($entity
      ->save() == SAVED_UPDATED) {
      $data['success'] = TRUE;
      $data['message'] = $this
        ->t('Workflow state of Entity @type with @id has been updated to @state_id', [
        '@type' => $entity
          ->getEntityTypeId(),
        '@id' => $entity
          ->id(),
        '@state_id' => $state_id,
      ]);
    }
    return new JsonResponse($data);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
KanbanController::$currentUser protected property The current user service. Overrides ControllerBase::$currentUser
KanbanController::$kanbanService protected property The Kanban Service.
KanbanController::$moderationInformation protected property The Moderation information service.
KanbanController::$stateTransitionValidation protected property The State Transition Validation.
KanbanController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
KanbanController::showKanbans public function Show Kanbans.
KanbanController::updateEntityWorkflowState public function Updates the Workflow state of a given Entity.
KanbanController::__construct public function Constructs a new KanbanController object.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.