ilClassificationProvider Class Reference

Classification provider. More...

Inheritance diagram for ilClassificationProvider:

Collaboration diagram for ilClassificationProvider:

Public Member Functions
	__construct (int $a_parent_ref_id, int $a_parent_obj_id, string $a_parent_obj_type)
	render (array &$a_html, object $a_parent_gui)
	Render HTML chunks. More...
	importPostData (?array $a_saved=null)
	Import post data. More...
	setSelection (array $a_value)
	Set selection. More...
	getFilteredObjects ()
	Get filtered object ref ids. More...
	initListGUI (ilObjectListGUI $a_list_gui)
	Init list gui properties. More...

Static Public Member Functions
static	getValidProviders (int $a_parent_ref_id, int $a_parent_obj_id, string $a_parent_obj_type)
	Get all valid providers (for parent container) More...
static	isActive (int $a_parent_ref_id, int $a_parent_obj_id, string $a_parent_obj_type)
	Is provider currently active? More...

Protected Member Functions
	init ()

Protected Attributes
int	$parent_ref_id
int	$parent_obj_id
string	$parent_type
RequestInterface	$request

Detailed Description

Classification provider.

Author

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

Definition at line 22 of file class.ilClassificationProvider.php.

Constructor & Destructor Documentation

__construct()

ilClassificationProvider::__construct	(	int	$a_parent_ref_id,
		int	$a_parent_obj_id,
		string	$a_parent_obj_type
	)

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

References $DIC, and init().

      {
        global $DIC;

        $this->request = $DIC->http()->request();
        $this->parent_ref_id = $a_parent_ref_id;
        $this->parent_obj_id = $a_parent_obj_id;
        $this->parent_type = $a_parent_obj_type;

        $this->init();
    }

Here is the call graph for this function:

Member Function Documentation

getFilteredObjects()

ilClassificationProvider::getFilteredObjects ( )

abstract

Get filtered object ref ids.

Referenced by getValidProviders().

Here is the caller graph for this function:

getValidProviders()

static ilClassificationProvider::getValidProviders ( int  $a_parent_ref_id, int  $a_parent_obj_id, string  $a_parent_obj_type  )

static

Get all valid providers (for parent container)

Definition at line 51 of file class.ilClassificationProvider.php.

References $res, getFilteredObjects(), importPostData(), ilTaxonomyClassificationProvider\isActive(), ilTaggingClassificationProvider\isActive(), isActive(), render(), and setSelection().

Referenced by ILIAS\Style\Content\ItemSetManager\applyClassificationFilter(), ilContainer\getSubItems(), ilClassificationBlockGUI\initProviders(), ILIAS\Style\Content\ItemPresentationManager\isClassificationFilterActive(), ILIAS\Style\Content\ItemSetManager\isClassificationFilterActive(), and ilContainer\isClassificationFilterActive().

     : array {
        $res = array();

        if (ilTaxonomyClassificationProvider::isActive($a_parent_ref_id, $a_parent_obj_id, $a_parent_obj_type)) {
            $res[] = new ilTaxonomyClassificationProvider($a_parent_ref_id, $a_parent_obj_id, $a_parent_obj_type);
        }

        if (ilTaggingClassificationProvider::isActive($a_parent_ref_id, $a_parent_obj_id, $a_parent_obj_type)) {
            $res[] = new ilTaggingClassificationProvider($a_parent_ref_id, $a_parent_obj_id, $a_parent_obj_type);
        }

        return $res;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

importPostData()

ilClassificationProvider::importPostData ( ?array  $a_saved = null )

abstract

Import post data.

Parameters

array | null

$a_saved

Referenced by getValidProviders().

Here is the caller graph for this function:

init()

ilClassificationProvider::init ( )

protected

Definition at line 44 of file class.ilClassificationProvider.php.

Referenced by __construct().

                             : void
    {
    }

Here is the caller graph for this function:

initListGUI()

ilClassificationProvider::initListGUI

(

ilObjectListGUI

$a_list_gui

)

Init list gui properties.

Definition at line 102 of file class.ilClassificationProvider.php.

                                                            : void
    {
    }

isActive()

static ilClassificationProvider::isActive ( int  $a_parent_ref_id, int  $a_parent_obj_id, string  $a_parent_obj_type  )

staticabstract

Is provider currently active?

Referenced by getValidProviders().

Here is the caller graph for this function:

render()

ilClassificationProvider::render ( array &  $a_html, object  $a_parent_gui  )

abstract

Render HTML chunks.

Referenced by getValidProviders().

Here is the caller graph for this function:

setSelection()

ilClassificationProvider::setSelection ( array  $a_value )

abstract

Set selection.

Referenced by getValidProviders().

Here is the caller graph for this function:

Field Documentation

$parent_obj_id

int ilClassificationProvider::$parent_obj_id

protected

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

$parent_ref_id

int ilClassificationProvider::$parent_ref_id

protected

Definition at line 24 of file class.ilClassificationProvider.php.

$parent_type

string ilClassificationProvider::$parent_type

protected

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

$request

RequestInterface ilClassificationProvider::$request

protected

Definition at line 27 of file class.ilClassificationProvider.php.

---

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

• components/ILIAS/Container/Classification/class.ilClassificationProvider.php