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 ()

	fillDataSection ()

Public Member Functions inherited from ilBlockGUI
	getBlockType ()

	__construct ()
	Constructor. More...

	setData ($a_data)
	Set Data. More...

	getData ()
	Get Data. More...

	setPresentation (int $type)
	Set presentation. More...

	getPresentation ()
	Get presentation type. More...

	setBlockId ($a_block_id=0)
	Set Block Id. More...

	getBlockId ()
	Get Block Id. More...

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

	getGuiObject ()
	Get GuiObject. More...

	setTitle ($a_title)
	Set Title. More...

	getTitle ()
	Get Title. More...

	setOffset ($a_offset)
	Set Offset. More...

	getOffset ()
	Get Offset. More...

	correctOffset ()

	setLimit ($a_limit)
	Set Limit. More...

	getLimit ()
	Get Limit. More...

	setEnableEdit ($a_enableedit)
	Set EnableEdit. More...

	getEnableEdit ()
	Get EnableEdit. More...

	setRepositoryMode ($a_repositorymode)
	Set RepositoryMode. More...

	getRepositoryMode ()
	Get RepositoryMode. More...

	setSubtitle ($a_subtitle)
	Set Subtitle. More...

	getSubtitle ()
	Get Subtitle. More...

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

	getRefId ()
	Get Ref Id (only used if isRepositoryObject() is true). More...

	setAdminCommands (bool $a_admincommands)
	Set Administration Commmands. More...

	getAdminCommands ()
	Get Administration Commmands. More...

	setEnableNumInfo ($a_enablenuminfo)
	Set Enable Item Number Info. More...

	getEnableNumInfo ()
	Get Enable Item Number Info. More...

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

	getProperty ($a_property)

	setProperty ($a_property, $a_value)

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

	getNavParameter ()

	getConfigParameter ()

	getMoveParameter ()

	getRowTemplateName ()
	Get Row Template Name. More...

	getRowTemplateDir ()
	Get Row Template Directory. More...

	addBlockCommand (string $a_href, string $a_text, string $a_onclick="")
	Add Block Command. More...

	getBlockCommands ()
	Get Block commands. More...

	getHTML ()
	Get HTML. More...

	fillHeaderCommands ()
	Fill header commands block. More...

	fillHeaderTitleBlock ()
	Fill header title block (title and. More...

	setDataSection ($a_content)
	Call this from overwritten fillDataSection(), if standard row based data is not used. More...

	fillDataSection ()
	Standard implementation for row based data. More...

	fillRow ($a_set)

	fillFooter ()

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

	setPreviousNextLinks ()
	Get previous/next linkbar. More...

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

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

	getHTMLNew ()
	Get HTML. More...

Static Public Member Functions
static	getScreenMode ()

Static Public Member Functions inherited from ilBlockGUI
static	getScreenMode ()
	Get Screen Mode for current command. More...

Protected Member Functions
	isRepositoryObject ()

	returnToParent ()

	validate ()

	filterContainer ()

	initProviders ($a_check_post=false)

	toggle ()
	Toggle. More...

	getLegacyContent ()

	getSubItemIds ($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...

	initCommands ()
	Init commands. More...

	fillRowColor ($a_placeholder="CSS_ROW")

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

	getLegacyContent ()
	Get legacy content. More...

	getViewControls ()
	Get view controls. 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...

	getNoItemFoundContent ()
	No item entry. More...

Protected Attributes
	$obj_definition

	$tree

	$parent_obj_type

	$parent_obj_id

	$parent_ref_id

	$providers

	$item_list_gui

	$repo

	$new_rendering = true

Protected Attributes inherited from ilBlockGUI
	$ui

	$data = array()

	$enablenuminfo = true

	$footer_links = array()

	$block_id = 0

	$allow_moving = true

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

	$block_commands = array()

	$max_count = false

	$close_command = false

	$image = false

	$property = false

	$nav_value = ""

	$css_row = ""

	$title = ""

	$admincommands = false

	$dropdown

	$tpl

	$main_tpl

	$user

	$ctrl

	$access

	$lng

	$obj_def

	$presentation

	$new_rendering = false

Static Protected Attributes
static	$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

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilClassificationBlockGUI::__construct ( )

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

References $_GET, $DIC, ilBlockGUI\$lng, ILIAS\GlobalScreen\Provider\__construct(), ilObject\_lookupObjId(), ilObject\_lookupType(), and ilBlockGUI\setTitle().

     {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->ctrl = $DIC->ctrl();
         $this->obj_definition = $DIC["objDefinition"];
         $this->tree = $DIC->repositoryTree();
         $this->access = $DIC->access();
         $lng = $DIC->language();
         
         parent::__construct();
                             
         $this->parent_ref_id = (int) $_GET["ref_id"];
         $this->parent_obj_id = ilObject::_lookupObjId($this->parent_ref_id);
         $this->parent_obj_type = ilObject::_lookupType($this->parent_obj_id);
         
         $lng->loadLanguageModule("classification");
         $this->setTitle($lng->txt("clsfct_block_title"));
         // @todo: find another solution for this
         //$this->setFooterInfo($lng->txt("clsfct_block_info"));
 
         $this->repo = new ilClassificationSessionRepository($this->parent_ref_id);
     }

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilClassificationBlockGUI::executeCommand ( )

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

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

     {
         $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:

◆ fillDataSection()

ilClassificationBlockGUI::fillDataSection ( )

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

References ilBlockGUI\$ctrl, $ilCtrl, ilBlockGUI\$main_tpl, ilBlockGUI\$tpl, and getBlockType().

Referenced by getLegacyContent().

     {
         $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, "Services/Classification");
             
             foreach ($html as $item) {
                 $btpl->setCurrentBlock("provider_chunk_bl");
                 $btpl->setVariable("TITLE", $item["title"]);
                 $btpl->setVariable("CHUNK", $item["html"]);
                 $btpl->parseCurrentBlock();
             }
 
             $overall_html .= $btpl->get();
             //$this->tpl->setVariable("DATA", $btpl->get());
         }
         return $overall_html;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ filterContainer()

ilClassificationBlockGUI::filterContainer ( )

protected

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

References ilBlockGUI\$access, ilBlockGUI\$lng, $location, ilBlockGUI\$main_tpl, $obj_definition, ilBlockGUI\$tpl, $tree, $type, ilObjectListGUI\CONTEXT_REPOSITORY, exit, getBlockType(), ilUtil\getSystemMessageHTML(), initProviders(), and ilUtil\sortArray().

     {
         $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->repo->isEmpty()) {
             exit();
         }
 
         $all_matching_provider_object_ids = null;
         $no_provider = true;
         foreach ($this->providers as $provider) {
             $id = get_class($provider);
             $current = $this->repo->getValueForProvider($id);
             if ($current) {
                 $no_provider = false;
                 // combine providers AND
                 $provider_object_ids = $provider->getFilteredObjects();
                 if (is_array($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, "Services/Classification");
         
         if (is_array($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();
             
                 // :TODO: not sure if this makes sense...
                 include_once "Services/Object/classes/class.ilObjectListGUIPreloader.php";
                 $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 (!is_array($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 = ilUtil::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 = ilUtil::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";
 
                                 include_once($location . "/class." . $full_class . ".php");
                                 $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>";
             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 137 of file class.ilClassificationBlockGUI.php.

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

     {
         $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 fillDataSection(), and filterContainer().

                                    : string
     {
         return 'clsfct';
     }

Here is the caller graph for this function:

◆ getHTML()

ilClassificationBlockGUI::getHTML ( )

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

References ilBlockGUI\$ctrl, $ilCtrl, ilBlockGUI\$main_tpl, ilBlockGUI\$tpl, initProviders(), and validate().

Referenced by executeCommand(), and getAjax().

     {
         $tpl = $this->main_tpl;
         $ilCtrl = $this->ctrl;
         
         if (!$ilCtrl->isAsynch()) {
 //            $this->repo->unsetAll();
         }
         
         $this->initProviders();
         
         if (!$this->validate()) {
             return "";
         }
         
         $tpl->addJavaScript("Services/Classification/js/ilClassification.js");
                 
         return parent::getHTML();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLegacyContent()

ilClassificationBlockGUI::getLegacyContent ( )

protected

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

References fillDataSection().

                                           : string
     {
         return $this->fillDataSection();
     }

Here is the call graph for this function:

◆ getScreenMode()

static ilClassificationBlockGUI::getScreenMode ( )

static

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

References $DIC, $ilCtrl, and IL_SCREEN_CENTER.

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

◆ getSubItemIds()

ilClassificationBlockGUI::getSubItemIds ( $obj_ids )

protected

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

Parameters

int[]

Returns: array

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

References $tree, and ilObject\_lookupType().

     {
         $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 ( $a_check_post = false )

protected

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

References $parent_ref_id, and ilClassificationProvider\getValidProviders().

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

     {
         if (!isset(self::$providers_cache[$this->parent_ref_id])) {
             include_once "Services/Classification/classes/class.ilClassificationProvider.php";
             self::$providers_cache[$this->parent_ref_id] = ilClassificationProvider::getValidProviders(
                 $this->parent_ref_id,
                 $this->parent_obj_id,
                 $this->parent_obj_typ
             );
         }
         $this->providers = self::$providers_cache[$this->parent_ref_id];
         if ($a_check_post && (bool) !$_REQUEST["rdrw"]) {
             foreach ($this->providers as $provider) {
                 $id = get_class($provider);
                 $current = $provider->importPostData($this->repo->getValueForProvider($id));
                 if (is_array($current) || $current) {
                     $this->repo->setValueForProvider($id, $current);
                 } else {
                     //                              $this->repo->unsetValueForProvider($id);
                 }
             }
         }
         
         foreach ($this->providers as $provider) {
             $id = get_class($provider);
             $current = $this->repo->getValueForProvider($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 77 of file class.ilClassificationBlockGUI.php.

                                             : bool
     {
         return false;
     }

◆ returnToParent()

ilClassificationBlockGUI::returnToParent ( )

protected

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

     {
         $this->repo->unsetAll();
         $this->ctrl->returnToParent($this);
     }

◆ toggle()

ilClassificationBlockGUI::toggle ( )

protected

Toggle.

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

References initProviders().

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

Here is the call graph for this function:

◆ validate()

ilClassificationBlockGUI::validate ( )

protected

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

References $providers.

Referenced by getHTML().

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

Here is the caller graph for this function:

Field Documentation

◆ $item_list_gui

ilClassificationBlockGUI::$item_list_gui

protected

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

◆ $new_rendering

ilClassificationBlockGUI::$new_rendering = true

protected

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

◆ $obj_definition

ilClassificationBlockGUI::$obj_definition

protected

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

Referenced by filterContainer().

◆ $parent_obj_id

ilClassificationBlockGUI::$parent_obj_id

protected

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

◆ $parent_obj_type

ilClassificationBlockGUI::$parent_obj_type

protected

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

◆ $parent_ref_id

ilClassificationBlockGUI::$parent_ref_id

protected

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

Referenced by initProviders().

◆ $providers

ilClassificationBlockGUI::$providers

protected

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

Referenced by validate().

◆ $providers_cache

ilClassificationBlockGUI::$providers_cache

staticprotected

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

◆ $repo

ilClassificationBlockGUI::$repo

protected

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

◆ $tree

ilClassificationBlockGUI::$tree

protected

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

Referenced by filterContainer(), and getSubItemIds().

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

Services/Classification/classes/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()

◆ fillDataSection()

◆ filterContainer()

◆ getAjax()

◆ getBlockType()

◆ getHTML()

◆ getLegacyContent()

◆ getScreenMode()

◆ getSubItemIds()

◆ initProviders()

◆ isRepositoryObject()

◆ returnToParent()

◆ toggle()

◆ validate()

Field Documentation

◆ $item_list_gui

◆ $new_rendering

◆ $obj_definition

◆ $parent_obj_id

◆ $parent_obj_type

◆ $parent_ref_id

◆ $providers

◆ $providers_cache

◆ $repo

◆ $tree