ilTutorialSupportBlockGUI: ilColumnGUI More...

Inheritance diagram for ilTutorialSupportBlockGUI:

Collaboration diagram for ilTutorialSupportBlockGUI:

Public Member Functions
	__construct ()

	getData ()

	getBlockType ()

Public Member Functions inherited from ilBlockGUI
	__construct ()

	getBlockType ()

	setData (array $a_data)

	getData ()

	setPresentation (int $type)

	getPresentation ()

	setBlockId (string $a_block_id="0")

	getBlockId ()

	setGuiObject (object $a_gui_object)
	Set GuiObject. More...

	getGuiObject ()

	setTitle (string $a_title)

	getTitle ()

	setOffset (int $a_offset)

	getOffset ()

	checkOffset (int $offset)

	setLimit (int $a_limit)

	getLimit ()

	setEnableEdit (bool $a_enableedit)

	getEnableEdit ()

	setRepositoryMode (bool $a_repositorymode)

	getRepositoryMode ()

	setSubtitle (string $a_subtitle)

	getSubtitle ()

	setRefId (int $a_refid)
	Set Ref Id (only used if isRepositoryObject() is true). More...

	getRefId ()

	setAdminCommands (bool $a_admincommands)

	getAdminCommands ()

	setEnableNumInfo (bool $a_enablenuminfo)

	getEnableNumInfo ()

	setProperties (array $a_properties)
	This function is supposed to be used for block type specific properties, that should be inherited through ilColumnGUI->setBlockProperties. More...

	getProperty (string $a_property)

	setProperty (string $a_property, string $a_value)

	setRowTemplate (string $a_rowtemplatename, string $a_rowtemplatedir="")
	Set Row Template Name. More...

	getNavParameter ()

	getConfigParameter ()

	getMoveParameter ()

	getRowTemplateName ()

	getRowTemplateDir ()

	addBlockCommand (string $a_href, string $a_text, string $a_onclick="", ?RoundTrip $modal=null)

	getBlockCommands ()

	getHTML ()

	getAsynch ()
	Use this for final get before sending asynchronous output (ajax) per echo to output. More...

	getPaginationViewControl ()
	Fill previous/next row. More...

	getViewControlsForPanel ()

	sortObject ()

	addSortOption (string $option, string $label, bool $active)

	setSortTarget (string $target)

	addPresentation (string $label, string $target, bool $active)

	getNoItemFoundContent ()

Protected Member Functions
	initRefIdFromQuery ()

	createTutorItem (string $mail_url, string $name, int $tutor_id,)

	getTutorData (ilObjUser $tutor)

	getTutorIds ()

	hasPublicProfile (ilObjUser $tutor)

	hasContactEnabled (int $tutor_id)

	isIliasInternalMailEnabled ()

	isTutorCurrentUser (int $tutor_id)

	isUserValid (ilObjUser $tutor)

	isCurrentUserAllowedToSeeTutorBlock ()

	areILIASGlobalProfilesEnabled ()

	createMailShyButton (string $mail_url)

	getMailUrlOfUser (ilObjUser $tutor)

	getListItemForData (array $data)

	isRepositoryObject ()

Protected Member Functions inherited from ilBlockGUI
	isRepositoryObject ()
	Returns whether block has a corresponding repository object. More...

	specialCharsAsEntities (string $string)

	initCommands ()

	preloadData (array $data)
	Can be overwritten in subclasses. More...

	getLegacyContent ()
	Get legacy content. More...

	getListItemForData (array $data)
	Get list item for data array. More...

	handleNavigation ()
	Handle navigation. More...

	loadData ()
	Load data for current page. More...

	getListItemGroups ()
	Get items. More...

	addRepoCommands ()
	Add repo commands. More...

	getActionsForPanel ()

	send (string $output)
	Send. More...

Protected Attributes
const	BLOCK_TYPE = 'tusu'

const	DATA_MAIL_URL = 'mail_url'

const	DATA_NAME = 'name'

const	DATA_TUTOR_ID = 'tutor_id'

const	EMPTY_MAIL_URL_STRING = ''

const	ITEM_LIMIT = 5

HttpServices	$http

RefineryFactory	$refinery

ilSetting	$ilias_settings

ilRbacSystem	$rbac_system

Protected Attributes inherited from ilBlockGUI
ILIAS UI Renderer	$renderer

Factory	$factory

object	$gui_object

ILIAS Block StandardGUIRequest	$request

ILIAS Block BlockManager	$block_manager

bool	$repositorymode = false

ILIAS DI UIServices	$ui

array	$data = array()

bool	$enablenuminfo = true

array	$footer_links = array()

string	$block_id = "0"

bool	$allow_moving = true

array	$move = array("left" => false, "right" => false, "up" => false, "down" => false)

array	$block_commands = array()

int	$max_count = 0

bool	$close_command = false

bool	$image = false

array	$property = []

string	$nav_value = ""

string	$css_row = ""

string	$title = ""

bool	$admincommands = false

array	$dropdown

ilTemplate	$tpl

ilGlobalTemplateInterface	$main_tpl

ilObjUser	$user

ilCtrl	$ctrl

ilAccessHandler	$access

ilLanguage	$lng

ilObjectDefinition	$obj_def

int	$presentation

int	$requested_ref_id

Additional Inherited Members
Static Public Member Functions inherited from ilBlockGUI
static	getScreenMode ()

Data Fields inherited from ilBlockGUI
const	PRES_MAIN_LEG = 0

const	PRES_SEC_LEG = 1

const	PRES_SEC_LIST = 2

const	PRES_MAIN_LIST = 3

const	PRES_MAIN_TILE = 4

Detailed Description

ilTutorialSupportBlockGUI: ilColumnGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilTutorialSupportBlockGUI::__construct ( )

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilBlockGUI\setBlockId(), ilBlockGUI\setLimit(), ilBlockGUI\setPresentation(), and ilBlockGUI\setTitle().

     {
         global $DIC;
         parent::__construct();
         $this->http = $DIC->http();
         $this->refinery = $DIC->refinery();
         $this->ilias_settings = $DIC['ilSetting'];
         $this->rbac_system = $DIC['rbacsystem'];
         $this->setBlockId('tusu_' . $this->ctrl->getContextObjId());
         $this->setLimit(self::ITEM_LIMIT);
         $this->setTitle($this->lng->txt('tutorial_support_block_title'));
         $this->setPresentation(self::PRES_MAIN_LIST);
     }

Here is the call graph for this function:

Member Function Documentation

◆ areILIASGlobalProfilesEnabled()

ilTutorialSupportBlockGUI::areILIASGlobalProfilesEnabled ( )

protected

Definition at line 163 of file class.ilTutorialSupportBlockGUI.php.

Referenced by isCurrentUserAllowedToSeeTutorBlock().

                                                       : bool
     {
         return (bool) $this->ilias_settings->get('enable_global_profiles');
     }

Here is the caller graph for this function:

◆ createMailShyButton()

ilTutorialSupportBlockGUI::createMailShyButton ( string $mail_url )

protected

Definition at line 168 of file class.ilTutorialSupportBlockGUI.php.

References ILIAS\Repository\lng(), and ILIAS\Repository\ui().

Referenced by createTutorItem().

                                                             : ShyButton
     {
         return $this->ui->factory()->button()->shy(
             $this->lng->txt('tutorial_support_block_send_mail'),
             $mail_url
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createTutorItem()

ilTutorialSupportBlockGUI::createTutorItem	(	string	$mail_url,
		string	$name,
		int	$tutor_id
	)

protected

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

References ilBlockGUI\$dropdown, ilObjUser\_getPersonalPicturePath(), createMailShyButton(), ilBlockGUI\getHTML(), ilBuddySystemLinkButton\getInstanceByUserId(), hasContactEnabled(), isTutorCurrentUser(), ILIAS\Repository\lng(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

Referenced by getListItemForData().

      : Item {
         $properties = [];
         if ($mail_url !== self::EMPTY_MAIL_URL_STRING) {
             $mail_button = $this->createMailShyButton($mail_url);
             $property_name = $this->lng->txt('tutorial_support_block_contact');
             $properties[$property_name] = $mail_button;
         }
         $avatar = new Picture(ilObjUser::_getPersonalPicturePath($tutor_id), $name);
         $tutor_item = $this->ui->factory()->item()->standard($name)
             ->withLeadAvatar($avatar)
             ->withProperties($properties);
         if (
             $this->isTutorCurrentUser($tutor_id) ||
             $this->user->isAnonymous() ||
             !$this->hasContactEnabled($tutor_id)
         ) {
             return $tutor_item;
         }
         $dropdown_actions[] = $this->ui->factory()->legacy()->content(
             ilBuddySystemLinkButton::getInstanceByUserId($tutor_id)->getHTML()
         );
         $dropdown = $this->ui->factory()->dropdown()->standard($dropdown_actions);
         return $tutor_item->withActions($dropdown);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBlockType()

ilTutorialSupportBlockGUI::getBlockType ( )

Definition at line 223 of file class.ilTutorialSupportBlockGUI.php.

                                   : string
     {
         return self::BLOCK_TYPE;
     }

◆ getData()

ilTutorialSupportBlockGUI::getData ( )

Definition at line 194 of file class.ilTutorialSupportBlockGUI.php.

References ilBlockGUI\$data, getTutorData(), getTutorIds(), isCurrentUserAllowedToSeeTutorBlock(), isUserValid(), and ILIAS\Repository\user().

                              : array
     {
         if (!$this->isCurrentUserAllowedToSeeTutorBlock()) {
             return [];
         }
         $data = [];
         $tutor_ids = $this->getTutorIds();
         foreach ($tutor_ids as $tutor_id) {
             $tutor = new ilObjUser($tutor_id);
             if (
                 !$this->isUserValid($tutor) ||
                 $this->user->isAnonymous()
             ) {
                 continue;
             }
             $data[] = $this->getTutorData($tutor);
         }
         return $data;
     }

Here is the call graph for this function:

◆ getListItemForData()

ilTutorialSupportBlockGUI::getListItemForData ( array $data )

protected

Definition at line 214 of file class.ilTutorialSupportBlockGUI.php.

References createTutorItem().

                                                       : Item
     {
         return $this->createTutorItem(
             (string) $data[self::DATA_MAIL_URL],
             (string) $data[self::DATA_NAME],
             (int) $data[self::DATA_TUTOR_ID]
         );
     }

Here is the call graph for this function:

◆ getMailUrlOfUser()

ilTutorialSupportBlockGUI::getMailUrlOfUser ( ilObjUser $tutor )

protected

Definition at line 176 of file class.ilTutorialSupportBlockGUI.php.

References ilMailFormCall\getLinkTarget(), ilObjUser\getLogin(), ILIAS\FileDelivery\http(), and isIliasInternalMailEnabled().

Referenced by getTutorData().

                                                          : string
     {
         if (
             !$this->isIliasInternalMailEnabled()
         ) {
             return (string) self::EMPTY_MAIL_URL_STRING;
         }
         return ilMailFormCall::getLinkTarget(
             $this->http->request()->getUri()->__toString(),
             '',
             [],
             [
                 'type' => 'new',
                 'rcp_to' => $tutor->getLogin()
             ]
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTutorData()

ilTutorialSupportBlockGUI::getTutorData ( ilObjUser $tutor )

protected

Definition at line 101 of file class.ilTutorialSupportBlockGUI.php.

References ilObjUser\getFullname(), ilObject\getId(), and getMailUrlOfUser().

Referenced by getData().

                                                      : array
     {
         return [
             self::DATA_MAIL_URL => $this->getMailUrlOfUser($tutor),
             self::DATA_NAME => $tutor->getFullname(),
             self::DATA_TUTOR_ID => $tutor->getId(),
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTutorIds()

ilTutorialSupportBlockGUI::getTutorIds ( )

protected

Definition at line 110 of file class.ilTutorialSupportBlockGUI.php.

References ilObject\_lookupObjId(), and initRefIdFromQuery().

Referenced by getData().

                                     : array
     {
         $crs_ref_id = $this->initRefIdFromQuery();
         if (is_null($crs_ref_id)) {
             return [];
         }
         $crs_obj_id = ilObjCourse::_lookupObjId($crs_ref_id);
         $course_members = new ilCourseParticipants($crs_obj_id);
         return $course_members->getContacts();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasContactEnabled()

ilTutorialSupportBlockGUI::hasContactEnabled ( int $tutor_id )

protected

Definition at line 130 of file class.ilTutorialSupportBlockGUI.php.

References ilObjUser\_lookupPref(), and ilBuddySystem\getInstance().

Referenced by createTutorItem().

                                                        : bool
     {
         if (!ilBuddySystem::getInstance()->isEnabled()) {
             return false;
         }
         $setting_value = ilObjUser::_lookupPref($tutor_id, 'bs_allow_to_contact_me');
         return is_null($setting_value) ? false : $setting_value === 'y';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasPublicProfile()

ilTutorialSupportBlockGUI::hasPublicProfile ( ilObjUser $tutor )

protected

Definition at line 121 of file class.ilTutorialSupportBlockGUI.php.

References ilObjUser\getPref(), and ILIAS\Repository\user().

Referenced by isUserValid().

                                                          : bool
     {
         return $tutor->getPref('public_profile') === 'g' ||
             (
                 !$this->user->isAnonymous() &&
                 $tutor->getPref('public_profile') === 'y'
             );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initRefIdFromQuery()

ilTutorialSupportBlockGUI::initRefIdFromQuery ( )

protected

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

References ILIAS\FileDelivery\http(), null, and ILIAS\Repository\refinery().

Referenced by getTutorIds().

                                            : int|null
     {
         if ($this->http->wrapper()->query()->has('ref_id')) {
             return $this->http->wrapper()->query()->retrieve(
                 'ref_id',
                 $this->refinery->kindlyTo()->int()
             );
         }
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isCurrentUserAllowedToSeeTutorBlock()

ilTutorialSupportBlockGUI::isCurrentUserAllowedToSeeTutorBlock ( )

protected

Definition at line 154 of file class.ilTutorialSupportBlockGUI.php.

References areILIASGlobalProfilesEnabled(), and ILIAS\Repository\user().

Referenced by getData().

                                                             : bool
     {
         return !$this->user->isAnonymous() ||
             (
                 $this->user->isAnonymous() &&
                 $this->areILIASGlobalProfilesEnabled()
             );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isIliasInternalMailEnabled()

ilTutorialSupportBlockGUI::isIliasInternalMailEnabled ( )

protected

Definition at line 139 of file class.ilTutorialSupportBlockGUI.php.

References ilMailGlobalServices\getMailObjectRefId().

Referenced by getMailUrlOfUser().

                                                    : bool
     {
         return $this->rbac_system->checkAccess('internal_mail', ilMailGlobalServices::getMailObjectRefId());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isRepositoryObject()

ilTutorialSupportBlockGUI::isRepositoryObject ( )

protected

Definition at line 228 of file class.ilTutorialSupportBlockGUI.php.

                                            : bool
     {
         return false;
     }

◆ isTutorCurrentUser()

ilTutorialSupportBlockGUI::isTutorCurrentUser ( int $tutor_id )

protected

Definition at line 144 of file class.ilTutorialSupportBlockGUI.php.

References ILIAS\Repository\user().

Referenced by createTutorItem().

     {
         return $tutor_id === $this->user->getId();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isUserValid()

ilTutorialSupportBlockGUI::isUserValid ( ilObjUser $tutor )

protected

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

References hasPublicProfile(), and ilObjUser\isAnonymous().

Referenced by getData().

                                                     : bool
     {
         return !$tutor->isAnonymous() && $this->hasPublicProfile($tutor);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $http

HttpServices ilTutorialSupportBlockGUI::$http

protected

Definition at line 42 of file class.ilTutorialSupportBlockGUI.php.

◆ $ilias_settings

ilSetting ilTutorialSupportBlockGUI::$ilias_settings

protected

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

◆ $rbac_system

ilRbacSystem ilTutorialSupportBlockGUI::$rbac_system

protected

Definition at line 45 of file class.ilTutorialSupportBlockGUI.php.

◆ $refinery

RefineryFactory ilTutorialSupportBlockGUI::$refinery

protected

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

◆ BLOCK_TYPE

const ilTutorialSupportBlockGUI::BLOCK_TYPE = 'tusu'

protected

Definition at line 36 of file class.ilTutorialSupportBlockGUI.php.

◆ DATA_MAIL_URL

const ilTutorialSupportBlockGUI::DATA_MAIL_URL = 'mail_url'

protected

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

◆ DATA_NAME

const ilTutorialSupportBlockGUI::DATA_NAME = 'name'

protected

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

◆ DATA_TUTOR_ID

const ilTutorialSupportBlockGUI::DATA_TUTOR_ID = 'tutor_id'

protected

Definition at line 39 of file class.ilTutorialSupportBlockGUI.php.

◆ EMPTY_MAIL_URL_STRING

const ilTutorialSupportBlockGUI::EMPTY_MAIL_URL_STRING = ''

protected

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

◆ ITEM_LIMIT

const ilTutorialSupportBlockGUI::ITEM_LIMIT = 5

protected

Definition at line 41 of file class.ilTutorialSupportBlockGUI.php.

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

components/ILIAS/Course/classes/class.ilTutorialSupportBlockGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ areILIASGlobalProfilesEnabled()

◆ createMailShyButton()

◆ createTutorItem()

◆ getBlockType()

◆ getData()

◆ getListItemForData()

◆ getMailUrlOfUser()

◆ getTutorData()

◆ getTutorIds()

◆ hasContactEnabled()

◆ hasPublicProfile()

◆ initRefIdFromQuery()

◆ isCurrentUserAllowedToSeeTutorBlock()

◆ isIliasInternalMailEnabled()

◆ isRepositoryObject()

◆ isTutorCurrentUser()

◆ isUserValid()

Field Documentation

◆ $http

◆ $ilias_settings

◆ $rbac_system

◆ $refinery

◆ BLOCK_TYPE

◆ DATA_MAIL_URL

◆ DATA_NAME

◆ DATA_TUTOR_ID

◆ EMPTY_MAIL_URL_STRING

◆ ITEM_LIMIT