bakery.api.php in Bakery Single Sign-On System 6.2

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

bakery.api.php

<?php

/**
 * @file
 * 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 bakery Bakery module integrations.
 *
 * Module integrations with the Bakery SSO.
 */

/**
 * Bakery data transmit hook invoked before data is sent to another site.
 *
 * Invoked on master during user_save before syncing to subsites. Also invoked
 * on subsite when requesting account data from master for account creation.
 *
 * @param array $edit
 *   The array of form values submitted by the user from user_save().
 * @param object $account
 *   User account object.
 * @param string $category
 *   The active category of user information being edited.
 *
 * @return
 *   Keyed array of data to pass along to other sites.
 */
function hook_bakery_transmit($edit, $account, $category) {
  return array(
    'example_field' => 'example_value',
  );
}

/**
 * Bakery data receive hook invoked on response from data sync from master.
 *
 * Invoked on subsites after requesting account data from master for account
 * creation. Also invoked on subsites during account data sync from master.
 *
 * Note, callers are responsible for data validation.
 *
 * @param object $account
 *   User account object.
 * @param array $cookie
 *   Data sent from the master. Custom data sent by master's
 *   hook_bakery_transmit() will be available as top-level elements.
 *
 */
function hook_bakery_receive($account, $cookie) {
  if (!empty($cookie['example_field'])) {
    db_query("UPDATE {example_table} SET example_field = '%s'", array(
      '%s' => $cookie['example_field'],
    ));
  }
}

Functions

Name	Description
hook_bakery_receive	Bakery data receive hook invoked on response from data sync from master.
hook_bakery_transmit	Bakery data transmit hook invoked before data is sent to another site.