acquia_search.api.php in Acquia Search 3.x

Hooks specific to the acquia_search module.

File

acquia_search.api.php

<?php

/**
 * @file
 * Hooks specific to the acquia_search module.
 */

/**
 * @addtogroup hooks
 * @{
 */

/**
 * Alter the possible cores list.
 *
 * @param array $possible_core_ids
 *   The predefined list of possible cores.
 * @param array $context
 *   Context.
 *
 * @code
 *   $possible_core_ids = [
 *     'WXYZ-12345.prod.default',
 *     'WXYZ-12345.dev.mysitedev_folder1',
 *     'WXYZ-12345.dev.mysitedev_db',
 *   ];
 *   $context = [
 *     'ah_env' => 'dev',                // string|null
 *     'ah_db_role' => 'SomeDb1,         // string
 *     'identifier' => 'WXYZ-12345',     // string, may be empty
 *     'sites_foldername' => 'default',  // string
 *   ];
 * @endcode
 */
function hook_acquia_search_get_list_of_possible_cores_alter(array &$possible_core_ids, array $context) {
  if (empty($context['ah_env'])) {
    $possible_core_ids[] = 'WXYZ-12345.dev.mysitedev_db';
  }
}

/**
 * Alter the read-only mode for a search core.
 *
 * @param bool $read_only
 *   The read-only flag. TRUE if a read-only mode enforced on a search core.
 */
function hook_acquia_search_should_enforce_read_only_alter(&$read_only) {
  if (!$_ENV['AH_SITE_ENVIRONMENT']) {
    $read_only = TRUE;
  }
}

/**
 * @} End of "addtogroup hooks".
 */

Functions

Name	Description
hook_acquia_search_get_list_of_possible_cores_alter	Alter the possible cores list.
hook_acquia_search_should_enforce_read_only_alter	Alter the read-only mode for a search core.