Helper class to create new object types (object_data, RBAC) More...

Collaboration diagram for ilDBUpdateNewObjectType:

Static Public Member Functions
static	addNewType ($a_type_id, $a_type_title)
	Add new type to object data. More...

static	addRBACOperations ($a_type_id, array $a_operations)
	Add RBAC operations for type. More...

static	addRBACOperation ($a_type_id, $a_ops_id)
	Add RBAC operation. More...

static	isRBACOperation ($a_type_id, $a_ops_id)
	Check if rbac operation exists. More...

static	deleteRBACOperation ($a_type, $a_ops_id)
	Delete rbac operation. More...

static	deleteRBACTemplateOperation ($a_type, $a_ops_id)
	Delete operation for type in templates. More...

static	getCustomRBACOperationId ($a_operation)
	Get id of RBAC operation. More...

static	addCustomRBACOperation ($a_id, $a_title, $a_class, $a_pos)
	Add custom RBAC operation. More...

static	getObjectTypeId ($a_type)
	Get id for object data type entry. More...

static	addRBACCreate ($a_id, $a_title, array $a_parent_types)
	Add create RBAC operations for parent object types. More...

static	updateOperationOrder ($a_operation, $a_pos)
	Change order of operations. More...

static	addAdminNode ($a_obj_type, $a_title)
	Create new admin object node. More...

static	cloneOperation ($a_obj_type, $a_source_op_id, $a_target_op_id)
	Clone RBAC-settings between operations. More...

static	varchar2text ($a_table_name, $a_column_name)
	Migrate varchar column to text/clob. More...

static	addRBACTemplate ($a_obj_type, $a_id, $a_description, $a_op_ids)
	Add new RBAC template. More...

Data Fields
const	RBAC_OP_EDIT_PERMISSIONS = 1

const	RBAC_OP_VISIBLE = 2

const	RBAC_OP_READ = 3

const	RBAC_OP_WRITE = 4

const	RBAC_OP_DELETE = 6

const	RBAC_OP_COPY = 99

Static Protected Member Functions
static	isValidRBACOperation ($a_ops_id)
	Check if given RBAC operation id is valid. More...

Detailed Description

Helper class to create new object types (object_data, RBAC)

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

Id: class.ilObjFolderGUI.php 25134 2010-08-13 14:22:11Z smeyer

Definition at line 13 of file class.ilDBUpdateNewObjectType.php.

Member Function Documentation

◆ addAdminNode()

static ilDBUpdateNewObjectType::addAdminNode	(	$a_obj_type,
		$a_title
	)

static

Create new admin object node.

Parameters

string	$a_id
string	$a_title

Definition at line 325 of file class.ilDBUpdateNewObjectType.php.

References $ilDB, $ref_id, and array.

         {
                 global $ilDB, $tree;
                 
                 if(self::getObjectTypeId($a_obj_type))
                 {
                         return;
                 }
                 
                 $obj_type_id = self::addNewType($a_obj_type, $a_title);
 
                 $obj_id = $ilDB->nextId('object_data');
                 $ilDB->manipulate("INSERT INTO object_data ".
                         "(obj_id, type, title, description, owner, create_date, last_update) VALUES (".
                         $ilDB->quote($obj_id, "integer").",".
                         $ilDB->quote($a_obj_type, "text").",".
                         $ilDB->quote($a_title, "text").",".
                         $ilDB->quote($a_title, "text").",".
                         $ilDB->quote(-1, "integer").",".
                         $ilDB->now().",".
                         $ilDB->now().
                         ")");
 
                 $ref_id = $ilDB->nextId('object_reference');
                 $ilDB->manipulate("INSERT INTO object_reference ".
                         "(obj_id, ref_id) VALUES (".
                         $ilDB->quote($obj_id, "integer").",".
                         $ilDB->quote($ref_id, "integer").
                         ")");
 
                 // put in tree
                 require_once("Services/Tree/classes/class.ilTree.php");
                 $tree = new ilTree(ROOT_FOLDER_ID);
                 $tree->insertNode($ref_id, SYSTEM_FOLDER_ID);
 
                 $rbac_ops = array(
                         self::RBAC_OP_EDIT_PERMISSIONS,
                         self::RBAC_OP_VISIBLE,
                         self::RBAC_OP_READ,
                         self::RBAC_OP_WRITE
                 );
                 self::addRBACOperations($obj_type_id, $rbac_ops);
         }

◆ addCustomRBACOperation()

static ilDBUpdateNewObjectType::addCustomRBACOperation	(	$a_id,
		$a_title,
		$a_class,
		$a_pos
	)

static

Add custom RBAC operation.

Parameters

string	$a_id
string	$a_title
string	$a_class
string	$a_pos

Returns: int ops_id

Definition at line 230 of file class.ilDBUpdateNewObjectType.php.

References $ilDB, and array.

         {
                 global $ilDB;
                 
                 // check if it already exists
                 $ops_id = self::getCustomRBACOperationId($a_id);
                 if($ops_id)
                 {
                         return $ops_id;
                 }
                 
                 if(!in_array($a_class, array('create', 'object', 'general')))
                 {
                         return;
                 }
                 if($a_class == 'create')
                 {
                         $a_pos = 9999;
                 }
                 
                 $ops_id = $ilDB->nextId('rbac_operations');
                 
                 $fields = array(
                         'ops_id' => array('integer', $ops_id),
                         'operation' => array('text', $a_id),
                         'description' => array('text', $a_title),
                         'class' => array('text', $a_class),
                         'op_order' => array('integer', $a_pos),
                 );              
                 $ilDB->insert('rbac_operations', $fields);
                 
                 return $ops_id;
         }       

◆ addNewType()

static ilDBUpdateNewObjectType::addNewType	(	$a_type_id,
		$a_type_title
	)

static

Add new type to object data.

Parameters

string	$a_type_id
string	$a_type_title

Returns: int insert id

Definition at line 29 of file class.ilDBUpdateNewObjectType.php.

References $ilDB, array, and ilUtil\now().

         {
                 global $ilDB;
                 
                 // check if it already exists
                 $type_id = self::getObjectTypeId($a_type_id);
                 if($type_id)
                 {
                         return $type_id;
                 }
                 
                 $type_id = $ilDB->nextId('object_data');
                 
                 $fields = array(
                         'obj_id' => array('integer', $type_id),
                         'type' => array('text', 'typ'),
                         'title' => array('text', $a_type_id),
                         'description' => array('text', $a_type_title),
                         'owner' => array('integer', -1),
                         'create_date' => array('timestamp', ilUtil::now()),
                         'last_update' => array('timestamp', ilUtil::now())
                 );      
                 $ilDB->insert('object_data', $fields);
                 
                 return $type_id;
         }

Here is the call graph for this function:

◆ addRBACCreate()

static ilDBUpdateNewObjectType::addRBACCreate	(		$a_id,
			$a_title,
		array	$a_parent_types
	)

static

Add create RBAC operations for parent object types.

Parameters

string	$a_id
string	$a_title
array	$a_parent_types

Definition at line 289 of file class.ilDBUpdateNewObjectType.php.

         {               
                 $ops_id = self::addCustomRBACOperation($a_id, $a_title, 'create', 9999);
                 
                 foreach($a_parent_types as $type)
                 {
                         $type_id = self::getObjectTypeId($type);                
                         if($type_id)
                         {
                                 self::addRBACOperation($type_id, $ops_id);
                         }
                 }               
         }       

◆ addRBACOperation()

static ilDBUpdateNewObjectType::addRBACOperation	(	$a_type_id,
		$a_ops_id
	)

static

Add RBAC operation.

Parameters

int	$a_type_id
int	$a_ops_id

Returns: bool

Definition at line 85 of file class.ilDBUpdateNewObjectType.php.

References $ilDB, and array.

         {
                 global $ilDB;
                 
                 // check if it already exists
                 $set = $ilDB->query('SELECT * FROM rbac_ta'.
                         ' WHERE typ_id = '.$ilDB->quote($a_type_id, 'integer').
                         ' AND ops_id = '.$ilDB->quote($a_ops_id, 'integer'));
                 if($ilDB->numRows($set))
                 {                       
                         return false;
                 }               
                 
                 $fields = array(
                         'typ_id' => array('integer', $a_type_id),
                         'ops_id' => array('integer', $a_ops_id)
                 );
                 $ilDB->insert('rbac_ta', $fields);
                 return true;
         }

◆ addRBACOperations()

static ilDBUpdateNewObjectType::addRBACOperations	(		$a_type_id,
		array	$a_operations
	)

static

Add RBAC operations for type.

Parameters

int	$a_type_id
array	$a_operations

Definition at line 62 of file class.ilDBUpdateNewObjectType.php.

         {               
                 foreach($a_operations as $ops_id)
                 {                                               
                         if(self::isValidRBACOperation($ops_id))
                         {                       
                                 if($ops_id == self::RBAC_OP_COPY)
                                 {
                                         $ops_id = self::getCustomRBACOperationId('copy');                                       
                                 }
                                 
                                 self::addRBACOperation($a_type_id, $ops_id);
                         }
                 }               
         }

◆ addRBACTemplate()

static ilDBUpdateNewObjectType::addRBACTemplate	(	$a_obj_type,
		$a_id,
		$a_description,
		$a_op_ids
	)

static

Add new RBAC template.

Parameters

string	$a_obj_type
string	$a_id
string	$a_description
int \| array	$a_op_ids

Definition at line 491 of file class.ilDBUpdateNewObjectType.php.

References $ilDB, array, and ilUtil\now().

         {
                 global $ilDB;
                 
                 $new_tpl_id = $ilDB->nextId('object_data');
 
                 $ilDB->manipulateF("INSERT INTO object_data (obj_id, type, title, description,".
                         " owner, create_date, last_update) VALUES (%s, %s, %s, %s, %s, %s, %s)",
                         array("integer", "text", "text", "text", "integer", "timestamp", "timestamp"),
                         array($new_tpl_id, "rolt", $a_id, $a_description, -1, ilUtil::now(), ilUtil::now()));
                                 
                 $ilDB->manipulateF("INSERT INTO rbac_fa (rol_id, parent, assign, protected)".
                         " VALUES (%s, %s, %s, %s)", 
                         array("integer", "integer", "text", "text"),
                         array($new_tpl_id, 8, "n", "n"));
                 
                 if($a_op_ids)
                 {
                         if(!is_array($a_op_ids))
                         {
                                 $a_op_ids = array($a_op_ids);
                         }
                         foreach($a_op_ids as $op_id)
                         {
                                 $ilDB->manipulateF("INSERT INTO rbac_templates (rol_id, type, ops_id, parent)".
                                 " VALUES (%s, %s, %s, %s)", 
                                 array("integer", "text", "integer", "integer"),
                                 array($new_tpl_id, $a_obj_type, $op_id, 8));
                         }
                 }
         }

Here is the call graph for this function:

◆ cloneOperation()

static ilDBUpdateNewObjectType::cloneOperation	(	$a_obj_type,
		$a_source_op_id,
		$a_target_op_id
	)

static

Clone RBAC-settings between operations.

Parameters

string	$a_obj_type
int	$a_source_op_id
int	$a_target_op_id

Definition at line 376 of file class.ilDBUpdateNewObjectType.php.

References $ilDB, $row, and array.

         {
                 global $ilDB;
                 
                 // rbac_pa
                 $sql = "SELECT rpa.*".
                         " FROM rbac_pa rpa".
                         " JOIN object_reference ref ON (ref.ref_id = rpa.ref_id)".
                         " JOIN object_data od ON (od.obj_id = ref.obj_id AND od.type = ".$ilDB->quote($a_obj_type).")".
                         // see ilUtil::_getObjectsByOperations()
                         " WHERE (".$ilDB->like("ops_id", "text","%i:".$a_source_op_id."%"). 
                         " OR ".$ilDB->like("ops_id", "text", "%:\"".$a_source_op_id."\";%").")";
                 $set = $ilDB->query($sql);
                 while($row = $ilDB->fetchAssoc($set))
                 {
                         $ops = unserialize($row["ops_id"]);
                         // the query above could match by array KEY, we need extra checks
                         if(in_array($a_source_op_id, $ops) && !in_array($a_target_op_id, $ops))
                         {                               
                                 $ops[] = $a_target_op_id;
                                 
                                 $ilDB->manipulate("UPDATE rbac_pa".
                                         " SET ops_id = ".$ilDB->quote(serialize($ops), "text").
                                         " WHERE rol_id = ".$ilDB->quote($row["rol_id"], "integer").
                                         " AND ref_id = ".$ilDB->quote($row["ref_id"], "integer"));
                         }
                 }
                 
                 // rbac_templates
                 $tmp = array();
                 $sql = "SELECT rol_id, parent, ops_id".
                         " FROM rbac_templates".
                         " WHERE type = ".$ilDB->quote($a_obj_type, "text").
                         " AND (ops_id = ".$ilDB->quote($a_source_op_id, "integer").
                         " OR ops_id = ".$ilDB->quote($a_target_op_id).")";
                 $set = $ilDB->query($sql);
                 while($row = $ilDB->fetchAssoc($set))
                 {
                         $tmp[$row["rol_id"]][$row["parent"]][] = $row["ops_id"];                        
                 }
                 
                 foreach($tmp as $role_id => $parents)
                 {
                         foreach($parents as $parent_id => $ops_ids)
                         {
                                 // only if the target op is missing
                                 if(sizeof($ops_ids) < 2 && in_array($a_source_op_id, $ops_ids))
                                 {                                       
                                         $ilDB->manipulate("INSERT INTO rbac_templates".
                                                 " (rol_id, type, ops_id, parent)".
                                                 " VALUES ".
                                                 "(".$ilDB->quote($role_id, "integer").
                                                 ",".$ilDB->quote($a_obj_type, "text").
                                                 ",".$ilDB->quote($a_target_op_id, "integer").
                                                 ",".$ilDB->quote($parent_id, "integer").
                                                 ")");
                                 }
                         }
                 }
         }

◆ deleteRBACOperation()

static ilDBUpdateNewObjectType::deleteRBACOperation	(	$a_type,
		$a_ops_id
	)

static

Delete rbac operation.

Parameters

int	$a_type
int	$a_ops_id

Definition at line 134 of file class.ilDBUpdateNewObjectType.php.

References $a_type, $GLOBALS, $ilDB, and $query.

         {
                 global $ilDB;
                 
                 if(!$a_type || !$a_ops_id)
                 {
                         return;
                 }
                 
                 $type_id = self::getObjectTypeId($a_type);
                 if(!$type_id)
                 {
                         return;
                 }
 
                 $query = 'DELETE FROM rbac_ta WHERE '.
                         'typ_id = '.$ilDB->quote($type_id,'integer').' AND '.
                         'ops_id = '.$ilDB->quote($a_ops_id,'integer');
                 $GLOBALS['ilLog']->write(__METHOD__.': '.$query);
                 $ilDB->manipulate($query);              
                 
                 self::deleteRBACTemplateOperation($a_type, $a_ops_id);
         }

◆ deleteRBACTemplateOperation()

static ilDBUpdateNewObjectType::deleteRBACTemplateOperation	(	$a_type,
		$a_ops_id
	)

static

Delete operation for type in templates.

Parameters

string	$a_type
int	$a_ops_id

Definition at line 164 of file class.ilDBUpdateNewObjectType.php.

References $a_type, $GLOBALS, $ilDB, and $query.

         {
                 global $ilDB;
                 
                 if(!$a_type || !$a_ops_id)
                 {
                         return;
                 }
 
                 $query = 'DELETE FROM rbac_templates WHERE '.
                         'type = '.$ilDB->quote($a_type,'text').' AND '.
                         'ops_id = '.$ilDB->quote($a_ops_id,'integer');  
                 $GLOBALS['ilLog']->write(__METHOD__.': '.$query);
                 $ilDB->manipulate($query);      
         }

◆ getCustomRBACOperationId()

static ilDBUpdateNewObjectType::getCustomRBACOperationId ( $a_operation )

static

Get id of RBAC operation.

Parameters

string $a_operation

Returns: int

Definition at line 209 of file class.ilDBUpdateNewObjectType.php.

References $ilDB, $res, and $row.

         {
                 global $ilDB;
                 
                 $sql = 'SELECT ops_id'.
                         ' FROM rbac_operations'.
                         ' WHERE operation = '.$ilDB->quote($a_operation, 'text');
                 $res = $ilDB->query($sql);
                 $row = $ilDB->fetchAssoc($res);
                 return $row['ops_id'];
         }

◆ getObjectTypeId()

static ilDBUpdateNewObjectType::getObjectTypeId ( $a_type )

static

Get id for object data type entry.

Parameters

string $a_type

Returns: int

Definition at line 270 of file class.ilDBUpdateNewObjectType.php.

References $a_type, $ilDB, $res, and $row.

         {
                 global $ilDB;
                 
                 $sql = 'SELECT obj_id FROM object_data'.
                         ' WHERE type = '.$ilDB->quote('typ', 'text').
                         ' AND title = '.$ilDB->quote($a_type, 'text');
                 $res = $ilDB->query($sql);
                 $row = $ilDB->fetchAssoc($res);
                 return $row['obj_id'];
         }

◆ isRBACOperation()

static ilDBUpdateNewObjectType::isRBACOperation	(	$a_type_id,
		$a_ops_id
	)

static

Check if rbac operation exists.

Parameters

int	$a_type_id	type id
int	$a_ops_id	operation id

Returns: bool

Definition at line 113 of file class.ilDBUpdateNewObjectType.php.

References $ilDB.

         {
                 global $ilDB;
 
                 // check if it already exists
                 $set = $ilDB->query('SELECT * FROM rbac_ta' .
                         ' WHERE typ_id = ' . $ilDB->quote($a_type_id, 'integer') .
                         ' AND ops_id = ' . $ilDB->quote($a_ops_id, 'integer'));
                 if ($ilDB->numRows($set))
                 {
                         return true;
                 }
                 return false;
         }

◆ isValidRBACOperation()

static ilDBUpdateNewObjectType::isValidRBACOperation ( $a_ops_id )

staticprotected

Check if given RBAC operation id is valid.

Parameters

int $a_ops_id

Returns: bool

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

References $valid, and array.

         {
                 $valid = array(
                         self::RBAC_OP_EDIT_PERMISSIONS,
                         self::RBAC_OP_VISIBLE,
                         self::RBAC_OP_READ,
                         self::RBAC_OP_WRITE,
                         self::RBAC_OP_DELETE,
                         self::RBAC_OP_COPY                              
                 );
                 if(in_array($a_ops_id, $valid))
                 {
                         return true;
                 }
                 return false;
         }

◆ updateOperationOrder()

static ilDBUpdateNewObjectType::updateOperationOrder	(	$a_operation,
		$a_pos
	)

static

Change order of operations.

Parameters

string	$a_operation
int	$a_pos

Definition at line 309 of file class.ilDBUpdateNewObjectType.php.

References $ilDB, and array.

         {
                 global $ilDB;
                 
                 $ilDB->update('rbac_operations', 
                         array('op_order' => array('integer', $a_pos)),
                         array('operation' => array('text', $a_operation))               
                 );
         }

◆ varchar2text()

static ilDBUpdateNewObjectType::varchar2text	(	$a_table_name,
		$a_column_name
	)

static

Migrate varchar column to text/clob.

Parameters

string	$a_table_name
string	$a_column_name

Returns: bool

Definition at line 444 of file class.ilDBUpdateNewObjectType.php.

References $ilDB, ilDBInterface\addTableColumn(), array, ilDBInterface\dropTableColumn(), ilDBInterface\manipulate(), and ilDBInterface\renameTableColumn().

         {
                 global $ilDB;
                 
                 $tmp_column_name = $a_column_name."_tmp_clob";
                 
                 if(!$ilDB->tableColumnExists($a_table_name, $a_column_name) ||
                         $ilDB->tableColumnExists($a_table_name, $tmp_column_name))
                 {
                         return false;
                 }
                 
                 // oracle does not support ALTER TABLE varchar2 to CLOB
 
                 $ilAtomQuery = $ilDB->buildAtomQuery();
                 $ilAtomQuery->addTableLock($a_table_name);
 
                 $ilAtomQuery->addQueryCallable(
                         function(ilDBInterface $ilDB) use ($a_table_name, $a_column_name, $tmp_column_name)
                 {
                                 $def = array(
                                         'type'    => 'clob',
                                         'notnull' => false
                                 );
                                 $ilDB->addTableColumn($a_table_name, $tmp_column_name, $def);
 
                                 $ilDB->manipulate('UPDATE '.$a_table_name.' SET '.$tmp_column_name.' = '.$a_column_name);
 
                                 $ilDB->dropTableColumn($a_table_name, $a_column_name);
 
                                 $ilDB->renameTableColumn($a_table_name, $tmp_column_name, $a_column_name);
 
                 });
 
                 $ilAtomQuery->run();
                 
                 return true;
         }

Here is the call graph for this function:

Field Documentation

◆ RBAC_OP_COPY

const ilDBUpdateNewObjectType::RBAC_OP_COPY = 99

Definition at line 20 of file class.ilDBUpdateNewObjectType.php.

◆ RBAC_OP_DELETE

const ilDBUpdateNewObjectType::RBAC_OP_DELETE = 6

Definition at line 19 of file class.ilDBUpdateNewObjectType.php.

◆ RBAC_OP_EDIT_PERMISSIONS

const ilDBUpdateNewObjectType::RBAC_OP_EDIT_PERMISSIONS = 1

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

◆ RBAC_OP_READ

const ilDBUpdateNewObjectType::RBAC_OP_READ = 3

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

◆ RBAC_OP_VISIBLE

const ilDBUpdateNewObjectType::RBAC_OP_VISIBLE = 2

Definition at line 16 of file class.ilDBUpdateNewObjectType.php.

◆ RBAC_OP_WRITE

const ilDBUpdateNewObjectType::RBAC_OP_WRITE = 4

Definition at line 18 of file class.ilDBUpdateNewObjectType.php.

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

Services/Migration/DBUpdate_3560/classes/class.ilDBUpdateNewObjectType.php

Static Public Member Functions

Data Fields

Static Protected Member Functions

Detailed Description

Member Function Documentation

◆ addAdminNode()

◆ addCustomRBACOperation()

◆ addNewType()

◆ addRBACCreate()

◆ addRBACOperation()

◆ addRBACOperations()

◆ addRBACTemplate()

◆ cloneOperation()

◆ deleteRBACOperation()

◆ deleteRBACTemplateOperation()

◆ getCustomRBACOperationId()

◆ getObjectTypeId()

◆ isRBACOperation()

◆ isValidRBACOperation()

◆ updateOperationOrder()

◆ varchar2text()

Field Documentation

◆ RBAC_OP_COPY

◆ RBAC_OP_DELETE

◆ RBAC_OP_EDIT_PERMISSIONS

◆ RBAC_OP_READ

◆ RBAC_OP_VISIBLE

◆ RBAC_OP_WRITE