php_stream_wrapper_log_error() number of args changed in PHP 8.6.0

[Jan-E]

Description

php_stream_wrapper_log_error() used to take only 3 arguments:

php-src/main/php_streams.h

Lines 644 to 645 in ce4adcc

	/* pushes an error message onto the stack for a wrapper instance */
	PHPAPI void php_stream_wrapper_log_error(const php_stream_wrapper *wrapper, int options, const char *fmt, ...) PHP_ATTRIBUTE_FORMAT(printf, 3, 4);

After the addition of the new streams errors API php_stream_wrapper_log_error was marked as

/* Legacy wrapper error log functions */

php-src/main/streams/php_stream_errors.h

Lines 149 to 153 in f2b371e

	/* Legacy wrapper error log functions */
	PHPAPI void php_stream_wrapper_log_error(const php_stream_wrapper *wrapper,
	php_stream_context *context, int options, int severity, bool terminating,
	zend_enum_StreamErrorCode code, const char *fmt, ...)
	ZEND_ATTRIBUTE_FORMAT(printf, 7, 8);

The number of required args changed from 3 to 7.
@bukka This backwards incompatible change deserves a solution or a description in UPGRADING.INTERNALS, IMHO.

PHP Version

PHP 8.6.0 Alpha 1

Operating System

N/A

[Jan-E]

I ran into this issue while trying to compile sqlsrv for PHP 8.6.0 Alpha 3:

https://github.com/microsoft/msphpsql/blob/cea2418e2f298ec51740e782713be536bd883911/source/shared/core_stream.cpp#L275-L282

// The function core_get_field_common() is changed to pass REPORT_ERRORS for
    // php_stream_open_wrapper(). Whether the error flag is toggled or cleared,
    // the argument "options" will be zero.
    // For details check this pull request: https://github.com/php/php-src/pull/6190
    if (options != 0) {
        php_stream_wrapper_log_error(wrapper, options, "Invalid option: no options except REPORT_ERRORS may be specified with a sqlsrv stream");
        return NULL;
    }

The extension needs other fixes for PHP 8.6, but those are documented in UPGRADINF or UPGRADING.INTERNALS

[Girgias]

Would you prefer a detailed explanation on how to migrate from the old version to the new version, or somehow we keep the old signature and forward it to the new API?

(also note I might be looking into tweaking the API signature again to get rid of the severity parameter, but that might need a discussion on internals anyway.)

For maximum compatibility you probably want to use E_WARNING as the severity, NULL for the context (or pass it if you have one), and ZEND_ENUM_StreamErrorCode_Generic for the code. terminating should be set depending on if you abort the operation or not if my understanding is correct.