Collaboration diagram for ilContainerSortingSettings:

Public Member Functions
	__construct ($a_obj_id=0)
	Constructor. More...

	loadEffectiveSettings ()
	Load inherited settings. More...

	getInheritedSettings ($a_container_obj_id)
	Read inherited settings of course/group ilTree $tree. More...

	getSortMode ()
	get sort mode More...

	getSortDirection ()
	Get sort direction. More...

	getSortNewItemsPosition ()
	GET new item position. More...

	getSortNewItemsOrder ()
	GET new item order. More...

	setSortMode ($a_mode)
	set sort mode More...

	setSortDirection ($a_direction)
	Set sort direction. More...

	setSortNewItemsPosition ($a_position)
	SET new item position. More...

	setSortNewItemsOrder ($a_order)
	SET new item order. More...

	update ()
	Update. More...

	save ()
	save settings More...

	delete ()
	Delete setting. More...

Static Public Member Functions
static	getInstanceByObjId ($a_obj_id)
	Get singleton instance. More...

static	_readSortMode ($a_obj_id)

static	_lookupSortMode ($a_obj_id)
	lookup sort mode More...

static	lookupSortModeFromParentContainer ($a_obj_id)
	Lookup sort mode from parent container. More...

static	_cloneSettings ($a_old_id, $a_new_id)
	Clone settings. More...

static	sortModeToString ($a_sort_mode)
	get String representation of sort mode More...

static	_exportContainerSortingSettings (ilXmlWriter $xml, $obj_id)
	sorting XML-export for all container objects More...

static	_importContainerSortingSettings ($attibs, $obj_id)
	sorting import for all container objects More...

Protected Member Functions
	read ()
	read settings More...

Protected Attributes
	$tree

	$obj_id

	$sort_mode = ilContainer::SORT_TITLE

	$sort_direction = ilContainer::SORT_DIRECTION_ASC

	$new_items_position = ilContainer::SORT_NEW_ITEMS_POSITION_BOTTOM

	$new_items_order = ilContainer::SORT_NEW_ITEMS_ORDER_TITLE

	$db

Static Private Attributes
static	$instances = array()

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilContainerSortingSettings::__construct ( $a_obj_id = 0 )

Constructor.

public

Parameters

Definition at line 59 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	(	$a_old_id,
		$a_new_id
	)

static

Clone settings.

public

Parameters

int	orig obj_id @þaram int new obj_id

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

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

Referenced by ilContainer\removeCustomIcon().

     {
         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);
         }
         return true;
     }

Here is the caller graph for this function:

◆ _exportContainerSortingSettings()

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

static

sorting XML-export for all container objects

Parameters

ilXmlWriter	$xml
	$obj_id

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

References $obj_id, array, 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().

     {
         $settings = self::getInstanceByObjId($obj_id);
 
         $attr = array();
         switch ($settings->getSortMode()) {
             case ilContainer::SORT_MANUAL:
                 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 = array(
                     '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 = array(
                     'direction' => $settings->getSortDirection() == ilContainer::SORT_DIRECTION_ASC ? "ASC" : "DESC",
                     'type' => 'Creation'
                 );
                 break;
 
             case ilContainer::SORT_TITLE:
                 $attr = array(
                     'direction' => $settings->getSortDirection() == ilContainer::SORT_DIRECTION_ASC ? "ASC" : "DESC",
                     'type' => 'Title'
                 );
                 break;
             case ilContainer::SORT_ACTIVATION:
                 $attr = array(
                     'direction' => $settings->getSortDirection() == ilContainer::SORT_DIRECTION_ASC ? "ASC" : "DESC",
                     'type' => 'Activation'
                 );
                 break;
             case ilContainer::SORT_INHERIT:
                 $attr = array(
                     '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	(	$attibs,
		$obj_id
	)

static

sorting import for all container objects

Parameters

$attibs	array (type, direction, position, order)
$obj_id

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

References $obj_id, 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 ilGroupXMLParser\__initContainerSorting(), ilFolderXmlParser\handlerBeginTag(), ilCourseXMLParser\handlerBeginTag(), and ilCategoryXmlParser\handlerBeginTag().

     {
         $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 ( $a_obj_id )

static

lookup sort mode

public

Parameters

int obj_id

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

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

Referenced by ilObjLinkResourceGUI\activateTabs(), ilContainerGUI\addStandardRow(), ilObjLinkResourceGUI\initFormSettings(), ilWebResourceLinkTableGUI\initSorting(), ilContainerGUI\isActiveItemOrdering(), ilObjFolder\read(), ilObjCourse\read(), ilObjGroup\read(), ilContainer\read(), ilLinkResourceItems\sortItems(), ilObjLinkResource\toXML(), and ilObjLinkResourceGUI\view().

     {
         global $DIC;
 
         $tree = $DIC->repositoryTree();
         $ilDB = $DIC->database();
         $objDefinition = $DIC["objDefinition"];
         
         // Try to read from table
         $query = "SELECT * 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 ($row->sort_mode != ilContainer::SORT_INHERIT) {
                 return $row->sort_mode;
             }
         }
         return self::lookupSortModeFromParentContainer($a_obj_id);
     }

Here is the caller graph for this function:

◆ _readSortMode()

static ilContainerSortingSettings::_readSortMode ( $a_obj_id )

static

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

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

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         $query = "SELECT * 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 $row->sort_mode;
         }
         return ilContainer::SORT_INHERIT;
     }

◆ delete()

ilContainerSortingSettings::delete ( )

Delete setting.

Returns

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

References $db, $ilDB, and $query.

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

◆ getInheritedSettings()

ilContainerSortingSettings::getInheritedSettings ( $a_container_obj_id )

Read inherited settings of course/group ilTree $tree.

Parameters

int $a_container_obj_id

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

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

Referenced by loadEffectiveSettings().

     {
         $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 ( $a_obj_id )

static

Get singleton instance.

Parameters

type $a_obj_id

Returns: ilContainerSortingSettings

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

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

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

Here is the caller graph for this function:

◆ getSortDirection()

ilContainerSortingSettings::getSortDirection ( )

Get sort direction.

Returns: type

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

References ilContainer\SORT_DIRECTION_ASC.

Referenced by ilContainerGUI\initSortingDirectionForm().

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

Here is the caller graph for this function:

◆ getSortMode()

ilContainerSortingSettings::getSortMode ( )

get sort mode

public

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

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

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

Here is the caller graph for this function:

◆ getSortNewItemsOrder()

ilContainerSortingSettings::getSortNewItemsOrder ( )

GET new item order.

Returns: int position

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

References $new_items_order.

Referenced by ilContainerGUI\initManualSortingOptionForm().

     {
         return $this->new_items_order;
     }

Here is the caller graph for this function:

◆ getSortNewItemsPosition()

ilContainerSortingSettings::getSortNewItemsPosition ( )

GET new item position.

Returns: int position

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

References $new_items_position.

Referenced by ilContainerGUI\initManualSortingOptionForm().

     {
         return $this->new_items_position;
     }

Here is the caller graph for this function:

◆ loadEffectiveSettings()

ilContainerSortingSettings::loadEffectiveSettings ( )

Load inherited settings.

Returns: ilContainerSortingSettings

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

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

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

◆ lookupSortModeFromParentContainer()

static ilContainerSortingSettings::lookupSortModeFromParentContainer ( $a_obj_id )

static

Lookup sort mode from parent container.

Parameters

object $a_obj_id

Returns

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

Referenced by ilContainerGUI\initSortingForm().

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

read settings

private

Parameters

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

References $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by __construct().

     {
         if (!$this->obj_id) {
             return true;
         }
         
         $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 = $row->sort_mode;
             $this->sort_direction = $row->sort_direction;
             $this->new_items_position = $row->new_items_position;
             $this->new_items_order = $row->new_items_order;
             return true;
         }
     }

Here is the caller graph for this function:

◆ save()

ilContainerSortingSettings::save ( )

save settings

public

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

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

Referenced by update().

     {
         $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') . ' ' .
             ")";
         $res = $ilDB->manipulate($query);
     }

Here is the caller graph for this function:

◆ setSortDirection()

ilContainerSortingSettings::setSortDirection ( $a_direction )

Set sort direction.

Parameters

type $a_direction

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

     {
         $this->sort_direction = (int) $a_direction;
     }

◆ setSortMode()

ilContainerSortingSettings::setSortMode ( $a_mode )

set sort mode

public

Parameters

int	MODE_TITLE \| MODE_MANUAL \| MODE_ACTIVATION

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

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

     {
         $this->sort_mode = (int) $a_mode;
     }

Here is the caller graph for this function:

◆ setSortNewItemsOrder()

ilContainerSortingSettings::setSortNewItemsOrder ( $a_order )

SET new item order.

Parameters

int $a_order

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

     {
         $this->new_items_order = (int) $a_order;
     }

◆ setSortNewItemsPosition()

ilContainerSortingSettings::setSortNewItemsPosition ( $a_position )

SET new item position.

Parameters

int $a_position

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

     {
         $this->new_items_position = (int) $a_position;
     }

◆ sortModeToString()

static ilContainerSortingSettings::sortModeToString ( $a_sort_mode )

static

get String representation of sort mode

Parameters

int $a_sort_mode

Returns

Definition at line 400 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().

     {
         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 ( )

Update.

public

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

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

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