class SearchApiAlterAddViewedEntity in Search API 7
Search API data alteration callback that adds an URL field for all items.
Hierarchy
- class \SearchApiAbstractAlterCallback implements SearchApiAlterCallbackInterface
Expanded class hierarchy of SearchApiAlterAddViewedEntity
1 string reference to 'SearchApiAlterAddViewedEntity'
File
- includes/
callback_add_viewed_entity.inc, line 11 - Contains SearchApiAlterAddViewedEntity.
View source
class SearchApiAlterAddViewedEntity extends SearchApiAbstractAlterCallback {
/**
* Only support indexes containing entities.
*
* @see SearchApiAlterCallbackInterface::supportsIndex()
*/
public function supportsIndex(SearchApiIndex $index) {
return (bool) $index
->getEntityType();
}
public function configurationForm() {
$view_modes = array();
if ($entity_type = $this->index
->getEntityType()) {
$info = entity_get_info($entity_type);
foreach ($info['view modes'] as $key => $mode) {
$view_modes[$key] = $mode['label'];
}
}
$this->options += array(
'mode' => reset($view_modes),
// Backward compatible definition - if this is an existing config the
// language processing is disabled by default.
'global_language_switch' => !isset($this->options['mode']),
);
if (count($view_modes) > 1) {
$form['mode'] = array(
'#type' => 'select',
'#title' => t('View mode'),
'#options' => $view_modes,
'#default_value' => $this->options['mode'],
);
}
else {
$form['mode'] = array(
'#type' => 'value',
'#value' => $this->options['mode'],
);
if ($view_modes) {
$form['note'] = array(
'#markup' => '<p>' . t('Entities of type %type have only a single view mode. ' . 'Therefore, no selection needs to be made.', array(
'%type' => $info['label'],
)) . '</p>',
);
}
else {
$form['note'] = array(
'#markup' => '<p>' . t('Entities of type %type have no defined view modes. ' . 'This might either mean that they are always displayed the same way, or that they cannot be processed by this alteration at all. ' . 'Please consider this when using this alteration.', array(
'%type' => $info['label'],
)) . '</p>',
);
}
}
$form['global_language_switch'] = array(
'#type' => 'checkbox',
'#title' => t('Adjust environment language when indexing'),
'#description' => t('If enabled, the indexing process will not just set the language for the entity view but also the global environment. This can prevent wrong translations leaking into the indexed data on multi-lingual sites, but causes problems in rare cases. Unless you notice any problems in connection with this, the recommended setting is enabled.'),
'#default_value' => !empty($this->options['global_language_switch']),
);
return $form;
}
public function alterItems(array &$items) {
// Prevent session information from being saved while indexing.
drupal_save_session(FALSE);
// Language handling.
$languages = language_list();
$global_language = array(
'language' => $GLOBALS['language'],
'language_url' => $GLOBALS['language_url'],
'language_content' => $GLOBALS['language_content'],
);
// Force the current user to anonymous to prevent access bypass in search
// indexes.
$original_user = $GLOBALS['user'];
$GLOBALS['user'] = drupal_anonymous_user();
$type = $this->index
->getEntityType();
$mode = empty($this->options['mode']) ? 'full' : $this->options['mode'];
foreach ($items as &$item) {
// Since we can't really know what happens in entity_view() and render(),
// we use try/catch. This will at least prevent some errors, even though
// it's no protection against fatal errors and the like.
try {
// Check if the global language switch is enabled.
if (!empty($this->options['global_language_switch'])) {
// Language handling. We need to overwrite the global language
// configuration because parts of entity rendering won't rely on the
// passed in language (for instance, URL aliases).
if (isset($languages[$item->search_api_language])) {
$GLOBALS['language'] = $languages[$item->search_api_language];
$GLOBALS['language_url'] = $languages[$item->search_api_language];
$GLOBALS['language_content'] = $languages[$item->search_api_language];
}
else {
$GLOBALS['language'] = $global_language['language'];
$GLOBALS['language_url'] = $global_language['language_url'];
$GLOBALS['language_content'] = $global_language['language_content'];
}
}
$render = entity_view($type, array(
entity_id($type, $item) => $item,
), $mode, $item->search_api_language);
$text = render($render);
if (!$text) {
$item->search_api_viewed = NULL;
continue;
}
$item->search_api_viewed = $text;
} catch (Exception $e) {
$item->search_api_viewed = NULL;
}
}
// Restore global language settings.
if (!empty($this->options['global_language_switch'])) {
$GLOBALS['language'] = $global_language['language'];
$GLOBALS['language_url'] = $global_language['language_url'];
$GLOBALS['language_content'] = $global_language['language_content'];
}
// Restore the user.
$GLOBALS['user'] = $original_user;
drupal_save_session(TRUE);
}
public function propertyInfo() {
return array(
'search_api_viewed' => array(
'label' => t('Entity HTML output'),
'description' => t('The whole HTML content of the entity when viewed.'),
'type' => 'text',
),
);
}
}