You are here

class DefaultWebformHandler in CMS Content Sync 8

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

Implements webform references.

Plugin annotation


@FieldHandler(
  id = "cms_content_sync_default_webform_handler",
  label = @Translation("Default Webform"),
  weight = 90
)

Hierarchy

Expanded class hierarchy of DefaultWebformHandler

File

src/Plugin/cms_content_sync/field_handler/DefaultWebformHandler.php, line 19

Namespace

Drupal\cms_content_sync\Plugin\cms_content_sync\field_handler
View source
class DefaultWebformHandler extends EntityReferenceHandlerBase {

  /**
   * {@inheritdoc}
   */
  public static function supports($entity_type, $bundle, $field_name, FieldDefinitionInterface $field) {
    if (!in_array($field
      ->getType(), [
      'webform',
    ])) {
      return false;
    }
    return true;
  }

  /**
   * Don't expose option, but force push.
   *
   * @return bool
   */
  protected function forcePushingReferencedEntities() {
    return false;
  }

  /**
   * @return bool
   */
  protected function allowPushingReferencedEntities() {
    return true;
  }

  /**
   * Don't expose option, but force push.
   *
   * @return bool
   */
  protected function forceEmbeddingReferencedEntities() {
    return false;
  }

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

  /**
   * Get the values to be set to the $entity->field_*.
   *
   * @param $reference
   * @param \Drupal\cms_content_sync\PullIntent $intent
   *
   * @return array
   */
  protected function getFieldValuesForReference($reference, $intent) {
    return [
      'target_id' => $reference
        ->id(),
    ];
  }

  /**
   * @param $value
   *
   * @throws \Drupal\Core\Entity\EntityStorageException
   * @throws \Drupal\cms_content_sync\Exception\SyncException
   * @throws \GuzzleHttp\Exception\GuzzleException
   *
   * @return array
   */
  protected function serializeReference(PushIntent $intent, EntityInterface $reference, $value) {
    if ($this
      ->shouldEmbedReferencedEntities()) {
      return $intent
        ->embed($reference, $value);
    }
    if ($this
      ->shouldPushReferencedEntities()) {
      return $intent
        ->addDependency($reference, $value);
    }
    return $intent
      ->addReference($reference, $value);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DefaultWebformHandler::allowPushingReferencedEntities protected function Overrides EntityReferenceHandlerBase::allowPushingReferencedEntities
DefaultWebformHandler::forceEmbeddingReferencedEntities protected function Don't expose option, but force push. Overrides EntityReferenceHandlerBase::forceEmbeddingReferencedEntities
DefaultWebformHandler::forcePushingReferencedEntities protected function Don't expose option, but force push. Overrides EntityReferenceHandlerBase::forcePushingReferencedEntities
DefaultWebformHandler::getFieldValuesForReference protected function Get the values to be set to the $entity->field_*. Overrides EntityReferenceHandlerBase::getFieldValuesForReference
DefaultWebformHandler::getReferencedEntityTypes protected function Overrides EntityReferenceHandlerBase::getReferencedEntityTypes
DefaultWebformHandler::serializeReference protected function Overrides EntityReferenceHandlerBase::serializeReference
DefaultWebformHandler::supports public static function Check if this handler supports the given field instance. Overrides FieldHandlerInterface::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::allowSubscribeFilter protected function 1
EntityReferenceHandlerBase::getHandlerSettings public function Get the handler settings. Overrides FieldHandlerBase::getHandlerSettings 2
EntityReferenceHandlerBase::getInvalidSubfields protected function 1
EntityReferenceHandlerBase::getReferencedEntityTypesFromFieldDefinition public static function
EntityReferenceHandlerBase::loadReferencedEntity protected function Load the entity that is either referenced or embedded by $definition. 2
EntityReferenceHandlerBase::loadReferencedEntityFromFieldValue protected function Load the referenced entity, given the $entity->field_* value. 2
EntityReferenceHandlerBase::pull public function Overrides FieldHandlerBase::pull
EntityReferenceHandlerBase::push public function Overrides FieldHandlerBase::push
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.