Inheritance diagram for ilDclRatingFieldModel:

Collaboration diagram for ilDclRatingFieldModel:

Public Member Functions
	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...

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

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

	getRequired ()
	Get Required Required. 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...

	getFieldSettings ()

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

	setLocked ($locked)

	getLocked ()

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

Additional Inherited Members
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)

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

	$required

	$order

	$unique

	$locked

	$property = array()

	$exportable

	$datatype

	$storage_location_override = null

Detailed Description

Class ilDclRatingFieldModel.

Author: Michael Herren mh@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version: 1.0.0

Definition at line 9 of file class.ilDclRatingFieldModel.php.

Member Function Documentation

◆ getRecordQueryFilterObject()

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

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

Parameters

string $filter_value

Returns: null|ilDclRecordQueryObject

Definition at line 42 of file class.ilDclRatingFieldModel.php.

References $DIC, and $ilDB.

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         if (!$sort_field instanceof $this) {
             $join_str = "LEFT JOIN (SELECT (ROUND(AVG(rating), 1) * 10000 + COUNT(rating)) as rating, obj_id FROM il_rating GROUP BY obj_id) AS average ON average.obj_id = record.id";
         }
         // FSX Bugfix 0015735: The average is multiplied with 10000 and added to the amount of votes
         $where_additions = " AND average.rating >= " . $ilDB->quote($filter_value * 10000, 'integer');
 
         $sql_obj = new ilDclRecordQueryObject();
         $sql_obj->setWhereStatement($where_additions);
         $sql_obj->setJoinStatement($join_str);
 
         return $sql_obj;
     }

◆ getRecordQuerySortObject()

ilDclRatingFieldModel::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 20 of file class.ilDclRatingFieldModel.php.

     {
         // FSX Bugfix 0015735: The average is multiplied with 10000 and added to the amount of votes
         $join_str = "LEFT JOIN (SELECT (ROUND(AVG(rating), 1) * 10000 + COUNT(rating)) as rating, obj_id FROM il_rating GROUP BY obj_id) AS average ON average.obj_id = record.id";
         $select_str = " average.rating AS field_{$this->getId()},";
 
         $sql_obj = new ilDclRecordQueryObject();
         $sql_obj->setSelectStatement($select_str);
         $sql_obj->setJoinStatement($join_str);
         $sql_obj->setOrderStatement("field_{$this->getId()} " . $direction);
 
         return $sql_obj;
     }

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

Modules/DataCollection/classes/Fields/Rating/class.ilDclRatingFieldModel.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getRecordQueryFilterObject()

◆ getRecordQuerySortObject()