ILIAS  release_5-2 Revision v5.2.25-18-g3f80b82851
ilAdvancedMDPermissionHelper Class Reference

Advanced metadata permission helper. More...

+ Inheritance diagram for ilAdvancedMDPermissionHelper:
+ Collaboration diagram for ilAdvancedMDPermissionHelper:

Data Fields

const CONTEXT_MD = 1
 
const CONTEXT_RECORD = 2
 
const CONTEXT_FIELD = 3
 
const CONTEXT_SUBSTITUTION = 4
 
const CONTEXT_SUBSTITUTION_COURSE = 5
 
const CONTEXT_SUBSTITUTION_CATEGORY = 6
 
const ACTION_MD_CREATE_RECORD = 1
 
const ACTION_MD_IMPORT_RECORDS = 2
 
const ACTION_RECORD_EDIT = 5
 
const ACTION_RECORD_DELETE = 6
 
const ACTION_RECORD_EXPORT = 7
 
const ACTION_RECORD_TOGGLE_ACTIVATION = 8
 
const ACTION_RECORD_EDIT_PROPERTY = 9
 
const ACTION_RECORD_EDIT_FIELDS = 10
 
const ACTION_RECORD_CREATE_FIELD = 11
 
const ACTION_RECORD_FIELD_POSITIONS = 12
 
const ACTION_FIELD_EDIT = 13
 
const ACTION_FIELD_DELETE = 14
 
const ACTION_FIELD_EDIT_PROPERTY = 15
 
const ACTION_SUBSTITUTION_SHOW_DESCRIPTION = 16
 
const ACTION_SUBSTITUTION_SHOW_FIELDNAMES = 17
 
const ACTION_SUBSTITUTION_FIELD_POSITIONS = 18
 
const ACTION_SUBSTITUTION_COURSE_SHOW_FIELD = 19
 
const ACTION_SUBSTITUTION_COURSE_EDIT_FIELD_PROPERTY = 20
 
const ACTION_SUBSTITUTION_CATEGORY_SHOW_FIELD = 21
 
const ACTION_SUBSTITUTION_CATEGORY_EDIT_FIELD_PROPERTY = 22
 
const SUBACTION_RECORD_TITLE = 1
 
const SUBACTION_RECORD_DESCRIPTION = 2
 
const SUBACTION_RECORD_OBJECT_TYPES = 3
 
const SUBACTION_FIELD_TITLE = 4
 
const SUBACTION_FIELD_DESCRIPTION = 5
 
const SUBACTION_FIELD_SEARCHABLE = 6
 
const SUBACTION_FIELD_PROPERTIES = 7
 
const SUBACTION_SUBSTITUTION_BOLD = 8
 
const SUBACTION_SUBSTITUTION_NEWLINE = 9
 

Protected Member Functions

 readContextIds ($a_context_type)
 
 buildPermissionMap ()
 
 getActivePlugins ()
 
 checkPermission ($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id=null)
 
- Protected Member Functions inherited from ilClaimingPermissionHelper
 __construct ($a_user_id, $a_ref_id)
 Constructor. More...
 
 setUserId ($a_value)
 Set user id. More...
 
 getUserId ()
 Get user id. More...
 
 setRefId ($a_value)
 Set ref id. More...
 
 getRefId ()
 Get ref id. More...
 
 readContextIds ($a_context_type)
 Get all context ids for context type (from DB, is cached) More...
 
 buildPermissionMap ()
 Build map of context and actions. More...
 
 isValidContextAndAction ($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id=null)
 Check if given combination of context and action is valid. More...
 
 getValidContextIds ($a_context_type)
 Get context ids for context type (uses cache) More...
 
 checkPermission ($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id=null)
 Check permission (helper: rbac, plugins) More...
 
 checkRBAC ()
 Check permission against RBAC. More...
 
 getActivePlugins ()
 Get active plugins (for current slot) More...
 
 checkPlugins ($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id=null)
 Check permission against plugins. More...
 

Additional Inherited Members

- Public Member Functions inherited from ilClaimingPermissionHelper
 reset ()
 Reset (internal caches) More...
 
 hasPermission ($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id=null)
 Check permission. More...
 
 hasPermissions ($a_context_type, $a_context_id, array $a_action_ids)
 Check permissions. More...
 
- Static Public Member Functions inherited from ilClaimingPermissionHelper
static getInstance ($a_user_id=null, $a_ref_id=null)
 Factory. More...
 
- Protected Attributes inherited from ilClaimingPermissionHelper
 $user_id
 
 $ref_id
 
 $map
 
 $context_ids
 
 $plugins
 
- Static Protected Attributes inherited from ilClaimingPermissionHelper
static $instances
 

Detailed Description

Advanced metadata permission helper.

Author
Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
$Id$

Definition at line 14 of file class.ilAdvancedMDPermissionHelper.php.

Member Function Documentation

◆ buildPermissionMap()

ilAdvancedMDPermissionHelper::buildPermissionMap ( )
protected

Definition at line 106 of file class.ilAdvancedMDPermissionHelper.php.

References array.

107  {
108  return array(
109  self::CONTEXT_MD => array(
110  "actions" => array(
111  self::ACTION_MD_CREATE_RECORD
112  ,self::ACTION_MD_IMPORT_RECORDS
113  )
114  ),
115  self::CONTEXT_RECORD => array(
116  "actions" => array(
117  self::ACTION_RECORD_EDIT
118  ,self::ACTION_RECORD_DELETE
119  ,self::ACTION_RECORD_EXPORT
120  ,self::ACTION_RECORD_TOGGLE_ACTIVATION
121  ,self::ACTION_RECORD_EDIT_FIELDS
122  ,self::ACTION_RECORD_FIELD_POSITIONS
123  ,self::ACTION_RECORD_CREATE_FIELD
124  ),
125  "subactions" => array(
126  self::ACTION_RECORD_EDIT_PROPERTY =>
127  array(
128  self::SUBACTION_RECORD_TITLE
129  ,self::SUBACTION_RECORD_DESCRIPTION
130  ,self::SUBACTION_RECORD_OBJECT_TYPES
131  )
132  )
133  ),
134  self::CONTEXT_FIELD => array(
135  "actions" => array(
136  self::ACTION_FIELD_EDIT,
137  self::ACTION_FIELD_DELETE
138  ),
139  "subactions" => array(
140  self::ACTION_FIELD_EDIT_PROPERTY =>
141  array(
142  self::SUBACTION_FIELD_TITLE
143  ,self::SUBACTION_FIELD_DESCRIPTION
144  ,self::SUBACTION_FIELD_SEARCHABLE
145  ,self::SUBACTION_FIELD_PROPERTIES
146  )
147  )
148  ),
149  self::CONTEXT_SUBSTITUTION => array(
150  "actions" => array(
151  self::ACTION_SUBSTITUTION_SHOW_DESCRIPTION
152  ,self::ACTION_SUBSTITUTION_SHOW_FIELDNAMES
153  ,self::ACTION_SUBSTITUTION_FIELD_POSITIONS
154  )
155  ),
156  self::CONTEXT_SUBSTITUTION_COURSE => array(
157  "actions" => array(
158  self::ACTION_SUBSTITUTION_COURSE_SHOW_FIELD
159  ),
160  "subactions" => array(
161  self::ACTION_SUBSTITUTION_COURSE_EDIT_FIELD_PROPERTY =>
162  array(
163  self::SUBACTION_SUBSTITUTION_BOLD
164  ,self::SUBACTION_SUBSTITUTION_NEWLINE
165  )
166  )
167  ),
168  self::CONTEXT_SUBSTITUTION_CATEGORY => array(
169  "actions" => array(
170  self::ACTION_SUBSTITUTION_CATEGORY_SHOW_FIELD
171  ),
172  "subactions" => array(
173  self::ACTION_SUBSTITUTION_CATEGORY_EDIT_FIELD_PROPERTY =>
174  array(
175  self::SUBACTION_SUBSTITUTION_BOLD
176  ,self::SUBACTION_SUBSTITUTION_NEWLINE
177  )
178  )
179  )
180  );
181  }
Create styles array
The data for the language used.

◆ checkPermission()

ilAdvancedMDPermissionHelper::checkPermission (   $a_context_type,
  $a_context_id,
  $a_action_id,
  $a_action_sub_id = null 
)
protected

Definition at line 201 of file class.ilAdvancedMDPermissionHelper.php.

References $a_context_id, $a_context_type, ACTION_RECORD_EXPORT, ilClaimingPermissionHelper\checkPlugins(), ilClaimingPermissionHelper\checkRBAC(), CONTEXT_RECORD, ilClaimingPermissionHelper\getRefId(), and ilClaimingPermissionHelper\getUserId().

202  {
203  global $ilAccess;
204 
205  if(!$this->checkPlugins($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id))
206  {
207  return false;
208  }
209 
210  // export is considered read-action
213  {
214  return $ilAccess->checkAccessOfUser($this->getUserId(), "read", "", $this->getRefId());
215  }
216 
217  return $this->checkRBAC();
218  }
$a_context_id
Definition: workflow.php:98
checkRBAC()
Check permission against RBAC.
checkPlugins($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id=null)
Check permission against plugins.
$a_context_type
Definition: workflow.php:97
+ Here is the call graph for this function:

◆ getActivePlugins()

ilAdvancedMDPermissionHelper::getActivePlugins ( )
protected

Definition at line 186 of file class.ilAdvancedMDPermissionHelper.php.

References $res, array, and IL_COMP_SERVICE.

187  {
188  global $ilPluginAdmin;
189 
190  $res = array();
191 
192  foreach($ilPluginAdmin->getActivePluginsForSlot(IL_COMP_SERVICE, "AdvancedMetaData", "amdc") as $plugin_name)
193  {
194  $res[] = $ilPluginAdmin->getPluginObject(IL_COMP_SERVICE,
195  "AdvancedMetaData", "amdc", $plugin_name);
196  }
197 
198  return $res;
199  }
Create styles array
The data for the language used.
const IL_COMP_SERVICE

◆ readContextIds()

ilAdvancedMDPermissionHelper::readContextIds (   $a_context_type)
protected

Definition at line 67 of file class.ilAdvancedMDPermissionHelper.php.

References $a_context_type, $ilDB, $res, $row, and array.

68  {
69  global $ilDB;
70 
71  switch($a_context_type)
72  {
73  case self::CONTEXT_MD:
74  return array($_REQUEST["ref_id"]);
75 
76  case self::CONTEXT_RECORD:
77  $set = $ilDB->query("SELECT record_id id".
78  " FROM adv_md_record");
79  break;
80 
81  case self::CONTEXT_FIELD:
82  case self::CONTEXT_SUBSTITUTION_COURSE:
83  case self::CONTEXT_SUBSTITUTION_CATEGORY:
84  $set = $ilDB->query("SELECT field_id id".
85  " FROM adv_mdf_definition");
86  break;
87 
88  case self::CONTEXT_SUBSTITUTION:
89  return array("crs", "cat");
90 
91  default:
92  return array();
93  }
94 
95  $res = array();
96  while($row = $ilDB->fetchAssoc($set))
97  {
98  $res[] = $row["id"];
99  }
100  return $res;
101  }
Create styles array
The data for the language used.
$a_context_type
Definition: workflow.php:97
global $ilDB

Field Documentation

◆ ACTION_FIELD_DELETE

const ilAdvancedMDPermissionHelper::ACTION_FIELD_DELETE = 14

◆ ACTION_FIELD_EDIT

const ilAdvancedMDPermissionHelper::ACTION_FIELD_EDIT = 13

◆ ACTION_FIELD_EDIT_PROPERTY

◆ ACTION_MD_CREATE_RECORD

const ilAdvancedMDPermissionHelper::ACTION_MD_CREATE_RECORD = 1

◆ ACTION_MD_IMPORT_RECORDS

const ilAdvancedMDPermissionHelper::ACTION_MD_IMPORT_RECORDS = 2

◆ ACTION_RECORD_CREATE_FIELD

const ilAdvancedMDPermissionHelper::ACTION_RECORD_CREATE_FIELD = 11

◆ ACTION_RECORD_DELETE

const ilAdvancedMDPermissionHelper::ACTION_RECORD_DELETE = 6

◆ ACTION_RECORD_EDIT

const ilAdvancedMDPermissionHelper::ACTION_RECORD_EDIT = 5

◆ ACTION_RECORD_EDIT_FIELDS

const ilAdvancedMDPermissionHelper::ACTION_RECORD_EDIT_FIELDS = 10

◆ ACTION_RECORD_EDIT_PROPERTY

◆ ACTION_RECORD_EXPORT

const ilAdvancedMDPermissionHelper::ACTION_RECORD_EXPORT = 7

◆ ACTION_RECORD_FIELD_POSITIONS

const ilAdvancedMDPermissionHelper::ACTION_RECORD_FIELD_POSITIONS = 12

◆ ACTION_RECORD_TOGGLE_ACTIVATION

◆ ACTION_SUBSTITUTION_CATEGORY_EDIT_FIELD_PROPERTY

const ilAdvancedMDPermissionHelper::ACTION_SUBSTITUTION_CATEGORY_EDIT_FIELD_PROPERTY = 22

◆ ACTION_SUBSTITUTION_CATEGORY_SHOW_FIELD

const ilAdvancedMDPermissionHelper::ACTION_SUBSTITUTION_CATEGORY_SHOW_FIELD = 21

◆ ACTION_SUBSTITUTION_COURSE_EDIT_FIELD_PROPERTY

const ilAdvancedMDPermissionHelper::ACTION_SUBSTITUTION_COURSE_EDIT_FIELD_PROPERTY = 20

◆ ACTION_SUBSTITUTION_COURSE_SHOW_FIELD

const ilAdvancedMDPermissionHelper::ACTION_SUBSTITUTION_COURSE_SHOW_FIELD = 19

◆ ACTION_SUBSTITUTION_FIELD_POSITIONS

const ilAdvancedMDPermissionHelper::ACTION_SUBSTITUTION_FIELD_POSITIONS = 18

◆ ACTION_SUBSTITUTION_SHOW_DESCRIPTION

const ilAdvancedMDPermissionHelper::ACTION_SUBSTITUTION_SHOW_DESCRIPTION = 16

◆ ACTION_SUBSTITUTION_SHOW_FIELDNAMES

const ilAdvancedMDPermissionHelper::ACTION_SUBSTITUTION_SHOW_FIELDNAMES = 17

◆ CONTEXT_FIELD

◆ CONTEXT_MD

const ilAdvancedMDPermissionHelper::CONTEXT_MD = 1

◆ CONTEXT_RECORD

◆ CONTEXT_SUBSTITUTION

const ilAdvancedMDPermissionHelper::CONTEXT_SUBSTITUTION = 4

◆ CONTEXT_SUBSTITUTION_CATEGORY

const ilAdvancedMDPermissionHelper::CONTEXT_SUBSTITUTION_CATEGORY = 6

◆ CONTEXT_SUBSTITUTION_COURSE

const ilAdvancedMDPermissionHelper::CONTEXT_SUBSTITUTION_COURSE = 5

◆ SUBACTION_FIELD_DESCRIPTION

const ilAdvancedMDPermissionHelper::SUBACTION_FIELD_DESCRIPTION = 5

◆ SUBACTION_FIELD_PROPERTIES

const ilAdvancedMDPermissionHelper::SUBACTION_FIELD_PROPERTIES = 7

◆ SUBACTION_FIELD_SEARCHABLE

◆ SUBACTION_FIELD_TITLE

const ilAdvancedMDPermissionHelper::SUBACTION_FIELD_TITLE = 4

◆ SUBACTION_RECORD_DESCRIPTION

const ilAdvancedMDPermissionHelper::SUBACTION_RECORD_DESCRIPTION = 2

◆ SUBACTION_RECORD_OBJECT_TYPES

◆ SUBACTION_RECORD_TITLE

const ilAdvancedMDPermissionHelper::SUBACTION_RECORD_TITLE = 1

◆ SUBACTION_SUBSTITUTION_BOLD

const ilAdvancedMDPermissionHelper::SUBACTION_SUBSTITUTION_BOLD = 8

◆ SUBACTION_SUBSTITUTION_NEWLINE

const ilAdvancedMDPermissionHelper::SUBACTION_SUBSTITUTION_NEWLINE = 9

The documentation for this class was generated from the following file: