ilWorkspaceFolderUserSettings Class Reference

User settings for workspace folders. More...

Collaboration diagram for ilWorkspaceFolderUserSettings:

Public Member Functions
	__construct (int $user_id, ilWorkspaceFolderUserSettingsRepository $repo, ilWorkspaceTree $tree=null)
	Constructor. More...
	getSortation (int $wfld_id)
	Get Sortation of workspace folder. More...
	updateSortation (int $wfld_id, int $sortation)
	Update sortation for workspace folder. More...
	getEffectiveSortation (int $wfld_wsp_id)
	Get effective sortation for a workspace folder (next upper context that has sortation > 0) More...

Protected Attributes
	$tree
	$user_id
	$repo

Detailed Description

User settings for workspace folders.

Author

killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 10 of file class.ilWorkspaceFolderUserSettings.php.

Constructor & Destructor Documentation

__construct()

ilWorkspaceFolderUserSettings::__construct	(	int	$user_id,
		ilWorkspaceFolderUserSettingsRepository	$repo,
		ilWorkspaceTree	$tree = null
	)

Constructor.

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

    {
        $this->repo = $repo;
        $this->user_id = $user_id;
        $this->tree = ($tree != null)
            ? $tree
            : new ilWorkspaceTree($user_id);
    }

References $repo, $tree, and $user_id.

Member Function Documentation

getEffectiveSortation()

ilWorkspaceFolderUserSettings::getEffectiveSortation

(

int

$wfld_wsp_id

)

Get effective sortation for a workspace folder (next upper context that has sortation > 0)

Parameters

int

$wfld_wsp_id

Returns

int|mixed

Definition at line 72 of file class.ilWorkspaceFolderUserSettings.php.

    {
        $tree = $this->tree;
 
        // get path
        $path = $tree->getPathId($wfld_wsp_id);
        // get object ids of path
        $obj_ids = array_map(function ($wsp_id) use ($tree) {
            return $tree->lookupObjectId($wsp_id);
        }, $path);
 
        // get sortations for object ids
        $sortations = $this->repo->getSortationMultiple($obj_ids);
 
        // search bottom to top first one with sortation > 0
        foreach (array_reverse($obj_ids) as $id) {
            if ($sortations[$id] > 0) {
                return $sortations[$id];
            }
        }
        return ilWorkspaceFolderSorting::SORT_ALPHABETICAL_ASC;
    }

References $tree, and ilWorkspaceFolderSorting\SORT_ALPHABETICAL_ASC.

getSortation()

ilWorkspaceFolderUserSettings::getSortation

(

int

$wfld_id

)

Get Sortation of workspace folder.

Parameters

int

$wfld_id

folder object id

Returns

int

Definition at line 44 of file class.ilWorkspaceFolderUserSettings.php.

                                               : int
    {
        $sort = $this->repo->getSortation($wfld_id);
        if ($sort > 0) {
            return $sort;
        }
        if (ilObject::_lookupType($wfld_id) == "wfld") {
            return ilWorkspaceFolderSorting::SORT_DERIVED;
        }
        return ilWorkspaceFolderSorting::SORT_ALPHABETICAL_ASC;
    }

References ilObject\_lookupType(), ilWorkspaceFolderSorting\SORT_ALPHABETICAL_ASC, and ilWorkspaceFolderSorting\SORT_DERIVED.

Here is the call graph for this function:

updateSortation()

ilWorkspaceFolderUserSettings::updateSortation	(	int	$wfld_id,
		int	$sortation
	)

Update sortation for workspace folder.

Parameters

int	$wfld_id	folder object id
int	$sortation

Definition at line 61 of file class.ilWorkspaceFolderUserSettings.php.

    {
        $this->repo->updateSortation($wfld_id, $sortation);
    }

Field Documentation

$repo

ilWorkspaceFolderUserSettings::$repo

protected

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

Referenced by __construct().

$tree

ilWorkspaceFolderUserSettings::$tree

protected

Definition at line 15 of file class.ilWorkspaceFolderUserSettings.php.

Referenced by __construct(), and getEffectiveSortation().

$user_id

ilWorkspaceFolderUserSettings::$user_id

protected

Definition at line 20 of file class.ilWorkspaceFolderUserSettings.php.

Referenced by __construct().

---

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

• Modules/WorkspaceFolder/UserSettings/classes/class.ilWorkspaceFolderUserSettings.php