class RelatedProperties in Salesforce Suite 8.4
Same name and namespace in other branches
- 8.3 modules/salesforce_mapping/src/Plugin/SalesforceMappingField/RelatedProperties.php \Drupal\salesforce_mapping\Plugin\SalesforceMappingField\RelatedProperties
- 5.0.x modules/salesforce_mapping/src/Plugin/SalesforceMappingField/RelatedProperties.php \Drupal\salesforce_mapping\Plugin\SalesforceMappingField\RelatedProperties
Adapter for entity Reference and fields.
Plugin annotation
@Plugin(
id = "RelatedProperties",
label = @Translation("Related Entity Properties")
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\salesforce_mapping\SalesforceMappingFieldPluginBase implements SalesforceMappingFieldPluginInterface
- class \Drupal\salesforce_mapping\Plugin\SalesforceMappingField\RelatedProperties
- class \Drupal\salesforce_mapping\SalesforceMappingFieldPluginBase implements SalesforceMappingFieldPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of RelatedProperties
File
- modules/
salesforce_mapping/ src/ Plugin/ SalesforceMappingField/ RelatedProperties.php, line 21
Namespace
Drupal\salesforce_mapping\Plugin\SalesforceMappingFieldView source
class RelatedProperties extends SalesforceMappingFieldPluginBase {
/**
* {@inheritdoc}
*/
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
$pluginForm = parent::buildConfigurationForm($form, $form_state);
// @TODO inspecting the form and form_state feels wrong, but haven't found a good way to get the entity from config before the config is saved.
$options = $this
->getConfigurationOptions($form['#entity']);
if (empty($options)) {
$pluginForm['drupal_field_value'] += [
'#markup' => $this
->t('No available entity reference fields.'),
];
}
else {
$pluginForm['drupal_field_value'] += [
'#type' => 'select',
'#options' => $options,
'#empty_option' => $this
->t('- Select -'),
'#default_value' => $this
->config('drupal_field_value'),
'#description' => $this
->t('Select a property from the referenced field.<br />If more than one entity is referenced, the entity at delta zero will be used.<br />An entity reference field will be used to sync an identifier, e.g. Salesforce ID and Node ID.'),
];
}
return $pluginForm;
}
/**
* {@inheritdoc}
*/
public function value(EntityInterface $entity, SalesforceMappingInterface $mapping) {
[
$field_name,
$referenced_field_name,
] = explode(':', $this
->config('drupal_field_value'), 2);
// Since we're not setting hard restrictions around bundles/fields, we may
// have a field that doesn't exist for the given bundle/entity. In that
// case, calling get() on an entity with a non-existent field argument
// causes an exception during entity save. Probably a bug, but I haven't
// found it in the issue queue. So, just check first to make sure the field
// exists.
$instances = $this->entityFieldManager
->getFieldDefinitions($mapping
->get('drupal_entity_type'), $mapping
->get('drupal_bundle'));
if (empty($instances[$field_name])) {
return;
}
$field = $entity
->get($field_name);
if (empty($field->entity)) {
// This reference field is blank.
return;
}
try {
$describe = $this->salesforceClient
->objectDescribe($mapping
->getSalesforceObjectType());
$field_definition = $describe
->getField($this
->config('salesforce_field'));
if ($field_definition['type'] == 'multipicklist') {
$values = [];
foreach ($field as $ref_entity) {
if (!$ref_entity->entity
->get($referenced_field_name)
->isEmpty()) {
$values[] = $ref_entity->entity
->get($referenced_field_name)->value;
}
}
return implode(';', $values);
}
else {
return $field->entity
->get($referenced_field_name)->value;
}
} catch (\Exception $e) {
return NULL;
}
}
/**
* {@inheritdoc}
*/
public function getPluginDefinition() {
$definition = parent::getPluginDefinition();
$definition['config_dependencies']['config'] = [];
$field_name = $this
->config('drupal_field_value');
if (strpos($field_name, ':')) {
[
$field_name,
$dummy,
] = explode(':', $field_name, 2);
}
// Add reference field.
if ($field = FieldConfig::loadByName($this->mapping
->getDrupalEntityType(), $this->mapping
->getDrupalBundle(), $field_name)) {
$definition['config_dependencies']['config'][] = $field
->getConfigDependencyName();
// Add dependencies of referenced field.
foreach ($field
->getDependencies() as $type => $dependency) {
foreach ($dependency as $item) {
$definition['config_dependencies'][$type][] = $item;
}
}
}
return $definition;
}
/**
* {@inheritdoc}
*/
public function checkFieldMappingDependency(array $dependencies) {
$definition = $this
->getPluginDefinition();
foreach ($definition['config_dependencies'] as $type => $dependency) {
foreach ($dependency as $item) {
if (!empty($dependencies[$type][$item])) {
return TRUE;
}
}
}
}
/**
* Form options helper.
*/
protected function getConfigurationOptions($mapping) {
$instances = $this->entityFieldManager
->getFieldDefinitions($mapping
->get('drupal_entity_type'), $mapping
->get('drupal_bundle'));
if (empty($instances)) {
return;
}
$options = [];
// Loop over every field on the mapped entity. For reference fields, expose
// all properties of the referenced entity.
foreach ($instances as $instance) {
if (!$this
->instanceOfEntityReference($instance)) {
continue;
}
$settings = $instance
->getSettings();
$entity_type_id = $settings['target_type'];
$properties = [];
$entity_type = $this->entityTypeManager
->getDefinition($entity_type_id);
// exclude non-fieldables
if ($entity_type
->entityClassImplements(FieldableEntityInterface::class)) {
foreach ($this->entityTypeBundleInfo
->getBundleInfo($entity_type_id) as $bundle => $bundle_info) {
// If target bundles is specified, limit which bundles are visible.
if (!empty($settings['handler_settings']['target_bundles']) && !in_array($bundle, $settings['handler_settings']['target_bundles'])) {
continue;
}
$properties += $this->entityFieldManager
->getFieldDefinitions($entity_type_id, $bundle);
}
}
foreach ($properties as $key => $property) {
$options[(string) $instance
->getLabel()][$instance
->getName() . ':' . $key] = $property
->getLabel();
}
}
if (empty($options)) {
return;
}
// Alphabetize options for UI.
foreach ($options as $group => &$option_set) {
asort($option_set);
}
asort($options);
return $options;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
RelatedProperties:: |
public | function |
Form constructor. Overrides SalesforceMappingFieldPluginBase:: |
|
RelatedProperties:: |
public | function |
On dependency removal, determine if this plugin needs to be removed. Overrides SalesforceMappingFieldPluginBase:: |
|
RelatedProperties:: |
protected | function | Form options helper. | |
RelatedProperties:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginBase:: |
|
RelatedProperties:: |
public | function |
Given a Drupal entity, return the outbound value. Overrides SalesforceMappingFieldPluginInterface:: |
|
SalesforceMappingFieldPluginBase:: |
protected | property | Entity field manager service. | |
SalesforceMappingFieldPluginBase:: |
protected | property | Entity type bundle info service. | |
SalesforceMappingFieldPluginBase:: |
protected | property | Entity type manager service. | |
SalesforceMappingFieldPluginBase:: |
protected | property | Event dispatcher service. | |
SalesforceMappingFieldPluginBase:: |
protected | property | The machine name of the mapping. | |
SalesforceMappingFieldPluginBase:: |
protected | property | The label of the mapping. | |
SalesforceMappingFieldPluginBase:: |
protected | property | Storage handler for Mapped Objects. | |
SalesforceMappingFieldPluginBase:: |
protected | property | The mapping to which this instance is attached. | |
SalesforceMappingFieldPluginBase:: |
protected | property | Storage handler for SF mappings. | |
SalesforceMappingFieldPluginBase:: |
protected | property | Salesforce client service. | |
SalesforceMappingFieldPluginBase:: |
protected | function | Helper for buildConfigurationForm() to build a broken field plugin. | |
SalesforceMappingFieldPluginBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
|
SalesforceMappingFieldPluginBase:: |
public | function |
In order to set a config value to null, use setConfiguration() Overrides SalesforceMappingFieldPluginInterface:: |
|
SalesforceMappingFieldPluginBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
2 |
SalesforceMappingFieldPluginBase:: |
public | function |
Gets default configuration for this plugin. Overrides ConfigurableInterface:: |
|
SalesforceMappingFieldPluginBase:: |
public | function |
Used for returning values by key. Overrides SalesforceMappingFieldPluginInterface:: |
|
SalesforceMappingFieldPluginBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurableInterface:: |
|
SalesforceMappingFieldPluginBase:: |
protected | function | Helper method to get the Field Type of the given Field Data Definition. | 1 |
SalesforceMappingFieldPluginBase:: |
protected | function | Helper method to get the Data Definition for the current field. | 1 |
SalesforceMappingFieldPluginBase:: |
protected | function | Helper to retreive a list of fields for a given object type. | |
SalesforceMappingFieldPluginBase:: |
protected | function | Return TRUE if the given field uses an entity reference handler. | |
SalesforceMappingFieldPluginBase:: |
public static | function |
Determine whether this plugin is allowed for a given mapping. Overrides SalesforceMappingFieldPluginInterface:: |
4 |
SalesforceMappingFieldPluginBase:: |
public | function |
Returns label of the mapping field plugin. Overrides SalesforceMappingFieldPluginInterface:: |
|
SalesforceMappingFieldPluginBase:: |
public | function |
Whether this plugin supports "pull" operations. Overrides SalesforceMappingFieldPluginInterface:: |
6 |
SalesforceMappingFieldPluginBase:: |
public | function |
Pull callback for field plugins. Overrides SalesforceMappingFieldPluginInterface:: |
4 |
SalesforceMappingFieldPluginBase:: |
public | function |
Whether this plugin supports "push" operations. Overrides SalesforceMappingFieldPluginInterface:: |
1 |
SalesforceMappingFieldPluginBase:: |
public | function |
Munge the value that's being prepared to push to Salesforce. Overrides SalesforceMappingFieldPluginInterface:: |
|
SalesforceMappingFieldPluginBase:: |
protected | function | Wraper for plugin.manager.entity_reference_selection service. | |
SalesforceMappingFieldPluginBase:: |
public | function |
Used for returning values by key. Overrides SalesforceMappingFieldPluginInterface:: |
|
SalesforceMappingFieldPluginBase:: |
public | function |
Sets the configuration for this plugin instance. Overrides ConfigurableInterface:: |
|
SalesforceMappingFieldPluginBase:: |
public | function |
Implements PluginFormInterface::submitConfigurationForm(). Overrides PluginFormInterface:: |
1 |
SalesforceMappingFieldPluginBase:: |
public | function |
Implements PluginFormInterface::validateConfigurationForm(). Overrides PluginFormInterface:: |
1 |
SalesforceMappingFieldPluginBase:: |
public | function |
SalesforceMappingFieldPluginBase constructor. Overrides PluginBase:: |
1 |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |