ilMailMimeSubjectBuilderTest Class Reference

Inheritance diagram for ilMailMimeSubjectBuilderTest:

Collaboration diagram for ilMailMimeSubjectBuilderTest:

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

Private Attributes
const	DEFAULT_PREFIX = 'docu default'

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

Detailed Description

Author

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

Definition at line 7 of file ilMailMimeSubjectBuilderTest.php.

Member Function Documentation

globalSubjectPrefixOnlyProvider()

ilMailMimeSubjectBuilderTest::globalSubjectPrefixOnlyProvider

(

)

Returns

array<string, array<int, string>>

Definition at line 14 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|false>>

Definition at line 25 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' => [
                false, // The administrator did not save the global email settings form, yet
                'Course',
                '[' . self::DEFAULT_PREFIX . ' : Course] %s'
            ],
        ];
    }

testContextPrefixMustBePrependedWhenGivenAndPrefixShouldBeAppended()

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

@dataProvider subjectPrefixesProvider

Parameters

string | false	$globalPrefix
string	$contextPrefix
string	$expectedSubject

Definition at line 90 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->assertEquals($expectedSubject, $subjectBuilder->subject($subject, true, $contextPrefix));
    }

testDefaultPrefixMustBePrependedWhenNoGlobalPrefixIsDefinedAndPrefixShouldBeAppended()

ilMailMimeSubjectBuilderTest::testDefaultPrefixMustBePrependedWhenNoGlobalPrefixIsDefinedAndPrefixShouldBeAppended

(

)

Definition at line 72 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(false);
 
        $subjectBuilder = new ilMailMimeSubjectBuilder($settings, self::DEFAULT_PREFIX);
 
        $subject = 'phpunit';
        $expectedSubject = self::DEFAULT_PREFIX . ' ' . $subject;
        $this->assertEquals($expectedSubject, $subjectBuilder->subject($subject, true));
    }

testGlobalPrefixMustBePrependedWhenDefinedAndPrefixShouldBeAppended()

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

@dataProvider globalSubjectPrefixOnlyProvider

Parameters

string	$globalPrefix
string	$expectedSubject

Definition at line 58 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->assertEquals($expectedSubject, $subjectBuilder->subject($subject, true));
    }

testSubjectMustNotBeChangedWhenNotPrefixShouldBeAdded()

ilMailMimeSubjectBuilderTest::testSubjectMustNotBeChangedWhenNotPrefixShouldBeAdded

(

)

Definition at line 43 of file ilMailMimeSubjectBuilderTest.php.

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

Field Documentation

DEFAULT_PREFIX

const ilMailMimeSubjectBuilderTest::DEFAULT_PREFIX = 'docu default'

private

Definition at line 9 of file ilMailMimeSubjectBuilderTest.php.

---

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

• Services/Mail/test/ilMailMimeSubjectBuilderTest.php