ilCtrl Class Reference

This class provides processing control methods. More...

Collaboration diagram for ilCtrl:

Public Member Functions
	__construct ()
	control class constructor More...
	callBaseClass ()
	Calls base class of current request. More...
	getModuleDir ()
	get directory of current module More...
	forwardCommand ($a_gui_object)
	Forward flow of control to next gui class this invokes the executeCommand() method of the gui object that is passed via reference. More...
	getHTML ($a_gui_object, array $a_parameters=null, array $class_path=[])
	Gets an HTML output from another GUI class and returns the flow of control to the calling class. More...
	setContext ($a_obj_id, $a_obj_type, $a_sub_obj_id=0, $a_sub_obj_type="")
	Set context of current user interface. More...
	getContextObjId ()
	Get context object id. More...
	getContextObjType ()
	Get context object type. More...
	getContextSubObjId ()
	Get context subobject id. More...
	getContextSubObjType ()
	Get context subobject type. More...
	checkTargetClass ($a_class)
	Check whether target is valid. More...
	getCmdNode ()
	Get command target node. More...
	addTab ($a_lang_var, $a_link, $a_cmd, $a_class)
	Add a tab to tabs array (. More...
	getTabs ()
	Get tabs array (. More...
	getCallHistory ()
	Get controller call history. More...
	getCallStructure ($a_class)
	Get call structure of class context. More...
	readCallStructure ($a_class, $a_nr=0, $a_parent=0)
	Reads call structure from db. More...
	saveParameter ($a_obj, $a_parameter)
	Set parameters that should be passed in every form and link of a gui class. More...
	saveParameterByClass ($a_class, $a_parameter)
	Save parameter for a class. More...
	setParameter ($a_obj, $a_parameter, $a_value)
	Set parameters that should be passed a form and link of a gui class. More...
	setParameterByClass ($a_class, $a_parameter, $a_value)
	Same as setParameterByClass, except that a class name is passed. More...
	clearParameterByClass ($a_class, $a_parameter)
	Same as setParameterByClass, except that a class name is passed. More...
	clearParameters ($a_obj)
	Clears all parameters that have been set via setParameter for a GUI class. More...
	clearParametersByClass ($a_class)
	Clears all parameters that have been set via setParameter for a GUI class. More...
	getNextClass ($a_gui_class=null)
	Get next class in the control path from the current class to the target command class. More...
	lookupClassPath ($a_class_name)
	Get class path that can be used in include statements for a given class name. More...
	getClassForClasspath ($a_class_path)
	this method assumes that the class path has the format "dir/class.<class_name>.php" More...
	setTargetScript (string $a_target_script)
	set target script name More...
	getTargetScript ()
	Get target script name. More...
	initBaseClass ($a_base_class)
	Initialises new base class. More...
	getCmd ($a_default_cmd="", $a_safe_commands="")
	Determines current get/post command. More...
	setCmd ($a_cmd)
	Set the current command. More...
	setCmdClass ($a_cmd_class)
	Set the current command class. More...
	getCmdClass ()
	Determines class that should execute the current command. More...
	getFormAction ( $a_gui_obj, $a_fallback_cmd="", $a_anchor="", $a_asynch=false, $xml_style=false)
	Get form action url for gui class object. More...
	getFormActionByClass ( $a_class, $a_fallback_cmd="", $a_anchor="", $a_asynch=false, $xml_style=false)
	Get form action url for gui class name. More...
	appendRequestTokenParameterString ($a_url, $xml_style=false)
	Append request token as url parameter. More...
	getRequestToken ()
	Get request token. More...
	redirect ($a_gui_obj, $a_cmd="", $a_anchor="", $a_asynch=false)
	Redirect to another command. More...
	redirectToURL ($a_script)
	redirectByClass ($a_class, $a_cmd="", $a_anchor="", $a_asynch=false)
	Redirect to other gui class using class name. More...
	isAsynch ()
	Is current command an asynchronous command? More...
	getLinkTarget ( $a_gui_obj, $a_cmd="", $a_anchor="", $a_asynch=false, $xml_style=false)
	Get link target for command using gui object. More...
	getLinkTargetByClass ( $a_class, $a_cmd="", $a_anchor="", $a_asynch=false, $xml_style=false)
	Get link target for command using gui class name. More...
	setReturn ($a_gui_obj, $a_cmd)
	Set return command. More...
	setReturnByClass ($a_class, $a_cmd)
	Set return command. More...
	returnToParent ($a_gui_obj, $a_anchor="")
	Redirects to next parent class that used setReturn. More...
	getParentReturn ($a_gui_obj)
	Get return script url. More...
	getParentReturnByClass ($a_class)
	Get return script url. More...
	getReturnClass ($a_class)
	Get return class. More...
	getRedirectSource ()
	Get current redirect source. More...
	getUrlParameters ($a_class, $a_str, $a_cmd="", $xml_style=false)
	Get URL parameters for a class and append them to a string. More...
	getParameterArray ($a_gui_obj, $a_cmd="")
	Get all set/save parameters for a gui object. More...
	getParameterArrayByClass ($a_class, $a_cmd="")
	Get all set/save parameters using gui class name. More...
	insertCtrlCalls ($a_parent, $a_child, $a_comp_prefix)
	Insert ctrl calls record. More...
	checkCurrentPathForClass ($gui_class)
	Check if current path contains a certain gui class. More...
	getCurrentClassPath ()
	Get current class path as array of class file names. More...

Data Fields
const	IL_RTOKEN_NAME = 'rtoken'

Protected Member Functions
	initializeMemberVariables ()
	Initialize member variables. More...
	checkLPSettingsForward ($a_gui_obj, $a_cmd_node)
	getReadableNode ($node)
	Get readable node. More...

Protected Attributes
	$save_parameter
	$parameter
	$return
	$call_hist = array()
	Stores the order in which different GUI classes were called. More...
	$calls = array()
	Stores which class calls which other class. More...
	$rtoken = false
	$target_script = "ilias.php"
	$module_dir
	$use_current_to_determine_next = false
	$inner_base_class = ""

Private Member Functions
	getNodeIdForTargetClass ($a_par_node, $a_class, $a_check=false)
	Searches a node for a given class ($a_class) "near" another node ($a_par_node). More...
	getPathNew ($a_source_node, $a_target_node)
	Get path in call structure. More...
	verifyToken ()
	Verify Token. More...
	searchReturnClass ($a_class)
	Determine current return class. More...
	classCidUnknown ($a_class)
	getCidForClass ($a_class, $a_check=false)
	Get class id for class after fetching and storing corresponding information, if necessary. More...
	cidClassUnknown ($a_cid)
	getClassForCid ($a_cid)
	Get class for class id after fetching and storing corresponding information, if necessary. More...
	fetchCallsOfClassFromCache ($a_class, ilCachedCtrl $a_cached_ctrl)
	readCidInfo ($a_cid)
	Save class respective to $a_cid and store corresponding class calls for future reference. More...
	readNodeInfo ($a_node)
	Save classes respective to the class id's of a node and store corresponding class calls for future reference. More...
	readClassInfo ($a_class)
	Save class id respective to $a_class and store corresponding class calls for future reference. More...
	callOfClassNotKnown ($a_class, $a_child)
	updateClassCidMap ($a_class, $a_cid)
	getParentCidOfNode ($a_node)
	Get 2nd to last class id of node. More...
	getCidOfNode ($a_node)
	Get last class id of node. More...
	removeLastCid ($a_node)
	Remove the class id that comes at the beginning the sequence. More...
	getCurrentCidOfNode ($a_node)
	Get cid of node. More...

Detailed Description

This class provides processing control methods.

A global instance is available via variable $ilCtrl

xml_style parameters: This mode was activated per default in the past, is now set to false but still being used and needed, if link information is passed to the xslt processing e.g. in content pages.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilCtrl::__construct

(

)

control class constructor

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

    {
        $this->initializeMemberVariables();
 
        // this information should go to xml files one day
        $this->stored_trees = array("ilrepositorygui", "ildashboardgui",
            "illmpresentationgui", "illmeditorgui",
            "iladministrationgui");
    }

References initializeMemberVariables().

Here is the call graph for this function:

Member Function Documentation

addTab()

ilCtrl::addTab	(		$a_lang_var,
			$a_link,
			$a_cmd,
			$a_class
	)

Add a tab to tabs array (.

Deprecated:

use $ilTabs)

Parameters

string	$a_lang_var	language variable
string	$a_link	link
string	$a_cmd	command (must be same as in link)
string	$a_class	command class (must be same as in link)

Definition at line 498 of file class.ilCtrl.php.

    {
        $a_class = strtolower($a_class);
 
        $this->tab[] = array("lang_var" => $a_lang_var,
            "link" => $a_link, "cmd" => $a_cmd, "class" => $a_class);
    }

appendRequestTokenParameterString()

ilCtrl::appendRequestTokenParameterString	(		$a_url,
			$xml_style = false
	)

Append request token as url parameter.

Parameters

string	url
boolean	xml style

Definition at line 1117 of file class.ilCtrl.php.

    {
        return ilUtil::appendUrlParameterString(
            $a_url,
            self::IL_RTOKEN_NAME . '=' . $this->getRequestToken(),
            $xml_style
        );
    }

References ilUtil\appendUrlParameterString(), and getRequestToken().

Here is the call graph for this function:

callBaseClass()

ilCtrl::callBaseClass

(

)

Calls base class of current request.

The base class is passed via $_GET["baseClass"] and is the first class in the call sequence of the request. Do not call this method within other scripts than ilias.php.

Exceptions

ilCtrlException

Definition at line 140 of file class.ilCtrl.php.

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        
        $baseClass = strtolower($_GET["baseClass"]);
 
        $module_class = ilCachedCtrl::getInstance();
        $mc_rec = $module_class->lookupModuleClass($baseClass);
 
        $module = $mc_rec["module"];
        $class = $mc_rec["class"];
        $class_dir = $mc_rec["dir"];
        
        if ($module != "") {
            $m_set = $ilDB->query("SELECT * FROM il_component WHERE name = " .
                $ilDB->quote($module, "text"));
            $m_rec = $ilDB->fetchAssoc($m_set);
        } else {                // check whether class belongs to a service
            $mc_rec = $module_class->lookupServiceClass($baseClass);
 
            $service = $mc_rec["service"];
            $class = $mc_rec["class"];
            $class_dir = $mc_rec["dir"];
            
            if ($service == "") {
                include_once("./Services/UICore/exceptions/class.ilCtrlException.php");
                throw new ilCtrlException("Could not find entry in modules.xml or services.xml for " .
                    $baseClass . " <br/>" . str_replace("&", "<br />&", htmlentities($_SERVER["REQUEST_URI"])));
            }
 
            $m_rec = ilComponent::getComponentInfo('Services', $service);
        }
        
        // forward processing to base class
        $this->getCallStructure(strtolower($baseClass));
        $base_class_gui = new $class();
        $this->forwardCommand($base_class_gui);
    }

References $_GET, $_SERVER, $DIC, $ilDB, $service, forwardCommand(), getCallStructure(), ilComponent\getComponentInfo(), and ilCachedCtrl\getInstance().

Here is the call graph for this function:

callOfClassNotKnown()

ilCtrl::callOfClassNotKnown (   $a_class,   $a_child  )

private

Definition at line 1778 of file class.ilCtrl.php.

    {
        return !isset($this->calls[$a_class])
                || !is_array($this->calls[$a_class])
                || !in_array($a_child, $this->calls[$a_class]);
    }

Referenced by fetchCallsOfClassFromCache().

Here is the caller graph for this function:

checkCurrentPathForClass()

ilCtrl::checkCurrentPathForClass

(

$gui_class

)

Check if current path contains a certain gui class.

Parameters

$gui_class

Returns

bool

Exceptions

ilCtrlException

Definition at line 1868 of file class.ilCtrl.php.

    {
        foreach (explode(":", $this->getCmdNode()) as $cid) {
            if ($cid != "" && strtolower($this->getClassForCid($cid)) == strtolower($gui_class)) {
                return true;
            }
        }
        return false;
    }

References getClassForCid(), and getCmdNode().

Here is the call graph for this function:

checkLPSettingsForward()

ilCtrl::checkLPSettingsForward (   $a_gui_obj,   $a_cmd_node  )

protected

Definition at line 696 of file class.ilCtrl.php.

    {
        global $DIC;
 
        $objDefinition = $DIC["objDefinition"];
        
        // forward to learning progress settings if possible and accessible
        if ($_GET["gotolp"] &&
            $a_gui_obj) {
            $ref_id = $_GET["ref_id"];
            if (!$ref_id) {
                $ref_id = $_REQUEST["ref_id"];
            }
            
            $gui_class = get_class($a_gui_obj);
            
            if ($gui_class == "ilSAHSEditGUI") {
                // #1625 - because of scorm "sub-types" this is all very special
                include_once "./Modules/ScormAicc/classes/class.ilObjSAHSLearningModule.php";
                $obj_id = ilObject::_lookupObjectId($ref_id);
                switch (ilObjSAHSLearningModule::_lookupSubType($obj_id)) {
                    case "scorm2004":
                        $class = "ilObjSCORM2004LearningModuleGUI";
                        break;
                
                    case "scorm":
                        $class = "ilObjSCORMLearningModuleGUI";
                        break;
 
                    case "aicc":
                        $class = "ilObjAICCLearningModuleGUI";
                        break;
 
                    case "hacp":
                        $class = "ilObjHACPLearningModuleGUI";
                        break;
                }
                if ($GLOBALS["ilAccess"]->checkAccess("edit_learning_progress", "", $ref_id)) {
                    $this->redirectByClass(array($gui_class, $class, "illearningprogressgui", "illplistofsettingsgui"), "");
                }
            }
            // special case: cannot use any presentation GUIs
            elseif ($gui_class == "ilLMPresentationGUI") {
                $this->setParameterByClass("ilObjLearningModuleGUI", "gotolp", 1);
                $this->redirectByClass(array("ilLMEditorGUI", "ilObjLearningModuleGUI"), "");
            }
                        
            include_once "Services/Object/classes/class.ilObjectLP.php";
            $type = ilObject::_lookupType($ref_id, true);
            $class = "ilObj" . $objDefinition->getClassName($type) . "GUI";
            
            if ($gui_class == $class &&
                ilObjectLP::isSupportedObjectType($type) &&
                $GLOBALS["ilAccess"]->checkAccess("edit_learning_progress", "", $ref_id)) {
                // add path to repository object gui if missing from cmdNode
                if (!$a_cmd_node) {
                    $repo_node = $this->getNodeIdForTargetClass(null, "ilrepositorygui");
                    $obj_node = $this->getNodeIdForTargetClass($repo_node["node_id"], $gui_class);
                    $a_cmd_node = $obj_node["node_id"];
                }
                // find path to lp settings
                $lp_node = $this->getNodeIdForTargetClass($a_cmd_node, "illearningprogressgui");
                $lp_settings_node = $this->getNodeIdForTargetClass($lp_node["node_id"], "illplistofsettingsgui");
                $_GET["cmdNode"] = $lp_settings_node["node_id"];
                $_GET["cmdClass"] = "ilLPListOfSettingsGUI";
                $_GET["cmd"] = "";
                return "illearningprogressgui";
            }
        }
    }

References $_GET, $DIC, $GLOBALS, $type, ilObject\_lookupObjectId(), ilObjSAHSLearningModule\_lookupSubType(), ilObject\_lookupType(), getNodeIdForTargetClass(), ilObjectLP\isSupportedObjectType(), redirectByClass(), and setParameterByClass().

Referenced by getNextClass().

Here is the call graph for this function:

Here is the caller graph for this function:

checkTargetClass()

ilCtrl::checkTargetClass

(

$a_class

)

Check whether target is valid.

Parameters

return

Definition at line 457 of file class.ilCtrl.php.

    {
        if (!is_array($a_class)) {
            $a_class = array($a_class);
        }
 
        $nr = $this->current_node;
        foreach ($a_class as $class) {
            $class = strtolower($class);
 
            if (!$this->getCidForClass($class, true)) {
                return false;
            }
 
            $nr = $this->getNodeIdForTargetClass($nr, $class, true);
            $nr = $nr["node_id"];
            if ($nr === false) {
                return false;
            }
        }
        return true;
    }

References getCidForClass(), and getNodeIdForTargetClass().

Here is the call graph for this function:

cidClassUnknown()

ilCtrl::cidClassUnknown (   $a_cid )

private

Definition at line 1685 of file class.ilCtrl.php.

    {
        return $this->cid_class[$a_cid] == "";
    }

Referenced by getClassForCid().

Here is the caller graph for this function:

classCidUnknown()

ilCtrl::classCidUnknown (   $a_class )

private

Definition at line 1657 of file class.ilCtrl.php.

    {
        return $this->class_cid[$a_class] == "";
    }

Referenced by getCidForClass().

Here is the caller graph for this function:

clearParameterByClass()

ilCtrl::clearParameterByClass	(		$a_class,
			$a_parameter
	)

Same as setParameterByClass, except that a class name is passed.

Parameters

string	$a_class	gui class name
string	$a_parameter	parameter name
string	$a_parameter	parameter value

Definition at line 669 of file class.ilCtrl.php.

    {
        unset($this->parameter[strtolower($a_class)][$a_parameter]);
    }

clearParameters()

ilCtrl::clearParameters

(

$a_obj

)

Clears all parameters that have been set via setParameter for a GUI class.

Parameters

object

$a_obj

gui object

Definition at line 680 of file class.ilCtrl.php.

    {
        $this->clearParametersByClass(strtolower(get_class($a_obj)));
    }

References clearParametersByClass().

Here is the call graph for this function:

clearParametersByClass()

ilCtrl::clearParametersByClass

(

$a_class

)

Clears all parameters that have been set via setParameter for a GUI class.

Parameters

string

$a_class

gui class name

Definition at line 691 of file class.ilCtrl.php.

    {
        $this->parameter[strtolower($a_class)] = array();
    }

Referenced by clearParameters().

Here is the caller graph for this function:

fetchCallsOfClassFromCache()

ilCtrl::fetchCallsOfClassFromCache (   $a_class, ilCachedCtrl  $a_cached_ctrl  )

private

Definition at line 1706 of file class.ilCtrl.php.

    {
        foreach ($a_cached_ctrl->lookupCall($a_class) as $call) {
            if ($call["child"] != "" && $this->callOfClassNotKnown($a_class, $call['child'])) {
                $this->calls[$a_class][] = $call["child"];
            }
        }
    }

References callOfClassNotKnown(), and ilCachedCtrl\lookupCall().

Referenced by readCidInfo(), and readClassInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

forwardCommand()

ilCtrl::forwardCommand

(

$a_gui_object

)

Forward flow of control to next gui class this invokes the executeCommand() method of the gui object that is passed via reference.

Parameters

object

$a_gui_object

gui object that should receive

Returns

mixed return data of invoked executeCommand() method

Exceptions

ilCtrlException

Definition at line 202 of file class.ilCtrl.php.

    {
        $class = strtolower(get_class($a_gui_object));
        $nr = $this->getNodeIdForTargetClass($this->current_node, $class);
        $nr = $nr["node_id"];
        if ($nr != "") {
            $current_node = $this->current_node;
            
            $this->current_node = $nr;
 
            // always populate the call history
            // it will only be displayed in DEVMODE but is needed for UI plugins, too
            $this->call_hist[] = array("class" => get_class($a_gui_object),
                    "mode" => "execComm", "cmd" => $this->getCmd());
 
            $html = $a_gui_object->executeCommand();
            
            // reset current node
            $this->current_node = $current_node;
            
            return $html;
        }
        
        include_once("./Services/UICore/exceptions/class.ilCtrlException.php");
        throw new ilCtrlException("ERROR: Can't forward to class $class.");
    }

References getCmd(), and getNodeIdForTargetClass().

Referenced by callBaseClass(), ilObjectPermissionStatusGUI\executeCommand(), ilLTIRouterGUI\executeCommand(), and ilChatroomInfoGUI\executeDefault().

Here is the call graph for this function:

Here is the caller graph for this function:

getCallHistory()

ilCtrl::getCallHistory

(

)

Get controller call history.

This is used for the developer mode and presented in the footer

Returns

array array of call history entries

Definition at line 523 of file class.ilCtrl.php.

    {
        return $this->call_hist;
    }

References $call_hist.

getCallStructure()

ilCtrl::getCallStructure

(

$a_class

)

Get call structure of class context.

This method must be called for the top level gui class in the leading php script. It must be called before the the current command is forwarded to the top level gui class. Example:

include_once "classes/class.ilRepositoryGUI.php"; $ilCtrl->getCallStructure("ilrepositorygui"); $repository_gui = new ilRepositoryGUI(); $ilCtrl->forwardCommand($repository_gui);

Parameters

string

$a_class

gui class name

@access public

Definition at line 543 of file class.ilCtrl.php.

    {
        $this->readClassInfo($a_class);
    }

References readClassInfo().

Referenced by callBaseClass(), and getNodeIdForTargetClass().

Here is the call graph for this function:

Here is the caller graph for this function:

getCidForClass()

ilCtrl::getCidForClass (   $a_class,   $a_check = false  )

private

Get class id for class after fetching and storing corresponding information, if necessary.

Definition at line 1665 of file class.ilCtrl.php.

    {
        if ($this->classCidUnknown($a_class)) {
            $this->readClassInfo($a_class);
        }
        if ($this->classCidUnknown($a_class)) {
            if ($a_check) {
                return false;
            }
            if (DEVMODE == 1) {
                $add = "<br><br>Please make sure your GUI class name ends with 'GUI' and that the filename is 'class.[YourClassName].php'. In exceptional cases you
                                        may solve the issue by putting an empty * @ilCtrl_Calls [YourClassName]: into your class header." .
                    " In both cases you need to reload the control structure in the setup.";
            }
            include_once("./Services/UICore/exceptions/class.ilCtrlException.php");
            throw new ilCtrlException("Cannot find cid for class " . $a_class . "." . $add);
        }
        return $this->class_cid[$a_class];
    }

References classCidUnknown(), and readClassInfo().

Referenced by checkTargetClass(), and getNodeIdForTargetClass().

Here is the call graph for this function:

Here is the caller graph for this function:

getCidOfNode()

ilCtrl::getCidOfNode (   $a_node )

private

Get last class id of node.

Definition at line 1803 of file class.ilCtrl.php.

    {
        $class_ids = explode(":", $a_node);
        return $class_ids[count($class_ids) - 1];
    }

Referenced by getNodeIdForTargetClass().

Here is the caller graph for this function:

getClassForCid()

ilCtrl::getClassForCid (   $a_cid )

private

Get class for class id after fetching and storing corresponding information, if necessary.

Definition at line 1694 of file class.ilCtrl.php.

    {
        if ($this->cidClassUnknown($a_cid)) {
            $this->readCidInfo($a_cid);
        }
        if ($this->cidClassUnknown($a_cid)) {
            include_once("./Services/UICore/exceptions/class.ilCtrlException.php");
            throw new ilCtrlException("Cannot find class for cid " . $a_cid . ".");
        }
        return $this->cid_class[$a_cid];
    }

References cidClassUnknown(), and readCidInfo().

Referenced by checkCurrentPathForClass(), getCurrentClassPath(), getNodeIdForTargetClass(), getParameterArrayByClass(), getReadableNode(), and searchReturnClass().

Here is the call graph for this function:

Here is the caller graph for this function:

getClassForClasspath()

ilCtrl::getClassForClasspath

(

$a_class_path

)

this method assumes that the class path has the format "dir/class.<class_name>.php"

Parameters

string

$a_class_path

class path @access public

Returns

string class name

Definition at line 828 of file class.ilCtrl.php.

    {
        $path = pathinfo($a_class_path);
        $file = $path["basename"];
        $class = substr($file, 6, strlen($file) - 10);
 
        return $class;
    }

getCmd()

ilCtrl::getCmd	(		$a_default_cmd = "",
			$a_safe_commands = ""
	)

Determines current get/post command.

Parameters

string	default command
array	safe commands: for these commands no token is checked for post requests

Definition at line 940 of file class.ilCtrl.php.

    {
        $cmd = "";
        if (isset($_GET["cmd"])) {
            $cmd = $_GET["cmd"];
        }
        if ($cmd == "post") {
            if (isset($_POST["cmd"]) && is_array($_POST["cmd"])) {
                reset($_POST["cmd"]);
            }
            $cmd = @key($_POST["cmd"]);
 
            // verify command
            if ($this->verified_cmd != "") {
                return $this->verified_cmd;
            } else {
                if (!$this->verifyToken() &&
                    (!is_array($a_safe_commands) || !in_array($cmd, $a_safe_commands))) {
                    return $a_default_cmd;
                }
            }
            
            $this->verified_cmd = $cmd;
            if ($cmd == "" && isset($_POST["table_top_cmd"])) {         // selected command in multi-list (table2)
                $cmd = @key($_POST["table_top_cmd"]);
                $this->verified_cmd = $cmd;
                $_POST[$_POST["cmd_sv"][$cmd]] = $_POST[$_POST["cmd_sv"][$cmd] . "_2"];
            }
            if ($cmd == "" && isset($_POST["select_cmd2"])) {           // selected command in multi-list (table2)
                if (isset($_POST["select_cmd_all2"])) {
                    $_POST["select_cmd_all"] = $_POST["select_cmd_all2"];
                } else {
                    $_POST["select_cmd_all"] = $_POST["select_cmd_all2"] = null;
                }
                $cmd = $_POST["selected_cmd2"];
                $this->verified_cmd = $cmd;
            }
            if ($cmd == "" && isset($_POST["select_cmd"])) {            // selected command in multi-list (table2)
                if (isset($_POST["select_cmd_all"])) {
                    $_POST["select_cmd_all2"] = $_POST["select_cmd_all"];
                } else {
                    $_POST["select_cmd_all"] = $_POST["select_cmd_all2"] = null;
                }
                $cmd = $_POST["selected_cmd"];
                $this->verified_cmd = $cmd;
            }
            if ($cmd == "") {
                $cmd = $_GET["fallbackCmd"];
                $this->verified_cmd = $cmd;
            }
        }
        if ($cmd == "") {
            $cmd = $a_default_cmd;
        }
        return $cmd;
    }

References $_GET, $_POST, and verifyToken().

Referenced by ilObjectPermissionStatusGUI\executeCommand(), ilObjWorkflowEngineGUI\executeCommand(), forwardCommand(), and getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

getCmdClass()

ilCtrl::getCmdClass

(

)

Determines class that should execute the current command.

Returns

string class name

Definition at line 1036 of file class.ilCtrl.php.

    {
        return strtolower($_GET["cmdClass"]);
    }

References $_GET.

getCmdNode()

ilCtrl::getCmdNode

(

)

Get command target node.

Returns

string id of current command target node

Definition at line 485 of file class.ilCtrl.php.

    {
        return $_GET["cmdNode"];
    }

References $_GET.

Referenced by checkCurrentPathForClass(), getCurrentClassPath(), and getNextClass().

Here is the caller graph for this function:

getContextObjId()

ilCtrl::getContextObjId

(

)

Get context object id.

Returns

int object id

Definition at line 311 of file class.ilCtrl.php.

    {
        return $this->context_obj_id;
    }

getContextObjType()

ilCtrl::getContextObjType

(

)

Get context object type.

Returns

string object type

Definition at line 321 of file class.ilCtrl.php.

    {
        return $this->context_obj_type;
    }

getContextSubObjId()

ilCtrl::getContextSubObjId

(

)

Get context subobject id.

Returns

int subobject id

Definition at line 331 of file class.ilCtrl.php.

    {
        return $this->context_sub_obj_id;
    }

getContextSubObjType()

ilCtrl::getContextSubObjType

(

)

Get context subobject type.

Returns

string subobject type

Definition at line 341 of file class.ilCtrl.php.

    {
        return $this->context_sub_obj_type;
    }

getCurrentCidOfNode()

ilCtrl::getCurrentCidOfNode (   $a_node )

private

Get cid of node.

Definition at line 1821 of file class.ilCtrl.php.

    {
        $n_arr = explode(":", $a_node);
        return $n_arr[count($n_arr) - 1];
    }

Referenced by getNextClass(), getNodeIdForTargetClass(), and getParameterArrayByClass().

Here is the caller graph for this function:

getCurrentClassPath()

ilCtrl::getCurrentClassPath

(

)

Get current class path as array of class file names.

Returns

array

Exceptions

ilCtrlException

Definition at line 1884 of file class.ilCtrl.php.

                                          : array
    {
        $path = [];
        foreach (explode(":", $this->getCmdNode()) as $cid) {
            if ($cid != "") {
                $path[] = $this->getClassForCid($cid);
            }
        }
        if ($this->getCmdNode() == "" && $_GET["baseClass"] != "") {
            $path[] = $_GET["baseClass"];
        }
        return $path;
    }

References $_GET, getClassForCid(), and getCmdNode().

Here is the call graph for this function:

getFormAction()

ilCtrl::getFormAction	(		$a_gui_obj,
			$a_fallback_cmd = "",
			$a_anchor = "",
			$a_asynch = false,
			$xml_style = false
	)

Get form action url for gui class object.

Parameters

object	gui object
string	fallback command
string	anchor
bool	asynchronous call
bool	xml style t/f

Returns

string script url

Definition at line 1051 of file class.ilCtrl.php.

      {
        $script = $this->getFormActionByClass(
            strtolower(get_class($a_gui_obj)),
            $a_fallback_cmd,
            $a_anchor,
            $a_asynch,
            $xml_style
        );
        return $script;
    }

References getFormActionByClass().

Referenced by ilTestSkillLevelThresholdsTableGUI\__construct(), ilObjectPermissionStatusGUI\accessStatusInfo(), ilObjectPermissionStatusGUI\addToolbar(), ilChatroomHistoryGUI\byDay(), ilChatroomHistoryGUI\bySession(), ilChatroomAdminViewGUI\clientsettings(), ilChatroomAdminSmileyGUI\deleteMultipleObject(), ilChatroomSettingsGUI\general(), ilChatroomAdminSmileyGUI\initSmiliesEditForm(), ilChatroomAdminSmileyGUI\initSmiliesForm(), ilHistoryTableGUI\initTable(), ilChatroomAdminSmileyGUI\showDeleteSmileyFormObject(), and ilChatroomViewGUI\showNameSelection().

Here is the call graph for this function:

Here is the caller graph for this function:

getFormActionByClass()

ilCtrl::getFormActionByClass	(		$a_class,
			$a_fallback_cmd = "",
			$a_anchor = "",
			$a_asynch = false,
			$xml_style = false
	)

Get form action url for gui class name.

Parameters

string	gui class name
string	fallback command
string	anchor
bool	asynchronous call
bool	xml style t/f

Returns

string script url

Definition at line 1078 of file class.ilCtrl.php.

      {
        if (!is_array($a_class)) {
            $a_class = strtolower($a_class);
        }
        
        $tok = $this->getRequestToken();
 
        if ($a_asynch) {
            $xml_style = false;
        }
 
        $script = $this->getLinkTargetByClass($a_class, "post", "", $a_asynch, $xml_style);
        if ($a_fallback_cmd != "") {
            $script = ilUtil::appendUrlParameterString($script, "fallbackCmd=" . $a_fallback_cmd, $xml_style);
        }
        $script = ilUtil::appendUrlParameterString(
            $script,
            self::IL_RTOKEN_NAME . '=' . $this->getRequestToken(),
            $xml_style
        );
        if ($a_anchor != "") {
            $script = $script . "#" . $a_anchor;
        }
 
        return $script;
    }

References ilUtil\appendUrlParameterString(), getLinkTargetByClass(), and getRequestToken().

Referenced by getFormAction().

Here is the call graph for this function:

Here is the caller graph for this function:

getHTML()

ilCtrl::getHTML	(		$a_gui_object,
		array	$a_parameters = null,
		array	$class_path = []
	)

Gets an HTML output from another GUI class and returns the flow of control to the calling class.

Parameters

object	$a_gui_object	GUI class that implements getHTML() method to return its HTML
array | null	$a_parameters	parameter array

Returns

string

Exceptions

ilCtrlException

Definition at line 238 of file class.ilCtrl.php.

    {
        $class = strtolower(get_class($a_gui_object));
 
        if (count($class_path) > 0) {
            $class_path = array_merge($class_path, [$class]);
            $p = $this->getParameterArrayByClass($class_path);
            $nr = $p["cmdNode"];
            $baseclass = $p["baseClass"];
            $this->inner_base_class = $p["cmdNode"];
        } else {
            $nr = $this->getNodeIdForTargetClass($this->current_node, $class);
            $nr = $nr["node_id"];
        }
        if ($nr != "") {
            $current_inner_base_class = $this->inner_base_class;
            $this->use_current_to_determine_next = true;
 
            if ($baseclass != $_GET["baseClass"]) {
                $this->inner_base_class = $baseclass;
            }
            $current_node = $this->current_node;
            
            // set current node to new gui class
            $this->current_node = $nr;
            
            // always populate the call history
            // it will only be displayed in DEVMODE but is needed for UI plugins, too
            $this->call_hist[] = array("class" => get_class($a_gui_object),
                    "mode" => "getHtml", "cmd" => $this->getCmd());
            
            // get block
            if ($a_parameters != null) {
                $html = $a_gui_object->getHTML($a_parameters);
            } else {
                $html = $a_gui_object->getHTML();
            }
            
            // reset current node
            $this->current_node = $current_node;
            $this->inner_base_class = $current_inner_base_class;
            $this->use_current_to_determine_next = false;
            
            // return block
            return $html;
        }
 
        include_once("./Services/UICore/exceptions/class.ilCtrlException.php");
        throw new ilCtrlException("ERROR: Can't getHTML from class $class.");
    }

References $_GET, $inner_base_class, getCmd(), getNodeIdForTargetClass(), and getParameterArrayByClass().

Here is the call graph for this function:

getLinkTarget()

ilCtrl::getLinkTarget	(		$a_gui_obj,
			$a_cmd = "",
			$a_anchor = "",
			$a_asynch = false,
			$xml_style = false
	)

Get link target for command using gui object.

Parameters

object	gui object (usually $this)
string	command
string	# anchor
boolean	asynchronous mode
boolean	xml style t/f

Returns

string target link

Definition at line 1378 of file class.ilCtrl.php.

      {
        $script = $this->getLinkTargetByClass(
            strtolower(get_class($a_gui_obj)),
            $a_cmd,
            $a_anchor,
            $a_asynch,
            $xml_style
        );
        return $script;
    }

References getLinkTargetByClass().

Referenced by ilObjWorkflowEngineGUI\initLocator(), and ilChatroomViewGUI\showRoom().

Here is the call graph for this function:

Here is the caller graph for this function:

getLinkTargetByClass()

ilCtrl::getLinkTargetByClass	(		$a_class,
			$a_cmd = "",
			$a_anchor = "",
			$a_asynch = false,
			$xml_style = false
	)

Get link target for command using gui class name.

Parameters

string/array	command target class
string	command
string	# anchor
boolean	asynchronous mode
boolean	xml style t/f

Returns

string target link

Definition at line 1407 of file class.ilCtrl.php.

      {
        if ($a_asynch) {
            $xml_style = false;
        }
        
        $script = $this->getTargetScript();
        $script = $this->getUrlParameters($a_class, $script, $a_cmd, $xml_style);
 
        if ($a_asynch) {
            $amp = "&";
            $script .= $amp . "cmdMode=asynch";
        }
        
        if ($a_anchor != "") {
            $script = $script . "#" . $a_anchor;
        }
 
        return $script;
    }

References getTargetScript(), and getUrlParameters().

Referenced by ilObjectPermissionStatusGUI\addToolbar(), ilHistoryTableGUI\fillRow(), ilObjStudyProgrammeReferenceListGUI\getCommandLink(), getFormActionByClass(), getLinkTarget(), redirect(), redirectByClass(), and ilChatroomViewGUI\showRoom().

Here is the call graph for this function:

Here is the caller graph for this function:

getModuleDir()

ilCtrl::getModuleDir

(

)

get directory of current module

Deprecated:

Returns

mixed

Exceptions

Exception

Definition at line 187 of file class.ilCtrl.php.

    {
        throw new Exception("ilCtrl::getModuleDir is deprecated.");
        //return $this->module_dir;
    }

getNextClass()

ilCtrl::getNextClass

(

$a_gui_class = null

)

Get next class in the control path from the current class to the target command class.

This is the class that should be instantiated and be invoked via $ilCtrl->forwardCommand($class) next.

Returns

string class name of next class

Definition at line 775 of file class.ilCtrl.php.

    {
        if ($this->use_current_to_determine_next) {
            $cmdNode = $this->current_node;
        } else {
            $cmdNode = $this->getCmdNode();
        }
 
        if ($cmdNode == "") {
            return ($class = $this->checkLPSettingsForward($a_gui_class, $cmdNode))
                ? $class
                : false;
        } else {
            if ($this->current_node == $cmdNode) {
                return ($class = $this->checkLPSettingsForward($a_gui_class, $cmdNode))
                    ? $class
                    : "";
            } else {
                $path = $this->getPathNew($this->current_node, $cmdNode);
                $this->readCidInfo($this->getCurrentCidOfNode($path[1]));
                return $this->cid_class[$this->getCurrentCidOfNode($path[1])];
            }
        }
    }

References checkLPSettingsForward(), getCmdNode(), getCurrentCidOfNode(), getPathNew(), and readCidInfo().

Referenced by ilTestSignatureGUI\executeCommand(), ilObjectPermissionStatusGUI\executeCommand(), ilLTIRouterGUI\executeCommand(), and ilObjWorkflowEngineGUI\executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

getNodeIdForTargetClass()

ilCtrl::getNodeIdForTargetClass (   $a_par_node,   $a_class,   $a_check = false  )

private

Searches a node for a given class ($a_class) "near" another node ($a_par_node).

It first looks if the given class is a child class of the current node. If such a child node has been found, its id is returned.

If not, this method determines, whether the given class is a sibling of the current node within the call structure. If this is the case, then the corresponding id is returned.

At last the method searches for the given class along the path from the current node to the root class of the call structure.

Parameters

string	$a_par_node	id of starting node for the search
string	$a_class	class that should be searched
bool	$a_check

Returns

array|bool id of target node that has been found

Exceptions

ilCtrlException

Definition at line 366 of file class.ilCtrl.php.

    {
        $class = strtolower($a_class);
        $this->readClassInfo($class);
        
        if ($a_par_node === 0 || $a_par_node == "") {
            return array("node_id" => $this->getCidForClass($class),
                "base_class" => $class);
        }
        
        $this->readNodeInfo($a_par_node);
        
        $node_cid = $this->getCurrentCidOfNode($a_par_node);
 
        // target class is class of current node id
        if ($class == $this->getClassForCid($node_cid)) {
            return array("node_id" => $a_par_node,
                "base_class" => "");
        }
 
        // target class is child of current node id
        if (isset($this->calls[$this->getClassForCid($node_cid)]) &&
            is_array($this->calls[$this->getClassForCid($node_cid)]) &&
            in_array($a_class, $this->calls[$this->getClassForCid($node_cid)])) {
            return array("node_id" => $a_par_node . ":" . $this->getCidForClass($class),
                "base_class" => "");
        }
 
        // target class is sibling
        $par_cid = $this->getParentCidOfNode($a_par_node);
        if ($par_cid != "") {
            if (is_array($this->calls[$this->getClassForCid($par_cid)]) &&
                in_array($a_class, $this->calls[$this->getClassForCid($par_cid)])) {
                return array("node_id" =>
                    $this->removeLastCid($a_par_node) . ":" . $this->getCidForClass($class),
                    "base_class" => "");
            }
        }
 
        // target class is parent
        $temp_node = $this->removeLastCid($a_par_node);
        while ($temp_node != "") {
            $temp_cid = $this->getCurrentCidOfNode($temp_node);
            if ($this->getClassForCid($temp_cid) == $a_class) {
                return array("node_id" => $temp_node,
                    "base_class" => "");
            }
            $temp_node = $this->removeLastCid($temp_node);
        }
        
        // target class is another base class
        $n_class = "";
        if ($a_class != "") {
            $module_class = ilCachedCtrl::getInstance();
            $mc_rec = $module_class->lookupModuleClass($class);
            $n_class = $mc_rec['lower_class'];
 
            if ($n_class == "") {
                $mc_rec = $module_class->lookupServiceClass($class);
                $n_class = $mc_rec['lower_class'];
            }
            
            if ($n_class != "") {
                $this->getCallStructure($n_class);
                return array("node_id" => $this->getCidForClass($n_class),
                    "base_class" => $class);
            }
        }
 
        if ($a_check) {
            return false;
        }
        
        // Please do NOT change these lines.
        // Developers must be aware, if they use classes unknown to the controller
        // otherwise certain problem will be extremely hard to track down...
 
        error_log("ERROR: Can't find target class $a_class for node $a_par_node " .
            "(" . $this->cid_class[$this->getCidOfNode($a_par_node)] . ")");
            
        include_once("./Services/UICore/exceptions/class.ilCtrlException.php");
        throw new ilCtrlException("ERROR: Can't find target class $a_class for node $a_par_node " .
            "(" . $this->cid_class[$this->getCidOfNode($a_par_node)] . ").");
    }

References getCallStructure(), getCidForClass(), getCidOfNode(), getClassForCid(), getCurrentCidOfNode(), ilCachedCtrl\getInstance(), getParentCidOfNode(), readClassInfo(), readNodeInfo(), and removeLastCid().

Referenced by checkLPSettingsForward(), checkTargetClass(), forwardCommand(), getHTML(), getParameterArrayByClass(), searchReturnClass(), and setCmdClass().

Here is the call graph for this function:

Here is the caller graph for this function:

getParameterArray()

ilCtrl::getParameterArray	(		$a_gui_obj,
			$a_cmd = ""
	)

Get all set/save parameters for a gui object.

Definition at line 1576 of file class.ilCtrl.php.

    {
        $par_arr = $this->getParameterArrayByClass(strtolower(get_class($a_gui_obj)), $a_cmd);
 
        return $par_arr;
    }

References getParameterArrayByClass().

Here is the call graph for this function:

getParameterArrayByClass()

ilCtrl::getParameterArrayByClass	(		$a_class,
			$a_cmd = ""
	)

Get all set/save parameters using gui class name.

Parameters

string	class name
string	cmd $

Returns

array parameter array

Definition at line 1590 of file class.ilCtrl.php.

    {
        if ($a_class == "") {
            return array();
        }
 
        $current_base_class = $_GET["baseClass"];
        if ($this->use_current_to_determine_next && $this->inner_base_class != "") {
            $current_base_class = $this->inner_base_class;
        }
 
        if (!is_array($a_class)) {
            $a_class = array($a_class);
        }
 
        $nr = $this->current_node;
        $new_baseclass = "";
        foreach ($a_class as $class) {
            $class = strtolower($class);
            $nr = $this->getNodeIdForTargetClass($nr, $class);
            if ($nr["base_class"] != "") {
                $new_baseclass = $nr["base_class"];
            }
            $nr = $nr["node_id"];
            $target_class = $class;
        }
 
        $path = $this->getPathNew(1, $nr);
        $params = array();
 
        // append parameters of parent classes
        foreach ($path as $node_id) {
            $class = ($node_id == "")
                ? strtolower($current_base_class)
                : $this->getClassForCid($this->getCurrentCidOfNode($node_id));
            if (isset($this->save_parameter[$class]) && is_array($this->save_parameter[$class])) {
                foreach ($this->save_parameter[$class] as $par) {
                    if (isset($_GET[$par])) {
                        $params[$par] = $_GET[$par];
                    } elseif (isset($_POST[$par])) {
                        $params[$par] = ilUtil::stripSlashesRecursive($_POST[$par]);
                    }
                }
            }
 
            if (isset($this->parameter[$class]) && is_array($this->parameter[$class])) {
                foreach ($this->parameter[$class] as $par => $value) {
                    $params[$par] = $value;
                }
            }
        }
 
        if ($a_cmd != "") {
            $params["cmd"] = $a_cmd;
        }
 
        $params["cmdClass"] = $target_class;
        $params["cmdNode"] = $nr;
        if ($new_baseclass == "") {
            $params["baseClass"] = $current_base_class;
        } else {
            $params["baseClass"] = $new_baseclass;
        }
 
        return $params;
    }

References $_GET, $_POST, $inner_base_class, getClassForCid(), getCurrentCidOfNode(), getNodeIdForTargetClass(), getPathNew(), and ilUtil\stripSlashesRecursive().

Referenced by getHTML(), getParameterArray(), and getUrlParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

getParentCidOfNode()

ilCtrl::getParentCidOfNode (   $a_node )

private

Get 2nd to last class id of node.

Definition at line 1794 of file class.ilCtrl.php.

    {
        $class_ids = explode(":", $a_node);
        return $class_ids[count($class_ids) - 2];
    }

Referenced by getNodeIdForTargetClass().

Here is the caller graph for this function:

getParentReturn()

ilCtrl::getParentReturn

(

$a_gui_obj

)

Get return script url.

Used in conjunction with ilTabs->setBackTarget and ilBlockGUI->addHeaderCommand.

Definition at line 1484 of file class.ilCtrl.php.

    {
        return $this->getParentReturnByClass(strtolower(get_class($a_gui_obj)));
    }

References getParentReturnByClass().

Referenced by returnToParent().

Here is the call graph for this function:

Here is the caller graph for this function:

getParentReturnByClass()

ilCtrl::getParentReturnByClass

(

$a_class

)

Get return script url.

Only used in getParentReturn.

Definition at line 1495 of file class.ilCtrl.php.

    {
        $a_class = strtolower($a_class);
        $ret_class = $this->searchReturnClass($a_class);
        if ($ret_class) {
            return $this->return[$ret_class];
        }
    }

References searchReturnClass().

Referenced by getParentReturn().

Here is the call graph for this function:

Here is the caller graph for this function:

getPathNew()

ilCtrl::getPathNew (   $a_source_node,   $a_target_node  )

private

Get path in call structure.

Parameters

string	$a_source_node	source node id
string	$a_source_node	target node id

Definition at line 843 of file class.ilCtrl.php.

    {
        if ($a_source_node == "1") {
            $a_source_node = "";
        }
        if (substr($a_target_node, 0, strlen($a_source_node)) != $a_source_node) {
            $failure = "ERROR: Path not found. Source:" . $a_source_node .
                ", Target:" . $a_target_node;
            if (DEVMODE == 1) {
                include_once("./Services/UICore/exceptions/class.ilCtrlException.php");
                throw new ilCtrlException($failure);
            }
            $GLOBALS['ilLog']->write(__METHOD__ . ' ' . $failure);
            $this->redirectToURL('./ilias.php?baseClass=ilRepositoryGUI');
        }
        $temp_node = $a_source_node;
        
        $path = array();
        if ($a_source_node != "") {
            $path = array($a_source_node);
        }
        
        $diffstart = ($a_source_node == "")
            ? 0
            : strlen($a_source_node) + 1;
        $diff = substr($a_target_node, $diffstart);
        $diff_arr = explode(":", $diff);
        foreach ($diff_arr as $cid) {
            if ($temp_node != "") {
                $temp_node .= ":";
            }
            $temp_node .= $cid;
            $path[] = $temp_node;
        }
        return $path;
    }

References $failure, $GLOBALS, and redirectToURL().

Referenced by getNextClass(), and getParameterArrayByClass().

Here is the call graph for this function:

Here is the caller graph for this function:

getReadableNode()

ilCtrl::getReadableNode (   $node )

protected

Get readable node.

Parameters

return

Definition at line 895 of file class.ilCtrl.php.

    {
        return implode(
            ":",
            array_map(function ($cid) {
                return $this->getClassForCid($cid);
            }, explode(":", $node))
        );
    }

References getClassForCid().

Here is the call graph for this function:

getRedirectSource()

ilCtrl::getRedirectSource

(

)

Get current redirect source.

Returns

string redirect source class

Definition at line 1547 of file class.ilCtrl.php.

    {
        return $_GET["redirectSource"];
    }

References $_GET.

getRequestToken()

ilCtrl::getRequestToken

(

)

Get request token.

Returns

string request token for user and session

Definition at line 1131 of file class.ilCtrl.php.

    {
        global $DIC;
 
        $ilUser = $DIC["ilUser"];
        $ilDB = $DIC->database();
 
        
        if ($this->rtoken != "") {
            return $this->rtoken;
        } else {
            if (is_object($ilDB) && is_object($ilUser) && $ilUser->getId() > 0 &&
                $ilUser->getId() != ANONYMOUS_USER_ID) {
                $res = $ilDB->query("SELECT token FROM il_request_token WHERE user_id = " .
                    $ilDB->quote($ilUser->getId(), "integer") .
                    " AND session_id = " . $ilDB->quote(session_id(), "text"));
                $rec = $ilDB->fetchAssoc($res);
                if ($rec["token"] != "") {
                    $this->rtoken = $rec["token"];
                    return $rec["token"];
                }
                //echo "new rtoken, new entry for :".$ilUser->getId().":".session_id().":"; exit;
                $random = new \ilRandom();
                $this->rtoken = md5(uniqid($random->int(), true));
                
                // delete entries older than one and a half days
                if ($random->int(1, 200) == 2) {
                    $dt = new ilDateTime(time(), IL_CAL_UNIX);
                    $dt->increment(IL_CAL_DAY, -1);
                    $dt->increment(IL_CAL_HOUR, -12);
                    $dq = "DELETE FROM il_request_token WHERE " .
                        " stamp < " . $ilDB->quote($dt->get(IL_CAL_DATETIME), "timestamp");
                    $ilDB->manipulate($dq);
                }
                
                // IMPORTANT: Please do NOT try to move this implementation to a
                // session basis. This will fail due to framesets that are used
                // occasionally in ILIAS, e.g. in the chat, where multiple
                // forms are loaded in different frames.
                $ilDB->manipulate("INSERT INTO il_request_token (user_id, token, stamp, session_id) VALUES " .
                    "(" .
                    $ilDB->quote($ilUser->getId(), "integer") . "," .
                    $ilDB->quote($this->rtoken, "text") . "," .
                    $ilDB->now() . "," .
                    $ilDB->quote(session_id(), "text") . ")");
                return $this->rtoken;
            }
        }
        return "";
    }

References $DIC, $ilDB, $ilUser, $res, $rtoken, ANONYMOUS_USER_ID, IL_CAL_DATETIME, IL_CAL_DAY, IL_CAL_HOUR, and IL_CAL_UNIX.

Referenced by appendRequestTokenParameterString(), and getFormActionByClass().

Here is the caller graph for this function:

getReturnClass()

ilCtrl::getReturnClass

(

$a_class

)

Get return class.

Only used in COPage/ilPCParagraphGUI and COPage/ilPCPlaceHolderGUI

Parameters

string | object

$class

Returns

string|bool

Definition at line 1512 of file class.ilCtrl.php.

    {
        if (is_object($a_class)) {
            $class = strtolower(get_class($a_class));
        } else {
            $class = strtolower($a_class);
        }
        return $this->searchReturnClass($class);
    }

References searchReturnClass().

Here is the call graph for this function:

getTabs()

ilCtrl::getTabs

(

)

Get tabs array (.

Deprecated:

, use $ilTabs)

Returns

array array of tab entries (array("lang_var", "link", "cmd", "class))

Definition at line 511 of file class.ilCtrl.php.

    {
        return $this->tab;
    }

getTargetScript()

ilCtrl::getTargetScript

(

)

Get target script name.

Returns

string target script name

Definition at line 910 of file class.ilCtrl.php.

                                      : string
    {
        return $this->target_script;
    }

References $target_script.

Referenced by getLinkTargetByClass(), setReturn(), and setReturnByClass().

Here is the caller graph for this function:

getUrlParameters()

ilCtrl::getUrlParameters	(		$a_class,
			$a_str,
			$a_cmd = "",
			$xml_style = false
	)

Get URL parameters for a class and append them to a string.

Parameters

	$a_class
	$a_str
string	$a_cmd	command
bool	$xml_style

Returns

string

Definition at line 1560 of file class.ilCtrl.php.

    {
        $params = $this->getParameterArrayByClass($a_class, $a_cmd);
 
        foreach ($params as $par => $value) {
            if (strlen((string) $value)) {
                $a_str = ilUtil::appendUrlParameterString($a_str, $par . "=" . $value, $xml_style);
            }
        }
 
        return $a_str;
    }

References ilUtil\appendUrlParameterString(), and getParameterArrayByClass().

Referenced by getLinkTargetByClass(), setReturn(), and setReturnByClass().

Here is the call graph for this function:

Here is the caller graph for this function:

initBaseClass()

ilCtrl::initBaseClass

(

$a_base_class

)

Initialises new base class.

Note: this resets the whole current ilCtrl context completely. You can call callBaseClass() after that.

Parameters

string

base class name

Definition at line 924 of file class.ilCtrl.php.

    {
        $_GET["baseClass"] = $a_base_class;
        $_GET["cmd"] = "";
        $_GET["cmdClass"] = "";
        $_GET["cmdNode"] = "";
        $this->initializeMemberVariables();
    }

References $_GET, and initializeMemberVariables().

Here is the call graph for this function:

initializeMemberVariables()

ilCtrl::initializeMemberVariables ( )

protected

Initialize member variables.

This is used in __construct and initBaseClass.

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

    {
        $this->save_parameter = array();
        $this->parameter = array();                     // save parameter array
        $this->return = array();                        // return commmands
        $this->tab = array();
        $this->current_node = 0;
        $this->call_node = array();
        $this->root_class = "";
    }

Referenced by __construct(), and initBaseClass().

Here is the caller graph for this function:

insertCtrlCalls()

ilCtrl::insertCtrlCalls	(		$a_parent,
			$a_child,
			$a_comp_prefix
	)

Insert ctrl calls record.

Parameters

return

Definition at line 1833 of file class.ilCtrl.php.

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        ;
 
        $a_parent = strtolower($a_parent);
        $a_child = strtolower($a_child);
        $a_comp_prefix = strtolower($a_comp_prefix);
 
        $set = $ilDB->query(
            "SELECT * FROM ctrl_calls WHERE " .
            " parent = " . $ilDB->quote($a_parent, "text") . " AND " .
            " child = " . $ilDB->quote($a_child, "text") . " AND " .
            " comp_prefix = " . $ilDB->quote($a_comp_prefix, "text")
        );
        if ($rec = $ilDB->fetchAssoc($set)) {
            return;
        }
        $ilDB->manipulate("INSERT IGNORE INTO ctrl_calls " .
            "(parent, child, comp_prefix) VALUES (" .
            $ilDB->quote($a_parent, "text") . "," .
            $ilDB->quote($a_child, "text") . "," .
            $ilDB->quote($a_comp_prefix, "text") .
            ")");
    }

References $DIC, and $ilDB.

isAsynch()

ilCtrl::isAsynch

(

)

Is current command an asynchronous command?

Returns

boolean asynchronous t/f

Definition at line 1357 of file class.ilCtrl.php.

    {
        if (isset($_GET["cmdMode"]) && $_GET["cmdMode"] == "asynch") {
            return true;
        } else {
            return false;
        }
    }

References $_GET.

lookupClassPath()

ilCtrl::lookupClassPath

(

$a_class_name

)

Get class path that can be used in include statements for a given class name.

Parameters

string

$a_class_name

class name

Definition at line 806 of file class.ilCtrl.php.

    {
        $a_class_name = strtolower($a_class_name);
 
        $cached_ctrl = ilCachedCtrl::getInstance();
        $class_rec = $cached_ctrl->lookupClassFile($a_class_name);
 
        if ($class_rec["plugin_path"] != "") {
            return $class_rec["plugin_path"] . "/" . $class_rec["filename"];
        } else {
            return $class_rec["filename"];
        }
    }

References ilCachedCtrl\getInstance().

Referenced by ilLTIRouterGUI\executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

readCallStructure()

ilCtrl::readCallStructure	(		$a_class,
			$a_nr = 0,
			$a_parent = 0
	)

Reads call structure from db.

Definition at line 551 of file class.ilCtrl.php.

    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $a_class = strtolower($a_class);
 
        $a_nr++;
        
        // determine call node structure
        $this->call_node[$a_nr] = array("class" => $a_class, "parent" => $a_parent);
 
        $call_set = $ilDB->query("SELECT * FROM ctrl_calls WHERE parent = " .
            $ilDB->quote(strtolower($a_class), "text") .
            " ORDER BY child", array("text"));
        $a_parent = $a_nr;
        while ($call_rec = $ilDB->fetchAssoc($call_set)) {
            $a_nr = $this->readCallStructure($call_rec["child"], $a_nr, $a_parent);
            $forw[] = $call_rec["child"];
        }
 
        // determine root class
        $this->root_class = $a_class;
        return $a_nr;
    }

References $DIC, $ilDB, and readCallStructure().

Referenced by readCallStructure().

Here is the call graph for this function:

Here is the caller graph for this function:

readCidInfo()

ilCtrl::readCidInfo (   $a_cid )

private

Save class respective to $a_cid and store corresponding class calls for future reference.

Parameters

object

$a_cid

cid

Definition at line 1721 of file class.ilCtrl.php.

    {
        if (isset($this->info_read_cid[$a_cid])) {
            return;
        }
 
        $cached_ctrl = ilCachedCtrl::getInstance();
        $cid_info = $cached_ctrl->lookupCid($a_cid);
 
        if ($cid_info) {
            $this->updateClassCidMap($cid_info['class'], $a_cid);
            $this->fetchCallsOfClassFromCache($cid_info['class'], $cached_ctrl);
            $this->info_read_class[$cid_info["class"]] = true;
        }
        
        $this->info_read_cid[$a_cid] = true;
    }

References fetchCallsOfClassFromCache(), ilCachedCtrl\getInstance(), and updateClassCidMap().

Referenced by getClassForCid(), getNextClass(), and readNodeInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

readClassInfo()

ilCtrl::readClassInfo (   $a_class )

private

Save class id respective to $a_class and store corresponding class calls for future reference.

Parameters

object

$a_class

class name

Definition at line 1759 of file class.ilCtrl.php.

    {
        $a_class = strtolower($a_class);
        if (isset($this->info_read_class[$a_class])) {
            return;
        }
 
        $cached_ctrl = ilCachedCtrl::getInstance();
        $class_info = $cached_ctrl->lookupClassFile($a_class);
 
        if ($class_info) {
            $this->updateClassCidMap($a_class, $class_info['cid']);
        }
        $this->fetchCallsOfClassFromCache($a_class, $cached_ctrl);
        
        $this->info_read_class[$a_class] = true;
        $this->info_read_cid[$this->class_cid[$a_class]] = true;
    }

References fetchCallsOfClassFromCache(), ilCachedCtrl\getInstance(), and updateClassCidMap().

Referenced by getCallStructure(), getCidForClass(), and getNodeIdForTargetClass().

Here is the call graph for this function:

Here is the caller graph for this function:

readNodeInfo()

ilCtrl::readNodeInfo (   $a_node )

private

Save classes respective to the class id's of a node and store corresponding class calls for future reference.

Parameters

string

$a_node

Definition at line 1745 of file class.ilCtrl.php.

    {
        $class_ids = explode(":", $a_node);
        foreach ($class_ids as $cid) {
            $this->readCidInfo($cid);
        }
    }

References readCidInfo().

Referenced by getNodeIdForTargetClass().

Here is the call graph for this function:

Here is the caller graph for this function:

redirect()

ilCtrl::redirect	(		$a_gui_obj,
			$a_cmd = "",
			$a_anchor = "",
			$a_asynch = false
	)

Redirect to another command.

Parameters

object	gui object
string	command
string	anchor

Definition at line 1261 of file class.ilCtrl.php.

    {
        $script = $this->getLinkTargetByClass(
            strtolower(get_class($a_gui_obj)),
            $a_cmd,
            "",
            $a_asynch,
            false
        );
        if ($a_anchor != "") {
            $script = $script . "#" . $a_anchor;
        }
        $this->redirectToURL($script);
    }

References getLinkTargetByClass(), and redirectToURL().

Referenced by ilChatroomAdminSmileyGUI\confirmedDeleteMultipleObject(), ilChatroomBanGUI\delete(), ilChatroomAdminSmileyGUI\deleteMultipleObject(), ilChatroomAdminSmileyGUI\deleteSmileyObject(), ilChatroomAdminViewGUI\executeDefault(), ilChatroomViewGUI\executeDefault(), ilChatroomViewGUI\invitePD(), ilChatroomCreateGUI\save(), ilChatroomAdminViewGUI\saveClientSettings(), and ilChatroomSettingsGUI\saveGeneral().

Here is the call graph for this function:

Here is the caller graph for this function:

redirectByClass()

ilCtrl::redirectByClass	(		$a_class,
			$a_cmd = "",
			$a_anchor = "",
			$a_asynch = false
	)

Redirect to other gui class using class name.

Parameters

string	command target class
string	command

Definition at line 1343 of file class.ilCtrl.php.

    {
        $script = $this->getLinkTargetByClass($a_class, $a_cmd, "", $a_asynch, false);
        if ($a_anchor != "") {
            $script = $script . "#" . $a_anchor;
        }
        $this->redirectToURL($script);
    }

References getLinkTargetByClass(), and redirectToURL().

Referenced by checkLPSettingsForward(), ilChatroomSettingsGUI\general(), ilChatroomViewGUI\logout(), ilChatroomViewGUI\lostConnection(), ilChatroomGUIHandler\redirectIfNoPermission(), ilChatroomViewGUI\showRoom(), and ilChatroomKickGUI\sub().

Here is the call graph for this function:

Here is the caller graph for this function:

redirectToURL()

ilCtrl::redirectToURL

(

$a_script

)

Parameters

$a_script

Definition at line 1280 of file class.ilCtrl.php.

    {
        global $DIC;
 
        $ilPluginAdmin = null;
        if (isset($DIC["ilPluginAdmin"])) {
            $ilPluginAdmin = $DIC["ilPluginAdmin"];
        }
 
        if (!is_int(strpos($a_script, "://"))) {
            if (substr($a_script, 0, 1) != "/" && defined("ILIAS_HTTP_PATH")) {
                if (is_int(strpos($_SERVER["PHP_SELF"], "/setup/"))) {
                    $a_script = "setup/" . $a_script;
                }
                $a_script = ILIAS_HTTP_PATH . "/" . $a_script;
            }
        }
 
        // include the user interface hook
        if (is_object($ilPluginAdmin)) {
            $pl_names = $ilPluginAdmin->getActivePluginsForSlot(IL_COMP_SERVICE, "UIComponent", "uihk");
            foreach ($pl_names as $pl) {
                $ui_plugin = ilPluginAdmin::getPluginObject(IL_COMP_SERVICE, "UIComponent", "uihk", $pl);
                $gui_class = $ui_plugin->getUIClassInstance();
                $resp = $gui_class->getHTML("Services/Utilities", "redirect", array( "html" => $a_script ));
                if ($resp["mode"] != ilUIHookPluginGUI::KEEP) {
                    $a_script = $gui_class->modifyHTML($a_script, $resp);
                }
            }
        }
 
        // Manually trigger to write and close the session. This has the advantage that if an exception is thrown
        // during the writing of the session (ILIAS writes the session into the database by default) we get an exception
        // if the session_write_close() is triggered by exit() then the exception will be dismissed but the session
        // is never written, which is a nightmare to develop with.
        session_write_close();
 
        global $DIC;
        $http = $DIC->http();
        switch ($http->request()->getHeaderLine('Accept')) {
            case 'application/json':
                $stream = \ILIAS\Filesystem\Stream\Streams::ofString(json_encode([
                    'success' => true,
                    'message' => 'Called redirect after async fileupload request',
                    "redirect_url" => $a_script,
                ]));
                $http->saveResponse($http->response()->withBody($stream));
                break;
            default:
                $http->saveResponse($http->response()->withAddedHeader("Location", $a_script));
                break;
        }
        $http->sendResponse();
        exit;
    }

References $_SERVER, $DIC, $http, XapiProxy\$resp, exit, ilPluginAdmin\getPluginObject(), IL_COMP_SERVICE, ilUIHookPluginGUI\KEEP, and ILIAS\Filesystem\Stream\Streams\ofString().

Referenced by getPathNew(), redirect(), redirectByClass(), and returnToParent().

Here is the call graph for this function:

Here is the caller graph for this function:

removeLastCid()

ilCtrl::removeLastCid (   $a_node )

private

Remove the class id that comes at the beginning the sequence.

Definition at line 1812 of file class.ilCtrl.php.

    {
        $lpos = strrpos($a_node, ":");
        return substr($a_node, 0, $lpos);
    }

Referenced by getNodeIdForTargetClass().

Here is the caller graph for this function:

returnToParent()

ilCtrl::returnToParent	(		$a_gui_obj,
			$a_anchor = ""
	)

Redirects to next parent class that used setReturn.

Definition at line 1459 of file class.ilCtrl.php.

    {
        $script = $this->getParentReturn($a_gui_obj);
 
        $script = ilUtil::appendUrlParameterString(
            $script,
            "redirectSource=" . strtolower(get_class($a_gui_obj))
        );
        $script = ilUtil::appendUrlParameterString(
            $script,
            "cmdMode=" . $_GET["cmdMode"]
        );
        if ($a_anchor != "") {
            $script = $script . "#" . $a_anchor;
        }
 
        $this->redirectToURL($script);
    }

References $_GET, ilUtil\appendUrlParameterString(), getParentReturn(), and redirectToURL().

Here is the call graph for this function:

saveParameter()

ilCtrl::saveParameter	(		$a_obj,
			$a_parameter
	)

Set parameters that should be passed in every form and link of a gui class.

All links that relate to the specified gui object class and are build e.g. by using getLinkTarger() or getFormAction() will include this parameter. This is the mechanism to add url parameters to the standard url target everytime.

A typical example is the "ref_id" that should be included in almost every link or form action url. So the constructor of ilRepositoryGUI includes the command:

$this->ctrl->saveParameter($this, array("ref_id"));

Parameters

object	$a_obj	gui object that will process the parameter
mixed	$a_parameter	parameter name (string) or array of parameter names

@access public

Definition at line 597 of file class.ilCtrl.php.

    {
        if (is_object($a_obj)) {
            $this->saveParameterByClass(get_class($a_obj), $a_parameter);
        }
    }

References saveParameterByClass().

Referenced by ilChatroomAdminSmileyGUI\initSmiliesEditForm(), and ilChatroomViewGUI\showNameSelection().

Here is the call graph for this function:

Here is the caller graph for this function:

saveParameterByClass()

ilCtrl::saveParameterByClass	(		$a_class,
			$a_parameter
	)

Save parameter for a class.

Parameters

string	class name
string	parameter name

Definition at line 610 of file class.ilCtrl.php.

    {
        if (is_array($a_parameter)) {
            foreach ($a_parameter as $parameter) {
                $this->save_parameter[strtolower($a_class)][] = $parameter;
            }
        } else {
            $this->save_parameter[strtolower($a_class)][] = $a_parameter;
        }
    }

References $parameter.

Referenced by saveParameter().

Here is the caller graph for this function:

searchReturnClass()

ilCtrl::searchReturnClass (   $a_class )

private

Determine current return class.

Definition at line 1526 of file class.ilCtrl.php.

    {
        $a_class = strtolower($a_class);
 
        $node = $this->getNodeIdForTargetClass($this->current_node, $a_class);
        $node = $node["node_id"];
        $n_arr = explode(":", $node);
        for ($i = count($n_arr) - 2; $i >= 0; $i--) {
            if ($this->return[$this->getClassForCid($n_arr[$i])] != "") {
                return $this->getClassForCid($n_arr[$i]);
            }
        }
 
        return false;
    }

References $i, getClassForCid(), and getNodeIdForTargetClass().

Referenced by getParentReturnByClass(), and getReturnClass().

Here is the call graph for this function:

Here is the caller graph for this function:

setCmd()

ilCtrl::setCmd

(

$a_cmd

)

Set the current command.

IMPORTANT NOTE:

please use this function only in exceptional cases it is not intended for setting commands in forms or links! use the corresponding parameters of getFormAction() and getLinkTarget() instead.

Definition at line 1007 of file class.ilCtrl.php.

    {
        $_GET["cmd"] = $a_cmd;
    }

References $_GET.

Referenced by ilChatroomInfoGUI\executeDefault().

Here is the caller graph for this function:

setCmdClass()

ilCtrl::setCmdClass

(

$a_cmd_class

)

Set the current command class.

IMPORTANT NOTE:

please use this function only in exceptional cases it is not intended for setting the command class in forms or links! use the corresponding parameters of getFormAction() and getLinkTarget() instead.

Definition at line 1022 of file class.ilCtrl.php.

    {
        $a_cmd_class = strtolower($a_cmd_class);
        $nr = $this->getNodeIdForTargetClass($this->current_node, $a_cmd_class);
        $nr = $nr["node_id"];
        $_GET["cmdClass"] = $a_cmd_class;
        $_GET["cmdNode"] = $nr;
    }

References $_GET, and getNodeIdForTargetClass().

Here is the call graph for this function:

setContext()

ilCtrl::setContext	(		$a_obj_id,
			$a_obj_type,
			$a_sub_obj_id = 0,
			$a_sub_obj_type = ""
	)

Set context of current user interface.

A context is a ILIAS repository object (obj ID + obj type) with an additional optional subobject (ID + Type)

Parameters

integer	object ID
string	object type
integer	subobject ID
string	subobject type

Definition at line 298 of file class.ilCtrl.php.

    {
        $this->context_obj_id = $a_obj_id;
        $this->context_obj_type = $a_obj_type;
        $this->context_sub_obj_id = $a_sub_obj_id;
        $this->context_sub_obj_type = $a_sub_obj_type;
    }

setParameter()

ilCtrl::setParameter	(		$a_obj,
			$a_parameter,
			$a_value
	)

Set parameters that should be passed a form and link of a gui class.

All links that relate to the specified gui object class and are build e.g. by using getLinkTarger() or getFormAction() will include this parameter. This is the mechanism to add url parameters to the standard url target. The difference to the saveParameter() method is, that setParameter() does not simply forward the url parameter of the last request. You can set a spefific value.

If this parameter is also a "saved parameter" (set by saveParameter() method) the saved value will be overwritten.

The method is usually used in conjunction with a getFormAction() or getLinkTarget() call. E.g.:

    $this->ctrl->setParameter($this, "obj_id", $data_row["obj_id"]);
    $obj_link = $this->ctrl->getLinkTarget($this, "view");

Parameters

object	$a_obj	gui object
string	$a_parameter	parameter name
string	$a_parameter	parameter value

Definition at line 644 of file class.ilCtrl.php.

    {
        $this->parameter[strtolower(get_class($a_obj))][$a_parameter] = $a_value;
    }

Referenced by ilObjWorkflowEngineGUI\initLocator(), ilChatroomViewGUI\invitePD(), and ilChatroomCreateGUI\save().

Here is the caller graph for this function:

setParameterByClass()

ilCtrl::setParameterByClass	(		$a_class,
			$a_parameter,
			$a_value
	)

Same as setParameterByClass, except that a class name is passed.

Parameters

string	$a_class	gui class name
string	$a_parameter	parameter name
string	$a_parameter	parameter value

Definition at line 657 of file class.ilCtrl.php.

    {
        $this->parameter[strtolower($a_class)][$a_parameter] = $a_value;
    }

Referenced by checkLPSettingsForward(), ilHistoryTableGUI\fillRow(), ilChatroomSettingsGUI\general(), ilObjStudyProgrammeReferenceListGUI\getCommandLink(), ilChatroomViewGUI\logout(), ilChatroomGUIHandler\redirectIfNoPermission(), and ilChatroomKickGUI\sub().

Here is the caller graph for this function:

setReturn()

ilCtrl::setReturn	(		$a_gui_obj,
			$a_cmd
	)

Set return command.

Definition at line 1436 of file class.ilCtrl.php.

    {
        $script = $this->getTargetScript();
        $script = $this->getUrlParameters(strtolower(get_class($a_gui_obj)), $script, $a_cmd);
        $this->return[strtolower(get_class($a_gui_obj))] = $script;
    }

References getTargetScript(), and getUrlParameters().

Referenced by ilObjectPermissionStatusGUI\executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

setReturnByClass()

ilCtrl::setReturnByClass	(		$a_class,
			$a_cmd
	)

Set return command.

Definition at line 1446 of file class.ilCtrl.php.

    {
        // may not be an array!
        $a_class = strtolower($a_class);
 
        $script = $this->getTargetScript();
        $script = $this->getUrlParameters($a_class, $script, $a_cmd);
        $this->return[strtolower($a_class)] = $script;
    }

References getTargetScript(), and getUrlParameters().

Here is the call graph for this function:

setTargetScript()

ilCtrl::setTargetScript

(

string

$a_target_script

)

set target script name

Parameters

string

$a_target_script

target script name

Definition at line 885 of file class.ilCtrl.php.

    {
        $this->target_script = $a_target_script;
    }

updateClassCidMap()

ilCtrl::updateClassCidMap (   $a_class,   $a_cid  )

private

Definition at line 1785 of file class.ilCtrl.php.

    {
        $this->cid_class[$a_cid] = $a_class;
        $this->class_cid[$a_class] = $a_cid;
    }

Referenced by readCidInfo(), and readClassInfo().

Here is the caller graph for this function:

verifyToken()

ilCtrl::verifyToken ( )

private

Verify Token.

Returns

boolean valid t/f

Definition at line 1187 of file class.ilCtrl.php.

    {
        global $DIC;
 
        $ilUser = $DIC["ilUser"];
 
        $ilDB = $DIC->database();
        ;
 
        if (is_object($ilUser) && is_object($ilDB) && $ilUser->getId() > 0 &&
            $ilUser->getId() != ANONYMOUS_USER_ID) {
            if ($_GET["rtoken"] == "") {
                return false;
            }
 
            $set = $ilDB->query("SELECT * FROM il_request_token WHERE " .
                " user_id = " . $ilDB->quote($ilUser->getId(), "integer") . " AND " .
                " token = " . $ilDB->quote($_GET[self::IL_RTOKEN_NAME]), "text");
            if ($ilDB->numRows($set) > 0) {
                // remove tokens from older sessions
                // if we do this immediately, working with multiple windows does not work:
                // - window one: open form (with token a)
                // - window two: open form (with token b)
                // - submit window one: a is verified, but b must not be deleted immediately, otherwise
                // - window two: submit results in invalid token
                // see also bug #13551
                $dt = new ilDateTime(time(), IL_CAL_UNIX);
                $dt->increment(IL_CAL_DAY, -1);
                $dt->increment(IL_CAL_HOUR, -12);
                $ilDB->manipulate("DELETE FROM il_request_token WHERE " .
                    " user_id = " . $ilDB->quote($ilUser->getId(), "integer") . " AND " .
                    " session_id != " . $ilDB->quote(session_id(), "text") . " AND " .
                    " stamp < " . $ilDB->quote($dt->get(IL_CAL_DATETIME), "timestamp"));
                return true;
            } else {
                return false;
            }
            
            if ($_SESSION["rtokens"][$_GET[self::IL_RTOKEN_NAME]] != "") {
                // remove used token
                unset($_SESSION["rtokens"][$_GET[self::IL_RTOKEN_NAME]]);
                
                // remove old tokens
                if (count($_SESSION["rtokens"]) > 100) {
                    $to_remove = array();
                    $sec = 7200;                        // two hours
 
                    foreach ($_SESSION["rtokens"] as $tok => $time) {
                        if (time() - $time > $sec) {
                            $to_remove[] = $tok;
                        }
                    }
                    foreach ($to_remove as $tok) {
                        unset($_SESSION["rtokens"][$tok]);
                    }
                }
                
                return true;
            }
            return false;
        } else {
            return true;                // do not verify, if user or db object is missing
        }
        
        return false;
    }

References $_GET, $_SESSION, $DIC, $ilDB, $ilUser, ANONYMOUS_USER_ID, IL_CAL_DATETIME, IL_CAL_DAY, IL_CAL_HOUR, and IL_CAL_UNIX.

Referenced by getCmd().

Here is the caller graph for this function:

Field Documentation

$call_hist

ilCtrl::$call_hist = array()

protected

Stores the order in which different GUI classes were called.

TODO: Might better be called call_stack.

This is used in: forwardCommand, getHTML, getCallHistory

Definition at line 61 of file class.ilCtrl.php.

Referenced by getCallHistory().

$calls

ilCtrl::$calls = array()

protected

Stores which class calls which other class.

This is used in: getNodeIdForTargetClass, fetchCallsOfClassFromCache, callOfClassNotKnown

Definition at line 68 of file class.ilCtrl.php.

$inner_base_class

ilCtrl::$inner_base_class = ""

protected

Definition at line 102 of file class.ilCtrl.php.

Referenced by getHTML(), and getParameterArrayByClass().

$module_dir

ilCtrl::$module_dir

protected

Definition at line 88 of file class.ilCtrl.php.

$parameter

ilCtrl::$parameter

protected

Definition at line 39 of file class.ilCtrl.php.

Referenced by saveParameterByClass().

$return

ilCtrl::$return

protected

Definition at line 52 of file class.ilCtrl.php.

$rtoken

ilCtrl::$rtoken = false

protected

Definition at line 77 of file class.ilCtrl.php.

Referenced by getRequestToken().

$save_parameter

ilCtrl::$save_parameter

protected

Definition at line 28 of file class.ilCtrl.php.

$target_script

ilCtrl::$target_script = "ilias.php"

protected

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

Referenced by getTargetScript().

$use_current_to_determine_next

ilCtrl::$use_current_to_determine_next = false

protected

Definition at line 95 of file class.ilCtrl.php.

IL_RTOKEN_NAME

const ilCtrl::IL_RTOKEN_NAME = 'rtoken'

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

---

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

• Services/UICore/classes/class.ilCtrl.php