ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
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

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

27 {
28 $this->parent_ref_id = (int)$a_parent_ref_id;
29 $this->parent_obj_id = (int)$a_parent_obj_id;
30 $this->parent_type = (string)$a_parent_obj_type;
31
32 $this->init();
33 }

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 51 of file class.ilClassificationProvider.php.

52 {
53 $res = array();
54
55 include_once "Services/Taxonomy/classes/class.ilTaxonomyClassificationProvider.php";
56 if(ilTaxonomyClassificationProvider::isActive($a_parent_ref_id, $a_parent_obj_id, $a_parent_obj_type))
57 {
58 $res[] = new ilTaxonomyClassificationProvider($a_parent_ref_id, $a_parent_obj_id, $a_parent_obj_type);
59 }
60
61 include_once "Services/Tagging/classes/class.ilTaggingClassificationProvider.php";
62 if(ilTaggingClassificationProvider::isActive($a_parent_ref_id, $a_parent_obj_id, $a_parent_obj_type))
63 {
64 $res[] = new ilTaggingClassificationProvider($a_parent_ref_id, $a_parent_obj_id, $a_parent_obj_type);
65 }
66
67 return $res;
68 }
static isActive($a_parent_ref_id, $a_parent_obj_id, $a_parent_obj_type)
Is provider currently active?
static isActive($a_parent_ref_id, $a_parent_obj_id, $a_parent_obj_type)
Is provider currently active?

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

Referenced by ilClassificationBlockGUI\initProviders().

+ 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.

39 {
40
41 }

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 116 of file class.ilClassificationProvider.php.

117 {
118
119 }

◆ 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: