-
Notifications
You must be signed in to change notification settings - Fork 1
/
imagefield_tokens.module
278 lines (259 loc) · 11.2 KB
/
imagefield_tokens.module
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
<?php
/**
* @file
* Implements image Alt and Title field defaults with support for tokens.
*/
// Load all field formatter hooks for ImageField Tokens.
$path = backdrop_get_path('module', 'imagefield_tokens');
require_once BACKDROP_ROOT . '/' . $path . '/imagefield_tokens.field.inc';
/**
* Implements hook_field_info_alter().
*/
function imagefield_tokens_field_info_alter(&$info) {
$info['image']['instance_settings'] += array(
'alt_field_default' => '',
'alt_field_sync_title' => 0,
'alt_field_update_on_edit' => 0,
'alt_field_hide' => 0,
'title_field_default' => '',
'title_field_update_on_edit' => 0,
'title_field_hide' => 0,
);
}
/**
* Implements hook_form_FORM_ID_alter() for field-ui-field-edit-form.
*/
function imagefield_tokens_form_field_ui_field_edit_form_alter(&$form, &$form_state) {
$field = $form['#field'];
if ($field['type'] == 'image') {
$instance = $form['#instance'];
$settings = $instance['settings'];
$form_settings = &$form['instance']['settings'];
$form_settings['alt_settings'] = array(
'#type' => 'fieldset',
'#title' => t('<em>Alt</em> field settings'),
'#weight' => 11,
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#parents' => array('instance', 'settings'),
'#states' => array(
'visible' => array(
'#edit-instance-settings-alt-field' => array('checked' => TRUE),
),
),
);
$form_settings['alt_settings']['alt_field_sync_title'] = array(
'#type' => 'checkbox',
'#title' => t('Synchronize with <em>Title</em> field'),
'#description' => t('Replaces <em>Alt</em> field value with the <em>Title</em> field value (below) during entity saving.'),
'#default_value' => $settings['alt_field_sync_title'] ? $settings['alt_field_sync_title'] : FALSE,
'#states' => array(
'disabled' => array(
'#edit-instance-settings-title-field' => array('checked' => FALSE),
),
),
);
$form_settings['alt_settings']['alt_field_update_on_edit'] = array(
'#type' => 'checkbox',
'#title' => t('Update every edit'),
'#description' => t('Reevaluate the default value and replace <em>Alt</em> field value after each edit; recommended with tokens. Requires non-empty Default value.'),
'#default_value' => $settings['alt_field_update_on_edit'] ? $settings['alt_field_update_on_edit'] : FALSE,
'#states' => array(
'visible' => array(
':input[name="instance[settings][alt_field_sync_title]"]' => array('checked' => FALSE),
),
),
);
$form_settings['alt_settings']['alt_field_hide'] = array(
'#type' => 'checkbox',
'#title' => t('Hide field'),
'#description' => t('Hide the <em>Alt</em> field on node edit forms. Use with a Default value.'),
'#default_value' => $settings['alt_field_hide'] ? $settings['alt_field_hide'] : FALSE,
'#states' => array(
'visible' => array(
':input[name="instance[settings][alt_field_sync_title]"]' => array('checked' => FALSE),
),
),
);
$form_settings['alt_settings']['alt_field_default'] = array(
'#type' => 'textfield',
'#title' => t('Default value'),
'#description' => t('Default field value. Used after image upload, and just before field data get saved when <em>Alt</em> field is empty. Tokens are replaced only during entity saving.'),
'#default_value' => $settings['alt_field_default'] ? $settings['alt_field_default'] : '',
'#size' => 60,
'#maxlength' => 128,
'#states' => array(
'visible' => array(
':input[name="instance[settings][alt_field_sync_title]"]' => array('checked' => FALSE),
),
'required' => array(
array(
array(':input[name="instance[settings][alt_field_hide]"]' => array('checked' => TRUE)),
'or',
array(':input[name="instance[settings][alt_field_update_on_edit]"]' => array('checked' => TRUE)),
),
),
),
);
$token_types = array($form['#instance']['entity_type']);
$token_types += token_get_global_token_types();
$form_settings['alt_settings']['token_wrapper'] = array(
'#type' => 'container',
'#states' => array(
'visible' => array(
':input[name="instance[settings][alt_field_sync_title]"]' => array('checked' => FALSE),
),
),
);
$form_settings['alt_settings']['token_wrapper']['token_help'] = array(
'#theme' => 'token_tree',
'#token_types' => $token_types,
'#dialog' => TRUE,
);
$form_settings['title_field']['#weight'] = 12;
$form_settings['title_settings'] = array(
'#type' => 'fieldset',
'#title' => t('<em>Title</em> field settings'),
'#weight' => 13,
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#parents' => array('instance', 'settings'),
'#states' => array(
'visible' => array(
'#edit-instance-settings-title-field' => array('checked' => TRUE),
),
),
);
$form_settings['title_settings']['title_field_update_on_edit'] = array(
'#type' => 'checkbox',
'#title' => t('Update every edit'),
'#description' => t('Reevaluate the default value and replace <em>Title</em> field value after each edit; recommended with tokens. Requires non-empty Default value.'),
'#default_value' => $settings['title_field_update_on_edit'] ? $settings['title_field_update_on_edit'] : FALSE,
);
$form_settings['title_settings']['title_field_hide'] = array(
'#type' => 'checkbox',
'#title' => t('Hide field'),
'#description' => t('Hide the <em>Title</em> field on node edit forms. Use with a Default value.'),
'#default_value' => $settings['title_field_hide'] ? $settings['title_field_hide'] : FALSE,
);
$form_settings['title_settings']['title_field_default'] = array(
'#type' => 'textfield',
'#title' => t('Default value'),
'#description' => t('Default field value. Used after image upload, and just before field data get saved when <em>Title</em> field is empty. Tokens are replaced only during entity saving.'),
'#default_value' => $settings['title_field_default'] ? $settings['title_field_default'] : '',
'#size' => 60,
'#maxlength' => 128,
'#states' => array(
'required' => array(
array(
array(':input[name="instance[settings][title_field_hide]"]' => array('checked' => TRUE)),
'or',
array(':input[name="instance[settings][title_field_update_on_edit]"]' => array('checked' => TRUE)),
),
),
),
);
$form_settings['title_settings']['token_help'] = array(
'#theme' => 'token_tree',
'#token_types' => $token_types,
'#dialog' => TRUE,
);
}
}
/**
* Implements hook_field_widget_form_alter().
*/
function imagefield_tokens_field_widget_form_alter(&$element, &$form_state, $context) {
if ($context['field']['type'] == 'image') {
foreach (element_children($element) as $delta) {
$element[$delta]['#process'][] = 'imagefield_tokens_field_widget_process';
}
}
}
/**
* An element #process callback for the image_image field type.
*/
function imagefield_tokens_field_widget_process($element, &$form_state, $form) {
$instance = field_info_instance($element['#entity_type'], $element['#field_name'], $element['#bundle']);
$settings = $instance['settings'];
$item = $element['#value'];
// Possibly prefill the alt and title fields.
$element['alt']['#default_value'] = isset($item['alt']) ? trim(strip_tags($item['alt'])) : $settings['alt_field_default'];
$element['title']['#default_value'] = isset($item['title']) ? trim(strip_tags($item['title'])) : $settings['title_field_default'];
// Possibly hide the alt and title fields.
if ($settings['alt_field_hide']) {
$element['alt']['#access'] = FALSE;
}
if ($settings['title_field_hide']) {
$element['title']['#access'] = FALSE;
}
return $element;
}
/**
* Implements hook_field_attach_presave().
*/
function imagefield_tokens_field_attach_presave($entity_type, $entity) {
// Includes interation code from _field_invoke().
$options = array(
'default' => FALSE,
'deleted' => FALSE,
'language' => NULL,
);
// Get list of image fields.
$image_fields = array();
foreach (field_info_fields() as $field) {
if ($field['type'] == 'image') {
$image_fields[] = $field['field_name'];
}
}
// Determine the list of instances to iterate on.
list(, , $bundle) = entity_extract_ids($entity_type, $entity);
$instances = _field_invoke_get_instances($entity_type, $bundle, $options);
foreach ($instances as $instance) {
if (in_array($instance['field_name'], $image_fields)) {
$field_name = $instance['field_name'];
$field = field_info_field($field_name);
// Determine the list of languages to iterate on.
$available_languages = field_available_languages($entity_type, $field);
$languages = _field_language_suggestion($available_languages, $options['language'], $field_name);
foreach ($languages as $langcode) {
if (isset($entity->{$field_name}[$langcode])) {
foreach ($entity->{$field_name}[$langcode] as &$field_data) {
$settings = $instance['settings'];
// If ("Update every edit" or title is empty) and a default is specified.
if ((!empty($settings['title_field_update_on_edit']) || empty($field_data['title'])) && !empty($settings['title_field_default'])) {
$field_data['title'] = $settings['title_field_default'];
}
if (isset($field_data['title'])) {
$field_data['title'] = token_replace($field_data['title'], array($entity_type => $entity), array('sanitize' => TRUE, 'clear' => TRUE));
}
// If Alt should equal title field, else same as above.
if (!empty($settings['alt_field_sync_title']) && isset($field_data['title'])) {
$field_data['alt'] = $field_data['title'];
}
else {
if ((!empty($settings['alt_field_update_on_edit']) || empty($field_data['alt'])) && !empty($settings['alt_field_default'])) {
$field_data['alt'] = $settings['alt_field_default'];
}
if (isset($field_data['alt'])) {
$field_data['alt'] = token_replace($field_data['alt'], array($entity_type => $entity), array('sanitize' => TRUE, 'clear' => TRUE));
}
}
// Truncate fields to max allowed length.
// alt=512, title=1024 per image.install.
if (isset($field_data['title'])) {
$field_data['title'] = trim(strip_tags($field_data['title']));
$field_data['title'] = truncate_utf8($field_data['title'], 1024, TRUE, TRUE);
$field_data['title'] = htmlspecialchars_decode($field_data['title'], ENT_QUOTES | ENT_HTML401);
}
if (isset($field_data['alt'])) {
$field_data['alt'] = trim(strip_tags($field_data['alt']));
$field_data['alt'] = truncate_utf8($field_data['alt'], 512, TRUE, TRUE);
$field_data['alt'] = htmlspecialchars_decode($field_data['alt'], ENT_QUOTES | ENT_HTML401);
}
}
}
}
}
}
}