Inheritance diagram for ilMailTemplateContextTest:

Collaboration diagram for ilMailTemplateContextTest:

Public Member Functions
	getAnonymousTemplateContext (OrgUnitUserService $orgUnitUserService, ilMailEnvironmentHelper $envHelper, ilMailUserHelper $usernameHelper, ilMailLanguageHelper $languageHelper)

	testGlobalPlaceholdersCanBeResolvedWithCorrespondingValues (callable $user_callable, callable $ou_user_callable)
	userProvider More...

Static Public Member Functions
static	userProvider ()

Static Private Member Functions
static	generateOrgUnitUsers (Closure $mock_builder, int $amount)

Additional Inherited Members
Protected Member Functions inherited from ilMailBaseTestCase
	brutallyTrimHTML (string $html)

	setUp ()

	tearDown ()

	setGlobalVariable (string $name, $value)

Detailed Description

Definition at line 26 of file ilMailTemplateContextTest.php.

Member Function Documentation

◆ generateOrgUnitUsers()

static ilMailTemplateContextTest::generateOrgUnitUsers	(	Closure	$mock_builder,
		int	$amount
	)

staticprivate

Parameters

Closure() MockBuilder<ilOrgUnitUser> $mock_builder

Returns: array<int, ilOrgUnitUser&MockObject>

Exceptions

ReflectionException

Definition at line 71 of file ilMailTemplateContextTest.php.

                                                                                     : array
     {
         $users = [];
 
         for ($i = 1; $i <= $amount; $i++) {
             $user = $mock_builder()
                 ->disableOriginalConstructor()
                 ->onlyMethods(['getUserId',])
                 ->getMock();
             $user->expects(self::atLeastOnce())->method('getUserId')->willReturn($i);
 
             $users[$i] = $user;
         }
 
         return $users;
     }

◆ getAnonymousTemplateContext()

ilMailTemplateContextTest::getAnonymousTemplateContext	(	OrgUnitUserService	$orgUnitUserService,
		ilMailEnvironmentHelper	$envHelper,
		ilMailUserHelper	$usernameHelper,
		ilMailLanguageHelper	$languageHelper
	)

Definition at line 28 of file ilMailTemplateContextTest.php.

References ILIAS\Survey\Mode\getId(), and ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle().

Referenced by testGlobalPlaceholdersCanBeResolvedWithCorrespondingValues().

      : ilMailTemplateContext {
         return new class ($orgUnitUserService, $envHelper, $usernameHelper, $languageHelper) extends
             ilMailTemplateContext {
             public function getId(): string
             {
                 return 'phpunuit';
             }
 
             public function getTitle(): string
             {
                 return 'phpunuit';
             }
 
             public function getDescription(): string
             {
                 return 'phpunuit';
             }
 
             public function getSpecificPlaceholders(): array
             {
                 return [];
             }
 
             public function resolveSpecificPlaceholder(
                 string $placeholder_id,
                 array $context_parameters,
                 ilObjUser $recipient = null
             ): string {
                 return '';
             }
         };
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ testGlobalPlaceholdersCanBeResolvedWithCorrespondingValues()

ilMailTemplateContextTest::testGlobalPlaceholdersCanBeResolvedWithCorrespondingValues	(	callable	$user_callable,
		callable	$ou_user_callable
	)

userProvider

Parameters

callable(Closure()	MockBuilder<ilObjUser>): ilObjUser $user_callable
callable(Closure()	MockBuilder<ilOrgUnitUser>): array{0: ilOrgUnitUser, 1: list<ilOrgUnitUser>} $ou_user_callable

Exceptions

ReflectionException

Definition at line 165 of file ilMailTemplateContextTest.php.

References $context, $lng, getAnonymousTemplateContext(), and OrgUnit\User\ilOrgUnitUser\getUserId().

      : void {
         $mock_builder_user_callable = function (): MockBuilder {
             return $this->getMockBuilder(ilObjUser::class);
         };
         $mock_builder_ou_user_callable = function (): MockBuilder {
             return $this->getMockBuilder(ilOrgUnitUser::class);
         };
 
         $user = $user_callable($mock_builder_user_callable);
         [$ou_user, $ou_superiors] = $ou_user_callable($mock_builder_ou_user_callable);
 
         $ou_service = $this->getMockBuilder(OrgUnitUserService::class)
                            ->disableOriginalConstructor()
                            ->onlyMethods(['getUsers',])
                            ->getMock();
 
         $lng = $this->getMockBuilder(ilLanguage::class)
                     ->disableOriginalConstructor()
                     ->onlyMethods(['txt', 'loadLanguageModule',])
                     ->getMock();
 
         $env_helper = $this->getMockBuilder(ilMailEnvironmentHelper::class)
                            ->disableOriginalConstructor()
                            ->onlyMethods(['getClientId', 'getHttpPath',])
                            ->getMock();
 
         $lng_helper = $this->getMockBuilder(ilMailLanguageHelper::class)
                            ->disableOriginalConstructor()
                            ->onlyMethods(['getLanguageByIsoCode', 'getCurrentLanguage',])
                            ->getMock();
 
         $user_helper = $this->getMockBuilder(ilMailUserHelper::class)
                             ->disableOriginalConstructor()
                             ->onlyMethods(['getUsernameMapForIds',])
                             ->getMock();
 
         $ou_service->expects($this->atLeastOnce())->method('getUsers')->willReturn([$ou_user,]);
         $lng->expects($this->atLeastOnce())->method('txt')->will($this->returnArgument(0));
         $env_helper->expects($this->atLeastOnce())->method('getClientId')->willReturn('###phpunit_client###');
         $env_helper->expects($this->atLeastOnce())->method('getHttpPath')->willReturn('###http_ilias###');
         $lng_helper->expects($this->atLeastOnce())->method('getLanguageByIsoCode')->willReturn($lng);
         $lng_helper->expects($this->atLeastOnce())->method('getCurrentLanguage')->willReturn($lng);
 
         $expected_ids_constraint = [];
         if ($ou_superiors !== []) {
             $expected_ids_constraint = self::logicalAnd(
                 ...array_map(
                     static function (ilOrgUnitUser $user): \PHPUnit\Framework\Constraint\TraversableContainsEqual {
                         return self::containsEqual($user->getUserId());
                     },
                     $ou_superiors
                 )
             );
         }
 
         $first_and_last_names = array_map(static function (ilOrgUnitUser $user, int $key): string {
             return "PhpSup$key UnitSup$key";
         }, $ou_superiors, array_keys($ou_superiors));
 
         $user_helper->expects($this->atLeastOnce())->method('getUsernameMapForIds')
                     ->with($expected_ids_constraint)
                     ->willReturn($first_and_last_names);
 
         $context = $this->getAnonymousTemplateContext(
             $ou_service,
             $env_helper,
             $user_helper,
             $lng_helper
         );
 
         $mustache = new Mustache_Engine();
         $placeholder_resolver = new ilMailTemplatePlaceholderResolver($mustache);
 
         $message = implode('', [
             '{{MAIL_SALUTATION}}',
             '{{FIRST_NAME}}',
             '{{LAST_NAME}}',
             '{{LOGIN}}',
             '{{TITLE}}',
             '{{FIRSTNAME_LASTNAME_SUPERIOR}}',
             '{{ILIAS_URL}}',
             '{{INSTALLATION_NAME}}',
         ]);
         $replace_message = $placeholder_resolver->resolve($context, $message, $user);
 
         $this->assertStringContainsString('###Dr. Ing###', $replace_message);
         $this->assertStringContainsString('###phpunit###', $replace_message);
         $this->assertStringContainsString('###Unit###', $replace_message);
         $this->assertStringContainsString('###PHP###', $replace_message);
         $this->assertStringContainsString('###phpunit_client###', $replace_message);
         $this->assertStringContainsString('###http_ilias###', $replace_message);
         $this->assertStringContainsString('mail_salutation_' . $user->getGender(), $replace_message);
 
         foreach ($first_and_last_names as $firstAndLastname) {
             $this->assertStringContainsString($firstAndLastname, $replace_message);
         }
     }

Here is the call graph for this function:

◆ userProvider()

static ilMailTemplateContextTest::userProvider ( )

static

Returns: array<string, array{0: callable, 1: callable}>

Exceptions

ReflectionException

Parameters

Closure()	MockBuilder<ilObjUser> $mock_builder $mock_builder
Closure()	MockBuilder<ilOrgUnitUser> $mock_builder

Returns: array{0: ilOrgUnitUser&MockObject, 1: list<ilOrgUnitUser&MockObject>}

Exceptions

ReflectionException

Definition at line 92 of file ilMailTemplateContextTest.php.

                                          : array
     {
         $test_users = [];
 
         foreach (
             [
                 ['gender' => 'm', 'num_superiors' => 2,],
                 ['gender' => 'n', 'num_superiors' => 1,],
                 ['gender' => 'f', 'num_superiors' => 0,],
                 ['gender' => '', 'num_superiors' => 3,],
             ] as $definition
         ) {
             $user_callable = static function (Closure $mock_builder) use ($definition): ilObjUser&MockObject {
                 $user = $mock_builder()
                     ->disableOriginalConstructor()
                     ->onlyMethods([
                         'getLanguage',
                         'getUTitle',
                         'getLogin',
                         'getLastname',
                         'getFirstname',
                         'getGender',
                         'getId',
                     ])
                     ->getMock();
 
                 $user->expects(self::atLeastOnce())->method('getLanguage')->willReturn('de');
                 $user->expects(self::atLeastOnce())->method('getUTitle')->willReturn('###Dr. Ing###');
                 $user->expects(self::atLeastOnce())->method('getLogin')->willReturn('###phpunit###');
                 $user->expects(self::atLeastOnce())->method('getLastname')->willReturn('###Unit###');
                 $user->expects(self::atLeastOnce())->method('getFirstname')->willReturn('###PHP###');
                 $user->expects(self::atLeastOnce())->method('getGender')->willReturn($definition['gender']);
                 $user->expects(self::atLeastOnce())->method('getId')->willReturn(4711);
 
                 return $user;
             };
 
             $ou_user_callable = static function (Closure $mock_builder) use ($definition): array {
                 $ou_user = $mock_builder()
                     ->disableOriginalConstructor()
                     ->onlyMethods(['getSuperiors',])
                     ->getMock();
 
                 $superiors = self::generateOrgUnitUsers($mock_builder, $definition['num_superiors']);
                 $ou_user->expects(self::atLeastOnce())->method('getSuperiors')->willReturn($superiors);
 
                 return [$ou_user, $superiors];
             };
 
             $test_users[sprintf(
                 'User with gender "%s" and %s superiors',
                 $definition['gender'],
                 $definition['num_superiors']
             )] = [$user_callable, $ou_user_callable];
         }
 
         return $test_users;
     }

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

components/ILIAS/Mail/tests/ilMailTemplateContextTest.php

Public Member Functions

Static Public Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ generateOrgUnitUsers()

◆ getAnonymousTemplateContext()

◆ testGlobalPlaceholdersCanBeResolvedWithCorrespondingValues()

◆ userProvider()