You are here

Home » API reference » User Relationships 6

README.txt in User Relationships 6

Same filename in this branch
  1. 6 README.txt
  2. 6 user_relationship_elaborations/README.txt
  3. 6 user_relationship_mailer/README.txt
  4. 6 user_relationship_migrate/README.txt
  5. 6 user_relationship_defaults/README.txt
  6. 6 user_relationship_implications/README.txt
  7. 6 user_relationship_invites/README.txt
  8. 6 user_relationship_node_access/README.txt
  9. 6 user_relationship_blocks/README.txt
  10. 6 user_relationships_api/README.txt
User Relationships API
------------------
This the API only portion of User Relationships. This is required by all UR plugins and addon
modules. It provides no frontend interface.

Installation Notes
------------------
PostgreSQL users, please read http://drupal.org/node/331692 and check out the patch in it, as 
the current install schema does not apparently work with PostgreSQL.

Developers
------------
There are a number of API functions and two hooks. The API functions are all defined in
user_relationships_api.api.inc. I've provded a list below for quick lookup, but you'll
need to see the documentation in that file for a deeper explanaition.

  Functions
  =========
  user_relationships_type_load($param = array())
  user_relationships_types_load($reset = NULL)
  user_relationships_type_save(&$rtype)
  user_relationships_type_delete($rtid)

  user_relationships_load($param = array(), $options = array(), $reset = FALSE)
  user_relationships_api_translate_user_info(&$relationship)
  user_relationships_request_relationship($requester, $requestee, $type, $approved = FALSE)
  user_relationships_save_relationship(&$relationship, $op = 'request')
  user_relationships_delete_relationship(&$relationship, &$deleted_by, $op = 'remove')


  Hooks
  =====
  hook_user_relationships_type($op, &$relationship_type)
    presave | When either saving a new relationship type or updating an existing relationship type
    insert  | After saving a new relationship type
    update  | After saving an existing relationship type
    delete  | After deleting a relationship type
    load    | When a relationship type is loaded

  hook_user_relationships($op, &$relationship)
    load        | When a relationship is loaded
    presave     | When either saving a new relationship or updating an existing relationship
    request     | After a new relationship has been requested
    cancel      | When a relationship has been removed (specifically cancelled)
    update      | After saving an existing relationship
    approve     | After approving a relationship
    disapprove  | When a relationship has been removed (specifically disapproved)
    remove      | When a relationship has been removed

File

user_relationships_api/README.txt
View source 
  1. 

  2. User Relationships API

  3. ------------------

  4. This the API only portion of User Relationships. This is required by all UR plugins and addon

  5. modules. It provides no frontend interface.

  6. 

  7. Installation Notes

  8. ------------------

  9. PostgreSQL users, please read http://drupal.org/node/331692 and check out the patch in it, as 

  10. the current install schema does not apparently work with PostgreSQL.

  11. 

  12. Developers

  13. ------------

  14. There are a number of API functions and two hooks. The API functions are all defined in

  15. user_relationships_api.api.inc. I've provded a list below for quick lookup, but you'll

  16. need to see the documentation in that file for a deeper explanaition.

  17. 

  18.   Functions

  19.   =========

  20.   user_relationships_type_load($param = array())

  21.   user_relationships_types_load($reset = NULL)

  22.   user_relationships_type_save(&$rtype)

  23.   user_relationships_type_delete($rtid)

  24. 

  25.   user_relationships_load($param = array(), $options = array(), $reset = FALSE)

  26.   user_relationships_api_translate_user_info(&$relationship)

  27.   user_relationships_request_relationship($requester, $requestee, $type, $approved = FALSE)

  28.   user_relationships_save_relationship(&$relationship, $op = 'request')

  29.   user_relationships_delete_relationship(&$relationship, &$deleted_by, $op = 'remove')

  30. 

  31. 

  32.   Hooks

  33.   =====

  34.   hook_user_relationships_type($op, &$relationship_type)

  35.     presave | When either saving a new relationship type or updating an existing relationship type

  36.     insert  | After saving a new relationship type

  37.     update  | After saving an existing relationship type

  38.     delete  | After deleting a relationship type

  39.     load    | When a relationship type is loaded

  40. 

  41.   hook_user_relationships($op, &$relationship)

  42.     load        | When a relationship is loaded

  43.     presave     | When either saving a new relationship or updating an existing relationship

  44.     request     | After a new relationship has been requested

  45.     cancel      | When a relationship has been removed (specifically cancelled)

  46.     update      | After saving an existing relationship

  47.     approve     | After approving a relationship

  48.     disapprove  | When a relationship has been removed (specifically disapproved)

  49.     remove      | When a relationship has been removed