Classification block, displayed in different contexts, e.g. More...

Inheritance diagram for ilClassificationBlockGUI:

Collaboration diagram for ilClassificationBlockGUI:

Public Member Functions
	__construct ()

	getBlockType ()

	executeCommand ()

	getHTML ()

	getAjax ()

Public Member Functions inherited from ilBlockGUI
	__construct ()

	getBlockType ()

	setData (array $a_data)

	getData ()

	setPresentation (int $type)

	getPresentation ()

	setBlockId (string $a_block_id="0")

	getBlockId ()

	setGuiObject (object $a_gui_object)
	Set GuiObject. More...

	getGuiObject ()

	setTitle (string $a_title)

	getTitle ()

	setOffset (int $a_offset)

	getOffset ()

	checkOffset (int $offset)

	setLimit (int $a_limit)

	getLimit ()

	setEnableEdit (bool $a_enableedit)

	getEnableEdit ()

	setRepositoryMode (bool $a_repositorymode)

	getRepositoryMode ()

	setSubtitle (string $a_subtitle)

	getSubtitle ()

	setRefId (int $a_refid)
	Set Ref Id (only used if isRepositoryObject() is true). More...

	getRefId ()

	setAdminCommands (bool $a_admincommands)

	getAdminCommands ()

	setEnableNumInfo (bool $a_enablenuminfo)

	getEnableNumInfo ()

	setProperties (array $a_properties)
	This function is supposed to be used for block type specific properties, that should be inherited through ilColumnGUI->setBlockProperties. More...

	getProperty (string $a_property)

	setProperty (string $a_property, string $a_value)

	setRowTemplate (string $a_rowtemplatename, string $a_rowtemplatedir="")
	Set Row Template Name. More...

	getNavParameter ()

	getConfigParameter ()

	getMoveParameter ()

	getRowTemplateName ()

	getRowTemplateDir ()

	addBlockCommand (string $a_href, string $a_text, string $a_onclick="", ?RoundTrip $modal=null)

	getBlockCommands ()

	getHTML ()

	getAsynch ()
	Use this for final get before sending asynchronous output (ajax) per echo to output. More...

	getPaginationViewControl ()
	Fill previous/next row. More...

	getViewControlsForPanel ()

	sortObject ()

	addSortOption (string $option, string $label, bool $active)

	setSortTarget (string $target)

	addPresentation (string $label, string $target, bool $active)

	getNoItemFoundContent ()

Static Public Member Functions
static	getScreenMode ()

Static Public Member Functions inherited from ilBlockGUI
static	getScreenMode ()

Protected Member Functions
	isRepositoryObject ()

	getLegacyContent ()

	returnToParent ()

	validate ()

	filterContainer ()

	initProviders (bool $a_check_post=false)

	toggle ()

	getSubItemIds (array $obj_ids)
	Get sub item ids depending on container type that match the preselected object ids. More...

Protected Member Functions inherited from ilBlockGUI
	isRepositoryObject ()
	Returns whether block has a corresponding repository object. More...

	specialCharsAsEntities (string $string)

	initCommands ()

	preloadData (array $data)
	Can be overwritten in subclasses. More...

	getLegacyContent ()
	Get legacy content. More...

	getListItemForData (array $data)
	Get list item for data array. More...

	handleNavigation ()
	Handle navigation. More...

	loadData ()
	Load data for current page. More...

	getListItemGroups ()
	Get items. More...

	addRepoCommands ()
	Add repo commands. More...

	getActionsForPanel ()

	send (string $output)
	Send. More...

Protected Attributes
ILIAS Container Classification ClassificationManager	$classification

StandardGUIRequest	$cl_request

ilObjectDefinition	$obj_definition

ilTree	$tree

string	$parent_obj_type

int	$parent_obj_id

int	$parent_ref_id

array	$providers

array	$item_list_gui

Protected Attributes inherited from ilBlockGUI
ILIAS UI Renderer	$renderer

Factory	$factory

object	$gui_object

ILIAS Block StandardGUIRequest	$request

ILIAS Block BlockManager	$block_manager

bool	$repositorymode = false

ILIAS DI UIServices	$ui

array	$data = array()

bool	$enablenuminfo = true

array	$footer_links = array()

string	$block_id = "0"

bool	$allow_moving = true

array	$move = array("left" => false, "right" => false, "up" => false, "down" => false)

array	$block_commands = array()

int	$max_count = 0

bool	$close_command = false

bool	$image = false

array	$property = []

string	$nav_value = ""

string	$css_row = ""

string	$title = ""

bool	$admincommands = false

array	$dropdown

ilTemplate	$tpl

ilGlobalTemplateInterface	$main_tpl

ilObjUser	$user

ilCtrl	$ctrl

ilAccessHandler	$access

ilLanguage	$lng

ilObjectDefinition	$obj_def

int	$presentation

int	$requested_ref_id

Static Protected Attributes
static array	$providers_cache

Additional Inherited Members
Data Fields inherited from ilBlockGUI
const	PRES_MAIN_LEG = 0

const	PRES_SEC_LEG = 1

const	PRES_SEC_LIST = 2

const	PRES_MAIN_LIST = 3

const	PRES_MAIN_TILE = 4

Detailed Description

Classification block, displayed in different contexts, e.g.

Constructor & Destructor Documentation

◆ __construct()

ilClassificationBlockGUI::__construct ( )

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

References $DIC, ilBlockGUI\$requested_ref_id, $service, ILIAS\GlobalScreen\Provider\__construct(), ilObject\_lookupObjId(), ilObject\_lookupType(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilBlockGUI\setTitle().

     {
         global $DIC;
 
         $service = $DIC->container()->internal();
 
         $domain = $service->domain();
         $gui = $service->gui();
 
         $this->lng = $domain->lng();
         $this->obj_definition = $domain->objectDefinition();
         $this->tree = $domain->repositoryTree();
         $this->access = $domain->access();
 
         $this->ctrl = $gui->ctrl();
 
         parent::__construct();
 
         $this->parent_ref_id = $this->requested_ref_id;
         $this->parent_obj_id = ilObject::_lookupObjId($this->parent_ref_id);
         $this->parent_obj_type = ilObject::_lookupType($this->parent_obj_id);
 
         $this->lng->loadLanguageModule("classification");
         $this->setTitle($this->lng->txt("clsfct_block_title"));
 
         $this->cl_request = $gui->classification()->standardRequest();
 
         $this->classification = $domain->classification($this->parent_ref_id);
     }

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilClassificationBlockGUI::executeCommand ( )

Definition at line 79 of file class.ilClassificationBlockGUI.php.

References ilBlockGUI\$ctrl, ilCtrl\getCmd(), and getHTML().

                                     : void
     {
         $ilCtrl = $this->ctrl;
 
         $cmd = $ilCtrl->getCmd();
         $next_class = $ilCtrl->getNextClass($this);
 
         switch ($next_class) {
             default:
                 // explorer call
                 if ($ilCtrl->isAsynch() && $cmd != "getAjax" && $cmd != "filterContainer") {
                     $this->getHTML();
                 } else {
                     $this->$cmd();
                 }
                 break;
         }
     }

Here is the call graph for this function:

◆ filterContainer()

ilClassificationBlockGUI::filterContainer ( )

protected

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

References ilBlockGUI\$access, $id, ilBlockGUI\$lng, $location, ilBlockGUI\$main_tpl, $obj_definition, $provider, ilBlockGUI\$tpl, $tree, ilObjectListGUI\CONTEXT_REPOSITORY, exit, getBlockType(), ilTree\getPathFull(), ilTree\getSubTreeFilteredByObjIds(), ilUtil\getSystemMessageHTML(), initProviders(), ilTree\isDeleted(), null, ilArrayUtil\sortArray(), and ilLanguage\txt().

                                         : void
     {
         $objDefinition = $this->obj_definition;
         $lng = $this->lng;
         $tree = $this->tree;
         $ilAccess = $this->access;
         $tpl = $this->main_tpl;
 
         $this->initProviders();
 
         // empty selection is invalid
         if ($this->classification->isEmptySelection()) {
             exit();
         }
 
         $all_matching_provider_object_ids = null;
         $no_provider = true;
         foreach ($this->providers as $provider) {
             $id = get_class($provider);
             $current = $this->classification->getSelectionOfProvider($id);
             if ($current) {
                 $no_provider = false;
                 // combine providers AND
                 $provider_object_ids = $provider->getFilteredObjects();
                 if (isset($all_matching_provider_object_ids)) {
                     $all_matching_provider_object_ids = array_intersect($all_matching_provider_object_ids, $provider_object_ids);
                 } else {
                     $all_matching_provider_object_ids = $provider_object_ids;
                 }
             }
         }
         $has_content = false;
 
 
         $ltpl = new ilTemplate("tpl.classification_object_list.html", true, true, "components/ILIAS/Container/Classification");
 
         if (isset($all_matching_provider_object_ids) && sizeof($all_matching_provider_object_ids)) {
             $fields = array(
                 "object_reference.ref_id"
                 ,"object_data.obj_id"
                 ,"object_data.type"
                 ,"object_data.title"
                 ,"object_data.description"
             );
             // see #28883 (tags + filter still work on current level only)
             // see also JF comment on https://docu.ilias.de/goto.php?target=wiki_1357_Tagging_in_Categories
             $matching = $tree->getSubTreeFilteredByObjIds(
                 $this->parent_ref_id,
                 $all_matching_provider_object_ids,
                 $fields
             );
             //$matching = $this->getSubItemIds($all_matching_provider_object_ids);
             if (sizeof($matching)) {
                 $valid_objects = array();
 
                 $preloader = new ilObjectListGUIPreloader(ilObjectListGUI::CONTEXT_REPOSITORY);
 
                 foreach ($matching as $item) {
                     if ($item["ref_id"] != $this->parent_ref_id &&
                         !$tree->isDeleted($item["ref_id"]) &&
                         $ilAccess->checkAccess("visible", "", $item["ref_id"])) {
                         // group all valid items in blocks
                         // by their parent group/course or category
                         $block_ref_id = 0;
                         $block_title = "";
                         foreach ($tree->getPathFull($item["ref_id"]) as $p) {
                             if (in_array($p["type"], array("root", "cat", "crs", "grp"))) {
                                 $block_ref_id = $p["ref_id"];
                                 $block_title = $p["title"];
                             }
                         }
                         if ($block_ref_id > 0) {
                             if (!isset($valid_objects[$block_ref_id])) {
                                 $valid_objects[$block_ref_id] = array(
                                     "title" => $block_title,
                                     "items" => array()
                                 );
                             }
                             $valid_objects[$block_ref_id]["items"][] = $item;
                         }
 
                         $preloader->addItem($item["obj_id"], $item["type"], $item["ref_id"]);
                     }
                 }
                 $valid_objects = ilArrayUtil::sortArray($valid_objects, "title", "asc", false, true);
                 if (sizeof($valid_objects)) {
                     $has_content = true;
 
                     $preloader->preload();
 
                     $this->item_list_gui = array();
                     foreach ($valid_objects as $block) {
                         $items = ilArrayUtil::sortArray($block["items"], "title", "asc", false, true);
                         foreach ($items as $obj) {
                             $type = $obj["type"];
 
                             // get list gui class for each object type
                             if (empty($this->item_list_gui[$type])) {
                                 $class = $objDefinition->getClassName($type);
                                 $location = $objDefinition->getLocation($type);
 
                                 $full_class = "ilObj" . $class . "ListGUI";
 
                                 $this->item_list_gui[$type] = new $full_class();
                                 $this->item_list_gui[$type]->enableDelete(false);
                                 $this->item_list_gui[$type]->enablePath(
                                     true,
                                     $this->parent_ref_id,
                                     new \ilSessionClassificationPathGUI()
                                 );
                                 $this->item_list_gui[$type]->enableLinkedPath(true);
                                 $this->item_list_gui[$type]->enableCut(false);
                                 $this->item_list_gui[$type]->enableCopy(false);
                                 $this->item_list_gui[$type]->enableSubscribe(false);
                                 $this->item_list_gui[$type]->enableLink(false);
                                 $this->item_list_gui[$type]->enableIcon(true);
 
                                 // :TOOD: for each item or just for each list?
                                 foreach ($this->providers as $provider) {
                                     $provider->initListGUI($this->item_list_gui[$type]);
                                 }
                             }
 
                             $html = $this->item_list_gui[$type]->getListItemHTML(
                                 $obj["ref_id"],
                                 $obj["obj_id"],
                                 $obj["title"],
                                 $obj["description"]
                             );
 
                             if ($html != "") {
                                 $ltpl->setCurrentBlock("res_row");
                                 $ltpl->setVariable("RESOURCE_HTML", $html);
                                 $ltpl->parseCurrentBlock();
                             }
                         }
                         $ltpl->setCurrentBlock("block");
                         $ltpl->setVariable("BLOCK_TITLE", $block["title"]);
                         $ltpl->parseCurrentBlock();
                     }
                 }
             }
         }
 
         // if nothing has been selected reload to category page
         if ($no_provider) {
             echo "<span id='block_" . $this->getBlockType() . "_0_loader'></span>";
             //echo "<script>il.Classification.returnToParent();</script>";
             echo "<script>document.location.reload();</script>";
             //$this->ctrl->redirect($this->returnToParent());
             exit();
         }
 
         if ($has_content) {
             echo $ltpl->get();
         } else {
             //$content_block->setContent($lng->txt("clsfct_content_no_match"));
             echo ilUtil::getSystemMessageHTML($lng->txt("clsfct_content_no_match"), "info");
         }
 
         exit();
     }

Here is the call graph for this function:

◆ getAjax()

ilClassificationBlockGUI::getAjax ( )

Definition at line 128 of file class.ilClassificationBlockGUI.php.

References ilBlockGUI\$main_tpl, ilBlockGUI\$tpl, exit, getHTML(), and initProviders().

                              : void
     {
         $tpl = $this->main_tpl;
 
         $this->initProviders(true);
 
         echo $this->getHTML();
         echo $tpl->getOnLoadCodeForAsynch();
 
         exit();
     }

Here is the call graph for this function:

◆ getBlockType()

ilClassificationBlockGUI::getBlockType ( )

Definition at line 69 of file class.ilClassificationBlockGUI.php.

Referenced by filterContainer(), and getLegacyContent().

                                   : string
     {
         return 'clsfct';
     }

Here is the caller graph for this function:

◆ getHTML()

ilClassificationBlockGUI::getHTML ( )

Definition at line 115 of file class.ilClassificationBlockGUI.php.

References initProviders(), and validate().

Referenced by executeCommand(), and getAjax().

                              : string
     {
         $this->initProviders();
 
         if (!$this->validate()) {
             return "";
         }
         //$module = '<script type="module" src="../components/ILIAS/Container/resources/ilClassification.js"></script>';
         $module = '<script type="module" src="./assets/js/ilClassification.js"></script>';
 
         return parent::getHTML() . $module;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLegacyContent()

ilClassificationBlockGUI::getLegacyContent ( )

protected

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

References ilBlockGUI\$ctrl, ilBlockGUI\$main_tpl, $provider, ilBlockGUI\$tpl, getBlockType(), and ILIAS\Repository\lng().

                                          : string
     {
         $tpl = $this->main_tpl;
 
         $ilCtrl = $this->ctrl;
 
         $html = array();
         foreach ($this->providers as $provider) {
             $provider->render($html, $this);
         }
 
         //              $this->tpl->setVariable("BLOCK_ROW", "");
 
         $ajax_block_id = "block_" . $this->getBlockType() . "_0";
         $ajax_block_url = $ilCtrl->getLinkTarget($this, "getAjax", "", true, false);
         $ajax_content_id = "il_center_col";
         $ajax_content_url = $ilCtrl->getLinkTarget($this, "filterContainer", "", true, false);
 
         $tabs = new ilTabsGUI();
         $tabs->setBackTarget($this->lng->txt("clsfct_back_to_cat"), $ilCtrl->getLinkTarget($this, "returnToParent"));
         $tabs->addTab("sel_objects", $this->lng->txt("clsfct_selected_objects"), "#");
         $tabs_html = $tabs->getHTML();
 
 
         // #15008 - always load regardless of content (because of redraw)
         /*$tpl->addOnLoadCode('il.Classification.setAjax("' . $ajax_block_id . '", "' .
             $ajax_block_url . '", "' . $ajax_content_id . '", "' . $ajax_content_url . '", ' . json_encode($tabs_html) . ');');*/
 
         $overall_html = "";
         if (sizeof($html)) {
             $btpl = new ilTemplate("tpl.classification_block.html", true, true, "components/ILIAS/Container/Classification");
 
             foreach ($html as $item) {
                 $btpl->setCurrentBlock("provider_chunk_bl");
                 $btpl->setVariable("TITLE", $item["title"]);
                 $btpl->setVariable("CHUNK", $item["html"]);
                 $btpl->parseCurrentBlock();
             }
 
             $btpl->setVariable("AJAX_BLOCK_ID", $ajax_block_id);
             $btpl->setVariable("AJAX_BLOCK_URL", $ajax_block_url);
             $btpl->setVariable("AJAX_CONTENT_ID", $ajax_content_id);
             $btpl->setVariable("AJAX_CONTENT_URL", $ajax_content_url);
             $btpl->setVariable("TABS_HTML", json_encode($tabs_html));
 
             $overall_html .= $btpl->get();
             //$this->tpl->setVariable("DATA", $btpl->get());
         }
         return $overall_html;
     }

Here is the call graph for this function:

◆ getScreenMode()

static ilClassificationBlockGUI::getScreenMode ( )

static

Definition at line 98 of file class.ilClassificationBlockGUI.php.

References $DIC, and IL_SCREEN_CENTER.

                                           : string
     {
         global $DIC;
 
         $ilCtrl = $DIC->ctrl();
 
         if ($ilCtrl->isAsynch()) {
             return "";
         }
 
         switch ($ilCtrl->getCmd()) {
             case "filterContainer":
                 return IL_SCREEN_CENTER;
         }
         return "";
     }

◆ getSubItemIds()

ilClassificationBlockGUI::getSubItemIds ( array $obj_ids )

protected

Get sub item ids depending on container type that match the preselected object ids.

Parameters

int[]

Definition at line 407 of file class.ilClassificationBlockGUI.php.

References $tree, ilObject\_lookupType(), ilTree\getChilds(), and ilTree\getSubTreeFilteredByObjIds().

                                                     : array
     {
         $tree = $this->tree;
         if (ilObject::_lookupType($this->parent_ref_id, true) == "cat") {
             $matching = array_filter($tree->getChilds($this->parent_ref_id), function ($item) use ($obj_ids) {
                 return in_array($item["obj_id"], $obj_ids);
             });
         } else {
             $fields = array(
                 "object_reference.ref_id"
             ,"object_data.obj_id"
             ,"object_data.type"
             ,"object_data.title"
             ,"object_data.description"
             );
             $matching = $tree->getSubTreeFilteredByObjIds($this->parent_ref_id, $obj_ids, $fields);
         }
 
         return $matching;
     }

Here is the call graph for this function:

◆ initProviders()

ilClassificationBlockGUI::initProviders ( bool $a_check_post = false )

protected

Definition at line 365 of file class.ilClassificationBlockGUI.php.

References $id, $parent_ref_id, $provider, and ilClassificationProvider\getValidProviders().

Referenced by filterContainer(), getAjax(), getHTML(), and toggle().

                                                                 : void
     {
         if (!isset(self::$providers_cache[$this->parent_ref_id])) {
             self::$providers_cache[$this->parent_ref_id] = ilClassificationProvider::getValidProviders(
                 $this->parent_ref_id,
                 $this->parent_obj_id,
                 $this->parent_obj_type
             );
         }
         $this->providers = self::$providers_cache[$this->parent_ref_id];
         if ($a_check_post && !$this->cl_request->getRedraw()) {
             foreach ($this->providers as $provider) {
                 $id = get_class($provider);
                 $current = $provider->importPostData(
                     $this->classification->getSelectionOfProvider($id)
                 );
                 if (is_array($current) || $current) {
                     $this->classification->setSelectionOfProvider($id, $current);
                 }
             }
         }
 
         foreach ($this->providers as $provider) {
             $id = get_class($provider);
             $current = $this->classification->getSelectionOfProvider($id);
             if ($current) {
                 $provider->setSelection($current);
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isRepositoryObject()

ilClassificationBlockGUI::isRepositoryObject ( )

protected

Definition at line 74 of file class.ilClassificationBlockGUI.php.

                                            : bool
     {
         return false;
     }

◆ returnToParent()

ilClassificationBlockGUI::returnToParent ( )

protected

Definition at line 191 of file class.ilClassificationBlockGUI.php.

References ILIAS\Repository\ctrl().

                                        : void
     {
         $this->classification->clearSelection();
         $this->ctrl->returnToParent($this);
     }

Here is the call graph for this function:

◆ toggle()

ilClassificationBlockGUI::toggle ( )

protected

Definition at line 396 of file class.ilClassificationBlockGUI.php.

References ILIAS\Repository\ctrl(), and initProviders().

                                : void
     {
         $this->initProviders(true);
         $this->ctrl->returnToParent($this);
     }

Here is the call graph for this function:

◆ validate()

ilClassificationBlockGUI::validate ( )

protected

Definition at line 197 of file class.ilClassificationBlockGUI.php.

References $providers.

Referenced by getHTML().

                                  : bool
     {
         return sizeof($this->providers);
     }

Here is the caller graph for this function:

Field Documentation

◆ $cl_request

StandardGUIRequest ilClassificationBlockGUI::$cl_request

protected

Definition at line 29 of file class.ilClassificationBlockGUI.php.

◆ $classification

ILIAS Container Classification ClassificationManager ilClassificationBlockGUI::$classification

protected

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

◆ $item_list_gui

array ilClassificationBlockGUI::$item_list_gui

protected

Definition at line 36 of file class.ilClassificationBlockGUI.php.

◆ $obj_definition

ilObjectDefinition ilClassificationBlockGUI::$obj_definition

protected

Definition at line 30 of file class.ilClassificationBlockGUI.php.

Referenced by filterContainer().

◆ $parent_obj_id

int ilClassificationBlockGUI::$parent_obj_id

protected

Definition at line 33 of file class.ilClassificationBlockGUI.php.

◆ $parent_obj_type

string ilClassificationBlockGUI::$parent_obj_type

protected

Definition at line 32 of file class.ilClassificationBlockGUI.php.

◆ $parent_ref_id

int ilClassificationBlockGUI::$parent_ref_id

protected

Definition at line 34 of file class.ilClassificationBlockGUI.php.

Referenced by initProviders().

◆ $providers

array ilClassificationBlockGUI::$providers

protected

Definition at line 35 of file class.ilClassificationBlockGUI.php.

Referenced by validate().

◆ $providers_cache

array ilClassificationBlockGUI::$providers_cache

staticprotected

Definition at line 37 of file class.ilClassificationBlockGUI.php.

◆ $tree

ilTree ilClassificationBlockGUI::$tree

protected

Definition at line 31 of file class.ilClassificationBlockGUI.php.

Referenced by filterContainer(), and getSubItemIds().

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

components/ILIAS/Container/Classification/class.ilClassificationBlockGUI.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ executeCommand()

◆ filterContainer()

◆ getAjax()

◆ getBlockType()

◆ getHTML()

◆ getLegacyContent()

◆ getScreenMode()

◆ getSubItemIds()

◆ initProviders()

◆ isRepositoryObject()

◆ returnToParent()

◆ toggle()

◆ validate()

Field Documentation

◆ $cl_request

◆ $classification

◆ $item_list_gui

◆ $obj_definition

◆ $parent_obj_id

◆ $parent_obj_type

◆ $parent_ref_id

◆ $providers

◆ $providers_cache

◆ $tree