[177a560] | 1 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
---|
| 2 | ;; Field Permissions module |
---|
[663b989] | 3 | ;; $Id: README.txt,v 1.1.2.3 2009/11/14 12:32:51 markuspetrux Exp $ |
---|
[177a560] | 4 | ;; |
---|
| 5 | ;; Original author: markus_petrux (http://drupal.org/user/39593) |
---|
| 6 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
---|
| 7 | |
---|
| 8 | CONTENTS OF THIS FILE |
---|
| 9 | ===================== |
---|
| 10 | * OVERVIEW |
---|
| 11 | * USAGE |
---|
| 12 | * REQUIREMENTS |
---|
| 13 | * INSTALLATION |
---|
| 14 | * UPGRADING FROM CCK CONTENT PERMISSIONS |
---|
| 15 | |
---|
| 16 | |
---|
| 17 | OVERVIEW |
---|
| 18 | ======== |
---|
| 19 | |
---|
| 20 | The Field Permissions module is a drop-in replacement for the Content |
---|
| 21 | Permissions module shipped with CCK. |
---|
| 22 | |
---|
| 23 | The key differences are: |
---|
| 24 | |
---|
| 25 | * It allows site administrators to set field-level permissions to edit or |
---|
| 26 | view CCK fields in any node, and optionally (new feature compared to |
---|
| 27 | Content Permissions), edit or view permissions for nodes owned by the |
---|
| 28 | current user. |
---|
| 29 | |
---|
| 30 | * Permissions for each field are not created by default. Instead, |
---|
| 31 | administrators can enable these permissions explicitly for the fields |
---|
| 32 | where this feature is needed. |
---|
| 33 | |
---|
| 34 | |
---|
| 35 | USAGE |
---|
| 36 | ===== |
---|
| 37 | |
---|
| 38 | Once Field Permissions module is installed, you need to edit the field settings |
---|
| 39 | form to enable permissions for each where you need this feature. You can enable |
---|
| 40 | any of the following permission types: |
---|
| 41 | |
---|
| 42 | * Create FIELD (edit on node creation). |
---|
| 43 | * Edit any FIELD, regardless of its node author. |
---|
| 44 | * Edit own FIELD on node created by the user. |
---|
| 45 | * View any FIELD, regardless of its node author. |
---|
| 46 | * View own FIELD on node created by the user. |
---|
| 47 | |
---|
| 48 | Use these options to enable role based permissions for this field. When |
---|
| 49 | permissions are enabled, access to this field is denied by default and explicit |
---|
| 50 | permissions should be granted to the proper user roles from the permissions |
---|
| 51 | administration page. On the other hand, when these options are disabled, field |
---|
| 52 | permissions are inherited from node view and/or edit permissions. In example, |
---|
| 53 | users allowed to view a particular node will also be able to view this field, |
---|
| 54 | and so on. |
---|
| 55 | |
---|
| 56 | |
---|
| 57 | REQUIREMENTS |
---|
| 58 | ============ |
---|
| 59 | |
---|
| 60 | - CCK (6.x-2.5 or higher). |
---|
| 61 | http://drupal.org/project/cck |
---|
| 62 | |
---|
| 63 | Field permissions requires that hook_field_access() is invoked with $account |
---|
| 64 | as 3rd argument (added to CCK in 6.x-2.2, see [#336174] [1]) and $node as 4th |
---|
| 65 | argument (added to CCK in 6.x-2.5, see [#514452] [2]). |
---|
| 66 | |
---|
| 67 | [1] http://drupal.org/node/336174 |
---|
| 68 | [2] http://drupal.org/node/514452 |
---|
| 69 | |
---|
| 70 | |
---|
| 71 | INSTALLATION |
---|
| 72 | ============ |
---|
| 73 | |
---|
| 74 | - Be sure to install all dependent modules. |
---|
| 75 | |
---|
| 76 | - Copy all contents of this package to your modules directory preserving |
---|
| 77 | subdirectory structure. |
---|
| 78 | |
---|
| 79 | - Go to Administer -> Site building -> Modules to install module. |
---|
| 80 | |
---|
| 81 | - Review the settings of your fields. You will find a new option labelled |
---|
| 82 | "Field permissions" that allows you to enable permissions per field. It |
---|
| 83 | is disabled by default. |
---|
| 84 | |
---|
| 85 | |
---|
| 86 | UPGRADING FROM CCK CONTENT PERMISSIONS |
---|
| 87 | ====================================== |
---|
| 88 | |
---|
| 89 | The Field Permissions module is fully compatible with the permissions already |
---|
| 90 | defined with Content Permissions module shipped with CCK. |
---|
| 91 | |
---|
| 92 | 1. Make backups to ensure you can easily fallback in case of any trouble. |
---|
| 93 | 2. Install Field Permissions module while Content Permissions module is |
---|
| 94 | still enabled. |
---|
| 95 | 3. Disable and then Uninstall Content Permissions module. |
---|
| 96 | 4. You can now check your existing permissions are still there, in the |
---|
| 97 | Permissions administration screen. |
---|
| 98 | 5. Now, you may wish to disable permissions for fields where this feature |
---|
| 99 | is not really needed. |
---|