ILIAS  eassessment Revision 61809
 All Data Structures Namespaces Files Functions Variables Groups Pages
ilCtrl2 Class Reference

This class provides processing control methods. More...

+ Inheritance diagram for ilCtrl2:
+ Collaboration diagram for ilCtrl2:

Additional Inherited Members

- Public Member Functions inherited from ilCtrl
 ilCtrl ()
 control class constructor
 debug ($str)
 Collect debugging strings (.
 getDebug ()
 Get debug message string (.
 init ()
 initialisation
 callBaseClass ()
 Calls base class of current request.
 getModuleDir ()
 get directory of current module
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.
getHTML (&$a_gui_object)
 Gets an HTML output from another GUI class and returns the flow of control to the calling class.
 setContext ($a_obj_id, $a_obj_type, $a_sub_obj_id=0, $a_sub_obj_type="")
 Set context of current user interface.
 getContextObjId ()
 Get context object id.
 getContextObjType ()
 Get context object type.
 getContextSubObjId ()
 Get context subobject id.
 getContextSubObjType ()
 Get context subobject type.
 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).
 checkTargetClass ($a_class)
 Check whether target is valid.
 getCmdNode ()
 Get command target node.
 addLocation ($a_title, $a_link, $a_target="", $a_ref_id=0)
 Add a location to the locator array (.
 getLocations ()
 Get locations array (.
 addTab ($a_lang_var, $a_link, $a_cmd, $a_class)
 Add a tab to tabs array (.
 getTabs ()
 Get tabs array (.
 getCallHistory ()
 Get controller call history.
 getCallStructure ($a_class)
 Get call structure of class context.
 readCallStructure ($a_class, $a_nr=0, $a_parent=0)
 stores often used common call structures (called from db_update script!!!)
 saveParameter (&$a_obj, $a_parameter)
 Set parameters that should be passed in every form and link of a gui class.
 saveParameterByClass ($a_class, $a_parameter)
 Save parameter for a class.
 setParameter (&$a_obj, $a_parameter, $a_value)
 Set parameters that should be passed a form and link of a gui class.
 setParameterByClass ($a_class, $a_parameter, $a_value)
 Same as setParameterByClass, except that a class name is passed.
 clearParameters (&$a_obj)
 Clears all parameters that have been set via setParameter for a GUI class.
 clearParametersByClass ($a_class)
 Clears all parameters that have been set via setParameter for a GUI class.
 getNextClass ()
 Get next class in the control path from the current class to the target command class.
 lookupClassPath ($a_class_name)
 Get class path that can be used in include statements for a given class name.
 getClassForClasspath ($a_class_path)
 this method assumes that the class path has the format "dir/class.<class_name>.php"
 setTargetScript ($a_target_script)
 set target script name
 getTargetScript ()
 Get target script name.
 initBaseClass ($a_base_class)
 Initialises new base class.
 getCmd ($a_default_cmd="", $a_safe_commands="")
 Determines current get/post command.
 setCmd ($a_cmd)
 Set the current command.
 setCmdClass ($a_cmd_class)
 Set the current command class.
 getCmdClass ()
 Determines class that should execute the current command.
 getFormAction (&$a_gui_obj, $a_fallback_cmd="", $a_anchor="", $a_asynch=false, $xml_style=true)
 Get form action url for gui class object.
 getFormActionByClass ($a_class, $a_fallback_cmd="", $a_anchor="", $a_asynch=false, $xml_style=true)
 Get form action url for gui class name.
 appendRequestTokenParameterString ($a_url, $xml_style=true)
 Append request token as url parameter.
 getRequestToken ()
 Get request token.
 redirect (&$a_gui_obj, $a_cmd="", $a_anchor="")
 Redirect to another command.
 redirectByClass ($a_class, $a_cmd="")
 Redirect to other gui class using class name.
 isAsynch ()
 Is current command an asynchronous command?
 getLinkTarget (&$a_gui_obj, $a_cmd="", $a_anchor="", $a_asynch=false, $xml_style=true)
 Get link target for command using gui object.
 getLinkTargetByClass ($a_class, $a_cmd="", $a_anchor="", $a_asynch=false, $xml_style=true)
 Get link target for command using gui class name.
 setReturn (&$a_gui_obj, $a_cmd)
 Set return command.
 setReturnByClass ($a_class, $a_cmd)
 Set return command.
 returnToParent (&$a_gui_obj, $a_anchor="")
 Redirects to next parent class that used setReturn.
 getRedirectSource ()
 Get current redirect source.
 getParentReturn (&$a_gui_obj)
 Get return script url.
 getParentReturnByClass ($a_class)
 Get return script url.
 getUrlParameters ($a_class, $a_str, $a_cmd="", $xml_style=false)
 Get URL parameters for a class and append them to a string.
 getParameterArray (&$a_gui_obj, $a_cmd="")
 Get all set/save parameters for a gui object.
 getParameterArrayByClass ($a_class, $a_cmd="")
 Get all set/save parameters using gui class name.
 insertCtrlCalls ($a_parent, $a_child, $a_comp_prefix)
 Insert ctrl calls record.
- Data Fields inherited from ilCtrl
const IL_RTOKEN_NAME = 'rtoken'
 $target_script
 $forward
 $parent
 $save_parameter
 $return
 $call_hist = array()
 $debug = array()
 $calls = array()
 $rtoken = false

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:
class.ilCtrl.php 20093 2009-05-29 07:17:46Z akill

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


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