View source
<?php
namespace Drupal\image\Plugin\Field\FieldType;
use Drupal\Component\Utility\Random;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Field\FieldDefinitionInterface;
use Drupal\Core\Field\FieldStorageDefinitionInterface;
use Drupal\Core\File\Exception\FileException;
use Drupal\Core\File\FileSystemInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\StreamWrapper\StreamWrapperInterface;
use Drupal\Core\TypedData\DataDefinition;
use Drupal\file\Entity\File;
use Drupal\file\Plugin\Field\FieldType\FileItem;
class ImageItem extends FileItem {
protected $entityManager;
public static function defaultStorageSettings() {
return [
'default_image' => [
'uuid' => NULL,
'alt' => '',
'title' => '',
'width' => NULL,
'height' => NULL,
],
] + parent::defaultStorageSettings();
}
public static function defaultFieldSettings() {
$settings = [
'file_extensions' => 'png gif jpg jpeg',
'alt_field' => 1,
'alt_field_required' => 1,
'title_field' => 0,
'title_field_required' => 0,
'max_resolution' => '',
'min_resolution' => '',
'default_image' => [
'uuid' => NULL,
'alt' => '',
'title' => '',
'width' => NULL,
'height' => NULL,
],
] + parent::defaultFieldSettings();
unset($settings['description_field']);
return $settings;
}
public static function schema(FieldStorageDefinitionInterface $field_definition) {
return [
'columns' => [
'target_id' => [
'description' => 'The ID of the file entity.',
'type' => 'int',
'unsigned' => TRUE,
],
'alt' => [
'description' => "Alternative image text, for the image's 'alt' attribute.",
'type' => 'varchar',
'length' => 512,
],
'title' => [
'description' => "Image title text, for the image's 'title' attribute.",
'type' => 'varchar',
'length' => 1024,
],
'width' => [
'description' => 'The width of the image in pixels.',
'type' => 'int',
'unsigned' => TRUE,
],
'height' => [
'description' => 'The height of the image in pixels.',
'type' => 'int',
'unsigned' => TRUE,
],
],
'indexes' => [
'target_id' => [
'target_id',
],
],
'foreign keys' => [
'target_id' => [
'table' => 'file_managed',
'columns' => [
'target_id' => 'fid',
],
],
],
];
}
public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
$properties = parent::propertyDefinitions($field_definition);
unset($properties['display']);
unset($properties['description']);
$properties['alt'] = DataDefinition::create('string')
->setLabel(t('Alternative text'))
->setDescription(t("Alternative image text, for the image's 'alt' attribute."));
$properties['title'] = DataDefinition::create('string')
->setLabel(t('Title'))
->setDescription(t("Image title text, for the image's 'title' attribute."));
$properties['width'] = DataDefinition::create('integer')
->setLabel(t('Width'))
->setDescription(t('The width of the image in pixels.'));
$properties['height'] = DataDefinition::create('integer')
->setLabel(t('Height'))
->setDescription(t('The height of the image in pixels.'));
return $properties;
}
public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) {
$element = [];
$settings = $this
->getFieldDefinition()
->getFieldStorageDefinition()
->getSettings();
$scheme_options = \Drupal::service('stream_wrapper_manager')
->getNames(StreamWrapperInterface::WRITE_VISIBLE);
$element['uri_scheme'] = [
'#type' => 'radios',
'#title' => t('Upload destination'),
'#options' => $scheme_options,
'#default_value' => $settings['uri_scheme'],
'#description' => t('Select where the final files should be stored. Private file storage has significantly more overhead than public files, but allows restricted access to files within this field.'),
];
static::defaultImageForm($element, $settings);
$element['default_image']['#description'] = t('If no image is uploaded, this image will be shown on display.');
return $element;
}
public function fieldSettingsForm(array $form, FormStateInterface $form_state) {
$element = parent::fieldSettingsForm($form, $form_state);
$settings = $this
->getSettings();
$max_resolution = explode('x', $settings['max_resolution']) + [
'',
'',
];
$element['max_resolution'] = [
'#type' => 'item',
'#title' => t('Maximum image resolution'),
'#element_validate' => [
[
get_class($this),
'validateResolution',
],
],
'#weight' => 4.1,
'#description' => t('The maximum allowed image size expressed as WIDTH×HEIGHT (e.g. 640×480). Leave blank for no restriction. If a larger image is uploaded, it will be resized to reflect the given width and height. Resizing images on upload will cause the loss of <a href="http://wikipedia.org/wiki/Exchangeable_image_file_format">EXIF data</a> in the image.'),
];
$element['max_resolution']['x'] = [
'#type' => 'number',
'#title' => t('Maximum width'),
'#title_display' => 'invisible',
'#default_value' => $max_resolution[0],
'#min' => 1,
'#field_suffix' => ' × ',
'#prefix' => '<div class="form--inline clearfix">',
];
$element['max_resolution']['y'] = [
'#type' => 'number',
'#title' => t('Maximum height'),
'#title_display' => 'invisible',
'#default_value' => $max_resolution[1],
'#min' => 1,
'#field_suffix' => ' ' . t('pixels'),
'#suffix' => '</div>',
];
$min_resolution = explode('x', $settings['min_resolution']) + [
'',
'',
];
$element['min_resolution'] = [
'#type' => 'item',
'#title' => t('Minimum image resolution'),
'#element_validate' => [
[
get_class($this),
'validateResolution',
],
],
'#weight' => 4.2,
'#description' => t('The minimum allowed image size expressed as WIDTH×HEIGHT (e.g. 640×480). Leave blank for no restriction. If a smaller image is uploaded, it will be rejected.'),
];
$element['min_resolution']['x'] = [
'#type' => 'number',
'#title' => t('Minimum width'),
'#title_display' => 'invisible',
'#default_value' => $min_resolution[0],
'#min' => 1,
'#field_suffix' => ' × ',
'#prefix' => '<div class="form--inline clearfix">',
];
$element['min_resolution']['y'] = [
'#type' => 'number',
'#title' => t('Minimum height'),
'#title_display' => 'invisible',
'#default_value' => $min_resolution[1],
'#min' => 1,
'#field_suffix' => ' ' . t('pixels'),
'#suffix' => '</div>',
];
unset($element['description_field']);
$element['alt_field'] = [
'#type' => 'checkbox',
'#title' => t('Enable <em>Alt</em> field'),
'#default_value' => $settings['alt_field'],
'#description' => t('Short description of the image used by screen readers and displayed when the image is not loaded. Enabling this field is recommended.'),
'#weight' => 9,
];
$element['alt_field_required'] = [
'#type' => 'checkbox',
'#title' => t('<em>Alt</em> field required'),
'#default_value' => $settings['alt_field_required'],
'#description' => t('Making this field required is recommended.'),
'#weight' => 10,
'#states' => [
'visible' => [
':input[name="settings[alt_field]"]' => [
'checked' => TRUE,
],
],
],
];
$element['title_field'] = [
'#type' => 'checkbox',
'#title' => t('Enable <em>Title</em> field'),
'#default_value' => $settings['title_field'],
'#description' => t('The title attribute is used as a tooltip when the mouse hovers over the image. Enabling this field is not recommended as it can cause problems with screen readers.'),
'#weight' => 11,
];
$element['title_field_required'] = [
'#type' => 'checkbox',
'#title' => t('<em>Title</em> field required'),
'#default_value' => $settings['title_field_required'],
'#weight' => 12,
'#states' => [
'visible' => [
':input[name="settings[title_field]"]' => [
'checked' => TRUE,
],
],
],
];
static::defaultImageForm($element, $settings);
$element['default_image']['#description'] = t("If no image is uploaded, this image will be shown on display and will override the field's default image.");
return $element;
}
public function preSave() {
parent::preSave();
$width = $this->width;
$height = $this->height;
if ($this->entity && $this->entity instanceof EntityInterface) {
if (empty($width) || empty($height)) {
$image = \Drupal::service('image.factory')
->get($this->entity
->getFileUri());
if ($image
->isValid()) {
$this->width = $image
->getWidth();
$this->height = $image
->getHeight();
}
}
}
else {
trigger_error(sprintf("Missing file with ID %s.", $this->target_id), E_USER_WARNING);
}
}
public static function generateSampleValue(FieldDefinitionInterface $field_definition) {
$random = new Random();
$settings = $field_definition
->getSettings();
static $images = [];
$min_resolution = empty($settings['min_resolution']) ? '100x100' : $settings['min_resolution'];
$max_resolution = empty($settings['max_resolution']) ? '600x600' : $settings['max_resolution'];
$extensions = array_intersect(explode(' ', $settings['file_extensions']), [
'png',
'gif',
'jpg',
'jpeg',
]);
$extension = array_rand(array_combine($extensions, $extensions));
if (!isset($images[$extension][$min_resolution][$max_resolution]) || count($images[$extension][$min_resolution][$max_resolution]) <= 5) {
$file_system = \Drupal::service('file_system');
$tmp_file = $file_system
->tempnam('temporary://', 'generateImage_');
$destination = $tmp_file . '.' . $extension;
try {
$file_system
->move($tmp_file, $destination);
} catch (FileException $e) {
}
if ($path = $random
->image($file_system
->realpath($destination), $min_resolution, $max_resolution)) {
$image = File::create();
$image
->setFileUri($path);
$image
->setOwnerId(\Drupal::currentUser()
->id());
$image
->setMimeType(\Drupal::service('file.mime_type.guesser')
->guess($path));
$image
->setFileName($file_system
->basename($path));
$destination_dir = static::doGetUploadLocation($settings);
$file_system
->prepareDirectory($destination_dir, FileSystemInterface::CREATE_DIRECTORY);
$destination = $destination_dir . '/' . basename($path);
$file = file_move($image, $destination);
$images[$extension][$min_resolution][$max_resolution][$file
->id()] = $file;
}
else {
return [];
}
}
else {
$image_index = array_rand($images[$extension][$min_resolution][$max_resolution]);
$file = $images[$extension][$min_resolution][$max_resolution][$image_index];
}
list($width, $height) = getimagesize($file
->getFileUri());
$values = [
'target_id' => $file
->id(),
'alt' => $random
->sentences(4),
'title' => $random
->sentences(4),
'width' => $width,
'height' => $height,
];
return $values;
}
public static function validateResolution($element, FormStateInterface $form_state) {
if (!empty($element['x']['#value']) || !empty($element['y']['#value'])) {
foreach ([
'x',
'y',
] as $dimension) {
if (!$element[$dimension]['#value']) {
$form_state
->setError($element[$dimension], t('Both a height and width value must be specified in the @name field.', [
'@name' => $element['#title'],
]));
return;
}
}
$form_state
->setValueForElement($element, $element['x']['#value'] . 'x' . $element['y']['#value']);
}
else {
$form_state
->setValueForElement($element, '');
}
}
protected function defaultImageForm(array &$element, array $settings) {
$element['default_image'] = [
'#type' => 'details',
'#title' => t('Default image'),
'#open' => TRUE,
];
$fids = [];
$uuid = $settings['default_image']['uuid'];
if ($uuid && ($file = \Drupal::service('entity.repository')
->loadEntityByUuid('file', $uuid))) {
$fids[0] = $file
->id();
}
$element['default_image']['uuid'] = [
'#type' => 'managed_file',
'#title' => t('Image'),
'#description' => t('Image to be shown if no image is uploaded.'),
'#default_value' => $fids,
'#upload_location' => $settings['uri_scheme'] . '://default_images/',
'#element_validate' => [
'\\Drupal\\file\\Element\\ManagedFile::validateManagedFile',
[
get_class($this),
'validateDefaultImageForm',
],
],
'#upload_validators' => $this
->getUploadValidators(),
];
$element['default_image']['alt'] = [
'#type' => 'textfield',
'#title' => t('Alternative text'),
'#description' => t('Short description of the image used by screen readers and displayed when the image is not loaded. This is important for accessibility.'),
'#default_value' => $settings['default_image']['alt'],
'#maxlength' => 512,
];
$element['default_image']['title'] = [
'#type' => 'textfield',
'#title' => t('Title'),
'#description' => t('The title attribute is used as a tooltip when the mouse hovers over the image.'),
'#default_value' => $settings['default_image']['title'],
'#maxlength' => 1024,
];
$element['default_image']['width'] = [
'#type' => 'value',
'#value' => $settings['default_image']['width'],
];
$element['default_image']['height'] = [
'#type' => 'value',
'#value' => $settings['default_image']['height'],
];
}
public static function validateDefaultImageForm(array &$element, FormStateInterface $form_state) {
if (isset($element['fids']['#value'][0])) {
$value = $element['fids']['#value'][0];
if ($file = \Drupal::entityTypeManager()
->getStorage('file')
->load($value)) {
$value = $file
->uuid();
}
}
else {
$value = '';
}
$form_state
->setValueForElement($element, $value);
}
public function isDisplayed() {
return TRUE;
}
protected function getEntityManager() {
@trigger_error(__METHOD__ . ' is deprecated in drupal:8.8.0 and is removed in drupal:9.0.0. Use \\Drupal::entityTypeManager() instead in most cases. If the needed method is not on \\Drupal\\Core\\Entity\\EntityTypeManagerInterface, see the deprecated \\Drupal\\Core\\Entity\\EntityManager to find the correct interface or service. See https://www.drupal.org/node/2549139', E_USER_DEPRECATED);
if (!isset($this->entityManager)) {
$this->entityManager = \Drupal::entityManager();
}
return $this->entityManager;
}
}