[5.x]: voku/stringy not compatible with PHP 8.4

[jordikroon]

What happened?

Description

The package Voku/stringy is not compatible with PHP 8.4. This package uses by Craft CMS within composer.json seems to be abandoned as has not received any updates nor for 2 years. Or longer if you consider major patches.

Since PHP 8.4 all nullable parameters without a question mark (string $test = null) are deprecated and should be prefixed with ?.

The console gives a lot of deprecations. This even occurs on commands like craft up. While there are methods to suppress, ideally the deprecations are resolved.

PHP Deprecated:  voku\helper\UTF8::extract_text(): Implicitly marking parameter $length as nullable is deprecated, the explicit nullable type must be used instead in /var/www/html/vendor/voku/portable-utf8/src/voku/helper/UTF8.php on line 1622

PHP Deprecated:  voku\helper\UTF8::file_get_contents(): Implicitly marking parameter $offset as nullable is deprecated, the explicit nullable type must be used instead in /var/www/html/vendor/voku/portable-utf8/src/voku/helper/UTF8.php on line 1842

PHP Deprecated:  voku\helper\UTF8::file_get_contents(): Implicitly marking parameter $max_length as nullable is deprecated, the explicit nullable type must be used instead in /var/www/html/vendor/voku/portable-utf8/src/voku/helper/UTF8.php on line 1842

PHP Deprecated:  voku\helper\UTF8::getSupportInfo(): Implicitly marking parameter $key as nullable is deprecated, the explicit nullable type must be used instead in /var/www/html/vendor/voku/portable-utf8/src/voku/helper/UTF8.php on line 2580

PHP Deprecated:  Stringy\Stringy::__construct(): Implicitly marking parameter $encoding as nullable is deprecated, the explicit nullable type must be used instead in /var/www/html/vendor/voku/stringy/src/Stringy.php on line 77

Deprecated: Stringy\Stringy::create(): Implicitly marking parameter $encoding as nullable is deprecated, the explicit nullable type must be used instead in /var/www/html/vendor/voku/stringy/src/Stringy.php on line 957

Deprecated:  Stringy\Stringy::extractText(): Implicitly marking parameter $length as nullable is deprecated, the explicit nullable type must be used instead in /var/www/html/vendor/voku/stringy/src/Stringy.php on line 1324

Craft CMS version

5.6.4

PHP version

8.4

Operating system and version

No response

Database type and version

No response

Image driver and version

No response

Installed plugins and versions

[brandonkelly]

We’re aware of that, but decided to hold off on addressing it for a while, to see if the project ends up getting picked back up, or if a strong fork/alternative library emerges. Our only other option would be to fork it ourselves, but we’re not currently qualified to maintain it (beyond keeping it up-to-date with PHP changes), so that would only be a last resort.

[brandonkelly]

Craft does attempt to hide deprecation errors, so I’m not sure why they would be shown in your CLI output:

cms/bootstrap/bootstrap.php

Lines 159 to 160 in 7547163

	$errorLevel = E_ALL & ~E_DEPRECATED & ~E_USER_DEPRECATED;
	error_reporting($errorLevel);

[terryupton]

Hey @brandonkelly
I have also come up against this issue as I started a new project on 8.4 and also updated a project for a new server migration (upgrade). Whilst these are only warnings; would be be best to stick to 8.3 for now?

Do you have any further updates or new plans to resolve this?

[brandonkelly]

I wouldn’t consider it a reason to stick with PHP 8.3, but it’s up to you.

Since Stringy seems to be abandonware, we’ll consider our other options for Craft 6.

[maxfenton]

This is the bulk of the error using DDEV with PHP 8.4

Maybe the deprecation warning comes back only when Blitz is enabled?

An Error occurred while handling another error:
yii\web\HeadersAlreadySentException: Headers already sent in /var/www/html/vendor/voku/portable-utf8/src/voku/helper/UTF8.php on line 8704. in /var/www/html/vendor/yiisoft/yii2/web/Response.php:369
Stack trace:
#0 /var/www/html/vendor/yiisoft/yii2/web/Response.php(342): yii\web\Response->sendHeaders()
#1 /var/www/html/vendor/yiisoft/yii2/web/ErrorHandler.php(136): yii\web\Response->send()
#2 /var/www/html/vendor/craftcms/cms/src/web/ErrorHandler.php(226): yii\web\ErrorHandler->renderException()
#3 /var/www/html/vendor/yiisoft/yii2/base/ErrorHandler.php(152): craft\web\ErrorHandler->renderException()
#4 /var/www/html/vendor/craftcms/cms/src/web/ErrorHandler.php(102): yii\base\ErrorHandler->handleException()
#5 [internal function]: craft\web\ErrorHandler->handleException()
#6 {main}
Previous exception:
yii\base\ErrorException: session_name(): Session name cannot be changed after headers have already been sent in /var/www/html/vendor/yiisoft/yii2/web/Session.php:348
Stack trace:
#0 /var/www/html/vendor/craftcms/cms/src/web/ErrorHandler.php(115): yii\base\ErrorHandler->handleError()
#1 [internal function]: craft\web\ErrorHandler->handleError()
#2 /var/www/html/vendor/yiisoft/yii2/web/Session.php(348): session_name()
#3 /var/www/html/vendor/yiisoft/yii2/base/Component.php(180): yii\web\Session->setName()
#4 /var/www/html/vendor/yiisoft/yii2/BaseYii.php(557): yii\base\Component->__set()
#5 /var/www/html/vendor/yiisoft/yii2/base/BaseObject.php(107): yii\BaseYii::configure()
#6 [internal function]: yii\base\BaseObject->__construct()
#7 /var/www/html/vendor/yiisoft/yii2/di/Container.php(419): ReflectionClass->newInstanceArgs()
#8 /var/www/html/vendor/yiisoft/yii2/di/Container.php(170): yii\di\Container->build()
#9 /var/www/html/vendor/yiisoft/yii2/BaseYii.php(365): yii\di\Container->get()
#10 /var/www/html/vendor/craftcms/cms/src/Craft.php(71): yii\BaseYii::createObject()
#11 /var/www/html/vendor/craftcms/cms/src/config/app.web.php(30): Craft::createObject()
#12 [internal function]: {closure:/var/www/html/vendor/craftcms/cms/src/config/app.web.php:28}()
#13 /var/www/html/vendor/yiisoft/yii2/di/Container.php(633): call_user_func_array()
#14 /var/www/html/vendor/yiisoft/yii2/BaseYii.php(349): yii\di\Container->invoke()
#15 /var/www/html/vendor/yiisoft/yii2/di/ServiceLocator.php(137): yii\BaseYii::createObject()
#16 /var/www/html/vendor/yiisoft/yii2/base/Module.php(766): yii\di\ServiceLocator->get()
#17 /var/www/html/vendor/craftcms/cms/src/web/Application.php(380): yii\base\Module->get()
#18 /var/www/html/vendor/yiisoft/yii2/web/Application.php(178): craft\web\Application->get()
#19 /var/www/html/vendor/craftcms/cms/src/helpers/Session.php(112): yii\web\Application->getSession()
#20 /var/www/html/vendor/craftcms/cms/src/helpers/Session.php(133): craft\helpers\Session::session()
#21 /var/www/html/vendor/craftcms/cms/src/helpers/Session.php(92): craft\helpers\Session::exists()
#22 /var/www/html/vendor/craftcms/cms/src/web/User.php(536): craft\helpers\Session::has()
#23 /var/www/html/vendor/yiisoft/yii2/web/User.php(199): craft\web\User->renewAuthStatus()
#24 /var/www/html/vendor/putyourlightson/craft-blitz/src/services/CacheRequestService.php(135): yii\web\User->getIdentity()
#25 /var/www/html/vendor/putyourlightson/craft-blitz/src/Blitz.php(314): putyourlightson\blitz\services\CacheRequestService->getIsCacheableRequest()
#26 [internal function]: putyourlightson\blitz\Blitz->{closure:putyourlightson\blitz\Blitz::registerCacheableRequestEvents():311}()
#27 /var/www/html/vendor/yiisoft/yii2/base/Event.php(312): call_user_func()
#28 /var/www/html/vendor/yiisoft/yii2/base/Component.php(654): yii\base\Event::trigger()
#29 /var/www/html/vendor/craftcms/cms/src/base/ApplicationTrait.php(547): yii\base\Component->trigger()
#30 /var/www/html/vendor/craftcms/cms/src/base/ApplicationTrait.php(1633): craft\web\Application->trigger()
#31 /var/www/html/vendor/craftcms/cms/src/web/Application.php(110): craft\web\Application->_postInit()
#32 /var/www/html/vendor/yiisoft/yii2/base/BaseObject.php(109): craft\web\Application->init()
#33 /var/www/html/vendor/yiisoft/yii2/base/Application.php(204): yii\base\BaseObject->__construct()
#34 [internal function]: yii\base\Application->__construct()
#35 /var/www/html/vendor/yiisoft/yii2/di/Container.php(419): ReflectionClass->newInstanceArgs()
#36 /var/www/html/vendor/yiisoft/yii2/di/Container.php(170): yii\di\Container->build()
#37 /var/www/html/vendor/yiisoft/yii2/BaseYii.php(365): yii\di\Container->get()
#38 /var/www/html/vendor/craftcms/cms/src/Craft.php(71): yii\BaseYii::createObject()
#39 /var/www/html/vendor/craftcms/cms/bootstrap/bootstrap.php(349): Craft::createObject()
#40 /var/www/html/vendor/craftcms/cms/bootstrap/web.php(40): require('...')
#41 /var/www/html/web/index.php(11): require('...')
#42 {main}

---

composer.json

{
  "name": "projectname",
  "minimum-stability": "dev",
  "prefer-stable": true,
  "require": {
    "craftcms/aws-s3": "2.2.2",
    "craftcms/ckeditor": "4.8.0",
    "craftcms/cms": "5.7.6",
    "mmikkel/cp-field-inspect": "2.0.4",
    "mmikkel/retcon": "3.2.1",
    "nystudio107/craft-emptycoalesce": "5.0.0",
    "nystudio107/craft-retour": "5.0.10",
    "nystudio107/craft-seomatic": "5.1.13",
    "nystudio107/craft-vite": "5.0.1",
    "putyourlightson/craft-blitz": "5.10.5",
    "spacecatninja/imager-x": "5.1.3",
    "spacecatninja/imager-x-aws-serverless-transformer": "3.0.2",
    "spacecatninja/imager-x-power-pack": "1.0.5",
    "spicyweb/craft-embedded-assets": "5.4.3",
    "vandres/craft-matrix-extended": "v4.2.1",
    "verbb/expanded-singles": "3.0.2",
    "verbb/navigation": "3.0.8",
    "viget/craft-classnames": "3.0.0",
    "viget/craft-viget-base": "^6.0",
    "vlucas/phpdotenv": "^5.4.0"
  },
  "require-dev": {
    "craftcms/ecs": "dev-main",
    "craftcms/generator": "^2.0.0",
    "craftcms/phpstan": "dev-main",
    "nystudio107/craft-autocomplete": "^1.12",
    "yiisoft/yii2-shell": "^2.0.3"
  },
  "autoload": {
    "psr-4": {
      "modules\\": "modules/"
    }
  },
  "config": {
    "allow-plugins": {
      "craftcms/plugin-installer": true,
      "yiisoft/yii2-composer": true
    },
    "sort-packages": true,
    "optimize-autoloader": true,
    "platform": {
      "php": "8.4"
    }
  },
  "scripts": {
    "ecs-check": "ecs check --ansi",
    "ecs-fix": "ecs check --ansi --fix",
    "phpstan": "phpstan --memory-limit=1G"
  },
  "repositories": [
    {
      "type": "composer",
      "url": "https://composer.craftcms.com",
      "canonical": false
    }
  ]
}

[joshuapease]

It looks like there has been some progress on this in the voku/portable-utf8 repo.

Although I don't think a release has happened yet.

voku/portable-utf8#208 (comment)

[jan-dh]

@brandonkelly seeing how the last tag was in March 2023, I'm not sure if it makes much sense in waiting around for a tag: https://github.com/voku/portable-utf8/tags

[Antimated]

@brandonkelly Not sure if you are aware but if you try to update plugins via the CMS the screen will just be stuck on checking server requirements. The only fix was to downgrade to php 8.3.

[koenvdp]

We resolved this in our PHP 8.4 projects by just adding the error reporting line from Craft's bootstrap.php to our own projects bootstrap.php file. (the one copied from the starter project: https://github.com/craftcms/craft/blob/5.x/bootstrap.php)

$errorLevel = E_ALL & ~E_DEPRECATED & ~E_USER_DEPRECATED;
error_reporting($errorLevel);

I assume the deprecated errors are triggered when the Voku/stringy package is autoloaded, which could be before Craft's bootstrap.php file is called. So making sure no deprecated errors are reported before loading Composer's autoloader should fix this.

[boboldehampsink]

@brandonkelly any chance of getting the fix in? We're still stuck on 8.3 because of this, and it is being deprecated soon.