Deprecated functions in PHTML files

[addison74]

I recently worked at a store that needs to switch to PHP 8.1. If regarding the OpenMage files the matter was resolved and I did not encounter any errors in the log files, the theme and the extensions caused me big issues.

Today I spent an hour trying to understand why the product page does not load in the information area. After disabling all the extensions and not getting any positive results, I took the layout files first. I found that removing one loaded the page. I looked inside and identified the few PHTML files. Analyzing them one by one, I found nothing wrong, the variables were all displayed.

Then I went to the comment line by line until I found echo implode ($config, ','). When I reversed the parameters of the function, the situation was resolved. I looked for references and starting with PHP 8.0 this function parameters were switched. Honestly, I didn't know about this change, but I can't help but notice that in version 7, the PHP team scratched their right ear with their left hand in some respects.

In case someone faces this problem I wanted to make it public. Please note no errors were reported in the log files. Is there any way to debug the PHTML files and get in system.log the errors?

[sreichel]

Have you tried syntax-check that is used in github workflow?

[addison74]

I didn't do that. I would like to check the whole theme for syntax. I appreciate if you can give me a recommendation where to start.

[sreichel]

GitHub workflow runs this to check syntax errors ... i dont know if your issue is covered

- name: Check .phtml files
  run: '! find app/design -type f -name "*.phtml" -exec php -d error_reporting=32767 -l {} \; 2>&1 1> /dev/null | grep "^"'

[sreichel]

Maybe comment the lines mentioned here helps too ... #2586 (comment)

[kiatng]

Ref my comment here, can you try to change line 263 to } catch (Throwable $e) { in file

magento-lts/app/code/core/Mage/Core/Block/Template.php

Lines 263 to 266 in 5de30bf

	} catch (Exception $e) {
	ob_get_clean();
	throw $e;
	}

Does it throw an error on implode after the change?

[addison74]

Moved from #1442

I have a question, is it possible to display these error messages in the exceptions.log file instead of the browser window? If the error occurs in production, at least it is not displayed to visitors.

[addison74]

Moved from #1442

@kiatng replied: @addison74 To not display errors in browser, try removing $_SERVER['MAGE_IS_DEVELOPER_MODE'] in your vhost config, and set up the local.xml file in root folder /errors/. The errors will be saved in the folder /var/report/. See also https://magento.stackexchange.com/questions/49355/prevent-error-log-display-to-the-public

[addison74]

@kiatng - I loaded a phpinfo file and I don't have that variable set somewhere. Neither in vhost nor in .htaccess. It is a test DDEV environment, possibly the issue comes from its default settings. I will check more in detail.

[addison74]

I found the issue. It comes from display_errors = On set by default in DDEV. I had to create a new file /.ddev/php/noerrors.ini and set the value to Off. Once I did this the page is loaded with error 503 and I catch the error message in the log file of the webserver.

[sreichel]

@addison74 this might be useful for #2575.

[addison74]

At this moment we have the following code in OpenMage:

magento-lts/app/code/core/Mage/Core/Block/Template.php

Lines 262 to 265 in f96f0b3

	} catch (Exception $e) {
	ob_get_clean();
	throw $e;
	}

I would propose the following change:

        } catch (Throwable $e) {
            ob_get_clean();
            Mage::logException($e);
            // throw $e;

By using Mage::logException method the error is written in exceptions.log file. I commented throw so that the error does not appear in the Frontend anymore.

The advantage of this simple modification is that the Frontend is loaded entirely and only the block with the issue is omitted. In my case, where the implode function was used, it is not displayed. Now troubleshooting is simple, I go to /var/log and I get all the template issues in exceptions file.

I'm really surprised why it was preferred to display errors from templates in the browser instead of being recorded in exceptions.log or another file by using Mage::log($e, null, 'template_error.log'.

[kiatng]

How about

        } catch (Throwable $e) {
            ob_get_clean();
            Mage::logException($e);
            if (Mage::getIsDeveloperMode()) {
                throw $e;
            }

This way, it's more helpful during development.

[addison74]

It is a good observation related to the developer mode. Since the error is displayed in the browser, it is no longer needed to write it in the exceptions.log file too. The code would look like this:

} catch (Throwable $e) {
    ob_get_clean();
    if (Mage::getIsDeveloperMode()) {
        throw $e;
    } else {
        Mage::logException($e);
    }

[elidrissidev]

I have a pending PR that resolves a lot of deprecation errors, but it's not exhaustive. Please if you can, take note of any errors you encounter that have to do with PHP 8.1's changed behavior so that they can be worked on either by me, or anyone else.