user_relationships.api.php in User Relationships 7

This file documents all hooks for user_relationships.module

File

user_relationships.api.php

<?php

/**
 * @file
 * This file documents all hooks for user_relationships.module
 */

/**
 * Act when relationship types are loaded.
 *
 * @param $relationship_types_list
 *   A list of relationship types, keyed by rtid.
 *
 * @see user_relationships_type_load_multiple()
 */
function hook_user_relationships_type_load($relationship_types_list) {
}

/**
 * This hook is executed before an existing or new relationship type is saved.
 *
 * @param $relationship_type
 *   Relationship type object.
 *
 * @see user_relationships_type_save()
 */
function hook_user_relationships_type_presave($relationship_type) {
}

/**
 * This hook is executed after an relationship type has been updated.
 *
 * @param $relationship_type
 *   Relationship type object.
 *
 * @see user_relationships_type_save()
 */
function hook_user_relationships_type_update($relationship_type) {
}

/**
 * This hook is executed after a new relationship type has been inserted.
 *
 * @param $relationship_type
 *   Relationship type object.
 *
 * @see user_relationships_type_save()
 */
function hook_user_relationships_type_insert($relationship_type) {
}

/**
 * This hook is executed after a relationship type has been deleted.
 *
 * @param $relationship_type
 *   Relationship type object.
 *
 * @see user_relationships_type_delete()
 */
function hook_user_relationships_type_delete($relationship_type) {
}

/**
 * Act when relationships are loaded.
 *
 * @param $relationship_list
 *   Array of relations, keyed by rid.
 *
 * @see user_relationships_load()
 */
function hook_user_relationships_load($relationship_list) {
}

/**
 * This hook is executed before a relationship will be saved.
 *
 * @param $relationship
 *   Relationship object.
 *
 * @see user_relationships_save_relationship()
 */
function hook_user_relationships_presave($relationship) {
}

/**
 * This hook is executed after a relationship has been updated.
 *
 * @param $relationship
 *   Relationship object.
 * @param $action
 *   The reason for the update (request, approve, update).
 *
 * @see user_relationships_save_relationship()
 */
function hook_user_relationships_save($relationship, $action) {
}

/**
 * This hook is executed after a new relationship has been saved.
 *
 * @param $relationship
 *   Relationship object.
 *
 * @see user_relationships_save_relationship()
 */
function hook_user_relationships_insert($relationship) {
}

/**
 * This hook is executed before a relationship will be saved.
 *
 * @param $relationship
 *   Relationship object.
 * @param $action
 *   String reason for removal ('cancel','disapprove','remove').
 *
 * @see user_relationships_delete_relationship()
 *
 */
function hook_user_relationships_delete($relationship, $action) {
}

/**
 * Alter the relationship types listing page.
 */
function hook_user_relationships_types_list_alter(&$page) {
  $defaults = user_relationship_defaults_load();
  $default_rows = array();
  foreach ($defaults as $default) {
    $default_rows[] = array(
      theme('username', array(
        'account' => $default->user,
      )),
      $default->relationship_type->name,
      l(t('delete'), "admin/config/people/relationships/defaults/{$default->rdid}/delete"),
    );
  }
  $page['defaults'] = array(
    '#type' => 'fieldset',
    '#title' => t('Default Relationships'),
    '#weight' => 2,
  );
  $page['defaults']['list'] = array(
    '#theme' => 'table',
    '#header' => array(
      t('User'),
      t('Relationship'),
      t('Operations'),
    ),
    '#rows' => $default_rows,
    '#empty' => t('No default relationships available.'),
  );
}

Functions

Name	Description
hook_user_relationships_delete	This hook is executed before a relationship will be saved.
hook_user_relationships_insert	This hook is executed after a new relationship has been saved.
hook_user_relationships_load	Act when relationships are loaded.
hook_user_relationships_presave	This hook is executed before a relationship will be saved.
hook_user_relationships_save	This hook is executed after a relationship has been updated.
hook_user_relationships_types_list_alter	Alter the relationship types listing page.
hook_user_relationships_type_delete	This hook is executed after a relationship type has been deleted.
hook_user_relationships_type_insert	This hook is executed after a new relationship type has been inserted.
hook_user_relationships_type_load	Act when relationship types are loaded.
hook_user_relationships_type_presave	This hook is executed before an existing or new relationship type is saved.
hook_user_relationships_type_update	This hook is executed after an relationship type has been updated.