Namespaces
namespace	ilias
	admin objects frameset
Functions
	updateObject ($a_obj_id, $a_title, $a_desc, $a_len_title=MAXLENGTH_OBJ_TITLE, $a_len_desc=MAXLENGTH_OBJ_DESC, $a_dots=true)
	deprecated: Use new ilObj..($obj_id, false) or $ilias->obj_factory->getInstanceByObjId($obj_id) instead
	updateObjectValue ($a_obj_id, $a_column, $a_value)
	updates a single value in a column of object data public
	fetchObjectData ($a_row)
	fetch object data from mysql result set and returns an array private
	getObjectList ($a_obj_type="", $a_order="", $a_direction="ASC", $a_offset="", $a_limit="")
	get list of object, optional only a list of a particular type public
	getOperationList ($a_type="", $a_order="", $a_direction="")
	get operation list by object type TODO: rename function to: getOperationByType public
	createNewOperation ($a_operation, $a_description)
	creates a new object public
	getOperationId ($a_operation)
	get operation id by name of operation public
	isUserLoggedIn ()
	POSSIBLE DEPRECATED.
	trimDeluxe ($a_text)
	TODO: move to class.util removes spaces and tabs within text strings public.
	loginExists ($a_login, $a_user_id=0)
	deprecated: moved to class ilUtil
	sendInfo ($a_info="", $a_keep=false)
	sends a message to the recent page if you call sendInfo without any parameter, function will display a stored message in session and delete it afterwards public
	infoPanel ($a_keep=true)

Function Documentation

createNewOperation	(	$	a_operation,
		$	a_description
	)

creates a new object public

Parameters:

	string	operation name
	string	operation description

Returns:: integer returns operation id

Definition at line 278 of file class.perm.php.

References $ilias, $ops_id, $q, ilUtil::addSlashes(), and getOperationId().

{
        global $ilias;

        if (!isset($a_operation))
        {
                $message = "perm::createNewOperation(): No operation name given!";
                $ilias->raiseError($message,$ilias->error_obj->WARNING);
        }

        // check if operation exists
        $ops_id = getOperationId($a_operation);
        // quit in case operation already exists
        if (!empty($ops_id))
        {
                $message = "perm::createNewOperation(): An operation '".$a_operation."' is already defined!";
                $ilias->raiseError($message,$ilias->error_obj->WARNING);
        }

        $q = "INSERT INTO operations ".
                 "(operation,description) ".
                 "VALUES ".
                 "('".ilUtil::addSlashes($a_operation)."','".ilUtil::addSlashes($a_description)."')";
        $ilias->db->query($q);

        return $ilias->db->getLastInsertId();
}

Here is the call graph for this function:

fetchObjectData ( $ a_row )

fetch object data from mysql result set and returns an array private

Parameters:

object

result row of mysql result set

Returns:: array

Definition at line 153 of file class.perm.php.

Referenced by ilRbacReview::getAssignableRoles(), getObjectList(), ilRbacReview::getRoleListByObject(), and ilRbacReview::getRolesByFilter().

{
        $arr = array (
                                        "obj_id"                => $a_row->obj_id,
                                        "ref_id"                => $a_row->ref_id,
                                        "type"                  => $a_row->type,
                                        "title"                 => $a_row->title,
                                        "description"   => $a_row->description, // for compability only
                                        "desc"                  => $a_row->description,
                                        "usr_id"                => $a_row->owner,       // compability
                                        "owner"                 => $a_row->owner,
                                        "create_date"   => $a_row->create_date,
                                        "last_update"   => $a_row->last_update,
                                        "last_login"    => $a_row->last_login,  // maybe senseless
                                        "assign"                => $a_row->assign,      // maybe senseless
                                        "parent"                => $a_row->parent       // role folder 
                                );

        return $arr ? $arr : array();   // maybe senseless
}

Here is the caller graph for this function:

getObjectList	(	$	a_obj_type = `""`,
		$	a_order = `""`,
		$	a_direction = `"ASC"`,
		$	a_offset = `""`,
		$	a_limit = `""`
	)

get list of object, optional only a list of a particular type public

Parameters:

	string	object type
	integer	start row of result set
	integer	maximum rows in result set
	string	order column
	string	order direction (possible values: ASC or DESC)

Returns:: array/boolean returns array of objects or false if no objects found

Definition at line 185 of file class.perm.php.

References $ilias, $q, $row, and fetchObjectData().

Referenced by ilLanguage::getInstalledLanguages(), ilObjLanguageFolder::getLanguages(), ilObjLanguageFolderGUI::refreshObject(), and ilObjObjectFolderGUI::viewObject().

{
        global $ilias;
        
        // order
        if (!$a_order)
        {
                $a_order = "title";
        }
        
        $order = "ORDER BY ".$a_order." ".$a_direction;

        // limit clause
        if ($a_limit && $a_offset)
        {
                $limit_clause = " LIMIT ".$a_offset.",".$a_limit;
        }

        // where clause
        if ($a_obj_type)
        {
                $where_clause = "WHERE type = '".$a_obj_type."' ";
        }

        $q = "SELECT * FROM object_data ".$where_clause.$order.$limit_clause;
        $r = $ilias->db->query($q);

        if ($r->numRows() > 0)
        {
                while ($row = $r->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $arr[$row->obj_id] = fetchObjectData($row);
                }

                return $arr;
        }

        return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

getOperationId ( $ a_operation )

get operation id by name of operation public

Parameters:

string

operation name

Returns:: integer operation id

Definition at line 312 of file class.perm.php.

References $ilias, $q, and $row.

Referenced by ilRbacSystem::checkAccessOfUser(), and createNewOperation().

{
        global $ilias;

        if (!isset($a_operation))
        {
                $message = "perm::getOperationId(): No operation given!";
                $ilias->raiseError($message,$ilias->error_obj->WARNING);        
        }

        $q = "SELECT DISTINCT ops_id FROM rbac_operations ".
                 "WHERE operation ='".$a_operation."'";             
        $row = $ilias->db->getRow($q);

        return $row->ops_id;
}

Here is the caller graph for this function:

getOperationList	(	$	a_type = `""`,
		$	a_order = `""`,
		$	a_direction = `""`
	)

get operation list by object type TODO: rename function to: getOperationByType public

Parameters:

	string	object type you want to have the operation list
	string	order column
	string	order direction (possible values: ASC or DESC)

Returns:: array returns array of operations

Definition at line 234 of file class.perm.php.

References $ilias, $q, and $row.

Referenced by ilObjTypeDefinitionGUI::editObject(), ilObjectStatusGUI::getAssignedValidRoles(), ilObjectStatusGUI::getPermissionInfo(), ilObjectGUI::permObject(), and ilObjTypeDefinitionGUI::viewObject().

 {
        global $ilias;

        if (!$a_order)
        {
                $a_order = "operation";
        }

        if ($a_type)
        {
                $q = "SELECT * FROM rbac_operations ".
                         "LEFT JOIN rbac_ta ON rbac_operations.ops_id = rbac_ta.ops_id ".
                         "LEFT JOIN object_data ON rbac_ta.typ_id = object_data.obj_id ".
                         "WHERE object_data.title='".$a_type."' AND object_data.type='typ' ".
                         "ORDER BY rbac_operations.".$a_order." ".$a_direction; 
        }
        else
        {
                $q = "SELECT * FROM rbac_operations ".
                         "ORDER BY ".$a_order." ".$a_direction;
        }
        
        $r = $ilias->db->query($q);

        while ($row = $r->fetchRow())
        {
                $arr[] = array(
                                        "ops_id"        => $row[0],
                                        "operation"     => $row[1],
                                        "desc"          => $row[2]
                                        );
        }

        return $arr;
}

Here is the caller graph for this function:

infoPanel ( $ a_keep = true )

Definition at line 462 of file class.perm.php.

References $_SESSION, $ilias, $lng, and $tpl.

Referenced by ilObjLinkResourceGUI::__prepareOutput(), ilObjRoleGUI::__prepareOutput(), ilObjChatGUI::__prepareOutput(), ilSearchGUI::__show(), ilSearchAdministrationGUI::__show(), ilSearchAdministrationGUI::__showCreateFolder(), ilSearchAdministrationGUI::__showRename(), ilSearchAdministrationGUI::__showTree(), ilObjiLincCourseGUI::changeMemberObject(), ilObjGroupGUI::changeMemberObject(), ilObjiLincCourseGUI::confirmationObject(), ilObjGroupGUI::confirmationObject(), ilLOListGUI::displayList(), ilBookmarkAdministrationGUI::main_header(), ilSearchBaseGUI::prepareOutput(), and ilRepositoryGUI::prepareOutput().

{
        global $tpl,$ilias,$lng;

        if (!empty($_SESSION["infopanel"]) and is_array($_SESSION["infopanel"]))
        {
                $tpl->addBlockFile("INFOPANEL", "infopanel", "tpl.infopanel.html");
                $tpl->setCurrentBlock("infopanel");

                if (!empty($_SESSION["infopanel"]["text"]))
                {
                        $link = "<a href=\"".$dir.$_SESSION["infopanel"]["link"]."\" target=\"bottom\">";
                        $link .= $lng->txt($_SESSION["infopanel"]["text"]);
                        $link .= "</a>";
                }

                // deactivated
                if (!empty($_SESSION["infopanel"]["img"]))
                {
                        $link .= "<td><a href=\"".$_SESSION["infopanel"]["link"]."\" target=\"bottom\">";
                        $link .= "<img src=\"".$ilias->tplPath.$ilias->account->prefs["skin"]."/images/".
                                $_SESSION["infopanel"]["img"]."\" border=\"0\" vspace=\"0\"/>";
                        $link .= "</a></td>";
                }

                $tpl->setVariable("INFO_ICONS",$link);
                $tpl->parseCurrentBlock();
        }

        //if (!$a_keep)
        //{
                        session_unregister("infopanel");
        //}
}

Here is the caller graph for this function:

isUserLoggedIn ( )

POSSIBLE DEPRECATED.

IF NOT, FUNCTION BELONGS TO class.user check if user is logged in public

Returns:: boolean true if logged in

Definition at line 355 of file class.perm.php.

References $ilias, and $user_id.

{
        global $ilias;

        $user_id = $ilias->account->getId();

        if (empty($user_id))
        {
                return false;
        }

        return true;
}

loginExists	(	$	a_login,
		$	a_user_id = `0`
	)

deprecated: moved to class ilUtil

check if a login name already exists You may exclude a user from the check by giving his user id as 2nd paramter public

Parameters:

	string	login name
	integer	user id of user to exclude (optional)

Returns:: boolean

Definition at line 406 of file class.perm.php.

References $ilias, and $q.

Referenced by ilMail::__substituteRecipients(), ilSoapUserAdministration::__validateUserData(), ShibAuth::login(), saveForm(), ilObjUserGUI::saveObject(), and ilObjUserGUI::updateObject().

{
        global $ilias;

        if ($a_user_id == 0)
        {
                $clause = "";
        }
        else
        {
                $clause = "AND usr_id != '".$a_user_id."'";
        }

        $q = "SELECT DISTINCT login FROM usr_data ".
                 "WHERE login = '".ilUtil::stripSlashes($a_login)."' ".$clause;
        $r = $ilias->db->query($q);
        
        if ($r->numRows() == 1)
        {
                return true;
        }
        
        return false;
}

Here is the caller graph for this function:

sendInfo	(	$	a_info = `""`,
		$	a_keep = `false`
	)

sends a message to the recent page if you call sendInfo without any parameter, function will display a stored message in session and delete it afterwards public

Parameters:

	string	message
	boolean	if true message is kept in session

Definition at line 439 of file class.perm.php.

References $_SESSION, and $tpl.

{
        global $tpl;

        if (!empty($a_info))
        {
                $_SESSION["info"] = $a_info;
        }

        if (!empty($_SESSION["info"]))
        {
                $tpl->addBlockFile("MESSAGE", "message", "tpl.message.html");
#               $tpl->setCurrentBlock("message");
                $tpl->setVariable("INFO",$_SESSION["info"]);
#               $tpl->parseCurrentBlock();
        }

        if (!$a_keep)
        {
                        session_unregister("info");
        }
}

Here is the caller graph for this function:

trimDeluxe ( $ a_text )

TODO: move to class.util removes spaces and tabs within text strings public.

Parameters:

string

string to be trimmed

Returns:: string trimmed string

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

Referenced by ilXML2SQL::insertText().

{
        str_replace("\t"," ",$a_text);

        for ($i=0;$i<50;$i++)
        {
                str_replace("  "," ",$a_text);
        }

        $a_text = trim($a_text);

        return $a_text;
}

Here is the caller graph for this function:

updateObject	(	$	a_obj_id,
		$	a_title,
		$	a_desc,
		$	a_len_title = `MAXLENGTH_OBJ_TITLE`,
		$	a_len_desc = `MAXLENGTH_OBJ_DESC`,
		$	a_dots = `true`
	)

deprecated: Use new ilObj..($obj_id, false) or $ilias->obj_factory->getInstanceByObjId($obj_id) instead

deprecated: Use new ilObj..($ref_id, true) or $ilias->obj_factory->getInstanceByRefId($ref_id) instead deprecated: use ilObject->clone() instead deprecated: use ilObject->delete() instead updates an object public

Parameters:

	integer	object id
	string	object title
	string	object description
	integer	cut length of title string to given value (optional, default: MAXLENGTH_OBJ_TITLE)
	integer	cut length of description string to given value (optional, default: MAXLENGTH_OBJ_DESC)
	boolean	adding 3 dots to shortended string (optional, default: true)

Returns:: boolean true

Definition at line 83 of file class.perm.php.

References $ilias, $q, and ilUtil::shortenText().

{
        global $ilias;

        if (!isset($a_obj_id))
        {
                $message = "perm::updateObject(): No obj_id given!";
                $ilias->raiseError($message,$ilias->error_obj->WARNING);        
        }
        
        if (empty($a_title))
        {
                $message = "perm::updateObject(): No title given! A title is required!";
                $ilias->raiseError($message,$ilias->error_obj->WARNING);        
        }

        // cut length of text
        $a_title = ilUtil::shortenText($a_title,$a_len_title,$a_dots);
        $_desc = ilUtil::shortenText($a_desc,$a_len_desc,$a_dots);

        $q = "UPDATE object_data ".
                 "SET ".
                 "title='".ilUtil::addSlashes($a_title)."',".
                 "description='".ilUtil::addSlashes($a_desc)."', ".
                 "last_update=now() ".
                 "WHERE obj_id='".$a_obj_id."'";
        $ilias->db->query($q);

        return true;
}

Here is the call graph for this function:

updateObjectValue	(	$	a_obj_id,
		$	a_column,
		$	a_value
	)

updates a single value in a column of object data public

Parameters:

	integer	object id of object to change
	string	column name of obj_data table
	string	value to be changed

Returns:: boolean true on success

Definition at line 122 of file class.perm.php.

References $ilias, $q, and ilUtil::addSlashes().

{
        global $ilias;
        
        if (!isset($a_obj_id))
        {
                $message = "perm::updateObjectValue(): No obj_id given!";
                $ilias->raiseError($message,$ilias->error_obj->WARNING);        
        }
        
        if (!isset($a_column))
        {
                $message = "perm::updateObjectValue(): No table column specified!";
                $ilias->raiseError($message,$ilias->error_obj->WARNING);        
        }

        $q = "UPDATE object_data ".
                 "SET ".$a_column."='".ilUtil::addSlashes($a_value)."',".
                 "last_update=now() ".
                 "WHERE obj_id='".$a_id."'";
        $ilias->db->query($q);
        
        return true;
}

Here is the call graph for this function:

classes/class.perm.php File Reference

Namespaces

Functions

Function Documentation