ilCtrl Class Reference

This class provides processing control methods. More...

Collaboration diagram for ilCtrl:

Public Member Functions
	ilCtrl ()
	control class constructor More...
	debug ($str)
	Collect debugging strings (. More...
	getDebug ()
	Get debug message string (. More...
	init ()
	initialisation 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)
	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...
	addLocation ($a_title, $a_link, $a_target="", $a_ref_id=0)
	Add a location to the locator array (. More...
	getLocations ()
	Get locations array (. 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)
	stores often used common call structures (called from db_update script!!!) 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...
	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 ()
	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 ($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=true)
	Get form action url for gui class object. More...
	getFormActionByClass ($a_class, $a_fallback_cmd="", $a_anchor="", $a_asynch=false, $xml_style=true)
	Get form action url for gui class name. More...
	appendRequestTokenParameterString ($a_url, $xml_style=true)
	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...
	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=true)
	Get link target for command using gui object. More...
	getLinkTargetByClass ($a_class, $a_cmd="", $a_anchor="", $a_asynch=false, $xml_style=true)
	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...
	getRedirectSource ()
	Get current redirect source. 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...
	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...

Data Fields
const	IL_RTOKEN_NAME = 'rtoken'
	$target_script
	$forward
	$parent
	$save_parameter
	$return
	$call_hist = array()
	$debug = array()
	$calls = array()
	$rtoken = false

Private Member Functions
	getNodeIdForTargetClass ($a_par_node, $a_class, $a_check=false)
	Searchs a node for a given class ($a_class) "near" the another node ($a_par_node). More...
	forwards ($a_from_class, $a_to_class)
	Stores which classes forwards commands to which other classes. 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...
	getCidForClass ($a_class, $a_check=false)
	Get Cid for Class. More...
	getClassForCid ($a_cid)
	Get class for cid. More...
	readCidInfo ($a_cid)
	Read information of class per cid. More...
	readNodeInfo ($a_node)
	Read info of node. More...
	readClassInfo ($a_class)
	Read info of class. More...
	getParentCidOfNode ($a_node)
	Get last but one cid of node id. More...
	removeLastCid ($a_node)
	Remove last cid of node. More...
	getCurrentCidOfNode ($a_node)
	Get last cid of node id. More...

Detailed Description

This class provides processing control methods.

A global instance is available via variable $ilCtrl

Author

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

Version

$Id$

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

Member Function Documentation

addLocation()

ilCtrl::addLocation	(		$a_title,
			$a_link,
			$a_target = "",
			$a_ref_id = 0
	)

Add a location to the locator array (.

Deprecated:

, use $ilLocator)

Parameters

string	$a_title	link text
string	$a_link	link
string	$a_target	target frame

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

        {
                $this->location[] = array("title" => $a_title,
                        "link" => $a_link, "target" => $a_target, "ref_id" => $a_ref_id);
        }

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 491 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 = true
	)

Append request token as url parameter.

Parameters

string	url
boolean	xml style

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

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

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

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.

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

References $_GET, forwardCommand(), and getCallStructure().

        {
                global $ilDB;
                
                $baseClass = strtolower($_GET["baseClass"]);
                
                // get class information
                $mc_set = $ilDB->query("SELECT * FROM module_class WHERE LOWER(class) = ".
                        $ilDB->quote($baseClass, "text"));
                $mc_rec = $ilDB->fetchAssoc($mc_set);
                $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);
                        $this->module_dir = $m_rec["type"]."/".$m_rec["name"];
                        include_once $this->module_dir."/".$class_dir."/class.".$class.".php";
                }
                else            // check whether class belongs to a service
                {
                        $mc_set = $ilDB->query("SELECT * FROM service_class WHERE LOWER(class) = ".
                                $ilDB->quote($baseClass, "text"));
                        $mc_rec = $ilDB->fetchAssoc($mc_set);

                        $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"])));
                        }

                        // get service information
                        $m_set = $ilDB->query("SELECT * FROM il_component WHERE name = ".
                                $ilDB->quote($service, "text"));
                        $m_rec = $ilDB->fetchAssoc($m_set);
                        $this->service_dir = $m_rec["type"]."/".$m_rec["name"];
                        
                        include_once $this->service_dir."/".$class_dir."/class.".$class.".php";;
                }
                
                // forward processing to base class
                $this->getCallStructure(strtolower($baseClass));
                $base_class_gui =& new $class();
                $this->forwardCommand($base_class_gui);
        }

Here is the call graph for this function:

checkTargetClass()

ilCtrl::checkTargetClass

(

$a_class

)

Check whether target is valid.

Parameters

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

References getCidForClass(), and getNodeIdForTargetClass().

        {
                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;
        }

Here is the call graph for this function:

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 742 of file class.ilCtrl.php.

References clearParametersByClass().

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

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 753 of file class.ilCtrl.php.

Referenced by clearParameters().

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

Here is the caller graph for this function:

debug()

ilCtrl::debug

(

$str

)

Collect debugging strings (.

Deprecated:

)

Parameters

string

debug message

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

        {
                $this->debug[] = $str;
        }

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

gui object that should receive the flow of control

Returns

mixed return data of invoked executeCommand() method

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

References getCmd(), and getNodeIdForTargetClass().

Referenced by callBaseClass(), and ilTestSubmissionReviewGUI\executeCommand().

        {
                $class = strtolower(get_class($a_gui_object));
//echo "<br>class:".$class.":";
                $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());

//echo "<br>class:".get_class($a_gui_object).":";
                        $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.");
        }

Here is the call graph for this function:

Here is the caller graph for this function:

forwards()

ilCtrl::forwards (   $a_from_class,   $a_to_class  )

private

Stores which classes forwards commands to which other classes.

Parameters

string	$a_from_class	source class name
string	$a_to_class	target class name

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

Referenced by init(), and readCallStructure().

        {
                $a_from_class = strtolower($a_from_class);

                if (is_array($a_to_class))
                {
                        foreach($a_to_class as $to_class)
                        {
                                if ($a_from_class != "" && $to_class != "")
                                {
                                        if (!is_array($this->forward[$a_from_class]) || !in_array(strtolower($to_class), $this->forward[$a_from_class]))
                                        {
                                                $this->forward[$a_from_class][] = strtolower($to_class);
                                        }
                                        if (!is_array($this->parent[strtolower($to_class)]) || !in_array($a_from_class, $this->parent[strtolower($to_class)]))
                                        {
                                                $this->parent[strtolower($to_class)][] = $a_from_class;
                                        }
                                }
                        }
                }
                else
                {
                        $to_class = $a_to_class;
                        if ($a_from_class != "" && $to_class != "")
                        {
                                if (!is_array($this->forward[$a_from_class]) || !in_array(strtolower($to_class), $this->forward[$a_from_class]))
                                {
                                        $this->forward[$a_from_class][] = strtolower($to_class);
                                }
                                if (!is_array($this->parent[strtolower($to_class)]) || !in_array($a_from_class, $this->parent[strtolower($to_class)]))
                                {
                                        $this->parent[strtolower($to_class)][] = $a_from_class;
                                }
                        }
                }
        }

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 515 of file class.ilCtrl.php.

References $call_hist.

        {
                return $this->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->setTargetScript("ilias.php");
 $ilCtrl->getCallStructure("ilrepositorygui");
 $repository_gui =& new ilRepositoryGUI();
 $ilCtrl->forwardCommand($repository_gui);

Parameters

string

$a_class

gui class name

public

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

References readClassInfo().

Referenced by callBaseClass(), and getNodeIdForTargetClass().

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

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 Cid for Class.

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

References readClassInfo().

Referenced by checkTargetClass(), and getNodeIdForTargetClass().

        {
                if ($this->class_cid[$a_class] == "")
                {
                        $this->readClassInfo($a_class);
                }
                if ($this->class_cid[$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];
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getClassForCid()

ilCtrl::getClassForCid (   $a_cid )

private

Get class for cid.

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

References readCidInfo().

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

        {
                if ($this->cid_class[$a_cid] == "")
                {
                        $this->readCidInfo($a_cid);
                }
                if ($this->cid_class[$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];
        }

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 public

Returns

string class name

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

References $file, and $path.

        {
                $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 938 of file class.ilCtrl.php.

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

Referenced by ilTestSubmissionReviewGUI\dispatchCommand(), ilTestSignatureGUI\executeCommand(), forwardCommand(), and getHTML().

        {
                $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;
        }

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 1052 of file class.ilCtrl.php.

References $_GET.

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

getCmdNode()

ilCtrl::getCmdNode

(

)

Get command target node.

Returns

string id of current command target node

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

References $_GET.

Referenced by getNextClass().

        {
                return $_GET["cmdNode"];
        }

Here is the caller graph for this function:

getContextObjId()

ilCtrl::getContextObjId

(

)

Get context object id.

Returns

int object id

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

        {
                return $this->context_obj_id;
        }

getContextObjType()

ilCtrl::getContextObjType

(

)

Get context object type.

Returns

string object type

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

        {
                return $this->context_obj_type;
        }

getContextSubObjId()

ilCtrl::getContextSubObjId

(

)

Get context subobject id.

Returns

int subobject id

Definition at line 275 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 285 of file class.ilCtrl.php.

        {
                return $this->context_sub_obj_type;
        }

getCurrentCidOfNode()

ilCtrl::getCurrentCidOfNode (   $a_node )

private

Get last cid of node id.

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

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

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

Here is the caller graph for this function:

getDebug()

ilCtrl::getDebug

(

)

Get debug message string (.

Deprecated:

)

Returns

array array of debug strings

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

References $debug.

        {
                return $this->debug;
        }

getFormAction()

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

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 1067 of file class.ilCtrl.php.

References getFormActionByClass().

Referenced by ilTestSubmissionReviewGUI\show().

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

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 = true
	)

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 1085 of file class.ilCtrl.php.

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

Referenced by getFormAction().

        {
                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);
                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;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getHTML()

& ilCtrl::getHTML

(

&

$a_gui_object

)

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

Parameters

object

gui object that returns the HTML block

Returns

string HTML

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

References getCmd(), and getNodeIdForTargetClass().

        {
                $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;
                        
                        // 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
                        $html = $a_gui_object->getHTML();
                        
                        // reset current node
                        $this->current_node = $current_node;
                        
                        // return block
                        return $html;
                }

                include_once("./Services/UICore/exceptions/class.ilCtrlException.php");
                throw new ilCtrlException("ERROR: Can't getHTML from class $class.");

        }

Here is the call graph for this function:

getLinkTarget()

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

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 1343 of file class.ilCtrl.php.

References getLinkTargetByClass().

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

Here is the call graph for this function:

getLinkTargetByClass()

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

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 1363 of file class.ilCtrl.php.

References getTargetScript(), and getUrlParameters().

Referenced by getFormActionByClass(), getLinkTarget(), redirect(), and redirectByClass().

        {
                if ($a_asynch)
                {
                        $xml_style = false;
                }
                
                // note: $a_class may be an array
                //$a_class = strtolower($a_class);

//echo "<br>getLinkTargetByClass";
                $script = $this->getTargetScript();
                $script = $this->getUrlParameters($a_class, $script, $a_cmd, $xml_style);

                if ($a_asynch)
                {
                        //$amp = $xml_style
                        //      ? "&amp;"
                        //      : "&";
                        $amp = "&";
                        $script.= $amp."cmdMode=asynch";
                }
                
                if ($a_anchor != "")
                {
                        $script = $script."#".$a_anchor;
                }

                return $script;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getLocations()

ilCtrl::getLocations

(

)

Get locations array (.

Deprecated:

, use $ilLocator)

Returns

array array of locations (array("title", "link", "target"))

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

References $location.

        {
                return $this->location;
        }

getModuleDir()

ilCtrl::getModuleDir

(

)

get directory of current module

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

        {
                return $this->module_dir;
        }

getNextClass()

ilCtrl::getNextClass

(

)

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 766 of file class.ilCtrl.php.

References $path, getCmdNode(), getCurrentCidOfNode(), getPathNew(), and readCidInfo().

Referenced by ilTestSubmissionReviewGUI\executeCommand(), and ilTestSignatureGUI\executeCommand().

        {
                $cmdNode = $this->getCmdNode();
//echo "<br>getNextClass (current node: ".$this->current_node."; cmd node: ".$cmdNode.") ";
                if ($cmdNode == "")
                {
                        return false;
                }
                else
                {
                        if ($this->current_node == $cmdNode)
                        {
//echo "1:".$this->call_node[$cmdNode]["class"]."<br>";
                                //return $this->call_node[$cmdNode]["class"];
                                return "";
                        }
                        else
                        {
                                $path = $this->getPathNew($this->current_node, $cmdNode);
//var_dump($path);
//echo " - Next Node: ".$path[1];
                                $this->readCidInfo($this->getCurrentCidOfNode($path[1]));
//echo ":".$this->cid_class[$this->getCurrentCidOfNode($path[1])].":".$this->getCurrentCidOfNode($path[1]).":";
                                return $this->cid_class[$this->getCurrentCidOfNode($path[1])];
                        }
                }
        }

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

Searchs a node for a given class ($a_class) "near" the 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 wether 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 methode searchs for the given class along the path from the current node to the root class of the call structure.

Parameters

string	id of starting node for the search
string	class that should be searched

Returns

int id of target node that has been found

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

References getCallStructure(), getCidForClass(), getClassForCid(), getCurrentCidOfNode(), getParentCidOfNode(), readClassInfo(), readNodeInfo(), and removeLastCid().

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

        {
                $class = strtolower($a_class);
                $this->readClassInfo($class);
                
                if ($a_par_node === 0 || $a_par_node == "")
                {
                        return array("node_id" => $this->getCidForClass($class),
                                "base_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 != "")
                {
                        global $ilDB;
                        
                        // get class information
                        $mc_set = $ilDB->query("SELECT * FROM module_class WHERE LOWER(class) = ".
                                $ilDB->quote($class, "text"));
                        $mc_rec = $ilDB->fetchAssoc($mc_set);
                        $n_class = strtolower($mc_rec["class"]);

                        if ($n_class == "")
                        {
                                $mc_set = $ilDB->query("SELECT * FROM service_class WHERE LOWER(class) = ".
                                        $ilDB->quote($class, "text"));
                                $mc_rec = $ilDB->fetchAssoc($mc_set);
                                $n_class = strtolower($mc_rec["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...
                
//              echo "ERROR: Can't find target class $a_class for node $a_par_node ".
//                      "(".$this->cid_class[$this->getParentCidOfNode($a_par_node)].").<br>";
                error_log( "ERROR: Can't find target class $a_class for node $a_par_node ".
                        "(".$this->cid_class[$this->getParentCidOfNode($a_par_node)].")");
                        
                if (DEVMODE == 1)
                {
//                      ilUtil::printBacktrace();
                }

                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->getParentCidOfNode($a_par_node)].").");
        }

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 1539 of file class.ilCtrl.php.

References getParameterArrayByClass().

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

                return $par_arr;
        }

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 1553 of file class.ilCtrl.php.

References $_GET, $_POST, $path, getClassForCid(), getCurrentCidOfNode(), getNodeIdForTargetClass(), and getPathNew().

Referenced by getParameterArray(), and getUrlParameters().

        {
                if ($a_class == "")
                {
                        return array();
                }

                if (!is_array($a_class))
                {
                        $a_class = array($a_class);
                }

                $nr = $this->current_node;
                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($_GET["baseClass"])
                                : $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];
                                        }
                                        else if (isset($_POST[$par]))
                                        {
                                                $params[$par] = $_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"] = $_GET["baseClass"];
                }
                else
                {
                        $params["baseClass"] = $new_baseclass;
                }

                return $params;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getParentCidOfNode()

ilCtrl::getParentCidOfNode (   $a_node )

private

Get last but one cid of node id.

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

Referenced by getNodeIdForTargetClass().

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

Here is the caller graph for this function:

getParentReturn()

ilCtrl::getParentReturn

(

&

$a_gui_obj

)

Get return script url.

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

References getParentReturnByClass().

Referenced by returnToParent().

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

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.

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

References searchReturnClass().

Referenced by getParentReturn().

        {
                $a_class = strtolower($a_class);
                $ret_class = $this->searchReturnClass($a_class);
//echo ":$ret_class:";
                if($ret_class)
                {
//echo ":".$this->return[$ret_class].":";
                        return $this->return[$ret_class];
                }
        }

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 842 of file class.ilCtrl.php.

References $failure, $GLOBALS, $path, and ilUtil\redirect().

Referenced by getNextClass(), and getParameterArrayByClass().

        {
//if ($this->getCmdClass() == "ilmailfoldergui") echo "-".$a_source_node."-".$a_target_node."-";
//echo "-".$a_source_node."-".$a_target_node."-";
//echo "<br>:::$a_source_node:::";
                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);
                        ilUtil::redirect('./ilias.php?baseClass=ilRepositoryGUI');
                }
//echo "<br>:::$a_source_node:::";
                $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);
//echo "=$diff=$diffstart=";
                $diff_arr = explode(":", $diff);
                foreach($diff_arr as $cid)
                {
                        if ($temp_node != "")
                        {
                                $temp_node.= ":";
                        }
                        $temp_node.= $cid;
                        $path[] = $temp_node;
                }
//if ($this->getCmdClass() == "ilmailfoldergui") var_dump($path);
//var_dump($path);
                return $path;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getRedirectSource()

ilCtrl::getRedirectSource

(

)

Get current redirect source.

Returns

string redirect source class

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

References $_GET.

        {
                return $_GET["redirectSource"];
        }

getRequestToken()

ilCtrl::getRequestToken

(

)

Get request token.

Returns

string request token for user and session

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

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

Referenced by appendRequestTokenParameterString(), and getFormActionByClass().

        {
                global $ilDB, $ilUser;
                
                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);
//echo session_id();
                                if ($rec["token"] != "")
                                {
                                        $this->rtoken = $rec["token"];
                                        return $rec["token"];
                                }
//echo "new rtoken, new entry for :".$ilUser->getId().":".session_id().":"; exit;
                                $this->rtoken = md5(uniqid(rand(), true));
                                
                                // delete entries older than one and a half days
                                if (rand(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;
                        }
                        //$this->rtoken = md5(uniqid(rand(), true));
                }
                return "";
        }

Here is the caller graph for this function:

getReturnClass()

ilCtrl::getReturnClass

(

$a_class

)

Get return class.

Parameters

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

References searchReturnClass().

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

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 504 of file class.ilCtrl.php.

References $tab.

        {
                return $this->tab;
        }

getTargetScript()

ilCtrl::getTargetScript

(

)

Get target script name.

Returns

string target script name

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

References $target_script.

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

        {
                return $this->target_script;
        }

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.

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

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

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

        {
                // note: $a_class may be an array!
                //$a_class = strtolower($a_class);
 
                $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;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilCtrl()

ilCtrl::ilCtrl

(

)

control class constructor

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

References $ilBench, and init().

        {
                global $ilBench;

                $this->bench =& $ilBench;
                
                // initialisation
                $this->init();
                
                // this information should go to xml files one day
                $this->stored_trees = array
                        ("ilrepositorygui", "ilpersonaldesktopgui",
                        "illmpresentationgui", "illmeditorgui",
                        "iladministrationgui");
        }

Here is the call graph for this function:

init()

ilCtrl::init

(

)

initialisation

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

References forwards().

Referenced by ilCtrl(), and initBaseClass().

        {
                $this->transit = array();
                $this->forward = array();                       // forward array
                $this->forwards = array();                      // forward array
                $this->parent = array();                        // parent array (reverse forward)
                $this->save_parameter = array();        // save parameter array
                $this->parameter = array();                     // save parameter array
                $this->return = "";                                     // return commmands
                $this->location = array();
                $this->tab = array();
                $this->current_node = 0;
                $this->module_dir = "";
                $this->service_dir = "";
                $this->call_node = array();
                $this->root_class = "";
        }

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 setTargetScript() and callBaseClass() after that.

Parameters

string

base class name

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

References $_GET, and init().

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

Here is the call graph for this function:

insertCtrlCalls()

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

Insert ctrl calls record.

Parameters

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

        {
                global $ilDB;

                $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 INTO ctrl_calls ".
                        "(parent, child, comp_prefix) VALUES (".
                        $ilDB->quote($a_parent, "text").",".
                        $ilDB->quote($a_child, "text").",".
                        $ilDB->quote($a_comp_prefix, "text").
                        ")");
        }

isAsynch()

ilCtrl::isAsynch

(

)

Is current command an asynchronous command?

Returns

boolean asynchronous t/f

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

References $_GET.

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

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 800 of file class.ilCtrl.php.

        {
                global $ilDB;
                $a_class_name = strtolower($a_class_name);

                $class_set = $ilDB->query("SELECT * FROM ctrl_classfile WHERE class = ".
                        $ilDB->quote($a_class_name, "text"));
                $class_rec = $ilDB->fetchAssoc($class_set);

                if ($class_rec["plugin_path"] != "")
                {
                        return $class_rec["plugin_path"]."/".$class_rec["filename"];
                }
                else
                {
                        return $class_rec["filename"];
                }
        }

readCallStructure()

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

stores often used common call structures (called from db_update script!!!)

Reads call structure from db

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

References forwards().

        {
                global $ilDB;

                $a_class = strtolower($a_class);

                $a_nr++;
                
                // determine call node structure
                $this->call_node[$a_nr] = array("class" => $a_class, "parent" => $a_parent);
                
//echo "<br>nr:$a_nr: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"];
                }
                
                // determin forward and parent array
                $this->forwards($a_class, $forw);
//echo "<br>forwards:".$a_class."<br>"; var_dump($forw);

                // determine root class
                $this->root_class = $a_class;
                return $a_nr;
        }

Here is the call graph for this function:

readCidInfo()

ilCtrl::readCidInfo (   $a_cid )

private

Read information of class per cid.

Returns

Parameters

object

$a_cid

cid

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

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

        {
                global $ilDB;
                
                if (isset($this->info_read_cid[$a_cid]))
                {
                        return;
                }
                $set = $ilDB->query("SELECT * FROM ctrl_classfile ".
                        " WHERE cid = ".$ilDB->quote($a_cid, "text")
                        );
                if ($rec  = $ilDB->fetchAssoc($set))
                {
                        $this->cid_class[$a_cid] = $rec["class"];
                        $this->class_cid[$rec["class"]] = $a_cid;
                
                        $set = $ilDB->query("SELECT * FROM ctrl_calls ".
                                " WHERE parent = ".$ilDB->quote($rec["class"], "text")
                                );
                        while ($rec2  = $ilDB->fetchAssoc($set))
                        {
                                if (!isset($this->calls[$rec["class"]]) || !is_array($this->calls[$rec["class"]]) || !in_array($rec2["child"], $this->calls[$rec["class"]]))
                                {
                                        if ($rec2["child"] != "")
                                        {
                                                $this->calls[$rec["class"]][] = $rec2["child"];
                                        }
                                }
                        }
                        $this->info_read_class[$rec["class"]] = true;
                }
                
                $this->info_read_cid[$a_cid] = true;
        }

Here is the caller graph for this function:

readClassInfo()

ilCtrl::readClassInfo (   $a_class )

private

Read info of class.

Parameters

object

$a_class

class name

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

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

        {
                global $ilDB;
                
                $a_class = strtolower($a_class);
                if (isset($this->info_read_class[$a_class]))
                {
                        return;
                }
                $set = $ilDB->query("SELECT * FROM ctrl_classfile ".
                        " WHERE class = ".$ilDB->quote($a_class, "text")
                        );
                if ($rec  = $ilDB->fetchAssoc($set))
                {
                        $this->cid_class[$rec["cid"]] = $a_class;
                        $this->class_cid[$a_class] = $rec["cid"];
                }
                
                $set = $ilDB->query("SELECT * FROM ctrl_calls ".
                        " WHERE parent = ".$ilDB->quote($a_class, "text")
                        );
                while ($rec  = $ilDB->fetchAssoc($set))
                {
                        if (!isset($this->calls[$a_class]) || !is_array($this->calls[$a_class]) || !in_array($rec["child"], $this->calls[$a_class]))
                        {
                                if ($rec["child"] != "")
                                {
                                        $this->calls[$a_class][] = $rec["child"];
                                }
                        }
                }
                
                $this->info_read_class[$a_class] = true;
                $this->info_read_cid[$this->class_cid[$a_class]] = true;
        }

Here is the caller graph for this function:

readNodeInfo()

ilCtrl::readNodeInfo (   $a_node )

private

Read info of node.

Parameters

object

$a_class

class name

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

References readCidInfo().

Referenced by getNodeIdForTargetClass().

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

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 1280 of file class.ilCtrl.php.

References $ilBench, getLinkTargetByClass(), and ilUtil\redirect().

        {
                global $ilBench;
                
                $script = $this->getLinkTargetByClass(strtolower(get_class($a_gui_obj)), $a_cmd,
                        "", $a_asynch, false);
                if  (is_object($ilBench))
                {
                        $ilBench->save();
                }
                if ($a_anchor != "")
                {
                        $script = $script."#".$a_anchor;
                }
                ilUtil::redirect($script);
        }

Here is the call 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 1304 of file class.ilCtrl.php.

References getLinkTargetByClass(), and ilUtil\redirect().

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

Here is the call graph for this function:

removeLastCid()

ilCtrl::removeLastCid (   $a_node )

private

Remove last cid of node.

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

Referenced by getNodeIdForTargetClass().

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

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 1423 of file class.ilCtrl.php.

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

        {
                $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;
                }

                ilUtil::redirect($script);
        }

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 (which is set by the setTargetScript() method) 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

public

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

References saveParameterByClass().

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

Here is the call 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 679 of file class.ilCtrl.php.

Referenced by saveParameter().

        {
                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;
                }
        }

Here is the caller graph for this function:

searchReturnClass()

ilCtrl::searchReturnClass (   $a_class )

private

Determine current return class.

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

References getClassForCid(), and getNodeIdForTargetClass().

Referenced by getParentReturnByClass(), and getReturnClass().

        {
                $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;
        }

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 1023 of file class.ilCtrl.php.

References $_GET.

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

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 1038 of file class.ilCtrl.php.

References $_GET, and getNodeIdForTargetClass().

        {
                $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;
        }

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 242 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 (which is set by the setTargetScript() method) 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 717 of file class.ilCtrl.php.

Referenced by ilTestSubmissionReviewGUI\show().

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

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 730 of file class.ilCtrl.php.

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

setReturn()

ilCtrl::setReturn	(	&	$a_gui_obj,
			$a_cmd
	)

Set return command.

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

References getTargetScript(), and getUrlParameters().

        {
                $script = $this->getTargetScript();
                $script = $this->getUrlParameters(strtolower(get_class($a_gui_obj)), $script, $a_cmd);
//echo "<br>setReturn:".get_class($a_gui_obj).":".$script.":<br>";
                $this->return[strtolower(get_class($a_gui_obj))] = $script;
        }

Here is the call graph for this function:

setReturnByClass()

ilCtrl::setReturnByClass	(		$a_class,
			$a_cmd
	)

Set return command.

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

References getTargetScript(), and getUrlParameters().

        {
                // may not be an array!
                $a_class = strtolower($a_class);

                $script = $this->getTargetScript();
                $script = $this->getUrlParameters($a_class, $script, $a_cmd);
//echo "<br>setReturn:".get_class($a_gui_obj).":".$script.":<br>";
                $this->return[strtolower($a_class)] = $script;
        }

Here is the call graph for this function:

setTargetScript()

ilCtrl::setTargetScript

(

$a_target_script

)

set target script name

Parameters

string

$a_target_script

target script name

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

        {
                $this->target_script = $a_target_script;
        }

verifyToken()

ilCtrl::verifyToken ( )

private

Verify Token.

Returns

boolean valid t/f

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

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

Referenced by getCmd().

        {
                global $ilDB, $ilUser;

                if (is_object($ilUser) && is_object($ilDB) && $ilUser->getId() > 0 &&
                        $ilUser->getId() != ANONYMOUS_USER_ID)
                {
                        if ($_GET["rtoken"] == "")
                        {
                                #echo "ilCtrl::No Request Token Given!";                // for debugging, maybe changed later
                                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 used token
                                /*
                                $ilDB->query("DELETE FROM il_request_token WHERE ".              
                                        " user_id = ".$ilDB->quote($ilUser->getId())." AND ".            
                                        " token = ".$ilDB->quote($_GET[self::IL_RTOKEN_NAME]));
                                */

                                // 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;
        }

Here is the caller graph for this function:

Field Documentation

$call_hist

ilCtrl::$call_hist = array()

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

Referenced by getCallHistory().

$calls

ilCtrl::$calls = array()

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

$debug

ilCtrl::$debug = array()

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

Referenced by getDebug().

$forward

ilCtrl::$forward

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

$parent

ilCtrl::$parent

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

$return

ilCtrl::$return

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

$rtoken

ilCtrl::$rtoken = false

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

Referenced by getRequestToken().

$save_parameter

ilCtrl::$save_parameter

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

$target_script

ilCtrl::$target_script

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

Referenced by getTargetScript().

IL_RTOKEN_NAME

const ilCtrl::IL_RTOKEN_NAME = 'rtoken'

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

Referenced by ilObjFileBasedLMGUI\addBibItem(), ilObjContentObjectGUI\addBibItem(), ilObjFileBasedLMGUI\deleteBibItem(), ilObjContentObjectGUI\deleteBibItem(), ilObjFileBasedLMGUI\editBibItem(), ilObjContentObjectGUI\editBibItem(), ilObjFileBasedLMGUI\saveBibItem(), and ilObjContentObjectGUI\saveBibItem().

---

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

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