class DefaultFileHandler in CMS Content Sync 2.0.x
Same name and namespace in other branches
- 8 src/Plugin/cms_content_sync/field_handler/DefaultFileHandler.php \Drupal\cms_content_sync\Plugin\cms_content_sync\field_handler\DefaultFileHandler
- 2.1.x src/Plugin/cms_content_sync/field_handler/DefaultFileHandler.php \Drupal\cms_content_sync\Plugin\cms_content_sync\field_handler\DefaultFileHandler
Providing a minimalistic implementation for any field type.
Plugin annotation
@FieldHandler(
id = "cms_content_sync_default_file_handler",
label = @Translation("Default File"),
weight = 90
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\cms_content_sync\Plugin\FieldHandlerBase implements FieldHandlerInterface, ContainerFactoryPluginInterface
- class \Drupal\cms_content_sync\Plugin\cms_content_sync\field_handler\DefaultFileHandler
- class \Drupal\cms_content_sync\Plugin\FieldHandlerBase implements FieldHandlerInterface, ContainerFactoryPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of DefaultFileHandler
File
- src/
Plugin/ cms_content_sync/ field_handler/ DefaultFileHandler.php, line 22
Namespace
Drupal\cms_content_sync\Plugin\cms_content_sync\field_handlerView source
class DefaultFileHandler extends FieldHandlerBase {
/**
* {@inheritdoc}
*/
public static function supports($entity_type, $bundle, $field_name, FieldDefinitionInterface $field) {
$allowed = [
'image',
'file_uri',
'file',
'svg_image_field',
];
return false !== in_array($field
->getType(), $allowed);
}
/**
* {@inheritdoc}
*/
public function pull(PullIntent $intent) {
$action = $intent
->getAction();
/**
* @var \Drupal\Core\Entity\FieldableEntityInterface $entity
*/
$entity = $intent
->getEntity();
// Deletion doesn't require any action on field basis for static data.
if (SyncIntent::ACTION_DELETE == $action) {
return false;
}
if ($intent
->shouldMergeChanges()) {
return false;
}
$data = $intent
->getProperty($this->fieldName);
if (empty($data)) {
$entity
->set($this->fieldName, null);
}
else {
$file_ids = [];
foreach ($data as $value) {
/**
* @var \Drupal\file\Entity\File $file
*/
$file = $intent
->loadEmbeddedEntity($value);
$meta = $intent
->getEmbeddedEntityData($value);
if ($file) {
$meta['target_id'] = $file
->id();
$file_ids[] = $meta;
}
}
$entity
->set($this->fieldName, $file_ids);
}
return true;
}
/**
* {@inheritdoc}
*/
public function push(PushIntent $intent) {
$action = $intent
->getAction();
/**
* @var \Drupal\Core\Entity\FieldableEntityInterface $entity
*/
$entity = $intent
->getEntity();
// Deletion doesn't require any action on field basis for static data.
if (SyncIntent::ACTION_DELETE == $action) {
return false;
}
$result = [];
$file = null;
$invalid_subfields = [
'_accessCacheability',
'_attributes',
'_loaded',
'top',
'target_revision_id',
'subform',
];
if ('uri' == $this->fieldDefinition
->getType()) {
$data = $entity
->get($this->fieldName)
->getValue();
foreach ($data as $i => $value) {
$files = \Drupal::entityTypeManager()
->getStorage('file')
->loadByProperties([
'uri' => $value['value'],
]);
$file = empty($files) ? null : reset($files);
if ($file) {
foreach ($invalid_subfields as $invalid_subfield) {
unset($value[$invalid_subfield]);
}
unset($value['value']);
$result[] = $this
->embedFile($intent, $file, $value, $entity->{$this->fieldName}[$i]);
}
}
}
else {
$data = $entity
->get($this->fieldName)
->getValue();
foreach ($data as $i => $value) {
if (empty($value['target_id'])) {
continue;
}
$file = File::load($value['target_id']);
if ($file) {
foreach ($invalid_subfields as $invalid_subfield) {
unset($value[$invalid_subfield]);
}
unset($value['target_id']);
$result[] = $this
->embedFile($intent, $file, $value, $entity->{$this->fieldName}[$i]);
}
}
}
$intent
->setProperty($this->fieldName, $result);
return true;
}
/**
* @param \Drupal\cms_content_sync\PushIntent $intent
* @param \Drupal\file\Entity\File $file
* @param array $value
* @param mixed $item
*
* @return array|object
*/
protected function embedFile($intent, $file, $value, $item) {
// Handle crop entities.
$moduleHandler = \Drupal::service('module_handler');
$crop_types = $intent
->getFlow()
->getEntityTypeConfig('crop', null, true);
if ($moduleHandler
->moduleExists('crop') && !empty($crop_types)) {
$settings = $this->flow
->getEntityTypeConfig('file', 'file');
if ($settings['handler_settings']['export_crop']) {
foreach ($crop_types as $crop_type) {
if (Crop::cropExists($file
->getFileUri(), $crop_type['bundle_name'])) {
$crop = Crop::findCrop($file
->getFileUri(), $crop_type['bundle_name']);
if ($crop) {
$intent
->addDependency($crop);
}
}
}
}
}
return $intent
->addDependency($file, $value);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DefaultFileHandler:: |
protected | function | ||
DefaultFileHandler:: |
public | function |
Overrides FieldHandlerBase:: |
|
DefaultFileHandler:: |
public | function |
Overrides FieldHandlerBase:: |
|
DefaultFileHandler:: |
public static | function |
Check if this handler supports the given field instance. Overrides FieldHandlerInterface:: |
|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
FieldHandlerBase:: |
protected | property | ||
FieldHandlerBase:: |
protected | property | ||
FieldHandlerBase:: |
protected | property | ||
FieldHandlerBase:: |
protected | property | ||
FieldHandlerBase:: |
protected | property | ||
FieldHandlerBase:: |
protected | property | A logger instance. | |
FieldHandlerBase:: |
protected | property | Additional settings as provided by { | |
FieldHandlerBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
FieldHandlerBase:: |
public | function |
Provide the Sync Core with the right property definition so this field can be stored
and synchronized. Overrides FieldHandlerInterface:: |
1 |
FieldHandlerBase:: |
protected | function | 1 | |
FieldHandlerBase:: |
public | function |
Get the allowed pull options. Overrides FieldHandlerInterface:: |
|
FieldHandlerBase:: |
public | function |
Get the allowed push options. Overrides FieldHandlerInterface:: |
|
FieldHandlerBase:: |
public | function |
Overrides FieldHandlerInterface:: |
|
FieldHandlerBase:: |
public | function |
Get the handler settings. Overrides FieldHandlerInterface:: |
3 |
FieldHandlerBase:: |
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:: |
1 |
FieldHandlerBase:: |
public | function |
Constructs a Drupal\rest\Plugin\ResourceBase object. Overrides PluginBase:: |
|
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
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 definition of the plugin implementation. Overrides PluginInspectionInterface:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
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. |