814 lines
28 KiB
Plaintext
814 lines
28 KiB
Plaintext
<?php
|
|
|
|
/**
|
|
* @file
|
|
* Exposes global functionality for creating image styles.
|
|
*/
|
|
|
|
use Drupal\Core\Entity\EntityInterface;
|
|
use Drupal\Core\Language\Language;
|
|
use Drupal\field\Plugin\Core\Entity\Field;
|
|
use Drupal\field\Plugin\Core\Entity\FieldInstance;
|
|
use Drupal\Component\Uuid\Uuid;
|
|
use Drupal\file\Plugin\Core\Entity\File;
|
|
use Drupal\image\ImageStyleInterface;
|
|
use Drupal\image\Plugin\Core\Entity\ImageStyle;
|
|
use Drupal\field\FieldInterface;
|
|
use Drupal\field\FieldInstanceInterface;
|
|
|
|
/**
|
|
* Image style constant for user presets in the database.
|
|
*/
|
|
const IMAGE_STORAGE_NORMAL = 1;
|
|
|
|
/**
|
|
* Image style constant for user presets that override module-defined presets.
|
|
*/
|
|
const IMAGE_STORAGE_OVERRIDE = 2;
|
|
|
|
/**
|
|
* Image style constant for module-defined presets in code.
|
|
*/
|
|
const IMAGE_STORAGE_DEFAULT = 4;
|
|
|
|
/**
|
|
* Image style constant to represent an editable preset.
|
|
*/
|
|
define('IMAGE_STORAGE_EDITABLE', IMAGE_STORAGE_NORMAL | IMAGE_STORAGE_OVERRIDE);
|
|
|
|
/**
|
|
* Image style constant to represent any module-based preset.
|
|
*/
|
|
define('IMAGE_STORAGE_MODULE', IMAGE_STORAGE_OVERRIDE | IMAGE_STORAGE_DEFAULT);
|
|
|
|
/**
|
|
* The name of the query parameter for image derivative tokens.
|
|
*/
|
|
define('IMAGE_DERIVATIVE_TOKEN', 'itok');
|
|
|
|
// Load all Field module hooks for Image.
|
|
require_once __DIR__ . '/image.field.inc';
|
|
|
|
/**
|
|
* Implements hook_help().
|
|
*/
|
|
function image_help($path, $arg) {
|
|
switch ($path) {
|
|
case 'admin/help#image':
|
|
$output = '';
|
|
$output .= '<h3>' . t('About') . '</h3>';
|
|
$output .= '<p>' . t('The Image module allows you to manipulate images on your website. It exposes a setting for using the <em>Image toolkit</em>, allows you to configure <em>Image styles</em> that can be used for resizing or adjusting images on display, and provides an <em>Image</em> field for attaching images to content. For more information, see the online handbook entry for <a href="@image">Image module</a>.', array('@image' => 'http://drupal.org/documentation/modules/image')) . '</p>';
|
|
$output .= '<h3>' . t('Uses') . '</h3>';
|
|
$output .= '<dl>';
|
|
$output .= '<dt>' . t('Manipulating images') . '</dt>';
|
|
$output .= '<dd>' . t('With the Image module you can scale, crop, resize, rotate and desaturate images without affecting the original image using <a href="@image">image styles</a>. When you change an image style, the module automatically refreshes all created images. Every image style must have a name, which will be used in the URL of the generated images. There are two common approaches to naming image styles (which you use will depend on how the image style is being applied):',array('@image' => url('admin/config/media/image-styles')));
|
|
$output .= '<ul><li>' . t('Based on where it will be used: eg. <em>profile-picture</em>') . '</li>';
|
|
$output .= '<li>' . t('Describing its appearance: eg. <em>square-85x85</em>') . '</li></ul>';
|
|
$output .= t('After you create an image style, you can add effects: crop, scale, resize, rotate, and desaturate (other contributed modules provide additional effects). For example, by combining effects as crop, scale, and desaturate, you can create square, grayscale thumbnails.') . '<dd>';
|
|
$output .= '<dt>' . t('Attaching images to content as fields') . '</dt>';
|
|
$output .= '<dd>' . t("Image module also allows you to attach images to content as fields. To add an image field to a <a href='@content-type'>content type</a>, go to the content type's <em>manage fields</em> page, and add a new field of type <em>Image</em>. Attaching images to content this way allows image styles to be applied and maintained, and also allows you more flexibility when theming.", array('@content-type' => url('admin/structure/types'))) . '</dd>';
|
|
$output .= '</dl>';
|
|
return $output;
|
|
case 'admin/config/media/image-styles':
|
|
return '<p>' . t('Image styles commonly provide thumbnail sizes by scaling and cropping images, but can also add various effects before an image is displayed. When an image is displayed with a style, a new file is created and the original image is left unchanged.') . '</p>';
|
|
case 'admin/config/media/image-styles/manage/%/add/%':
|
|
$effect = image_effect_definition_load($arg[7]);
|
|
return isset($effect['help']) ? ('<p>' . $effect['help'] . '</p>') : NULL;
|
|
case 'admin/config/media/image-styles/manage/%/effects/%':
|
|
$effect = ($arg[5] == 'add') ? image_effect_definition_load($arg[6]) : image_effect_load($arg[6], $arg[4]);
|
|
return isset($effect['help']) ? ('<p>' . $effect['help'] . '</p>') : NULL;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Entity URI callback for image style.
|
|
*/
|
|
function image_style_entity_uri(ImageStyle $style) {
|
|
return array(
|
|
'path' => 'admin/config/media/image-styles/manage/' . $style->id(),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Implements hook_menu().
|
|
*/
|
|
function image_menu() {
|
|
$items = array();
|
|
|
|
// Generate image derivatives of publicly available files.
|
|
// If clean URLs are disabled, image derivatives will always be served
|
|
// through the menu system.
|
|
// If clean URLs are enabled and the image derivative already exists,
|
|
// PHP will be bypassed.
|
|
$directory_path = file_stream_wrapper_get_instance_by_scheme('public')->getDirectoryPath();
|
|
$items[$directory_path . '/styles/%image_style'] = array(
|
|
'title' => 'Generate image style',
|
|
'page callback' => 'image_style_deliver',
|
|
'page arguments' => array(count(explode('/', $directory_path)) + 1),
|
|
'access callback' => TRUE,
|
|
'type' => MENU_CALLBACK,
|
|
);
|
|
// Generate and deliver image derivatives of private files.
|
|
// These image derivatives are always delivered through the menu system.
|
|
$items['system/files/styles/%image_style'] = array(
|
|
'title' => 'Generate image style',
|
|
'page callback' => 'image_style_deliver',
|
|
'page arguments' => array(3),
|
|
'access callback' => TRUE,
|
|
'type' => MENU_CALLBACK,
|
|
);
|
|
$items['admin/config/media/image-styles'] = array(
|
|
'title' => 'Image styles',
|
|
'description' => 'Configure styles that can be used for resizing or adjusting images on display.',
|
|
'page callback' => 'image_style_list',
|
|
'access arguments' => array('administer image styles'),
|
|
'file' => 'image.admin.inc',
|
|
);
|
|
$items['admin/config/media/image-styles/list'] = array(
|
|
'title' => 'List',
|
|
'description' => 'List the current image styles on the site.',
|
|
'page callback' => 'image_style_list',
|
|
'access arguments' => array('administer image styles'),
|
|
'type' => MENU_DEFAULT_LOCAL_TASK,
|
|
'file' => 'image.admin.inc',
|
|
);
|
|
$items['admin/config/media/image-styles/add'] = array(
|
|
'title' => 'Add style',
|
|
'description' => 'Add a new image style.',
|
|
'page callback' => 'drupal_get_form',
|
|
'page arguments' => array('image_style_add_form'),
|
|
'access arguments' => array('administer image styles'),
|
|
'type' => MENU_LOCAL_ACTION,
|
|
'weight' => 2,
|
|
'file' => 'image.admin.inc',
|
|
);
|
|
$items['admin/config/media/image-styles/manage/%image_style'] = array(
|
|
'title' => 'Edit style',
|
|
'title callback' => 'entity_page_label',
|
|
'title arguments' => array(5),
|
|
'description' => 'Configure an image style.',
|
|
'page callback' => 'drupal_get_form',
|
|
'page arguments' => array('image_style_form', 5),
|
|
'access arguments' => array('administer image styles'),
|
|
'file' => 'image.admin.inc',
|
|
);
|
|
$items['admin/config/media/image-styles/manage/%image_style/edit'] = array(
|
|
'title' => 'Edit',
|
|
'type' => MENU_DEFAULT_LOCAL_TASK,
|
|
'weight' => -10,
|
|
);
|
|
$items['admin/config/media/image-styles/manage/%image_style/delete'] = array(
|
|
'title' => 'Delete',
|
|
'description' => 'Delete an image style.',
|
|
'type' => MENU_LOCAL_TASK,
|
|
'weight' => 10,
|
|
'route_name' => 'image_style_delete',
|
|
);
|
|
$items['admin/config/media/image-styles/manage/%image_style/effects/%image_effect'] = array(
|
|
'title' => 'Edit image effect',
|
|
'description' => 'Edit an existing effect within a style.',
|
|
'load arguments' => array(5, (string) IMAGE_STORAGE_EDITABLE),
|
|
'page callback' => 'drupal_get_form',
|
|
'page arguments' => array('image_effect_form', 5, 7),
|
|
'access arguments' => array('administer image styles'),
|
|
'file' => 'image.admin.inc',
|
|
);
|
|
$items['admin/config/media/image-styles/manage/%image_style/effects/%image_effect/delete'] = array(
|
|
'title' => 'Delete image effect',
|
|
'description' => 'Delete an existing effect from a style.',
|
|
'route_name' => 'image_effect_delete',
|
|
);
|
|
$items['admin/config/media/image-styles/manage/%image_style/add/%image_effect_definition'] = array(
|
|
'title' => 'Add image effect',
|
|
'description' => 'Add a new effect to a style.',
|
|
'load arguments' => array(5),
|
|
'page callback' => 'drupal_get_form',
|
|
'page arguments' => array('image_effect_form', 5, 7),
|
|
'access arguments' => array('administer image styles'),
|
|
'file' => 'image.admin.inc',
|
|
);
|
|
|
|
return $items;
|
|
}
|
|
|
|
/**
|
|
* Implements hook_theme().
|
|
*/
|
|
function image_theme() {
|
|
return array(
|
|
// Theme functions in image.module.
|
|
'image_style' => array(
|
|
'variables' => array(
|
|
'style_name' => NULL,
|
|
'uri' => NULL,
|
|
'width' => NULL,
|
|
'height' => NULL,
|
|
'alt' => '',
|
|
'title' => NULL,
|
|
'attributes' => array(),
|
|
),
|
|
),
|
|
|
|
// Theme functions in image.admin.inc.
|
|
'image_style_list' => array(
|
|
'variables' => array('styles' => NULL),
|
|
),
|
|
'image_style_effects' => array(
|
|
'render element' => 'form',
|
|
),
|
|
'image_style_preview' => array(
|
|
'variables' => array('style' => NULL),
|
|
),
|
|
'image_anchor' => array(
|
|
'render element' => 'element',
|
|
),
|
|
'image_resize_summary' => array(
|
|
'variables' => array('data' => NULL),
|
|
),
|
|
'image_scale_summary' => array(
|
|
'variables' => array('data' => NULL),
|
|
),
|
|
'image_crop_summary' => array(
|
|
'variables' => array('data' => NULL),
|
|
),
|
|
'image_rotate_summary' => array(
|
|
'variables' => array('data' => NULL),
|
|
),
|
|
|
|
// Theme functions in image.field.inc.
|
|
'image_widget' => array(
|
|
'render element' => 'element',
|
|
),
|
|
'image_formatter' => array(
|
|
'variables' => array('item' => NULL, 'path' => NULL, 'image_style' => NULL),
|
|
),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Implements hook_permission().
|
|
*/
|
|
function image_permission() {
|
|
return array(
|
|
'administer image styles' => array(
|
|
'title' => t('Administer image styles'),
|
|
'description' => t('Create and modify styles for generating image modifications such as thumbnails.'),
|
|
),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Implements hook_form_FORM_ID_alter().
|
|
*/
|
|
function image_form_system_file_system_settings_alter(&$form, &$form_state) {
|
|
$form['#submit'][] = 'image_system_file_system_settings_submit';
|
|
}
|
|
|
|
/**
|
|
* Form submission handler for system_file_system_settings().
|
|
*
|
|
* Adds a menu rebuild after the public file path has been changed, so that the
|
|
* menu router item depending on that file path will be regenerated.
|
|
*/
|
|
function image_system_file_system_settings_submit($form, &$form_state) {
|
|
if ($form['file_public_path']['#default_value'] !== $form_state['values']['file_public_path']) {
|
|
Drupal::state()->set('menu_rebuild_needed', TRUE);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Implements hook_file_download().
|
|
*
|
|
* Control the access to files underneath the styles directory.
|
|
*/
|
|
function image_file_download($uri) {
|
|
$path = file_uri_target($uri);
|
|
|
|
// Private file access for image style derivatives.
|
|
if (strpos($path, 'styles/') === 0) {
|
|
$args = explode('/', $path);
|
|
// Discard the first part of the path (styles).
|
|
array_shift($args);
|
|
// Get the style name from the second part.
|
|
$style_name = array_shift($args);
|
|
// Remove the scheme from the path.
|
|
array_shift($args);
|
|
|
|
// Then the remaining parts are the path to the image.
|
|
$original_uri = file_uri_scheme($uri) . '://' . implode('/', $args);
|
|
|
|
// Check that the file exists and is an image.
|
|
if ($info = image_get_info($uri)) {
|
|
// Check the permissions of the original to grant access to this image.
|
|
$headers = module_invoke_all('file_download', $original_uri);
|
|
// Confirm there's at least one module granting access and none denying access.
|
|
if (!empty($headers) && !in_array(-1, $headers)) {
|
|
return array(
|
|
// Send headers describing the image's size, and MIME-type...
|
|
'Content-Type' => $info['mime_type'],
|
|
'Content-Length' => $info['file_size'],
|
|
// By not explicitly setting them here, this uses normal Drupal
|
|
// Expires, Cache-Control and ETag headers to prevent proxy or
|
|
// browser caching of private images.
|
|
);
|
|
}
|
|
}
|
|
return -1;
|
|
}
|
|
|
|
// Private file access for the original files. Note that we only
|
|
// check access for non-temporary images, since file.module will
|
|
// grant access for all temporary files.
|
|
$files = entity_load_multiple_by_properties('file', array('uri' => $uri));
|
|
if (count($files)) {
|
|
$file = reset($files);
|
|
if ($file->status) {
|
|
return file_file_download($uri, 'image');
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Implements hook_file_move().
|
|
*/
|
|
function image_file_move(File $file, File $source) {
|
|
// Delete any image derivatives at the original image path.
|
|
image_path_flush($source->getFileUri());
|
|
}
|
|
|
|
/**
|
|
* Implements hook_file_predelete().
|
|
*/
|
|
function image_file_predelete(File $file) {
|
|
// Delete any image derivatives of this image.
|
|
image_path_flush($file->getFileUri());
|
|
}
|
|
|
|
/**
|
|
* Clears cached versions of a specific file in all styles.
|
|
*
|
|
* @param $path
|
|
* The Drupal file path to the original image.
|
|
*/
|
|
function image_path_flush($path) {
|
|
$styles = entity_load_multiple('image_style');
|
|
foreach ($styles as $style) {
|
|
$style->flush($path);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Loads an ImageStyle object.
|
|
*
|
|
* @param string $name
|
|
* The ID of the ImageStyle object to load.
|
|
*/
|
|
function image_style_load($name) {
|
|
return entity_load('image_style', $name);
|
|
}
|
|
|
|
/**
|
|
* Gets an array of image styles suitable for using as select list options.
|
|
*
|
|
* @param $include_empty
|
|
* If TRUE a '- None -' option will be inserted in the options array.
|
|
* @return
|
|
* Array of image styles both key and value are set to style name.
|
|
*/
|
|
function image_style_options($include_empty = TRUE) {
|
|
$styles = entity_load_multiple('image_style');
|
|
$options = array();
|
|
if ($include_empty && !empty($styles)) {
|
|
$options[''] = t('- None -');
|
|
}
|
|
foreach ($styles as $name => $style) {
|
|
$options[$name] = $style->label();
|
|
}
|
|
|
|
if (empty($options)) {
|
|
$options[''] = t('No defined styles');
|
|
}
|
|
return $options;
|
|
}
|
|
|
|
/**
|
|
* Page callback: Generates a derivative, given a style and image path.
|
|
*
|
|
* After generating an image, transfer it to the requesting agent.
|
|
*
|
|
* @param \Drupal\image\ImageStyleInterface $style
|
|
* The image style.
|
|
* @param string $scheme
|
|
* The scheme name of the original image file stream wrapper ('public',
|
|
* 'private', 'temporary', etc.).
|
|
*
|
|
* @return \Symfony\Component\HttpFoundation\BinaryFileResponse|\Symfony\Component\HttpFoundation\Response
|
|
* The image to be delivered.
|
|
*
|
|
* @todo Remove this wrapper in https://drupal.org/node/1987712.
|
|
*/
|
|
function image_style_deliver(ImageStyleInterface $style, $scheme) {
|
|
$args = func_get_args();
|
|
// Remove $style and $scheme from the arguments.
|
|
unset($args[0], $args[1]);
|
|
$target = implode('/', $args);
|
|
return $style->deliver($scheme, $target);
|
|
}
|
|
|
|
/**
|
|
* Returns a set of image effects.
|
|
*
|
|
* These image effects are exposed by modules implementing
|
|
* hook_image_effect_info().
|
|
*
|
|
* @return
|
|
* An array of image effects to be used when transforming images.
|
|
* @see hook_image_effect_info()
|
|
* @see image_effect_definition_load()
|
|
*/
|
|
function image_effect_definitions() {
|
|
$language_interface = language(Language::TYPE_INTERFACE);
|
|
|
|
// hook_image_effect_info() includes translated strings, so each language is
|
|
// cached separately.
|
|
$langcode = $language_interface->id;
|
|
|
|
$effects = &drupal_static(__FUNCTION__);
|
|
|
|
if (!isset($effects)) {
|
|
if ($cache = cache()->get("image_effects:$langcode")) {
|
|
$effects = $cache->data;
|
|
}
|
|
else {
|
|
$effects = array();
|
|
include_once __DIR__ . '/image.effects.inc';
|
|
foreach (module_implements('image_effect_info') as $module) {
|
|
foreach (module_invoke($module, 'image_effect_info') as $name => $effect) {
|
|
// Ensure the current toolkit supports the effect.
|
|
$effect['module'] = $module;
|
|
$effect['name'] = $name;
|
|
$effect['data'] = isset($effect['data']) ? $effect['data'] : array();
|
|
$effects[$name] = $effect;
|
|
}
|
|
}
|
|
uasort($effects, '_image_effect_definitions_sort');
|
|
drupal_alter('image_effect_info', $effects);
|
|
cache()->set("image_effects:$langcode", $effects);
|
|
}
|
|
}
|
|
|
|
return $effects;
|
|
}
|
|
|
|
/**
|
|
* Loads the definition for an image effect.
|
|
*
|
|
* The effect definition is a set of core properties for an image effect, not
|
|
* containing any user-settings. The definition defines various functions to
|
|
* call when configuring or executing an image effect. This loader is mostly for
|
|
* internal use within image.module. Use image_effect_load() or
|
|
* entity_load() to get image effects that contain configuration.
|
|
*
|
|
* @param $effect
|
|
* The name of the effect definition to load.
|
|
* @return
|
|
* An array containing the image effect definition with the following keys:
|
|
* - "effect": The unique name for the effect being performed. Usually prefixed
|
|
* with the name of the module providing the effect.
|
|
* - "module": The module providing the effect.
|
|
* - "help": A description of the effect.
|
|
* - "function": The name of the function that will execute the effect.
|
|
* - "form": (optional) The name of a function to configure the effect.
|
|
* - "summary": (optional) The name of a theme function that will display a
|
|
* one-line summary of the effect. Does not include the "theme_" prefix.
|
|
*/
|
|
function image_effect_definition_load($effect) {
|
|
$definitions = image_effect_definitions();
|
|
return isset($definitions[$effect]) ? $definitions[$effect] : NULL;
|
|
}
|
|
|
|
/**
|
|
* Loads a single image effect.
|
|
*
|
|
* @param $ieid
|
|
* The image effect ID.
|
|
* @param $style_name
|
|
* The image style name.
|
|
*
|
|
* @return
|
|
* An image effect array, consisting of the following keys:
|
|
* - "ieid": The unique image effect ID.
|
|
* - "weight": The weight of this image effect within the image style.
|
|
* - "name": The name of the effect definition that powers this image effect.
|
|
* - "data": An array of configuration options for this image effect.
|
|
* Besides these keys, the entirety of the image definition is merged into
|
|
* the image effect array. Returns NULL if the specified effect cannot be
|
|
* found.
|
|
* @see image_effect_definition_load()
|
|
*/
|
|
function image_effect_load($ieid, $style_name) {
|
|
if (($style = entity_load('image_style', $style_name)) && isset($style->effects[$ieid])) {
|
|
$effect = $style->effects[$ieid];
|
|
$definition = image_effect_definition_load($effect['name']);
|
|
$effect = array_merge($definition, $effect);
|
|
// @todo The effect's key name within the style is unknown. It *should* be
|
|
// identical to the ieid, but that is in no way guaranteed. And of course,
|
|
// the ieid key *within* the effect is senseless duplication in the first
|
|
// place. This problem can be eliminated in many places, but especially
|
|
// for loaded menu arguments like %image_effect, the actual router
|
|
// callbacks don't have access to 'ieid' anymore (unless resorting to
|
|
// dirty %index and %map tricks).
|
|
$effect['ieid'] = $ieid;
|
|
return $effect;
|
|
}
|
|
return NULL;
|
|
}
|
|
|
|
/**
|
|
* Saves an image effect.
|
|
*
|
|
* @param ImageStyle $style
|
|
* The image style this effect belongs to.
|
|
* @param array $effect
|
|
* An image effect array. Passed by reference.
|
|
*
|
|
* @return array
|
|
* The saved image effect array. The 'ieid' key will be set for the effect.
|
|
*/
|
|
function image_effect_save($style, &$effect) {
|
|
// Remove all values that are not properties of an image effect.
|
|
// @todo Convert image effects into plugins.
|
|
$effect = array_intersect_key($effect, array_flip(array('ieid', 'module', 'name', 'data', 'weight')));
|
|
|
|
// Generate a unique image effect ID for a new effect.
|
|
if (empty($effect['ieid'])) {
|
|
$uuid = new Uuid();
|
|
$effect['ieid'] = $uuid->generate();
|
|
}
|
|
$style->effects[$effect['ieid']] = $effect;
|
|
$style->save();
|
|
}
|
|
|
|
/**
|
|
* Deletes an image effect.
|
|
*
|
|
* @param ImageStyle $style
|
|
* The image style this effect belongs to.
|
|
* @param $effect
|
|
* An image effect array.
|
|
*/
|
|
function image_effect_delete($style, $effect) {
|
|
unset($style->effects[$effect['ieid']]);
|
|
$style->save();
|
|
}
|
|
|
|
/**
|
|
* Applies an image effect to the image object.
|
|
*
|
|
* @param $image
|
|
* An image object returned by image_load().
|
|
* @param $effect
|
|
* An image effect array.
|
|
* @return
|
|
* TRUE on success. FALSE if unable to perform the image effect on the image.
|
|
*/
|
|
function image_effect_apply($image, $effect) {
|
|
module_load_include('inc', 'image', 'image.effects');
|
|
$function = $effect['effect callback'];
|
|
return $function($image, $effect['data']);
|
|
}
|
|
|
|
/**
|
|
* Returns HTML for an image using a specific image style.
|
|
*
|
|
* @param $variables
|
|
* An associative array containing:
|
|
* - style_name: The name of the style to be used to alter the original image.
|
|
* - uri: The path of the image file relative to the Drupal files directory.
|
|
* This function does not work with images outside the files directory nor
|
|
* with remotely hosted images. This should be in a format such as
|
|
* 'images/image.jpg', or using a stream wrapper such as
|
|
* 'public://images/image.jpg'.
|
|
* - width: The width of the source image (if known).
|
|
* - height: The height of the source image (if known).
|
|
* - alt: The alternative text for text-based browsers.
|
|
* - title: The title text is displayed when the image is hovered in some
|
|
* popular browsers.
|
|
* - attributes: Associative array of attributes to be placed in the img tag.
|
|
*
|
|
* @ingroup themeable
|
|
*/
|
|
function theme_image_style($variables) {
|
|
// @todo Image style loading will be moved outside theme in
|
|
// https://drupal.org/node/2029649
|
|
$style = entity_load('image_style', $variables['style_name']);
|
|
|
|
// Determine the dimensions of the styled image.
|
|
$dimensions = array(
|
|
'width' => $variables['width'],
|
|
'height' => $variables['height'],
|
|
);
|
|
|
|
$style->transformDimensions($dimensions);
|
|
|
|
// Add in the image style name as an HTML class.
|
|
$variables['attributes']['class'][] = 'image-style-' . drupal_html_class($variables['style_name']);
|
|
|
|
$image = array(
|
|
'#theme' => 'image',
|
|
'#width' => $dimensions['width'],
|
|
'#height' => $dimensions['height'],
|
|
'#attributes' => $variables['attributes'],
|
|
'#uri' => $style->buildUrl($variables['uri']),
|
|
);
|
|
|
|
if (isset($variables['alt'])) {
|
|
$image['#alt'] = $variables['alt'];
|
|
}
|
|
if (isset($variables['title'])) {
|
|
$image['#title'] = $variables['title'];
|
|
}
|
|
|
|
return drupal_render($image);
|
|
}
|
|
|
|
/**
|
|
* Accepts a keyword (center, top, left, etc) and returns it as a pixel offset.
|
|
*
|
|
* @param $value
|
|
* @param $current_pixels
|
|
* @param $new_pixels
|
|
*/
|
|
function image_filter_keyword($value, $current_pixels, $new_pixels) {
|
|
switch ($value) {
|
|
case 'top':
|
|
case 'left':
|
|
return 0;
|
|
|
|
case 'bottom':
|
|
case 'right':
|
|
return $current_pixels - $new_pixels;
|
|
|
|
case 'center':
|
|
return $current_pixels / 2 - $new_pixels / 2;
|
|
}
|
|
return $value;
|
|
}
|
|
|
|
/**
|
|
* Internal function for sorting image effect definitions through uasort().
|
|
*
|
|
* @see image_effect_definitions()
|
|
*/
|
|
function _image_effect_definitions_sort($a, $b) {
|
|
return strcasecmp($a['name'], $b['name']);
|
|
}
|
|
|
|
/**
|
|
* Implements hook_entity_presave().
|
|
*
|
|
* Transforms default image of image field from array into single value at save.
|
|
*/
|
|
function image_entity_presave(EntityInterface $entity, $type) {
|
|
$field = FALSE;
|
|
if ($entity instanceof FieldInstance) {
|
|
$field = $entity->getField();
|
|
}
|
|
elseif ($entity instanceof Field) {
|
|
$field = $entity;
|
|
}
|
|
if ($field && $field->type == 'image' && is_array($entity->settings['default_image'])) {
|
|
if (!empty($entity->settings['default_image'][0])) {
|
|
$entity->settings['default_image'] = $entity->settings['default_image'][0];
|
|
}
|
|
else {
|
|
$entity->settings['default_image'] = 0;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Implements hook_ENTITY_TYPE_update() for 'field_entity'.
|
|
*/
|
|
function image_field_entity_update(FieldInterface $field) {
|
|
if ($field->type != 'image') {
|
|
// Only act on image fields.
|
|
return;
|
|
}
|
|
|
|
$prior_field = $field->original;
|
|
|
|
// The value of a managed_file element can be an array if #extended == TRUE.
|
|
$fid_new = (isset($field->settings['default_image']['fids']) ? $field->settings['default_image']['fids'] : $field->settings['default_image']);
|
|
$fid_old = (isset($prior_field->settings['default_image']['fids']) ? $prior_field->settings['default_image']['fids'] : $prior_field->settings['default_image']);
|
|
|
|
$file_new = $fid_new ? file_load($fid_new) : FALSE;
|
|
|
|
if ($fid_new != $fid_old) {
|
|
|
|
// Is there a new file?
|
|
if ($file_new) {
|
|
$file_new->status = FILE_STATUS_PERMANENT;
|
|
$file_new->save();
|
|
file_usage()->add($file_new, 'image', 'default_image', $field->uuid);
|
|
}
|
|
|
|
// Is there an old file?
|
|
if ($fid_old && ($file_old = file_load($fid_old[0]))) {
|
|
file_usage()->delete($file_old, 'image', 'default_image', $field->uuid);
|
|
}
|
|
}
|
|
|
|
// If the upload destination changed, then move the file.
|
|
if ($file_new && (file_uri_scheme($file_new->getFileUri()) != $field->settings['uri_scheme'])) {
|
|
$directory = $field->settings['uri_scheme'] . '://default_images/';
|
|
file_prepare_directory($directory, FILE_CREATE_DIRECTORY);
|
|
file_move($file_new, $directory . $file_new->filename);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Implements hook_ENTITY_TYPE_update() for 'field_instance'.
|
|
*/
|
|
function image_field_instance_update(FieldInstanceInterface $field_instance) {
|
|
$field = $field_instance->getField();
|
|
if ($field->type != 'image') {
|
|
// Only act on image fields.
|
|
return;
|
|
}
|
|
|
|
$prior_instance = $field_instance->original;
|
|
|
|
// The value of a managed_file element can be an array if the #extended
|
|
// property is set to TRUE.
|
|
$fid_new = $field_instance->settings['default_image'];
|
|
if (isset($fid_new['fids'])) {
|
|
$fid_new = $fid_new['fids'];
|
|
}
|
|
$fid_old = $prior_instance->settings['default_image'];
|
|
if (isset($fid_old['fids'])) {
|
|
$fid_old = $fid_old['fids'];
|
|
}
|
|
|
|
// If the old and new files do not match, update the default accordingly.
|
|
$file_new = $fid_new ? file_load($fid_new[0]) : FALSE;
|
|
if ($fid_new != $fid_old) {
|
|
// Save the new file, if present.
|
|
if ($file_new) {
|
|
$file_new->status = FILE_STATUS_PERMANENT;
|
|
$file_new->save();
|
|
file_usage()->add($file_new, 'image', 'default_image', $field_instance->uuid);
|
|
}
|
|
// Delete the old file, if present.
|
|
if ($fid_old && ($file_old = file_load($fid_old[0]))) {
|
|
file_usage()->delete($file_old, 'image', 'default_image', $field_instance->uuid);
|
|
}
|
|
}
|
|
|
|
// If the upload destination changed, then move the file.
|
|
if ($file_new && (file_uri_scheme($file_new->getFileUri()) != $field->settings['uri_scheme'])) {
|
|
$directory = $field->settings['uri_scheme'] . '://default_images/';
|
|
file_prepare_directory($directory, FILE_CREATE_DIRECTORY);
|
|
file_move($file_new, $directory . $file_new->filename);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Implements hook_ENTITY_TYPE_delete() for 'field_entity'.
|
|
*/
|
|
function image_field_entity_delete(FieldInterface $field) {
|
|
if ($field->type != 'image') {
|
|
// Only act on image fields.
|
|
return;
|
|
}
|
|
|
|
// The value of a managed_file element can be an array if #extended == TRUE.
|
|
$fid = (isset($field->settings['default_image']['fids']) ? $field->settings['default_image']['fids'] : $field->settings['default_image']);
|
|
if ($fid && ($file = file_load($fid[0]))) {
|
|
file_usage()->delete($file, 'image', 'default_image', $field->uuid);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Implements hook_ENTITY_TYPE_delete() for 'field_instance'.
|
|
*/
|
|
function image_field_instance_delete(FieldInstanceInterface $field_instance) {
|
|
$field = $field_instance->getField();
|
|
if ($field->type != 'image') {
|
|
// Only act on image fields.
|
|
return;
|
|
}
|
|
|
|
// The value of a managed_file element can be an array if the #extended
|
|
// property is set to TRUE.
|
|
$fid = $field_instance->settings['default_image'];
|
|
if (is_array($fid)) {
|
|
$fid = $fid['fid'];
|
|
}
|
|
|
|
// Remove the default image when the instance is deleted.
|
|
if ($fid && ($file = file_load($fid))) {
|
|
file_usage()->delete($file, 'image', 'default_image', $field_instance->uuid);
|
|
}
|
|
}
|