class SearchApiAlterNodeAccess in Search API 7
Adds node access information to node indexes.
Hierarchy
- class \SearchApiAbstractAlterCallback implements SearchApiAlterCallbackInterface
- class \SearchApiAlterNodeAccess
Expanded class hierarchy of SearchApiAlterNodeAccess
1 string reference to 'SearchApiAlterNodeAccess'
File
- includes/
callback_node_access.inc, line 10 - Contains the SearchApiAlterNodeAccess class.
View source
class SearchApiAlterNodeAccess extends SearchApiAbstractAlterCallback {
/**
* Overrides SearchApiAbstractAlterCallback::supportsIndex().
*
* Returns TRUE only for indexes on nodes.
*/
public function supportsIndex(SearchApiIndex $index) {
// Currently only node access is supported.
return $index
->getEntityType() === 'node';
}
/**
* Overrides SearchApiAbstractAlterCallback::propertyInfo().
*
* Adds the "search_api_access_node" property.
*/
public function propertyInfo() {
return array(
'search_api_access_node' => array(
'label' => t('Node access information'),
'description' => t('Data needed to apply node access.'),
'type' => 'list<token>',
),
);
}
/**
* {@inheritdoc}
*/
public function alterItems(array &$items) {
static $account;
if (!isset($account)) {
// Load the anonymous user.
$account = drupal_anonymous_user();
}
foreach ($items as $id => $item) {
$node = $this
->getNode($item);
// Check whether all users have access to the node.
if (!node_access('view', $node, $account)) {
// Get node access grants.
$result = db_query('SELECT * FROM {node_access} WHERE (nid = 0 OR nid = :nid) AND grant_view = 1', array(
':nid' => $node->nid,
));
// Store all grants together with their realms in the item.
foreach ($result as $grant) {
$items[$id]->search_api_access_node[] = "node_access_{$grant->realm}:{$grant->gid}";
}
}
else {
// Add the generic view grant if we are not using node access or the
// node is viewable by anonymous users.
$items[$id]->search_api_access_node = array(
'node_access__all',
);
}
}
}
/**
* Retrieves the node related to a search item.
*
* In the default implementation for nodes, the item is already the node.
* Subclasses may override this to easily provide node access checks for
* items related to nodes.
*/
protected function getNode($item) {
return $item;
}
/**
* Overrides SearchApiAbstractAlterCallback::configurationFormSubmit().
*
* If the data alteration is being enabled, set "Published" and "Author" to
* "indexed", because both are needed for the node access filter.
*/
public function configurationFormSubmit(array $form, array &$values, array &$form_state) {
$old_status = !empty($form_state['index']->options['data_alter_callbacks']['search_api_alter_node_access']['status']);
$new_status = !empty($form_state['values']['callbacks']['search_api_alter_node_access']['status']);
if (!$old_status && $new_status) {
$form_state['index']->options['fields']['status']['type'] = 'boolean';
$form_state['index']->options['fields']['author']['type'] = 'integer';
$form_state['index']->options['fields']['author']['entity_type'] = 'user';
}
return parent::configurationFormSubmit($form, $values, $form_state);
}
}