ilContainerSortingSettings Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilContainerSortingSettings:

Public Member Functions
	__construct (int $a_obj_id=0)
	loadEffectiveSettings ()
	Load inherited settings. More...
	getInheritedSettings (int $a_container_obj_id)
	getSortMode ()
	getSortDirection ()
	getSortNewItemsPosition ()
	getSortNewItemsOrder ()
	setSortMode (int $a_mode)
	setSortDirection (int $a_direction)
	setSortNewItemsPosition (int $a_position)
	setSortNewItemsOrder (int $a_order)
	update ()
	save ()
	delete ()

Static Public Member Functions
static	getInstanceByObjId (int $a_obj_id)
static	_readSortMode (int $a_obj_id)
static	_lookupSortMode (int $a_obj_id)
static	lookupSortModeFromParentContainer (int $a_obj_id)
static	_cloneSettings (int $a_old_id, int $a_new_id)
static	sortModeToString (int $a_sort_mode)
	Get string representation of sort mode. More...
static	_exportContainerSortingSettings (ilXmlWriter $xml, int $obj_id)
	sorting XML-export for all container objects More...
static	_importContainerSortingSettings (array $attibs, int $obj_id)
	sorting import for all container objects More...

Protected Member Functions
	read ()

Protected Attributes
ilTree	$tree
int	$obj_id
int	$sort_mode = ilContainer::SORT_TITLE
int	$sort_direction = ilContainer::SORT_DIRECTION_ASC
int	$new_items_position = ilContainer::SORT_NEW_ITEMS_POSITION_BOTTOM
int	$new_items_order = ilContainer::SORT_NEW_ITEMS_ORDER_TITLE
ilDBInterface	$db

Static Private Attributes
static array	$instances = []

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

__construct()

ilContainerSortingSettings::__construct

(

int

$a_obj_id = 0

)

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

References $DIC, $ilDB, and read().

    {
        global $DIC;

        $this->tree = $DIC->repositoryTree();
        $ilDB = $DIC->database();

        $this->obj_id = $a_obj_id;
        $this->db = $ilDB;

        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

_cloneSettings()

static ilContainerSortingSettings::_cloneSettings ( int  $a_old_id, int  $a_new_id  )

static

Definition at line 148 of file class.ilContainerSortingSettings.php.

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

Referenced by ilContainer\_exportContainerSettings().

     : void {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "SELECT sort_mode,sort_direction,new_items_position,new_items_order " .
            "FROM container_sorting_set " .
            "WHERE obj_id = " . $ilDB->quote($a_old_id, 'integer') . " ";
        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchAssoc($res)) {
            $query = "DELETE FROM container_sorting_set " .
                "WHERE obj_id = " . $ilDB->quote($a_new_id) . " ";
            $ilDB->manipulate($query);

            $query = "INSERT INTO container_sorting_set  " .
                "(obj_id,sort_mode, sort_direction, new_items_position, new_items_order) " .
                "VALUES( " .
                $ilDB->quote($a_new_id, 'integer') . ", " .
                $ilDB->quote($row["sort_mode"], 'integer') . ", " .
                $ilDB->quote($row["sort_direction"], 'integer') . ', ' .
                $ilDB->quote($row["new_items_position"], 'integer') . ', ' .
                $ilDB->quote($row["new_items_order"], 'integer') . ' ' .
                ")";
            $ilDB->manipulate($query);
        }
    }

Here is the caller graph for this function:

_exportContainerSortingSettings()

static ilContainerSortingSettings::_exportContainerSortingSettings ( ilXmlWriter  $xml, int  $obj_id  )

static

sorting XML-export for all container objects

Definition at line 304 of file class.ilContainerSortingSettings.php.

References ILIAS\LTI\ToolProvider\$settings, ilContainer\SORT_ACTIVATION, ilContainer\SORT_CREATION, ilContainer\SORT_DIRECTION_ASC, ilContainer\SORT_INHERIT, ilContainer\SORT_MANUAL, ilContainer\SORT_NEW_ITEMS_ORDER_ACTIVATION, ilContainer\SORT_NEW_ITEMS_ORDER_CREATION, ilContainer\SORT_NEW_ITEMS_ORDER_TITLE, ilContainer\SORT_NEW_ITEMS_POSITION_BOTTOM, ilContainer\SORT_TITLE, and ilXmlWriter\xmlElement().

Referenced by ilCategoryXmlWriter\export(), ilGroupXMLWriter\start(), ilCourseXMLWriter\start(), and ilFolderXmlWriter\write().

     : void {
        $settings = self::getInstanceByObjId($obj_id);

        $attr = [];
        switch ($settings->getSortMode()) {
            case ilContainer::SORT_MANUAL:
                $order = 'Title';
                switch ($settings->getSortNewItemsOrder()) {
                    case ilContainer::SORT_NEW_ITEMS_ORDER_ACTIVATION:
                        $order = 'Activation';
                        break;
                    case ilContainer::SORT_NEW_ITEMS_ORDER_CREATION:
                        $order = 'Creation';
                        break;
                    case ilContainer::SORT_NEW_ITEMS_ORDER_TITLE:
                        $order = 'Title';
                        break;
                }

                $attr = [
                    'direction' => $settings->getSortDirection() === ilContainer::SORT_DIRECTION_ASC ? "ASC" : "DESC",
                    'position' => $settings->getSortNewItemsPosition() === ilContainer::SORT_NEW_ITEMS_POSITION_BOTTOM ? "Bottom" : "Top",
                    'order' => $order,
                    'type' => 'Manual'
                ];

                break;

            case ilContainer::SORT_CREATION:
                $attr = [
                    'direction' => $settings->getSortDirection() === ilContainer::SORT_DIRECTION_ASC ? "ASC" : "DESC",
                    'type' => 'Creation'
                ];
                break;

            case ilContainer::SORT_TITLE:
                $attr = [
                    'direction' => $settings->getSortDirection() === ilContainer::SORT_DIRECTION_ASC ? "ASC" : "DESC",
                    'type' => 'Title'
                ];
                break;
            case ilContainer::SORT_ACTIVATION:
                $attr = [
                    'direction' => $settings->getSortDirection() === ilContainer::SORT_DIRECTION_ASC ? "ASC" : "DESC",
                    'type' => 'Activation'
                ];
                break;
            case ilContainer::SORT_INHERIT:
                $attr = [
                    'type' => 'Inherit'
                ];
        }
        $xml->xmlElement('Sort', $attr);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_importContainerSortingSettings()

static ilContainerSortingSettings::_importContainerSortingSettings ( array  $attibs, int  $obj_id  )

static

sorting import for all container objects

Definition at line 365 of file class.ilContainerSortingSettings.php.

References ILIAS\LTI\ToolProvider\$settings, ilContainer\SORT_ACTIVATION, ilContainer\SORT_CREATION, ilContainer\SORT_DIRECTION_ASC, ilContainer\SORT_DIRECTION_DESC, ilContainer\SORT_MANUAL, ilContainer\SORT_NEW_ITEMS_ORDER_ACTIVATION, ilContainer\SORT_NEW_ITEMS_ORDER_CREATION, ilContainer\SORT_NEW_ITEMS_ORDER_TITLE, ilContainer\SORT_NEW_ITEMS_POSITION_BOTTOM, ilContainer\SORT_NEW_ITEMS_POSITION_TOP, and ilContainer\SORT_TITLE.

Referenced by ilFolderXmlParser\handlerBeginTag(), ilCategoryXmlParser\handlerBeginTag(), ilCourseXMLParser\handlerBeginTag(), and ilGroupXMLParser\initContainerSorting().

     : void {
        $settings = self::getInstanceByObjId($obj_id);

        switch ($attibs['type'] ?? '') {
            case 'Manual':
                $settings->setSortMode(ilContainer::SORT_MANUAL);
                break;
            case 'Creation':
                $settings->setSortMode(ilContainer::SORT_CREATION);
                break;
            case 'Title':
                $settings->setSortMode(ilContainer::SORT_TITLE);
                break;
            case 'Activation':
                $settings->setSortMode(ilContainer::SORT_ACTIVATION);
                break;
        }

        switch ($attibs['direction'] ?? '') {
            case 'ASC':
                $settings->setSortDirection(ilContainer::SORT_DIRECTION_ASC);
                break;
            case 'DESC':
                $settings->setSortDirection(ilContainer::SORT_DIRECTION_DESC);
                break;
        }

        switch ($attibs['position'] ?? "") {
            case "Top":
                $settings->setSortNewItemsPosition(ilContainer::SORT_NEW_ITEMS_POSITION_TOP);
                break;
            case "Bottom":
                $settings->setSortNewItemsPosition(ilContainer::SORT_NEW_ITEMS_POSITION_BOTTOM);
                break;
        }

        switch ($attibs['order'] ?? "") {
            case 'Creation':
                $settings->setSortNewItemsOrder(ilContainer::SORT_NEW_ITEMS_ORDER_CREATION);
                break;
            case 'Title':
                $settings->setSortNewItemsOrder(ilContainer::SORT_NEW_ITEMS_ORDER_TITLE);
                break;
            case 'Activation':
                $settings->setSortNewItemsOrder(ilContainer::SORT_NEW_ITEMS_ORDER_ACTIVATION);
        }

        $settings->update();
    }

Here is the caller graph for this function:

_lookupSortMode()

static ilContainerSortingSettings::_lookupSortMode ( int  $a_obj_id )

static

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

References $DIC, $ilDB, $query, $res, ilDBConstants\FETCHMODE_OBJECT, and ilContainer\SORT_INHERIT.

Referenced by ilObjLinkResourceGUI\activateTabs(), ilContainerGUI\addHeaderRow(), ilObjLinkResourceGUI\initFormSettings(), ilContainerGUI\isActiveItemOrdering(), ilObjFolder\read(), ilObjCourse\read(), ilObjGroup\read(), ilContainer\read(), ilWebLinkItemsContainer\sort(), ilObjLinkResource\toXML(), and ilObjLinkResourceGUI\view().

                                                         : int
    {
        global $DIC;

        $ilDB = $DIC->database();

        // Try to read from table
        $query = "SELECT sort_mode FROM container_sorting_set " .
            "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " ";
        $res = $ilDB->query($query);

        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            if ((int) $row->sort_mode !== ilContainer::SORT_INHERIT) {
                return (int) $row->sort_mode;
            }
        }
        return self::lookupSortModeFromParentContainer($a_obj_id);
    }

Here is the caller graph for this function:

_readSortMode()

static ilContainerSortingSettings::_readSortMode ( int  $a_obj_id )

static

Definition at line 106 of file class.ilContainerSortingSettings.php.

References $DIC, $ilDB, $query, $res, ilDBConstants\FETCHMODE_OBJECT, and ilContainer\SORT_INHERIT.

                                                       : int
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "SELECT sort_mode FROM container_sorting_set " .
            "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " ";
        $res = $ilDB->query($query);

        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return (int) $row->sort_mode;
        }
        return ilContainer::SORT_INHERIT;
    }

delete()

ilContainerSortingSettings::delete

(

)

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

References $db, $ilDB, and $query.

                            : void
    {
        $ilDB = $this->db;

        $query = 'DELETE FROM container_sorting_set WHERE obj_id = ' . $ilDB->quote($this->obj_id, 'integer');
        $ilDB->query($query);
    }

getInheritedSettings()

ilContainerSortingSettings::getInheritedSettings

(

int

$a_container_obj_id

)

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

References $obj_id, $ref_id, $tree, ilObject\_getAllReferences(), ilObject\_lookupObjId(), ilTree\checkForParentType(), and ilContainer\SORT_INHERIT.

Referenced by loadEffectiveSettings().

                                                                 : self
    {
        $tree = $this->tree;

        if (!$a_container_obj_id) {
            $a_container_obj_id = $this->obj_id;
        }

        $ref_ids = ilObject::_getAllReferences($a_container_obj_id);
        $ref_id = current($ref_ids);

        if ($cont_ref_id = $tree->checkForParentType($ref_id, 'grp', true)) {
            $parent_obj_id = ilObject::_lookupObjId($cont_ref_id);
            $parent_settings = self::getInstanceByObjId($parent_obj_id);

            if ($parent_settings->getSortMode() === ilContainer::SORT_INHERIT) {
                return $this->getInheritedSettings($parent_obj_id);
            }
            return $parent_settings;
        }

        if ($cont_ref_id = $tree->checkForParentType($ref_id, 'crs', true)) {
            $parent_obj_id = ilObject::_lookupObjId($cont_ref_id);
            $parent_settings = self::getInstanceByObjId($parent_obj_id);
            return $parent_settings;
        }
        // no parent settings found => return current settings
        return $this;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getInstanceByObjId()

static ilContainerSortingSettings::getInstanceByObjId ( int  $a_obj_id )

static

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

Referenced by ilCourseXMLParser\handlerBeginTag(), and ilContainerSorting\read().

                                                            : self
    {
        return self::$instances[$a_obj_id] ?? (self::$instances[$a_obj_id] = new self($a_obj_id));
    }

Here is the caller graph for this function:

getSortDirection()

ilContainerSortingSettings::getSortDirection

(

)

Definition at line 183 of file class.ilContainerSortingSettings.php.

References ilContainer\SORT_DIRECTION_ASC.

Referenced by ilContainerGUI\initSortingDirectionForm().

                                      : int
    {
        return $this->sort_direction ?: ilContainer::SORT_DIRECTION_ASC;
    }

Here is the caller graph for this function:

getSortMode()

ilContainerSortingSettings::getSortMode

(

)

Definition at line 178 of file class.ilContainerSortingSettings.php.

Referenced by ilObjFolderGUI\getEditFormCustomValues(), and loadEffectiveSettings().

                                 : int
    {
        return $this->sort_mode ?: 0;
    }

Here is the caller graph for this function:

getSortNewItemsOrder()

ilContainerSortingSettings::getSortNewItemsOrder

(

)

Definition at line 193 of file class.ilContainerSortingSettings.php.

References $new_items_order.

Referenced by ilContainerGUI\initManualSortingOptionForm().

                                          : int
    {
        return $this->new_items_order;
    }

Here is the caller graph for this function:

getSortNewItemsPosition()

ilContainerSortingSettings::getSortNewItemsPosition

(

)

Definition at line 188 of file class.ilContainerSortingSettings.php.

References $new_items_position.

Referenced by ilContainerGUI\initManualSortingOptionForm().

                                             : int
    {
        return $this->new_items_position;
    }

Here is the caller graph for this function:

loadEffectiveSettings()

ilContainerSortingSettings::loadEffectiveSettings

(

)

Load inherited settings.

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

References getInheritedSettings(), getSortMode(), ilContainer\SORT_INHERIT, and ilContainer\SORT_TITLE.

Referenced by ilContainerSorting\read().

                                           : self
    {
        if ($this->getSortMode() !== ilContainer::SORT_INHERIT) {
            return $this;
        }

        $effective_settings = $this->getInheritedSettings($this->obj_id);
        $inherited = clone $this;

        if ($effective_settings->getSortMode() === ilContainer::SORT_INHERIT) {
            $inherited->setSortMode(ilContainer::SORT_TITLE);
        } else {
            $inherited->setSortMode($effective_settings->getSortMode());
            $inherited->setSortNewItemsOrder($effective_settings->getSortNewItemsOrder());
            $inherited->setSortNewItemsPosition($effective_settings->getSortNewItemsPosition());
        }
        return $inherited;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

lookupSortModeFromParentContainer()

static ilContainerSortingSettings::lookupSortModeFromParentContainer ( int  $a_obj_id )

static

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

References ILIAS\LTI\ToolProvider\$settings.

Referenced by ilContainerGUI\initSortingForm().

                                                                           : int
    {
        $settings = self::getInstanceByObjId($a_obj_id);
        $inherited_settings = $settings->getInheritedSettings($a_obj_id);
        return $inherited_settings->getSortMode();
    }

Here is the caller graph for this function:

read()

ilContainerSortingSettings::read ( )

protected

Definition at line 256 of file class.ilContainerSortingSettings.php.

References $query, $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Referenced by __construct().

                             : void
    {
        if (!$this->obj_id) {
            return;
        }

        $query = "SELECT * FROM container_sorting_set " .
            "WHERE obj_id = " . $this->db->quote($this->obj_id, 'integer') . " ";

        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->sort_mode = (int) $row->sort_mode;
            $this->sort_direction = (int) $row->sort_direction;
            $this->new_items_position = (int) $row->new_items_position;
            $this->new_items_order = (int) $row->new_items_order;
            return;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilContainerSortingSettings::save

(

)

Definition at line 232 of file class.ilContainerSortingSettings.php.

References $db, $ilDB, and $query.

Referenced by update().

                          : void
    {
        $ilDB = $this->db;

        $query = "INSERT INTO container_sorting_set " .
            "(obj_id,sort_mode, sort_direction, new_items_position, new_items_order) " .
            "VALUES ( " .
            $this->db->quote($this->obj_id, 'integer') . ", " .
            $this->db->quote($this->sort_mode, 'integer') . ", " .
            $this->db->quote($this->sort_direction, 'integer') . ', ' .
            $this->db->quote($this->new_items_position, 'integer') . ', ' .
            $this->db->quote($this->new_items_order, 'integer') . ' ' .
            ")";
        $ilDB->manipulate($query);
    }

Here is the caller graph for this function:

setSortDirection()

ilContainerSortingSettings::setSortDirection

(

int

$a_direction

)

Definition at line 206 of file class.ilContainerSortingSettings.php.

                                                      : void
    {
        $this->sort_direction = $a_direction;
    }

setSortMode()

ilContainerSortingSettings::setSortMode

(

int

$a_mode

)

Parameters

int

$a_mode

MODE_TITLE | MODE_MANUAL | MODE_ACTIVATION

Definition at line 201 of file class.ilContainerSortingSettings.php.

Referenced by ilObjFolderGUI\afterSave(), ilObjGroupGUI\afterSave(), and ilObjLinkResourceGUI\saveSettings().

                                            : void
    {
        $this->sort_mode = $a_mode;
    }

Here is the caller graph for this function:

setSortNewItemsOrder()

ilContainerSortingSettings::setSortNewItemsOrder

(

int

$a_order

)

Definition at line 216 of file class.ilContainerSortingSettings.php.

                                                      : void
    {
        $this->new_items_order = $a_order;
    }

setSortNewItemsPosition()

ilContainerSortingSettings::setSortNewItemsPosition

(

int

$a_position

)

Definition at line 211 of file class.ilContainerSortingSettings.php.

                                                            : void
    {
        $this->new_items_position = $a_position;
    }

sortModeToString()

static ilContainerSortingSettings::sortModeToString ( int  $a_sort_mode )

static

Get string representation of sort mode.

Definition at line 278 of file class.ilContainerSortingSettings.php.

References $DIC, $lng, ilContainer\SORT_ACTIVATION, ilContainer\SORT_CREATION, ilContainer\SORT_MANUAL, and ilContainer\SORT_TITLE.

Referenced by ilContainerGUI\initSortingForm().

                                                             : string
    {
        global $DIC;

        $lng = $DIC->language();

        $lng->loadLanguageModule('crs');
        switch ($a_sort_mode) {
            case ilContainer::SORT_ACTIVATION:
                return $lng->txt('crs_sort_activation');

            case ilContainer::SORT_MANUAL:
                return $lng->txt('crs_sort_manual');

            case ilContainer::SORT_TITLE:
                return $lng->txt('crs_sort_title');

            case ilContainer::SORT_CREATION:
                return $lng->txt('sorting_creation_header');
        }
        return '';
    }

Here is the caller graph for this function:

update()

ilContainerSortingSettings::update

(

)

Definition at line 221 of file class.ilContainerSortingSettings.php.

References $db, $ilDB, $query, and save().

                            : void
    {
        $ilDB = $this->db;

        $query = "DELETE FROM container_sorting_set " .
            "WHERE obj_id = " . $ilDB->quote($this->obj_id, 'integer');
        $ilDB->manipulate($query);

        $this->save();
    }

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ilContainerSortingSettings::$db

protected

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

Referenced by delete(), save(), and update().

$instances

array ilContainerSortingSettings::$instances = []

staticprivate

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

$new_items_order

int ilContainerSortingSettings::$new_items_order = ilContainer::SORT_NEW_ITEMS_ORDER_TITLE

protected

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

Referenced by getSortNewItemsOrder().

$new_items_position

int ilContainerSortingSettings::$new_items_position = ilContainer::SORT_NEW_ITEMS_POSITION_BOTTOM

protected

Definition at line 30 of file class.ilContainerSortingSettings.php.

Referenced by getSortNewItemsPosition().

$obj_id

int ilContainerSortingSettings::$obj_id

protected

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

Referenced by getInheritedSettings().

$sort_direction

int ilContainerSortingSettings::$sort_direction = ilContainer::SORT_DIRECTION_ASC

protected

Definition at line 29 of file class.ilContainerSortingSettings.php.

$sort_mode

int ilContainerSortingSettings::$sort_mode = ilContainer::SORT_TITLE

protected

Definition at line 28 of file class.ilContainerSortingSettings.php.

$tree

ilTree ilContainerSortingSettings::$tree

protected

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

Referenced by getInheritedSettings().

---

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

• Services/Container/Sorting/class.ilContainerSortingSettings.php