shoutbox.api.php in Shoutbox 7.2

File

shoutbox.api.php

<?php

/**
 * Implementation of hook_shoutbox()
 *
 * See shoutbox_group for a detailed example
 *
 * @param $op
 *   The current operation (see code below)
 * @param $shout
 *   The shout object used in the operation
 * @param $a1
 *   An additional parameter that contains data based on the operation
 * @param $form_state
 *   The form state of the shout form. Usually only used on the shoutbox form.
 *   Modules like shoutbox_group attach extra data to the form with a form_alter.
 */
function hook_shoutbox($op, &$shout, &$a1 = NULL, $form_state = NULL) {
  switch ($op) {
    case 'insert':

      // A shout was just added.
      break;
    case 'presave':

      // A shout is about to be saved
      // ********** IMPORTANT**********
      // If it recommended that in presave, you set $shout->module to the name of your
      // module. This will prevent shoutbox from displaying your module's shouts on
      // general shoutboxes - unless that is what is desired.
      break;
    case 'edit':

      // An edited shout is about to be saved.
      break;
    case 'view':

      // A shout is about to be viewed.
      break;
    case 'unpublish':

      // A shout is being unpublished.
      // Will not be called if a shout is initially saved unpublished.
      break;
    case 'publish':

      // A shout is being published.
      // Will not be called if a shout is initially saved published.
      break;
    case 'delete':

      // A shout was just removed.
      break;
    case 'link':

      // Alter the link to the shoutbox page.
      $a1 = 'shoutbox/something/custom';
      break;
    case 'form':

      // Alter the shoutbox add form.
      $a1['new_field'] = array(
        '#type' => 'textbox',
        etc,
      );
      break;
    case 'js path':

      // Alter the AJAX callback path.
      $a1 = 'something/js/callback';
      break;
    case 'context':

      // Set a shoutbox "context", for example, indicating the current group.
      // These will be passed into hook_db_rewrite_query() so you can alter
      // the shout query accordingly.
      $a1['shoutbox_group'] = $group->nid;
      break;
  }
}

/**
 * Alter access to shoutbox.
 *
 * This is useful for modules customizing access to shoutbox. All shout views,
 * edits, deletes and moderation will go through this function. 
 *
 * @see _shoutbox_user_access().
 *
 * @param Boolean $access_granted
 *   The final returned value for access granted or denied.
 * @param String $permission
 *   The hook_permission string key to check against.
 * @param Object $shout
 *   If applicable, the function will check against the shout.
 */
function hook_shoutbox_user_access_alter(&$access_granted, $permission, $shout = NULL) {
  if (module_exists('domain')) {
    $access_granted = _shoutbox_domain_user_access();
  }
}

Functions

Name	Description
hook_shoutbox	Implementation of hook_shoutbox()
hook_shoutbox_user_access_alter	Alter access to shoutbox.