This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilCommonActionDispatcherGUI:

Public Member Functions
	__construct (int $node_type, $access_handler, string $obj_type, int $node_id, int $obj_id, int $news_id=0)

	getAjaxHash ()
	Build ajax hash for current (object/node) properties. More...

	executeCommand ()

	setSubObject (?string $sub_obj_type, ?int $sub_obj_id)
	Set sub object attributes. More...

	enableCommentsSettings (bool $value)
	Toggle comments settings. More...

	setRatingCallback (object $gui, string $cmd)
	Add callback for rating gui. More...

	initHeaderAction ()
	Set header action menu. More...

Static Public Member Functions
static	buildAjaxHash (int $node_type, ?int $node_id, string $obj_type, int $obj_id, string $sub_type=null, int $sub_id=null, int $news_id=0)
	Build ajax hash. More...

static	removeSubObjFromAjaxHash (string $hash)

static	getInstanceFromAjaxCall ()
	(Re-)Build instance from ajax call More...

Data Fields
const	TYPE_REPOSITORY = 1

const	TYPE_WORKSPACE = 2

Protected Attributes
ilCtrl	$ctrl

ilSetting	$settings

ILIAS HTTP Wrapper RequestWrapper	$request_wrapper

ILIAS Refinery Factory	$refinery

int	$node_type = 0

	$access_handler

string	$obj_type = ""

int	$node_id = 0

int	$obj_id = 0

int	$news_id = 0

string	$sub_type = null

int	$sub_id = null

bool	$enable_comments_settings = false

array	$rating_callback = []

Private Attributes
ilObjectRequestRetriever	$retriever

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilCommonActionDispatcherGUI

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om ilCommonActionDispatcherGUI: ilNoteGUI, ilTaggingGUI, ilObjectActivationGUI ilCommonActionDispatcherGUI: ilRatingGUI, ilObjRootFolderGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilCommonActionDispatcherGUI::__construct	(	int	$node_type,
			$access_handler,
		string	$obj_type,
		int	$node_id,
		int	$obj_id,
		int	$news_id = `0`
	)

Definition at line 54 of file class.ilCommonActionDispatcherGUI.php.

References $access_handler, $DIC, $news_id, $node_id, $node_type, $obj_id, $obj_type, $refinery, ILIAS\Repository\ctrl(), ILIAS\Repository\refinery(), and ILIAS\Repository\settings().

       {
         global $DIC;
 
         $this->ctrl = $DIC->ctrl();
         $this->settings = $DIC->settings();
         $this->request_wrapper = $DIC->http()->wrapper()->query();
         $this->refinery = $DIC->refinery();
         $this->retriever = new ilObjectRequestRetriever($DIC->http()->wrapper(), $this->refinery);
 
         $this->node_type = $node_type;
         $this->access_handler = $access_handler;
         $this->obj_type = $obj_type;
         $this->node_id = $node_id;
         $this->obj_id = $obj_id;
         $this->news_id = $news_id;
     }

Here is the call graph for this function:

Member Function Documentation

◆ buildAjaxHash()

static ilCommonActionDispatcherGUI::buildAjaxHash	(	int	$node_type,
		?int	$node_id,
		string	$obj_type,
		int	$obj_id,
		string	$sub_type = `null`,
		int	$sub_id = `null`,
		int	$news_id = `0`
	)

static

Build ajax hash.

Definition at line 97 of file class.ilCommonActionDispatcherGUI.php.

References $news_id.

Referenced by ilPollBlockGUI\commentJSCall(), ilDclRecordListTableGUI\getCommentsAjaxLink(), ilQuestionBrowserTableGUI\getCommentsAjaxLink(), ilNoteGUI\getCommentsWidget(), ilDclBaseRecordModel\getStandardFieldHTML(), ilObjectListGUI\initItem(), and ilContainerContentGUI\renderCard().

      : string {
         return
             $node_type . ";" . $node_id . ";" . $obj_type . ";" . $obj_id . ";" .
             $sub_type . ";" . $sub_id . ";" . $news_id
         ;
     }

Here is the caller graph for this function:

◆ enableCommentsSettings()

ilCommonActionDispatcherGUI::enableCommentsSettings ( bool $value )

Toggle comments settings.

Definition at line 275 of file class.ilCommonActionDispatcherGUI.php.

                                                        : void
     {
         $this->enable_comments_settings = $value;
     }

◆ executeCommand()

ilCommonActionDispatcherGUI::executeCommand ( )

Definition at line 175 of file class.ilCommonActionDispatcherGUI.php.

References $obj_type, $sub_type, ILIAS\Repository\ctrl(), exit, and ILIAS\Repository\settings().

                                     : void
     {
         // check access for object
         if (
             $this->node_id &&
             !$this->access_handler->checkAccess("visible", "", $this->node_id) &&
             !$this->access_handler->checkAccess("read", "", $this->node_id)
         ) {
             exit();
         }
 
         $next_class = $this->ctrl->getNextClass($this);
 
         $this->ctrl->saveParameter($this, "cadh");
 
         switch ($next_class) {
             case "ilnotegui":
 
                 $obj_type = $this->obj_type;
                 if ($this->sub_type) {
                     $obj_type = $this->sub_type;
                 }
 
                 $note_gui = new ilNoteGUI($this->obj_id, (int) $this->sub_id, $obj_type, false, $this->news_id);
                 $note_gui->enablePrivateNotes();
 
                 $has_write = $this->access_handler->checkAccess("write", "", $this->node_id);
                 if ($has_write && $this->settings->get("comments_del_tutor", "1")) {
                     $note_gui->enablePublicNotesDeletion();
                 }
 
                 // comments cannot be turned off globally
                 if ($this->enable_comments_settings) {
                     // should only be shown if active or permission to toggle
                     if (
                         $has_write ||
                         $this->access_handler->checkAccess("edit_permissions", "", $this->node_id)
                     ) {
                         $note_gui->enableCommentsSettings();
                     }
                 }
                 /* this is different to the info screen but we need this
                    for sub-object action menus, e.g. wiki page */
                 elseif ($this->sub_id) {
                     $note_gui->enablePublicNotes();
                 }
 
                 $this->ctrl->forwardCommand($note_gui);
                 break;
 
             case "iltagginggui":
                 $tags_gui = new ilTaggingGUI();
                 $tags_gui->setObject($this->obj_id, $this->obj_type);
                 $this->ctrl->forwardCommand($tags_gui);
                 break;
 
             case "ilobjectactivationgui":
                 $parent_id = $this->retriever->getMaybeInt('parent_id') ?? 0;
                 $this->ctrl->setParameter($this, "parent_id", $parent_id);
                 $act_gui = new ilObjectActivationGUI($parent_id, $this->node_id);
                 $this->ctrl->forwardCommand($act_gui);
                 break;
 
             case "ilratinggui":
                 $rating_gui = new ilRatingGUI();
                 if (
                     $this->request_wrapper->has("rnsb")
                 ) {
                     $rating_gui->setObject($this->obj_id, $this->obj_type, $this->sub_id, $this->sub_type);
                 } else {
                     // coming from headaction ignore sub-objects
                     $rating_gui->setObject($this->obj_id, $this->obj_type);
                 }
                 $this->ctrl->forwardCommand($rating_gui);
                 if ($this->rating_callback) {
                     // as rating in categories is form-based we need to redirect
                     // somewhere after saving
                     $this->ctrl->redirect($this->rating_callback[0], $this->rating_callback[1]);
                 }
                 break;
 
             default:
                 break;
         }
 
         exit();
     }

Here is the call graph for this function:

◆ getAjaxHash()

ilCommonActionDispatcherGUI::getAjaxHash ( )

Build ajax hash for current (object/node) properties.

Definition at line 81 of file class.ilCommonActionDispatcherGUI.php.

Referenced by initHeaderAction().

                                  : string
     {
         return self::buildAjaxHash(
             $this->node_type,
             $this->node_id,
             $this->obj_type,
             $this->obj_id,
             $this->sub_type,
             $this->sub_id,
             $this->news_id
         );
     }

Here is the caller graph for this function:

◆ getInstanceFromAjaxCall()

static ilCommonActionDispatcherGUI::getInstanceFromAjaxCall ( )

static

(Re-)Build instance from ajax call

Definition at line 124 of file class.ilCommonActionDispatcherGUI.php.

References $access_handler, $DIC, $ilUser, $news_id, $node_id, $node_type, $obj_id, $obj_type, $parts, and ILIAS\Repository\int().

                                                     : ?ilCommonActionDispatcherGUI
     {
         global $DIC;
 
         $ilAccess = $DIC->access();
         $ilUser = $DIC->user();
         $request_wrapper = $DIC->http()->wrapper()->query();
         $refinery = $DIC->refinery();
 
         if ($request_wrapper->has("cadh")) {
             $parts = explode(";", $request_wrapper->retrieve("cadh", $refinery->kindlyTo()->string()));
 
             $node_type = (int) $parts[0];
             $node_id = (int) $parts[1];
             $obj_type = (string) $parts[2];
             $obj_id = (int) $parts[3];
             $sub_type = (string) $parts[4];
             $sub_id = (int) $parts[5];
             $news_id = (int) $parts[6];
 
             switch ($node_type) {
                 case self::TYPE_REPOSITORY:
                     $access_handler = $ilAccess;
                     break;
 
                 case self::TYPE_WORKSPACE:
                     $tree = new ilWorkspaceTree($ilUser->getId());
                     $access_handler = new ilWorkspaceAccessHandler($tree);
                     break;
 
                 default:
                     return null;
             }
 
             $dispatcher = new self($node_type, $access_handler, $obj_type, $node_id, $obj_id, $news_id);
 
             if ($sub_type && $sub_id) {
                 $dispatcher->setSubObject($sub_type, $sub_id);
             }
 
             // poll comments have specific settings
 
             if ($node_type == self::TYPE_REPOSITORY && $obj_type != "poll") {
                 $dispatcher->enableCommentsSettings(true);
             }
 
             return $dispatcher;
         }
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initHeaderAction()

ilCommonActionDispatcherGUI::initHeaderAction ( )

Set header action menu.

Definition at line 291 of file class.ilCommonActionDispatcherGUI.php.

References ilObjectListGUIFactory\_getListGUIByType(), ilObjectListGUI\CONTEXT_REPOSITORY, ilObjectListGUI\CONTEXT_WORKSPACE, and getAjaxHash().

                                       : ?ilObjectListGUI
     {
         // check access for object
         if (
             $this->node_id &&
             !$this->access_handler->checkAccess("visible", "", $this->node_id) &&
             !$this->access_handler->checkAccess("read", "", $this->node_id)
         ) {
             return null;
         }
 
         $header_action = ilObjectListGUIFactory::_getListGUIByType(
             $this->obj_type,
             ($this->node_type == self::TYPE_REPOSITORY) ?
                 ilObjectListGUI::CONTEXT_REPOSITORY : ilObjectListGUI::CONTEXT_WORKSPACE
         );
 
         // remove all currently unwanted actions
         $header_action->enableCopy(false);
         $header_action->enableCut(false);
         $header_action->enableDelete(false);
         $header_action->enableLink(false);
         $header_action->enableInfoScreen(false);
         $header_action->enableTimings(false);
         $header_action->enableSubscribe($this->node_type == self::TYPE_REPOSITORY);
 
         $header_action->initItem($this->node_id, $this->obj_id, $this->obj_type);
         $header_action->setHeaderSubObject($this->sub_type, $this->sub_id);
         $header_action->setAjaxHash($this->getAjaxHash());
 
         return $header_action;
     }

Here is the call graph for this function:

◆ removeSubObjFromAjaxHash()

static ilCommonActionDispatcherGUI::removeSubObjFromAjaxHash ( string $hash )

static

Definition at line 112 of file class.ilCommonActionDispatcherGUI.php.

Referenced by ilObjectListGUI\getHeaderAction().

                                                                   : string {
         $arr = explode(";", $hash);
         if (isset($arr[4]) && isset($arr[5])) {
             $arr[4] = "";
             $arr[5] = "";
         }
         return implode(";", $arr);
     }

Here is the caller graph for this function:

◆ setRatingCallback()

ilCommonActionDispatcherGUI::setRatingCallback	(	object	$gui,
		string	$cmd
	)

Add callback for rating gui.

Definition at line 283 of file class.ilCommonActionDispatcherGUI.php.

                                                                : void
     {
         $this->rating_callback = array($gui, $cmd);
     }

◆ setSubObject()

ilCommonActionDispatcherGUI::setSubObject	(	?string	$sub_obj_type,
		?int	$sub_obj_id
	)

Set sub object attributes.

Definition at line 266 of file class.ilCommonActionDispatcherGUI.php.

Referenced by assQuestionGUI\getHeaderAction(), ilLMPresentationGUI\getHeaderAction(), and ilObjectGUI\initHeaderAction().

                                                                          : void
     {
         $this->sub_type = $sub_obj_type;
         $this->sub_id = $sub_obj_id;
     }

Here is the caller graph for this function: