ilDclTable Class Reference

Class ilDclBaseFieldModel. More...

Collaboration diagram for ilDclTable:

Public Member Functions
	__construct ($a_id=0)
	doRead ()
	Read table. More...
	doCreate ($create_tablefield_setting=true, $create_standardview=true)
	doUpdate ()
	setId ($a_id)
	Set table id. More...
	getId ()
	Get table id. More...
	setObjId ($a_id)
	getObjId ()
	setTitle ($a_title)
	getTitle ()
	getCollectionObject ()
	getRecords ()
	loadRecords ()
	deleteField ($field_id)
	getField ($field_id)
	getFieldIds ()
	getCustomFields ()
	getNewFieldOrder ()
	getNewOrder More...
	getNewTableviewOrder ()
	sortTableViews (array $tableviews=null)
	getFields ()
	Returns all fields of this table including the standard fields. More...
	reloadFields ()
	getTableViews ()
	getVisibleTableViews ($ref_id, $with_active_detailedview=false, $user_id=0)
	For current user. More...
	getFirstTableViewId ($ref_id, $user_id=0)
	get id of first (for current user) available view More...
	getRecordFields ()
	Returns all fields of this table which are NOT standard fields. More...
	getEditableFields (bool $creation_mode)
	getExportableFields ()
	Return all the fields that are marked as exportable. More...
	hasPermissionToEditRecord ($ref_id, ilDclBaseRecordModel $record)
	hasPermissionToDeleteRecord ($ref_id, ilDclBaseRecordModel $record)
	hasPermissionToDeleteRecords ($ref_id)
	hasPermissionToViewRecord ($ref_id, $record, $user_id=0)
	checkLimit ()
	updateFields ()
	Update fields. More...
	sortFields (&$fields)
	sortFields More...
	buildOrderFields ()
	buildOrderFields orders the fields. More...
	getFieldByTitle ($title)
	Get a field by title. More...
	setAddPerm ($add_perm)
	getAddPerm ()
	setDeletePerm ($delete_perm)
	getDeletePerm ()
	setEditByOwner ($edit_by_owner)
	getEditByOwner ()
	getDeleteByOwner ()
	setDeleteByOwner ($delete_by_owner)
	setEditPerm ($edit_perm)
	getEditPerm ()
	setLimited ($limited)
	getLimited ()
	setLimitEnd ($limit_end)
	getLimitEnd ()
	setLimitStart ($limit_start)
	getLimitStart ()
	setIsVisible ($is_visible)
	getIsVisible ()
	setDescription ($description)
	getDescription ()
	setDefaultSortField ($default_sort_field)
	/** More...
	getDefaultSortField ()
	setDefaultSortFieldOrder ($default_sort_field_order)
	getDefaultSortFieldOrder ()
	setPublicCommentsEnabled ($public_comments)
	getPublicCommentsEnabled ()
	setViewOwnRecordsPerm ($view_own_perm)
	getViewOwnRecordsPerm ()
	getSaveConfirmation ()
	setSaveConfirmation ($save_confirmation)
	hasCustomFields ()
	hasCustomFields More...
	compareOrder ($a, $b)
	cloneStructure (ilDclTable $original)
	afterClone ()
	_hasRecords ()
	_hasRecords More...
	addField ($field)
	setExportEnabled ($export_enabled)
	getExportEnabled ()
	getOrder ()
	updateOrder ()
	setOrder ($table_order)
	setImportEnabled ($import_enabled)
	getImportEnabled ()

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

Protected Member Functions
	loadObj ()
	doesRecordBelongToUser (ilDclBaseRecordModel $record)
	sortByOrder (&$array)

Protected Attributes
	$id = 0
	$objId
	$obj
	$title
	$fields
	$stdFields
	$records
	$is_visible
	$add_perm
	$edit_perm
	$delete_perm
	$edit_by_owner
	$delete_by_owner
	$save_confirmation
	$limited
	$limit_start
	$limit_end
	$export_enabled
	$table_order
	$import_enabled
	$default_sort_field = 0
	$default_sort_field_order = 'asc'
	$description = ''
	$public_comments = 0
	$view_own_records_perm = 0
	$all_fields = 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

Stefan Wanzenried sw@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version

$Id:

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

Constructor & Destructor Documentation

__construct()

ilDclTable::__construct

(

$a_id = 0

)

Parameters

int

$a_id

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

References doRead().

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

Here is the call graph for this function:

Member Function Documentation

_getTableIdByTitle()

static ilDclTable::_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 1412 of file class.ilDclTable.php.

References $DIC, $id, $ilDB, $result, and $title.

Referenced by ilObjDataCollection\reorderTables().

    {
        global $DIC;
        $ilDB = $DIC['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:

_hasFieldByTitle()

static ilDclTable::_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 1508 of file class.ilDclTable.php.

References $_SESSION, $DIC, $id, $ilDB, $ilUser, $records, $result, $title, getField(), getFieldByTitle(), getId(), ilDclCache\getRecordCache(), getViewOwnRecordsPerm(), ilObjDataCollectionAccess\hasEditAccess(), and ilObjDataCollectionAccess\hasWriteAccess().

Referenced by ilDclFieldEditGUI\checkInput().

    {
        global $DIC;
        $ilDB = $DIC['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 call graph for this function:

Here is the caller graph for this function:

_hasRecords()

ilDclTable::_hasRecords

(

)

_hasRecords

Returns

boolean

Definition at line 1375 of file class.ilDclTable.php.

References getRecords().

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

Here is the call graph for this function:

_tableExists()

static ilDclTable::_tableExists (   $table_id )

static

Parameters

$table_id

int

Returns

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

Definition at line 1395 of file class.ilDclTable.php.

References $DIC, $ilDB, $query, and $result.

Referenced by ilDclBaseRecordModel\doCreate(), and ilDclBaseFieldModel\doCreate().

    {
        global $DIC;
        $ilDB = $DIC['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:

addField()

ilDclTable::addField

(

$field

)

Parameters

$field

ilDclBaseFieldModel add an already created field for eg. ordering.

Definition at line 1384 of file class.ilDclTable.php.

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

afterClone()

ilDclTable::afterClone

(

)

Definition at line 1362 of file class.ilDclTable.php.

References getFields(), and getRecords().

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

Here is the call graph for this function:

buildOrderFields()

ilDclTable::buildOrderFields

(

)

buildOrderFields orders the fields.

Definition at line 924 of file class.ilDclTable.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:

checkLimit()

ilDclTable::checkLimit

(

)

Returns

bool

Definition at line 865 of file class.ilDclTable.php.

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

Referenced by hasPermissionToDeleteRecord(), and hasPermissionToEditRecord().

    {
        if ($this->getLimited()) {
            $now = new ilDateTime(date("Y-m-d H:i:s"), IL_CAL_DATE);
            $from = new ilDateTime($this->getLimitStart(), IL_CAL_DATE);
            $to = new ilDateTime($this->getLimitEnd(), IL_CAL_DATE);

            return ($from <= $now && $now <= $to);
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cloneStructure()

ilDclTable::cloneStructure

(

ilDclTable

$original

)

Parameters

ilDclTable

$original

Definition at line 1287 of file class.ilDclTable.php.

References $default_sort_field, cloneStructure(), doCreate(), doUpdate(), getAddPerm(), getDefaultSortField(), getDefaultSortFieldOrder(), getDeleteByOwner(), getDeletePerm(), getDescription(), getEditByOwner(), getEditPerm(), getExportEnabled(), getFields(), getId(), getImportEnabled(), getIsVisible(), getLimited(), getLimitEnd(), getLimitStart(), getOrder(), getPublicCommentsEnabled(), getRecords(), getSaveConfirmation(), getTableViews(), getTitle(), getViewOwnRecordsPerm(), setAddPerm(), ilDclCache\setCloneOf(), setDefaultSortField(), setDefaultSortFieldOrder(), setDeleteByOwner(), setDeletePerm(), setDescription(), setEditByOwner(), setEditPerm(), setExportEnabled(), setImportEnabled(), setIsVisible(), setLimited(), setLimitEnd(), setLimitStart(), setOrder(), setPublicCommentsEnabled(), setSaveConfirmation(), setTitle(), setViewOwnRecordsPerm(), and ilDclCache\TYPE_TABLE.

Referenced by cloneStructure().

    {
        $this->setTitle($original->getTitle());
        $this->setDescription($original->getDescription());
        $this->setIsVisible($original->getIsVisible());
        $this->setEditByOwner($original->getEditByOwner());
        $this->setAddPerm($original->getAddPerm());
        $this->setEditPerm($original->getEditPerm());
        $this->setDeleteByOwner($original->getDeleteByOwner());
        $this->setSaveConfirmation($original->getSaveConfirmation());
        $this->setDeletePerm($original->getDeletePerm());
        $this->setLimited($original->getLimited());
        $this->setLimitStart($original->getLimitStart());
        $this->setLimitEnd($original->getLimitEnd());
        $this->setViewOwnRecordsPerm($original->getViewOwnRecordsPerm());
        $this->setExportEnabled($original->getExportEnabled());
        $this->setImportEnabled($original->getImportEnabled());
        $this->setPublicCommentsEnabled($original->getPublicCommentsEnabled());
        $this->setDefaultSortFieldOrder($original->getDefaultSortFieldOrder());
        $this->setOrder($original->getOrder());

        $this->doCreate(true, false);
        // reset stdFields to get new for the created object

        $default_sort_field = 0;
        // Clone standard-fields
        $org_std_fields = $original->getStandardFields();
        foreach ($this->getStandardFields() as $element_key => $std_field) {
            $std_field->cloneStructure($org_std_fields[$element_key]);
            if ($std_field->getId() === $original->getDefaultSortField()) {
                $default_sort_field = $std_field->getId();
            }
        }

        // Clone fields
        $new_fields = array();
        foreach ($original->getFields() as $orig_field) {
            if (!$orig_field->isStandardField()) {
                $class_name = get_class($orig_field);
                $new_field = new $class_name();
                $new_field->setTableId($this->getId());
                $new_field->cloneStructure($orig_field->getId());
                $new_fields[$orig_field->getId()] = $new_field;

                if ($orig_field->getId() === $original->getDefaultSortField()) {
                    $default_sort_field = $new_field->getId();
                }
            }
        }

        $this->setDefaultSortField($default_sort_field);
        $this->doUpdate();

        // Clone Records with recordfields
        foreach ($original->getRecords() as $orig_record) {
            $new_record = new ilDclBaseRecordModel();
            $new_record->setTableId($this->getId());
            $new_record->cloneStructure($orig_record->getId(), $new_fields);
        }

        //clone tableviews (includes pageobjects)
        foreach ($original->getTableViews() as $orig_tableview) {
            $new_tableview = new ilDclTableView();
            $new_tableview->setTableId($this->getId());
            $new_tableview->cloneStructure($orig_tableview, $new_fields);
        }

        // mandatory for all cloning functions
        ilDclCache::setCloneOf($original->getId(), $this->getId(), ilDclCache::TYPE_TABLE);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

compareOrder()

ilDclTable::compareOrder	(		$a,
			$b
	)

Parameters

$a
$b

Returns

int

Definition at line 1268 of file class.ilDclTable.php.

References Vendor\Package\$a, and Vendor\Package\$b.

    {
        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;
    }

deleteField()

ilDclTable::deleteField

(

$field_id

)

Parameters

$field_id

Definition at line 410 of file class.ilDclTable.php.

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

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

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

        $field->doDelete();
    }

Here is the call graph for this function:

doCreate()

ilDclTable::doCreate	(		$create_tablefield_setting = true,
			$create_standardview = true
	)

Parameters

bool

$create_views

Definition at line 226 of file class.ilDclTable.php.

References $DIC, $id, $ilDB, $query, buildOrderFields(), ilDclTableView\createOrGetStandardView(), getAddPerm(), getDefaultSortField(), getDefaultSortFieldOrder(), getDeleteByOwner(), getDeletePerm(), getDescription(), getEditByOwner(), getEditPerm(), getExportEnabled(), getId(), getImportEnabled(), getIsVisible(), getLimited(), getLimitEnd(), getLimitStart(), getObjId(), getOrder(), getPublicCommentsEnabled(), getSaveConfirmation(), getTitle(), getViewOwnRecordsPerm(), and setId().

Referenced by cloneStructure().

    {
        global $DIC;
        $ilDB = $DIC['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" . ", import_enabled" . ", default_sort_field_id"
            . ", default_sort_field_order" . ", description" . ", public_comments" . ", view_own_records_perm"
            . ", delete_by_owner, save_confirmation , table_order ) 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->quote($this->getImportEnabled() ? 1 : 0, "integer") . ","
            . $ilDB->quote($this->getDefaultSortField(), "text") . "," . $ilDB->quote($this->getDefaultSortFieldOrder(), "text") . ","
            . $ilDB->quote($this->getDescription(), "text") . "," . $ilDB->quote($this->getPublicCommentsEnabled(), "integer") . ","
            . $ilDB->quote($this->getViewOwnRecordsPerm(), "integer") . "," . $ilDB->quote($this->getDeleteByOwner() ? 1 : 0, 'integer') . ","
            . $ilDB->quote($this->getSaveConfirmation() ? 1 : 0, 'integer') . "," . $ilDB->quote($this->getOrder(), 'integer') . ")";

        $ilDB->manipulate($query);

        if ($create_standardview) {
            //standard tableview
            ilDclTableView::createOrGetStandardView($this->id);
        }

        if ($create_tablefield_setting) {
            $this->buildOrderFields();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doesRecordBelongToUser()

ilDclTable::doesRecordBelongToUser ( ilDclBaseRecordModel  $record )

protected

Parameters

ilDclBaseRecordModel

$record

Returns

bool

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

References $DIC, $ilUser, and ilDclBaseRecordModel\getOwner().

Referenced by hasPermissionToDeleteRecord(), and hasPermissionToEditRecord().

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

        return ($ilUser->getId() == $record->getOwner());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doRead()

ilDclTable::doRead

(

)

Read table.

Definition at line 153 of file class.ilDclTable.php.

References $DIC, $ilDB, $query, getId(), getRecordFields(), getRecords(), setAddPerm(), setDefaultSortField(), setDefaultSortFieldOrder(), setDeleteByOwner(), setDeletePerm(), setDescription(), setEditByOwner(), setEditPerm(), setExportEnabled(), setImportEnabled(), setIsVisible(), setLimited(), setLimitEnd(), setLimitStart(), setObjId(), setOrder(), setPublicCommentsEnabled(), setSaveConfirmation(), setTitle(), and setViewOwnRecordsPerm().

Referenced by __construct().

    {
        global $DIC;
        $ilDB = $DIC['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->setImportEnabled($rec["import_enabled"]);
        $this->setLimited($rec["limited"]);
        $this->setLimitStart($rec["limit_start"]);
        $this->setLimitEnd($rec["limit_end"]);
        $this->setIsVisible($rec["is_visible"]);
        $this->setDescription($rec['description']);
        $this->setDefaultSortField($rec['default_sort_field_id']);
        $this->setDefaultSortFieldOrder($rec['default_sort_field_order']);
        $this->setPublicCommentsEnabled($rec['public_comments']);
        $this->setViewOwnRecordsPerm($rec['view_own_records_perm']);
        $this->setDeleteByOwner($rec['delete_by_owner']);
        $this->setSaveConfirmation($rec['save_confirmation']);
        $this->setOrder($rec['table_order']);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doUpdate()

ilDclTable::doUpdate

(

)

Definition at line 264 of file class.ilDclTable.php.

References $DIC, $ilDB, getAddPerm(), getDefaultSortField(), getDefaultSortFieldOrder(), getDeleteByOwner(), getDeletePerm(), getDescription(), getEditByOwner(), getEditPerm(), getExportEnabled(), getId(), getImportEnabled(), getIsVisible(), getLimited(), getLimitEnd(), getLimitStart(), getObjId(), getOrder(), getPublicCommentsEnabled(), getSaveConfirmation(), getTitle(), and getViewOwnRecordsPerm().

Referenced by cloneStructure().

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

        $ilDB->update(
            "il_dcl_table",
            array(
            "obj_id" => array("integer", $this->getObjId()),
            "title" => array("text", $this->getTitle()),
            "add_perm" => array("integer", (int) $this->getAddPerm()),
            "edit_perm" => array("integer", (int) $this->getEditPerm()),
            "delete_perm" => array("integer", (int) $this->getDeletePerm()),
            "edit_by_owner" => array("integer", (int) $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),
            "import_enabled" => array("integer", $this->getImportEnabled() ? 1 : 0),
            "description" => array("text", $this->getDescription()),
            "default_sort_field_id" => array("text", $this->getDefaultSortField()),
            "default_sort_field_order" => array("text", $this->getDefaultSortFieldOrder()),
            "public_comments" => array("integer", $this->getPublicCommentsEnabled() ? 1 : 0),
            "view_own_records_perm" => array("integer", $this->getViewOwnRecordsPerm()),
            'delete_by_owner' => array('integer', $this->getDeleteByOwner() ? 1 : 0),
            'save_confirmation' => array('integer', $this->getSaveConfirmation() ? 1 : 0),
            'table_order' => array('integer', $this->getOrder()),
        ),
            array(
                "id" => array("integer", $this->getId()),
            )
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAddPerm()

ilDclTable::getAddPerm

(

)

Returns

boolean

Definition at line 973 of file class.ilDclTable.php.

References $add_perm.

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

    {
        return (bool) $this->add_perm;
    }

Here is the caller graph for this function:

getCollectionObject()

ilDclTable::getCollectionObject

(

)

Returns

ilObjDataCollection

Definition at line 361 of file class.ilDclTable.php.

References $obj, and loadObj().

    {
        $this->loadObj();

        return $this->obj;
    }

Here is the call graph for this function:

getCustomFields()

ilDclTable::getCustomFields

(

)

Definition at line 495 of file class.ilDclTable.php.

References $fields, and fields.

    {
        if (!$this->fields) {
            $this->loadCustomFields();
        }

        return $this->fields;
    }

getDefaultSortField()

ilDclTable::getDefaultSortField

(

)

Returns

string

Definition at line 1168 of file class.ilDclTable.php.

References $default_sort_field.

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

    {
        return $this->default_sort_field;
    }

Here is the caller graph for this function:

getDefaultSortFieldOrder()

ilDclTable::getDefaultSortFieldOrder

(

)

Returns

string

Definition at line 1189 of file class.ilDclTable.php.

References $default_sort_field_order.

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

    {
        return $this->default_sort_field_order;
    }

Here is the caller graph for this function:

getDeleteByOwner()

ilDclTable::getDeleteByOwner

(

)

Returns

boolean

Definition at line 1024 of file class.ilDclTable.php.

References $delete_by_owner.

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

    {
        return (bool) $this->delete_by_owner;
    }

Here is the caller graph for this function:

getDeletePerm()

ilDclTable::getDeletePerm

(

)

Returns

boolean

Definition at line 994 of file class.ilDclTable.php.

References $delete_perm.

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

    {
        return (bool) $this->delete_perm;
    }

Here is the caller graph for this function:

getDescription()

ilDclTable::getDescription

(

)

Returns

string

Definition at line 1147 of file class.ilDclTable.php.

References $description.

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

    {
        return $this->description;
    }

Here is the caller graph for this function:

getEditableFields()

ilDclTable::getEditableFields

(

bool

$creation_mode

)

Parameters

bool

$creation_mode

Returns

array

Definition at line 706 of file class.ilDclTable.php.

References $_POST, $fields, and getRecordFields().

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

        foreach ($fields as $field) {
            if (!$field->getViewSetting($_POST["tableview_id"])->isLocked($creation_mode)) {
                $editableFields[] = $field;
            }
        }

        return $editableFields;
    }

Here is the call graph for this function:

getEditByOwner()

ilDclTable::getEditByOwner

(

)

Returns

boolean

Definition at line 1015 of file class.ilDclTable.php.

References $edit_by_owner.

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

    {
        return (bool) $this->edit_by_owner;
    }

Here is the caller graph for this function:

getEditPerm()

ilDclTable::getEditPerm

(

)

Returns

boolean

Definition at line 1057 of file class.ilDclTable.php.

References $edit_perm.

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

    {
        return (bool) $this->edit_perm;
    }

Here is the caller graph for this function:

getExportableFields()

ilDclTable::getExportableFields

(

)

Return all the fields that are marked as exportable.

Returns

array ilDclBaseFieldModel

Definition at line 726 of file class.ilDclTable.php.

References $fields, and getFields().

    {
        $fields = $this->getFields();
        $exportableFields = array();
        foreach ($fields as $field) {
            if ($field->getExportable()) {
                $exportableFields[] = $field;
            }
        }

        return $exportableFields;
    }

Here is the call graph for this function:

getExportEnabled()

ilDclTable::getExportEnabled

(

)

Returns

boolean

Definition at line 1441 of file class.ilDclTable.php.

References $export_enabled.

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

    {
        return $this->export_enabled;
    }

Here is the caller graph for this function:

getField()

ilDclTable::getField

(

$field_id

)

Parameters

$field_id

Returns

ilDclBaseFieldModel|null

Definition at line 428 of file class.ilDclTable.php.

References $fields, and getFields().

Referenced by _hasFieldByTitle().

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

getFieldByTitle()

ilDclTable::getFieldByTitle

(

$title

)

Get a field by title.

Parameters

$title

Returns

ilDclBaseFieldModel

Definition at line 947 of file class.ilDclTable.php.

References $title, and getFields().

Referenced by _hasFieldByTitle().

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

        return $return;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFieldIds()

ilDclTable::getFieldIds

(

)

Parameters

bool

$force_include_comments

Returns

array

Definition at line 447 of file class.ilDclTable.php.

References $DIC, $fields, $ilDB, $query, ilDclCache\buildFieldFromRecord(), fields, getFields(), getId(), and ilDclCache\preloadFieldProperties().

    {
        $field_ids = array();
        foreach ($this->getFields() as $field) {
            if ($field->getId()) {
                $field_ids[] = $field->getId();
            }
        }

        return $field_ids;
    }

Here is the call graph for this function:

getFields()

ilDclTable::getFields

(

)

Returns all fields of this table including the standard fields.

Parameters

bool

$force_include_comments

by default false, so comments will only load when enabled in tablesettings

Returns

ilDclBaseFieldModel[]

Definition at line 558 of file class.ilDclTable.php.

References $all_fields, and reloadFields().

Referenced by afterClone(), buildOrderFields(), cloneStructure(), ilDclContentExporter\fillHeaderExcel(), ilDclContentExporter\fillRowExcel(), getExportableFields(), getField(), getFieldByTitle(), getFieldIds(), getNewFieldOrder(), ilObjDataCollectionTest\testDefaultTable(), and updateFields().

    {
        if ($this->all_fields == null) {
            $this->reloadFields();
        }

        return $this->all_fields;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFirstTableViewId()

ilDclTable::getFirstTableViewId	(		$ref_id,
			$user_id = 0
	)

get id of first (for current user) available view

Parameters

	$ref_id
int	$user_id

Returns

bool

Definition at line 624 of file class.ilDclTable.php.

References $stdFields, ilDclStandardField\_getStandardFields(), fields, getPublicCommentsEnabled(), getVisibleTableViews(), ilDclDatatype\INPUTFORMAT_FILE, ilDclDatatype\INPUTFORMAT_FORMULA, ilDclDatatype\INPUTFORMAT_ILIAS_REF, ilDclDatatype\INPUTFORMAT_MOB, ilDclDatatype\INPUTFORMAT_RATING, ilDclDatatype\INPUTFORMAT_REFERENCE, and ilDclDatatype\INPUTFORMAT_REFERENCELIST.

    {
        $tableview = array_shift($this->getVisibleTableViews($ref_id, false, $user_id));

        return $tableview ? $tableview->getId() : false;
    }

Here is the call graph for this function:

getId()

ilDclTable::getId

(

)

Get table id.

Returns

int

Definition at line 316 of file class.ilDclTable.php.

References $id.

Referenced by ilDclTableViewTableGUI\__construct(), _hasFieldByTitle(), cloneStructure(), doCreate(), doRead(), doUpdate(), getFieldIds(), getNewTableviewOrder(), getTableViews(), and updateOrder().

    {
        return $this->id;
    }

Here is the caller graph for this function:

getImportEnabled()

ilDclTable::getImportEnabled

(

)

Returns

boolean

Definition at line 1494 of file class.ilDclTable.php.

References $import_enabled.

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

    {
        return $this->import_enabled;
    }

Here is the caller graph for this function:

getIsVisible()

ilDclTable::getIsVisible

(

)

Returns

boolean

Definition at line 1129 of file class.ilDclTable.php.

References $is_visible.

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

    {
        return $this->is_visible;
    }

Here is the caller graph for this function:

getLimited()

ilDclTable::getLimited

(

)

Returns

boolean

Definition at line 1075 of file class.ilDclTable.php.

References $limited.

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

    {
        return $this->limited;
    }

Here is the caller graph for this function:

getLimitEnd()

ilDclTable::getLimitEnd

(

)

Returns

string

Definition at line 1093 of file class.ilDclTable.php.

References $limit_end.

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

    {
        return $this->limit_end;
    }

Here is the caller graph for this function:

getLimitStart()

ilDclTable::getLimitStart

(

)

Returns

string

Definition at line 1111 of file class.ilDclTable.php.

References $limit_start.

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

    {
        return $this->limit_start;
    }

Here is the caller graph for this function:

getNewFieldOrder()

ilDclTable::getNewFieldOrder

(

)

getNewOrder

Returns

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

Definition at line 510 of file class.ilDclTable.php.

References $fields, and getFields().

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

        return $place;
    }

Here is the call graph for this function:

getNewTableviewOrder()

ilDclTable::getNewTableviewOrder

(

)

Returns

int

Definition at line 527 of file class.ilDclTable.php.

References ilDclTableView\getCountForTableId(), and getId().

    {
        return (ilDclTableView::getCountForTableId($this->getId()) + 1) * 10;
    }

Here is the call graph for this function:

getObjId()

ilDclTable::getObjId

(

)

Returns

int

Definition at line 334 of file class.ilDclTable.php.

References $objId.

Referenced by doCreate(), doUpdate(), hasPermissionToDeleteRecord(), hasPermissionToDeleteRecords(), hasPermissionToEditRecord(), and hasPermissionToViewRecord().

    {
        return $this->objId;
    }

Here is the caller graph for this function:

getOrder()

ilDclTable::getOrder

(

)

Returns

int

Definition at line 1450 of file class.ilDclTable.php.

References $table_order, and updateOrder().

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

    {
        if (!$this->table_order) {
            $this->updateOrder();
        }

        return $this->table_order;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPublicCommentsEnabled()

ilDclTable::getPublicCommentsEnabled

(

)

Returns

boolean

Definition at line 1207 of file class.ilDclTable.php.

References $public_comments.

Referenced by cloneStructure(), doCreate(), doUpdate(), getFirstTableViewId(), and ilObjDataCollectionTest\testDefaultTable().

    {
        return $this->public_comments;
    }

Here is the caller graph for this function:

getRecordFields()

ilDclTable::getRecordFields

(

)

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

Returns

ilDclBaseFieldModel[]

Definition at line 695 of file class.ilDclTable.php.

References $fields.

Referenced by doRead(), getEditableFields(), and ilObjDataCollectionTest\testDefaultTable().

    {
        $this->loadCustomFields();

        return $this->fields;
    }

Here is the caller graph for this function:

getRecords()

ilDclTable::getRecords

(

)

Returns

ilDclBaseRecordModel[]

Definition at line 380 of file class.ilDclTable.php.

References $records, and loadRecords().

Referenced by _hasRecords(), afterClone(), cloneStructure(), deleteField(), doRead(), and ilObjDataCollectionTest\testDefaultTable().

    {
        if ($this->records == null) {
            $this->loadRecords();
        }

        return $this->records;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSaveConfirmation()

ilDclTable::getSaveConfirmation

(

)

Returns

boolean

Definition at line 1234 of file class.ilDclTable.php.

References $save_confirmation.

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

    {
        return $this->save_confirmation;
    }

Here is the caller graph for this function:

getTableViews()

ilDclTable::getTableViews

(

)

Returns

ilDclTableView[] all tableviews ordered by tableview_order

Definition at line 583 of file class.ilDclTable.php.

References ilDclTableView\getAllForTableId(), and getId().

Referenced by cloneStructure(), getVisibleTableViews(), sortTableViews(), and ilObjDataCollectionTest\testDefaultTableViewCreated().

    {
        return ilDclTableView::getAllForTableId($this->getId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTitle()

ilDclTable::getTitle

(

)

Returns

string

Definition at line 352 of file class.ilDclTable.php.

References $title.

Referenced by cloneStructure(), doCreate(), doUpdate(), and ilObjDataCollectionTest\testDefaultTable().

    {
        return $this->title;
    }

Here is the caller graph for this function:

getViewOwnRecordsPerm()

ilDclTable::getViewOwnRecordsPerm

(

)

Returns

boolean

Definition at line 1225 of file class.ilDclTable.php.

References $view_own_records_perm.

Referenced by _hasFieldByTitle(), cloneStructure(), doCreate(), doUpdate(), and hasPermissionToViewRecord().

    {
        return (bool) $this->view_own_records_perm;
    }

Here is the caller graph for this function:

getVisibleTableViews()

ilDclTable::getVisibleTableViews	(		$ref_id,
			$with_active_detailedview = false,
			$user_id = 0
	)

For current user.

Parameters

int	$ref_id	DataCollections reference
int	$user_id

Returns

ilDclTableView[]

Definition at line 597 of file class.ilDclTable.php.

References getTableViews(), ilObjDataCollectionAccess\hasAccessToTableView(), ilObjDataCollectionAccess\hasWriteAccess(), and ilDclDetailedViewDefinition\isActive().

Referenced by getFirstTableViewId().

    {
        if (ilObjDataCollectionAccess::hasWriteAccess($ref_id, $user_id) && !$with_active_detailedview) {
            return $this->getTableViews();
        }

        $visible_views = array();
        foreach ($this->getTableViews() as $tableView) {
            if (ilObjDataCollectionAccess::hasAccessToTableView($tableView, $user_id)) {
                if (!$with_active_detailedview || ilDclDetailedViewDefinition::isActive($tableView->getId())) {
                    $visible_views[] = $tableView;
                }
            }
        }

        return $visible_views;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasCustomFields()

ilDclTable::hasCustomFields

(

)

hasCustomFields

Returns

boolean

Definition at line 1254 of file class.ilDclTable.php.

References fields.

    {
        $this->loadCustomFields();

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

hasPermissionToDeleteRecord()

ilDclTable::hasPermissionToDeleteRecord	(		$ref_id,
		ilDclBaseRecordModel	$record
	)

Parameters

$ref_id	int the reference id of the current datacollection object
$record	ilDclBaseRecordModel the record which will be deleted

Returns

bool

Definition at line 777 of file class.ilDclTable.php.

References ilObject2\_lookupObjectId(), checkLimit(), doesRecordBelongToUser(), getDeleteByOwner(), getDeletePerm(), getObjId(), ilObjDataCollectionAccess\hasAddRecordAccess(), and ilObjDataCollectionAccess\hasWriteAccess().

    {
        if ($this->getObjId() != ilObjDataCollection::_lookupObjectId($ref_id)) {
            return false;
        }
        if (ilObjDataCollectionAccess::hasWriteAccess($ref_id)) {
            return true;
        }
        if (!ilObjDataCollectionAccess::hasAddRecordAccess($ref_id)) {
            return false;
        }
        if (!$this->checkLimit()) {
            return false;
        }
        if ($this->getDeletePerm() && !$this->getDeleteByOwner()) {
            return true;
        }
        if ($this->getDeleteByOwner()) {
            return $this->doesRecordBelongToUser($record);
        }

        return false;
    }

Here is the call graph for this function:

hasPermissionToDeleteRecords()

ilDclTable::hasPermissionToDeleteRecords

(

$ref_id

)

Parameters

$ref_id

Returns

bool

Definition at line 807 of file class.ilDclTable.php.

References ilObject2\_lookupObjectId(), getDeletePerm(), getObjId(), ilObjDataCollectionAccess\hasAddRecordAccess(), and ilObjDataCollectionAccess\hasWriteAccess().

    {
        if ($this->getObjId() != ilObjDataCollection::_lookupObjectId($ref_id)) {
            return false;
        }

        return ((ilObjDataCollectionAccess::hasAddRecordAccess($ref_id) && $this->getDeletePerm())
            || ilObjDataCollectionAccess::hasWriteAccess($ref_id));
    }

Here is the call graph for this function:

hasPermissionToEditRecord()

ilDclTable::hasPermissionToEditRecord	(		$ref_id,
		ilDclBaseRecordModel	$record
	)

Parameters

$ref_id	int the reference id of the current datacollection object
$record	ilDclBaseRecordModel the record which will be edited

Returns

bool

Definition at line 746 of file class.ilDclTable.php.

References ilObject2\_lookupObjectId(), checkLimit(), doesRecordBelongToUser(), getEditByOwner(), getEditPerm(), getObjId(), ilObjDataCollectionAccess\hasAddRecordAccess(), ilObjDataCollectionAccess\hasEditAccess(), and ilObjDataCollectionAccess\hasWriteAccess().

    {
        if ($this->getObjId() != ilObjDataCollection::_lookupObjectId($ref_id)) {
            return false;
        }
        if (ilObjDataCollectionAccess::hasWriteAccess($ref_id) || ilObjDataCollectionAccess::hasEditAccess($ref_id)) {
            return true;
        }
        if (!ilObjDataCollectionAccess::hasAddRecordAccess($ref_id)) {
            return false;
        }
        if (!$this->checkLimit()) {
            return false;
        }
        if ($this->getEditPerm() && !$this->getEditByOwner()) {
            return true;
        }
        if ($this->getEditByOwner()) {
            return $this->doesRecordBelongToUser($record);
        }

        return false;
    }

Here is the call graph for this function:

hasPermissionToViewRecord()

ilDclTable::hasPermissionToViewRecord	(		$ref_id,
			$record,
			$user_id = 0
	)

Parameters

int	$ref_id
	$record	ilDclBaseRecordModel
int	$user_id

Returns

bool

Definition at line 825 of file class.ilDclTable.php.

References $DIC, $ilUser, ilObject2\_lookupObjectId(), getObjId(), getViewOwnRecordsPerm(), ilObjDataCollectionAccess\hasEditAccess(), ilObjDataCollectionAccess\hasReadAccess(), and ilObjDataCollectionAccess\hasWriteAccess().

    {
        global $DIC;
        $ilUser = $DIC['ilUser'];
        if ($this->getObjId() != ilObjDataCollection::_lookupObjectId($ref_id)) {
            return false;
        }
        if (ilObjDataCollectionAccess::hasWriteAccess($ref_id, $user_id) || ilObjDataCollectionAccess::hasEditAccess($ref_id, $user_id)) {
            return true;
        }
        if (ilObjDataCollectionAccess::hasReadAccess($ref_id)) {
            // Check for view only own entries setting
            if ($this->getViewOwnRecordsPerm() && ($user_id ? $user_id : $ilUser->getId()) != $record->getOwner()) {
                return false;
            }

            return true;
        }

        return false;
    }

Here is the call graph for this function:

loadObj()

ilDclTable::loadObj ( )

protected

Definition at line 369 of file class.ilDclTable.php.

Referenced by getCollectionObject().

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

Here is the caller graph for this function:

loadRecords()

ilDclTable::loadRecords

(

)

Definition at line 390 of file class.ilDclTable.php.

References $DIC, $ilDB, $query, $records, and ilDclCache\getRecordCache().

Referenced by getRecords().

    {
        global $DIC;
        $ilDB = $DIC['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']] = ilDclCache::getRecordCache($rec['id']);
        }

        $this->records = $records;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

reloadFields()

ilDclTable::reloadFields

(

)

Definition at line 568 of file class.ilDclTable.php.

References $fields, fields, and sortByOrder().

Referenced by getFields().

    {
        $this->loadCustomFields();
        $this->stdFields = $this->getStandardFields();
        $fields = array_merge($this->fields, $this->stdFields);

        $this->sortByOrder($fields);

        $this->all_fields = $fields;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setAddPerm()

ilDclTable::setAddPerm

(

$add_perm

)

Parameters

boolean

$add_perm

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

References $add_perm.

Referenced by cloneStructure(), and doRead().

    {
        $this->add_perm = $add_perm;
    }

Here is the caller graph for this function:

setDefaultSortField()

ilDclTable::setDefaultSortField

(

$default_sort_field

)

/**

Parameters

string

$default_sort_field

Definition at line 1158 of file class.ilDclTable.php.

References $default_sort_field.

Referenced by cloneStructure(), and doRead().

    {
        $default_sort_field = ($default_sort_field) ? $default_sort_field : 0; // Change null or empty strings to zero
        $this->default_sort_field = $default_sort_field;
    }

Here is the caller graph for this function:

setDefaultSortFieldOrder()

ilDclTable::setDefaultSortFieldOrder

(

$default_sort_field_order

)

Parameters

string

$default_sort_field_order

Definition at line 1177 of file class.ilDclTable.php.

References $default_sort_field_order.

Referenced by cloneStructure(), and doRead().

    {
        if (!in_array($default_sort_field_order, array('asc', 'desc'))) {
            $default_sort_field_order = 'asc';
        }
        $this->default_sort_field_order = $default_sort_field_order;
    }

Here is the caller graph for this function:

setDeleteByOwner()

ilDclTable::setDeleteByOwner

(

$delete_by_owner

)

Parameters

boolean

$delete_by_owner

Definition at line 1033 of file class.ilDclTable.php.

References $delete_by_owner, and setDeletePerm().

Referenced by cloneStructure(), doRead(), and setDeletePerm().

    {
        $this->delete_by_owner = $delete_by_owner;
        if ($delete_by_owner) {
            $this->setDeletePerm(true);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setDeletePerm()

ilDclTable::setDeletePerm

(

$delete_perm

)

Parameters

boolean

$delete_perm

Definition at line 982 of file class.ilDclTable.php.

References $delete_perm, and setDeleteByOwner().

Referenced by cloneStructure(), doRead(), and setDeleteByOwner().

    {
        $this->delete_perm = $delete_perm;
        if (!$delete_perm) {
            $this->setDeleteByOwner(false);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setDescription()

ilDclTable::setDescription

(

$description

)

Parameters

string

$description

Definition at line 1138 of file class.ilDclTable.php.

References $description.

Referenced by cloneStructure(), and doRead().

    {
        $this->description = $description;
    }

Here is the caller graph for this function:

setEditByOwner()

ilDclTable::setEditByOwner

(

$edit_by_owner

)

Parameters

boolean

$edit_by_owner

Definition at line 1003 of file class.ilDclTable.php.

References $edit_by_owner, and setEditPerm().

Referenced by cloneStructure(), doRead(), and setEditPerm().

    {
        $this->edit_by_owner = $edit_by_owner;
        if ($edit_by_owner) {
            $this->setEditPerm(true);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setEditPerm()

ilDclTable::setEditPerm

(

$edit_perm

)

Parameters

boolean

$edit_perm

Definition at line 1045 of file class.ilDclTable.php.

References $edit_perm, and setEditByOwner().

Referenced by cloneStructure(), doRead(), and setEditByOwner().

    {
        $this->edit_perm = $edit_perm;
        if (!$edit_perm) {
            $this->setEditByOwner(false);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setExportEnabled()

ilDclTable::setExportEnabled

(

$export_enabled

)

Parameters

boolean

$export_enabled

Definition at line 1432 of file class.ilDclTable.php.

References $export_enabled.

Referenced by cloneStructure(), and doRead().

    {
        $this->export_enabled = $export_enabled;
    }

Here is the caller graph for this function:

setId()

ilDclTable::setId

(

$a_id

)

Set table id.

Parameters

int

$a_id

Definition at line 305 of file class.ilDclTable.php.

Referenced by doCreate().

    {
        $this->id = $a_id;
    }

Here is the caller graph for this function:

setImportEnabled()

ilDclTable::setImportEnabled

(

$import_enabled

)

Parameters

boolean

$import_enabled

Definition at line 1485 of file class.ilDclTable.php.

References $import_enabled.

Referenced by cloneStructure(), and doRead().

    {
        $this->import_enabled = $import_enabled;
    }

Here is the caller graph for this function:

setIsVisible()

ilDclTable::setIsVisible

(

$is_visible

)

Parameters

boolean

$is_visible

Definition at line 1120 of file class.ilDclTable.php.

References $is_visible.

Referenced by cloneStructure(), and doRead().

    {
        $this->is_visible = $is_visible;
    }

Here is the caller graph for this function:

setLimited()

ilDclTable::setLimited

(

$limited

)

Parameters

boolean

$limited

Definition at line 1066 of file class.ilDclTable.php.

References $limited.

Referenced by cloneStructure(), and doRead().

    {
        $this->limited = $limited;
    }

Here is the caller graph for this function:

setLimitEnd()

ilDclTable::setLimitEnd

(

$limit_end

)

Parameters

string

$limit_end

Definition at line 1084 of file class.ilDclTable.php.

References $limit_end.

Referenced by cloneStructure(), and doRead().

    {
        $this->limit_end = $limit_end;
    }

Here is the caller graph for this function:

setLimitStart()

ilDclTable::setLimitStart

(

$limit_start

)

Parameters

string

$limit_start

Definition at line 1102 of file class.ilDclTable.php.

References $limit_start.

Referenced by cloneStructure(), and doRead().

    {
        $this->limit_start = $limit_start;
    }

Here is the caller graph for this function:

setObjId()

ilDclTable::setObjId

(

$a_id

)

Parameters

$a_id

Definition at line 325 of file class.ilDclTable.php.

Referenced by doRead().

    {
        $this->objId = $a_id;
    }

Here is the caller graph for this function:

setOrder()

ilDclTable::setOrder

(

$table_order

)

Parameters

int

$table_order

Definition at line 1476 of file class.ilDclTable.php.

References $table_order.

Referenced by cloneStructure(), and doRead().

    {
        $this->table_order = $table_order;
    }

Here is the caller graph for this function:

setPublicCommentsEnabled()

ilDclTable::setPublicCommentsEnabled

(

$public_comments

)

Parameters

boolean

$public_comments

Definition at line 1198 of file class.ilDclTable.php.

References $public_comments.

Referenced by cloneStructure(), and doRead().

    {
        $this->public_comments = $public_comments;
    }

Here is the caller graph for this function:

setSaveConfirmation()

ilDclTable::setSaveConfirmation

(

$save_confirmation

)

Parameters

boolean

$save_confirmation

Definition at line 1243 of file class.ilDclTable.php.

References $save_confirmation.

Referenced by cloneStructure(), and doRead().

    {
        $this->save_confirmation = $save_confirmation;
    }

Here is the caller graph for this function:

setTitle()

ilDclTable::setTitle

(

$a_title

)

Parameters

$a_title

Definition at line 343 of file class.ilDclTable.php.

Referenced by cloneStructure(), and doRead().

    {
        $this->title = $a_title;
    }

Here is the caller graph for this function:

setViewOwnRecordsPerm()

ilDclTable::setViewOwnRecordsPerm

(

$view_own_perm

)

Parameters

boolean

$view_own_perm

Definition at line 1216 of file class.ilDclTable.php.

Referenced by cloneStructure(), and doRead().

    {
        $this->view_own_records_perm = (int) $view_own_perm;
    }

Here is the caller graph for this function:

sortByOrder()

ilDclTable::sortByOrder ( &  $array )

protected

Parameters

$array

ilDclBaseFieldModel[] the array to sort

Definition at line 912 of file class.ilDclTable.php.

Referenced by buildOrderFields(), reloadFields(), and sortFields().

    {
        // php-bug: https://bugs.php.net/bug.php?id=50688
        // fixed in php 7 but for now we need the @ a workaround
        @usort($array, array($this, "compareOrder"));
    }

Here is the caller graph for this function:

sortFields()

ilDclTable::sortFields

(

&

$fields

)

sortFields

Parameters

$fields

ilDclBaseFieldModel[]

Definition at line 895 of file class.ilDclTable.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:

sortTableViews()

ilDclTable::sortTableViews

(

array

$tableviews = null

)

Parameters

ilDclTableView[]

$tableviews

Definition at line 536 of file class.ilDclTable.php.

References getTableViews().

    {
        if ($tableviews == null) {
            $tableviews = $this->getTableViews();
        }

        $order = 10;
        foreach ($tableviews as $tableview) {
            $tableview->setTableviewOrder($order);
            $tableview->update();
            $order += 10;
        }
    }

Here is the call graph for this function:

updateFields()

ilDclTable::updateFields

(

)

Update fields.

Definition at line 882 of file class.ilDclTable.php.

References getFields().

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

Here is the call graph for this function:

updateOrder()

ilDclTable::updateOrder

(

)

Definition at line 1463 of file class.ilDclTable.php.

References $DIC, $ilDB, $result, and getId().

Referenced by getOrder().

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $result = $ilDB->query('SELECT MAX(table_order) AS table_order FROM il_dcl_table WHERE obj_id = ' . $ilDB->quote($this->getCollectionObject()->getId(), 'integer'));
        $this->table_order = $ilDB->fetchObject($result)->table_order + 10;
        $ilDB->query('UPDATE il_dcl_table SET table_order = ' . $ilDB->quote($this->table_order, 'integer') . ' WHERE id = ' . $ilDB->quote($this->getId(), 'integer'));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$add_perm

ilDclTable::$add_perm

protected

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

Referenced by getAddPerm(), and setAddPerm().

$all_fields

ilDclTable::$all_fields = null

protected

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

Referenced by getFields().

$default_sort_field

ilDclTable::$default_sort_field = 0

protected

Definition at line 105 of file class.ilDclTable.php.

Referenced by cloneStructure(), getDefaultSortField(), and setDefaultSortField().

$default_sort_field_order

ilDclTable::$default_sort_field_order = 'asc'

protected

Definition at line 111 of file class.ilDclTable.php.

Referenced by getDefaultSortFieldOrder(), and setDefaultSortFieldOrder().

$delete_by_owner

ilDclTable::$delete_by_owner

protected

Definition at line 71 of file class.ilDclTable.php.

Referenced by getDeleteByOwner(), and setDeleteByOwner().

$delete_perm

ilDclTable::$delete_perm

protected

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

Referenced by getDeletePerm(), and setDeletePerm().

$description

ilDclTable::$description = ''

protected

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

Referenced by getDescription(), and setDescription().

$edit_by_owner

ilDclTable::$edit_by_owner

protected

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

Referenced by getEditByOwner(), and setEditByOwner().

$edit_perm

ilDclTable::$edit_perm

protected

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

Referenced by getEditPerm(), and setEditPerm().

$export_enabled

ilDclTable::$export_enabled

protected

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

Referenced by getExportEnabled(), and setExportEnabled().

$fields

ilDclTable::$fields

protected

Definition at line 39 of file class.ilDclTable.php.

Referenced by buildOrderFields(), getCustomFields(), getEditableFields(), getExportableFields(), getField(), getFieldIds(), getNewFieldOrder(), getRecordFields(), reloadFields(), and sortFields().

$id

ilDclTable::$id = 0

protected

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

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

$import_enabled

ilDclTable::$import_enabled

protected

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

Referenced by getImportEnabled(), and setImportEnabled().

$is_visible

ilDclTable::$is_visible

protected

Definition at line 51 of file class.ilDclTable.php.

Referenced by getIsVisible(), and setIsVisible().

$limit_end

ilDclTable::$limit_end

protected

Definition at line 87 of file class.ilDclTable.php.

Referenced by getLimitEnd(), and setLimitEnd().

$limit_start

ilDclTable::$limit_start

protected

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

Referenced by getLimitStart(), and setLimitStart().

$limited

ilDclTable::$limited

protected

Definition at line 79 of file class.ilDclTable.php.

Referenced by getLimited(), and setLimited().

$obj

ilDclTable::$obj

protected

Definition at line 31 of file class.ilDclTable.php.

Referenced by getCollectionObject().

$objId

ilDclTable::$objId

protected

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

Referenced by getObjId().

$public_comments

ilDclTable::$public_comments = 0

protected

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

Referenced by getPublicCommentsEnabled(), and setPublicCommentsEnabled().

$records

ilDclTable::$records

protected

Definition at line 47 of file class.ilDclTable.php.

Referenced by _hasFieldByTitle(), deleteField(), getRecords(), and loadRecords().

$save_confirmation

ilDclTable::$save_confirmation

protected

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

Referenced by getSaveConfirmation(), and setSaveConfirmation().

$stdFields

ilDclTable::$stdFields

protected

Definition at line 43 of file class.ilDclTable.php.

Referenced by getFirstTableViewId().

$table_order

ilDclTable::$table_order

protected

Definition at line 95 of file class.ilDclTable.php.

Referenced by getOrder(), and setOrder().

$title

ilDclTable::$title

protected

Definition at line 35 of file class.ilDclTable.php.

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

$view_own_records_perm

ilDclTable::$view_own_records_perm = 0

protected

Definition at line 129 of file class.ilDclTable.php.

Referenced by getViewOwnRecordsPerm().

---

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

• Modules/DataCollection/classes/Table/class.ilDclTable.php