ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
ilDclTableFieldSetting Class Reference

Class ilDclTableFieldSetting. More...

+ Inheritance diagram for ilDclTableFieldSetting:
+ Collaboration diagram for ilDclTableFieldSetting:

Public Member Functions

 getId ()
 
 setId ($id)
 
 getTableId ()
 
 setTableId ($table_id)
 
 getField ()
 
 setField ($field)
 
 getFieldOrder ()
 
 setFieldOrder ($field_order)
 
 isExportable ()
 
 setExportable ($exportable)
 
- Public Member Functions inherited from ActiveRecord
 getArConnector ()
 
 getArFieldList ()
 
 getConnectorContainerName ()
 
 setConnectorContainerName ($connector_container_name)
 
 getPrimaryFieldValue ()
 
 setPrimaryFieldValue ($value)
 
 __construct ($primary_key=0, arConnector $connector=null)
 
 storeObjectToCache ()
 
 __getConvertedDateFieldsAsArray ($format=null)
 
 __asCsv ($separator=';', $header=false)
 
 __asArray ()
 
 __asStdClass ()
 
 __asSerializedObject ()
 
 buildFromArray (array $array)
 
 fixDateField ($field_name, $value)
 
 sleep ($field_name)
 
 wakeUp ($field_name, $field_value)
 
 getArrayForDb ()
 
 getArrayForConnector ()
 
 installConnector ()
 
 store ()
 
 save ()
 
 create ()
 
 copy ($new_id=0)
 
 afterObjectLoad ()
 
 read ()
 
 update ()
 
 delete ()
 
 __call ($name, $arguments)
 

Static Public Member Functions

static returnDbTableName ()
 
static getInstance ($table_id, $field)
 
- Static Public Member Functions inherited from ActiveRecord
static returnDbTableName ()
 
static installDB ()
 
static renameDBField ($old_name, $new_name)
 
static tableExists ()
 
static fieldExists ($field_name)
 
static removeDBField ($field_name)
 
static updateDB ()
 
static resetDB ()
 
static truncateDB ()
 
static flushDB ()
 
static preloadObjects ()
 
static additionalParams (array $additional_params)
 
static findOrFail ($primary_key, array $add_constructor_args=array())
 Tries to find the object and throws an Exception if object is not found, instead of returning null. More...
 
static findOrGetInstance ($primary_key, array $add_constructor_args=array())
 
static where ($where, $operator=null)
 
static innerjoinAR (ActiveRecord $ar, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)
 
static innerjoin ($tablename, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)
 
static leftjoin ($tablename, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)
 
static orderBy ($orderBy, $orderDirection='ASC')
 
static dateFormat ($date_format='d.m.Y - H:i:s')
 
static limit ($start, $end)
 
static affectedRows ()
 
static count ()
 
static get ()
 
static debug ()
 
static first ()
 
static getCollection ()
 
static last ()
 
static getFirstFromLastQuery ()
 
static connector (arConnector $connector)
 
static raw ($set_raw=true)
 
static getArray ($key=null, $values=null)
 
static _toCamelCase ($str, $capitalise_first_char=false)
 

Protected Attributes

 $id
 
 $table_id
 
 $field
 
 $field_order
 
 $exportable
 
- Protected Attributes inherited from ActiveRecord
 $ar_safe_read = true
 
 $connector_container_name = ''
 

Additional Inherited Members

- Data Fields inherited from ActiveRecord
const ACTIVE_RECORD_VERSION = '2.0.7'
 
- Protected Member Functions inherited from ActiveRecord
 serializeToCSV ($field)
 This method is called for every field of your instance if you use __asCsv. More...
 
 installDatabase ()
 
- Static Protected Member Functions inherited from ActiveRecord
static getCalledClass ()
 
static fromCamelCase ($str)
 

Detailed Description

Class ilDclTableFieldSetting.

defines table/field specific settings: field_order, editable, exportable

Author
Theodor Truffer tt@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 12 of file class.ilDclTableFieldSetting.php.

Member Function Documentation

◆ getField()

ilDclTableFieldSetting::getField ( )
Returns
string

Definition at line 107 of file class.ilDclTableFieldSetting.php.

References $field.

◆ getFieldOrder()

ilDclTableFieldSetting::getFieldOrder ( )
Returns
int

Definition at line 123 of file class.ilDclTableFieldSetting.php.

References $field_order.

◆ getId()

ilDclTableFieldSetting::getId ( )
Returns
int

Definition at line 75 of file class.ilDclTableFieldSetting.php.

References $id.

◆ getInstance()

static ilDclTableFieldSetting::getInstance (   $table_id,
  $field 
)
static
Parameters
$table_id
$field
Returns
\ActiveRecord|\ilDclTableFieldSetting

Definition at line 157 of file class.ilDclTableFieldSetting.php.

157 {
158 $setting = self::where(array( 'table_id' => $table_id, 'field' => $field ))->first();
159 if (!$setting) {
160 $setting = new self();
161 $setting->setField($field);
162 $setting->setTableId($table_id);
163 }
164
165 return $setting;
166 }
static where($where, $operator=null)

References $field, $table_id, and ActiveRecord\where().

Referenced by ilDclBaseFieldModel\doDelete(), ilDclBaseFieldModel\loadTableFieldSetting(), and ilDclBaseFieldModel\updateTableFieldSetting().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getTableId()

ilDclTableFieldSetting::getTableId ( )
Returns
int

Definition at line 91 of file class.ilDclTableFieldSetting.php.

91 {
92 return $this->table_id;
93 }

References $table_id.

◆ isExportable()

ilDclTableFieldSetting::isExportable ( )
Returns
boolean

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

References $exportable.

◆ returnDbTableName()

static ilDclTableFieldSetting::returnDbTableName ( )
static
Returns
string @description Return the Name of your Database Table

Reimplemented from ActiveRecord.

Definition at line 67 of file class.ilDclTableFieldSetting.php.

67 {
68 return "il_dcl_tfield_set";
69 }

◆ setExportable()

ilDclTableFieldSetting::setExportable (   $exportable)
Parameters
boolean$exportable

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

147 {
148 $this->exportable = $exportable;
149 }

References $exportable.

◆ setField()

ilDclTableFieldSetting::setField (   $field)
Parameters
string$field

Definition at line 115 of file class.ilDclTableFieldSetting.php.

115 {
116 $this->field = $field;
117 }

References $field.

◆ setFieldOrder()

ilDclTableFieldSetting::setFieldOrder (   $field_order)
Parameters
int$field_order

Definition at line 131 of file class.ilDclTableFieldSetting.php.

131 {
132 $this->field_order = $field_order;
133 }

References $field_order.

◆ setId()

ilDclTableFieldSetting::setId (   $id)
Parameters
int$id

Definition at line 83 of file class.ilDclTableFieldSetting.php.

83 {
84 $this->id = $id;
85 }

References $id.

◆ setTableId()

ilDclTableFieldSetting::setTableId (   $table_id)
Parameters
int$table_id

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

99 {
100 $this->table_id = $table_id;
101 }

References $table_id.

Field Documentation

◆ $exportable

ilDclTableFieldSetting::$exportable
protected

Definition at line 60 of file class.ilDclTableFieldSetting.php.

Referenced by isExportable(), and setExportable().

◆ $field

ilDclTableFieldSetting::$field
protected

Definition at line 44 of file class.ilDclTableFieldSetting.php.

Referenced by getField(), getInstance(), and setField().

◆ $field_order

ilDclTableFieldSetting::$field_order
protected

Definition at line 52 of file class.ilDclTableFieldSetting.php.

Referenced by getFieldOrder(), and setFieldOrder().

◆ $id

ilDclTableFieldSetting::$id
protected

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

Referenced by getId(), and setId().

◆ $table_id

ilDclTableFieldSetting::$table_id
protected

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

Referenced by getInstance(), getTableId(), and setTableId().


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