Inheritance diagram for ilDataCollectionStandardField:

Collaboration diagram for ilDataCollectionStandardField:

Public Member Functions
	doRead ()

	doCreate ()

	doUpdate ()

	getLocked ()

	isStandardField ()

	isUnique ()

Public Member Functions inherited from ilDataCollectionField
	__construct ($a_id=0)
	Constructor public. More...

	setId ($a_id)
	Set field id. More...

	getId ()
	Get field id. More...

	setTableId ($a_id)
	Set table id. More...

	getTableId ()
	Get table id. More...

	setTitle ($a_title)
	Set title. More...

	getTitle ()
	Get title. More...

	setDescription ($a_desc)
	Set description. More...

	getDescription ()
	Get description. More...

	setDatatypeId ($a_id)
	Set datatype id. More...

	getDatatypeId ()
	Get datatype_id. More...

	setRequired ($a_required)
	Set Required. More...

	getRequired ()
	Get Required Required. More...

	setPropertyvalue ($a_value, $a_id)
	Set Property Value. More...

	isUnique ()

	setUnique ($unique)

	getPropertyvalues ()
	Get Property Values. More...

	setVisible ($visible)
	setVisible More...

	setFilterable ($filterable)
	setFilterable More...

	getDatatype ()

	getLength ()

	getTextArea ()

	getLearningProgress ()

	getDatatypeTitle ()

	getStorageLocation ()

	isVisible ()

	isFilterable ()

	isEditable ()
	isEditable More...

	setEditable ($editable)

	getExportable ()

	toArray ()

	isStandardField ()

	doRead ()
	Read field. More...

	buildFromDBRecord ($rec)

	doCreate ()
	Create new field. More...

	doUpdate ()
	Update field. More...

	getFilterable ()

	doDelete ()

	getOrder ()

	setOrder ($order)

	getFieldRef ()

	getFieldReflist ()

	isNRef ()

	getProperties ()
	Get all properties of a field. More...

	setProperties ($data)

	setLocked ($locked)

	getLocked ()

	checkValidity ($value, $record_id=null)

	cloneStructure ($original_id)

	cloneProperties ($originalField)

	setExportable ($exportable)

Static Public Member Functions
static	_getStandardFieldsAsArray ()

static	_getStandardFields ($table_id)

static	_isStandardField ($field_id)

static	_getDatatypeForId ($id)
	gives you the datatype id of a specified standard field. More...

Static Public Member Functions inherited from ilDataCollectionField
static	_getTitleValidChars ($a_as_regex=true)
	All valid chars for filed titles. More...

static	_getFieldIdByTitle ($title, $table_id)

Additional Inherited Members
Data Fields inherited from ilDataCollectionField
const	PROPERTYID_LENGTH = 1

const	PROPERTYID_REGEX = 2

const	PROPERTYID_REFERENCE = 3

const	PROPERTYID_REFERENCELIST = 11

const	PROPERTYID_URL = 4
	LINK OR EMAIL! More...

const	PROPERTYID_TEXTAREA = 5

const	PROPERTYID_REFERENCE_LINK = 6

const	PROPERTYID_WIDTH = 7

const	PROPERTYID_HEIGHT = 8

const	PROPERTYID_LEARNING_PROGRESS = 9

const	PROPERTYID_ILIAS_REFERENCE_LINK = 10

const	PROPERTYID_N_REFERENCE = 11

const	VIEW_VIEW = 1

const	EDIT_VIEW = 2

const	FILTER_VIEW = 3

const	EXPORTABLE_VIEW = 4

Protected Member Functions inherited from ilDataCollectionField
	updateProperties ()
	Update properties of this field in Database. More...

	updateVisibility ()

	updateFilterability ()

	updateEditability ()

	updateExportability ()

Protected Attributes inherited from ilDataCollectionField
	$id

	$table_id

	$title

	$description

	$datatypeId

	$required

	$order

	$unique

	$visible

	$editable

	$filterable

	$locked

	$property = array()

	$exportable

	$datatype

Detailed Description

Class ilDataCollectionField.

Author: Martin Studer ms@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Marcel Raimann mr@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version: $Id:

Definition at line 18 of file class.ilDataCollectionStandardField.php.

Member Function Documentation

◆ _getDatatypeForId()

static ilDataCollectionStandardField::_getDatatypeForId ( $id )

static

gives you the datatype id of a specified standard field.

Parameters

$id	the id of the standardfield eg. "create_date"

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

References ilDataCollectionField\$id, ilDataCollectionDatatype\INPUTFORMAT_DATETIME, ilDataCollectionDatatype\INPUTFORMAT_NUMBER, and ilDataCollectionDatatype\INPUTFORMAT_TEXT.

Referenced by ilDataCollectionField\getDatatypeId().

         {
                 switch($id)
                 {
                         case 'id':
                                 return ilDataCollectionDatatype::INPUTFORMAT_NUMBER;
                         case 'owner';
                                 return ilDataCollectionDatatype::INPUTFORMAT_TEXT;
                         case 'create_date':
                                 return ilDataCollectionDatatype::INPUTFORMAT_DATETIME;
                         case 'last_edit_by':
                                 return ilDataCollectionDatatype::INPUTFORMAT_TEXT;
                         case 'table_id':
                                 return ilDataCollectionDatatype::INPUTFORMAT_NUMBER;
                         case 'last_update':
                                 return ilDataCollectionDatatype::INPUTFORMAT_DATETIME;
                 }
                 return NULL;
         }

Here is the caller graph for this function:

◆ _getStandardFields()

static ilDataCollectionStandardField::_getStandardFields ( $table_id )

static

Definition at line 81 of file class.ilDataCollectionStandardField.php.

References ilDataCollectionField\$table_id.

Referenced by ilDataCollectionTable\getFields(), and ilDataCollectionTable\getStandardFields().

         {
                 $stdFields = array();
                 foreach(self::_getStandardFieldsAsArray() as $array)
                 {
                         $array["table_id"] = $table_id;
                         $array["datatype_id"] = self::_getDatatypeForId($array["id"]);
                         $field = new ilDataCollectionStandardField();
                         $field->buildFromDBRecord($array);
                         array_push($stdFields, $field);
                 }
                 return $stdFields;
         }

Here is the caller graph for this function:

◆ _getStandardFieldsAsArray()

static ilDataCollectionStandardField::_getStandardFieldsAsArray ( )

static

Definition at line 63 of file class.ilDataCollectionStandardField.php.

References $lng, ilDataCollectionDatatype\INPUTFORMAT_DATETIME, ilDataCollectionDatatype\INPUTFORMAT_NUMBER, and ilDataCollectionDatatype\INPUTFORMAT_TEXT.

         {
 
                 //TODO: this isn't particularly pretty especially as $lng is used in the model. On the long run the standard fields should be refactored into "normal" fields.
                 global $lng;
                 $stdfields = array(
                         array("id"=>"id", "title" => $lng->txt("dcl_id"), "description" => $lng->txt("dcl_id_description"), "datatype_id" => ilDataCollectionDatatype::INPUTFORMAT_NUMBER, "required" => true),
                         array("id"=>"create_date", "title" => $lng->txt("dcl_creation_date"), "description" => $lng->txt("dcl_creation_date_description"), "datatype_id" => ilDataCollectionDatatype::INPUTFORMAT_DATETIME, "required" => true),
                         array("id"=>"last_update", "title" => $lng->txt("dcl_last_update"), "description" => $lng->txt("dcl_last_update_description"), "datatype_id" => ilDataCollectionDatatype::INPUTFORMAT_DATETIME, "required" => true),
                         array("id"=>"owner", "title" => $lng->txt("dcl_owner"), "description" => $lng->txt("dcl_owner_description"), "datatype_id" => ilDataCollectionDatatype::INPUTFORMAT_TEXT, "required" => true),
                         array("id"=>"last_edit_by", "title" => $lng->txt("dcl_last_edited_by"), "description" => $lng->txt("dcl_last_edited_by_description"), "datatype_id" => ilDataCollectionDatatype::INPUTFORMAT_TEXT, "required" => true)
                 );
                 return $stdfields;
         }

◆ _isStandardField()

static ilDataCollectionStandardField::_isStandardField ( $field_id )

static

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

Referenced by ilDataCollectionRecord\getRecordFieldExportValue(), ilDataCollectionRecord\getRecordFieldFormInput(), ilDataCollectionRecord\getRecordFieldHTML(), ilDataCollectionRecord\getRecordFieldSingleHTML(), ilDataCollectionRecord\getRecordFieldValue(), and ilDataCollectionRecord\setRecordFieldValue().

         {
                 $return = false;
                 foreach(self::_getStandardFieldsAsArray() as $field)
                 {
                         if($field["id"] == $field_id)
                         {
                                 $return = true;
                         }
                 }
                         
                 return $return;
         }

Here is the caller graph for this function:

◆ doCreate()

ilDataCollectionStandardField::doCreate ( )

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

References $ilLog, and ilUtil\sendFailure().

         {
                 global $ilLog;
                 $message = "Standard fields cannot be written to DB";
                 ilUtil::sendFailure($message);
                 $ilLog->write("[ilDataCollectionStandardField] ".$message);
         }

Here is the call graph for this function:

◆ doRead()

ilDataCollectionStandardField::doRead ( )

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

References $ilLog, and ilUtil\sendFailure().

         {
                 global $ilLog;
                 $message = "Standard fields cannot be read from DB";
                 ilUtil::sendFailure($message);
                 $ilLog->write("[ilDataCollectionStandardField] ".$message);
         }

Here is the call graph for this function:

◆ doUpdate()

ilDataCollectionStandardField::doUpdate ( )

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

References ilDataCollectionField\updateExportability(), ilDataCollectionField\updateFilterability(), and ilDataCollectionField\updateVisibility().

         {
                 $this->updateVisibility();
                 $this->updateFilterability();
                 $this->updateExportability();
         }

Here is the call graph for this function:

◆ getLocked()

ilDataCollectionStandardField::getLocked ( )

Definition at line 55 of file class.ilDataCollectionStandardField.php.

         {
                 return true;
         }

◆ isStandardField()

ilDataCollectionStandardField::isStandardField ( )

Definition at line 139 of file class.ilDataCollectionStandardField.php.

         {
                 return true;
         }

◆ isUnique()

ilDataCollectionStandardField::isUnique ( )

Definition at line 147 of file class.ilDataCollectionStandardField.php.

         {
                 return false;
         }

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

Modules/DataCollection/classes/class.ilDataCollectionStandardField.php

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _getDatatypeForId()

◆ _getStandardFields()

◆ _getStandardFieldsAsArray()

◆ _isStandardField()

◆ doCreate()

◆ doRead()

◆ doUpdate()

◆ getLocked()

◆ isStandardField()

◆ isUnique()