You are here

class DefaultFieldHandler in CMS Content Sync 2.0.x

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

Providing a minimalistic implementation for any field type.

Plugin annotation


@FieldHandler(
  id = "cms_content_sync_default_field_handler",
  label = @Translation("Default"),
  weight = 100
)

Hierarchy

Expanded class hierarchy of DefaultFieldHandler

File

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

Namespace

Drupal\cms_content_sync\Plugin\cms_content_sync\field_handler
View source
class DefaultFieldHandler extends FieldHandlerBase {

  /**
   * {@inheritdoc}
   */
  public static function supports($entity_type, $bundle, $field_name, FieldDefinitionInterface $field) {
    $core_field_types = [
      'boolean',
      'changed',
      'comment',
      'created',
      'daterange',
      'datetime',
      'decimal',
      'email',
      'float',
      'iframe',
      'integer',
      'language',
      'list_float',
      'list_integer',
      'list_string',
      'map',
      'range_decimal',
      'range_float',
      'range_integer',
      'string',
      'string_long',
      'telephone',
      'text',
      'text_long',
      'text_with_summary',
      'timestamp',
      'uri',
      'uuid',
    ];
    $contrib_field_types = [
      'add_to_calendar_field',
      'address',
      'address_country',
      'address_zone',
      'block_field',
      'color_field_type',
      'easychart',
      'geolocation',
      'heading',
      'key_value',
      'key_value_long',
      'metatag',
      'social_media',
      'soundcloud',
      'tablefield',
      'video_embed_field',
      'viewfield',
      'yearonly',
      'yoast_seo',
      'weight',
    ];
    $allowed = array_merge($core_field_types, $contrib_field_types);
    return false !== in_array($field
      ->getType(), $allowed) && ('menu_link_content' != $entity_type || 'parent' != $field_name);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DefaultFieldHandler::supports public static function Check if this handler supports the given field instance. Overrides FieldHandlerInterface::supports
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
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::definePropertyAtType public function Provide the Sync Core with the right property definition so this field can be stored and synchronized. Overrides FieldHandlerInterface::definePropertyAtType 1
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::getHandlerSettings public function Get the handler settings. Overrides FieldHandlerInterface::getHandlerSettings 3
FieldHandlerBase::pull public function Overrides FieldHandlerInterface::pull 8
FieldHandlerBase::push public function Overrides FieldHandlerInterface::push 8
FieldHandlerBase::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 FieldHandlerInterface::validateHandlerSettings 1
FieldHandlerBase::__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.