ILIAS  release_8 Revision v8.24
ilMailAddressTypeHelperImpl Class Reference

Class ilMailAddressTypeHelper. More...

+ Inheritance diagram for ilMailAddressTypeHelperImpl:
+ Collaboration diagram for ilMailAddressTypeHelperImpl:

Public Member Functions

 __construct (string $installationHost)
 
 doesGroupNameExists (string $name)
 
 getGroupObjIdByTitle (string $title)
 
 getInstanceByRefId (int $refId)
 
 getAllRefIdsForObjId (int $objId)
 
 getUserIdByLogin (string $login)
 
 getInstallationHost ()
 
 getGlobalMailSystemId ()
 
 receivesInternalMailsOnly (int $usrId)
 
 doesGroupNameExists (string $name)
 
 getGroupObjIdByTitle (string $title)
 
 getInstanceByRefId (int $refId)
 
 getAllRefIdsForObjId (int $objId)
 
 getUserIdByLogin (string $login)
 
 getInstallationHost ()
 
 getGlobalMailSystemId ()
 
 receivesInternalMailsOnly (int $usrId)
 

Protected Attributes

string $installationHost = ''
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

ilMailAddressTypeHelperImpl::__construct ( string  $installationHost)

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

30 {
31 $this->installationHost = $installationHost;
32 }

References $installationHost.

Member Function Documentation

◆ doesGroupNameExists()

ilMailAddressTypeHelperImpl::doesGroupNameExists ( string  $name)

Implements ilMailAddressTypeHelper.

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

34 : bool
35 {
37 }
static groupNameExists(string $a_group_name, ?int $a_id=null)
checks if group name already exists.
if($format !==null) $name
Definition: metadata.php:247

References $name, and ilUtil\groupNameExists().

+ Here is the call graph for this function:

◆ getAllRefIdsForObjId()

ilMailAddressTypeHelperImpl::getAllRefIdsForObjId ( int  $objId)
Returns
int[]

Implements ilMailAddressTypeHelper.

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

49 : array
50 {
51 return array_map('intval', ilObject::_getAllReferences($objId));
52 }
static _getAllReferences(int $id)
get all reference ids for object ID
$objId
Definition: xapitoken.php:57

References $objId, and ilObject\_getAllReferences().

+ Here is the call graph for this function:

◆ getGlobalMailSystemId()

ilMailAddressTypeHelperImpl::getGlobalMailSystemId ( )

Implements ilMailAddressTypeHelper.

Definition at line 64 of file class.ilMailAddressTypeHelper.php.

References ilMailGlobalServices\getMailObjectRefId().

+ Here is the call graph for this function:

◆ getGroupObjIdByTitle()

ilMailAddressTypeHelperImpl::getGroupObjIdByTitle ( string  $title)

Implements ilMailAddressTypeHelper.

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

39 : int
40 {
41 return (int) ilObjGroup::_lookupIdByTitle($title);
42 }
static _lookupIdByTitle(string $a_title)

References ilObjGroup\_lookupIdByTitle().

+ Here is the call graph for this function:

◆ getInstallationHost()

ilMailAddressTypeHelperImpl::getInstallationHost ( )

Implements ilMailAddressTypeHelper.

Definition at line 59 of file class.ilMailAddressTypeHelper.php.

59 : string
60 {
62 }

References $installationHost.

◆ getInstanceByRefId()

ilMailAddressTypeHelperImpl::getInstanceByRefId ( int  $refId)

Implements ilMailAddressTypeHelper.

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

44 : ilObject
45 {
47 }
static getInstanceByRefId(int $ref_id, bool $stop_on_error=true)
get an instance of an Ilias object by reference id
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
$refId
Definition: xapitoken.php:58

References $refId, and ilObjectFactory\getInstanceByRefId().

+ Here is the call graph for this function:

◆ getUserIdByLogin()

ilMailAddressTypeHelperImpl::getUserIdByLogin ( string  $login)

Implements ilMailAddressTypeHelper.

Definition at line 54 of file class.ilMailAddressTypeHelper.php.

54 : int
55 {
56 return ilObjUser::getUserIdByLogin($login);
57 }
static getUserIdByLogin(string $a_login)

References ilObjUser\getUserIdByLogin().

+ Here is the call graph for this function:

◆ receivesInternalMailsOnly()

ilMailAddressTypeHelperImpl::receivesInternalMailsOnly ( int  $usrId)

Implements ilMailAddressTypeHelper.

Definition at line 69 of file class.ilMailAddressTypeHelper.php.

69 : bool
70 {
71 $options = new ilMailOptions($usrId);
72
73 return $options->getIncomingType() === ilMailOptions::INCOMING_LOCAL;
74 }
Class ilMailOptions this class handles user mails.

References ilMailOptions\INCOMING_LOCAL.

Field Documentation

◆ $installationHost

string ilMailAddressTypeHelperImpl::$installationHost = ''
protected

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

Referenced by __construct(), and getInstallationHost().


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