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
Same filename and directory in other branches
  1. 7 user_relationship_blocks/README.txt
User Relationship Blocks
------------------------
Provides a few basic blocks for use with User Relationships. Block explanaitions are below.


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


Requirements
------------
Drupal 6
User Relationships API
User Relationships UI


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


Blocks
------
User Relationships: Actions
  Some basic actions that can be performed between the current user and the user being viewed*.
  This block is useful for those using nodeprofile

My Pending Relationships
  Shows all the pending relationship requests, both requested from and of the current user.

My Relationships: All Relationships
  Shows all of the current users relationships. The number of relationships and the order
  in which they're shown can be configured.

My Relationships: {Relationship Type}
  Where {Relationship Type} is a specific relationship type. This will show only the current
  user's relationships of the specified type.

User Relationships: All Relationships
  Like "My Relationships: All Relationships" only it shows the relationships of the user being
  viewed*

User Relationships: {Relationship Type}
  Like "My Relationships: {Relationship Type}" only it shows the relationships of the user being
  viewed*


* A note about the user being viewed:
  This user is found using a PHP function. It can be configured per block to be specific to your site.
  This is for more expert users (and is really only needed by expert users). You can find the current
  default code in the "_user_relationship_blocks_find_user_php" function in "user_relationship_blocks.module"


Theme Developers
----------------
There is one theme function and three theme files.

The function is "theme_user_relationship_block_subject" and is used to generate the title of the block

The files are under the "templates" directory and listed below:
  user_relationships-block for "My Relationships: " and "User Relationships: " blocks
  user_relationships-pending_block for pending relationships
  user_relationships-actions_block for relationship actions


Credits
-------
Originally Written by JB Christy.
Rewritten by Jeff Smick.
Written originally for and financially supported by OurChart Inc. (http://www.ourchart.com)

File

user_relationship_blocks/README.txt
View source 
  1. 

  2. User Relationship Blocks

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

  4. Provides a few basic blocks for use with User Relationships. Block explanaitions are below.

  5. 

  6. 

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

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

  9. 

  10. 

  11. Requirements

  12. ------------

  13. Drupal 6

  14. User Relationships API

  15. User Relationships UI

  16. 

  17. 

  18. Installation

  19. ------------

  20. 1. Enable User Relationship Blocks in the "Site building -> Modules" administration screen.

  21. 

  22. 

  23. Blocks

  24. ------

  25. User Relationships: Actions

  26.   Some basic actions that can be performed between the current user and the user being viewed*.

  27.   This block is useful for those using nodeprofile

  28. 

  29. My Pending Relationships

  30.   Shows all the pending relationship requests, both requested from and of the current user.

  31. 

  32. My Relationships: All Relationships

  33.   Shows all of the current users relationships. The number of relationships and the order

  34.   in which they're shown can be configured.

  35. 

  36. My Relationships: {Relationship Type}

  37.   Where {Relationship Type} is a specific relationship type. This will show only the current

  38.   user's relationships of the specified type.

  39. 

  40. User Relationships: All Relationships

  41.   Like "My Relationships: All Relationships" only it shows the relationships of the user being

  42.   viewed*

  43. 

  44. User Relationships: {Relationship Type}

  45.   Like "My Relationships: {Relationship Type}" only it shows the relationships of the user being

  46.   viewed*

  47. 

  48. 

  49. * A note about the user being viewed:

  50.   This user is found using a PHP function. It can be configured per block to be specific to your site.

  51.   This is for more expert users (and is really only needed by expert users). You can find the current

  52.   default code in the "_user_relationship_blocks_find_user_php" function in "user_relationship_blocks.module"

  53. 

  54. 

  55. Theme Developers

  56. ----------------

  57. There is one theme function and three theme files.

  58. 

  59. The function is "theme_user_relationship_block_subject" and is used to generate the title of the block

  60. 

  61. The files are under the "templates" directory and listed below:

  62.   user_relationships-block for "My Relationships: " and "User Relationships: " blocks

  63.   user_relationships-pending_block for pending relationships

  64.   user_relationships-actions_block for relationship actions

  65. 

  66. 

  67. Credits

  68. -------

  69. Originally Written by JB Christy.

  70. Rewritten by Jeff Smick.

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