class ScheduledTransitionsUtility in Scheduled Transitions 2.x

Utilities for Scheduled Transitions module.

Hierarchy

• class \Drupal\scheduled_transitions\ScheduledTransitionsUtility implements ScheduledTransitionsUtilityInterface

3 files declare their use of ScheduledTransitionsUtility

ScheduledTransition.php in src/Entity/ScheduledTransition.php

ScheduledTransitionsLocalTask.php in src/Plugin/Menu/LocalTask/ScheduledTransitionsLocalTask.php

ScheduledTransitionsUtilityUnitTest.php in tests/src/Unit/ScheduledTransitionsUtilityUnitTest.php

1 string reference to 'ScheduledTransitionsUtility'

scheduled_transitions.services.yml in ./scheduled_transitions.services.yml

scheduled_transitions.services.yml

1 service uses ScheduledTransitionsUtility

scheduled_transitions.utility in ./scheduled_transitions.services.yml

Drupal\scheduled_transitions\ScheduledTransitionsUtility

File

src/ScheduledTransitionsUtility.php, line 24

Namespace

Drupal\scheduled_transitions

class ScheduledTransitionsUtility implements ScheduledTransitionsUtilityInterface {

  /**
   * The configuration factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * The cache.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface
   */
  protected $cache;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The bundle information service.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
   */
  protected $bundleInfo;

  /**
   * General service for moderation-related questions about Entity API.
   *
   * @var \Drupal\content_moderation\ModerationInformationInterface
   */
  protected $moderationInformation;

  /**
   * The token replacement system.
   *
   * @var \Drupal\Core\Utility\Token
   */
  protected $token;

  /**
   * String translation manager.
   *
   * @var \Drupal\Core\StringTranslation\TranslationInterface
   */
  protected $stringTranslation;

  /**
   * Cache bin ID for enabled bundled cache.
   */
  protected const CID_SCHEDULED_TRANSITIONS_BUNDLES = 'scheduled_transitions_enabled_bundles';

  /**
   * Query tag to alter target revisions.
   */
  public const QUERY_TAG_TARGET_REVISIONS = 'scheduled_transitions_target_revisions';

  /**
   * Constructs a new ScheduledTransitionsUtility.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
   *   The configuration factory.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache
   *   The cache.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity type manager.
   * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $bundleInfo
   *   The bundle information service.
   * @param \Drupal\content_moderation\ModerationInformationInterface $moderationInformation
   *   General service for moderation-related questions about Entity API.
   * @param \Drupal\Core\Utility\Token $token
   *   The token replacement system.
   * @param \Drupal\Core\StringTranslation\TranslationInterface $stringTranslation
   *   String translation manager.
   */
  public function __construct(ConfigFactoryInterface $configFactory, CacheBackendInterface $cache, EntityTypeManagerInterface $entityTypeManager, EntityTypeBundleInfoInterface $bundleInfo, ModerationInformationInterface $moderationInformation, Token $token, TranslationInterface $stringTranslation) {
    $this->configFactory = $configFactory;
    $this->cache = $cache;
    $this->entityTypeManager = $entityTypeManager;
    $this->bundleInfo = $bundleInfo;
    $this->moderationInformation = $moderationInformation;
    $this->token = $token;
    $this->stringTranslation = $stringTranslation;
  }

  /**
   * {@inheritdoc}
   */
  public function getTransitions(EntityInterface $entity) : array {
    $transitionStorage = $this->entityTypeManager
      ->getStorage('scheduled_transition');
    $ids = $transitionStorage
      ->getQuery()
      ->condition('entity__target_type', $entity
      ->getEntityTypeId())
      ->condition('entity__target_id', $entity
      ->id())
      ->execute();
    return $transitionStorage
      ->loadMultiple($ids);
  }

  /**
   * {@inheritdoc}
   */
  public function getApplicableBundles() : array {
    $bundles = [];
    $bundleInfo = $this->bundleInfo
      ->getAllBundleInfo();
    foreach ($bundleInfo as $entityTypeId => $entityTypeBundles) {
      $entityType = $this->entityTypeManager
        ->getDefinition($entityTypeId);
      $entityTypeBundles = array_filter($entityTypeBundles, function ($bundleId) use ($entityType) : bool {
        return $this->moderationInformation
          ->shouldModerateEntitiesOfBundle($entityType, $bundleId);
      }, \ARRAY_FILTER_USE_KEY);
      $bundles[$entityTypeId] = array_keys($entityTypeBundles);
    }
    return array_filter($bundles);
  }

  /**
   * {@inheritdoc}
   */
  public function getBundles() : array {
    $enabledBundlesCache = $this->cache
      ->get(static::CID_SCHEDULED_TRANSITIONS_BUNDLES);
    if ($enabledBundlesCache !== FALSE) {
      return $enabledBundlesCache->data ?? [];
    }
    $enabledBundles = $this->configFactory
      ->get('scheduled_transitions.settings')
      ->get('bundles');
    $enabledBundles = array_map(function (array $bundleConfig) {
      return sprintf('%s:%s', $bundleConfig['entity_type'], $bundleConfig['bundle']);
    }, is_array($enabledBundles) ? $enabledBundles : []);
    $applicableBundles = $this
      ->getApplicableBundles();
    foreach ($applicableBundles as $entityTypeId => &$bundles) {
      $bundles = array_filter($bundles, function (string $bundle) use ($entityTypeId, $enabledBundles) {
        return in_array($entityTypeId . ':' . $bundle, $enabledBundles);
      });
    }
    $applicableBundles = array_filter($applicableBundles);
    $this->cache
      ->set(static::CID_SCHEDULED_TRANSITIONS_BUNDLES, $applicableBundles, Cache::PERMANENT, [
      SettingsForm::SETTINGS_TAG,
    ]);
    return $applicableBundles;
  }

  /**
   * {@inheritdoc}
   */
  public function getTargetRevisionIds(EntityInterface $entity, string $language) : array {
    $entityStorage = $this->entityTypeManager
      ->getStorage($entity
      ->getEntityTypeId());
    $entityDefinition = $entityStorage
      ->getEntityType();
    $ids = $entityStorage
      ->getQuery()
      ->allRevisions()
      ->condition($entityDefinition
      ->getKey('id'), $entity
      ->id())
      ->condition($entityDefinition
      ->getKey('langcode'), $language)
      ->sort($entityDefinition
      ->getKey('revision'), 'DESC')
      ->addTag(static::QUERY_TAG_TARGET_REVISIONS)
      ->execute();
    return array_keys($ids);
  }

  /**
   * {@inheritdoc}
   */
  public function generateRevisionLog(ScheduledTransitionInterface $scheduledTransition, RevisionLogInterface $newRevision) : string {
    $entityStorage = $this->entityTypeManager
      ->getStorage($newRevision
      ->getEntityTypeId());
    $latestRevisionId = $entityStorage
      ->getLatestRevisionId($newRevision
      ->id());
    if ($latestRevisionId) {

      /** @var \Drupal\Core\Entity\EntityInterface|\Drupal\Core\Entity\RevisionableInterface $latest */
      $latest = $entityStorage
        ->loadRevision($latestRevisionId);
    }
    if (!isset($latest)) {
      throw new ScheduledTransitionMissingEntity(sprintf('Could not determine latest revision.'));
    }
    $options = $scheduledTransition
      ->getOptions();
    if (($options['revision_log_override'] ?? NULL) === TRUE) {
      $template = $options['revision_log'] ?? '';
    }
    else {
      $newIsLatest = $newRevision
        ->getRevisionId() === $latest
        ->getRevisionId();
      $settings = $this->configFactory
        ->get('scheduled_transitions.settings');
      $template = $newIsLatest ? $settings
        ->get('message_transition_latest') : $settings
        ->get('message_transition_historical');
    }
    $replacements = new ScheduledTransitionsTokenReplacements($scheduledTransition, $newRevision, $latest);
    $replacements
      ->setStringTranslation($this->stringTranslation);
    return $this
      ->tokenReplace($template, $replacements);
  }

  /**
   * Creates a cache tag for scheduled transitions related to an entity.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   An entity.
   *
   * @return string
   *   Cache tag to add to lists showing scheduled transitions for an entity.
   */
  public static function createScheduledTransitionsCacheTag(EntityInterface $entity) : string {
    return sprintf('scheduled_transitions_for:%s:%s', $entity
      ->getEntityTypeId(), $entity
      ->id());
  }

  /**
   * Replaces all tokens in a given string with appropriate values.
   *
   * @param string $text
   *   A string containing replaceable tokens.
   * @param \Drupal\scheduled_transitions\ScheduledTransitionsTokenReplacements $replacements
   *   A replacements object.
   *
   * @return string
   *   The string with the tokens replaced.
   */
  protected function tokenReplace(string $text, ScheduledTransitionsTokenReplacements $replacements) : string {
    $tokenData = [
      'scheduled-transitions' => $replacements
        ->getReplacements(),
    ];
    return $this->token
      ->replace($text, $tokenData);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ScheduledTransitionsUtility::$bundleInfo	protected	property	The bundle information service.
ScheduledTransitionsUtility::$cache	protected	property	The cache.
ScheduledTransitionsUtility::$configFactory	protected	property	The configuration factory.
ScheduledTransitionsUtility::$entityTypeManager	protected	property	The entity type manager.
ScheduledTransitionsUtility::$moderationInformation	protected	property	General service for moderation-related questions about Entity API.
ScheduledTransitionsUtility::$stringTranslation	protected	property	String translation manager.
ScheduledTransitionsUtility::$token	protected	property	The token replacement system.
ScheduledTransitionsUtility::CID_SCHEDULED_TRANSITIONS_BUNDLES	protected	constant	Cache bin ID for enabled bundled cache.
ScheduledTransitionsUtility::createScheduledTransitionsCacheTag	public static	function	Creates a cache tag for scheduled transitions related to an entity.
ScheduledTransitionsUtility::generateRevisionLog	public	function	Generates a revision log for a ready to save revision. Overrides ScheduledTransitionsUtilityInterface::generateRevisionLog
ScheduledTransitionsUtility::getApplicableBundles	public	function	Get list of entity type/bundles scheduled transitions can work with. Overrides ScheduledTransitionsUtilityInterface::getApplicableBundles
ScheduledTransitionsUtility::getBundles	public	function	Get list of entity type/bundles scheduled transitions are enabled on. Overrides ScheduledTransitionsUtilityInterface::getBundles
ScheduledTransitionsUtility::getTargetRevisionIds	public	function	Get potential revisions which can be transitioned to. Overrides ScheduledTransitionsUtilityInterface::getTargetRevisionIds
ScheduledTransitionsUtility::getTransitions	public	function	Get scheduled transitions for an entity. Overrides ScheduledTransitionsUtilityInterface::getTransitions
ScheduledTransitionsUtility::QUERY_TAG_TARGET_REVISIONS	public	constant	Query tag to alter target revisions.
ScheduledTransitionsUtility::tokenReplace	protected	function	Replaces all tokens in a given string with appropriate values.
ScheduledTransitionsUtility::__construct	public	function	Constructs a new ScheduledTransitionsUtility.