Merge branch 'release/5.1.0'

Fixes #996

CHANGELOG.md

@@ -6,6 +6,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [5.1.0] - 2024-04-22
+- Prevent deprecation notices during compilation in PHP8.3 [#996](https://github.com/smarty-php/smarty/issues/996)
+- Fix that getTemplateVars would return an array of objects instead of the assigned variables values [#994](https://github.com/smarty-php/smarty/issues/994)
+- Fix Smarty::assign() not returning $this when called with an array as first parameter [#972](https://github.com/smarty-php/smarty/pull/972)
+- Documented support for `{if $element is in $array}` syntax [#937](https://github.com/smarty-php/smarty/issues/937)
+- Added support for `{if $element is not in $array}` syntax [#937](https://github.com/smarty-php/smarty/issues/937)
+- Using stream variables in templates now throws a deprecation notice [#933](https://github.com/smarty-php/smarty/pull/933)
+- Internal compiler classes always return a string (the internal has_code flag has been removed for simplicity) [#918](https://github.com/smarty-php/smarty/pull/918)
+- Fix invalid classnames in Runtime code for foreach [#1000](https://github.com/smarty-php/smarty/issues/1000)
+
+
 ## [5.0.1] - 2024-03-27
 - Fix error in Smarty\Smarty::compileAllTemplates() by including missing FilesystemIterator class [#966](https://github.com/smarty-php/smarty/issues/966)  
 

changelog/918.md

@@ -1 +0,0 @@
-- Internal compiler classes always return a string (the internal has_code flag has been removed for simplicity) [#918](https://github.com/smarty-php/smarty/pull/918)

changelog/933.md

@@ -1 +0,0 @@
-- Using stream variables in templates now throws a deprecation notice [#933](https://github.com/smarty-php/smarty/pull/933)

changelog/937.md

@@ -1,2 +0,0 @@
-- Documented support for `{if $element is in $array}` syntax [#937](https://github.com/smarty-php/smarty/issues/937)
-- Added support for `{if $element is not in $array}` syntax [#937](https://github.com/smarty-php/smarty/issues/937)

changelog/972.md

@@ -1 +0,0 @@
-- Fix Smarty::assign() not returning $this when called with an array as first parameter [#972](https://github.com/smarty-php/smarty/pull/972)

src/Compiler/Template.php

@@ -680,7 +680,8 @@ class Template extends BaseCompiler {
 	 *
 	 * @return string
 	 */
-	public function appendCode($left, $right) {
+	public function appendCode(string $left, string $right): string
+	{
 		if (preg_match('/\s*\?>\s?$/D', $left) && preg_match('/^<\?php\s+/', $right)) {
 			$left = preg_replace('/\s*\?>\s?$/D', "\n", $left);
 			$left .= preg_replace('/^<\?php\s+/', '', $right);
@@ -1056,7 +1057,7 @@ class Template extends BaseCompiler {
 		$prefixArray = array_merge($this->prefix_code, array_pop($this->prefixCodeStack));
 		$this->prefixCodeStack[] = [];
 		foreach ($prefixArray as $c) {
-			$code = $this->appendCode($code, $c);
+			$code = $this->appendCode($code, (string) $c);
 		}
 		$this->prefix_code = [];
 		return $code;

src/Data.php

@@ -224,7 +224,10 @@ class Data
 			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)
+		);
     }
 
 	/**

src/ParseTree/Dq.php

@@ -47,18 +47,18 @@ class Dq extends Base
             if ($subtree instanceof Code) {
                 $this->subtrees[ $last_subtree ]->data =
                     $parser->compiler->appendCode(
-                        $this->subtrees[ $last_subtree ]->data,
+                        (string) $this->subtrees[ $last_subtree ]->data,
                         '<?php echo ' . $subtree->data . ';?>'
                     );
             } elseif ($subtree instanceof DqContent) {
                 $this->subtrees[ $last_subtree ]->data =
                     $parser->compiler->appendCode(
-                        $this->subtrees[ $last_subtree ]->data,
+                        (string) $this->subtrees[ $last_subtree ]->data,
                         '<?php echo "' . $subtree->data . '";?>'
                     );
             } else {
                 $this->subtrees[ $last_subtree ]->data =
-                    $parser->compiler->appendCode($this->subtrees[ $last_subtree ]->data, $subtree->data);
+                    $parser->compiler->appendCode((string) $this->subtrees[ $last_subtree ]->data, (string) $subtree->data);
             }
         } else {
             $this->subtrees[] = $subtree;

src/ParseTree/Tag.php

@@ -62,9 +62,9 @@ class Tag extends Base
     public function assign_to_var(\Smarty\Parser\TemplateParser $parser)
     {
         $var = $parser->compiler->getNewPrefixVariable();
-        $tmp = $parser->compiler->appendCode('<?php ob_start();?>', $this->data);
+        $tmp = $parser->compiler->appendCode('<?php ob_start();?>', (string) $this->data);
         $tmp = $parser->compiler->appendCode($tmp, "<?php {$var}=ob_get_clean();?>");
-        $parser->compiler->appendPrefixCode((string) $tmp);
+        $parser->compiler->appendPrefixCode($tmp);
         return $var;
     }
 }

src/ParseTree/Template.php

@@ -114,7 +114,7 @@ class Template extends Base
                     break;
                 case 'tag':
                     foreach ($chunk['subtrees'] as $subtree) {
-                        $text = $parser->compiler->appendCode($text, $subtree->to_smarty_php($parser));
+                        $text = $parser->compiler->appendCode($text, (string) $subtree->to_smarty_php($parser));
                     }
                     $code .= $text;
                     break;

src/Parser/TemplateParser.php

@@ -2536,7 +2536,7 @@ public static $yy_action = array(
 // line 806 "src/Parser/TemplateParser.y"
     public function yy_r101(){
     $prefixVar = $this->compiler->getNewPrefixVariable();
-    $tmp = $this->compiler->appendCode('<?php ob_start();?>', $this->yystack[$this->yyidx + 0]->minor);
+    $tmp = $this->compiler->appendCode('<?php ob_start();?>', (string) $this->yystack[$this->yyidx + 0]->minor);
     $this->compiler->appendPrefixCode($this->compiler->appendCode($tmp, "<?php {$prefixVar} = ob_get_clean();?>"));
     $this->_retvalue = $prefixVar;
     }

src/Parser/TemplateParser.y

@@ -805,7 +805,7 @@ value(res)    ::= varindexed(vi) DOUBLECOLON static_class_access(r). {
                   // Smarty tag
 value(res)       ::= smartytag(st). {
     $prefixVar = $this->compiler->getNewPrefixVariable();
-    $tmp = $this->compiler->appendCode('<?php ob_start();?>', st);
+    $tmp = $this->compiler->appendCode('<?php ob_start();?>', (string) st);
     $this->compiler->appendPrefixCode($this->compiler->appendCode($tmp, "<?php {$prefixVar} = ob_get_clean();?>"));
     res = $prefixVar;
 }

src/Runtime/ForeachRuntime.php

@@ -116,22 +116,20 @@ class ForeachRuntime {
 	 *
 	 * @return int   the count for arrays and objects that implement countable, 1 for other objects that don't, and 0
 	 *               for empty elements
+	 * @throws \Exception
 	 */
-	public function count($value) {
-		if ($value instanceof IteratorAggregate) {
+	public function count($value): int
+	{
+		if ($value instanceof \IteratorAggregate) {
 			// Note: getIterator() returns a Traversable, not an Iterator
 			// thus rewind() and valid() methods may not be present
 			return iterator_count($value->getIterator());
-		} elseif ($value instanceof Iterator) {
-			return $value instanceof Generator ? 1 : iterator_count($value);
-		} elseif ($value instanceof Countable) {
+		} elseif ($value instanceof \Iterator) {
+			return $value instanceof \Generator ? 1 : iterator_count($value);
+		} elseif ($value instanceof \Countable) {
 			return count($value);
-		} elseif ($value instanceof PDOStatement) {
-			return $value->rowCount();
-		} elseif ($value instanceof Traversable) {
-			return iterator_count($value);
 		}
-		return count((array)$value);
+		return count((array) $value);
 	}
 
 	/**

src/Smarty.php

@@ -54,7 +54,7 @@ class Smarty extends \Smarty\TemplateBase {
 	/**
 	 * smarty version
 	 */
-	const SMARTY_VERSION = '5.0.1';
+	const SMARTY_VERSION = '5.1.0';
 
 	/**
 	 * define caching modes

tests/UnitTests/SmartyMethodsTests/GetTemplateVars/GetTemplateVarsTest.php

@@ -1,112 +1,126 @@
 <?php
 /**
  * Smarty PHPunit tests getTemplateVars method
- *
-
- * @author  Uwe Tews
- */
-
-/**
- * class for getTemplateVars method test
- *
- * 
- * 
- * 
  */
 class GetTemplateVarsTest extends PHPUnit_Smarty
 {
-    public function setUp(): void
-    {
-        $this->setUpSmarty(__DIR__);
-    }
+	public function setUp(): void
+	{
+		$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()
-    {
-        $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'));
-    }
+	/**
+	 * test root getTemplateVars all values
+	 */
+	public function testGetAllTemplateVarsScopeRoot()
+	{
+		$this->smarty->assign('foo', 'bar');
+		$this->smarty->assign('blar', 'buh');
+		$vars = $this->smarty->getTemplateVars();
+		$this->assertTrue(is_array($vars));
+		$this->assertEquals("bar", $vars['foo']);
+		$this->assertEquals("buh", $vars['blar']);
+	}
 
-    /**
-     * test root getTemplateVars all values
-     */
-    public function testGetAllTemplateVarsScopeRoot()
-    {
-        $this->smarty->assign('foo', 'bar');
-        $this->smarty->assign('blar', 'buh');
-        $vars = $this->smarty->getTemplateVars();
-        $this->assertTrue(is_array($vars));
-        $this->assertEquals("bar", $vars['foo']);
-        $this->assertEquals("buh", $vars['blar']);
-    }
+	/**
+	 * test single variable with data object chain
+	 */
+	public function testGetSingleTemplateVarScopeAll()
+	{
+		$data1 = $this->smarty->createData($this->smarty);
+		$data2 = $this->smarty->createData($data1);
+		$this->smarty->assign('foo', 'bar');
+		$this->smarty->assign('blar', 'buh');
+		$this->assertEquals("bar", $data2->getTemplateVars('foo'));
+	}
 
-    /**
-     * test single variable with data object chain
-     */
-    public function testGetSingleTemplateVarScopeAll()
-    {
-        $data1 = $this->smarty->createData($this->smarty);
-        $data2 = $this->smarty->createData($data1);
-        $this->smarty->assign('foo', 'bar');
-        $this->smarty->assign('blar', 'buh');
-        $this->assertEquals("bar", $data2->getTemplateVars('foo'));
-    }
+	/**
+	 * test get all variables with data object chain
+	 */
+	public function testGetAllTemplateVarsScopeAll()
+	{
+		$data1 = $this->smarty->createData($this->smarty);
+		$data2 = $this->smarty->createData($data1);
+		$this->smarty->assign('foo', 'bar');
+		$data1->assign('blar', 'buh');
+		$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
-     */
-    public function testGetAllTemplateVarsScopeAll()
-    {
-        $data1 = $this->smarty->createData($this->smarty);
-        $data2 = $this->smarty->createData($data1);
-        $this->smarty->assign('foo', 'bar');
-        $data1->assign('blar', 'buh');
-        $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 search parents disabled
+	 */
+	public function testGetAllTemplateVarsScopeAllNoParents()
+	{
+		$data1 = $this->smarty->createData($this->smarty);
+		$data2 = $this->smarty->createData($data1);
+		$this->smarty->assign('foo', 'bar');
+		$data1->assign('blar', 'buh');
+		$data2->assign('foo2', 'bar2');
+		$vars = $data2->getTemplateVars(null, false);
+		$this->assertTrue(is_array($vars));
+		$this->assertFalse(isset($vars['foo']));
+		$this->assertEquals("bar2", $vars['foo2']);
+		$this->assertFalse(isset($vars['blar']));
+	}
 
-    /**
-     * test get all variables with data object chain search parents disabled
-     */
-    public function testGetAllTemplateVarsScopeAllNoParents()
-    {
-        $data1 = $this->smarty->createData($this->smarty);
-        $data2 = $this->smarty->createData($data1);
-        $this->smarty->assign('foo', 'bar');
-        $data1->assign('blar', 'buh');
-        $data2->assign('foo2', 'bar2');
-        $vars = $data2->getTemplateVars(null, false);
-        $this->assertTrue(is_array($vars));
-        $this->assertFalse(isset($vars['foo']));
-        $this->assertEquals("bar2", $vars['foo2']);
-        $this->assertFalse(isset($vars['blar']));
-    }
+	/**
+	 * 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));
+	}
+
+	/**
+	 * 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));
-    }
 }