Deprecate mysqli_refresh

[kamil-tekiela]

This functions was using the binary protocol command COM_REFRESH which is deprecated as of MySQL 5.7. We should not be using deprecated commands, so let's deprecate this function which has very easy alternatives in plain text SQL. See:

• https://dev.mysql.com/doc/dev/mysql-server/latest/page_protocol_com_refresh.html
• http://www.tocker.ca/2014/05/15/proposal-to-deprecate-com_refresh-packet.html
• https://dev.mysql.com/doc/c-api/8.0/en/mysql-refresh.html
• https://dev.mysql.com/worklog/task/?id=8754

We didn't have any tests for it so there was nothing to adjust.

[Girgias]

To land this in master/PHP 8.3 this needs RM approval @bukka @ericmann @adoy

I am otherwise in favour but this might also require a thread on the internals mailing list to see if anyone complains about this.

[kamil-tekiela]

It can also go in 8.4. I am fine either way.

[bukka]

yeah agreed better to target 8.4 as this should have some discussion most likely.

[jorgsowa]

IMO, it needs corresponding information in the changelog, because it's either way deprecation.

[kamil-tekiela]

I have added this to PHP 8.4 deprecation list https://wiki.php.net/rfc/deprecations_php_8_4#deprecate_mysqli_refresh

While I haven't included the 9 constants that are used with this function in the PR, I wonder if the constants should also be marked as deprecated. They will be removed when this function gets removed in PHP 9.0, but it's unlikely they have ever been used for anything other than this function.

[Girgias]

I have added this to PHP 8.4 deprecation list https://wiki.php.net/rfc/deprecations_php_8_4#deprecate_mysqli_refresh

While I haven't included the 9 constants that are used with this function in the PR, I wonder if the constants should also be marked as deprecated. They will be removed when this function gets removed in PHP 9.0, but it's unlikely they have ever been used for anything other than this function.

Makes sense, maybe just mention the constants in the RFC text?

[TimWolla]

Should be rebased onto master and the use of @deprecated replaced by the #[\Deprecated(since: '8.4', message: 'some explanation')] attribute.

[Girgias]

@kamil-tekiela could you rebase this?

[Girgias]

LGTM if CI is green

[jrfnl]

Looking at the commit, it looks like the functions have been deprecated, but the constants have not been (though are unlikely to be used with anything but these functions).

The RFC vote question was, however, "Deprecate mysqli_refresh(), mysqli::refresh() and related constants?", which leads me to believe the constants should also be formally deprecated.

I can see some discussion about this above, but would like to make sure anyway.

Was there a particular reason not to deprecate the constants ?

[Girgias]

They were indeed, let me do this in a follow-up PR.

EDIT: Kamil beat me to it: #15358