ilDclDatatype Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilDclDatatype:

Public Member Functions
	__construct (int $a_id=0)
	Constructor public. More...
	getId ()
	setTitle (string $a_title)
	getTitle ()
	setStorageLocation (int $a_id)
	Set Storage Location. More...
	getStorageLocation ()
	Get Storage Location. More...
	getDbType ()
	doRead ()
	Read Datatype. More...

Static Public Member Functions
static	getAllDatatype (bool $force=false)
	Get all possible Datatypes. More...

Data Fields
const	INPUTFORMAT_NONE = 0
const	INPUTFORMAT_NUMBER = 1
const	INPUTFORMAT_TEXT = 2
const	INPUTFORMAT_REFERENCE = 3
const	INPUTFORMAT_BOOLEAN = 4
const	INPUTFORMAT_DATETIME = 5
const	INPUTFORMAT_FILE = 6
const	INPUTFORMAT_RATING = 7
const	INPUTFORMAT_ILIAS_REF = 8
const	INPUTFORMAT_MOB = 9
const	INPUTFORMAT_REFERENCELIST = 10
const	INPUTFORMAT_FORMULA = 11
const	INPUTFORMAT_PLUGIN = 12
const	INPUTFORMAT_TEXT_SELECTION = 14
const	INPUTFORMAT_DATE_SELECTION = 15

Static Public Attributes
static array	$datatype_cache = []

Protected Member Functions
	loadDatatype (array $rec)

Protected Attributes
int	$id = 0
string	$title = ""
int	$storageLocation = 0
string	$dbType

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Definition at line 19 of file class.ilDclDatatype.php.

Constructor & Destructor Documentation

__construct()

ilDclDatatype::__construct

(

int

$a_id = 0

)

Constructor public.

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

References doRead().

    {
        if ($a_id != 0) {
            $this->id = $a_id;
            $this->doRead();
        }
    }

Here is the call graph for this function:

Member Function Documentation

doRead()

ilDclDatatype::doRead

(

)

Read Datatype.

Definition at line 98 of file class.ilDclDatatype.php.

References $DIC, $ilDB, $query, getId(), and loadDatatype().

Referenced by __construct().

                            : void
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $query = "SELECT * FROM il_dcl_datatype WHERE id = " . $ilDB->quote(
            $this->getId(),
            "integer"
        ) . " ORDER BY sort";
        $set = $ilDB->query($query);
        $rec = $ilDB->fetchAssoc($set);

        $this->loadDatatype($rec);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAllDatatype()

static ilDclDatatype::getAllDatatype ( bool  $force = false )

static

Get all possible Datatypes.

Definition at line 116 of file class.ilDclDatatype.php.

References $DIC, $ilDB, $query, ilDclFieldTypePlugin\getPluginId(), and ilDclFieldTypePlugin\isPluginDatatype().

Referenced by ilDclFieldEditGUI\__construct(), ilDclFieldListTableGUI\fillRowFromObject(), ilDclCache\getDatatype(), ilDclTableView\getFieldSettings(), ilDataCollectionDataSet\getXmlNamespace(), ilDclFieldEditGUI\initForm(), ilDclFieldTypePlugin\install(), and ilDclTable\loadCustomFields().

                                                              : array
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        if (self::$datatype_cache == null) {
            self::$datatype_cache = array();

            $query = "SELECT * FROM il_dcl_datatype ORDER BY sort";
            $set = $ilDB->query($query);

            while ($rec = $ilDB->fetchAssoc($set)) {
                $instance = new ilDclDatatype();
                $instance->loadDatatype($rec);

                if (
                    $force ||
                    !ilDclFieldTypePlugin::isPluginDatatype($instance->getTitle()) ||
                    $DIC['component.repository']->hasActivatedPlugin(ilDclFieldTypePlugin::getPluginId($instance->getTitle()))
                ) {
                    self::$datatype_cache[$rec['id']] = $instance;
                }

            }
        }

        return self::$datatype_cache;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDbType()

ilDclDatatype::getDbType

(

)

Definition at line 90 of file class.ilDclDatatype.php.

References $dbType.

                               : string
    {
        return $this->dbType;
    }

getId()

ilDclDatatype::getId

(

)

Definition at line 59 of file class.ilDclDatatype.php.

References $id.

Referenced by doRead().

                           : int
    {
        return $this->id;
    }

Here is the caller graph for this function:

getStorageLocation()

ilDclDatatype::getStorageLocation

(

)

Get Storage Location.

Definition at line 85 of file class.ilDclDatatype.php.

References $storageLocation.

                                        : int
    {
        return $this->storageLocation;
    }

getTitle()

ilDclDatatype::getTitle

(

)

Definition at line 69 of file class.ilDclDatatype.php.

References $title.

                              : string
    {
        return $this->title;
    }

loadDatatype()

ilDclDatatype::loadDatatype ( array  $rec )

protected

Definition at line 145 of file class.ilDclDatatype.php.

References setStorageLocation(), and setTitle().

Referenced by doRead().

                                               : void
    {
        $this->id = $rec['id'];
        $this->dbType = $rec["ildb_type"];

        $this->setTitle($rec["title"]);
        $this->setStorageLocation($rec["storage_location"]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setStorageLocation()

ilDclDatatype::setStorageLocation

(

int

$a_id

)

Set Storage Location.

Definition at line 77 of file class.ilDclDatatype.php.

Referenced by loadDatatype().

                                                 : void
    {
        $this->storageLocation = $a_id;
    }

Here is the caller graph for this function:

setTitle()

ilDclDatatype::setTitle

(

string

$a_title

)

Definition at line 64 of file class.ilDclDatatype.php.

Referenced by loadDatatype().

                                             : void
    {
        $this->title = $a_title;
    }

Here is the caller graph for this function:

Field Documentation

$datatype_cache

array ilDclDatatype::$datatype_cache = []

static

Definition at line 45 of file class.ilDclDatatype.php.

$dbType

string ilDclDatatype::$dbType

protected

Definition at line 41 of file class.ilDclDatatype.php.

Referenced by getDbType().

$id

int ilDclDatatype::$id = 0

protected

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

Referenced by getId().

$storageLocation

int ilDclDatatype::$storageLocation = 0

protected

Definition at line 40 of file class.ilDclDatatype.php.

Referenced by getStorageLocation().

$title

string ilDclDatatype::$title = ""

protected

Definition at line 39 of file class.ilDclDatatype.php.

Referenced by getTitle().

INPUTFORMAT_BOOLEAN

const ilDclDatatype::INPUTFORMAT_BOOLEAN = 4

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

INPUTFORMAT_DATE_SELECTION

const ilDclDatatype::INPUTFORMAT_DATE_SELECTION = 15

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

INPUTFORMAT_DATETIME

const ilDclDatatype::INPUTFORMAT_DATETIME = 5

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

Referenced by ilDclStandardField\_getStandardFieldsAsArray(), ilDclReferenceFieldRepresentation\getInputField(), ilDclStandardField\getRecordQueryFilterObject(), and ilDataCollectionDataSet\getXmlNamespace().

INPUTFORMAT_FILE

const ilDclDatatype::INPUTFORMAT_FILE = 6

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

Referenced by ilDclReferenceFieldModel\allowFilterInListView(), ilDclBaseRecordModel\doDelete(), ilDclReferenceFieldRepresentation\getInputField(), ilDataCollectionExporter\getXmlExportHeadDependencies(), and ilDataCollectionDataSet\getXmlNamespace().

INPUTFORMAT_FORMULA

const ilDclDatatype::INPUTFORMAT_FORMULA = 11

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

INPUTFORMAT_ILIAS_REF

const ilDclDatatype::INPUTFORMAT_ILIAS_REF = 8

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

Referenced by ilDclReferenceFieldRepresentation\getInputField(), and ilDataCollectionDataSet\getXmlNamespace().

INPUTFORMAT_MOB

const ilDclDatatype::INPUTFORMAT_MOB = 9

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

Referenced by ilDclReferenceFieldModel\allowFilterInListView(), ilDclBaseRecordModel\doDelete(), ilDclReferenceFieldRepresentation\getInputField(), ilDataCollectionExporter\getXmlExportHeadDependencies(), ilDataCollectionDataSet\getXmlNamespace(), and ilDataCollectionDBUpdateSteps\step_8().

INPUTFORMAT_NONE

const ilDclDatatype::INPUTFORMAT_NONE = 0

Definition at line 21 of file class.ilDclDatatype.php.

Referenced by ilDclRecordEditGUI\setFormValues().

INPUTFORMAT_NUMBER

const ilDclDatatype::INPUTFORMAT_NUMBER = 1

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

Referenced by ilDclStandardField\_getStandardFieldsAsArray(), ilDclStandardField\getRecordQueryFilterObject(), ilDclBaseFieldModel\hasNumericSorting(), and ilDclCreateViewDefinitionGUI\postOutputProcessing().

INPUTFORMAT_PLUGIN

const ilDclDatatype::INPUTFORMAT_PLUGIN = 12

Deprecated:

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

Referenced by ilDataCollectionDBUpdateSteps\step_12().

INPUTFORMAT_RATING

const ilDclDatatype::INPUTFORMAT_RATING = 7

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

INPUTFORMAT_REFERENCE

const ilDclDatatype::INPUTFORMAT_REFERENCE = 3

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

Referenced by ilDclReferenceFieldRepresentation\buildFieldCreationInput(), ilDclBaseFieldModel\cloneProperties(), ilDclDetailedViewDefinition\getAvailablePlaceholders(), ilDclCreateViewDefinition\getAvailablePlaceholders(), ilDclEditViewDefinition\getAvailablePlaceholders(), and ilDataCollectionDataSet\getXmlNamespace().

INPUTFORMAT_REFERENCELIST

const ilDclDatatype::INPUTFORMAT_REFERENCELIST = 10

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

Referenced by ilDataCollectionDataSet\getXmlNamespace().

INPUTFORMAT_TEXT

const ilDclDatatype::INPUTFORMAT_TEXT = 2

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

Referenced by ilDclStandardField\_getStandardFieldsAsArray(), ilDclReferenceFieldRepresentation\getInputField(), ilDclStandardField\getRecordQueryFilterObject(), ilDataCollectionDataSet\getXmlNamespace(), ilDataCollectionDBUpdateSteps\step_8(), and ilDataCollectionDBUpdateSteps\step_9().

INPUTFORMAT_TEXT_SELECTION

const ilDclDatatype::INPUTFORMAT_TEXT_SELECTION = 14

Definition at line 35 of file class.ilDclDatatype.php.

---

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

• Modules/DataCollection/classes/Fields/Base/class.ilDclDatatype.php