node_access_write_grants

• Drupal 5
• Drupal 6
• Drupal 7

Versions

5 – 7

node_access_write_grants($node, $grants, $realm = NULL, $delete = TRUE)

This function will write a list of grants to the database, deleting any pre-existing grants. If a realm is provided, it will only delete grants from that realm, but it will always delete a grant from the 'all' realm. Modules which utilize node_access can use this function when doing mass updates due to widespread permission changes.

Parameters

$node The $node being written to. All that is necessary is that it contains a nid.

$grants A list of grants to write. Each grant is an array that must contain the following keys: realm, gid, grant_view, grant_update, grant_delete. The realm is specified by a particular module; the gid is as well, and is a module-defined id to define grant privileges. each grant_* field is a boolean value.

$realm If provided, only read/write grants for that realm.

$delete If false, do not delete records. This is only for optimization purposes, and assumes the caller has already performed a mass delete of some form.

Related topics

Node access rights

The node access system determines who can do what to which nodes.

Code

modules/node/node.module, line 2751

<?php
function node_access_write_grants($node, $grants, $realm = NULL, $delete = TRUE) {
  if ($delete) {
    $query = db_delete('node_access')->condition('nid', $node->nid);
    if ($realm) {
      $query->condition('realm', array($realm, 'all'), 'IN');
    }
    $query->execute();
  }

  // Only perform work when node_access modules are active.
  if (count(module_implements('node_grants'))) {
    $query = db_insert('node_access')->fields(array('nid', 'realm', 'gid', 'grant_view', 'grant_update', 'grant_delete'));
    foreach ($grants as $grant) {
      if ($realm && $realm != $grant['realm']) {
        continue;
      }
      // Only write grants; denies are implicit.
      if ($grant['grant_view'] || $grant['grant_update'] || $grant['grant_delete']) {
        $grant['nid'] = $node->nid;
        $query->values($grant);
      }
    }
    $query->execute();
  }
}
?>

Login or register to post comments