You are here

Home » API reference » Permissions by field 8

README.txt in Permissions by field 8 

CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Similar modules
 * Installation
 * Configuration
 * Troubleshooting
 * FAQ
 * Maintainers

INTRODUCTION
------------

Permissions by field provide a new Field Type which enhance the Entity
Reference field type.

By adding fields of type Permissions by fields, you can manage access to the
node hosting these field by referencing other entity and specifiy which access
you want to grant (none or standard permission, view, update, delete) for users
which reference same entities (node, term, role or other users). You can also
grant access to the node directly per user if needed.

You can reference with the field type Permissions by field these entity types :
- user
- node
- term
- role

REQUIREMENTS
------------

This module provide a field type bases on the Entity Reference field. Entity
Reference is provided by Drupal core.


SIMILAR MODULES
-------------------

There is a lot modules which handle access permissions for node :

- Content access manage access per node type or per node and grant access to
  roles
- Permissions by terms handle permissions for nodes and users which reference
  same taxonomy term with a determined field.
- Organic Group which permit to manage group and related permissions inside
  each group

The goal of this module is to provide a simple method for implementing
similar but lighter features than thoses provided by Organic Group, currently
being ported to Drupal 8.

By using a specific field enhancing entity Reference field, you can easily
manage access to node in multiples way.

- For users members of a group node (who reference a content type named Group
  for example)
- Per user individually
- By role assigned to users
- By Term referenced by the node and users
- for users which reference others users

See documentation for more explanation about possibles configurations.

INSTALLATION
------------
Install as you would normally install a contributed Drupal module. See:
https://www.drupal.org/documentation/install/modules-themes/modules-8
for further information.


CONFIGURATION
-------------

- Add a field Permissions by field to the content type you want manage access.
- Choose the entity type this field will reference
- In the field's settings form, you can set default values and configure target
  bundles, as any Entity Reference field. You can set too the default access
  provided by this field.
  For example, we can add on the content type article a field pbf_ref_group
  which reference the content type Group.
- Add a field Permissions by field to user entity type. This field *must* have
  the same machine name (pbf_ref_node) as the field added to the content type,
   and configure it to reference too the content type Group.
- It's done. Now users who reference Group will grant access to the the content
  Article which reference same Group with the permissions you set on the field
  Permissions by Field.

Note that the checkbox Public in the grant access options, if checked, permit
you to use standard permissions of the Drupal site. You can then add a content
type to a Group but let this content be accessible to all the users who have
standard permission "access content".

Node's author will always granted all permissions.

TROUBLESHOOTING
---------------


FAQ
---


MAINTAINERS
-----------

Current maintainers:
 * flocondetoile - https://drupal.org/u/flocondetoile

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3. 

  4.  * Introduction

  5.  * Requirements

  6.  * Similar modules

  7.  * Installation

  8.  * Configuration

  9.  * Troubleshooting

  10.  * FAQ

  11.  * Maintainers

  12. 

  13. INTRODUCTION

  14. ------------

  15. 

  16. Permissions by field provide a new Field Type which enhance the Entity

  17. Reference field type.

  18. 

  19. By adding fields of type Permissions by fields, you can manage access to the

  20. node hosting these field by referencing other entity and specifiy which access

  21. you want to grant (none or standard permission, view, update, delete) for users

  22. which reference same entities (node, term, role or other users). You can also

  23. grant access to the node directly per user if needed.

  24. 

  25. You can reference with the field type Permissions by field these entity types :

  26. - user

  27. - node

  28. - term

  29. - role

  30. 

  31. REQUIREMENTS

  32. ------------

  33. 

  34. This module provide a field type bases on the Entity Reference field. Entity

  35. Reference is provided by Drupal core.

  36. 

  37. 

  38. SIMILAR MODULES

  39. -------------------

  40. 

  41. There is a lot modules which handle access permissions for node :

  42. 

  43. - Content access manage access per node type or per node and grant access to

  44.   roles

  45. - Permissions by terms handle permissions for nodes and users which reference

  46.   same taxonomy term with a determined field.

  47. - Organic Group which permit to manage group and related permissions inside

  48.   each group

  49. 

  50. The goal of this module is to provide a simple method for implementing

  51. similar but lighter features than thoses provided by Organic Group, currently

  52. being ported to Drupal 8.

  53. 

  54. By using a specific field enhancing entity Reference field, you can easily

  55. manage access to node in multiples way.

  56. 

  57. - For users members of a group node (who reference a content type named Group

  58.   for example)

  59. - Per user individually

  60. - By role assigned to users

  61. - By Term referenced by the node and users

  62. - for users which reference others users

  63. 

  64. See documentation for more explanation about possibles configurations.

  65. 

  66. INSTALLATION

  67. ------------

  68. Install as you would normally install a contributed Drupal module. See:

  69. https://www.drupal.org/documentation/install/modules-themes/modules-8

  70. for further information.

  71. 

  72. 

  73. CONFIGURATION

  74. -------------

  75. 

  76. - Add a field Permissions by field to the content type you want manage access.

  77. - Choose the entity type this field will reference

  78. - In the field's settings form, you can set default values and configure target

  79.   bundles, as any Entity Reference field. You can set too the default access

  80.   provided by this field.

  81.   For example, we can add on the content type article a field pbf_ref_group

  82.   which reference the content type Group.

  83. - Add a field Permissions by field to user entity type. This field *must* have

  84.   the same machine name (pbf_ref_node) as the field added to the content type,

  85.    and configure it to reference too the content type Group.

  86. - It's done. Now users who reference Group will grant access to the the content

  87.   Article which reference same Group with the permissions you set on the field

  88.   Permissions by Field.

  89. 

  90. Note that the checkbox Public in the grant access options, if checked, permit

  91. you to use standard permissions of the Drupal site. You can then add a content

  92. type to a Group but let this content be accessible to all the users who have

  93. standard permission "access content".

  94. 

  95. Node's author will always granted all permissions.

  96. 

  97. TROUBLESHOOTING

  98. ---------------

  99. 

  100. 

  101. FAQ

  102. ---

  103. 

  104. 

  105. MAINTAINERS

  106. -----------

  107. 

  108. Current maintainers:

  109.  * flocondetoile - https://drupal.org/u/flocondetoile