Collaboration diagram for ilContainerSortingSettings:

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

	_isManualSortingEnabled ($a_obj_id)
	is manual sorting enabled More...

	getSortMode ()
	get sort mode More...

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

	update ()
	Update. More...

	save ()
	save settings More...

	delete ()
	Delete setting. More...

Static Public Member Functions
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...

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

Protected Attributes
	$obj_id

	$sort_mode

	$db

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilContainerSortingSettings::__construct ( $a_obj_id )

Constructor.

public

Parameters

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

References read().

         {
                 global $ilDB;
                 
                 $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 163 of file class.ilContainerSortingSettings.php.

References $ilLog, $query, $res, and $row.

         {
                 global $ilLog;
                 global $ilDB;
                 
                 $query = "SELECT sort_mode FROM container_sorting_set ".
                         "WHERE obj_id = ".$ilDB->quote($a_old_id ,'integer')." ";
                 $res = $ilDB->query($query);
                 while($row = $res->fetchRow())
                 {
                         $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) ".
                                 "VALUES( ".
                                 $ilDB->quote($a_new_id ,'integer').", ".
                                 $ilDB->quote($row[0] ,'integer')." ".
                                 ")";
                         $ilDB->manipulate($query);
                 }
                 return true;
         }

◆ _isManualSortingEnabled()

ilContainerSortingSettings::_isManualSortingEnabled ( $a_obj_id )

is manual sorting enabled

public

Parameters

int obj_id

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

References ilContainer\SORT_MANUAL.

Referenced by ilContainerSorting\read().

         {
                 return self::_lookupSortMode($a_obj_id) == ilContainer::SORT_MANUAL;
         }

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 83 of file class.ilContainerSortingSettings.php.

References $query, $res, $row, DB_FETCHMODE_OBJECT, and ilContainer\SORT_INHERIT.

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

         {
                 global $tree, $ilDB, $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(DB_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 59 of file class.ilContainerSortingSettings.php.

References $query, $res, $row, DB_FETCHMODE_OBJECT, and ilContainer\SORT_INHERIT.

         {
                 global $ilDB;
                 
                 $query = "SELECT * FROM container_sorting_set ".
                         "WHERE obj_id = ".$ilDB->quote($a_obj_id ,'integer')." ";
                 $res = $ilDB->query($query);
                 
                 while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                 {
                         return $row->sort_mode;
                 }
                 return ilContainer::SORT_INHERIT;
         }

◆ delete()

ilContainerSortingSettings::delete ( )

Delete setting.

Returns

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

References $query.

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

◆ getSortMode()

ilContainerSortingSettings::getSortMode ( )

get sort mode

public

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

Referenced by ilObjFolderGUI\getEditFormCustomValues().

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

Here is the caller 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 107 of file class.ilContainerSortingSettings.php.

References $ref_id, $sort_mode, ilObject\_getAllReferences(), ilObject\_lookupObjId(), ilObject\_lookupType(), ilContainer\SORT_INHERIT, and ilContainer\SORT_TITLE.

Referenced by ilObjFolderGUI\initEditCustomForm(), and ilObjGroupGUI\initForm().

         {
                 global $tree, $ilDB, $objDefinition;
 
                 if(!$objDefinition->isContainer(ilObject::_lookupType($a_obj_id)))
                 {
                         return ilContainer::SORT_TITLE;
                 }
                 
                 $ref_ids = ilObject::_getAllReferences($a_obj_id);
                 $ref_id = current($ref_ids);
 
                 
                 if($cont_ref_id = $tree->checkForParentType($ref_id,'grp'))
                 {
                         $a_obj_id = ilObject::_lookupObjId($cont_ref_id);
                         $sort_mode = self::_readSortMode($a_obj_id);
                         if($sort_mode != ilContainer::SORT_INHERIT)
                         {
                                 return $sort_mode;
                         }
                 }
                 if($cont_ref_id = $tree->checkForParentType($ref_id,'crs'))
                 {
                         $a_obj_id = ilObject::_lookupObjId($cont_ref_id);
                         $sort_mode = self::_readSortMode($a_obj_id);
                         if($sort_mode != ilContainer::SORT_INHERIT)
                         {
                                 return $sort_mode;
                         }
                 }
                 return ilContainer::SORT_TITLE;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilContainerSortingSettings::read ( )

protected

read settings

private

Parameters

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

References $query, $res, $row, and DB_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(DB_FETCHMODE_OBJECT))
                 {
                         $this->sort_mode = $row->sort_mode;
                         return TRUE;
                 }
         }

Here is the caller graph for this function:

◆ save()

ilContainerSortingSettings::save ( )

save settings

public

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

References $query, and $res.

Referenced by update().

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

Here is the caller graph for this function:

◆ setSortMode()

ilContainerSortingSettings::setSortMode ( $a_mode )

set sort mode

public

Parameters

int	MODE_TITLE \| MODE_MANUAL \| MODE_ACTIVATION

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

Referenced by ilObjFolderGUI\afterSave(), ilObjCategoryGUI\afterSave(), ilContainer\cloneObject(), ilObjGroupGUI\saveObject(), ilObjLinkResourceGUI\saveSettings(), ilObjFolderGUI\updateCustom(), ilObjRootFolderGUI\updateObject(), ilObjGroupGUI\updateObject(), and ilObjCategoryGUI\updateObject().

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

Here is the caller graph for this function:

◆ sortModeToString()

static ilContainerSortingSettings::sortModeToString ( $a_sort_mode )

static

get String representation of sort mode

Parameters

int $a_sort_mode

Returns

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

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

Referenced by ilObjFolderGUI\initEditCustomForm().

         {
                 global $lng;
                 
                 $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');
                                  
                 }
                 return '';
         }

Here is the caller graph for this function:

◆ update()

ilContainerSortingSettings::update ( )

Update.

public

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

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

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

Here is the call graph for this function:

Field Documentation

◆ $db

ilContainerSortingSettings::$db

protected

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

◆ $obj_id

ilContainerSortingSettings::$obj_id

protected

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

◆ $sort_mode

ilContainerSortingSettings::$sort_mode

protected

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

Referenced by lookupSortModeFromParentContainer().

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

Services/Container/classes/class.ilContainerSortingSettings.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _cloneSettings()

◆ _isManualSortingEnabled()

◆ _lookupSortMode()

◆ _readSortMode()

◆ delete()

◆ getSortMode()

◆ lookupSortModeFromParentContainer()

◆ read()

◆ save()

◆ setSortMode()

◆ sortModeToString()

◆ update()

Field Documentation

◆ $db

◆ $obj_id

◆ $sort_mode