ilClassificationBlockGUI Class Reference

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 ()
	correctOffset ()
	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="")
	getBlockCommands ()
	getHTML ()
	fillHeaderCommands ()
	fillHeaderTitleBlock ()
	setDataSection (string $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 (array $a_set)
	fillFooter ()
	fillPreviousNext ()
	setPreviousNextLinks ()
	getAsynch ()
	Use this for final get before sending asynchronous output (ajax) per echo to output. More...
	getPaginationViewControl ()
	Fill previous/next row. More...
	getHTMLNew ()
	getNoItemFoundContent ()

Static Public Member Functions
static	getScreenMode ()
static	getScreenMode ()

Protected Member Functions
	isRepositoryObject ()
	Returns whether block has a corresponding repository object. More...
	getLegacyContent ()
	Get legacy content. More...
	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 ()
	fillRowColor (string $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...
	send (string $output)
	Send. More...

Protected Attributes
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
ilClassificationSessionRepository	$repo
bool	$new_rendering = true
Protected Attributes inherited from ilBlockGUI
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
bool	$new_rendering = false

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.

categories

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om @ilCtrl_IsCalledBy ilClassificationBlockGUI: ilColumnGUI

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

Constructor & Destructor Documentation

__construct()

ilClassificationBlockGUI::__construct

(

)

Reimplemented from ilBlockGUI.

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

    {
        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 = $this->requested_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->cl_request = new StandardGUIRequest(
            $DIC->http(),
            $DIC->refinery()
        );
 
        $this->repo = new ilClassificationSessionRepository($this->parent_ref_id);
    }

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

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilClassificationBlockGUI::executeCommand

(

)

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

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

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

Here is the call graph for this function:

filterContainer()

ilClassificationBlockGUI::filterContainer ( )

protected

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

                                        : 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->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 (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, "Services/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();
 
                // :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 (!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";
 
                                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();
    }

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

Here is the call graph for this function:

getAjax()

ilClassificationBlockGUI::getAjax

(

)

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

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

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

Here is the call graph for this function:

getBlockType()

ilClassificationBlockGUI::getBlockType

(

)

Reimplemented from ilBlockGUI.

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

                                  : string
    {
        return 'clsfct';
    }

Referenced by filterContainer(), and getLegacyContent().

Here is the caller graph for this function:

getHTML()

ilClassificationBlockGUI::getHTML

(

)

Reimplemented from ilBlockGUI.

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

                             : string
    {
        $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();
    }

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

Referenced by executeCommand(), and getAjax().

Here is the call graph for this function:

Here is the caller graph for this function:

getLegacyContent()

ilClassificationBlockGUI::getLegacyContent ( )

protected

Get legacy content.

Returns

string

Reimplemented from ilBlockGUI.

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

                                         : 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, "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;
    }

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

Here is the call graph for this function:

getScreenMode()

static ilClassificationBlockGUI::getScreenMode ( )

static

Reimplemented from ilBlockGUI.

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

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

References $DIC, and IL_SCREEN_CENTER.

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 412 of file class.ilClassificationBlockGUI.php.

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

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

Here is the call graph for this function:

initProviders()

ilClassificationBlockGUI::initProviders ( bool  $a_check_post = false )

protected

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

                                                                : void
    {
        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_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->repo->getValueForProvider($id));
                if (is_array($current) || $current) {
                    $this->repo->setValueForProvider($id, $current);
                }
            }
        }
 
        foreach ($this->providers as $provider) {
            $id = get_class($provider);
            $current = $this->repo->getValueForProvider($id);
            if ($current) {
                $provider->setSelection($current);
            }
        }
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

isRepositoryObject()

ilClassificationBlockGUI::isRepositoryObject ( )

protected

Returns whether block has a corresponding repository object.

Reimplemented from ilBlockGUI.

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

                                           : bool
    {
        return false;
    }

returnToParent()

ilClassificationBlockGUI::returnToParent ( )

protected

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

                                       : void
    {
        $this->repo->unsetAll();    // this resets, e.g. the taxonomy selection before showing the parent container
        $this->ctrl->returnToParent($this);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

toggle()

ilClassificationBlockGUI::toggle ( )

protected

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

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

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

Here is the call graph for this function:

validate()

ilClassificationBlockGUI::validate ( )

protected

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

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

References $providers.

Referenced by getHTML().

Here is the caller graph for this function:

Field Documentation

$cl_request

StandardGUIRequest ilClassificationBlockGUI::$cl_request

protected

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

$item_list_gui

array ilClassificationBlockGUI::$item_list_gui

protected

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

$new_rendering

bool ilClassificationBlockGUI::$new_rendering = true

protected

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

$obj_definition

ilObjectDefinition ilClassificationBlockGUI::$obj_definition

protected

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

Referenced by filterContainer().

$parent_obj_id

int ilClassificationBlockGUI::$parent_obj_id

protected

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

$parent_obj_type

string ilClassificationBlockGUI::$parent_obj_type

protected

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

$parent_ref_id

int ilClassificationBlockGUI::$parent_ref_id

protected

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

Referenced by initProviders().

$providers

array ilClassificationBlockGUI::$providers

protected

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

Referenced by validate().

$providers_cache

array ilClassificationBlockGUI::$providers_cache

staticprotected

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

$repo

ilClassificationSessionRepository ilClassificationBlockGUI::$repo

protected

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

$tree

ilTree ilClassificationBlockGUI::$tree

protected

Definition at line 27 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