Inheritance diagram for TemplateTest:

Public Member Functions
	testFilter ()

	testAfterFilter ()

	testAfterFilterCallbackReset ()

	testVarDirective ($construction, $variables, $expectedResult)

	varDirectiveDataProvider ()

	testLoopPattern ($construction, $variables, $expectedResult)

	loopPatternDataProvider ()

	getTemplateAndExpectedResults ($type)

Protected Member Functions
	setUp ()

Detailed Description

Definition at line 9 of file TemplateTest.php.

Member Function Documentation

◆ getTemplateAndExpectedResults()

getTemplateAndExpectedResults ( $type )

Parameters

$type

Returns: array

Definition at line 255 of file TemplateTest.php.

     {
         switch ($type) {
             case 'noLoopTag':
                 $template = $expected = '';
                 break;
             case 'noBodyTag':
                 $template = <<<TEMPLATE
 <ul>
 {{for item in order.all_visible_items}}{{/for}}
 </ul>
 TEMPLATE;
                 $expected = <<<TEMPLATE
 <ul>
 {{for item in order.all_visible_items}}{{/for}}
 </ul>
 TEMPLATE;
                 break;
             case 'noItemTag':
                 $template = <<<TEMPLATE
 <ul>
 {{for in order.all_visible_items}}
     <li>
         {{var loop.index}} name: {{var thing.name}}, lastname: {{var thing.lastname}}, age: {{var thing.age}}
     </li>
 {{/for}}
 </ul>
 TEMPLATE;
                 $expected = <<<TEMPLATE
 <ul>
 {{for in order.all_visible_items}}
     <li>
         {{var loop.index}} name: {{var thing.name}}, lastname: {{var thing.lastname}}, age: {{var thing.age}}
     </li>
 {{/for}}
 </ul>
 TEMPLATE;
                 break;
             case 'noItemNoBodyTag':
                 $template = <<<TEMPLATE
 <ul>
 {{for in order.all_visible_items}}
     
 {{/for}}
 </ul>
 TEMPLATE;
                 $expected = <<<TEMPLATE
 <ul>
 {{for in order.all_visible_items}}
     
 {{/for}}
 </ul>
 TEMPLATE;
                 break;
             case 'noItemNoDataNoBodyTag':
                 $template = <<<TEMPLATE
 <ul>
 {{for in }}
     
 {{/for}}
 </ul>
 TEMPLATE;
                 $expected = <<<TEMPLATE
 <ul>
 {{for in }}
     
 {{/for}}
 </ul>
 TEMPLATE;
                 break;
             default:
                 $template = <<<TEMPLATE
 <ul>
     {{for item in order.all_visible_items}}
     <li>
         index: {{var loop.index}} sku: {{var item.sku}}
         name: {{var item.name}} price: {{var item.price}} quantity: {{var item.ordered_qty}}
     </li>
     {{/for}}
 </ul>
 TEMPLATE;
                 $expected = <<<TEMPLATE
 <ul>
     
     <li>
         index: 0 sku: ABC123
         name: Product ABC price: 123 quantity: 2
     </li>
     
     <li>
         index: 1 sku: DOREMI
         name: Product DOREMI price: 456 quantity: 1
     </li>
     
 </ul>
 TEMPLATE;
         }
         return [$template, ['order' => $this->getObjectData()], $expected];
     }

◆ loopPatternDataProvider()

loopPatternDataProvider ( )

Returns: array

Definition at line 222 of file TemplateTest.php.

     {
         return [
             'no loop tag' => $this->getTemplateAndExpectedResults('noLoopTag'),
             'no loop body tag' => $this->getTemplateAndExpectedResults('noBodyTag'),
             'no item tag' =>  $this->getTemplateAndExpectedResults('noItemTag'),
             'no item, no body tags' => $this->getTemplateAndExpectedResults('noItemNoBodyTag'),
             'no item, no data, no body tags' => $this->getTemplateAndExpectedResults('noItemNoDataNoBodyTag'),
         ];
     }

◆ setUp()

setUp ( )

protected

Definition at line 16 of file TemplateTest.php.

     {
         $objectManager = new \Magento\Framework\TestFramework\Unit\Helper\ObjectManager($this);
         $this->templateFilter = $objectManager->getObject(\Magento\Framework\Filter\Template::class);
     }

◆ testAfterFilter()

testAfterFilter ( )

@covers \Magento\Framework\Filter\Template::afterFilter @covers \Magento\Framework\Filter\Template::addAfterFilterCallback

Definition at line 77 of file TemplateTest.php.

     {
         $value = 'test string';
         $expectedResult = 'TEST STRING';
 
         // Build arbitrary object to pass into the addAfterFilterCallback method
         $callbackObject = $this->getMockBuilder('stdObject')
             ->setMethods(['afterFilterCallbackMethod'])
             ->getMock();
 
         $callbackObject->expects($this->once())
             ->method('afterFilterCallbackMethod')
             ->with($value)
             ->will($this->returnValue($expectedResult));
 
         // Add callback twice to ensure that the check in addAfterFilterCallback prevents the callback from being called
         // more than once
         $this->templateFilter->addAfterFilterCallback([$callbackObject, 'afterFilterCallbackMethod']);
         $this->templateFilter->addAfterFilterCallback([$callbackObject, 'afterFilterCallbackMethod']);
 
         $this->assertEquals($expectedResult, $this->templateFilter->filter($value));
     }

◆ testAfterFilterCallbackReset()

testAfterFilterCallbackReset ( )

@covers \Magento\Framework\Filter\Template::afterFilter @covers \Magento\Framework\Filter\Template::addAfterFilterCallback @covers \Magento\Framework\Filter\Template::resetAfterFilterCallbacks

Definition at line 105 of file TemplateTest.php.

     {
         $value = 'test string';
         $expectedResult = 'TEST STRING';
 
         // Build arbitrary object to pass into the addAfterFilterCallback method
         $callbackObject = $this->getMockBuilder('stdObject')
             ->setMethods(['afterFilterCallbackMethod'])
             ->getMock();
 
         $callbackObject->expects($this->once())
             ->method('afterFilterCallbackMethod')
             ->with($value)
             ->will($this->returnValue($expectedResult));
 
         $this->templateFilter->addAfterFilterCallback([$callbackObject, 'afterFilterCallbackMethod']);
 
         // Callback should run and filter content
         $this->assertEquals($expectedResult, $this->templateFilter->filter($value));
 
         // Callback should *not* run as callbacks should be reset
         $this->assertEquals($value, $this->templateFilter->filter($value));
     }

◆ testFilter()

testFilter ( )

Definition at line 22 of file TemplateTest.php.

     {
         $this->templateFilter->setVariables(
             [
                 'customer' => new \Magento\Framework\DataObject(['firstname' => 'Felicia', 'lastname' => 'Henry']),
                 'company' => 'A. L. Price',
                 'street1' => '687 Vernon Street',
                 'city' => 'Parker Dam',
                 'region' => 'CA',
                 'postcode' => '92267',
                 'telephone' => '760-663-5876',
             ]
         );
 
         $template = <<<TEMPLATE
 {{var customer.firstname}} {{depend middlename}}{{var middlename}} {{/depend}}{{var customer.getLastname()}}
 {{depend company}}{{var company}}{{/depend}}
 {{if street1}}{{var street1}}
 {{/if}}
 {{depend street2}}{{var street2}}{{/depend}}
 {{depend street3}}{{var street3}}{{/depend}}
 {{depend street4}}{{var street4}}{{/depend}}
 {{if city}}{{var city}},  {{/if}}{{if region}}{{var region}}, {{/if}}{{if postcode}}{{var postcode}}{{/if}}
 {{var country}}
 {{depend telephone}}T: {{var telephone}}{{/depend}}
 {{depend fax}}F: {{var fax}}{{/depend}}
 {{depend vat_id}}VAT: {{var vat_id}}{{/depend}}
 TEMPLATE;
 
         $expectedResult = <<<EXPECTED_RESULT
 Felicia Henry
 A. L. Price
 687 Vernon Street
 
 
 
 
 Parker Dam,  CA, 92267
 
 T: 760-663-5876
 
 
 EXPECTED_RESULT;
 
         $this->assertEquals(
             $expectedResult,
             $this->templateFilter->filter($template),
             'Template was processed incorrectly'
         );
     }

◆ testLoopPattern()

testLoopPattern	(	$construction,
		$variables,
		$expectedResult
	)

@covers \Magento\Framework\Filter\Template::filterFor @dataProvider loopPatternDataProvider

Definition at line 213 of file TemplateTest.php.

     {
         $this->templateFilter->setVariables($variables);
         $this->assertEquals($expectedResult, $this->invokeMethod($this->templateFilter, 'filterFor', [$construction]));
     }

◆ testVarDirective()

testVarDirective	(	$construction,
		$variables,
		$expectedResult
	)

@covers \Magento\Framework\Filter\Template::varDirective @covers \Magento\Framework\Filter\Template::getVariable @covers \Magento\Framework\Filter\Template::getStackArgs @dataProvider varDirectiveDataProvider

Definition at line 135 of file TemplateTest.php.

     {
         $this->templateFilter->setVariables($variables);
         $this->assertEquals($expectedResult, $this->templateFilter->filter($construction));
     }

◆ varDirectiveDataProvider()

varDirectiveDataProvider ( )

Returns: array

Definition at line 144 of file TemplateTest.php.

     {
         /* @var $dataObjectVariable \Magento\Framework\DataObject|\PHPUnit_Framework_MockObject_MockObject */
         $dataObjectVariable = $this->getMockBuilder(\Magento\Framework\DataObject::class)
             ->disableOriginalConstructor()
             ->disableProxyingToOriginalMethods()
             ->setMethods(['bar'])
             ->getMock();
         $dataObjectVariable->expects($this->once())
             ->method('bar')
             ->willReturn('DataObject Method Return');
 
         /* @var $nonDataObjectVariable \Magento\Framework\Escaper|\PHPUnit_Framework_MockObject_MockObject */
         $nonDataObjectVariable = $this->getMockBuilder(\Magento\Framework\Escaper::class)
             ->disableOriginalConstructor()
             ->getMock();
         $nonDataObjectVariable->expects($this->once())
             ->method('escapeHtml')
             ->willReturnArgument(0);
 
         return [
             'no variables' => [
                 '{{var}}',
                 [],
                 '{{var}}',
             ],
             'invalid variable' => [
                 '{{var invalid}}',
                 ['foobar' => 'barfoo'],
                 '',
             ],
             'string variable' => [
                 '{{var foobar}}',
                 ['foobar' => 'barfoo'],
                 'barfoo',
             ],
             'array argument to method' => [
                 '{{var foo.bar([param_1:value_1, param_2:$value_2, param_3:[a:$b, c:$d]])}}',
                 [
                     'foo' => $dataObjectVariable,
                     'value_2' => 'lorem',
                     'b' => 'bee',
                     'd' => 'dee',
                 ],
                 'DataObject Method Return'
             ],
             'non DataObject method call' => [
                 '{{var foo.escapeHtml($value)}}',
                 [
                     'foo' => $nonDataObjectVariable,
                     'value' => 'lorem'
                 ],
                 'lorem'
             ],
             'non DataObject undefined method call' => [
                 '{{var foo.undefinedMethod($value)}}',
                 [
                     'foo' => $nonDataObjectVariable,
                     'value' => 'lorem'
                 ],
                 ''
             ],
         ];
     }

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

vendor/magento/framework/Filter/Test/Unit/TemplateTest.php

Public Member Functions

Protected Member Functions