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 Views Module
---------------------------------

This is a plugin module for the User Relationships module. It allows integration
with the Views module (http://drupal.org/project/views)

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 Module
Views Module


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


Usage
------------
  FIELDS
  ------
  Author's Relationships to Current User: 
    provides a list of relationships the author of a node has with the current user
    can be tunes to show any, only approved, or only non-approved relationships

  Current User's Relationships to Author:
    provides a list of relationships the current user has with the author of a node
    can be tunes to show any, only approved, or only non-approved relationships

  Approval Status:
    shows the approval status of a relationship between the author and the current user
    this is really only useful if you've filtered by a specific relationship

  Relationship Creation Date:
    shows the date/time a relationship between the author and the current user was created
    this is really only useful if you've filtered by a specific relationship


  FILTERS
  -------
  Author's relationship with Username:
    show only nodes where the author has or does not have a specified relationship with a specified user
    OPERATOR: select if the author is or is not related and if that relationship should be approved, non-approved or either
    VALUE:    the relationship to filter by
    OPTION:   the name of the user the author should relate to

  Author's relationship with the Current User:
    show only nodes where the author has or does not have a specified relationship with the currenly logged in user
    OPERATOR: select if the author is or is not related and if that relationship should be approved, non-approved or either
    VALUE:    the relationship to filter by

  ARGUMENTS
  ---------
    UID is related to Author:
      show only nodes where the author is related to the UID argument
      VALUE: any valid user ID

    Author is related to UID through RTID:
      show only nodes where the author has a relationship type specified by RTID
      This argument should probably be used in conjunction with "UID is related to Author" as a way of filtering by relationship type
      VALUE: any valid rtid for a relationship type

    UID to Author is (Non-)Approved:
      show only nodes where the author has an approved or non-approved relationship
      This argument should probably be used in conjunction with "UID is related to Author" as a way of filtering by approval
      VALUE: 0 = Non-Approved, 1 = Approved
      
Credits
-------
Written by Jeff Smick.
Thanks to Eaton for ideas.

File

plugins/user_relationship_views/README.txt
View source 
  1. 

  2. User Relationship Views Module

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

  4. 

  5. This is a plugin module for the User Relationships module. It allows integration

  6. with the Views module (http://drupal.org/project/views)

  7. 

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

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

  10. 

  11. 

  12. Requirements

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

  14. Drupal 5

  15. User Relationships Module

  16. Views Module

  17. 

  18. 

  19. Installation

  20. ------------

  21. Enable User Relationship Views in the "Site building -> Modules" administration screen.

  22. 

  23. 

  24. Usage

  25. ------------

  26.   FIELDS

  27.   ------

  28.   Author's Relationships to Current User: 

  29.     provides a list of relationships the author of a node has with the current user

  30.     can be tunes to show any, only approved, or only non-approved relationships

  31. 

  32.   Current User's Relationships to Author:

  33.     provides a list of relationships the current user has with the author of a node

  34.     can be tunes to show any, only approved, or only non-approved relationships

  35. 

  36.   Approval Status:

  37.     shows the approval status of a relationship between the author and the current user

  38.     this is really only useful if you've filtered by a specific relationship

  39. 

  40.   Relationship Creation Date:

  41.     shows the date/time a relationship between the author and the current user was created

  42.     this is really only useful if you've filtered by a specific relationship

  43. 

  44. 

  45.   FILTERS

  46.   -------

  47.   Author's relationship with Username:

  48.     show only nodes where the author has or does not have a specified relationship with a specified user

  49.     OPERATOR: select if the author is or is not related and if that relationship should be approved, non-approved or either

  50.     VALUE:    the relationship to filter by

  51.     OPTION:   the name of the user the author should relate to

  52. 

  53.   Author's relationship with the Current User:

  54.     show only nodes where the author has or does not have a specified relationship with the currenly logged in user

  55.     OPERATOR: select if the author is or is not related and if that relationship should be approved, non-approved or either

  56.     VALUE:    the relationship to filter by

  57. 

  58.   ARGUMENTS

  59.   ---------

  60.     UID is related to Author:

  61.       show only nodes where the author is related to the UID argument

  62.       VALUE: any valid user ID

  63. 

  64.     Author is related to UID through RTID:

  65.       show only nodes where the author has a relationship type specified by RTID

  66.       This argument should probably be used in conjunction with "UID is related to Author" as a way of filtering by relationship type

  67.       VALUE: any valid rtid for a relationship type

  68. 

  69.     UID to Author is (Non-)Approved:

  70.       show only nodes where the author has an approved or non-approved relationship

  71.       This argument should probably be used in conjunction with "UID is related to Author" as a way of filtering by approval

  72.       VALUE: 0 = Non-Approved, 1 = Approved

  73.       

  74. Credits

  75. -------

  76. Written by Jeff Smick.

  77. Thanks to Eaton for ideas.