farm_access.api.php in farmOS 7

Hooks provided by farm_access.

This file contains no working PHP code; it exists to provide additional documentation for doxygen as well as to document hooks in the standard Drupal manner.

File

modules/farm/farm_access/farm_access.api.php

<?php

/**
 * @file
 * Hooks provided by farm_access.
 *
 * This file contains no working PHP code; it exists to provide additional
 * documentation for doxygen as well as to document hooks in the standard
 * Drupal manner.
 */

/**
 * @defgroup farm_access Farm access module integrations.
 *
 * Module integrations with the farm_access module.
 */

/**
 * @defgroup farm_access_hooks Farm access's hooks
 * @{
 * Hooks that can be implemented by other modules in order to extend farm_access.
 */

/**
 * Defines farm access roles.
 *
 * @return array
 *   Returns an array of farm access roles. The key should be a unique farm
 *   role machine name, and each should be an array of role information,
 *   including the following keys:
 *     name: The human-readable name of the role.
 *     access: An optional array of default access permissions
 *       view: Specifies what the role has access to view. Set to 'all' to
 *         allow view access to everything. Or, it can be an array of arrays
 *         keyed by entity type, with a list of bundles (or 'all').
 *       edit: Specifies what the role has access to edit. Set to 'all' to
 *         allow edit access to everything. Or, it can be an array of arrays
 *         keyed by entity type, with a list of bundles (or 'all').
 *       config: Boolean that specifies whether or not the role should have
 *         access to configuration. Only grant this to trusted roles.
 */
function hook_farm_access_roles() {

  // Build a list of roles.
  $roles = array(
    'farm_manager' => array(
      'name' => 'Farm Manager',
      'access' => array(
        'view' => 'all',
        'edit' => 'all',
        'config' => TRUE,
      ),
    ),
    'farm_worker' => array(
      'name' => 'Farm Worker',
      'access' => array(
        'view' => 'all',
        'edit' => 'all',
      ),
    ),
    'farm_viewer' => array(
      'name' => 'Farm Viewer',
      'access' => array(
        'view' => 'all',
      ),
    ),
  );
  return $roles;
}

/**
 * Defines farm access permissions.
 * Use farm_access_entity_perms() to generate permissions for common entity
 * types.
 *
 * @param string $role
 *   The role name to add permissions for.
 *
 * @return array
 *   Returns an array of farm access permissions.
 *
 * @see farm_access_entity_perms()
 */
function hook_farm_access_perms($role) {

  // Grant the 'view mymodule records' permission to all roles.
  $perms[] = 'view mymodule records';

  // Load the list of farm roles.
  $roles = farm_access_roles();

  // Grant the 'configure mymodule' permission to roles with config access.
  if (!empty($roles[$role]['access']['config'])) {
    $perms[] = 'configure mymodule';
  }
  return $perms;
}

/**
 * Alter permissions that were defined by modules using
 * hook_farm_access_perms().
 *
 * @param string $role
 *   The role name that permissions are being built for.
 * @param array $perms
 *   The permissions provided by other modules, passed by reference.
 */
function hook_farm_access_perms_alter($role, &$perms) {

  // Give Farm Managers permission to administer modules.
  if ($role == 'farm_manager') {
    $perms[] = 'administer modules';
  }
}

/**
 * @}
 */

Functions

Name	Description
hook_farm_access_perms	Defines farm access permissions. Use farm_access_entity_perms() to generate permissions for common entity types.
hook_farm_access_perms_alter	Alter permissions that were defined by modules using hook_farm_access_perms().
hook_farm_access_roles	Defines farm access roles.