|
| 1 | +<?php |
| 2 | +/** |
| 3 | + * @file |
| 4 | + * Displays the time it will take to read content on your site. |
| 5 | + */ |
| 6 | + |
| 7 | +/** |
| 8 | + * Implements hook_form_FORM_ID_alter() for node_type_form. |
| 9 | + */ |
| 10 | +function read_time_form_node_type_form_alter(&$form, &$form_state, $form_id) { |
| 11 | + $type = $form['#node_type']; |
| 12 | + $defaults = read_time_defaults(); |
| 13 | + |
| 14 | + // Get text fields in this bundle. |
| 15 | + $field_instances = field_info_instances('node', $type->type); |
| 16 | + foreach ($field_instances as $field => $field_instance) { |
| 17 | + $field_info = field_info_field($field); |
| 18 | + if (in_array($field_info['type'], array('text', 'text_long', 'text_with_summary'))) { |
| 19 | + $fields[$field] = $field_instance['label']; |
| 20 | + } |
| 21 | + } |
| 22 | + |
| 23 | + $form['read_time'] = array( |
| 24 | + '#type' => 'fieldset', |
| 25 | + '#title' => t('Read time'), |
| 26 | + '#group' => 'additional_settings', |
| 27 | + ); |
| 28 | + $form['read_time']['read_time_fields'] = array( |
| 29 | + '#type' => 'checkboxes', |
| 30 | + '#title' => t('Fields'), |
| 31 | + '#description' => t('Calculate the combined read time of these fields.'), |
| 32 | + '#options' => $fields, |
| 33 | + '#multiple' => TRUE, |
| 34 | + '#default_value' => variable_get('read_time_fields_' . $type->type, $defaults['fields']), |
| 35 | + ); |
| 36 | + $form['read_time']['read_time_wpm'] = array( |
| 37 | + '#type' => 'textfield', |
| 38 | + '#title' => t('Words per minute'), |
| 39 | + '#description' => t('Average reading speed used for the calculation.'), |
| 40 | + '#size' => 2, |
| 41 | + '#maxlength' => 3, |
| 42 | + '#element_validate' => array('element_validate_integer_positive'), |
| 43 | + '#default_value' => variable_get('read_time_wpm_' . $type->type, $defaults['wpm']), |
| 44 | + ); |
| 45 | + $form['read_time']['read_time_format'] = array( |
| 46 | + '#type' => 'select', |
| 47 | + '#title' => t('Format'), |
| 48 | + '#description' => t('How the calculation will be formatted.'), |
| 49 | + '#options' => array( |
| 50 | + 'hour_short' => t('Hours & minutes, short (1 hr, 5 mins)'), |
| 51 | + 'hour_long' => t('Hours & minutes, long (1 hour, 5 minutes)'), |
| 52 | + 'min_short' => t('Minutes, short (65 mins)'), |
| 53 | + 'min_long' => t('Minutes, long (65 minutes)'), |
| 54 | + ), |
| 55 | + '#default_value' => variable_get('read_time_format_' . $type->type, $defaults['format']), |
| 56 | + ); |
| 57 | + $form['read_time']['read_time_display'] = array( |
| 58 | + '#type' => 'textfield', |
| 59 | + '#title' => t('Read time display'), |
| 60 | + '#description' => t("How the read time will be displayed. Use <em>%read_time</em> to output the read time formatted as above."), |
| 61 | + '#default_value' => variable_get('read_time_display_' . $type->type, $defaults['display']), |
| 62 | + ); |
| 63 | +} |
| 64 | + |
| 65 | +/** |
| 66 | + * Implements hook_field_extra_fields(). |
| 67 | + */ |
| 68 | +function read_time_field_extra_fields() { |
| 69 | + foreach (field_info_bundles('node') as $bundle => $bundle_info) { |
| 70 | + $extra['node'][$bundle]['display'] = array( |
| 71 | + 'read_time' => array( |
| 72 | + 'label' => t('Read time'), |
| 73 | + 'description' => t('Read time'), |
| 74 | + 'weight' => 0, |
| 75 | + ), |
| 76 | + ); |
| 77 | + } |
| 78 | + |
| 79 | + return $extra; |
| 80 | +} |
| 81 | + |
| 82 | +/** |
| 83 | + * Implements hook_node_insert(). |
| 84 | + */ |
| 85 | +function read_time_node_insert($node) { |
| 86 | + $read_time = read_time_calculate($node); |
| 87 | + |
| 88 | + db_insert('read_time') |
| 89 | + ->fields(array( |
| 90 | + 'nid' => $node->nid, |
| 91 | + 'read_time' => $read_time, |
| 92 | + )) |
| 93 | + ->execute(); |
| 94 | +} |
| 95 | + |
| 96 | +/** |
| 97 | + * Implements hook_node_update(). |
| 98 | + */ |
| 99 | +function read_time_node_update($node) { |
| 100 | + $read_time = read_time_calculate($node); |
| 101 | + |
| 102 | + db_merge('read_time') |
| 103 | + ->key(array( |
| 104 | + 'nid' => $node->nid, |
| 105 | + )) |
| 106 | + ->fields(array( |
| 107 | + 'read_time' => $read_time, |
| 108 | + )) |
| 109 | + ->execute(); |
| 110 | +} |
| 111 | + |
| 112 | +/** |
| 113 | + * Implements hook_node_view(). |
| 114 | + */ |
| 115 | +function read_time_node_view($node, $view_mode, $langcode) { |
| 116 | + // Get read time field settings. |
| 117 | + $display_settings = field_extra_fields_get_display('node', $node->type, $view_mode); |
| 118 | + $settings = $display_settings['read_time']; |
| 119 | + |
| 120 | + if ($settings['visible']) { |
| 121 | + // Get read time from database. |
| 122 | + $read_time = db_query('SELECT read_time FROM {read_time} WHERE nid = :nid', array( |
| 123 | + ':nid' => $node->nid, |
| 124 | + ))->fetchField(); |
| 125 | + |
| 126 | + // Calculate read time if it doesn't exist and save to database. |
| 127 | + if (empty($read_time)) { |
| 128 | + $read_time = read_time_calculate($node); |
| 129 | + |
| 130 | + db_merge('read_time') |
| 131 | + ->key(array( |
| 132 | + 'nid' => $node->nid, |
| 133 | + )) |
| 134 | + ->fields(array( |
| 135 | + 'read_time' => $read_time, |
| 136 | + )) |
| 137 | + ->execute(); |
| 138 | + } |
| 139 | + |
| 140 | + // Display read time with node. |
| 141 | + $node->content['read_time'] = array( |
| 142 | + '#markup' => '<span class="read-time">' . $read_time . '</span>', |
| 143 | + '#weight' => $settings['weight'], |
| 144 | + ); |
| 145 | + } |
| 146 | +} |
| 147 | + |
| 148 | +/** |
| 149 | + * Implements hook_node_delete(). |
| 150 | + */ |
| 151 | +function read_time_node_delete($node) { |
| 152 | + db_delete('read_time') |
| 153 | + ->condition('nid', $node->nid) |
| 154 | + ->execute(); |
| 155 | +} |
| 156 | + |
| 157 | +/** |
| 158 | + * Implements hook_node_type_delete(). |
| 159 | + */ |
| 160 | +function read_time_node_type_delete($info) { |
| 161 | + variable_del('read_time_fields_' . $info->type); |
| 162 | + variable_del('read_time_wpm_' . $info->type); |
| 163 | + variable_del('read_time_format_' . $info->type); |
| 164 | + variable_del('read_time_display_' . $info->type); |
| 165 | +} |
| 166 | + |
| 167 | +/** |
| 168 | + * Calculate read time. |
| 169 | + */ |
| 170 | +function read_time_calculate($node) { |
| 171 | + $defaults = read_time_defaults(); |
| 172 | + |
| 173 | + // Get read time bundle settings. |
| 174 | + $fields = variable_get('read_time_fields_' . $node->type, $defaults['fields']); |
| 175 | + $wpm = variable_get('read_time_wpm_' . $node->type, $defaults['wpm']); |
| 176 | + $format = variable_get('read_time_format_' . $node->type, $defaults['format']); |
| 177 | + $display = variable_get('read_time_display_' . $node->type, $defaults['display']); |
| 178 | + |
| 179 | + // Get fields to calculate read time of. |
| 180 | + $field_words = ''; |
| 181 | + foreach ($fields as $field) { |
| 182 | + $field_items = field_get_items('node', $node, $field); |
| 183 | + foreach ($field_items as $field_item) { |
| 184 | + $field_words .= strip_tags($field_item['value']); |
| 185 | + } |
| 186 | + } |
| 187 | + |
| 188 | + // Calculate read time. |
| 189 | + $words = str_word_count($field_words); |
| 190 | + $time = $words / $wpm; |
| 191 | + |
| 192 | + // Format read time. |
| 193 | + if (in_array($format, array('hour_short', 'hour_long'))) { |
| 194 | + $hours = floor($time / 60); |
| 195 | + $minutes = ceil(fmod($time, 60)); |
| 196 | + } else { |
| 197 | + $minutes = ceil($time); |
| 198 | + } |
| 199 | + if (in_array($format, array('hour_long', 'min_long'))) { |
| 200 | + $hour_suffix = 'hour'; |
| 201 | + $min_suffix = 'minute'; |
| 202 | + } else { |
| 203 | + $hour_suffix = 'hr'; |
| 204 | + $min_suffix = 'min'; |
| 205 | + } |
| 206 | + $minute_format = format_plural($minutes, '1 ' . $min_suffix, '@count ' . $min_suffix . 's'); |
| 207 | + if (!empty($hours)) { |
| 208 | + $hour_format = format_plural($hours, '1 ' . $hour_suffix, '@count ' . $hour_suffix . 's'); |
| 209 | + $read_time = format_string('@h, @m', array('@h' => $hour_format, '@m' => $minute_format)); |
| 210 | + } else { |
| 211 | + $read_time = $minute_format; |
| 212 | + } |
| 213 | + |
| 214 | + return check_plain(str_replace('%read_time', $read_time, $display)); |
| 215 | +} |
| 216 | + |
| 217 | +/** |
| 218 | + * Store default settings. |
| 219 | + */ |
| 220 | +function read_time_defaults() { |
| 221 | + return array( |
| 222 | + 'fields' => array('body'), |
| 223 | + 'wpm' => '225', |
| 224 | + 'format' => 'hour_short', |
| 225 | + 'display' => t('Read time: %read_time'), |
| 226 | + ); |
| 227 | +} |
| 228 | + |
0 commit comments