You are here

Home » API reference » CMS Content Sync 2.0.x » DefaultNodeHandler.php

class DefaultNodeHandler in CMS Content Sync 2.0.x

Same name and namespace in other branches
  1. 8 src/Plugin/cms_content_sync/entity_handler/DefaultNodeHandler.php \Drupal\cms_content_sync\Plugin\cms_content_sync\entity_handler\DefaultNodeHandler
  2. 2.1.x src/Plugin/cms_content_sync/entity_handler/DefaultNodeHandler.php \Drupal\cms_content_sync\Plugin\cms_content_sync\entity_handler\DefaultNodeHandler

Class DefaultNodeHandler, providing proper handling for published/unpublished content.

Plugin annotation


@EntityHandler(
  id = "cms_content_sync_default_node_handler",
  label = @Translation("Default Node"),
  weight = 90
)

Hierarchy

Expanded class hierarchy of DefaultNodeHandler

File

src/Plugin/cms_content_sync/entity_handler/DefaultNodeHandler.php, line 22

Namespace

Drupal\cms_content_sync\Plugin\cms_content_sync\entity_handler
View source 
class DefaultNodeHandler extends EntityHandlerBase {
  public const USER_PROPERTY = 'uid';
  public const USER_REVISION_PROPERTY = 'revision_uid';
  public const REVISION_TRANSLATION_AFFECTED_PROPERTY = 'revision_translation_affected';

  /**
   * {@inheritdoc}
   */
  public static function supports($entity_type, $bundle) {
    return 'node' == $entity_type;
  }

  /**
   * {@inheritdoc}
   */
  public function getAllowedPushOptions() {
    return [
      PushIntent::PUSH_DISABLED,
      PushIntent::PUSH_AUTOMATICALLY,
      PushIntent::PUSH_AS_DEPENDENCY,
      PushIntent::PUSH_MANUALLY,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function push(PushIntent $intent, EntityInterface $entity = null) {
    if (!parent::push($intent, $entity)) {
      return false;
    }
    if (!$entity) {
      $entity = $intent
        ->getEntity();
    }

    /**
     * @var \Drupal\node\NodeInterface $entity
     */
    $this
      ->setDateProperty($intent, 'created', intval($entity
      ->getCreatedTime()));
    return true;
  }

  /**
   * {@inheritdoc}
   */
  public function setEntityValues(PullIntent $intent, FieldableEntityInterface $entity = null) {
    if (!$entity) {
      $entity = $intent
        ->getEntity();
    }
    $entity
      ->setRevisionCreationTime(time());
    if ($intent
      ->getProperty('revision_log')) {
      $entity
        ->setRevisionLogMessage(reset($intent
        ->getProperty('revision_log')[0]));
    }
    return parent::setEntityValues($intent, $entity);
  }

  /**
   * {@inheritdoc}
   */
  public function getAllowedPreviewOptions() {
    return [
      'table' => 'Table',
      'preview_mode' => 'Preview mode',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getHandlerSettings($current_values, $type = 'both') {
    $options = parent::getHandlerSettings($current_values, $type);

    // @todo Move to default handler for all entities that can be published.
    $options['ignore_unpublished'] = [
      '#type' => 'checkbox',
      '#title' => 'Ignore unpublished content',
      '#default_value' => isset($current_values['ignore_unpublished']) && 0 === $current_values['ignore_unpublished'] ? 0 : 1,
    ];
    $options['allow_explicit_unpublishing'] = [
      '#type' => 'checkbox',
      '#title' => 'Allow explicit unpublishing',
      '#default_value' => isset($current_values['allow_explicit_unpublishing']) && 0 === $current_values['allow_explicit_unpublishing'] ? 0 : 1,
    ];
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function ignorePull(PullIntent $intent) {

    // Not published? Ignore this revision then.
    if (empty($intent
      ->getProperty('status')[0]['value']) && $this->settings['handler_settings']['ignore_unpublished']) {
      if (!$this->settings['handler_settings']['allow_explicit_unpublishing'] || SyncIntent::ACTION_CREATE === $intent
        ->getAction()) {

        // Unless it's a delete, then it won't have a status and is independent
        // of published state, so we don't ignore the pull.
        if (SyncIntent::ACTION_DELETE != $intent
          ->getAction()) {
          return true;
        }
      }
    }
    return parent::ignorePull($intent);
  }

  /**
   * {@inheritdoc}
   */
  public function ignorePush(PushIntent $intent) {

    /**
     * @var \Drupal\node\NodeInterface $entity
     */
    $entity = $intent
      ->getEntity();
    $node_storage = \Drupal::entityTypeManager()
      ->getStorage('node');
    $node = $node_storage
      ->load($entity
      ->id());
    if (!$entity
      ->isPublished() && $this->settings['handler_settings']['ignore_unpublished']) {
      if (!$this->settings['handler_settings']['allow_explicit_unpublishing'] || $node
        ->isPublished() || $entity
        ->getRevisionId() == $node
        ->getRevisionId() && !$intent
        ->getEntityStatus()
        ->getLastPush()) {
        return true;
      }
    }
    return parent::ignorePush($intent);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DefaultNodeHandler::getAllowedPreviewOptions public function Overrides EntityHandlerInterface::getAllowedPreviewOptions
DefaultNodeHandler::getAllowedPushOptions public function Get the allowed push options. Overrides EntityHandlerBase::getAllowedPushOptions
DefaultNodeHandler::getHandlerSettings public function Get the handler settings. Overrides EntityHandlerBase::getHandlerSettings
DefaultNodeHandler::ignorePull public function Check if the pull should be ignored. Overrides EntityHandlerBase::ignorePull
DefaultNodeHandler::ignorePush public function Check if the entity should not be ignored from the push. Overrides EntityHandlerBase::ignorePush
DefaultNodeHandler::push public function Overrides EntityHandlerBase::push
DefaultNodeHandler::REVISION_TRANSLATION_AFFECTED_PROPERTY public constant Overrides EntityHandlerBase::REVISION_TRANSLATION_AFFECTED_PROPERTY
DefaultNodeHandler::setEntityValues public function Set the values for the pulled entity. Overrides EntityHandlerBase::setEntityValues
DefaultNodeHandler::supports public static function Check if this handler supports the given entity type. Overrides EntityHandlerInterface::supports
DefaultNodeHandler::USER_PROPERTY public constant Overrides EntityHandlerBase::USER_PROPERTY
DefaultNodeHandler::USER_REVISION_PROPERTY public constant Overrides EntityHandlerBase::USER_REVISION_PROPERTY
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
EntityHandlerBase::$bundleName protected property
EntityHandlerBase::$entityTypeName protected property
EntityHandlerBase::$flow protected property A sync instance.
EntityHandlerBase::$logger protected property A logger instance.
EntityHandlerBase::$settings protected property
EntityHandlerBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
EntityHandlerBase::createNew protected function 1
EntityHandlerBase::deleteEntity protected function Delete a entity.
EntityHandlerBase::getAllowedPullOptions public function Get the allowed pull options. Overrides EntityHandlerInterface::getAllowedPullOptions 2
EntityHandlerBase::getDateProperty protected function
EntityHandlerBase::getEntityName protected function
EntityHandlerBase::getForbiddenFields public function Provide a list of fields that are not allowed to be pushed or pulled. These fields typically contain all label fields that are pushed separately anyway (we don't want to set IDs and revision IDs of entities for example, but only use the UUID for… Overrides EntityHandlerInterface::getForbiddenFields 4
EntityHandlerBase::getStaticFields protected function Get a list of fields that can't be updated.
EntityHandlerBase::getViewUrl public function Overrides EntityHandlerInterface::getViewUrl 2
EntityHandlerBase::hasLabelProperty protected function Check whether the entity type supports having a label. 2
EntityHandlerBase::isEntityTypeTranslatable protected function
EntityHandlerBase::pull public function Pull the remote entity. Overrides EntityHandlerInterface::pull 4
EntityHandlerBase::pushReferencedMenuItems protected function Whether or not menu item references should be pushed.
EntityHandlerBase::saveEntity protected function 1
EntityHandlerBase::setDateProperty protected function
EntityHandlerBase::setPreviewHtml protected function
EntityHandlerBase::updateEntityTypeDefinition public function Update the entity type definition. Overrides EntityHandlerInterface::updateEntityTypeDefinition 3
EntityHandlerBase::validateHandlerSettings public function Validate the settings defined above. $form and $form_state are the same as in the Form API. $settings_key is the index at $form['sync_entities'] for this handler instance. Overrides EntityHandlerInterface::validateHandlerSettings
EntityHandlerBase::__construct public function Constructs a Drupal\rest\Plugin\ResourceBase object. Overrides PluginBase::__construct
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.