Add PHP 8.4 support to Smarty (#1043)

.github/workflows/ci.yml

@@ -33,6 +33,7 @@ jobs:
           - "8.1"
           - "8.2"
           - "8.3"
+          - "8.4"
 
         compiler:
           - default
@@ -50,6 +51,9 @@ jobs:
           - os: ubuntu-latest
             php-version: "8.3"
             compiler: jit
+          - os: ubuntu-latest
+            php-version: "8.4"
+            compiler: jit
 
     steps:
     - name: Checkout

README.md

@@ -7,7 +7,7 @@ Smarty is a template engine for PHP, facilitating the separation of presentation
 Read the [documentation](https://smarty-php.github.io/smarty/) to find out how to use it. 
 
 ## Requirements
-Smarty v5 can be run with PHP 7.2 to PHP 8.3.
+Smarty v5 can be run with PHP 7.2 to PHP 8.4.
 
 ## Installation
 Smarty versions 3.1.11 or later can be installed with [Composer](https://getcomposer.org/).

docker-compose.yml

@@ -42,6 +42,11 @@ services:
       service: base
     build:
       dockerfile: ./utilities/testrunners/php83/Dockerfile
+  php84:
+    extends:
+      service: base
+    build:
+      dockerfile: ./utilities/testrunners/php84/Dockerfile
 volumes:
   smarty-code:
 

run-tests-for-all-php-versions.sh

@@ -14,3 +14,4 @@ $COMPOSE_CMD run --rm php80 ./run-tests.sh $@ && \
 $COMPOSE_CMD run --rm php81 ./run-tests.sh $@ && \
 $COMPOSE_CMD run --rm php82 ./run-tests.sh $@
 $COMPOSE_CMD run --rm php83 ./run-tests.sh $@
+$COMPOSE_CMD run --rm php84 ./run-tests.sh $@

src/Cacheresource/Base.php

@@ -44,7 +44,7 @@ abstract public function populateTimestamp(Cached $cached);
 	 */
     abstract public function process(
 	    Template $_template,
-	    Cached   $cached = null,
+	    ?Cached  $cached = null,
 	             $update = false
     );
 

src/Cacheresource/Custom.php

@@ -139,7 +139,7 @@ public function populateTimestamp(\Smarty\Template\Cached $cached)
 	 */
     public function process(
 	    Template               $_smarty_tpl,
-	    \Smarty\Template\Cached $cached = null,
+	    ?\Smarty\Template\Cached $cached = null,
 	                           $update = false
     ) {
         if (!$cached) {

src/Cacheresource/File.php

@@ -99,7 +99,7 @@ public function populateTimestamp(Cached $cached)
 	 */
     public function process(
 	    Template $_smarty_tpl,
-	    Cached   $cached = null,
+	    ?Cached  $cached = null,
 	             $update = false
     ) {
         $_smarty_tpl->getCached()->setValid(false);

src/Cacheresource/KeyValueStore.php

@@ -103,7 +103,7 @@ public function populateTimestamp(Cached $cached)
 	 */
     public function process(
 	    Template $_smarty_tpl,
-	    Cached   $cached = null,
+	    ?Cached  $cached = null,
 	             $update = false
     ) {
         if (!$cached) {

src/Compiler/CodeFrame.php

@@ -41,7 +41,7 @@ public function create(
         $content = '',
         $functions = '',
         $cache = false,
-        \Smarty\Compiler\Template $compiler = null
+        ?\Smarty\Compiler\Template $compiler = null
     ) {
         // build property code
         $properties[ 'version' ] = \Smarty\Smarty::SMARTY_VERSION;

src/Compiler/Template.php

@@ -374,7 +374,7 @@ public function compileTemplate(\Smarty\Template $template) {
 	 * @throws CompilerException
 	 * @throws Exception
 	 */
-	public function compileTemplateSource(\Smarty\Template $template, \Smarty\Compiler\Template $parent_compiler = null) {
+	public function compileTemplateSource(\Smarty\Template $template, ?\Smarty\Compiler\Template $parent_compiler = null) {
 		try {
 			// save template object in compiler class
 			$this->template = $template;

src/CompilerException.php

@@ -16,14 +16,14 @@ class CompilerException extends Exception {
 	 * @param int $code The Exception code.
 	 * @param string|null $filename The filename where the exception is thrown.
 	 * @param int|null $line The line number where the exception is thrown.
-	 * @param Throwable|null $previous The previous exception used for the exception chaining.
+	 * @param \Throwable|null $previous The previous exception used for the exception chaining.
 	 */
 	public function __construct(
 		string    $message = "",
 		int       $code = 0,
 		?string   $filename = null,
 		?int      $line = null,
-		Throwable $previous = null
+		?\Throwable $previous = null
 	) {
 		parent::__construct($message, $code, $previous);
 

src/Resource/BasePlugin.php

@@ -112,7 +112,7 @@ abstract public function getContent(Source $source);
 	 * @param Source $source source object
 	 * @param Template|null $_template template object
 	 */
-    abstract public function populate(Source $source, \Smarty\Template $_template = null);
+    abstract public function populate(Source $source, ?\Smarty\Template $_template = null);
 
     /**
      * populate Source Object with timestamp and exists from Resource

src/Resource/CustomPlugin.php

@@ -50,7 +50,7 @@ protected function fetchTimestamp($name) {
 	 * @param Source $source source object
 	 * @param Template|null $_template template object
 	 */
-	public function populate(Source $source, Template $_template = null) {
+	public function populate(Source $source, ?Template $_template = null) {
 		$source->uid = sha1($source->type . ':' . $source->name);
 		$mtime = $this->fetchTimestamp($source->name);
 		if ($mtime !== null) {

src/Resource/ExtendsPlugin.php

@@ -23,7 +23,7 @@ class ExtendsPlugin extends BasePlugin
      *
      * @throws Exception
      */
-    public function populate(Source $source, Template $_template = null)
+    public function populate(Source $source, ?Template $_template = null)
     {
         $uid = '';
         $sources = array();

src/Resource/FilePlugin.php

@@ -32,7 +32,7 @@ class FilePlugin extends BasePlugin {
 	 *
 	 * @throws Exception
 	 */
-	public function populate(Source $source, Template $_template = null) {
+	public function populate(Source $source, ?Template $_template = null) {
 
 		$source->uid = sha1(
 			$source->name . ($source->isConfig ? $source->getSmarty()->_joined_config_dir :

src/Resource/StreamPlugin.php

@@ -33,7 +33,7 @@ class StreamPlugin extends RecompiledPlugin {
 	 *
 	 * @return void
 	 */
-	public function populate(Source $source, Template $_template = null) {
+	public function populate(Source $source, ?Template $_template = null) {
 		$source->uid = false;
 		$source->content = $this->getContent($source);
 		$source->timestamp = $source->exists = !!$source->content;

src/Resource/StringPlugin.php

@@ -31,7 +31,7 @@ class StringPlugin extends BasePlugin {
 	 *
 	 * @return void
 	 */
-	public function populate(Source $source, Template $_template = null) {
+	public function populate(Source $source, ?Template $_template = null) {
 		$source->uid = sha1($source->name);
 		$source->timestamp = $source->exists = true;
 	}

src/Runtime/InheritanceRuntime.php

@@ -162,7 +162,7 @@ public function instanceBlock(Template $tpl, $className, $name, $tplIndex = null
 	private function processBlock(
 		Template              $tpl,
 		\Smarty\Runtime\Block $block,
-		\Smarty\Runtime\Block $parent = null
+		?\Smarty\Runtime\Block $parent = null
 	) {
 		if ($block->hide && !isset($block->child)) {
 			return;

src/Template.php

@@ -115,7 +115,7 @@ class Template extends TemplateBase {
 	public function __construct(
 		$template_resource,
 		Smarty $smarty,
-		\Smarty\Data $_parent = null,
+		?\Smarty\Data $_parent = null,
 		$_cache_id = null,
 		$_compile_id = null,
 		$_caching = null,
@@ -248,7 +248,7 @@ public function renderSubTemplate(
 		$caching,
 		$cache_lifetime,
 		array $extra_vars = [],
-		int $scope = null,
+		?int $scope = null,
 		?string $currentDir = null
 	) {
 
@@ -462,7 +462,7 @@ public function getCompiler() {
 	 * @return string
 	 * @throws Exception
 	 */
-	public function createCodeFrame($content = '', $functions = '', $cache = false, \Smarty\Compiler\Template $compiler = null) {
+	public function createCodeFrame($content = '', $functions = '', $cache = false, ?\Smarty\Compiler\Template $compiler = null) {
 		return $this->getCodeFrameCompiler()->create($content, $functions, $cache, $compiler);
 	}
 

src/Template/Source.php

@@ -134,9 +134,9 @@ public function __construct(Smarty $smarty, $type, $name) {
 	 * @throws Exception
 	 */
 	public static function load(
-		Template $_template = null,
-		Smarty   $smarty = null,
-		         $template_resource = null
+		?Template $_template = null,
+		?Smarty   $smarty = null,
+		          $template_resource = null
 	) {
 		if ($_template) {
 			$smarty = $_template->getSmarty();

src/TemplateBase.php

@@ -179,7 +179,7 @@ public function setCacheId($cache_id) {
 	 * @api  Smarty::createData()
 	 *
 	 */
-	public function createData(Data $parent = null, $name = null) {
+	public function createData(?Data $parent = null, $name = null) {
 		/* @var Smarty $smarty */
 		$smarty = $this->getSmarty();
 		$dataObj = new Data($parent, $smarty, $name);

tests/PHPUnit_Smarty.php

@@ -64,7 +64,7 @@ class PHPUnit_Smarty extends PHPUnit\Framework\TestCase
      */
     public static function setUpBeforeClass(): void
     {
-        error_reporting(E_ALL & ~E_STRICT & ~E_DEPRECATED & ~E_USER_DEPRECATED);
+        error_reporting(E_ALL & ~E_DEPRECATED & ~E_USER_DEPRECATED);
         self::$init = true;
         self::$pluginsdir =self::getSmartyPluginsDir();
     }

tests/UnitTests/CacheResourceTests/_shared/PHPunitplugins/resource.filetest.php

@@ -12,7 +12,7 @@ class Smarty_Resource_FiletestPlugin extends FilePlugin
      * @param Source   $source    source object
      * @param Template $_template template object
      */
-    public function populate(Source $source, Template $_template = null)
+    public function populate(Source $source, ?Template $_template = null)
     {
         parent::populate($source, $_template);
         if ($source->exists) {

tests/UnitTests/ResourceTests/Custom/Ambiguous/PHPunitplugins/resource.ambiguous.php

@@ -34,7 +34,7 @@ public function setSegment($segment)
      * @param Source   $source    source object
      * @param Template $_template template object
      */
-    public function populate(Source $source, Template $_template = null)
+    public function populate(Source $source, ?Template $_template = null)
     {
         $segment = '';
         if ($this->segment) {

tests/UnitTests/ResourceTests/ResourcePlugins/PHPunitplugins/resource.db.php

@@ -16,7 +16,7 @@
 
 class Smarty_Resource_Db extends RecompiledPlugin {
 
-    public function populate(Source $source, Template $_template = null) {
+    public function populate(Source $source, ?Template $_template = null) {
         $source->uid = sha1($source->resource);
         $source->timestamp = 1000000000;
         $source->exists = true;

tests/UnitTests/ResourceTests/ResourcePlugins/PHPunitplugins/resource.db2.php

@@ -16,7 +16,7 @@
 
 class Smarty_Resource_Db2 extends RecompiledPlugin
 {
-    public function populate(Source $source, Template $_template = null)
+    public function populate(Source $source, ?Template $_template = null)
     {
         $source->uid = sha1($source->resource);
         $source->timestamp = 0;

tests/UnitTests/ResourceTests/ResourcePlugins/PHPunitplugins/resource.db3.php

@@ -15,7 +15,7 @@
 
 class Smarty_Resource_Db3 extends Smarty\Resource\BasePlugin
 {
-    public function populate(Source $source, Template $_template = null)
+    public function populate(Source $source, ?Template $_template = null)
     {
         $source->uid = sha1($source->resource);
         $source->timestamp = 0;

tests/UnitTests/ResourceTests/ResourcePlugins/PHPunitplugins/resource.db4.php

@@ -16,7 +16,7 @@
 
 class Smarty_Resource_Db4 extends Smarty\Resource\BasePlugin
 {
-    public function populate(Source $source, Template $_template = null)
+    public function populate(Source $source, ?Template $_template = null)
     {
         $source->uid = sha1($source->resource);
         $source->timestamp = 0;

tests/UnitTests/__shared/resources/resource.extendsall.php

@@ -22,7 +22,7 @@ class My_Resource_Extendsall extends \Smarty\Resource\ExtendsPlugin
      *
      * @return void
      */
-    public function populate(Source $source, Template $_template = null)
+    public function populate(Source $source, ?Template $_template = null)
     {
         $uid = '';
         $sources = array();

utilities/testrunners/php84/Dockerfile

@@ -0,0 +1,10 @@
+FROM php:8.4-rc-cli-bullseye
+
+## Basic utilities
+RUN apt-get update -yqq && apt-get install -y curl apt-utils git zip unzip
+
+## Composer
+COPY ./utilities/testrunners/shared/install-composer.sh /root/install-composer.sh
+WORKDIR /root
+RUN sh ./install-composer.sh
+RUN mv ./composer.phar /usr/local/bin/composer