class DefaultContentEntityHandler in CMS Content Sync 8

Class DefaultContentEntityHandler, providing a minimalistic implementation for any content entity type.

Plugin annotation

@EntityHandler(
  id = "cms_content_sync_default_entity_handler",
  label = @Translation("Default Content"),
  weight = 100
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\cms_content_sync\Plugin\EntityHandlerBase implements EntityHandlerInterface, ContainerFactoryPluginInterface
      • class \Drupal\cms_content_sync\Plugin\cms_content_sync\entity_handler\DefaultContentEntityHandler

File

src/Plugin/cms_content_sync/entity_handler/DefaultContentEntityHandler.php, line 17

Namespace

Drupal\cms_content_sync\Plugin\cms_content_sync\entity_handler

class DefaultContentEntityHandler extends EntityHandlerBase {

  /**
   * {@inheritdoc}
   */
  public static function supports($entity_type, $bundle) {

    // Whitelist supported entity types.
    $entity_types = [
      'block_content',
      'config_pages',
      'paragraph',
      'paragraphs_library_item',
      'bibcite_contributor',
      'bibcite_reference',
      'bibcite_keyword',
      'redirect',
    ];
    $moduleHandler = \Drupal::service('module_handler');
    $eck_exists = $moduleHandler
      ->moduleExists('eck');
    if ($eck_exists) {
      $eck_entity_type = \Drupal::entityTypeManager()
        ->getStorage('eck_entity_type')
        ->load($entity_type);
      if (!empty($eck_entity_type)) {
        return true;
      }
    }
    return in_array($entity_type, $entity_types);
  }

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

  /**
   * {@inheritdoc}
   */
  public function getForbiddenFields() {

    // Ignore paragraphs parent_id as it is a reference id.
    return array_merge(parent::getForbiddenFields(), [
      'parent_id',
    ]);
  }

  /**
   * Check whether the entity type supports having a label.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   *
   * @return bool
   */
  protected function hasLabelProperty() {
    $moduleHandler = \Drupal::service('module_handler');
    $eck_exists = $moduleHandler
      ->moduleExists('eck');
    if ($eck_exists) {
      $entity_type = \Drupal::entityTypeManager()
        ->getStorage('eck_entity_type')
        ->load($this->entityTypeName);
      if ($entity_type) {
        return $entity_type
          ->hasTitleField();
      }
    }
    return true;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DefaultContentEntityHandler::getAllowedPreviewOptions	public	function	Overrides EntityHandlerInterface::getAllowedPreviewOptions
DefaultContentEntityHandler::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 EntityHandlerBase::getForbiddenFields
DefaultContentEntityHandler::hasLabelProperty	protected	function	Check whether the entity type supports having a label. Overrides EntityHandlerBase::hasLabelProperty
DefaultContentEntityHandler::supports	public static	function	Check if this handler supports the given entity type. Overrides EntityHandlerInterface::supports
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
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::getAllowedPushOptions	public	function	Get the allowed push options. Overrides EntityHandlerInterface::getAllowedPushOptions	4
EntityHandlerBase::getHandlerSettings	public	function	Get the handler settings. Overrides EntityHandlerInterface::getHandlerSettings	4
EntityHandlerBase::getStaticFields	protected	function	Get a list of fields that can't be updated.
EntityHandlerBase::ignorePull	protected	function	Check if the pull should be ignored.	2
EntityHandlerBase::ignorePush	protected	function	Check if the entity should not be ignored from the push.	2
EntityHandlerBase::isEntityTypeTranslatable	protected	function
EntityHandlerBase::pull	public	function	Pull the remote entity. Overrides EntityHandlerInterface::pull	4
EntityHandlerBase::push	public	function	Overrides EntityHandlerInterface::push	5
EntityHandlerBase::pushReferencedMenuItems	protected	function	Whether or not menu item references should be pushed.
EntityHandlerBase::REVISION_TRANSLATION_AFFECTED_PROPERTY	public	constant		2
EntityHandlerBase::saveEntity	protected	function		1
EntityHandlerBase::setEntityValues	protected	function	Set the values for the pulled entity.	2
EntityHandlerBase::setSourceUrl	protected	function
EntityHandlerBase::updateEntityTypeDefinition	public	function	Update the entity type definition. Overrides EntityHandlerInterface::updateEntityTypeDefinition	3
EntityHandlerBase::USER_PROPERTY	public	constant		2
EntityHandlerBase::USER_REVISION_PROPERTY	public	constant		5
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.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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	3
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.	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.