You are here

class DefaultMenuLinkContentReferenceHandler in CMS Content Sync 8

Same name and namespace in other branches
  1. 2.1.x src/Plugin/cms_content_sync/field_handler/DefaultMenuLinkContentReferenceHandler.php \Drupal\cms_content_sync\Plugin\cms_content_sync\field_handler\DefaultMenuLinkContentReferenceHandler
  2. 2.0.x src/Plugin/cms_content_sync/field_handler/DefaultMenuLinkContentReferenceHandler.php \Drupal\cms_content_sync\Plugin\cms_content_sync\field_handler\DefaultMenuLinkContentReferenceHandler

Reference menu references and make sure they're published as the content comes available.

Plugin annotation


@FieldHandler(
  id = "cms_content_sync_default_menu_link_content_reference_handler",
  label = @Translation("Default Menu Link Content Reference"),
  weight = 80
)

Hierarchy

Expanded class hierarchy of DefaultMenuLinkContentReferenceHandler

File

src/Plugin/cms_content_sync/field_handler/DefaultMenuLinkContentReferenceHandler.php, line 17

Namespace

Drupal\cms_content_sync\Plugin\cms_content_sync\field_handler
View source
class DefaultMenuLinkContentReferenceHandler extends DefaultEntityReferenceHandler {

  /**
   * {@inheritdoc}
   */
  public static function supports($entity_type, $bundle, $field_name, FieldDefinitionInterface $field) {
    return 'menu_link_content' == $entity_type && 'parent' == $field_name;
  }

  /**
   * {@inheritdoc}
   */
  protected function forcePushingReferencedEntities() {
    return true;
  }

  /**
   * {@inheritdoc}
   */
  protected function loadReferencedEntityFromFieldValue($value) {
    if (empty($value) || empty($value['value'])) {
      return null;
    }
    list($entity_type, $uuid) = explode(':', $value['value']);
    if ('menu_link_content' != $entity_type || empty($uuid)) {
      return null;
    }
    return \Drupal::service('entity.repository')
      ->loadEntityByUuid('menu_link_content', $uuid);
  }

  /**
   * {@inheritdoc}
   */
  protected function getFieldValuesForReference($reference, $intent) {
    return 'menu_link_content:' . $reference
      ->uuid();
  }

  /**
   * {@inheritdoc}
   */
  protected function getReferencedEntityTypes() {
    return [
      'menu_link_content',
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DefaultEntityReferenceHandler::allowSubscribeFilter protected function Overrides EntityReferenceHandlerBase::allowSubscribeFilter
DefaultEntityReferenceHandler::getInvalidSubfields protected function Get a list of array keys from $entity->field_* values that should be ignored (unset before push). Overrides EntityReferenceHandlerBase::getInvalidSubfields 1
DefaultEntityReferenceHandler::saveEmbeddedPushToPools public static function Save the push settings the user selected for paragraphs.
DefaultEntityReferenceHandler::SUPPORTED_CONFIG_ENTITY_TYPES public constant
DefaultMenuLinkContentReferenceHandler::forcePushingReferencedEntities protected function Don't expose option, but force push. Overrides EntityReferenceHandlerBase::forcePushingReferencedEntities
DefaultMenuLinkContentReferenceHandler::getFieldValuesForReference protected function Get the values to be set to the $entity->field_*. Overrides EntityReferenceHandlerBase::getFieldValuesForReference
DefaultMenuLinkContentReferenceHandler::getReferencedEntityTypes protected function Overrides EntityReferenceHandlerBase::getReferencedEntityTypes
DefaultMenuLinkContentReferenceHandler::loadReferencedEntityFromFieldValue protected function Load the referenced entity, given the $entity->field_* value. Overrides EntityReferenceHandlerBase::loadReferencedEntityFromFieldValue
DefaultMenuLinkContentReferenceHandler::supports public static function Check if this handler supports the given field instance. Overrides DefaultEntityReferenceHandler::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
EntityReferenceHandlerBase::allowPushingReferencedEntities protected function 1
EntityReferenceHandlerBase::forceEmbeddingReferencedEntities protected function Don't expose option, but force push. 2
EntityReferenceHandlerBase::getHandlerSettings public function Get the handler settings. Overrides FieldHandlerBase::getHandlerSettings 2
EntityReferenceHandlerBase::getReferencedEntityTypesFromFieldDefinition public static function
EntityReferenceHandlerBase::loadReferencedEntity protected function Load the entity that is either referenced or embedded by $definition. 2
EntityReferenceHandlerBase::pull public function Overrides FieldHandlerBase::pull
EntityReferenceHandlerBase::push public function Overrides FieldHandlerBase::push
EntityReferenceHandlerBase::serializeReference protected function 2
EntityReferenceHandlerBase::setValues protected function 1
EntityReferenceHandlerBase::shouldEmbedReferencedEntities protected function Check if referenced entities should be embedded automatically.
EntityReferenceHandlerBase::shouldPushReferencedEntities protected function Check if referenced entities should be pushed automatically.
EntityReferenceHandlerBase::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 FieldHandlerBase::validateHandlerSettings
FieldHandlerBase::$bundleName protected property
FieldHandlerBase::$entityTypeName protected property
FieldHandlerBase::$fieldDefinition protected property
FieldHandlerBase::$fieldName protected property
FieldHandlerBase::$flow protected property
FieldHandlerBase::$logger protected property A logger instance.
FieldHandlerBase::$settings protected property Additional settings as provided by {
FieldHandlerBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
FieldHandlerBase::forceMergeOverwrite protected function 1
FieldHandlerBase::getAllowedPullOptions public function Get the allowed pull options. Overrides FieldHandlerInterface::getAllowedPullOptions
FieldHandlerBase::getAllowedPushOptions public function Get the allowed push options. Overrides FieldHandlerInterface::getAllowedPushOptions
FieldHandlerBase::getFieldName public function Overrides FieldHandlerInterface::getFieldName
FieldHandlerBase::__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.