ilDataCollectionTable Class Reference

Class ilDataCollectionField. More...

Collaboration diagram for ilDataCollectionTable:

Public Member Functions
	__construct ($a_id=0)
	Constructor public.
	doRead ()
	Read table.
	doDelete ($delete_main_table=false)
	doDelete Attention this does not delete the maintable of it's the maintabla of the collection.
	doCreate ()
	Create new table.
	doUpdate ()
	setId ($a_id)
	Set table id.
	getId ()
	Get table id.
	setObjId ($a_id)
	Set object id.
	getObjId ()
	Get object id.
	setTitle ($a_title)
	Set title.
	getTitle ()
	Get title.
	getCollectionObject ()
	getCollectionObject
	getRecords ()
	getRecordsByFilter (array $filter=array())
	getRecordsByFilter
	getAll ($a_id)
	get all tables of a Data Collection Object
	deleteField ($field_id)
	getField ($field_id)
	getFieldIds ()
	getNewOrder ()
	getNewOrder
	getFields ()
	Returns all fields of this table including the standard fields.
	getRecordFields ()
	Returns all fields of this table which are NOT standard fields.
	getVisibleFields ()
	Returns all fields of this table who have set their visibility to true, including standard fields.
	getEditableFields ()
	getFilterableFields ()
	getFilterableFields Returns all fields of this table who have set their filterable to true, including standard fields.
	hasPermissionToFields ($ref_id)
	hasPermissionToAddTable ($ref_id)
	hasPermissionToAddRecord ($ref)
	hasPermissionToEditRecord ($ref, $record)
	hasPermissionToDeleteRecord ($ref, $record)
	updateFields ()
	sortFields (&$fields)
	sortFields
	buildOrderFields ()
	buildOrderFields orders the fields.
	getFieldByTitle ($name)
	setAddPerm ($add_perm)
	getAddPerm ()
	setDeletePerm ($delete_perm)
	getDeletePerm ()
	setEditByOwner ($edit_by_owner)
	getEditByOwner ()
	setEditPerm ($edit_perm)
	getEditPerm ()
	setLimited ($limited)
	getLimited ()
	setLimitEnd ($limit_end)
	getLimitEnd ()
	setLimitStart ($limit_start)
	getLimitStart ()
	setIsVisible ($is_visible)
	getIsVisible ()
	hasCustomFields ()
	hasCustomFields
	compareOrder ($a, $b)
	cloneStructure ($original_id)
	_hasRecords ()
	_hasRecords
	addField ($field)
	buildTableAsArray ()
	setExportEnabled ($export_enabled)
	getExportEnabled ()
	getPartialRecords ($sort, $direction, $limit, $offset, array $filter=array())
	Return only the needed subset of record objects for the table, according to sorting, paging and filters.

Static Public Member Functions
static	_tableExists ($table_id)
static	_getTableIdByTitle ($title, $obj_id)
static	_hasFieldByTitle ($title, $obj_id)
	Checks if a table has a field with the given title.

Protected Attributes
	$id
	$objId
	$obj
	$title
	$export_enabled

Private Member Functions
	loadObj ()
	loadRecords ()
	loadFields ()
	checkEditByOwner ($record)
	checkLimit ()
	sortByOrder (&$array)

Private Attributes
	$fields
	$stdFields
	$records
	$is_visible
	$add_perm
	$edit_perm
	$delete_perm
	$edit_by_owner
	$limited
	$limit_start
	$limit_end

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 19 of file class.ilDataCollectionTable.php.

Constructor & Destructor Documentation

ilDataCollectionTable::__construct

(

$a_id = 0

)

Constructor public.

Parameters

integer

fiel_id

Definition at line 76 of file class.ilDataCollectionTable.php.

References doRead().

        {
                if($a_id != 0) 
                {
                        $this->id = $a_id;
                        $this->doRead();
                }       
        }

Here is the call graph for this function:

Member Function Documentation

static ilDataCollectionTable::_getTableIdByTitle (   $title,   $obj_id  )

static

Parameters

$title	Title of table
$obj_id	DataCollection object ID where the table belongs to

Returns

int

Definition at line 942 of file class.ilDataCollectionTable.php.

References $id, $result, and $title.

Referenced by ilObjDataCollection\cloneStructure().

                                                               {
        global $ilDB;
        $result = $ilDB->query('SELECT id FROM il_dcl_table WHERE title = ' . $ilDB->quote($title, 'text') . ' AND obj_id = ' . $ilDB->quote($obj_id, 'integer'));
        $id = 0;
        while($rec = $ilDB->fetchAssoc($result)) {
            $id = $rec['id'];
        }
        return $id;
    }

Here is the caller graph for this function:

static ilDataCollectionTable::_hasFieldByTitle (   $title,   $obj_id  )

static

Checks if a table has a field with the given title.

Parameters

$title	Title of field
$obj_id	Obj-ID of the table

Returns

bool

Definition at line 983 of file class.ilDataCollectionTable.php.

References $result, and $title.

Referenced by ilDataCollectionFieldEditGUI\checkInput().

                                                             {
        global $ilDB;
        $result = $ilDB->query('SELECT * FROM il_dcl_field WHERE table_id = ' . $ilDB->quote($obj_id, 'integer') . ' AND title = ' . $ilDB->quote($title, 'text'));
        return ($ilDB->numRows($result)) ? true : false;
    }

Here is the caller graph for this function:

ilDataCollectionTable::_hasRecords

(

)

_hasRecords

Returns

boolean

Definition at line 914 of file class.ilDataCollectionTable.php.

References getRecords().

        {
                return (count($this->getRecords()) > 0) ? true : false;
        }

Here is the call graph for this function:

static ilDataCollectionTable::_tableExists (   $table_id )

static

Parameters

$table_id

int

Returns

bool returns true iff there exists a table with id $table_id

Definition at line 930 of file class.ilDataCollectionTable.php.

References $query, and $result.

Referenced by ilDataCollectionRecord\doCreate(), and ilDataCollectionField\doCreate().

                                                      {
                global $ilDB;
                $query = "SELECT * FROM il_dcl_table WHERE id = ".$table_id;
                $result = $ilDB->query($query);
                return $result->numRows() != 0;
        }

Here is the caller graph for this function:

ilDataCollectionTable::addField

(

$field

)

Parameters

$field

ilDataCollectionField add an already created field for eg. ordering.

Definition at line 922 of file class.ilDataCollectionTable.php.

References fields.

                                    {
        $this->fields[$field->getId()] = $field;
    }

ilDataCollectionTable::buildOrderFields

(

)

buildOrderFields orders the fields.

Definition at line 687 of file class.ilDataCollectionTable.php.

References $fields, getFields(), and sortByOrder().

Referenced by doCreate().

        {
                $fields = $this->getFields();

                $this->sortByOrder($fields);

                $count = 10;
                $offset = 10;

                foreach($fields as $field)
                {
                        if(!is_null($field->getOrder()))
                        {
                                $field->setOrder($count);
                                $count = $count + $offset;
                $field->doUpdate();
                        }
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilDataCollectionTable::buildTableAsArray

(

)

Definition at line 952 of file class.ilDataCollectionTable.php.

References $fields, $query, and getVisibleFields().

                                       {
        global $ilDB;
        $fields = $this->getVisibleFields();
        $table = array();
        $query = "  SELECT  stloc.value AS val rec_field AS  FROM il_dcl_stloc1_value stloc
                    INNER JOIN il_dcl_record_field rec_field ON rec_field.field_id = 2
                    WHERE stloc.record_field_id = rec_field.id";
    }

Here is the call graph for this function:

ilDataCollectionTable::checkEditByOwner (   $record )

private

Definition at line 614 of file class.ilDataCollectionTable.php.

References $ilUser, and getEditByOwner().

Referenced by hasPermissionToDeleteRecord(), and hasPermissionToEditRecord().

        {
                global $ilUser;
                
                if($this->getEditByOwner() && $ilUser->getId() != $record->getOwner())
                {
                        return false;
                }
                        
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilDataCollectionTable::checkLimit ( )

private

Definition at line 629 of file class.ilDataCollectionTable.php.

References getLimited(), getLimitEnd(), getLimitStart(), IL_CAL_DATE, and IL_CAL_UNIX.

Referenced by hasPermissionToAddRecord(), hasPermissionToDeleteRecord(), and hasPermissionToEditRecord().

        {
                if($this->getLimited())
                {
                        $now = new ilDateTime(time(), IL_CAL_UNIX);
                        $from = new ilDateTime($this->getLimitStart(), IL_CAL_DATE);
                        $to = new ilDateTime($this->getLimitEnd(), IL_CAL_DATE);
                        
                        if(!($from <= $now && $now <= $to))
                        {
                                return false;
                        }
                }
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilDataCollectionTable::cloneStructure

(

$original_id

)

Definition at line 881 of file class.ilDataCollectionTable.php.

References doCreate(), getId(), ilDataCollectionRecordViewViewdefinition\getIdByTableId(), ilDataCollectionCache\getTableCache(), setAddPerm(), setDeletePerm(), setEditByOwner(), setEditPerm(), setLimited(), setLimitEnd(), setLimitStart(), and setTitle().

        {
                $original = ilDataCollectionCache::getTableCache($original_id);
                $this->setEditByOwner($original->getEditByOwner());
                $this->setAddPerm($original->getAddPerm());
                $this->setEditPerm($original->getEditPerm());
                $this->setDeletePerm($original->getDeletePerm());
                $this->setLimited($original->getLimited());
                $this->setLimitStart($original->getLimitStart());
                $this->setLimitEnd($original->getLimitEnd());
                $this->setTitle($original->getTitle());
                $this->doCreate();

                //clone fields.
                foreach($original->getRecordFields() as $field)
                {
                        $new_field = new ilDataCollectionField();
                        $new_field->setTableId($this->getId());
                        $new_field->cloneStructure($field->getId());
                }

        if($old_view_id = ilDataCollectionRecordViewViewdefinition::getIdByTableId($original_id)){
            $old_view = new ilDataCollectionRecordViewViewdefinition($old_view_id, $original_id);
            $viewdef = new ilDataCollectionRecordViewViewdefinition(0, $this->id);
            $viewdef->setXMLContent($old_view->getXMLContent(false));
            $viewdef->create();
        }
        }

Here is the call graph for this function:

ilDataCollectionTable::compareOrder	(		$a,
			$b
	)

Definition at line 860 of file class.ilDataCollectionTable.php.

    {
        if(is_null($a->getOrder() == NULL) && is_null($b->getOrder() == NULL))
        {
            return 0;
        }
        if(is_null($a->getOrder()))
        {
            return 1;
        }
        if(is_null($b->getOrder()))
        {
            return -1;
        }

        return $a->getOrder() < $b->getOrder() ? -1 : 1;
    }

ilDataCollectionTable::deleteField

(

$field_id

)

Definition at line 396 of file class.ilDataCollectionTable.php.

References $records, ilDataCollectionCache\getFieldCache(), and getRecords().

        {
                $field = ilDataCollectionCache::getFieldCache($field_id);
                $records = $this->getRecords();

                foreach($records as $record)
                {
                        $record->deleteField($field_id);
                }

                $field->doDelete();
        }

Here is the call graph for this function:

ilDataCollectionTable::doCreate

(

)

Create new table.

Definition at line 149 of file class.ilDataCollectionTable.php.

References $id, $query, buildOrderFields(), ilDataCollectionField\EDIT_VIEW, ilDataCollectionField\FILTER_VIEW, getAddPerm(), getDeletePerm(), getEditByOwner(), getEditPerm(), getExportEnabled(), getId(), getIsVisible(), getLimited(), getLimitEnd(), getLimitStart(), getObjId(), getTitle(), setId(), and ilDataCollectionField\VIEW_VIEW.

Referenced by cloneStructure().

        {
                global $ilDB;

                $id = $ilDB->nextId("il_dcl_table");
                $this->setId($id);
                $query = "INSERT INTO il_dcl_table (".
                        "id".
                        ", obj_id".
                        ", title".
                        ", add_perm".
                        ", edit_perm".
                        ", delete_perm".
                        ", edit_by_owner".
                        ", limited".
                        ", limit_start".
                        ", limit_end".
                        ", is_visible".
                        ", export_enabled".
                        " ) VALUES (".
                        $ilDB->quote($this->getId(), "integer")
                        .",".$ilDB->quote($this->getObjId(), "integer")
                        .",".$ilDB->quote($this->getTitle(), "text")
                        .",".$ilDB->quote($this->getAddPerm()?1:0, "integer")
                        .",".$ilDB->quote($this->getEditPerm()?1:0, "integer")
                        .",".$ilDB->quote($this->getDeletePerm()?1:0, "integer")
                        .",".$ilDB->quote($this->getEditByOwner()?1:0, "integer")
                        .",".$ilDB->quote($this->getLimited()?1:0, "integer")
                        .",".$ilDB->quote($this->getLimitStart(), "timestamp")
                        .",".$ilDB->quote($this->getLimitEnd(), "timestamp")
                        .",".$ilDB->quote($this->getIsVisible()?1:0, "integer")
                        .",".$ilDB->quote($this->getExportEnabled()?1:0, "integer")
                        .")";
                $ilDB->manipulate($query);

                //add view definition
                $view_id = $ilDB->nextId("il_dcl_view");
                $query = "INSERT INTO il_dcl_view (id, table_id, type, formtype) VALUES (".$ilDB->quote($view_id, "integer").", ".$ilDB->quote($this->id, "integer").", ".$ilDB->quote(ilDataCollectionField::VIEW_VIEW, "integer").", ".$ilDB->quote(1, "integer").")";
                $ilDB->manipulate($query);

                //add edit definition
                $view_id = $ilDB->nextId("il_dcl_view");
                $query = "INSERT INTO il_dcl_view (id, table_id, type, formtype) VALUES (".$ilDB->quote($view_id, "integer").", ".$ilDB->quote($this->id, "integer").", ".$ilDB->quote(ilDataCollectionField::EDIT_VIEW, "integer").", ".$ilDB->quote(1, "integer").")";
                $ilDB->manipulate($query);

                //add filter definition
                $view_id = $ilDB->nextId("il_dcl_view");
                $query = "INSERT INTO il_dcl_view (id, table_id, type, formtype) VALUES (".$ilDB->quote($view_id, "integer").", ".$ilDB->quote($this->id, "integer").", ".$ilDB->quote(ilDataCollectionField::FILTER_VIEW, "integer").", ".$ilDB->quote(1, "integer").")";
                $ilDB->manipulate($query);

                $this->buildOrderFields();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilDataCollectionTable::doDelete

(

$delete_main_table = false

)

doDelete Attention this does not delete the maintable of it's the maintabla of the collection.

unlink the the maintable in the collections object to make this work.

Parameters

boolean

$delete_main_table

true to delete table anyway

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

References $query, getCollectionObject(), getId(), getRecordFields(), and getRecords().

        {
                global $ilDB;
                
                foreach($this->getRecords() as $record)
                {
                        $record->doDelete();
                }
                        
                foreach($this->getRecordFields() as $field)
                {
                        $field->doDelete();
                }

        // SW: Fix #12794 und #11405
        // Problem is that when the DC object gets deleted, $this::getCollectionObject() tries to load the DC but it's not in the DB anymore
        // If $delete_main_table is true, avoid getting the collection object
        $exec_delete = false;
        if ($delete_main_table) {
            $exec_delete = true;
        }
        if (!$exec_delete && $this->getCollectionObject()->getMainTableId() != $this->getId()) {
            $exec_delete = true;
        }
        if ($exec_delete) {
            $query = "DELETE FROM il_dcl_table WHERE id = ".$ilDB->quote($this->getId(), "integer");
            $ilDB->manipulate($query);
        }
        }

Here is the call graph for this function:

ilDataCollectionTable::doRead

(

)

Read table.

Definition at line 89 of file class.ilDataCollectionTable.php.

References $query, getId(), setAddPerm(), setDeletePerm(), setEditByOwner(), setEditPerm(), setExportEnabled(), setIsVisible(), setLimited(), setLimitEnd(), setLimitStart(), setObjId(), and setTitle().

Referenced by __construct().

        {
                global $ilDB;

                $query = "SELECT * FROM il_dcl_table WHERE id = ".$ilDB->quote($this->getId(),"integer");
                $set = $ilDB->query($query);
                $rec = $ilDB->fetchAssoc($set);

                $this->setObjId($rec["obj_id"]);
                $this->setTitle($rec["title"]);
                $this->setAddPerm($rec["add_perm"]);
                $this->setEditPerm($rec["edit_perm"]);
                $this->setDeletePerm($rec["delete_perm"]);
                $this->setEditByOwner($rec["edit_by_owner"]);
                $this->setExportEnabled($rec["export_enabled"]);
                $this->setLimited($rec["limited"]);
                $this->setLimitStart($rec["limit_start"]);
                $this->setLimitEnd($rec["limit_end"]);
                $this->setIsVisible($rec["is_visible"]);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilDataCollectionTable::doUpdate

(

)

Definition at line 205 of file class.ilDataCollectionTable.php.

References getAddPerm(), getDeletePerm(), getEditByOwner(), getEditPerm(), getExportEnabled(), getId(), getIsVisible(), getLimited(), getLimitEnd(), getLimitStart(), getObjId(), and getTitle().

        {
                global $ilDB;

                $ilDB->update("il_dcl_table", array(
                        "obj_id" => array("integer", $this->getObjId()),
                        "title" => array("text", $this->getTitle()),
                        "add_perm" => array("integer",$this->getAddPerm()),
                        "edit_perm" => array("integer",$this->getEditPerm()),
                        "delete_perm" => array("integer",$this->getDeletePerm()),
                        "edit_by_owner" => array("integer",$this->getEditByOwner()),
                        "limited" => array("integer",$this->getLimited()),
                        "limit_start" => array("timestamp",$this->getLimitStart()),
                        "limit_end" => array("timestamp",$this->getLimitEnd()),
                        "is_visible" => array("integer",$this->getIsVisible()?1:0),
                        "export_enabled" => array("integer",$this->getExportEnabled()?1:0)
                ), array(
                        "id" => array("integer", $this->getId())
                ));
        }

Here is the call graph for this function:

ilDataCollectionTable::getAddPerm

(

)

Returns

boolean

Definition at line 732 of file class.ilDataCollectionTable.php.

References $add_perm.

Referenced by doCreate(), doUpdate(), and hasPermissionToAddRecord().

        {
                return $this->add_perm;
        }

Here is the caller graph for this function:

ilDataCollectionTable::getAll

(

$a_id

)

get all tables of a Data Collection Object

Parameters

int

$a_id

obj_id

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

References $query.

Referenced by ilDataCollectionRecordListViewdefinitionGUI\initForm().

        {
                global $ilDB;

                //build query
                $query = "SELECT         *
                                                        FROM il_dcl_table
                                                        WHERE obj_id = ".$ilDB->quote($a_id,"integer");
                $set = $ilDB->query($query);

                $all = array();
                while($rec = $ilDB->fetchAssoc($set))
                {
                        $all[$rec['id']] = $rec;
                }

                return $all;
        }

Here is the caller graph for this function:

ilDataCollectionTable::getCollectionObject

(

)

getCollectionObject

Returns

ilObjDataCollection

Definition at line 290 of file class.ilDataCollectionTable.php.

References $obj, and loadObj().

Referenced by doDelete().

        {
                $this->loadObj();
                
                return $this->obj;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilDataCollectionTable::getDeletePerm

(

)

Returns

boolean

Definition at line 748 of file class.ilDataCollectionTable.php.

References $delete_perm.

Referenced by doCreate(), doUpdate(), and hasPermissionToDeleteRecord().

        {
                return $this->delete_perm;
        }

Here is the caller graph for this function:

ilDataCollectionTable::getEditableFields

(

)

Definition at line 532 of file class.ilDataCollectionTable.php.

References $fields, and getRecordFields().

        {
                $fields = $this->getRecordFields();
                $editableFields = array();

                foreach($fields as $field)
                {
                        if(!$field->getLocked())
                        {
                                array_push($editableFields, $field);
                        }
                }

                return $editableFields;
        }

Here is the call graph for this function:

ilDataCollectionTable::getEditByOwner

(

)

Returns

boolean

Definition at line 764 of file class.ilDataCollectionTable.php.

References $edit_by_owner.

Referenced by checkEditByOwner(), doCreate(), and doUpdate().

        {
                return $this->edit_by_owner;
        }

Here is the caller graph for this function:

ilDataCollectionTable::getEditPerm

(

)

Returns

boolean

Definition at line 780 of file class.ilDataCollectionTable.php.

References $edit_perm.

Referenced by doCreate(), doUpdate(), and hasPermissionToEditRecord().

        {
                return $this->edit_perm;
        }

Here is the caller graph for this function:

ilDataCollectionTable::getExportEnabled

(

)

Returns

boolean

Definition at line 972 of file class.ilDataCollectionTable.php.

References $export_enabled.

Referenced by doCreate(), and doUpdate().

    {
        return $this->export_enabled;
    }

Here is the caller graph for this function:

ilDataCollectionTable::getField

(

$field_id

)

Definition at line 413 of file class.ilDataCollectionTable.php.

References $fields, and getFields().

Referenced by getPartialRecords().

        {
                $fields = $this->getFields();
                $field = NULL;
                foreach($fields as $field_1)
                {
                        if($field_1->getId() == $field_id)
                        {
                                $field = $field_1;
                        }
                }
                        
                return $field;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilDataCollectionTable::getFieldByTitle

(

$name

)

Parameters

$name

Returns

ilDataCollectionField

Definition at line 711 of file class.ilDataCollectionTable.php.

References getFields().

Referenced by getPartialRecords().

                                          {
        $return = null;
        foreach($this->getFields() as $field)
            if($field->getTitle() == $name){
                $return = $field;
                break;
            }
        return $return;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ilDataCollectionTable::getFieldIds

(

)

Definition at line 431 of file class.ilDataCollectionTable.php.

References getFields().

        {
                return array_keys($this->getFields());
        }

Here is the call graph for this function:

ilDataCollectionTable::getFields

(

)

Returns all fields of this table including the standard fields.

Returns

ilDataCollectionField[]

Definition at line 484 of file class.ilDataCollectionTable.php.

References $fields, ilDataCollectionStandardField\_getStandardFields(), fields, loadFields(), and sortByOrder().

Referenced by buildOrderFields(), getField(), getFieldByTitle(), getFieldIds(), getFilterableFields(), getNewOrder(), getVisibleFields(), and updateFields().

        {
                $this->loadFields();
                if($this->stdFields == NULL)
                {
                        $this->stdFields = ilDataCollectionStandardField::_getStandardFields($this->id);
                }
                $fields = array_merge($this->fields, $this->stdFields);
                $this->sortByOrder($fields);

                return $fields;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilDataCollectionTable::getFilterableFields

(

)

getFilterableFields Returns all fields of this table who have set their filterable to true, including standard fields.

Returns

ilDataCollectionField[]

Definition at line 553 of file class.ilDataCollectionTable.php.

References $fields, and getFields().

        {
                $fields = $this->getFields();
                $filterableFields = array();
                
                foreach($fields as $field)
                {
                        if($field->isFilterable())
                        {
                                array_push($filterableFields, $field);
                        }
                }
                        
                return $filterableFields;
        }

Here is the call graph for this function:

ilDataCollectionTable::getId

(

)

Get table id.

Returns

int

Definition at line 241 of file class.ilDataCollectionTable.php.

References $id.

Referenced by cloneStructure(), doCreate(), doDelete(), doRead(), doUpdate(), getPartialRecords(), and loadFields().

        {
                return $this->id;
        }

Here is the caller graph for this function:

ilDataCollectionTable::getIsVisible

(

)

Returns

boolean

Definition at line 844 of file class.ilDataCollectionTable.php.

References $is_visible.

Referenced by doCreate(), and doUpdate().

        {
                return $this->is_visible;
        }

Here is the caller graph for this function:

ilDataCollectionTable::getLimited

(

)

Returns

boolean

Definition at line 796 of file class.ilDataCollectionTable.php.

References $limited.

Referenced by checkLimit(), doCreate(), and doUpdate().

        {
                return $this->limited;
        }

Here is the caller graph for this function:

ilDataCollectionTable::getLimitEnd

(

)

Returns

string

Definition at line 812 of file class.ilDataCollectionTable.php.

References $limit_end.

Referenced by checkLimit(), doCreate(), and doUpdate().

        {
                return $this->limit_end;
        }

Here is the caller graph for this function:

ilDataCollectionTable::getLimitStart

(

)

Returns

string

Definition at line 828 of file class.ilDataCollectionTable.php.

References $limit_start.

Referenced by checkLimit(), doCreate(), and doUpdate().

        {
                return $this->limit_start;
        }

Here is the caller graph for this function:

ilDataCollectionTable::getNewOrder

(

)

getNewOrder

Returns

int returns the place where a new field should be placed.

Definition at line 465 of file class.ilDataCollectionTable.php.

References $fields, and getFields().

        {
                $fields = $this->getFields();
                $place = 0;
                foreach($fields as $field)
                {
                        if($field->isVisible())
                        {
                                $place = $field->getOrder() + 1;
                        }
                }
                        
                return $place;
        }

Here is the call graph for this function:

ilDataCollectionTable::getObjId

(

)

Get object id.

Returns

int

Definition at line 261 of file class.ilDataCollectionTable.php.

References $objId.

Referenced by doCreate(), and doUpdate().

        {
                return $this->objId;
        }

Here is the caller graph for this function:

ilDataCollectionTable::getPartialRecords	(		$sort,
			$direction,
			$limit,
			$offset,
		array	$filter = array()
	)

Return only the needed subset of record objects for the table, according to sorting, paging and filters.

Parameters

string	$sort	Title of a field where the ilTable2GUI is sorted
string	$direction	'desc' or 'asc'
int	$limit	Limit of records
int	$offset	Offset from records
array	$filter	Containing the filter values

Returns

array Array with two keys: 'record' => Contains the record objects, 'total' => Number of total records (without slicing)

Definition at line 999 of file class.ilDataCollectionTable.php.

References $id, $ilUser, $records, getField(), getFieldByTitle(), ilDataCollectionCache\getFieldCache(), getId(), ilDataCollectionCache\getRecordCache(), ilDataCollectionDatatype\INPUTFORMAT_BOOLEAN, ilDataCollectionDatatype\INPUTFORMAT_DATETIME, ilDataCollectionDatatype\INPUTFORMAT_FILE, ilDataCollectionDatatype\INPUTFORMAT_ILIAS_REF, ilDataCollectionDatatype\INPUTFORMAT_MOB, ilDataCollectionDatatype\INPUTFORMAT_NUMBER, ilDataCollectionDatatype\INPUTFORMAT_RATING, ilDataCollectionDatatype\INPUTFORMAT_REFERENCE, and ilDataCollectionDatatype\INPUTFORMAT_TEXT.

                                                                                                   {
        global $ilDB;

        $sortField = ($sort) ? $sortField = $this->getFieldByTitle($sort) : $sortField = $this->getFieldByTitle('id');
        $direction = strtolower($direction);
        $direction = (in_array($direction, array('desc', 'asc'))) ? $direction : 'asc';

        // Sorting by a status from an ILIAS Ref field. This column is added dynamically to the table, there is no field model
        $sortByStatus = false;
        if (substr($sort, 0, 8) == '_status_') {
            $sortByStatus = true;
            $sortField = $this->getFieldByTitle(substr($sort, 8));
        }

        if (is_null($sortField)) $sortField = $this->getFieldByTitle('id');

        $id = $sortField->getId();
        $stl = $sortField->getStorageLocation();
        $selectStr = '';
        $joinStr = '';
        $where_additions = '';

        if ($sortField->isStandardField()) {
            if ($id == 'owner' || $id == 'last_edit_by') {
                $joinStr .= "LEFT JOIN usr_data AS sort_usr_data_{$id} ON (sort_usr_data_{$id}.usr_id = record.{$id})";
                $selectStr .= " sort_usr_data_{$id}.login AS field_{$id},";
            } else {
                $selectStr .= " record.{$id} AS field_{$id},";
            }
        } else {
            switch ($sortField->getDatatypeId()) {
                case ilDataCollectionDatatype::INPUTFORMAT_RATING:
                    $joinStr .= "LEFT JOIN (SELECT AVG(sort_avg_rating.rating) AS avg_rating, sort_avg_rating.obj_id AS obj_id FROM il_rating as sort_avg_rating WHERE sort_avg_rating.sub_obj_id = {$sortField->getId()} GROUP BY sort_avg_rating.obj_id) AS sort_avg_rating on sort_avg_rating.obj_id = record.id ";
                    $selectStr .= " sort_avg_rating.avg_rating AS field_{$id},";
                    break;
                case ilDataCollectionDatatype::INPUTFORMAT_ILIAS_REF:
                    $joinStr .= "LEFT JOIN il_dcl_record_field AS sort_record_field_{$id} ON (sort_record_field_{$id}.record_id = record.id AND sort_record_field_{$id}.field_id = " . $ilDB->quote($sortField->getId(), 'integer') .") ";
                    $joinStr .= "LEFT JOIN il_dcl_stloc{$stl}_value AS sort_stloc_{$id} ON (sort_stloc_{$id}.record_field_id = sort_record_field_{$id}.id) ";
                    $joinStr .= "LEFT JOIN object_reference AS sort_object_reference_{$id} ON (sort_object_reference_{$id}.ref_id = sort_stloc_{$id}.value AND sort_object_reference_{$id}.deleted IS NULL)";
                    $joinStr .= "LEFT JOIN object_data AS sort_object_data_{$id} ON (sort_object_data_{$id}.obj_id = sort_object_reference_{$id}.obj_id)";
                    if ($sortByStatus) {
                        global $ilUser;
                        $joinStr .= "LEFT JOIN ut_lp_marks AS ut ON (ut.obj_id = sort_object_data_{$id}.obj_id AND ut.usr_id = " . $ilDB->quote($ilUser->getId(), 'integer') . ") ";
                    }
                    $selectStr .= (!$sortByStatus) ? " sort_object_data_{$id}.title AS field_{$id}," : " ut.status AS field_{$id}";
                    break;
                case ilDataCollectionDatatype::INPUTFORMAT_FILE:
                case ilDataCollectionDatatype::INPUTFORMAT_MOB:
                    $joinStr .= "LEFT JOIN il_dcl_record_field AS sort_record_field_{$id} ON (sort_record_field_{$id}.record_id = record.id AND sort_record_field_{$id}.field_id = " . $ilDB->quote($sortField->getId(), 'integer') .") ";
                    $joinStr .= "LEFT JOIN il_dcl_stloc{$stl}_value AS sort_stloc_{$id} ON (sort_stloc_{$id}.record_field_id = sort_record_field_{$id}.id) ";
                    $joinStr .= "LEFT JOIN object_data AS sort_object_data_{$id} ON (sort_object_data_{$id}.obj_id = sort_stloc_{$id}.value) ";
                    $selectStr .= " sort_object_data_{$id}.title AS field_{$id},";
                    break;
                case ilDataCollectionDatatype::INPUTFORMAT_REFERENCE:
                    $prop = $sortField->getPropertyvalues();
                    $refField = ilDataCollectionCache::getFieldCache($sortField->getFieldRef());
                    $selectStr .= "stloc_{$id}_joined.value AS field_{$id},";
                    $joinStr .= "LEFT JOIN il_dcl_record_field AS record_field_{$id} ON (record_field_{$id}.record_id = record.id AND record_field_{$id}.field_id = " . $ilDB->quote($sortField->getId(), 'integer') .") ";
                    $joinStr .= "LEFT JOIN il_dcl_stloc{$stl}_value AS stloc_{$id} ON (stloc_{$id}.record_field_id = record_field_{$id}.id) ";
                    $joinStr .= "LEFT JOIN il_dcl_record_field AS record_field_{$id}_joined ON (record_field_{$id}_joined.record_id = stloc_{$id}.value AND record_field_{$id}_joined.field_id = " . $ilDB->quote($refField->getId(), 'integer') .") ";
                    $joinStr .= "LEFT JOIN il_dcl_stloc{$refField->getStorageLocation()}_value AS stloc_{$id}_joined ON (stloc_{$id}_joined.record_field_id = record_field_{$id}_joined.id) ";
                    break;
                case ilDataCollectionDatatype::INPUTFORMAT_DATETIME:
                case ilDataCollectionDatatype::INPUTFORMAT_TEXT:
                case ilDataCollectionDatatype::INPUTFORMAT_BOOLEAN:
                case ilDataCollectionDatatype::INPUTFORMAT_NUMBER:
                    $selectStr .= " sort_stloc_{$id}.value AS field_{$id},";
                    $joinStr .= "LEFT JOIN il_dcl_record_field AS sort_record_field_{$id} ON (sort_record_field_{$id}.record_id = record.id AND sort_record_field_{$id}.field_id = " . $ilDB->quote($sortField->getId(), 'integer') .") ";
                    $joinStr .= "LEFT JOIN il_dcl_stloc{$stl}_value AS sort_stloc_{$id} ON (sort_stloc_{$id}.record_field_id = sort_record_field_{$id}.id) ";
                    break;
            }
        }

        if(count($filter)) {
            foreach($filter as $key => $filter_value)
            {
                $filter_field_id = substr($key, 7);
                $filterField = $this->getField($filter_field_id);
                switch ($filterField->getDatatypeId()) {
                    case ilDataCollectionDatatype::INPUTFORMAT_RATING:
                        $joinStr .= "INNER JOIN (SELECT AVG(avg_rating.rating) AS avg_rating, avg_rating.obj_id AS obj_id FROM il_rating as avg_rating WHERE avg_rating.sub_obj_id = {$filter_field_id} GROUP BY avg_rating.obj_id) AS avg_rating on avg_rating.avg_rating >= ".$ilDB->quote($filter_value, 'integer') ." AND avg_rating.obj_id = record.id ";
                        break;
                    case ilDataCollectionDatatype::INPUTFORMAT_ILIAS_REF:
                        $joinStr .= "INNER JOIN il_dcl_record_field AS filter_record_field_{$filter_field_id} ON (filter_record_field_{$filter_field_id}.record_id = record.id AND filter_record_field_{$filter_field_id}.field_id = " . $ilDB->quote($filter_field_id, 'integer') .") ";
                        $joinStr .= "INNER JOIN il_dcl_stloc{$filterField->getStorageLocation()}_value AS filter_stloc_{$filter_field_id} ON (filter_stloc_{$filter_field_id}.record_field_id = filter_record_field_{$filter_field_id}.id) ";
                        $joinStr .= "INNER JOIN object_reference AS filter_object_reference_{$filter_field_id} ON (filter_object_reference_{$filter_field_id}.ref_id = filter_stloc_{$filter_field_id}.value ) ";
                        $joinStr .= "INNER JOIN object_data AS filter_object_data_{$filter_field_id} ON (filter_object_data_{$filter_field_id}.obj_id = filter_object_reference_{$filter_field_id}.obj_id AND filter_object_data_{$filter_field_id}.title LIKE " . $ilDB->quote("%$filter_value%", 'text') .") ";
                        break;
                    case ilDataCollectionDatatype::INPUTFORMAT_MOB:
                    case ilDataCollectionDatatype::INPUTFORMAT_FILE:
                        $joinStr .= "INNER JOIN il_dcl_record_field AS filter_record_field_{$filter_field_id} ON (filter_record_field_{$filter_field_id}.record_id = record.id AND filter_record_field_{$filter_field_id}.field_id = " . $ilDB->quote($filter_field_id, 'integer') .") ";
                        $joinStr .= "INNER JOIN il_dcl_stloc{$filterField->getStorageLocation()}_value AS filter_stloc_{$filter_field_id} ON (filter_stloc_{$filter_field_id}.record_field_id = filter_record_field_{$filter_field_id}.id) ";
                        $joinStr .= "INNER JOIN object_data AS filter_object_data_{$filter_field_id} ON (filter_object_data_{$filter_field_id}.obj_id = filter_stloc_{$filter_field_id}.value AND filter_object_data_{$filter_field_id}.title LIKE " . $ilDB->quote("%$filter_value%", 'text') .") ";
                        break;
                    case ilDataCollectionDatatype::INPUTFORMAT_DATETIME:
                        $dateFrom = (isset($filter_value['from']) && is_object($filter_value['from'])) ? $filter_value['from'] : null;
                        $dateTo = (isset($filter_value['to']) && is_object($filter_value['to'])) ? $filter_value['to'] : null;
                        if ($filterField->isStandardField()) {
                            if ($dateFrom) $where_additions .= " AND (record.{$filter_field_id} >= " . $ilDB->quote($dateFrom, 'date') . ")";
                            if ($dateTo) $where_additions .= " AND (record.{$filter_field_id} <= " . $ilDB->quote($dateTo, 'date') . ")";
                        } else {
                            $joinStr .= "INNER JOIN il_dcl_record_field AS filter_record_field_{$filter_field_id} ON (filter_record_field_{$filter_field_id}.record_id = record.id AND filter_record_field_{$filter_field_id}.field_id = " . $ilDB->quote($filter_field_id, 'integer') .") ";
                            $joinStr .= "INNER JOIN il_dcl_stloc{$filterField->getStorageLocation()}_value AS filter_stloc_{$filter_field_id} ON (filter_stloc_{$filter_field_id}.record_field_id = filter_record_field_{$filter_field_id}.id ";
                            if ($dateFrom) $joinStr .= "AND filter_stloc_{$filter_field_id}.value >= " . $ilDB->quote($dateFrom, 'date') . " ";
                            if ($dateTo) $joinStr .= "AND filter_stloc_{$filter_field_id}.value <= " . $ilDB->quote($dateTo, 'date') . " ";
                            $joinStr .= ") ";
                        }
                        break;
                    case ilDataCollectionDatatype::INPUTFORMAT_NUMBER:
                        $from = (isset($filter_value['from'])) ? (int) $filter_value['from'] : null;
                        $to = (isset($filter_value['to'])) ? (int) $filter_value['to'] : null;
                        if ($filterField->isStandardField()) {
                            if (!is_null($from)) $where_additions .= " AND record.{$filter_field_id} >= " . $ilDB->quote($from, 'integer');
                            if (!is_null($to)) $where_additions .= " AND record.{$filter_field_id} <= " . $ilDB->quote($to, 'integer');
                        } else {
                            $joinStr .= "INNER JOIN il_dcl_record_field AS filter_record_field_{$filter_field_id} ON (filter_record_field_{$filter_field_id}.record_id = record.id AND filter_record_field_{$filter_field_id}.field_id = " . $ilDB->quote($filter_field_id, 'integer') .") ";
                            $joinStr .= "INNER JOIN il_dcl_stloc{$filterField->getStorageLocation()}_value AS filter_stloc_{$filter_field_id} ON (filter_stloc_{$filter_field_id}.record_field_id = filter_record_field_{$filter_field_id}.id";
                            if (!is_null($from)) $joinStr .= " AND filter_stloc_{$filter_field_id}.value >= " . $ilDB->quote($from, 'integer');
                            if (!is_null($to)) $joinStr .= " AND filter_stloc_{$filter_field_id}.value <= " . $ilDB->quote($to, 'integer');
                            $joinStr .= ") ";
                        }
                        break;
                    case ilDataCollectionDatatype::INPUTFORMAT_BOOLEAN:
                        if($filter_value == "checked") {
                            $joinStr .= "INNER JOIN il_dcl_record_field AS filter_record_field_{$filter_field_id} ON (filter_record_field_{$filter_field_id}.record_id = record.id AND filter_record_field_{$filter_field_id}.field_id = " . $ilDB->quote($filter_field_id, 'integer') .") ";
                            $joinStr .= "INNER JOIN il_dcl_stloc{$filterField->getStorageLocation()}_value AS filter_stloc_{$filter_field_id} ON (filter_stloc_{$filter_field_id}.record_field_id = filter_record_field_{$filter_field_id}.id";
                            $joinStr .= " AND filter_stloc_{$filter_field_id}.value = " . $ilDB->quote(1, 'integer');
                        } else {
                            $joinStr .= "INNER JOIN il_dcl_record_field AS filter_record_field_{$filter_field_id} ON (filter_record_field_{$filter_field_id}.record_id = record.id AND filter_record_field_{$filter_field_id}.field_id = " . $ilDB->quote($filter_field_id, 'integer') .") ";
                            $joinStr .= "LEFT JOIN il_dcl_stloc{$filterField->getStorageLocation()}_value AS filter_stloc_{$filter_field_id} ON (filter_stloc_{$filter_field_id}.record_field_id = filter_record_field_{$filter_field_id}.id";
                            $where_additions .= " AND (filter_stloc_{$filter_field_id}.value <> " . $ilDB->quote(1, 'integer')." OR filter_stloc_{$filter_field_id}.value is NULL)";
                        }
                        $joinStr .= " ) ";
                        break;
                    case ilDataCollectionDatatype::INPUTFORMAT_TEXT:
                        if ($filterField->isStandardField()) {
                            $joinStr .= "INNER JOIN usr_data AS filter_usr_data_{$filter_field_id} ON (filter_usr_data_{$filter_field_id}.usr_id = record.{$filter_field_id} AND filter_usr_data_{$filter_field_id}.login LIKE " . $ilDB->quote("%$filter_value%", 'text') .") ";
                        } else {
                            $joinStr .= " INNER JOIN il_dcl_record_field AS filter_record_field_{$filter_field_id} ON (filter_record_field_{$filter_field_id}.record_id = record.id AND filter_record_field_{$filter_field_id}.field_id = " . $ilDB->quote($filter_field_id, 'integer') .") ";
                            $joinStr .= " INNER JOIN il_dcl_stloc{$filterField->getStorageLocation()}_value AS filter_stloc_{$filter_field_id} ON (filter_stloc_{$filter_field_id}.record_field_id = filter_record_field_{$filter_field_id}.id AND filter_stloc_{$filter_field_id}.value LIKE " . $ilDB->quote("%$filter_value%", 'text') .") ";
                        }
                        break;
                    case ilDataCollectionDatatype::INPUTFORMAT_REFERENCE:
                        $joinStr .= " INNER JOIN il_dcl_record_field AS filter_record_field_{$filter_field_id} ON (filter_record_field_{$filter_field_id}.record_id = record.id AND filter_record_field_{$filter_field_id}.field_id = " . $ilDB->quote($filter_field_id, 'integer') .") ";
                        $joinStr .= " INNER JOIN il_dcl_stloc{$filterField->getStorageLocation()}_value AS filter_stloc_{$filter_field_id} ON (filter_stloc_{$filter_field_id}.record_field_id = filter_record_field_{$filter_field_id}.id AND filter_stloc_{$filter_field_id}.value = " . $ilDB->quote($filter_value, 'integer') .") ";
                        break;
                }
            }
        }

        // Build the query string
        $sql = "SELECT DISTINCT record.id, ";
        $sql  .= rtrim($selectStr, ',') . " FROM il_dcl_record AS record ";
        $sql .= $joinStr;
        $sql .= " WHERE record.table_id = " . $ilDB->quote($this->getId(), 'integer') . $where_additions;
        $sql .= " ORDER BY field_{$id} {$direction}";
//        echo $sql;die();
        $set = $ilDB->query($sql);
        $totalRecordIds = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            $totalRecordIds[] = $rec['id'];
        }
        // Now slice the array to load only the needed records in memory
        $recordIds = array_slice($totalRecordIds, $offset, $limit);
        $records = array();
        foreach ($recordIds as $id) {
            $records[] = ilDataCollectionCache::getRecordCache($id);
        }

        return array('records' => $records, 'total' => count($totalRecordIds));
    }

Here is the call graph for this function:

ilDataCollectionTable::getRecordFields

(

)

Returns all fields of this table which are NOT standard fields.

Returns

ilDataCollectionField[]

Definition at line 501 of file class.ilDataCollectionTable.php.

References $fields, and loadFields().

Referenced by doDelete(), and getEditableFields().

        {
                $this->loadFields();
                
                return $this->fields;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilDataCollectionTable::getRecords

(

)

Returns

ilDataCollectionRecord[]

Definition at line 311 of file class.ilDataCollectionTable.php.

References $records, and loadRecords().

Referenced by _hasRecords(), deleteField(), doDelete(), and getRecordsByFilter().

        {
                $this->loadRecords();
                
                return $this->records;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilDataCollectionTable::getRecordsByFilter

(

array

$filter = array()

)

getRecordsByFilter

@param $filter 
filter is of the form array("filter_{field_id}" => filter); 
For dates and integers this filter must be of the form array("from" => from, "to" => to). 
In case of dates from and to have to be ilDateTime objects 
in case of integers they have to be integers as well.

Returns

ilDataCollectionRecord[]

Definition at line 327 of file class.ilDataCollectionTable.php.

References $records, getRecords(), and loadRecords().

        {
                $this->loadRecords();

        // Only pass records trough filter if there is filtering required #performance-improvements
        if (!count($filter)) {
            return $this->records;
        }
        $filtered = array();
        foreach($this->getRecords() as $record) {
            if($record->passThroughFilter($filter)) {
                $filtered[] = $record;
            }
        }
                return $filtered;
        }

Here is the call graph for this function:

ilDataCollectionTable::getTitle

(

)

Get title.

Returns

string

Definition at line 281 of file class.ilDataCollectionTable.php.

References $title.

Referenced by doCreate(), and doUpdate().

        {
                return $this->title;
        }

Here is the caller graph for this function:

ilDataCollectionTable::getVisibleFields

(

)

Returns all fields of this table who have set their visibility to true, including standard fields.

Returns

ilDataCollectionField[]

Definition at line 512 of file class.ilDataCollectionTable.php.

References $fields, and getFields().

Referenced by buildTableAsArray().

        {
                $fields = $this->getFields();

                $visibleFields = array();
                
                foreach($fields as $field)
                {
                        if($field->isVisible())
                        {
                                $visibleFields[] = $field;
                        }
                }

                return $visibleFields;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilDataCollectionTable::hasCustomFields

(

)

hasCustomFields

Returns

boolean

Definition at line 853 of file class.ilDataCollectionTable.php.

References fields, and loadFields().

        {
                $this->loadFields();
                
                return (count($this->fields) > 0) ? true : false;
        }

Here is the call graph for this function:

ilDataCollectionTable::hasPermissionToAddRecord

(

$ref

)

Definition at line 586 of file class.ilDataCollectionTable.php.

References ilObjDataCollection\_hasReadAccess(), ilObjDataCollection\_hasWriteAccess(), checkLimit(), and getAddPerm().

        {
                return ($this->getAddPerm() && ilObjDataCollection::_hasReadAccess($ref) && $this->checkLimit()) || ilObjDataCollection::_hasWriteAccess($ref);
        }

Here is the call graph for this function:

ilDataCollectionTable::hasPermissionToAddTable

(

$ref_id

)

Definition at line 580 of file class.ilDataCollectionTable.php.

References $ref_id, and ilObjDataCollection\_hasWriteAccess().

        {
                return ilObjDataCollection::_hasWriteAccess($ref_id);
        }

Here is the call graph for this function:

ilDataCollectionTable::hasPermissionToDeleteRecord	(		$ref,
			$record
	)

Parameters

$ref	int the reference id of the current datacollection object
$record	ilDataCollectionRecord the record which will be deleted

Returns

bool

Definition at line 606 of file class.ilDataCollectionTable.php.

References ilObjDataCollection\_hasReadAccess(), ilObjDataCollection\_hasWriteAccess(), checkEditByOwner(), checkLimit(), and getDeletePerm().

        {
                return ($this->getDeletePerm() && ilObjDataCollection::_hasReadAccess($ref) && $this->checkEditByOwner($record) && $this->checkLimit())  || ilObjDataCollection::_hasWriteAccess($ref);
        }

Here is the call graph for this function:

ilDataCollectionTable::hasPermissionToEditRecord	(		$ref,
			$record
	)

Parameters

$ref	int the reference id of the current datacollection object
$record	ilDataCollectionRecord the record which will be edited

Returns

bool

Definition at line 596 of file class.ilDataCollectionTable.php.

References ilObjDataCollection\_hasReadAccess(), ilObjDataCollection\_hasWriteAccess(), checkEditByOwner(), checkLimit(), and getEditPerm().

        {
                return ($this->getEditPerm() && ilObjDataCollection::_hasReadAccess($ref) && $this->checkEditByOwner($record) && $this->checkLimit())  || ilObjDataCollection::_hasWriteAccess($ref);
        }

Here is the call graph for this function:

ilDataCollectionTable::hasPermissionToFields

(

$ref_id

)

Definition at line 572 of file class.ilDataCollectionTable.php.

References $ref_id, and ilObjDataCollection\_hasWriteAccess().

        {
                return ilObjDataCollection::_hasWriteAccess($ref_id);
        }

Here is the call graph for this function:

ilDataCollectionTable::loadFields ( )

private

Definition at line 439 of file class.ilDataCollectionTable.php.

References $fields, $query, ilDataCollectionCache\buildFieldFromRecord(), fields, getId(), and sortByOrder().

Referenced by getFields(), getRecordFields(), and hasCustomFields().

        {
                if($this->fields == NULL)
                {
                        global $ilDB;
                        
                        $query = "SELECT field.id, field.table_id, field.title, field.description, field.datatype_id, field.required, field.is_unique, field.is_locked FROM il_dcl_field field INNER JOIN il_dcl_view view ON view.table_id = field.table_id INNER JOIN il_dcl_viewdefinition def ON def.view_id = view.id WHERE field.table_id =".$ilDB->quote($this->getId(), "integer")." ORDER BY def.field_order DESC";
                        $fields = array();
                        $set = $ilDB->query($query);
                        
                        while($rec = $ilDB->fetchAssoc($set))
                        {
                $field = ilDataCollectionCache::buildFieldFromRecord($rec);
//                              $field = new ilDataCollectionField();
//                              $field->buildFromDBRecord($rec);
                                $fields[$field->getId()] = $field;
                        }
            $this->sortByOrder($fields);
                        $this->fields = $fields;
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilDataCollectionTable::loadObj ( )

private

Definition at line 300 of file class.ilDataCollectionTable.php.

Referenced by getCollectionObject().

        {
                if($this->obj == NULL)
                {
                        $this->obj = new ilObjDataCollection($this->objId, false);
                }
        }

Here is the caller graph for this function:

ilDataCollectionTable::loadRecords ( )

private

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

References $query, $records, and ilDataCollectionCache\getRecordCache().

Referenced by getRecords(), and getRecordsByFilter().

        {
                if($this->records == NULL)
                {
                        global $ilDB;
                        
                        $records = array();                     
                        $query = "SELECT id FROM il_dcl_record WHERE table_id = ".$ilDB->quote($this->id, "integer");
                        $set = $ilDB->query($query);

                        while($rec = $ilDB->fetchAssoc($set))
                        {
                                $records[$rec['id']] = ilDataCollectionCache::getRecordCache($rec['id']);
                        }

                        $this->records = $records;
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilDataCollectionTable::setAddPerm

(

$add_perm

)

Parameters

boolean

$add_perm

Definition at line 724 of file class.ilDataCollectionTable.php.

References $add_perm.

Referenced by cloneStructure(), and doRead().

        {
                $this->add_perm = $add_perm;
        }

Here is the caller graph for this function:

ilDataCollectionTable::setDeletePerm

(

$delete_perm

)

Parameters

boolean

$delete_perm

Definition at line 740 of file class.ilDataCollectionTable.php.

References $delete_perm.

Referenced by cloneStructure(), and doRead().

        {
                $this->delete_perm = $delete_perm;
        }

Here is the caller graph for this function:

ilDataCollectionTable::setEditByOwner

(

$edit_by_owner

)

Parameters

boolean

$edit_by_owner

Definition at line 756 of file class.ilDataCollectionTable.php.

References $edit_by_owner.

Referenced by cloneStructure(), and doRead().

        {
                $this->edit_by_owner = $edit_by_owner;
        }

Here is the caller graph for this function:

ilDataCollectionTable::setEditPerm

(

$edit_perm

)

Parameters

boolean

$edit_perm

Definition at line 772 of file class.ilDataCollectionTable.php.

References $edit_perm.

Referenced by cloneStructure(), and doRead().

        {
                $this->edit_perm = $edit_perm;
        }

Here is the caller graph for this function:

ilDataCollectionTable::setExportEnabled

(

$export_enabled

)

Parameters

boolean

$export_enabled

Definition at line 964 of file class.ilDataCollectionTable.php.

References $export_enabled.

Referenced by doRead().

    {
        $this->export_enabled = $export_enabled;
    }

Here is the caller graph for this function:

ilDataCollectionTable::setId

(

$a_id

)

Set table id.

Parameters

int

$a_id

Definition at line 231 of file class.ilDataCollectionTable.php.

Referenced by doCreate().

        {
                $this->id = $a_id;
        }

Here is the caller graph for this function:

ilDataCollectionTable::setIsVisible

(

$is_visible

)

Parameters

boolean

$is_visible

Definition at line 836 of file class.ilDataCollectionTable.php.

References $is_visible.

Referenced by doRead().

        {
                $this->is_visible = $is_visible;
        }

Here is the caller graph for this function:

ilDataCollectionTable::setLimited

(

$limited

)

Parameters

boolean

$limited

Definition at line 788 of file class.ilDataCollectionTable.php.

References $limited.

Referenced by cloneStructure(), and doRead().

        {
                $this->limited = $limited;
        }

Here is the caller graph for this function:

ilDataCollectionTable::setLimitEnd

(

$limit_end

)

Parameters

string

$limit_end

Definition at line 804 of file class.ilDataCollectionTable.php.

References $limit_end.

Referenced by cloneStructure(), and doRead().

        {
                $this->limit_end = $limit_end;
        }

Here is the caller graph for this function:

ilDataCollectionTable::setLimitStart

(

$limit_start

)

Parameters

string

$limit_start

Definition at line 820 of file class.ilDataCollectionTable.php.

References $limit_start.

Referenced by cloneStructure(), and doRead().

        {
                $this->limit_start = $limit_start;
        }

Here is the caller graph for this function:

ilDataCollectionTable::setObjId

(

$a_id

)

Set object id.

Parameters

int

$obj_id

Definition at line 251 of file class.ilDataCollectionTable.php.

Referenced by doRead().

        {
                $this->objId = $a_id;
        }

Here is the caller graph for this function:

ilDataCollectionTable::setTitle

(

$a_title

)

Set title.

Parameters

string

$a_title

Definition at line 271 of file class.ilDataCollectionTable.php.

Referenced by cloneStructure(), and doRead().

        {
                $this->title = $a_title;
        }

Here is the caller graph for this function:

ilDataCollectionTable::sortByOrder ( &  $array )

private

Parameters

$array

ilDataCollectionField[] the array to sort

Definition at line 678 of file class.ilDataCollectionTable.php.

Referenced by buildOrderFields(), getFields(), loadFields(), and sortFields().

        {
                usort($array, array($this, "compareOrder"));
        }

Here is the caller graph for this function:

ilDataCollectionTable::sortFields

(

&

$fields

)

sortFields

Parameters

$fields

ilDataCollectionField[]

Definition at line 660 of file class.ilDataCollectionTable.php.

References $fields, and sortByOrder().

        {
                $this->sortByOrder($fields);

                //After sorting the array loses it's keys respectivly their keys are set form $field->id to 1,2,3... so we reset the keys.
                $named = array();
                foreach($fields as $field)
                {
                        $named[$field->getId()] = $field;
                }
                
                $fields = $named;
        }

Here is the call graph for this function:

ilDataCollectionTable::updateFields

(

)

Definition at line 648 of file class.ilDataCollectionTable.php.

References getFields().

        {
                foreach($this->getFields() as $field)
                {
                        $field->doUpdate();
                }
        }

Here is the call graph for this function:

Field Documentation

ilDataCollectionTable::$add_perm

private

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

Referenced by getAddPerm(), and setAddPerm().

ilDataCollectionTable::$delete_perm

private

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

Referenced by getDeletePerm(), and setDeletePerm().

ilDataCollectionTable::$edit_by_owner

private

Definition at line 50 of file class.ilDataCollectionTable.php.

Referenced by getEditByOwner(), and setEditByOwner().

ilDataCollectionTable::$edit_perm

private

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

Referenced by getEditPerm(), and setEditPerm().

ilDataCollectionTable::$export_enabled

protected

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

Referenced by getExportEnabled(), and setExportEnabled().

ilDataCollectionTable::$fields

private

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

Referenced by buildOrderFields(), buildTableAsArray(), getEditableFields(), getField(), getFields(), getFilterableFields(), getNewOrder(), getRecordFields(), getVisibleFields(), loadFields(), and sortFields().

ilDataCollectionTable::$id

protected

Definition at line 21 of file class.ilDataCollectionTable.php.

Referenced by _getTableIdByTitle(), doCreate(), getId(), and getPartialRecords().

ilDataCollectionTable::$is_visible

private

Definition at line 32 of file class.ilDataCollectionTable.php.

Referenced by getIsVisible(), and setIsVisible().

ilDataCollectionTable::$limit_end

private

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

Referenced by getLimitEnd(), and setLimitEnd().

ilDataCollectionTable::$limit_start

private

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

Referenced by getLimitStart(), and setLimitStart().

ilDataCollectionTable::$limited

private

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

Referenced by getLimited(), and setLimited().

ilDataCollectionTable::$obj

protected

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

Referenced by getCollectionObject().

ilDataCollectionTable::$objId

protected

Definition at line 22 of file class.ilDataCollectionTable.php.

Referenced by getObjId().

ilDataCollectionTable::$records

private

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

Referenced by deleteField(), getPartialRecords(), getRecords(), getRecordsByFilter(), and loadRecords().

ilDataCollectionTable::$stdFields

private

Definition at line 26 of file class.ilDataCollectionTable.php.

ilDataCollectionTable::$title

protected

Definition at line 24 of file class.ilDataCollectionTable.php.

Referenced by _getTableIdByTitle(), _hasFieldByTitle(), and getTitle().

---

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

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