ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
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.
 render (array &$a_html, $a_parent_gui)
 Render HTML chunks.
 importPostData ($a_saved=null)
 Import post data.
 setSelection ($a_value)
 Set selection.
 getFilteredObjects ()
 Get filtered object ref ids.
 initListGUI (ilObjectListGUI $a_list_gui)
 Init list gui properties.

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)
static isActive ($a_parent_ref_id, $a_parent_obj_id, $a_parent_obj_type)
 Is provider currently active?

Protected Member Functions

 init ()
 Instance initialisation.

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

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.

References init().

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

+ Here is the call graph for this function:

Member Function Documentation

ilClassificationProvider::getFilteredObjects ( )
abstract

Get filtered object ref ids.

Returns
array

Reimplemented in ilTaggingClassificationProvider, and ilTaxonomyClassificationProvider.

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.

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

Referenced by ilClassificationBlockGUI\initProviders().

{
$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;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilClassificationProvider::importPostData (   $a_saved = null)
abstract

Import post data.

Parameters
mixed$a_saved
Returns
mixed

Reimplemented in ilTaggingClassificationProvider, and ilTaxonomyClassificationProvider.

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:

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.

{
}
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.

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.

ilClassificationProvider::setSelection (   $a_value)
abstract

Set selection.

Parameters
mixed$a_value

Reimplemented in ilTaggingClassificationProvider, and ilTaxonomyClassificationProvider.

Field Documentation

ilClassificationProvider::$parent_obj_id
protected

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

ilClassificationProvider::$parent_ref_id
protected

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

ilClassificationProvider::$parent_type
protected

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


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