ilDataCollectionStandardField Class Reference

Class ilDataCollectionField. More...

Inheritance diagram for ilDataCollectionStandardField:

Collaboration diagram for ilDataCollectionStandardField:

Public Member Functions
	doRead ()
	doCreate ()
	doUpdate ()
	cloneStructure (ilDataCollectionStandardField $original_record)
	getLocked ()
	isStandardField ()
	isUnique ()
Public Member Functions inherited from ilDataCollectionField
	__construct ($a_id=0)
	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 (ilDataCollectionField $originalField)
	setExportable ($exportable)

Static Public Member Functions
static	_getStandardFieldsAsArray ()
static	_getStandardFields ($table_id)
static	_getAllStandardFieldTitles ()
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_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	PROPERTYID_FORMULA_EXPRESSION = 12
const	PROPERTYID_DISPLAY_COPY_LINK_ACTION_MENU = 13
const	PROPERTYID_LINK_DETAIL_PAGE_TEXT = 14
const	PROPERTYID_LINK_DETAIL_PAGE_MOB = 15
const	PROPERTYID_SUPPORTED_FILE_TYPES = 16
const	VIEW_VIEW = 1
const	EDIT_VIEW = 2
const	FILTER_VIEW = 3
const	EXPORTABLE_VIEW = 4
Protected Member Functions inherited from ilDataCollectionField
	loadDatatype ()
	loadVisibility ()
	loadFilterability ()
	loadViewDefinition ($view)
	loadViewDefinition More...
	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

_getAllStandardFieldTitles()

static ilDataCollectionStandardField::_getAllStandardFieldTitles ( )

static

Returns

array all possible standardfield titles, in all languages (used for excel-import);

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

References ilDataCollectionField\$id, and $ilDB.

Referenced by ilDataCollectionRecordListGUI\getImportFieldsFromTitles().

                                                     {
                global $ilDB;
                $identifiers = '';
                foreach (array('dcl_id', 'dcl_creation_date', 'dcl_last_update', 'dcl_owner', 'dcl_last_edited_by', 'dcl_comments') as $id) {
                        $identifiers .= $ilDB->quote($id, 'text') . ',';
                }
                $identifiers = rtrim($identifiers, ',');
                $sql = $ilDB->query('SELECT value FROM lng_data WHERE identifier IN (' . $identifiers . ')');
                $titles = array();
                while ($rec = $ilDB->fetchAssoc($sql)) {
                        $titles[] = $rec['value'];
                }
                return $titles;
        }

Here is the caller graph for this function:

_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 153 of file class.ilDataCollectionStandardField.php.

References ilDataCollectionField\$datatype, and ilDataCollectionField\$id.

Referenced by ilDataCollectionField\getDatatypeId().

        {
        $datatype = null;
        foreach (self::_getStandardFieldsAsArray() as $fields_data) {
            if ($id == $fields_data['id']) {
                $datatype = $fields_data['datatype_id'];
                break;
            }
        }
        return $datatype;
        }

Here is the caller graph for this function:

_getStandardFields()

static ilDataCollectionStandardField::_getStandardFields (   $table_id )

static

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

References ilDataCollectionField\$table_id.

Referenced by ilDataCollectionTable\getFields().

        {
                $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);
                        $stdFields[] = $field;
                }
                return $stdFields;
        }

Here is the caller graph for this function:

_getStandardFieldsAsArray()

static ilDataCollectionStandardField::_getStandardFieldsAsArray ( )

static

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

References $lng, ilDataCollectionDatatype\INPUTFORMAT_DATETIME, ilDataCollectionDatatype\INPUTFORMAT_NONE, 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),
                    array('id' => 'comments', 'title' => $lng->txt('dcl_comments'), 'description' => $lng->txt('dcl_comments_description'), 'datatype_id' => ilDataCollectionDatatype::INPUTFORMAT_NONE, 'required' => false),
        );
                return $stdfields;
        }

_isStandardField()

static ilDataCollectionStandardField::_isStandardField (   $field_id )

static

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

Referenced by ilDataCollectionRecord\getRecordFieldExportValue(), ilDataCollectionRecord\getRecordFieldFormInput(), ilDataCollectionRecord\getRecordFieldHTML(), ilDataCollectionRecord\getRecordFieldSortingValue(), 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:

cloneStructure()

ilDataCollectionStandardField::cloneStructure

(

ilDataCollectionStandardField

$original_record

)

Parameters

ilDataCollectionStandardField

$original_record

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

References doUpdate(), ilDataCollectionField\getExportable(), getLocked(), ilDataCollectionField\getOrder(), ilDataCollectionField\getRequired(), ilDataCollectionField\isEditable(), ilDataCollectionField\isFilterable(), isUnique(), ilDataCollectionField\isVisible(), ilDataCollectionField\setEditable(), ilDataCollectionField\setExportable(), ilDataCollectionField\setFilterable(), ilDataCollectionField\setLocked(), ilDataCollectionField\setOrder(), ilDataCollectionField\setRequired(), ilDataCollectionField\setUnique(), and ilDataCollectionField\setVisible().

                                                                                       {
                $this->setEditable($original_record->isEditable());
                $this->setLocked($original_record->getLocked());
                $this->setFilterable($original_record->isFilterable());
                $this->setVisible($original_record->isVisible());
                $this->setOrder($original_record->getOrder());
                $this->setRequired($original_record->getRequired());
                $this->setUnique($original_record->isUnique());
                $this->setExportable($original_record->getExportable());

                $this->doUpdate();
        }

Here is the call 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().

Referenced by cloneStructure().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getLocked()

ilDataCollectionStandardField::getLocked

(

)

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

Referenced by cloneStructure().

        {
                return true;
        }

Here is the caller graph for this function:

isStandardField()

ilDataCollectionStandardField::isStandardField

(

)

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

        {
                return true;
        }

isUnique()

ilDataCollectionStandardField::isUnique

(

)

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

Referenced by cloneStructure().

        {
                return false;
        }

Here is the caller graph for this function:

---

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

• Modules/DataCollection/classes/class.ilDataCollectionStandardField.php