ilMailMimeSubjectBuilderTest Class Reference

Inheritance diagram for ilMailMimeSubjectBuilderTest:

Collaboration diagram for ilMailMimeSubjectBuilderTest:

Public Member Functions
	globalSubjectPrefixOnlyProvider ()
	subjectPrefixesProvider ()
	testSubjectMustNotBeChangedWhenNoPrefixShouldBeAdded ()
	testGlobalPrefixMustBePrependedWhenDefinedAndPrefixShouldBeAppended (string $globalPrefix, string $expectedSubject)
	@dataProvider globalSubjectPrefixOnlyProvider More...
	testDefaultPrefixMustBePrependedWhenNoGlobalPrefixIsDefinedAndPrefixShouldBeAppended ()
	testContextPrefixMustBePrependedWhenGivenAndPrefixShouldBeAppended (?string $globalPrefix, string $contextPrefix, string $expectedSubject)
	@dataProvider subjectPrefixesProvider More...

Private Attributes
const	DEFAULT_PREFIX = 'docu default'

Additional Inherited Members
Protected Member Functions inherited from ilMailBaseTest
	brutallyTrimHTML (string $html)
	setUp ()
	tearDown ()
	setGlobalVariable (string $name, $value)

Detailed Description

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 24 of file ilMailMimeSubjectBuilderTest.php.

Member Function Documentation

globalSubjectPrefixOnlyProvider()

ilMailMimeSubjectBuilderTest::globalSubjectPrefixOnlyProvider

(

)

Returns

array<string, array<int, string>>

Definition at line 31 of file ilMailMimeSubjectBuilderTest.php.

                                                     : array
    {
        return [
            'Global Prefix without Brackets' => ['docu', 'docu %s'],
            'Global Prefix with Brackets' => ['[docu]', '[docu] %s'],
        ];
    }

subjectPrefixesProvider()

ilMailMimeSubjectBuilderTest::subjectPrefixesProvider

(

)

Returns

array<string, array<int, string|null>>

Definition at line 42 of file ilMailMimeSubjectBuilderTest.php.

                                             : array
    {
        return [
            'Global Prefix without Brackets and Additional Context Prefix' => ['docu', 'Course', '[docu : Course] %s'],
            'Global Prefix with Brackets and Additional Context Prefix' => ['[docu]', 'Course', '[docu : Course] %s'],
            'Empty Global Prefix with Brackets and Additional Context Prefix' => [
                '',  // The administrator saved the global email settings form with an empty global subject prefix
                'Course',
                '[Course] %s',
            ],
            'Absent Global Prefix with Brackets and Additional Context Prefix' => [
                null, // The administrator did not save the global email settings form, yet
                'Course',
                '[' . self::DEFAULT_PREFIX . ' : Course] %s',
            ],
        ];
    }

testContextPrefixMustBePrependedWhenGivenAndPrefixShouldBeAppended()

ilMailMimeSubjectBuilderTest::testContextPrefixMustBePrependedWhenGivenAndPrefixShouldBeAppended	(	?string	$globalPrefix,
		string	$contextPrefix,
		string	$expectedSubject
	)

@dataProvider subjectPrefixesProvider

Definition at line 104 of file ilMailMimeSubjectBuilderTest.php.

     : void {
        $settings = $this->getMockBuilder(ilSetting::class)->onlyMethods(['get'])->disableOriginalConstructor()->getMock();
        $settings->expects($this->once())->method('get')->with('mail_subject_prefix')->willReturn($globalPrefix);
 
        $subjectBuilder = new ilMailMimeSubjectBuilder($settings, self::DEFAULT_PREFIX);
 
        $subject = 'phpunit';
        $expectedSubject = sprintf($expectedSubject, $subject);
        $this->assertSame($expectedSubject, $subjectBuilder->subject($subject, true, $contextPrefix));
    }

testDefaultPrefixMustBePrependedWhenNoGlobalPrefixIsDefinedAndPrefixShouldBeAppended()

ilMailMimeSubjectBuilderTest::testDefaultPrefixMustBePrependedWhenNoGlobalPrefixIsDefinedAndPrefixShouldBeAppended

(

)

Definition at line 87 of file ilMailMimeSubjectBuilderTest.php.

                                                                                                          : void
    {
        $settings = $this->getMockBuilder(ilSetting::class)->onlyMethods(['get'])->disableOriginalConstructor()->getMock();
        $settings->expects($this->once())->method('get')->with('mail_subject_prefix')->willReturn(
            null
        );
 
        $subjectBuilder = new ilMailMimeSubjectBuilder($settings, self::DEFAULT_PREFIX);
 
        $subject = 'phpunit';
        $expectedSubject = self::DEFAULT_PREFIX . ' ' . $subject;
        $this->assertSame($expectedSubject, $subjectBuilder->subject($subject, true));
    }

References ILIAS\LTI\ToolProvider\$settings.

testGlobalPrefixMustBePrependedWhenDefinedAndPrefixShouldBeAppended()

ilMailMimeSubjectBuilderTest::testGlobalPrefixMustBePrependedWhenDefinedAndPrefixShouldBeAppended	(	string	$globalPrefix,
		string	$expectedSubject
	)

@dataProvider globalSubjectPrefixOnlyProvider

Definition at line 73 of file ilMailMimeSubjectBuilderTest.php.

     : void {
        $settings = $this->getMockBuilder(ilSetting::class)->onlyMethods(['get'])->disableOriginalConstructor()->getMock();
        $settings->expects($this->once())->method('get')->with('mail_subject_prefix')->willReturn($globalPrefix);
 
        $subjectBuilder = new ilMailMimeSubjectBuilder($settings, self::DEFAULT_PREFIX);
 
        $subject = 'phpunit';
        $expectedSubject = sprintf($expectedSubject, $subject);
        $this->assertSame($expectedSubject, $subjectBuilder->subject($subject, true));
    }

testSubjectMustNotBeChangedWhenNoPrefixShouldBeAdded()

ilMailMimeSubjectBuilderTest::testSubjectMustNotBeChangedWhenNoPrefixShouldBeAdded

(

)

Definition at line 60 of file ilMailMimeSubjectBuilderTest.php.

                                                                          : void
    {
        $settings = $this->getMockBuilder(ilSetting::class)->onlyMethods(['get'])->disableOriginalConstructor()->getMock();
        $subjectBuilder = new ilMailMimeSubjectBuilder($settings, self::DEFAULT_PREFIX);
 
        $subject = 'phpunit';
        $this->assertSame($subject, $subjectBuilder->subject($subject));
        $this->assertSame($subject, $subjectBuilder->subject($subject, false, 'Course'));
    }

References ILIAS\LTI\ToolProvider\$settings.

Field Documentation

DEFAULT_PREFIX

const ilMailMimeSubjectBuilderTest::DEFAULT_PREFIX = 'docu default'

private

Definition at line 26 of file ilMailMimeSubjectBuilderTest.php.

---

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

• Services/Mail/test/ilMailMimeSubjectBuilderTest.php