ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilDidacticTemplateBlockRoleAction Class Reference

Description of ilDidacticTemplateBlockRoleAction. More...

+ Inheritance diagram for ilDidacticTemplateBlockRoleAction:
+ Collaboration diagram for ilDidacticTemplateBlockRoleAction:

Public Member Functions

 __construct ($action_id=0)
 Constructor. More...
 
 addFilterPattern (ilDidacticTemplateFilterPattern $pattern)
 Add filter. More...
 
 setFilterPatterns (Array $patterns)
 Set filter patterns. More...
 
 getFilterPattern ()
 Get filter pattern. More...
 
 setFilterType ($a_type)
 Set filter type. More...
 
 getFilterType ()
 Get filter type. More...
 
 save ()
 Save action. More...
 
 delete ()
 delete action filter @global ilDB $ilDB More...
 
 apply ()
 Apply action. More...
 
 revert ()
 Revert action. More...
 
 getType ()
 Get action type. More...
 
 toXml (ilXmlWriter $writer)
 Export to xml. More...
 
 __clone ()
 clone method More...
 
 read ()
 read action data @global ilDB $ilDB More...
 
- Public Member Functions inherited from ilDidacticTemplateAction
 __construct ($action_id=0)
 Constructor. More...
 
 getActionId ()
 Get action id. More...
 
 setActionId ($a_action_id)
 Set action id. More...
 
 setType ($a_type_id)
 Set type id. More...
 
 setTemplateId ($a_id)
 Set template id. More...
 
 getTemplateId ()
 Get template id. More...
 
 setRefId ($a_ref_id)
 Set ref id of target object. More...
 
 getRefId ()
 Get ref id of target object. More...
 
 save ()
 write action to db overwrite for filling additional db fields More...
 
 delete ()
 Delete didactic template action overwrite for filling additional db fields. More...
 
 read ()
 @global ilDB $ilDB More...
 
 getType ()
 Get type of template. More...
 
 apply ()
 Apply action. More...
 
 revert ()
 Implement everthing that is necessary to revert a didactic template. More...
 
 __clone ()
 Clone method. More...
 
 toXml (ilXmlWriter $writer)
 Write xml for export. More...
 

Data Fields

const FILTER_SOURCE_TITLE = 1
 
const FILTER_SOURCE_OBJ_ID = 2
 
const PATTERN_PARENT_TYPE = 'action'
 
- Data Fields inherited from ilDidacticTemplateAction
const TYPE_LOCAL_POLICY = 1
 
const TYPE_LOCAL_ROLE = 2
 
const TYPE_BLOCK_ROLE = 3
 
const FILTER_SOURCE_TITLE = 1
 
const FILTER_SOURCE_OBJ_ID = 2
 
const PATTERN_PARENT_TYPE = 'action'
 

Protected Member Functions

 blockRole ($a_role_id, $source)
 Blo k role. More...
 
 deleteLocalPolicy ($a_role_id, $source)
 Delete local policy. More...
 
- Protected Member Functions inherited from ilDidacticTemplateAction
 initSourceObject ()
 Init the source object. More...
 
 filterRoles (ilObject $source)
 Filter roles. More...
 

Private Attributes

 $pattern = array()
 
 $filter_type = self::FILTER_SOURCE_TITLE
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

ilDidacticTemplateBlockRoleAction::__construct (   $action_id = 0)

Constructor.

Parameters
int$action_id

Reimplemented from ilDidacticTemplateAction.

Definition at line 27 of file class.ilDidacticTemplateBlockRoleAction.php.

28 {
29 parent::__construct($action_id);
30 }

References ilDidacticTemplateAction\$action_id.

Member Function Documentation

◆ __clone()

ilDidacticTemplateBlockRoleAction::__clone ( )

clone method

Reimplemented from ilDidacticTemplateAction.

Definition at line 261 of file class.ilDidacticTemplateBlockRoleAction.php.

262 {
263 parent::__clone();
264
265 // Clone patterns
266 $cloned = array();
267 foreach($this->getFilterPattern() as $pattern)
268 {
269 $clones[] = clone $pattern;
270 }
271 $this->setFilterPatterns($clones);
272 }
setFilterPatterns(Array $patterns)
Set filter patterns.

References $pattern, getFilterPattern(), and setFilterPatterns().

+ Here is the call graph for this function:

◆ addFilterPattern()

ilDidacticTemplateBlockRoleAction::addFilterPattern ( ilDidacticTemplateFilterPattern  $pattern)

Add filter.

Parameters
ilDidacticTemplateFilterPatter$pattern

Definition at line 36 of file class.ilDidacticTemplateBlockRoleAction.php.

37 {
38 $this->pattern[] = $pattern;
39 }

References $pattern.

Referenced by read().

+ Here is the caller graph for this function:

◆ apply()

ilDidacticTemplateBlockRoleAction::apply ( )

Apply action.

Reimplemented from ilDidacticTemplateAction.

Definition at line 130 of file class.ilDidacticTemplateBlockRoleAction.php.

131 {
132 $source = $this->initSourceObject();
133 $roles = $this->filterRoles($source);
134
135 // Create local policy for filtered roles
136 foreach($roles as $role_id => $role)
137 {
138 $this->blockRole($role_id, $source);
139 }
140 return true;
141 }
initSourceObject()
Init the source object.
filterRoles(ilObject $source)
Filter roles.

References blockRole(), ilDidacticTemplateAction\filterRoles(), and ilDidacticTemplateAction\initSourceObject().

+ Here is the call graph for this function:

◆ blockRole()

ilDidacticTemplateBlockRoleAction::blockRole (   $a_role_id,
  $source 
)
protected

Blo k role.

Parameters
int$a_role_id
ilObject$source

Definition at line 148 of file class.ilDidacticTemplateBlockRoleAction.php.

149 {
150 global $rbacadmin, $rbacreview;
151
152 // Set assign to 'y' only if it is a local role
153 $assign = $rbacreview->isAssignable($a_role_id, $source->getRefId()) ? 'y' : 'n';
154
155 // Delete permissions
156 $rbacadmin->revokeSubtreePermissions($source->getRefId(), $a_role_id);
157
158 // Delete template permissions
159 $rbacadmin->deleteSubtreeTemplates($source->getRefId(), $a_role_id);
160
161 $rbacadmin->assignRoleToFolder(
162 $a_role_id,
163 $source->getRefId(),
164 $assign
165 );
166 return true;
167 }

Referenced by apply().

+ Here is the caller graph for this function:

◆ delete()

ilDidacticTemplateBlockRoleAction::delete ( )

delete action filter @global ilDB $ilDB

Returns
bool

Reimplemented from ilDidacticTemplateAction.

Definition at line 107 of file class.ilDidacticTemplateBlockRoleAction.php.

108 {
109 global $ilDB;
110
111 parent::delete();
112
113 $query = 'DELETE FROM didactic_tpl_abr '.
114 'WHERE action_id = '.$ilDB->quote($this->getActionId(),'integer');
115 $ilDB->manipulate($query);
116
117 foreach($this->getFilterPattern() as $pattern)
118 {
119 $pattern->delete();
120 }
121 return true;
122 }
global $ilDB

References $ilDB, $pattern, $query, ilDidacticTemplateAction\getActionId(), and getFilterPattern().

+ Here is the call graph for this function:

◆ deleteLocalPolicy()

ilDidacticTemplateBlockRoleAction::deleteLocalPolicy (   $a_role_id,
  $source 
)
protected

Delete local policy.

Parameters
int$a_role_id
ilObject$source

Definition at line 191 of file class.ilDidacticTemplateBlockRoleAction.php.

192 {
193 global $rbacreview, $rbacadmin;
194
195 // Create role folder if it does not exist
196 //$rolf = $rbacreview->getRoleFolderIdOfObject($source->getRefId());
197
198 if($rbacreview->getRoleFolderOfRole($a_role_id) == $source->getRefId())
199 {
200 ilLoggerFactory::getLogger('otpl')->debug('Ignoring local role: '.ilObject::_lookupTitle($a_role_id));
201 return false;
202 }
203
204 $rbacadmin->deleteLocalRole($a_role_id, $source->getRefId());
205
206 // Change existing object
207 include_once './Services/AccessControl/classes/class.ilObjRole.php';
208 $role = new ilObjRole($a_role_id);
209 $role->changeExistingObjects(
210 $source->getRefId(),
212 array('all')
213 );
214
215 return true;
216 }
static getLogger($a_component_id)
Get component logger.
Class ilObjRole.
const MODE_UNPROTECTED_DELETE_LOCAL_POLICIES
static _lookupTitle($a_id)
lookup object title

References ilObject\_lookupTitle(), ilLoggerFactory\getLogger(), and ilObjRole\MODE_UNPROTECTED_DELETE_LOCAL_POLICIES.

Referenced by revert().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getFilterPattern()

ilDidacticTemplateBlockRoleAction::getFilterPattern ( )

Get filter pattern.

Returns
array

Definition at line 54 of file class.ilDidacticTemplateBlockRoleAction.php.

55 {
56 return $this->pattern;
57 }

References $pattern.

Referenced by __clone(), delete(), save(), and toXml().

+ Here is the caller graph for this function:

◆ getFilterType()

ilDidacticTemplateBlockRoleAction::getFilterType ( )

Get filter type.

Returns
int

Definition at line 72 of file class.ilDidacticTemplateBlockRoleAction.php.

References $filter_type.

Referenced by save(), and toXml().

+ Here is the caller graph for this function:

◆ getType()

ilDidacticTemplateBlockRoleAction::getType ( )

Get action type.

Returns
int

Reimplemented from ilDidacticTemplateAction.

Definition at line 223 of file class.ilDidacticTemplateBlockRoleAction.php.

References ilDidacticTemplateAction\TYPE_BLOCK_ROLE.

◆ read()

ilDidacticTemplateBlockRoleAction::read ( )

read action data @global ilDB $ilDB

Returns
bool

Reimplemented from ilDidacticTemplateAction.

Definition at line 279 of file class.ilDidacticTemplateBlockRoleAction.php.

280 {
281 global $ilDB;
282
283 if(!parent::read())
284 {
285 return false;
286 }
287
288 $query = 'SELECT * FROM didactic_tpl_abr '.
289 'WHERE action_id = '.$ilDB->quote($this->getActionId());
290 $res = $ilDB->query($query);
291 while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
292 {
293 $this->setFilterType($row->filter_type);
294 }
295
296 // Read filter
297 include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateFilterPatternFactory.php';
299 {
300 $this->addFilterPattern($pattern);
301 }
302 }
const DB_FETCHMODE_OBJECT
Definition: class.ilDB.php:11
addFilterPattern(ilDidacticTemplateFilterPattern $pattern)
Add filter.
static lookupPatternsByParentId($a_parent_id, $a_parent_type)
Get patterns by template id.

References $ilDB, $pattern, $query, $res, $row, addFilterPattern(), DB_FETCHMODE_OBJECT, ilDidacticTemplateAction\getActionId(), ilDidacticTemplateFilterPatternFactory\lookupPatternsByParentId(), and setFilterType().

+ Here is the call graph for this function:

◆ revert()

ilDidacticTemplateBlockRoleAction::revert ( )

Revert action.

Reimplemented from ilDidacticTemplateAction.

Definition at line 172 of file class.ilDidacticTemplateBlockRoleAction.php.

173 {
174 $source = $this->initSourceObject();
175 $roles = $this->filterRoles($source);
176
177 // Create local policy for filtered roles
178 foreach($roles as $role_id => $role)
179 {
180 $this->deleteLocalPolicy($role_id, $source);
181 }
182 return true;
183 }
deleteLocalPolicy($a_role_id, $source)
Delete local policy.

References deleteLocalPolicy(), ilDidacticTemplateAction\filterRoles(), and ilDidacticTemplateAction\initSourceObject().

+ Here is the call graph for this function:

◆ save()

ilDidacticTemplateBlockRoleAction::save ( )

Save action.

Reimplemented from ilDidacticTemplateAction.

Definition at line 80 of file class.ilDidacticTemplateBlockRoleAction.php.

81 {
82 global $ilDB;
83
84 parent::save();
85
86 $query = 'INSERT INTO didactic_tpl_abr (action_id,filter_type) '.
87 'VALUES( '.
88 $ilDB->quote($this->getActionId(),'integer').', '.
89 $ilDB->quote($this->getFilterType(),'integer').' '.
90 ')';
91 $ilDB->manipulate($query);
92
93 foreach($this->getFilterPattern() as $pattern)
94 {
95 /* @var ilDidacticTemplateFilterPattern $pattern */
96 $pattern->setParentId($this->getActionId());
97 $pattern->setParentType(self::PATTERN_PARENT_TYPE);
98 $pattern->save();
99 }
100 }

References $ilDB, $pattern, $query, ilDidacticTemplateAction\getActionId(), getFilterPattern(), and getFilterType().

+ Here is the call graph for this function:

◆ setFilterPatterns()

ilDidacticTemplateBlockRoleAction::setFilterPatterns ( Array  $patterns)

Set filter patterns.

Parameters
array$patterns

Definition at line 45 of file class.ilDidacticTemplateBlockRoleAction.php.

46 {
47 $this->pattern = $patterns;
48 }

Referenced by __clone().

+ Here is the caller graph for this function:

◆ setFilterType()

ilDidacticTemplateBlockRoleAction::setFilterType (   $a_type)

Set filter type.

Parameters
int$a_type

Definition at line 63 of file class.ilDidacticTemplateBlockRoleAction.php.

64 {
65 $this->filter_type = $a_type;
66 }

Referenced by read().

+ Here is the caller graph for this function:

◆ toXml()

ilDidacticTemplateBlockRoleAction::toXml ( ilXmlWriter  $writer)

Export to xml.

Parameters
ilXmlWriter$writer
Returns
void

Reimplemented from ilDidacticTemplateAction.

Definition at line 233 of file class.ilDidacticTemplateBlockRoleAction.php.

234 {
235 $writer->xmlStartTag('blockRoleAction');
236
237 switch($this->getFilterType())
238 {
240 $writer->xmlStartTag('roleFilter',array('source' => 'objId'));
241 break;
242
243 default:
245 $writer->xmlStartTag('roleFilter',array('source' => 'title'));
246 break;
247 }
248
249 foreach($this->getFilterPattern() as $pattern)
250 {
251 $pattern->toXml($writer);
252 }
253 $writer->xmlEndTag('roleFilter');
254 $writer->xmlEndTag('blockRoleAction');
255 return;
256 }
xmlEndTag($tag)
Writes an endtag.
xmlStartTag($tag, $attrs=NULL, $empty=FALSE, $encode=TRUE, $escape=TRUE)
Writes a starttag.

References $pattern, FILTER_SOURCE_OBJ_ID, FILTER_SOURCE_TITLE, getFilterPattern(), getFilterType(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

+ Here is the call graph for this function:

Field Documentation

◆ $filter_type

ilDidacticTemplateBlockRoleAction::$filter_type = self::FILTER_SOURCE_TITLE
private

Definition at line 21 of file class.ilDidacticTemplateBlockRoleAction.php.

Referenced by getFilterType().

◆ $pattern

ilDidacticTemplateBlockRoleAction::$pattern = array()
private

◆ FILTER_SOURCE_OBJ_ID

const ilDidacticTemplateBlockRoleAction::FILTER_SOURCE_OBJ_ID = 2

Definition at line 15 of file class.ilDidacticTemplateBlockRoleAction.php.

Referenced by toXml().

◆ FILTER_SOURCE_TITLE

const ilDidacticTemplateBlockRoleAction::FILTER_SOURCE_TITLE = 1

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

Referenced by toXml().

◆ PATTERN_PARENT_TYPE

const ilDidacticTemplateBlockRoleAction::PATTERN_PARENT_TYPE = 'action'

Definition at line 17 of file class.ilDidacticTemplateBlockRoleAction.php.


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