ilDclStandardField Class Reference

Class ilDclBaseFieldModel. More...

Inheritance diagram for ilDclStandardField:

Collaboration diagram for ilDclStandardField:

Public Member Functions
	doRead ()
	doCreate ()
	doUpdate ()
	cloneStructure ($original_record)
	getLocked ()
	isStandardField ()
	isUnique ()
	getRecordQuerySortObject ($direction="asc", $sort_by_status=false)
	Returns a query-object for building the record-loader-sql-query. More...
	getRecordQueryFilterObject ($filter_value="", ilDclBaseFieldModel $sort_field=null)
	Returns a query-object for building the record-loader-sql-query. More...
	getSortField ()
	hasNumericSorting ()
	allowFilterInListView ()
	fillHeaderExcel (ilExcel $worksheet, &$row, &$col)
	getValueFromExcel ($excel, $row, $col)
	afterClone ($records)
Public Member Functions inherited from ilDclBaseFieldModel
	__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...
	isUnique ()
	setUnique ($unique)
	getDatatype ()
	getDatatypeTitle ()
	getStorageLocation ()
	Get storage location for the model. More...
	getExportable ()
	toArray ()
	isStandardField ()
	doRead ()
	Read field. More...
	buildFromDBRecord ($rec)
	Builds model from db record. More...
	doCreate ()
	Create new field. More...
	doUpdate ()
	Update field. More...
	updateProperties ()
	Update properties of this field in Database. More...
	doDelete ()
	Remove field and properties. More...
	getViewSettings ()
	getViewSetting (int $tableview_id)
	getOrder ()
	setOrder ($order)
	hasProperty ($key)
	Checks if a certain property for a field is set. More...
	getProperty ($key)
	Returns a certain property of a field. More...
	getPropertyInstance ($key)
	Return ActiveRecord of property. More...
	setProperty ($key, $value)
	Set a property for a field (does not save) More...
	getValidFieldProperties ()
	Returns all valid properties for a field-type. More...
	checkValidityFromForm (ilPropertyFormGUI &$form, $record_id=null)
	checkValidity ($value, $record_id=null)
	Check if input is valid. More...
	cloneStructure ($original_id)
	afterClone ($records)
	cloneProperties (ilDclBaseFieldModel $originalField)
	setExportable ($exportable)
	allowFilterInListView ()
	getRecordQuerySortObject ($direction="asc", $sort_by_status=false)
	Returns a query-object for building the record-loader-sql-query. More...
	getRecordQueryFilterObject ($filter_value="", ilDclBaseFieldModel $sort_field=null)
	Returns a query-object for building the record-loader-sql-query. More...
	getSortField ()
	Returns the sort-field id. More...
	hasNumericSorting ()
	Set to true, when the sorting should be handled numerical. More...
	checkFieldCreationInput (ilPropertyFormGUI $form)
	Checks input of specific fields befor saving. More...
	getStorageLocationOverride ()
	setStorageLocationOverride ($storage_location_override)
	fillHeaderExcel (ilExcel $worksheet, &$row, &$col)
	checkTitlesForImport (array &$titles, array &$import_fields)
	storePropertiesFromForm (ilPropertyFormGUI $form)
	called when saving the 'edit field' form More...
	fillPropertiesForm (ilPropertyFormGUI &$form)
	called to fill the 'edit field' form More...
	isConfirmationRequired (ilPropertyFormGUI $form)
	called by ilDclFieldEditGUI when updating field properties if you overwrite this method, remember to also overwrite getConfirmationGUI More...
	getConfirmationGUI (ilPropertyFormGUI $form)
	called by ilDclFieldEditGUI if isConfirmationRequired returns true More...

Static Public Member Functions
static	_getStandardFieldsAsArray ()
static	_getStandardFields ($table_id)
static	_getNonImportableStandardFieldTitles ()
static	_getImportableStandardFieldTitle ()
static	_isStandardField ($field_id)
static	_getDatatypeForId ($id)
	gives you the datatype id of a specified standard field. More...
Static Public Member Functions inherited from ilDclBaseFieldModel
static	_getTitleInvalidChars ($a_as_regex=true)
	All valid chars for filed titles. More...
static	_getFieldIdByTitle ($title, $table_id)

Additional Inherited Members
Data Fields inherited from ilDclBaseFieldModel
const	PROP_LENGTH = "lenght"
	General properties. More...
const	PROP_REGEX = "regex"
const	PROP_REFERENCE = "table_id"
const	PROP_URL = "url"
const	PROP_TEXTAREA = "text_area"
const	PROP_REFERENCE_LINK = "reference_link"
const	PROP_WIDTH = "width"
const	PROP_HEIGHT = "height"
const	PROP_LEARNING_PROGRESS = "learning_progress"
const	PROP_ILIAS_REFERENCE_LINK = "ILIAS_reference_link"
const	PROP_N_REFERENCE = "multiple_selection"
const	PROP_FORMULA_EXPRESSION = "expression"
const	PROP_DISPLAY_COPY_LINK_ACTION_MENU = "display_action_menu"
const	PROP_LINK_DETAIL_PAGE_TEXT = "link_detail_page"
const	PROP_SUPPORTED_FILE_TYPES = "supported_file_types"
const	PROP_PLUGIN_HOOK_NAME = "plugin_hook_name"
const	PROP_TEXT_SELECTION_OPTIONS = "text_selection_options"
const	PROP_TEXT_SELECTION_TYPE = "text_selection_type"
const	PROP_DATE_SELECTION_OPTIONS = "date_selection_options"
const	PROP_DATE_SELECTION_TYPE = "date_selection_type"
const	EDIT_VIEW = 2
const	EXPORTABLE_VIEW = 4
Protected Member Functions inherited from ilDclBaseFieldModel
	loadDatatype ()
	Load datatype for model. More...
	loadTableFieldSetting ()
	loadTableFieldSetting More...
	addToTableViews ()
	create ilDclTableViewFieldSettings for this field in each tableview More...
	updateTableFieldSetting ()
	update exportable and fieldorder More...
	loadProperties ()
	Get all properties of a field. More...
	normalizeValue ($value)
Protected Attributes inherited from ilDclBaseFieldModel
	$id
	$table_id
	$title
	$description
	$datatypeId
	$order
	$unique
	$property = array()
	$exportable
	$datatype
	$storage_location_override = null

Detailed Description

Class ilDclBaseFieldModel.

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 15 of file class.ilDclStandardField.php.

Member Function Documentation

_getDatatypeForId()

static ilDclStandardField::_getDatatypeForId (   $id )

static

gives you the datatype id of a specified standard field.

Parameters

int

$id

the id of the standardfield eg. "create_date"

Returns

int|null

Definition at line 222 of file class.ilDclStandardField.php.

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

Referenced by ilDclBaseFieldModel\getDatatypeId(), and ilDclTableViewFieldSetting\getFieldObject().

    {
        $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:

_getImportableStandardFieldTitle()

static ilDclStandardField::_getImportableStandardFieldTitle ( )

static

Returns

array all possible titles of importable (excel import) standardfields (atm exclusively owner), in all languages;

Definition at line 175 of file class.ilDclStandardField.php.

References $DIC, ilDclBaseFieldModel\$id, and $ilDB.

Referenced by ilDclContentImporter\getImportFieldsFromTitles().

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

        return $titles;
    }

Here is the caller graph for this function:

_getNonImportableStandardFieldTitles()

static ilDclStandardField::_getNonImportableStandardFieldTitles ( )

static

Returns

array all possible titles of non-importable (excel import) standardfields (atm all except owner), in all languages;

Definition at line 141 of file class.ilDclStandardField.php.

References $DIC, ilDclBaseFieldModel\$id, and $ilDB.

Referenced by ilDclContentImporter\getImportFieldsFromTitles().

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $identifiers = '';
        foreach (
            array(
                'dcl_id',
                'dcl_creation_date',
                'dcl_last_update',
                '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:

_getStandardFields()

static ilDclStandardField::_getStandardFields (   $table_id )

static

Parameters

$table_id

Returns

array

Definition at line 122 of file class.ilDclStandardField.php.

References ilDclBaseFieldModel\$table_id.

Referenced by ilDclTable\getFirstTableViewId().

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

        return $stdFields;
    }

Here is the caller graph for this function:

_getStandardFieldsAsArray()

static ilDclStandardField::_getStandardFieldsAsArray ( )

static

Returns

array

Definition at line 68 of file class.ilDclStandardField.php.

References $DIC, $lng, ilDclDatatype\INPUTFORMAT_DATETIME, ilDclDatatype\INPUTFORMAT_NONE, ilDclDatatype\INPUTFORMAT_NUMBER, and ilDclDatatype\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 $DIC;
        $lng = $DIC['lng'];
        $stdfields = array(
            array(
                "id" => "id",
                "title" => $lng->txt("dcl_id"),
                "description" => $lng->txt("dcl_id_description"),
                "datatype_id" => ilDclDatatype::INPUTFORMAT_NUMBER
            ),
            array(
                "id" => "create_date",
                "title" => $lng->txt("dcl_creation_date"),
                "description" => $lng->txt("dcl_creation_date_description"),
                "datatype_id" => ilDclDatatype::INPUTFORMAT_DATETIME
            ),
            array(
                "id" => "last_update",
                "title" => $lng->txt("dcl_last_update"),
                "description" => $lng->txt("dcl_last_update_description"),
                "datatype_id" => ilDclDatatype::INPUTFORMAT_DATETIME
            ),
            array(
                "id" => "owner",
                "title" => $lng->txt("dcl_owner"),
                "description" => $lng->txt("dcl_owner_description"),
                "datatype_id" => ilDclDatatype::INPUTFORMAT_TEXT
            ),
            array(
                "id" => "last_edit_by",
                "title" => $lng->txt("dcl_last_edited_by"),
                "description" => $lng->txt("dcl_last_edited_by_description"),
                "datatype_id" => ilDclDatatype::INPUTFORMAT_TEXT
            ),
            array(
                'id' => 'comments',
                'title' => $lng->txt('dcl_comments'),
                'description' => $lng->txt('dcl_comments_desc'),
                'datatype_id' => ilDclDatatype::INPUTFORMAT_NONE
            ),
        );

        return $stdfields;
    }

_isStandardField()

static ilDclStandardField::_isStandardField (   $field_id )

static

Parameters

$field_id

Returns

bool

Definition at line 202 of file class.ilDclStandardField.php.

Referenced by ilDclTableView\createFieldSetting(), ilDclBaseRecordModel\fillRecordFieldExcelExport(), ilDclBaseRecordModel\fillRecordFieldFormInput(), ilDclBaseRecordModel\getRecordFieldExportValue(), ilDclBaseRecordModel\getRecordFieldFormulaValue(), ilDclBaseRecordModel\getRecordFieldHTML(), ilDclBaseRecordModel\getRecordFieldPlainText(), ilDclBaseRecordModel\getRecordFieldRepresentationValue(), ilDclBaseRecordModel\getRecordFieldSortingValue(), ilDclBaseRecordModel\getRecordFieldValue(), ilDclBaseRecordModel\setRecordFieldValue(), and ilDclBaseRecordModel\setRecordFieldValueFromForm().

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

        return $return;
    }

Here is the caller graph for this function:

afterClone()

ilDclStandardField::afterClone

(

$records

)

Parameters

$records

Definition at line 420 of file class.ilDclStandardField.php.

    {
    }

allowFilterInListView()

ilDclStandardField::allowFilterInListView

(

)

Returns

bool

Definition at line 373 of file class.ilDclStandardField.php.

References ilDclCache\getTableCache(), and ilDclBaseFieldModel\getTableId().

    {
        //comments are filterable if they are enabled in the tables settings
        return $this->id != 'comments'
            || ilDclCache::getTableCache($this->getTableId())->getPublicCommentsEnabled();
    }

Here is the call graph for this function:

cloneStructure()

ilDclStandardField::cloneStructure

(

$original_record

)

Parameters

ilDclStandardField

$original_record

Definition at line 46 of file class.ilDclStandardField.php.

References doUpdate(), ilDclBaseFieldModel\setExportable(), ilDclBaseFieldModel\setOrder(), and ilDclBaseFieldModel\setUnique().

    {
        $this->setOrder($original_record->getOrder());
        $this->setUnique($original_record->isUnique());
        $this->setExportable($original_record->getExportable());

        $this->doUpdate();
    }

Here is the call graph for this function:

doCreate()

ilDclStandardField::doCreate

(

)

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

References $DIC, $message, and ilUtil\sendFailure().

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

Here is the call graph for this function:

doRead()

ilDclStandardField::doRead

(

)

Definition at line 17 of file class.ilDclStandardField.php.

References $DIC, $message, and ilUtil\sendFailure().

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

Here is the call graph for this function:

doUpdate()

ilDclStandardField::doUpdate

(

)

Definition at line 37 of file class.ilDclStandardField.php.

References ilDclBaseFieldModel\updateTableFieldSetting().

Referenced by cloneStructure().

    {
        $this->updateTableFieldSetting();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillHeaderExcel()

ilDclStandardField::fillHeaderExcel	(	ilExcel	$worksheet,
		&	$row,
		&	$col
	)

Parameters

\ilExcel	$worksheet
	$row
	$col

Definition at line 386 of file class.ilDclStandardField.php.

References $DIC, $lng, ilDclBaseFieldModel\getId(), and ilExcel\setCell().

    {
        parent::fillHeaderExcel($worksheet, $row, $col);
        if ($this->getId() == 'owner') {
            global $DIC;
            $lng = $DIC['lng'];
            $worksheet->setCell($row, $col, $lng->txt("dcl_owner_name"));
            $col++;
        }
    }

Here is the call graph for this function:

getLocked()

ilDclStandardField::getLocked

(

)

Returns

bool

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

    {
        return true;
    }

getRecordQueryFilterObject()

ilDclStandardField::getRecordQueryFilterObject	(		$filter_value = "",
		ilDclBaseFieldModel	$sort_field = null
	)

Returns a query-object for building the record-loader-sql-query.

Parameters

string	$filter_value
ilDclBaseFieldModel	$sort_field

Returns

ilDclRecordQueryObject|null

Definition at line 293 of file class.ilDclStandardField.php.

References $DIC, $ilDB, ilDclBaseFieldModel\getDatatypeId(), ilDclDatatype\INPUTFORMAT_DATETIME, ilDclDatatype\INPUTFORMAT_NUMBER, and ilDclDatatype\INPUTFORMAT_TEXT.

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

        $where_additions = "";
        $join_str = "";
        if ($this->getDatatypeId() == ilDclDatatype::INPUTFORMAT_TEXT) {
            $join_str = "INNER JOIN usr_data AS filter_usr_data_{$this->getId()} ON (filter_usr_data_{$this->getId()}.usr_id = record.{$this->getId()} AND filter_usr_data_{$this->getId()}.login LIKE "
                . $ilDB->quote("%$filter_value%", 'text') . ") ";
        } else {
            if ($this->getDatatypeId() == ilDclDatatype::INPUTFORMAT_NUMBER) {
                $from = (isset($filter_value['from'])) ? $filter_value['from'] : null;
                $to = (isset($filter_value['to'])) ? $filter_value['to'] : null;
                if (is_numeric($from)) {
                    $where_additions .= " AND record.{$this->getId()} >= "
                        . $ilDB->quote($from, 'integer');
                }
                if (is_numeric($to)) {
                    $where_additions .= " AND record.{$this->getId()} <= "
                        . $ilDB->quote($to, 'integer');
                }
            } else {
                if ($this->getDatatypeId() == ilDclDatatype::INPUTFORMAT_DATETIME) {
                    $date_from = (isset($filter_value['from'])
                        && is_object($filter_value['from'])) ? $filter_value['from'] : null;
                    $date_to = (isset($filter_value['to'])
                        && is_object($filter_value['to'])) ? $filter_value['to'] : null;

                    // db->quote(.. date) at some point invokes ilDate->_toString, which adds a <br /> to the string,
                    // that's why strip_tags is used
                    if ($date_from) {
                        $where_additions .= " AND (record.{$this->getId()} >= "
                            . strip_tags($ilDB->quote($date_from, 'date')) . ")";
                    }
                    if ($date_to) {
                        $where_additions .= " AND (record.{$this->getId()} <= "
                            . strip_tags($ilDB->quote($date_to, 'date')) . ")";
                    }
                }
            }
        }

        $sql_obj = new ilDclRecordQueryObject();
        $sql_obj->setJoinStatement($join_str);
        $sql_obj->setWhereStatement($where_additions);

        return $sql_obj;
    }

Here is the call graph for this function:

getRecordQuerySortObject()

ilDclStandardField::getRecordQuerySortObject	(		$direction = "asc",
			$sort_by_status = false
	)

Returns a query-object for building the record-loader-sql-query.

Parameters

string	$direction
boolean	$sort_by_status	The specific sort object is a status field

Returns

null|ilDclRecordQueryObject

Definition at line 262 of file class.ilDclStandardField.php.

References ilDclBaseFieldModel\getId().

    {
        $sql_obj = new ilDclRecordQueryObject();

        $join_str = "";
        if ($this->getId() == 'owner' || $this->getId() == 'last_edit_by') {
            $join_str = "LEFT JOIN usr_data AS sort_usr_data_{$this->getId()} ON (sort_usr_data_{$this->getId()}.usr_id = record.{$this->getId()})";
            $select_str = " sort_usr_data_{$this->getId()}.login AS field_{$this->getId()},";
        } else {
            $select_str = " record.{$this->getId()} AS field_{$this->getId()},";
        }

        $sql_obj->setSelectStatement($select_str);
        $sql_obj->setJoinStatement($join_str);

        if ($this->getId() !== "comments") {
            $sql_obj->setOrderStatement("field_{$this->getId()} " . $direction);
        }

        return $sql_obj;
    }

Here is the call graph for this function:

getSortField()

ilDclStandardField::getSortField

(

)

Returns

string

Definition at line 347 of file class.ilDclStandardField.php.

References ilDclBaseFieldModel\getId(), and ilDclBaseFieldModel\getTitle().

    {
        if ($this->getId() == 'comments') {
            return 'n_comments';
        } else {
            return $this->getTitle();
        }
    }

Here is the call graph for this function:

getValueFromExcel()

ilDclStandardField::getValueFromExcel	(		$excel,
			$row,
			$col
	)

Parameters

$excel	ilExcel
$row
$col

Returns

mixed

Definition at line 405 of file class.ilDclStandardField.php.

References ilObjUser\_lookupId().

    {
        $value = $excel->getCell($row, $col);
        switch ($this->id) {
            case 'owner':
                return ilObjUser::_lookupId($value);
            default:
                return $value;
        }
    }

Here is the call graph for this function:

hasNumericSorting()

ilDclStandardField::hasNumericSorting

(

)

Returns

bool

Definition at line 360 of file class.ilDclStandardField.php.

References ilDclBaseFieldModel\getId().

    {
        if ($this->getId() == 'comments') {
            return true;
        }

        return parent::hasNumericSorting();
    }

Here is the call graph for this function:

isStandardField()

ilDclStandardField::isStandardField

(

)

Returns

bool

Definition at line 239 of file class.ilDclStandardField.php.

    {
        return true;
    }

isUnique()

ilDclStandardField::isUnique

(

)

Returns

bool

Definition at line 248 of file class.ilDclStandardField.php.

    {
        return false;
    }

---

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

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