ilClassificationProvider Class Reference

Classification provider. More...

Inheritance diagram for ilClassificationProvider:

Collaboration diagram for ilClassificationProvider:

Public Member Functions
	__construct ($a_parent_ref_id, $a_parent_obj_id, $a_parent_obj_type)
	Constructor. More...
	render (array &$a_html, $a_parent_gui)
	Render HTML chunks. More...
	importPostData ($a_saved=null)
	Import post data. More...
	setSelection ($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 ($a_parent_ref_id, $a_parent_obj_id, $a_parent_obj_type)
	Get all valid providers (for parent container) More...
static	isActive ($a_parent_ref_id, $a_parent_obj_id, $a_parent_obj_type)
	Is provider currently active? More...

Protected Member Functions
	init ()
	Instance initialisation. More...

Protected Attributes
	$parent_ref_id
	$parent_obj_id
	$parent_type

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

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

Constructor.

Parameters

int	$a_parent_ref_id
int	$a_parent_obj_id
string	$a_parent_obj_type

Returns

self

Reimplemented in ilTaggingClassificationProvider.

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

    {
        $this->parent_ref_id = (int) $a_parent_ref_id;
        $this->parent_obj_id = (int) $a_parent_obj_id;
        $this->parent_type = (string) $a_parent_obj_type;
        
        $this->init();
    }

References init().

Here is the call graph for this function:

Member Function Documentation

getFilteredObjects()

ilClassificationProvider::getFilteredObjects ( )

abstract

Get filtered object ref ids.

Returns

array

Reimplemented in ilTaggingClassificationProvider, and ilTaxonomyClassificationProvider.

getValidProviders()

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

static

Get all valid providers (for parent container)

Parameters

int	$a_parent_ref_id
int	$a_parent_obj_id
string	$a_parent_obj_type

Returns

array

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

    {
        $res = array();
        
        include_once "Services/Taxonomy/classes/class.ilTaxonomyClassificationProvider.php";
        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);
        }
        
        include_once "Services/Tagging/classes/class.ilTaggingClassificationProvider.php";
        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;
    }

References $res, ilTaggingClassificationProvider\isActive(), and ilTaxonomyClassificationProvider\isActive().

Referenced by ilContainer\getSubItems(), ilClassificationBlockGUI\initProviders(), and ilContainer\isClassificationFilterActive().

Here is the call graph for this function:

Here is the caller graph for this function:

importPostData()

ilClassificationProvider::importPostData (   $a_saved = null )

abstract

Import post data.

Parameters

mixed

$a_saved

Returns

mixed

Reimplemented in ilTaggingClassificationProvider, and ilTaxonomyClassificationProvider.

init()

ilClassificationProvider::init ( )

protected

Instance initialisation.

Reimplemented in ilTaggingClassificationProvider.

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

    {
    }

Referenced by __construct().

Here is the caller graph for this function:

initListGUI()

ilClassificationProvider::initListGUI

(

ilObjectListGUI

$a_list_gui

)

Init list gui properties.

Parameters

ilObjectListGUI

$a_list_gui

Reimplemented in ilTaggingClassificationProvider.

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

    {
    }

isActive()

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

staticabstract

Is provider currently active?

Parameters

int	$a_parent_ref_id
int	$a_parent_obj_id
string	$a_parent_obj_type

Returns

bool

Reimplemented in ilTaggingClassificationProvider, and ilTaxonomyClassificationProvider.

render()

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

abstract

Render HTML chunks.

Parameters

array	$a_html
object	$a_parent_gui

Reimplemented in ilTaggingClassificationProvider, and ilTaxonomyClassificationProvider.

setSelection()

ilClassificationProvider::setSelection (   $a_value )

abstract

Set selection.

Parameters

mixed

$a_value

Reimplemented in ilTaggingClassificationProvider, and ilTaxonomyClassificationProvider.

Field Documentation

$parent_obj_id

ilClassificationProvider::$parent_obj_id

protected

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

$parent_ref_id

ilClassificationProvider::$parent_ref_id

protected

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

$parent_type

ilClassificationProvider::$parent_type

protected

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

---

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

• Services/Classification/classes/class.ilClassificationProvider.php