class PublishOnlyRendered in Acquia Lift Connector 8.4

Responsible for filtering contents based on publishing configurations.

@package Drupal\acquia_lift_publisher\EventSubscriber\Publish

Hierarchy

• class \Drupal\acquia_lift_publisher\EventSubscriber\Publish\PublishOnlyRendered implements \Symfony\Component\EventDispatcher\EventSubscriberInterface uses ContentPublishingSettingsTrait

See also

\Drupal\acquia_lift_publisher\Form\ContentPublishingForm::$pushSettingField

1 string reference to 'PublishOnlyRendered'

acquia_lift_publisher.services.yml in modules/acquia_lift_publisher/acquia_lift_publisher.services.yml

modules/acquia_lift_publisher/acquia_lift_publisher.services.yml

1 service uses PublishOnlyRendered

acquia_lift_publisher.only_rendered in modules/acquia_lift_publisher/acquia_lift_publisher.services.yml

Drupal\acquia_lift_publisher\EventSubscriber\Publish\PublishOnlyRendered

File

modules/acquia_lift_publisher/src/EventSubscriber/Publish/PublishOnlyRendered.php, line 22

Namespace

Drupal\acquia_lift_publisher\EventSubscriber\Publish

class PublishOnlyRendered implements EventSubscriberInterface {
  use ContentPublishingSettingsTrait;

  /**
   * Content Hub common actions.
   *
   * @var \Drupal\acquia_contenthub\ContentHubCommonActions
   */
  private $commonActions;

  /**
   * PublishOnlyRendered constructor.
   *
   * @param \Drupal\acquia_contenthub\ContentHubCommonActions $common_actions
   *   The Content Hub common actions service.
   * @param \Drupal\Core\Config\ImmutableConfig $config
   *   The publisher configuration object.
   */
  public function __construct(ContentHubCommonActions $common_actions, ImmutableConfig $config) {
    $this->commonActions = $common_actions;
    $this->publisherSettings = $config;
  }

  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() {
    return [
      ContentHubPublisherEvents::ENQUEUE_CANDIDATE_ENTITY => [
        'onEnqueueCandidateEntity',
        99,
      ],
      AcquiaContentHubEvents::PRUNE_PUBLISH_CDF_ENTITIES => [
        'onPrunePublishCdfEntities',
        1000,
      ],
    ];
  }

  /**
   * Checks if the entity in hand is a renderable entity.
   *
   * Only enqueue the entity if it is renderable.
   *
   * @param \Drupal\acquia_contenthub_publisher\Event\ContentHubEntityEligibilityEvent $event
   *   The current enqueue eligibility event.
   *
   * @throws \Exception
   */
  public function onEnqueueCandidateEntity(ContentHubEntityEligibilityEvent $event) : void {
    if (!$this
      ->personalizedContentPushIsActive()) {
      return;
    }
    $entity = $event
      ->getEntity();

    // If the entity view configuration on Acquia Lift Publisher settings page is
    // set for the entity in question, the entity is qualified to be processed.
    if (empty($this
      ->getEntityViewModesSettingValue($entity))) {
      $event
        ->setEligibility(FALSE);
      $event
        ->stopPropagation();
      return;
    }
    $entities = [];
    $cdfs = $this->commonActions
      ->getEntityCdf($entity, $entities, TRUE, FALSE);
    foreach ($cdfs as $cdf) {
      if ($cdf
        ->getType() !== 'rendered_entity') {
        continue;
      }
      $source_uuid = $this
        ->getCdfEntityAttributeValue($cdf, 'source_entity');
      if ($source_uuid === $entity
        ->uuid()) {
        $event
          ->setEligibility(TRUE);
        $event
          ->setCalculateDependencies(FALSE);
        return;
      }
    }
    $event
      ->setEligibility(FALSE);
    $event
      ->stopPropagation();
  }

  /**
   * Removes cdfs that are not part of the personalized content scheme.
   *
   * @param \Drupal\acquia_contenthub\Event\PrunePublishCdfEntitiesEvent $event
   *   The current publishing event.
   */
  public function onPrunePublishCdfEntities(PrunePublishCdfEntitiesEvent $event) : void {
    if (!$this
      ->personalizedContentPushIsActive()) {
      return;
    }
    $cdf_document = $event
      ->getDocument();
    $cdfs_to_remove = $cdf_document
      ->getEntities();
    $rendered_entity = NULL;
    foreach ($cdfs_to_remove as $uuid => $cdf_entity) {
      if ($cdf_entity
        ->getType() === 'rendered_entity') {
        $rendered_entity = $cdf_entity;
        unset($cdfs_to_remove[$uuid]);
      }
    }

    // Extra sanity check. The personalized content push was set to true,
    // therefore, if for some reason the rendered entity is missing, stop the
    // execution.
    if (!$rendered_entity) {
      return;
    }
    $se_uuid = $this
      ->getCdfEntityAttributeValue($rendered_entity, 'source_entity');
    if (!$se_uuid) {
      return;
    }
    $cdfs_to_keep = [
      $se_uuid,
    ];
    $source_entity = $cdfs_to_remove[$se_uuid];
    $tags = $this
      ->getCdfEntityAttributeValue($source_entity, 'tags');
    if (is_array($tags)) {
      array_push($cdfs_to_keep, ...$tags);
    }
    $cdfs_to_remove = array_diff(array_keys($cdfs_to_remove), $cdfs_to_keep);
    foreach ($cdfs_to_remove as $uuid) {
      $cdf_document
        ->removeCdfEntity($uuid);
    }
  }

  /**
   * Returns an arbitrary attribute's value.
   *
   * @param \Acquia\ContentHubClient\CDF\CDFObject $cdf
   *   The cdf object in hand.
   * @param string $attribute
   *   The attribute to get from the cdf.
   *
   * @return mixed|null
   *   The attribute value could be several type. If the there's no value, or
   *   the attribute doesn't exist for some reason, return NULL.
   */
  private function getCdfEntityAttributeValue(CDFObject $cdf, string $attribute) {
    $attribute_obj = $cdf
      ->getAttribute($attribute);
    if (!$attribute_obj) {
      return NULL;
    }
    $attr_val = $attribute_obj
      ->getValue();
    return $attr_val[CDFObject::LANGUAGE_UNDETERMINED] ?? NULL;
  }

  /**
   * Determines if personalized content push rule is active.
   *
   * @return bool
   *   TRUE if active.
   */
  private function personalizedContentPushIsActive() : bool {
    return (bool) $this->publisherSettings
      ->get(ContentPublishingForm::$pushSettingField);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContentPublishingSettingsTrait::$publisherSettings	private	property	Acquia lift publisher configuration object.
ContentPublishingSettingsTrait::getEntityViewModesSettingValue	protected	function	Returns the value of the entity view modes setting.
PublishOnlyRendered::$commonActions	private	property	Content Hub common actions.
PublishOnlyRendered::getCdfEntityAttributeValue	private	function	Returns an arbitrary attribute's value.
PublishOnlyRendered::getSubscribedEvents	public static	function	Returns an array of event names this subscriber wants to listen to.
PublishOnlyRendered::onEnqueueCandidateEntity	public	function	Checks if the entity in hand is a renderable entity.
PublishOnlyRendered::onPrunePublishCdfEntities	public	function	Removes cdfs that are not part of the personalized content scheme.
PublishOnlyRendered::personalizedContentPushIsActive	private	function	Determines if personalized content push rule is active.
PublishOnlyRendered::__construct	public	function	PublishOnlyRendered constructor.