Issue #3368880 by kim.pepper, longwave: Deprecate file.field.inc and move functions to file.module (5067812f) · Commits · project / drupal

core/modules/file/file.field.inc

+1 −216

Original line number	Diff line number	Diff line
		@@ -5,219 +5,4 @@
		* Field module functionality for the File module.
		*/

		use Drupal\Core\Field\FieldDefinitionInterface;
		use Drupal\Core\Field\FieldFilteredMarkup;
		use Drupal\Core\Render\Element;

		/**
		* Prepares variables for multi file form widget templates.
		*
		* Default template: file-widget-multiple.html.twig.
		*
		* @param array $variables
		* An associative array containing:
		* - element: A render element representing the widgets.
		*/
		function template_preprocess_file_widget_multiple(&$variables) {
		$element = $variables['element'];
		// Special ID and classes for draggable tables.
		$weight_class = $element['#id'] . '-weight';
		$table_id = $element['#id'] . '-table';

		// Build up a table of applicable fields.
		$headers = [];
		$headers[] = t('File information');
		if ($element['#display_field']) {
		$headers[] = [
		'data' => t('Display'),
		'class' => ['checkbox'],
		];
		}
		$headers[] = t('Weight');
		$headers[] = t('Operations');

		// Get our list of widgets in order (needed when the form comes back after
		// preview or failed validation).
		$widgets = [];
		foreach (Element::children($element) as $key) {
		$widgets[] = &$element[$key];
		}
		usort($widgets, '_field_multiple_value_form_sort_helper');

		$rows = [];
		foreach ($widgets as &$widget) {
		// Save the uploading row for last.
		if (empty($widget['#files'])) {
		$widget['#title'] = $element['#file_upload_title'];
		$widget['#description'] = \Drupal::service('renderer')->renderPlain($element['#file_upload_description']);
		continue;
		}

		// Delay rendering of the buttons, so that they can be rendered later in the
		// "operations" column.
		$operations_elements = [];
		foreach (Element::children($widget) as $key) {
		if (isset($widget[$key]['#type']) && $widget[$key]['#type'] == 'submit') {
		hide($widget[$key]);
		$operations_elements[] = &$widget[$key];
		}
		}

		// Delay rendering of the "Display" option and the weight selector, so that
		// each can be rendered later in its own column.
		if ($element['#display_field']) {
		hide($widget['display']);
		}
		hide($widget['_weight']);
		$widget['_weight']['#attributes']['class'] = [$weight_class];

		// Render everything else together in a column, without the normal wrappers.
		$row = [];
		$widget['#theme_wrappers'] = [];
		$row[] = \Drupal::service('renderer')->render($widget);

		// Arrange the row with the rest of the rendered columns.
		if ($element['#display_field']) {
		unset($widget['display']['#title']);
		$row[] = [
		'data' => $widget['display'],
		'class' => ['checkbox'],
		];
		}
		$row[] = [
		'data' => $widget['_weight'],
		];

		// Show the buttons that had previously been marked as hidden in this
		// preprocess function. We use show() to undo the earlier hide().
		foreach (Element::children($operations_elements) as $key) {
		show($operations_elements[$key]);
		}
		$row[] = [
		'data' => $operations_elements,
		];
		$rows[] = [
		'data' => $row,
		'class' => isset($widget['#attributes']['class']) ? array_merge($widget['#attributes']['class'], ['draggable']) : ['draggable'],
		];
		}

		$variables['table'] = [
		'#type' => 'table',
		'#header' => $headers,
		'#rows' => $rows,
		'#attributes' => [
		'id' => $table_id,
		],
		'#tabledrag' => [
		[
		'action' => 'order',
		'relationship' => 'sibling',
		'group' => $weight_class,
		],
		],
		'#access' => !empty($rows),
		];

		$variables['element'] = $element;
		}

		/**
		* Prepares variables for file upload help text templates.
		*
		* Default template: file-upload-help.html.twig.
		*
		* @param array $variables
		* An associative array containing:
		* - description: The normal description for this field, specified by the
		* user.
		* - upload_validators: An array of upload validators as used in
		* $element['#upload_validators'].
		*/
		function template_preprocess_file_upload_help(&$variables) {
		$description = $variables['description'];
		$upload_validators = $variables['upload_validators'];
		$cardinality = $variables['cardinality'];

		$descriptions = [];

		if (!empty($description)) {
		$descriptions[] = FieldFilteredMarkup::create($description);
		}
		if (isset($cardinality)) {
		if ($cardinality == -1) {
		$descriptions[] = t('Unlimited number of files can be uploaded to this field.');
		}
		else {
		$descriptions[] = \Drupal::translation()->formatPlural($cardinality, 'One file only.', 'Maximum @count files.');
		}
		}
		if (isset($upload_validators['file_validate_size'])) {
		@trigger_error('\'file_validate_size\' is deprecated in drupal:10.2.0 and is removed from drupal:11.0.0. Use the \'FileSizeLimit\' constraint instead. See https://www.drupal.org/node/3363700', E_USER_DEPRECATED);
		$descriptions[] = t('@size limit.', ['@size' => format_size($upload_validators['file_validate_size'][0])]);
		}
		if (isset($upload_validators['FileSizeLimit'])) {
		$descriptions[] = t('@size limit.', ['@size' => format_size($upload_validators['FileSizeLimit']['fileLimit'])]);
		}

		if (isset($upload_validators['file_validate_extensions'])) {
		@trigger_error('\'file_validate_extensions\' is deprecated in drupal:10.2.0 and is removed from drupal:11.0.0. Use the \'FileExtension\' constraint instead. See https://www.drupal.org/node/3363700', E_USER_DEPRECATED);
		$descriptions[] = t('Allowed types: @extensions.', ['@extensions' => $upload_validators['file_validate_extensions'][0]]);
		}
		if (isset($upload_validators['FileExtension'])) {
		$descriptions[] = t('Allowed types: @extensions.', ['@extensions' => $upload_validators['FileExtension']['extensions']]);
		}

		if (isset($upload_validators['file_validate_image_resolution']) \|\| isset($upload_validators['FileImageDimensions'])) {
		if (isset($upload_validators['file_validate_image_resolution'])) {
		@trigger_error('\'file_validate_image_resolution\' is deprecated in drupal:10.2.0 and is removed from drupal:11.0.0. Use the \'FileImageDimensions\' constraint instead. See https://www.drupal.org/node/3363700', E_USER_DEPRECATED);
		$max = $upload_validators['file_validate_image_resolution'][0];
		$min = $upload_validators['file_validate_image_resolution'][1];
		}
		else {
		$max = $upload_validators['FileImageDimensions']['maxDimensions'];
		$min = $upload_validators['FileImageDimensions']['minDimensions'];
		}
		if ($min && $max && $min == $max) {
		$descriptions[] = t('Images must be exactly <strong>@size</strong> pixels.', ['@size' => $max]);
		}
		elseif ($min && $max) {
		$descriptions[] = t('Images must be larger than <strong>@min</strong> pixels. Images larger than <strong>@max</strong> pixels will be resized.', [
		'@min' => $min,
		'@max' => $max,
		]);
		}
		elseif ($min) {
		$descriptions[] = t('Images must be larger than <strong>@min</strong> pixels.', ['@min' => $min]);
		}
		elseif ($max) {
		$descriptions[] = t('Images larger than <strong>@max</strong> pixels will be resized.', ['@max' => $max]);
		}
		}

		$variables['descriptions'] = $descriptions;
		}

		/**
		* Determine whether a field references files stored in {file_managed}.
		*
		* @param \Drupal\Core\Field\FieldDefinitionInterface $field
		* A field definition.
		*
		* @return bool
		* The field column if the field references {file_managed}.fid, typically
		* fid, FALSE if it does not.
		*/
		function file_field_find_file_reference_column(FieldDefinitionInterface $field) {
		$schema = $field->getFieldStorageDefinition()->getSchema();
		foreach ($schema['foreign keys'] as $data) {
		if ($data['table'] == 'file_managed') {
		foreach ($data['columns'] as $field_column => $column) {
		if ($column == 'fid') {
		return $field_column;
		}
		}
		}
		}
		return FALSE;
		}
		@trigger_error(__FILE__ . ' is deprecated in drupal:10.2.0 and is removed from drupal:11.0.0. Functions have been moved to file.module. See https://www.drupal.org/node/3369330', E_USER_DEPRECATED);

core/modules/file/file.module

+214 −7

Original line number	Diff line number	Diff line
		@@ -10,6 +10,7 @@
		use Drupal\Core\Datetime\Entity\DateFormat;
		use Drupal\Core\Entity\EntityStorageInterface;
		use Drupal\Core\Field\FieldDefinitionInterface;
		use Drupal\Core\Field\FieldFilteredMarkup;
		use Drupal\Core\File\Exception\FileException;
		use Drupal\Core\File\Exception\FileExistsException;
		use Drupal\Core\File\Exception\FileWriteException;
		@@ -35,9 +36,6 @@

		// cspell:ignore abiword

		// Load all Field module hooks for File.
		require_once __DIR__ . '/file.field.inc';

		/**
		* Implements hook_help().
		*/
		@@ -385,15 +383,11 @@ function file_theme() {
		'file_video' => [
		'variables' => ['files' => [], 'attributes' => NULL],
		],

		// From file.field.inc.
		'file_widget_multiple' => [
		'render element' => 'element',
		'file' => 'file.field.inc',
		],
		'file_upload_help' => [
		'variables' => ['description' => NULL, 'upload_validators' => NULL, 'cardinality' => NULL],
		'file' => 'file.field.inc',
		],
		];
		}
		@@ -1093,6 +1087,195 @@ function template_preprocess_file_link(&$variables) {
		$variables['link'] = Link::fromTextAndUrl($link_text, $url->mergeOptions($options))->toRenderable();
		}

		/**
		* Prepares variables for multi file form widget templates.
		*
		* Default template: file-widget-multiple.html.twig.
		*
		* @param array $variables
		* An associative array containing:
		* - element: A render element representing the widgets.
		*/
		function template_preprocess_file_widget_multiple(&$variables) {
		$element = $variables['element'];
		// Special ID and classes for draggable tables.
		$weight_class = $element['#id'] . '-weight';
		$table_id = $element['#id'] . '-table';

		// Build up a table of applicable fields.
		$headers = [];
		$headers[] = t('File information');
		if ($element['#display_field']) {
		$headers[] = [
		'data' => t('Display'),
		'class' => ['checkbox'],
		];
		}
		$headers[] = t('Weight');
		$headers[] = t('Operations');

		// Get our list of widgets in order (needed when the form comes back after
		// preview or failed validation).
		$widgets = [];
		foreach (Element::children($element) as $key) {
		$widgets[] = &$element[$key];
		}
		usort($widgets, '_field_multiple_value_form_sort_helper');

		$rows = [];
		foreach ($widgets as &$widget) {
		// Save the uploading row for last.
		if (empty($widget['#files'])) {
		$widget['#title'] = $element['#file_upload_title'];
		$widget['#description'] = \Drupal::service('renderer')->renderPlain($element['#file_upload_description']);
		continue;
		}

		// Delay rendering of the buttons, so that they can be rendered later in the
		// "operations" column.
		$operations_elements = [];
		foreach (Element::children($widget) as $key) {
		if (isset($widget[$key]['#type']) && $widget[$key]['#type'] == 'submit') {
		hide($widget[$key]);
		$operations_elements[] = &$widget[$key];
		}
		}

		// Delay rendering of the "Display" option and the weight selector, so that
		// each can be rendered later in its own column.
		if ($element['#display_field']) {
		hide($widget['display']);
		}
		hide($widget['_weight']);
		$widget['_weight']['#attributes']['class'] = [$weight_class];

		// Render everything else together in a column, without the normal wrappers.
		$row = [];
		$widget['#theme_wrappers'] = [];
		$row[] = \Drupal::service('renderer')->render($widget);

		// Arrange the row with the rest of the rendered columns.
		if ($element['#display_field']) {
		unset($widget['display']['#title']);
		$row[] = [
		'data' => $widget['display'],
		'class' => ['checkbox'],
		];
		}
		$row[] = [
		'data' => $widget['_weight'],
		];

		// Show the buttons that had previously been marked as hidden in this
		// preprocess function. We use show() to undo the earlier hide().
		foreach (Element::children($operations_elements) as $key) {
		show($operations_elements[$key]);
		}
		$row[] = [
		'data' => $operations_elements,
		];
		$rows[] = [
		'data' => $row,
		'class' => isset($widget['#attributes']['class']) ? array_merge($widget['#attributes']['class'], ['draggable']) : ['draggable'],
		];
		}

		$variables['table'] = [
		'#type' => 'table',
		'#header' => $headers,
		'#rows' => $rows,
		'#attributes' => [
		'id' => $table_id,
		],
		'#tabledrag' => [
		[
		'action' => 'order',
		'relationship' => 'sibling',
		'group' => $weight_class,
		],
		],
		'#access' => !empty($rows),
		];

		$variables['element'] = $element;
		}

		/**
		* Prepares variables for file upload help text templates.
		*
		* Default template: file-upload-help.html.twig.
		*
		* @param array $variables
		* An associative array containing:
		* - description: The normal description for this field, specified by the
		* user.
		* - upload_validators: An array of upload validators as used in
		* $element['#upload_validators'].
		*/
		function template_preprocess_file_upload_help(&$variables) {
		$description = $variables['description'];
		$upload_validators = $variables['upload_validators'];
		$cardinality = $variables['cardinality'];

		$descriptions = [];

		if (!empty($description)) {
		$descriptions[] = FieldFilteredMarkup::create($description);
		}
		if (isset($cardinality)) {
		if ($cardinality == -1) {
		$descriptions[] = t('Unlimited number of files can be uploaded to this field.');
		}
		else {
		$descriptions[] = \Drupal::translation()->formatPlural($cardinality, 'One file only.', 'Maximum @count files.');
		}
		}
		if (isset($upload_validators['file_validate_size'])) {
		@trigger_error('\'file_validate_size\' is deprecated in drupal:10.2.0 and is removed from drupal:11.0.0. Use the \'FileSizeLimit\' constraint instead. See https://www.drupal.org/node/3363700', E_USER_DEPRECATED);
		$descriptions[] = t('@size limit.', ['@size' => format_size($upload_validators['file_validate_size'][0])]);
		}
		if (isset($upload_validators['FileSizeLimit'])) {
		$descriptions[] = t('@size limit.', ['@size' => format_size($upload_validators['FileSizeLimit']['fileLimit'])]);
		}

		if (isset($upload_validators['file_validate_extensions'])) {
		@trigger_error('\'file_validate_extensions\' is deprecated in drupal:10.2.0 and is removed from drupal:11.0.0. Use the \'FileExtension\' constraint instead. See https://www.drupal.org/node/3363700', E_USER_DEPRECATED);
		$descriptions[] = t('Allowed types: @extensions.', ['@extensions' => $upload_validators['file_validate_extensions'][0]]);
		}
		if (isset($upload_validators['FileExtension'])) {
		$descriptions[] = t('Allowed types: @extensions.', ['@extensions' => $upload_validators['FileExtension']['extensions']]);
		}

		if (isset($upload_validators['file_validate_image_resolution']) \|\| isset($upload_validators['FileImageDimensions'])) {
		if (isset($upload_validators['file_validate_image_resolution'])) {
		@trigger_error('\'file_validate_image_resolution\' is deprecated in drupal:10.2.0 and is removed from drupal:11.0.0. Use the \'FileImageDimensions\' constraint instead. See https://www.drupal.org/node/3363700', E_USER_DEPRECATED);
		$max = $upload_validators['file_validate_image_resolution'][0];
		$min = $upload_validators['file_validate_image_resolution'][1];
		}
		else {
		$max = $upload_validators['FileImageDimensions']['maxDimensions'];
		$min = $upload_validators['FileImageDimensions']['minDimensions'];
		}
		if ($min && $max && $min == $max) {
		$descriptions[] = t('Images must be exactly <strong>@size</strong> pixels.', ['@size' => $max]);
		}
		elseif ($min && $max) {
		$descriptions[] = t('Images must be larger than <strong>@min</strong> pixels. Images larger than <strong>@max</strong> pixels will be resized.', [
		'@min' => $min,
		'@max' => $max,
		]);
		}
		elseif ($min) {
		$descriptions[] = t('Images must be larger than <strong>@min</strong> pixels.', ['@min' => $min]);
		}
		elseif ($max) {
		$descriptions[] = t('Images larger than <strong>@max</strong> pixels will be resized.', ['@max' => $max]);
		}
		}

		$variables['descriptions'] = $descriptions;
		}

		/**
		* Gets a class for the icon for a MIME type.
		*
		@@ -1347,3 +1530,27 @@ function file_get_file_references(FileInterface $file, FieldDefinitionInterface
		}
		return $return;
		}

		/**
		* Determine whether a field references files stored in {file_managed}.
		*
		* @param \Drupal\Core\Field\FieldDefinitionInterface $field
		* A field definition.
		*
		* @return bool
		* The field column if the field references {file_managed}.fid, typically
		* fid, FALSE if it does not.
		*/
		function file_field_find_file_reference_column(FieldDefinitionInterface $field) {
		$schema = $field->getFieldStorageDefinition()->getSchema();
		foreach ($schema['foreign keys'] as $data) {
		if ($data['table'] == 'file_managed') {
		foreach ($data['columns'] as $field_column => $column) {
		if ($column == 'fid') {
		return $field_column;
		}
		}
		}
		}
		return FALSE;
		}

core/modules/file/tests/src/Kernel/LegacyFileThemeTest.php

+1 −1

Original line number	Diff line number	Diff line
		@@ -5,7 +5,7 @@
		use Drupal\KernelTests\KernelTestBase;

		/**
		* Tests legacy deprecated functions in file.field.inc.
		* Tests legacy deprecated functions in file.module.
		*
		* @group file
		* @group legacy