class WorkflowManager in Forms Steps 8

Class WorkflowManager.

@package Drupal\forms_steps\Service

Hierarchy

• class \Drupal\forms_steps\Service\WorkflowManager

1 string reference to 'WorkflowManager'

forms_steps.services.yml in ./forms_steps.services.yml

forms_steps.services.yml

1 service uses WorkflowManager

forms_steps.workflow.manager in ./forms_steps.services.yml

Drupal\forms_steps\Service\WorkflowManager

File

src/Service/WorkflowManager.php, line 17

Namespace

Drupal\forms_steps\Service

class WorkflowManager {

  /**
   * EntityTypeManager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  private $entityTypeManager;

  /**
   * FormsStepsManager.
   *
   * @var \Drupal\forms_steps\Service\FormsStepsManager
   */
  private $formsStepsManager;

  /**
   * UUID Service.
   *
   * @var \Drupal\Component\Uuid\UuidInterface
   */
  private $uuidService;

  /**
   * CurrentRouteMatch.
   *
   * @var \Drupal\Core\Routing\CurrentRouteMatch
   */
  private $currentRouteMatch;

  /**
   * WorkflowManager constructor.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   Injected EntityTypeManager instance.
   * @param \Drupal\forms_steps\Service\FormsStepsManager $forms_steps_manager
   *   Injected FormsStepsManager instance.
   * @param \Drupal\Component\Uuid\UuidInterface $uuid_service
   *   Injected UUID instance.
   * @param \Drupal\Core\Routing\CurrentRouteMatch $current_route_match
   *   Injected CurrentRouteMatch instance.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, FormsStepsManager $forms_steps_manager, UuidInterface $uuid_service, CurrentRouteMatch $current_route_match) {
    $this->entityTypeManager = $entity_type_manager;
    $this->formsStepsManager = $forms_steps_manager;
    $this->uuidService = $uuid_service;
    $this->currentRouteMatch = $current_route_match;
  }

  /**
   * Returns the first workflow entry of the provided entity.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   Entity instance to get the workflow from.
   *
   * @return \Drupal\forms_steps\Entity\Workflow|null
   *   Returns the workflow if found, null otherwise.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function getWorkflowByEntity(EntityInterface $entity) {
    $workflow = NULL;

    // We load all the workflow of that entity type & bundle.
    $workflows = $this
      ->getAllWorksflowByEntity($entity);

    // Only returning the first one.
    if (!empty($workflows)) {
      $workflow = reset($workflows);
    }
    return $workflow;
  }

  /**
   * Returns all workflow entries of the provided entity.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   Entity instance to get the workflow from.
   *
   * @return array|null
   *   Returns an array of workflows if found, null otherwise.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function getAllWorksflowByEntity(EntityInterface $entity) {
    return $this->entityTypeManager
      ->getStorage(Workflow::ENTITY_TYPE)
      ->loadByProperties([
      'entity_type' => $entity
        ->getEntityTypeId(),
      'bundle' => $entity
        ->bundle(),
      'entity_id' => $entity
        ->id(),
    ]);
  }

  /**
   * Workflow info storage on hook_entity_presave().
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity that is going to be saved.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   * @throws \Drupal\Core\Entity\EntityStorageException
   * @throws \Drupal\entity_embed\Exception\EntityNotFoundException
   */
  public function entityPreSave(EntityInterface $entity) {
    if ($entity
      ->isNew()) {
      return;
    }
    $currentRoute = $this->currentRouteMatch
      ->getRouteName();
    if (preg_match('/^forms_steps\\./', $currentRoute) && strcmp($entity
      ->getEntityTypeId(), Workflow::ENTITY_TYPE) != 0) {

      /** @var \Drupal\forms_steps\Step $step */
      $step = $this->formsStepsManager
        ->getStepByRoute($currentRoute);
      if (is_null($step)) {
        throw new EntityNotFoundException($this
          ->t('Unable to find Forms Steps step entity.'));
      }

      // We check if we are currently managing the right entity and not an
      // entity reference.
      if (strcmp($step
        ->entityType(), $entity
        ->getEntityTypeId()) != 0 || strcmp($step
        ->entityBundle(), $entity
        ->bundle()) != 0) {
        return;
      }
      $instanceId = $this->currentRouteMatch
        ->getParameter('instance_id');
      $workflows = [];
      if (!empty($instanceId)) {
        try {
          $workflows = $this->entityTypeManager
            ->getStorage(Workflow::ENTITY_TYPE)
            ->loadByProperties([
            'instance_id' => $instanceId,
            'entity_type' => $entity
              ->getEntityTypeId(),
            'bundle' => $entity
              ->bundle(),
            'step' => $step
              ->id(),
            'entity_id' => $entity
              ->id(),
            'form_mode' => $step
              ->formMode(),
            'forms_steps' => $step
              ->formsSteps()
              ->id(),
          ]);
        } catch (\Exception $ex) {

          // Nothing to do.
        }
      }
      else {
        $instanceId = $this->uuidService
          ->generate();
      }
      if (empty($workflows)) {
        $workflow = $this->entityTypeManager
          ->getStorage(Workflow::ENTITY_TYPE)
          ->create([
          'instance_id' => $instanceId,
          'entity_type' => $entity
            ->getEntityTypeId(),
          'bundle' => $entity
            ->bundle(),
          'step' => $step
            ->id(),
          'entity_id' => $entity
            ->id(),
          'form_mode' => $step
            ->formMode(),
          'forms_steps' => $step
            ->formsSteps()
            ->id(),
        ]);
        $workflow
          ->save();
      }
    }
  }

  /**
   * Workflow info storage on hook_entity_insert().
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity that is going to be inserted.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   * @throws \Drupal\Core\Entity\EntityStorageException
   * @throws \Drupal\entity_embed\Exception\EntityNotFoundException
   */
  public function entityInsert(EntityInterface $entity) {
    $currentRoute = $this->currentRouteMatch
      ->getRouteName();
    if (preg_match('/^forms_steps\\./', $currentRoute) && strcmp($entity
      ->getEntityTypeId(), Workflow::ENTITY_TYPE) != 0) {

      /** @var \Drupal\forms_steps\Step $step */
      $step = $this->formsStepsManager
        ->getStepByRoute($currentRoute);
      if (is_null($step)) {
        throw new EntityNotFoundException($this
          ->t('Unable to find Forms Steps step entity.'));
      }

      // We check if we are currently managing the right entity and not an
      // entity reference.
      if (strcmp($step
        ->entityType(), $entity
        ->getEntityTypeId()) != 0 || strcmp($step
        ->entityBundle(), $entity
        ->bundle()) != 0) {
        return;
      }
      $instanceId = $this->currentRouteMatch
        ->getParameter('instance_id');
      $workflows = [];
      if (!empty($instanceId)) {
        try {
          $workflows = $this->entityTypeManager
            ->getStorage(Workflow::ENTITY_TYPE)
            ->loadByProperties([
            'instance_id' => $instanceId,
            'entity_type' => $entity
              ->getEntityTypeId(),
            'bundle' => $entity
              ->bundle(),
            'step' => $step
              ->id(),
            'entity_id' => $entity
              ->id(),
            'form_mode' => $step
              ->formMode(),
            'forms_steps' => $step
              ->formsSteps()
              ->id(),
          ]);
        } catch (\Exception $ex) {

          // Nothing to do.
        }
      }
      else {
        $instanceId = $this->uuidService
          ->generate();
      }
      if (empty($workflows)) {
        $workflow = $this->entityTypeManager
          ->getStorage(Workflow::ENTITY_TYPE)
          ->create([
          'instance_id' => $instanceId,
          'entity_type' => $entity
            ->getEntityTypeId(),
          'bundle' => $entity
            ->bundle(),
          'step' => $step
            ->id(),
          'entity_id' => $entity
            ->id(),
          'form_mode' => $step
            ->formMode(),
          'forms_steps' => $step
            ->formsSteps()
            ->id(),
        ]);
        $workflow
          ->save();
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
WorkflowManager::$currentRouteMatch	private	property	CurrentRouteMatch.
WorkflowManager::$entityTypeManager	private	property	EntityTypeManager.
WorkflowManager::$formsStepsManager	private	property	FormsStepsManager.
WorkflowManager::$uuidService	private	property	UUID Service.
WorkflowManager::entityInsert	public	function	Workflow info storage on hook_entity_insert().
WorkflowManager::entityPreSave	public	function	Workflow info storage on hook_entity_presave().
WorkflowManager::getAllWorksflowByEntity	public	function	Returns all workflow entries of the provided entity.
WorkflowManager::getWorkflowByEntity	public	function	Returns the first workflow entry of the provided entity.
WorkflowManager::__construct	public	function	WorkflowManager constructor.