Fix change in signature of getTemplateVars (#995)

This commit is contained in:
Simon Wisselink
2024-04-13 16:53:05 +02:00
committed by GitHub
parent 77c0b74e3b
commit 5ee4363000
3 changed files with 117 additions and 99 deletions

1
changelog/994.md Normal file
View File

@@ -0,0 +1 @@
- Fix that getTemplateVars would return an array of objects instead of the assigned variables values [#994](https://github.com/smarty-php/smarty/issues/994)

View File

@@ -224,7 +224,10 @@ class Data
return $this->getValue($varName, $searchParents); return $this->getValue($varName, $searchParents);
} }
return array_merge($this->parent && $searchParents ? $this->parent->getTemplateVars() : [], $this->tpl_vars); return array_merge(
$this->parent && $searchParents ? $this->parent->getTemplateVars() : [],
array_map(function(Variable $var) { return $var->getValue(); }, $this->tpl_vars)
);
} }
/** /**

View File

@@ -1,112 +1,126 @@
<?php <?php
/** /**
* Smarty PHPunit tests getTemplateVars method * Smarty PHPunit tests getTemplateVars method
*
* @author Uwe Tews
*/
/**
* class for getTemplateVars method test
*
*
*
*
*/ */
class GetTemplateVarsTest extends PHPUnit_Smarty class GetTemplateVarsTest extends PHPUnit_Smarty
{ {
public function setUp(): void public function setUp(): void
{ {
$this->setUpSmarty(__DIR__); $this->setUpSmarty(__DIR__);
} }
public function testInit()
{
$this->cleanDirs();
}
/**
* test root getTemplateVars single value
*/
public function testGetSingleTemplateVarScopeRoot()
{
$this->smarty->assign('foo', 'bar');
$this->smarty->assign('blar', 'buh');
$this->assertEquals("bar", $this->smarty->getTemplateVars('foo'));
}
public function testInit() /**
{ * test root getTemplateVars all values
$this->cleanDirs(); */
} public function testGetAllTemplateVarsScopeRoot()
/** {
* test root getTemplateVars single value $this->smarty->assign('foo', 'bar');
*/ $this->smarty->assign('blar', 'buh');
public function testGetSingleTemplateVarScopeRoot() $vars = $this->smarty->getTemplateVars();
{ $this->assertTrue(is_array($vars));
$this->smarty->assign('foo', 'bar'); $this->assertEquals("bar", $vars['foo']);
$this->smarty->assign('blar', 'buh'); $this->assertEquals("buh", $vars['blar']);
$this->assertEquals("bar", $this->smarty->getTemplateVars('foo')); }
}
/** /**
* test root getTemplateVars all values * test single variable with data object chain
*/ */
public function testGetAllTemplateVarsScopeRoot() public function testGetSingleTemplateVarScopeAll()
{ {
$this->smarty->assign('foo', 'bar'); $data1 = $this->smarty->createData($this->smarty);
$this->smarty->assign('blar', 'buh'); $data2 = $this->smarty->createData($data1);
$vars = $this->smarty->getTemplateVars(); $this->smarty->assign('foo', 'bar');
$this->assertTrue(is_array($vars)); $this->smarty->assign('blar', 'buh');
$this->assertEquals("bar", $vars['foo']); $this->assertEquals("bar", $data2->getTemplateVars('foo'));
$this->assertEquals("buh", $vars['blar']); }
}
/** /**
* test single variable with data object chain * test get all variables with data object chain
*/ */
public function testGetSingleTemplateVarScopeAll() public function testGetAllTemplateVarsScopeAll()
{ {
$data1 = $this->smarty->createData($this->smarty); $data1 = $this->smarty->createData($this->smarty);
$data2 = $this->smarty->createData($data1); $data2 = $this->smarty->createData($data1);
$this->smarty->assign('foo', 'bar'); $this->smarty->assign('foo', 'bar');
$this->smarty->assign('blar', 'buh'); $data1->assign('blar', 'buh');
$this->assertEquals("bar", $data2->getTemplateVars('foo')); $data2->assign('foo2', 'bar2');
} $vars = $data2->getTemplateVars(null);
$this->assertTrue(is_array($vars));
$this->assertEquals("bar", $vars['foo']);
$this->assertEquals("bar2", $vars['foo2']);
$this->assertEquals("buh", $vars['blar']);
}
/** /**
* test get all variables with data object chain * test get all variables with data object chain search parents disabled
*/ */
public function testGetAllTemplateVarsScopeAll() public function testGetAllTemplateVarsScopeAllNoParents()
{ {
$data1 = $this->smarty->createData($this->smarty); $data1 = $this->smarty->createData($this->smarty);
$data2 = $this->smarty->createData($data1); $data2 = $this->smarty->createData($data1);
$this->smarty->assign('foo', 'bar'); $this->smarty->assign('foo', 'bar');
$data1->assign('blar', 'buh'); $data1->assign('blar', 'buh');
$data2->assign('foo2', 'bar2'); $data2->assign('foo2', 'bar2');
$vars = $data2->getTemplateVars(null); $vars = $data2->getTemplateVars(null, false);
$this->assertTrue(is_array($vars)); $this->assertTrue(is_array($vars));
$this->assertEquals("bar", $vars['foo']); $this->assertFalse(isset($vars['foo']));
$this->assertEquals("bar2", $vars['foo2']); $this->assertEquals("bar2", $vars['foo2']);
$this->assertEquals("buh", $vars['blar']); $this->assertFalse(isset($vars['blar']));
} }
/** /**
* test get all variables with data object chain search parents disabled * test get single variables with data object chain search parents disabled
*/ */
public function testGetAllTemplateVarsScopeAllNoParents() public function testGetSingleTemplateVarsScopeAllNoParents()
{ {
$data1 = $this->smarty->createData($this->smarty); error_reporting(error_reporting() & ~(E_NOTICE | E_USER_NOTICE));
$data2 = $this->smarty->createData($data1); $data1 = $this->smarty->createData($this->smarty);
$this->smarty->assign('foo', 'bar'); $data2 = $this->smarty->createData($data1);
$data1->assign('blar', 'buh'); $this->smarty->assign('foo', 'bar');
$data2->assign('foo2', 'bar2'); $data1->assign('blar', 'buh');
$vars = $data2->getTemplateVars(null, false); $data2->assign('foo2', 'bar2');
$this->assertTrue(is_array($vars)); $this->assertEquals("", $data2->getTemplateVars('foo', false));
$this->assertFalse(isset($vars['foo'])); $this->assertEquals("bar2", $data2->getTemplateVars('foo2', false));
$this->assertEquals("bar2", $vars['foo2']); $this->assertEquals("", $data2->getTemplateVars('blar', false));
$this->assertFalse(isset($vars['blar'])); }
}
/**
* test that variable assigned by global assign in template is included in getTemplateVars
*/
public function testAssignedInTemplate()
{
$this->smarty->fetch('string:{assign var="b" value="x" scope="global"}');
$this->assertEquals('x', $this->smarty->getTemplateVars('b'));
}
/**
* test that getTemplateVars returns simple array of values
*/
public function testSimpleCallReturnsArrayWithAllValues()
{
$this->smarty->assign('foo', 'bar');
$this->smarty->assign('i', 3);
$vars = $this->smarty->getTemplateVars();
$this->assertArrayHasKey('foo', $vars);
$this->assertArrayHasKey('i', $vars);
$this->assertEquals('bar', $vars['foo']);
$this->assertEquals(3,$vars['i']);
}
/**
* test get single variables with data object chain search parents disabled
*/
public function testGetSingleTemplateVarsScopeAllNoParents()
{
error_reporting(error_reporting() & ~(E_NOTICE | E_USER_NOTICE));
$data1 = $this->smarty->createData($this->smarty);
$data2 = $this->smarty->createData($data1);
$this->smarty->assign('foo', 'bar');
$data1->assign('blar', 'buh');
$data2->assign('foo2', 'bar2');
$this->assertEquals("", $data2->getTemplateVars('foo', false));
$this->assertEquals("bar2", $data2->getTemplateVars('foo2', false));
$this->assertEquals("", $data2->getTemplateVars('blar', false));
}
} }