You are here

Home » API reference » User Relationships 5.2

README.txt in User Relationships 5.2

Same filename in this branch
  1. 5.2 README.txt
  2. 5.2 plugins/user_relationship_mailer/README.txt
  3. 5.2 plugins/user_relationship_migrate/README.txt
  4. 5.2 plugins/user_relationship_defaults/README.txt
  5. 5.2 plugins/user_relationship_implications/README.txt
  6. 5.2 plugins/user_relationship_invites/README.txt
  7. 5.2 plugins/user_relationship_views/README.txt
  8. 5.2 plugins/user_relationship_service/README.txt
  9. 5.2 plugins/user_relationship_blocks/README.txt
User Relationship Blocks Module
-------------------------
This module allows users to add blocks for user relationships.

Send comments to Jeff Smick: http://drupal.org/user/107579/contact, or post an issue at
http://drupal.org/project/user_relationships.


Requirements
------------
Drupal 5
User Relationships


Installation
------------
1. Enable User Relationship Blocks in the "Site building -> modules" administration screen.



Developers
------------
This module provides a single hook that passes in identifying information about the block. Depending on the
$op passed in it will expect different information back.

  hook_user_relationship_blocks($op, $block_type, $rtid, $extra);

  $op       | expected return
  -----------------------------------------------------------------------------------------------------------------------------
  display   | A user object. It's a way for developers to display relationship information on non-standard pages. If nothing
            | is sent back the module will check if arg(0) matches "user" or "node" and pull the account information from that.

  
  $block_type   | description
  -----------------------------------------------------------------------------------------------------------------------------
  UR_BLOCK_MY   | the block relates to the currently logged in user
  UR_BLOCK_USER | the block relates to a specified user (normally the author of the current node)
  pending       | pending relationship requests, normally for the currently logged in user
  actions       | relationships and actions between the currently logged in user and normally the author of the current node


  $rtid
  -----------------------------------------------------------------------------------------------------------------------------
  Either UR_BLOCK_ALL_TYPES for any relationship type or an rtid corresponding to a specific relationship type
  I use "normally" because those values can be overridden by the hook


  $extra
  -----------------------------------------------------------------------------------------------------------------------------
  Any extra data about the block. Currently this is only used to specify which side of a one-way relationship should be shown.
  It will be either "you_to_them" or "them_to_you" where "you" means the currently logged in user and "them" means the specified
  user.



Credits
-------
Originally Written by JB Christy.
Refactored by Jeff Smick.
Written originally for and financially supported by OurChart Inc. (http://www.ourchart.com)
Thanks to the BuddyList module team for their inspiration

File

plugins/user_relationship_blocks/README.txt
View source 
  1. 

  2. User Relationship Blocks Module

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

  4. This module allows users to add blocks for user relationships.

  5. 

  6. Send comments to Jeff Smick: http://drupal.org/user/107579/contact, or post an issue at

  7. http://drupal.org/project/user_relationships.

  8. 

  9. 

  10. Requirements

  11. ------------

  12. Drupal 5

  13. User Relationships

  14. 

  15. 

  16. Installation

  17. ------------

  18. 1. Enable User Relationship Blocks in the "Site building -> modules" administration screen.

  19. 

  20. 

  21. 

  22. Developers

  23. ------------

  24. This module provides a single hook that passes in identifying information about the block. Depending on the

  25. $op passed in it will expect different information back.

  26. 

  27.   hook_user_relationship_blocks($op, $block_type, $rtid, $extra);

  28. 

  29.   $op       | expected return

  30.   -----------------------------------------------------------------------------------------------------------------------------

  31.   display   | A user object. It's a way for developers to display relationship information on non-standard pages. If nothing

  32.             | is sent back the module will check if arg(0) matches "user" or "node" and pull the account information from that.

  33. 

  34.   

  35.   $block_type   | description

  36.   -----------------------------------------------------------------------------------------------------------------------------

  37.   UR_BLOCK_MY   | the block relates to the currently logged in user

  38.   UR_BLOCK_USER | the block relates to a specified user (normally the author of the current node)

  39.   pending       | pending relationship requests, normally for the currently logged in user

  40.   actions       | relationships and actions between the currently logged in user and normally the author of the current node

  41. 

  42. 

  43.   $rtid

  44.   -----------------------------------------------------------------------------------------------------------------------------

  45.   Either UR_BLOCK_ALL_TYPES for any relationship type or an rtid corresponding to a specific relationship type

  46.   I use "normally" because those values can be overridden by the hook

  47. 

  48. 

  49.   $extra

  50.   -----------------------------------------------------------------------------------------------------------------------------

  51.   Any extra data about the block. Currently this is only used to specify which side of a one-way relationship should be shown.

  52.   It will be either "you_to_them" or "them_to_you" where "you" means the currently logged in user and "them" means the specified

  53.   user.

  54. 

  55. 

  56. 

  57. Credits

  58. -------

  59. Originally Written by JB Christy.

  60. Refactored by Jeff Smick.

  61. Written originally for and financially supported by OurChart Inc. (http://www.ourchart.com)

  62. Thanks to the BuddyList module team for their inspiration