ilUserUtil Class Reference

Class ilUserUtil. More...

Collaboration diagram for ilUserUtil:

Static Public Member Functions
static	getNamePresentation ( $a_user_id, $a_user_image=false, $a_profile_link=false, $a_profile_back_link="", $a_force_first_lastname=false, $a_omit_login=false, $a_sortable=true, $a_return_data_array=false, $a_ctrl_path="ilpublicuserprofilegui")
	Default behaviour is: More...
static	hasPublicProfile ($a_user_id)
	Has public profile. More...
static	getProfileLink ($a_usr_id)
	Get link to personal profile Return empty string in case of not public profile. More...
static	getPossibleStartingPoints ($a_force_all=false)
	Get all valid starting points. More...
static	setStartingPoint ($a_value, $a_ref_id=null)
	Set starting point setting. More...
static	getStartingPoint ()
	Get current starting point setting. More...
static	getStartingPointAsUrl ()
	Get current starting point setting as URL. More...
static	getStartingObject ()
	Get ref id of starting object. More...
static	togglePersonalStartingPoint ($a_value)
	Toggle personal starting point setting. More...
static	hasPersonalStartingPoint ()
	Can starting point be personalized? More...
static	hasPersonalStartPointPref ()
	Did user set any personal starting point (yet)? More...
static	getPersonalStartingPoint ()
	Get current personal starting point. More...
static	setPersonalStartingPoint ($a_value, $a_ref_id=null)
	Set personal starting point setting. More...
static	getPersonalStartingObject ()
	Get ref id of personal starting object. More...

Data Fields
const	START_PD_OVERVIEW = 1
const	START_PD_SUBSCRIPTION = 2
const	START_PD_BOOKMARKS = 3
const	START_PD_NOTES = 4
const	START_PD_NEWS = 5
const	START_PD_WORKSPACE = 6
const	START_PD_PORTFOLIO = 7
const	START_PD_SKILLS = 8
const	START_PD_LP = 9
const	START_PD_CALENDAR = 10
const	START_PD_MAIL = 11
const	START_PD_CONTACTS = 12
const	START_PD_PROFILE = 13
const	START_PD_SETTINGS = 14
const	START_REPOSITORY = 15
const	START_REPOSITORY_OBJ = 16
const	START_PD_MYSTAFF = 17

Detailed Description

Class ilUserUtil.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 12 of file class.ilUserUtil.php.

Member Function Documentation

getNamePresentation()

static ilUserUtil::getNamePresentation (   $a_user_id,   $a_user_image = false,   $a_profile_link = false,   $a_profile_back_link = "",   $a_force_first_lastname = false,   $a_omit_login = false,   $a_sortable = true,   $a_return_data_array = false,   $a_ctrl_path = "ilpublicuserprofilegui"  )

static

Default behaviour is:

• lastname, firstname if public profile enabled
• [loginname] (always) modifications by jposselt at databay . de : if $a_user_id is an array of user ids the method returns an array of "id" => "NamePresentation" pairs.

...

Parameters

boolean

sortable should be used in table presentions. output is "Doe, John" title is ommited

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

References $d, $data, $DIC, $id, $ilCtrl, $ilDB, $img, $lng, $row, and $title.

Referenced by ilMStShowUserGUI\__construct(), ilSurveyAppraiseesTableGUI\__construct(), ilMDCopyrightUsageTableGUI\collectData(), ilSystemNotification\compose(), ilGroupAddToGroupActionGUI\confirmAddUser(), ilSurveyParticipantsGUI\confirmAdminAppraiseesCloseObject(), ilGroupAddToGroupActionGUI\confirmCreateGroupAndAddUser(), ilBadgeManagementGUI\confirmDeassignBadge(), ilExerciseManagementGUI\confirmDeassignMembersObject(), ilSurveyParticipantsGUI\confirmDeleteAppraiseesObject(), ilMailingListsGUI\confirmDeleteMembers(), ilSurveyParticipantsGUI\confirmDeleteRatersObject(), ilConsultationHoursGUI\confirmRejectBooking(), ilCourseParticipantsGroupsGUI\confirmRemove(), ilObjBlogGUI\confirmRemoveContributor(), ilExSubmissionTeamGUI\confirmRemoveTeamMemberObject(), ilExSubmissionTeamGUI\createTeamObject(), ilExerciseManagementGUI\createTeamsFromGroupsObject(), ilContSkillAdminGUI\deassignCompetencesConfirm(), ilObjDataCollection\doUpdate(), ilPageObjectGUI\edit(), ilSharedResourceGUI\executeCommand(), ilExerciseManagementGUI\executeCommand(), ilUserForTagTableGUI\fillRow(), ilHistoryTableGUI\fillRow(), ilPageHistoryTableGUI\fillRow(), ilExcDeliveredFilesTableGUI\fillRow(), ilWikiRecentChangesTableGUI\fillRow(), ilExAssignmentListTextTableGUI\fillRow(), ilWikiPagesTableGUI\fillRow(), ilWorkspaceShareTableGUI\fillRow(), ilBookingReservationsTableGUI\fillRow(), ilAwarenessData\getData(), ilOnScreenChatUserDataProvider\getDataByUserIds(), ilContributorTableGUI\getItems(), ilExAssignmentPeerReviewTableGUI\getItems(), ilExAssignmentTeamTableGUI\getItems(), ilLMPageObjectGUI\getLinkXML(), ilGlossaryPresentationGUI\getLinkXML(), ilLMPresentationGUI\getLinkXML(), ilNoteGUI\getNoteListHTML(), ilAwarenessData\getOnlineUserData(), ilExSubmissionTeamGUI\getOverviewContent(), ilWikiPagesTableGUI\getPages(), ilAbstractUsersGalleryCollectionProvider\getPopulatedGroup(), ilDclBaseRecordModel\getStandardFieldHTML(), ilAppointmentPresentationGUI\getUserName(), ilInternalLinkGUI\getUserSearchResult(), ilBlogPosting\handleNews(), ilWorkspaceAccessTableGUI\importData(), ilObjSurveyGUI\infoScreen(), ilObjFileGUI\infoScreenForward(), ilLearningProgressBaseGUI\initEditUserForm(), ilSurveyParticipantsGUI\initExternalRaterForm(), ilCalendarCategoryGUI\initFormCategory(), ilExerciseManagementGUI\initGroupForm(), ilExPeerReviewGUI\initPeerReviewItemForm(), ilChatroomViewGUI\lostConnection(), ilSurveyExecutionGUI\outSurveyPage(), ilExAssignmentListTextTableGUI\parse(), ilConsultationHourBookingTableGUI\parse(), ilCronManagerTableGUI\parseJobToData(), ilMembershipCronNotifications\parseNewsItem(), ilMailingListsGUI\performDeleteMembers(), ilBuddySystemRelationsTableGUI\populate(), ilBlogPostingGUI\postOutputProcessing(), ilWikiPageGUI\preview(), ilContSkillAdminGUI\publishAssignments(), ilNewsTimelineItemGUI\render(), ilExPeerReviewGUI\renderInfoWidget(), ilObjBlogGUI\renderList(), ilLikeGUI\renderModal(), ilObjBlogGUI\renderNavigationByAuthors(), ilPublicUserProfileGUI\renderTitle(), ilBuddySystemNotification\send(), ilLMMailNotification\send(), ilObjSurvey\send360ReminderToUser(), ilWikiUtil\sendNotification(), ilObjSurvey\sendNotificationMail(), ilNote\sendNotifications(), ilObjSurvey\sendRaterNotification(), ilPageObjectGUI\setDefaultLinkXml(), ilChatroomBanGUI\show(), ilMailingListsGUI\showMembersList(), ilPageObjectGUI\showPage(), ilExAssignmentPeerReviewOverviewTableGUI\translateUserIds(), and ilPageObject\update().

      {
        global $DIC;

        $lng = $DIC['lng'];
        $ilCtrl = $DIC['ilCtrl'];
        $ilDB = $DIC['ilDB'];

        if (!is_array($a_ctrl_path)) {
            $a_ctrl_path = array($a_ctrl_path);
        }

        if (!($return_as_array = is_array($a_user_id))) {
            $a_user_id = array($a_user_id);
        }
        
        $sql = 'SELECT
                                        a.usr_id, 
                                        firstname,
                                        lastname,
                                        title,
                                        login,
                                        b.value public_profile,
                                        c.value public_title
                                FROM
                                        usr_data a 
                                        LEFT JOIN 
                                                usr_pref b ON 
                                                        (a.usr_id = b.usr_id AND
                                                        b.keyword = %s)
                                        LEFT JOIN 
                                                usr_pref c ON 
                                                        (a.usr_id = c.usr_id AND
                                                        c.keyword = %s)
                                WHERE ' . $ilDB->in('a.usr_id', $a_user_id, false, 'integer');
        
        $userrow = $ilDB->queryF($sql, array('text', 'text'), array('public_profile', 'public_title'));

        $names = array();

        $data = array();
        while ($row = $ilDB->fetchObject($userrow)) {
            $pres = '';
            $d = array("id" => $row->usr_id, "title" => "", "lastname" => "", "firstname" => "", "img" => "", "link" => "",
                "public_profile" => "");
            $has_public_profile = in_array($row->public_profile, array("y", "g"));
            if ($a_force_first_lastname || $has_public_profile) {
                $title = "";
                if ($row->public_title == "y" && $row->title) {
                    $title = $row->title . " ";
                }
                $d["title"] = $title;
                if ($a_sortable) {
                    $pres = $row->lastname;
                    if (strlen($row->firstname)) {
                        $pres .= (', ' . $row->firstname . ' ');
                    }
                } else {
                    $pres = $title;
                    if (strlen($row->firstname)) {
                        $pres .= $row->firstname . ' ';
                    }
                    $pres .= ($row->lastname . ' ');
                }
                $d["firstname"] = $row->firstname;
                $d["lastname"] = $row->lastname;
            }
            $d["login"] = $row->login;
            $d["public_profile"] = $has_public_profile;

            
            if (!$a_omit_login) {
                $pres .= "[" . $row->login . "]";
            }

            if ($a_profile_link && $has_public_profile) {
                $ilCtrl->setParameterByClass(end($a_ctrl_path), "user_id", $row->usr_id);
                if ($a_profile_back_link != "") {
                    $ilCtrl->setParameterByClass(
                        end($a_ctrl_path),
                        "back_url",
                        rawurlencode($a_profile_back_link)
                    );
                }
                $link = $ilCtrl->getLinkTargetByClass($a_ctrl_path, "getHTML");
                $pres = '<a href="' . $link . '">' . $pres . '</a>';
                $d["link"] = $link;
            }
    
            if ($a_user_image) {
                $img = ilObjUser::_getPersonalPicturePath($row->usr_id, "xxsmall");
                $pres = '<img class="ilUserXXSmall" src="' . $img . '" alt="' . $lng->txt("icon") .
                    " " . $lng->txt("user_picture") . '" /> ' . $pres;
                $d["img"] = $img;
            }

            $names[$row->usr_id] = $pres;
            $data[$row->usr_id] = $d;
        }

        foreach ($a_user_id as $id) {
            if (!$names[$id]) {
                $names[$id] = $lng->txt('usr_name_undisclosed');
            }
        }

        if ($a_return_data_array) {
            if ($return_as_array) {
                return $data;
            } else {
                return current($data);
            }
        }
        return $return_as_array ? $names : $names[$a_user_id[0]];
    }

Here is the caller graph for this function:

getPersonalStartingObject()

static ilUserUtil::getPersonalStartingObject ( )

static

Get ref id of personal starting object.

Returns

int

Definition at line 543 of file class.ilUserUtil.php.

References $DIC, and $ilUser.

Referenced by ilPersonalSettingsGUI\initGeneralSettingsForm().

    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        
        $ref_id = $ilUser->getPref("usr_starting_point_ref_id");
        if (!$ref_id) {
            $ref_id = self::getStartingObject();
        }
        return $ref_id;
    }

Here is the caller graph for this function:

getPersonalStartingPoint()

static ilUserUtil::getPersonalStartingPoint ( )

static

Get current personal starting point.

Returns

int

Definition at line 485 of file class.ilUserUtil.php.

References $current, $DIC, $ilUser, and $valid.

Referenced by ilPersonalSettingsGUI\initGeneralSettingsForm().

    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
                                
        $valid = array_keys(self::getPossibleStartingPoints());
        $current = $ilUser->getPref("usr_starting_point");
        if ($current == self::START_REPOSITORY_OBJ) {
            return $current;
        } elseif (!$current || !in_array($current, $valid)) {
            return self::getStartingPoint();
        }
        return $current;
    }

Here is the caller graph for this function:

getPossibleStartingPoints()

static ilUserUtil::getPossibleStartingPoints (   $a_force_all = false )

static

Get all valid starting points.

Returns

array

Definition at line 218 of file class.ilUserUtil.php.

References $DIC, $ilSetting, $lang, $lng, ilCalendarSettings\_getInstance(), and ilMyStaffAccess\getInstance().

Referenced by ilUserRoleStartingPointTableGUI\getItems(), ilUserStartingPointGUI\getRoleStartingPointForm(), and ilPersonalSettingsGUI\initGeneralSettingsForm().

    {
        global $DIC;

        $ilSetting = $DIC['ilSetting'];
        $lng = $DIC['lng'];
        
        // for all conditions: see ilMainMenuGUI
        
        $all = array();
        
        $all[self::START_PD_OVERVIEW] = 'overview';
        
        if ($a_force_all || ($ilSetting->get('disable_my_offers') == 0 &&
            $ilSetting->get('disable_my_memberships') == 0)) {
            $all[self::START_PD_SUBSCRIPTION] = 'my_courses_groups';
        }

        if (ilMyStaffAccess::getInstance()->hasCurrentUserAccessToMyStaff()) {
            $all[self::START_PD_MYSTAFF] = 'my_staff';
        }
    
        if ($a_force_all || !$ilSetting->get("disable_personal_workspace")) {
            $all[self::START_PD_WORKSPACE] = 'personal_workspace';
        }

        include_once('./Services/Calendar/classes/class.ilCalendarSettings.php');
        $settings = ilCalendarSettings::_getInstance();
        if ($a_force_all || $settings->isEnabled()) {
            $all[self::START_PD_CALENDAR] = 'calendar';
        }

        $all[self::START_REPOSITORY] = 'repository';
        
        foreach ($all as $idx => $lang) {
            $all[$idx] = $lng->txt($lang);
        }
        
        return $all;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getProfileLink()

static ilUserUtil::getProfileLink (   $a_usr_id )

static

Get link to personal profile Return empty string in case of not public profile.

Parameters

type

$a_usr_id

Returns

string

Definition at line 197 of file class.ilUserUtil.php.

References $GLOBALS, and ilObjUser\_lookupPref().

Referenced by ilMDCopyrightUsageTableGUI\collectData(), and ilRepositoryUserResultTableGUI\initMultiCommands().

    {
        $public_profile = ilObjUser::_lookupPref($a_usr_id, 'public_profile');
        if ($public_profile != 'y' and $public_profile != 'g') {
            return '';
        }
        
        $GLOBALS['DIC']['ilCtrl']->setParameterByClass('ilpublicuserprofilegui', 'user', $a_usr_id);
        return $GLOBALS['DIC']['ilCtrl']->getLinkTargetByClass('ilpublicuserprofilegui', 'getHTML');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getStartingObject()

static ilUserUtil::getStartingObject ( )

static

Get ref id of starting object.

Returns

int

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

References $DIC, and $ilSetting.

Referenced by ilUserRoleStartingPointTableGUI\getItems(), and ilUserStartingPointGUI\getRoleStartingPointForm().

    {
        global $DIC;

        $ilSetting = $DIC['ilSetting'];
        
        return $ilSetting->get("usr_starting_point_ref_id");
    }

Here is the caller graph for this function:

getStartingPoint()

static ilUserUtil::getStartingPoint ( )

static

Get current starting point setting.

Returns

int

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

References $current, $DIC, $ilSetting, $ilUser, and $valid.

Referenced by ilUserRoleStartingPointTableGUI\getItems(), and ilUserStartingPointGUI\getRoleStartingPointForm().

    {
        global $DIC;

        $ilSetting = $DIC['ilSetting'];
        $ilUser = $DIC['ilUser'];
                
        $valid = array_keys(self::getPossibleStartingPoints());
        $current = $ilSetting->get("usr_starting_point");
        if ($current == self::START_REPOSITORY_OBJ) {
            return $current;
        } elseif (!$current || !in_array($current, $valid)) {
            $current = self::START_PD_OVERVIEW;
                    
            // #10715 - if 1 is disabled overview will display the current default
            if ($ilSetting->get('disable_my_offers') == 0 &&
                $ilSetting->get('disable_my_memberships') == 0 &&
                $ilSetting->get('personal_items_default_view') == 1) {
                $current = self::START_PD_SUBSCRIPTION;
            }
            
            self::setStartingPoint($current);
        }
        if ($ilUser->getId() == ANONYMOUS_USER_ID ||
            !$ilUser->getId()) { // #18531
            $current = self::START_REPOSITORY;
        }
        return $current;
    }

Here is the caller graph for this function:

getStartingPointAsUrl()

static ilUserUtil::getStartingPointAsUrl ( )

static

Get current starting point setting as URL.

Returns

string

self::START_PD_LP => 'ilias.php?baseClass=ilPersonalDesktopGUI&cmd=jumpToLP',

Definition at line 330 of file class.ilUserUtil.php.

References $current, $DIC, $ilUser, $map, $tree, ilLink\_getStaticLink(), ilObject\_lookupObjId(), ilPersonalDesktopGUI\CMD_JUMP_TO_MY_STAFF, ilStartingPoint\getRolesWithStartingPoint(), and ilStartingPoint\ROLE_BASED.

Referenced by ilMainMenuGUI\getHeaderURL(), and ilInitialisation\redirect().

    {
        global $DIC;

        $tree = $DIC['tree'];
        $ilUser = $DIC['ilUser'];
        $rbacreview = $DIC['rbacreview'];
        
        $ref_id = 1;
        $by_default = true;

        //configuration by user preference
        #21782
        if (self::hasPersonalStartingPoint() && $ilUser->getPref('usr_starting_point') != null) {
            $current = self::getPersonalStartingPoint();
            if ($current == self::START_REPOSITORY_OBJ) {
                $ref_id = self::getPersonalStartingObject();
            }
        } else {
            include_once './Services/AccessControl/classes/class.ilStartingPoint.php';

            if (ilStartingPoint::ROLE_BASED) {
                //getting all roles with starting points and store them in array
                $roles = ilStartingPoint::getRolesWithStartingPoint();

                $roles_ids = array_keys($roles);

                $gr = array();
                foreach ($rbacreview->getGlobalRoles() as $role_id) {
                    if ($rbacreview->isAssigned($ilUser->getId(), $role_id)) {
                        if (in_array($role_id, $roles_ids)) {
                            $gr[$roles[$role_id]['position']] = array(
                                "point" => $roles[$role_id]['starting_point'],
                                "object" => $roles[$role_id]['starting_object']
                            );
                        }
                    }
                }
                if (!empty($gr)) {
                    krsort($gr);        // ak: if we use array_pop (last element) we need to reverse sort, since we want the one with the smallest number
                    $role_point = array_pop($gr);
                    $current = $role_point['point'];
                    $ref_id = $role_point['object'];
                    $by_default = false;
                }
            }
            if ($by_default) {
                $current = self::getStartingPoint();

                if ($current == self::START_REPOSITORY_OBJ) {
                    $ref_id = self::getStartingObject();
                }
            }
        }

        switch ($current) {
            case self::START_REPOSITORY:
                $ref_id = $tree->readRootId();

                // no break
            case self::START_REPOSITORY_OBJ:
                if ($ref_id &&
                    ilObject::_lookupObjId($ref_id) &&
                    !$tree->isDeleted($ref_id)) {
                    include_once('./Services/Link/classes/class.ilLink.php');
                    return ilLink::_getStaticLink($ref_id, '', true);
                }
                // invalid starting object, overview is fallback
                $current = self::START_PD_OVERVIEW;
                // fallthrough

                // no break
            default:
                $map = array(
                    self::START_PD_OVERVIEW => 'ilias.php?baseClass=ilPersonalDesktopGUI&cmd=jumpToSelectedItems',
                    self::START_PD_SUBSCRIPTION => 'ilias.php?baseClass=ilPersonalDesktopGUI&cmd=jumpToMemberships',
                    // self::START_PD_BOOKMARKS => 'ilias.php?baseClass=ilPersonalDesktopGUI&cmd=jumpToBookmarks',
                    // self::START_PD_NOTES => 'ilias.php?baseClass=ilPersonalDesktopGUI&cmd=jumpToNotes',
                    // self::START_PD_NEWS => 'ilias.php?baseClass=ilPersonalDesktopGUI&cmd=jumpToNews',
                    self::START_PD_WORKSPACE => 'ilias.php?baseClass=ilPersonalDesktopGUI&cmd=jumpToWorkspace',
                    // self::START_PD_PORTFOLIO => 'ilias.php?baseClass=ilPersonalDesktopGUI&cmd=jumpToPortfolio',
                    // self::START_PD_SKILLS => 'ilias.php?baseClass=ilPersonalDesktopGUI&cmd=jumpToSkills',
                    self::START_PD_CALENDAR => 'ilias.php?baseClass=ilPersonalDesktopGUI&cmd=jumpToCalendar',
                    // self::START_PD_MAIL => 'ilias.php?baseClass=ilMailGUI',
                    // self::START_PD_CONTACTS => 'ilias.php?baseClass=ilPersonalDesktopGUI&cmd=jumpToContacts',
                    // self::START_PD_PROFILE => 'ilias.php?baseClass=ilPersonalDesktopGUI&cmd=jumpToProfile',
                    // self::START_PD_SETTINGS => 'ilias.php?baseClass=ilPersonalDesktopGUI&cmd=jumpToSettings'
                    self::START_PD_MYSTAFF => 'ilias.php?baseClass=' . ilPersonalDesktopGUI::class . '&cmd=' . ilPersonalDesktopGUI::CMD_JUMP_TO_MY_STAFF
                );
                return $map[$current];
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasPersonalStartingPoint()

static ilUserUtil::hasPersonalStartingPoint ( )

static

Can starting point be personalized?

Returns

bool

Definition at line 457 of file class.ilUserUtil.php.

References $DIC, and $ilSetting.

Referenced by ilUserRoleStartingPointTableGUI\getItems(), ilUserStartingPointGUI\getUserStartingPointForm(), ilPersonalSettingsGUI\initGeneralSettingsForm(), and ilPersonalSettingsGUI\saveGeneralSettings().

    {
        global $DIC;

        $ilSetting = $DIC['ilSetting'];
        
        return $ilSetting->get("usr_starting_point_personal");
    }

Here is the caller graph for this function:

hasPersonalStartPointPref()

static ilUserUtil::hasPersonalStartPointPref ( )

static

Did user set any personal starting point (yet)?

Returns

bool

Definition at line 471 of file class.ilUserUtil.php.

References $DIC, and $ilUser.

Referenced by ilPersonalSettingsGUI\initGeneralSettingsForm().

    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        
        return (bool) $ilUser->getPref("usr_starting_point");
    }

Here is the caller graph for this function:

hasPublicProfile()

static ilUserUtil::hasPublicProfile (   $a_user_id )

static

Has public profile.

Parameters

Definition at line 174 of file class.ilUserUtil.php.

References $DIC, and $ilDB.

Referenced by ilLMPageObjectGUI\getLinkXML(), ilGlossaryPresentationGUI\getLinkXML(), ilLMPresentationGUI\getLinkXML(), and ilPageObjectGUI\setDefaultLinkXml().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $set = $ilDB->query(
            "SELECT value FROM usr_pref " .
            " WHERE usr_id = " . $ilDB->quote($a_user_id, "integer") .
            " and keyword = " . $ilDB->quote("public_profile", "text")
        );
        $rec = $ilDB->fetchAssoc($set);

        return in_array($rec["value"], array("y", "g"));
    }

Here is the caller graph for this function:

setPersonalStartingPoint()

static ilUserUtil::setPersonalStartingPoint (   $a_value,   $a_ref_id = null  )

static

Set personal starting point setting.

Parameters

int	$a_value
int	$a_ref_id

Returns

boolean

Definition at line 508 of file class.ilUserUtil.php.

References $DIC, $ilUser, $tree, $valid, and ilObject\_lookupObjId().

Referenced by ilPersonalSettingsGUI\saveGeneralSettings().

    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        $tree = $DIC['tree'];
        
        if (!$a_value) {
            $ilUser->setPref("usr_starting_point", null);
            $ilUser->setPref("usr_starting_point_ref_id", null);
            return;
        }
        
        if ($a_value == self::START_REPOSITORY_OBJ) {
            $a_ref_id = (int) $a_ref_id;
            if (ilObject::_lookupObjId($a_ref_id) &&
                !$tree->isDeleted($a_ref_id)) {
                $ilUser->setPref("usr_starting_point", $a_value);
                $ilUser->setPref("usr_starting_point_ref_id", $a_ref_id);
                return true;
            }
        }
        $valid = array_keys(self::getPossibleStartingPoints());
        if (in_array($a_value, $valid)) {
            $ilUser->setPref("usr_starting_point", $a_value);
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setStartingPoint()

static ilUserUtil::setStartingPoint (   $a_value,   $a_ref_id = null  )

static

Set starting point setting.

Parameters

int	$a_value
int	$a_ref_id

Returns

boolean

Definition at line 266 of file class.ilUserUtil.php.

References $DIC, $ilSetting, $tree, $valid, and ilObject\_lookupObjId().

Referenced by ilUserStartingPointGUI\saveStartingPoint().

    {
        global $DIC;

        $ilSetting = $DIC['ilSetting'];
        $tree = $DIC['tree'];
        
        if ($a_value == self::START_REPOSITORY_OBJ) {
            $a_ref_id = (int) $a_ref_id;
            if (ilObject::_lookupObjId($a_ref_id) &&
                !$tree->isDeleted($a_ref_id)) {
                $ilSetting->set("usr_starting_point", $a_value);
                $ilSetting->set("usr_starting_point_ref_id", $a_ref_id);
                return true;
            }
        }
        $valid = array_keys(self::getPossibleStartingPoints());
        if (in_array($a_value, $valid)) {
            $ilSetting->set("usr_starting_point", $a_value);
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

togglePersonalStartingPoint()

static ilUserUtil::togglePersonalStartingPoint (   $a_value )

static

Toggle personal starting point setting.

Parameters

bool

$a_value

Definition at line 443 of file class.ilUserUtil.php.

References $DIC, and $ilSetting.

Referenced by ilUserStartingPointGUI\saveUserStartingPoint().

    {
        global $DIC;

        $ilSetting = $DIC['ilSetting'];
        
        $ilSetting->set("usr_starting_point_personal", (bool) $a_value);
    }

Here is the caller graph for this function:

Field Documentation

START_PD_BOOKMARKS

const ilUserUtil::START_PD_BOOKMARKS = 3

Definition at line 16 of file class.ilUserUtil.php.

START_PD_CALENDAR

const ilUserUtil::START_PD_CALENDAR = 10

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

START_PD_CONTACTS

const ilUserUtil::START_PD_CONTACTS = 12

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

START_PD_LP

const ilUserUtil::START_PD_LP = 9

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

START_PD_MAIL

const ilUserUtil::START_PD_MAIL = 11

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

START_PD_MYSTAFF

const ilUserUtil::START_PD_MYSTAFF = 17

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

START_PD_NEWS

const ilUserUtil::START_PD_NEWS = 5

Definition at line 18 of file class.ilUserUtil.php.

START_PD_NOTES

const ilUserUtil::START_PD_NOTES = 4

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

START_PD_OVERVIEW

const ilUserUtil::START_PD_OVERVIEW = 1

Definition at line 14 of file class.ilUserUtil.php.

START_PD_PORTFOLIO

const ilUserUtil::START_PD_PORTFOLIO = 7

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

START_PD_PROFILE

const ilUserUtil::START_PD_PROFILE = 13

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

START_PD_SETTINGS

const ilUserUtil::START_PD_SETTINGS = 14

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

START_PD_SKILLS

const ilUserUtil::START_PD_SKILLS = 8

Definition at line 21 of file class.ilUserUtil.php.

START_PD_SUBSCRIPTION

const ilUserUtil::START_PD_SUBSCRIPTION = 2

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

START_PD_WORKSPACE

const ilUserUtil::START_PD_WORKSPACE = 6

Definition at line 19 of file class.ilUserUtil.php.

START_REPOSITORY

const ilUserUtil::START_REPOSITORY = 15

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

START_REPOSITORY_OBJ

const ilUserUtil::START_REPOSITORY_OBJ = 16

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

Referenced by ilUserRoleStartingPointTableGUI\getItems(), ilUserStartingPointGUI\getRoleStartingPointForm(), ilPersonalSettingsGUI\initGeneralSettingsForm(), and ilUserStartingPointGUI\saveStartingPoint().

---

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

• Services/User/classes/class.ilUserUtil.php