Skip to content

PHP 8.4: Indicate extensions have been unbundled #4103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions appendices/extensions.xml
Original file line number Diff line number Diff line change
Expand Up @@ -277,22 +277,18 @@
<listitem><para><xref linkend="book.enchant"/></para></listitem>
<listitem><para><xref linkend="book.gettext"/></para></listitem>
<listitem><para><xref linkend="book.gmp"/></para></listitem>
<listitem><para><xref linkend="book.imap"/></para></listitem>
<listitem><para><xref linkend="book.ldap"/></para></listitem>
<listitem><para><xref linkend="book.libxml"/></para></listitem>
<listitem><para><xref linkend="book.mysqli"/></para></listitem>
<listitem><para><xref linkend="book.mysqlnd"/></para></listitem>
<listitem><para><xref linkend="book.oci8"/></para></listitem>
<listitem><para><xref linkend="book.openssl"/></para></listitem>
<listitem><para><xref linkend="ref.pdo-dblib"/></para></listitem>
<listitem><para><xref linkend="ref.pdo-firebird"/></para></listitem>
<listitem><para><xref linkend="ref.pdo-mysql"/></para></listitem>
<listitem><para><xref linkend="ref.pdo-oci"/></para></listitem>
<listitem><para><xref linkend="ref.pdo-odbc"/></para></listitem>
<listitem><para><xref linkend="ref.pdo-pgsql"/></para></listitem>
<listitem><para><xref linkend="ref.pdo-sqlite"/></para></listitem>
<listitem><para><xref linkend="book.pgsql"/></para></listitem>
<listitem><para><xref linkend="book.pspell"/></para></listitem>
<listitem><para><xref linkend="book.readline"/></para></listitem>
<listitem><para><xref linkend="book.simplexml"/></para></listitem>
<listitem><para><xref linkend="book.snmp"/></para></listitem>
Expand Down Expand Up @@ -335,6 +331,7 @@
<listitem><para><xref linkend="book.ibm-db2"/></para></listitem>
<listitem><para><xref linkend="book.igbinary"/></para></listitem>
<listitem><para><xref linkend="book.imagick"/></para></listitem>
<listitem><para><xref linkend="book.imap"/></para></listitem>
<listitem><para><xref linkend="book.inotify"/></para></listitem>
<listitem><para><xref linkend="book.lua"/></para></listitem>
<listitem><para><xref linkend="book.luasandbox"/></para></listitem>
Expand All @@ -348,14 +345,17 @@
<listitem><para><xref linkend="book.mysql"/></para></listitem>
<listitem><para><xref linkend="book.mysql-xdevapi"/></para></listitem>
<listitem><para><xref linkend="book.oauth"/></para></listitem>
<listitem><para><xref linkend="book.oci8"/></para></listitem>
<listitem><para><xref linkend="book.openal"/></para></listitem>
<listitem><para><xref linkend="book.parallel"/></para></listitem>
<listitem><para><xref linkend="book.parle"/></para></listitem>
<listitem><para><xref linkend="ref.pdo-cubrid"/></para></listitem>
<listitem><para><xref linkend="ref.pdo-ibm"/></para></listitem>
<listitem><para><xref linkend="ref.pdo-informix"/></para></listitem>
<listitem><para><xref linkend="ref.pdo-oci"/></para></listitem>
<listitem><para><xref linkend="ref.pdo-sqlsrv"/></para></listitem>
<listitem><para><xref linkend="book.ps"/></para></listitem>
<listitem><para><xref linkend="book.pspell"/></para></listitem>
<listitem><para><xref linkend="book.pthreads"/></para></listitem>
<listitem><para><xref linkend="book.quickhash"/></para></listitem>
<listitem><para><xref linkend="book.radius"/></para></listitem>
Expand Down Expand Up @@ -415,6 +415,7 @@
&extcat.state.deprecated;

<itemizedlist>
<listitem><para><xref linkend="book.imap"/></para></listitem>
<listitem><para><xref linkend="book.mysql"/></para></listitem>
<listitem><para><xref linkend="book.wddx"/></para></listitem>
<listitem><para><xref linkend="book.xmlrpc"/></para></listitem>
Expand Down
11 changes: 7 additions & 4 deletions reference/imap/book.xml
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<!-- State: deprecated -->
<book xml:id="book.imap" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<?phpdoc extension-membership="bundledexternal" ?>
<?phpdoc extension-membership="pecl" ?>
<title>IMAP, POP3 and NNTP</title>
<titleabbrev>IMAP</titleabbrev>

<!-- {{{ preface -->
<preface xml:id="intro.imap">
&reftitle.intro;
<warning>
<simpara>
This extension is <emphasis>DEPRECATED</emphasis> and <emphasis>UNBUNDLED</emphasis> as of PHP 8.4.0.
</simpara>
</warning>
<para>
These functions enable you to operate with the <acronym>IMAP</acronym>
protocol, as well as the <acronym>NNTP</acronym>, <acronym>POP3</acronym>
Expand All @@ -32,7 +36,6 @@
&reference.imap.imap.connection;

</book>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand Down
65 changes: 39 additions & 26 deletions reference/imap/configure.xml
Original file line number Diff line number Diff line change
@@ -1,36 +1,49 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="imap.installation" xmlns="http://docbook.org/ns/docbook">
<section xml:id="imap.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.install;
<para>
To get these functions to work, you have to compile PHP with
<option role="configure">--with-imap[=DIR]</option>, where DIR is the
c-client install prefix. From our example above, you would use
<option role="configure">--with-imap=/usr/local/imap-2000b</option>.
This location depends on where you created this directory according to the
description above. <productname>Windows</productname> users may include the
<filename>php_imap.dll</filename> DLL in &php.ini;.
</para>
<note>
<simpara>
Depending on how the c-client was configured, you might also need
to add <option
role="configure">--with-imap-ssl=/path/to/openssl/</option> and/or
<option role="configure">--with-kerberos=/path/to/kerberos</option>
to the PHP configure line.
</simpara>
</note>
<section xml:id="imap.installation.php84">
<title>PHP 8.4</title>
<para>
&pecl.moved-ver;8.4.0
</para>
<para>
&pecl.info;
<link xlink:href="&url.pecl.package;imap">&url.pecl.package;imap</link>.
</para>
</section>

<warning>
<simpara>
The IMAP extension is not thread-safe; it should not be used with ZTS builds.
</simpara>
</warning>
<section xml:id="imap.installation.phplt84">
<title>PHP &lt; 8.4</title>
<para>
To get these functions to work, you have to compile PHP with
<option role="configure">--with-imap[=DIR]</option>, where DIR is the
c-client install prefix. From our example above, you would use
<option role="configure">--with-imap=/usr/local/imap-2000b</option>.
This location depends on where you created this directory according to the
description above. <productname>Windows</productname> users may include the
<filename>php_imap.dll</filename> DLL in &php.ini;.
</para>
<note>
<simpara>
Depending on how the c-client was configured, you might also need
to add <option
role="configure">--with-imap-ssl=/path/to/openssl/</option> and/or
<option role="configure">--with-kerberos=/path/to/kerberos</option>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's ignore that --with-imap-ssl and --with-kerberos no longer accept paths as of PHP 7.4.0 (using pkg-config instead). :)

to the PHP configure line.
</simpara>
</note>

&warn.imaprecodeyaz;
<warning>
<simpara>
The IMAP extension is not thread-safe; it should not be used with ZTS builds.
</simpara>
</warning>

</section>
&warn.imaprecodeyaz;
</section>

</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand Down
7 changes: 6 additions & 1 deletion reference/oci8/book.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,18 @@
<!-- $Revision$ -->

<book xml:id="book.oci8" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<?phpdoc extension-membership="bundledexternal" ?>
<?phpdoc extension-membership="pecl" ?>
<title>Oracle OCI8</title>
<titleabbrev>OCI8</titleabbrev>

<!-- {{{ preface -->
<preface xml:id="intro.oci8">
&reftitle.intro;
<warning>
<simpara>
This extension is <emphasis>UNBUNDLED</emphasis> as of PHP 8.4.0.
</simpara>
</warning>
<para>
These functions allow you to access Oracle Database. They support SQL and
PL/SQL statements. Basic features include transaction control, binding of PHP
Expand Down
48 changes: 31 additions & 17 deletions reference/pdo_oci/configure.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,30 +9,44 @@
<link xlink:href="&url.oracle.instant.client;">Oracle Instant Client</link> libraries.
For details refer to the <link linkend="oci8.requirements">OCI8 Requirements</link> section.
</para>
<para>
Use <option role="configure">--with-pdo-oci[=DIR]</option> to install
the PDO Oracle OCI extension, where the optional <literal>[=DIR]</literal>
is the Oracle Home directory. <literal>[=DIR]</literal> defaults to
the <varname>$ORACLE_HOME</varname> environment variable.
</para>
<para>
Use <option role="configure">--with-pdo-oci=instantclient,prefix,version</option>
for an Oracle Instant Client <acronym>SDK</acronym>, where prefix and
version are configured.
</para>
<para>
<screen>
<![CDATA[

<section xml:id="pdo-oci.installation.php84">
<title>PHP 8.4</title>
<para>
&pecl.moved-ver;8.4.0
</para>
<para>
&pecl.info;
<link xlink:href="&url.pecl.package;PDO_OCI">&url.pecl.package;PDO_OCI</link>.
</para>
</section>

<section xml:id="pdo-oci.installation.phplt84">
<title>PHP &lt; 8.4</title>
<para>
Use <option role="configure">--with-pdo-oci[=DIR]</option> to install
the PDO Oracle OCI extension, where the optional <literal>[=DIR]</literal>
is the Oracle Home directory. <literal>[=DIR]</literal> defaults to
the <varname>$ORACLE_HOME</varname> environment variable.
</para>
<para>
Use <option role="configure">--with-pdo-oci=instantclient,prefix,version</option>
for an Oracle Instant Client <acronym>SDK</acronym>, where prefix and
version are configured.
</para>
<para>
<screen>
<![CDATA[
// Using $ORACLE_HOME
$ ./configure --with-pdo-oci

// Using OIC for Linux with 10.2.0.3 RPMs with a /usr prefix
$ ./configure --with-pdo-oci=instantclient,/usr,10.2.0.3
]]>
</screen>
</para>
</screen>
</para>
</section>
</section>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand Down
2 changes: 1 addition & 1 deletion reference/pdo_oci/reference.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!-- $Revision$ -->

<reference xml:id="ref.pdo-oci" xmlns="http://docbook.org/ns/docbook">
<?phpdoc extension-membership="bundledexternal" ?>
<?phpdoc extension-membership="pecl" ?>
<title>Oracle Functions (PDO_OCI)</title>
<titleabbrev>Oracle (PDO)</titleabbrev>
<partintro>
Expand Down
13 changes: 8 additions & 5 deletions reference/pspell/book.xml
Original file line number Diff line number Diff line change
@@ -1,28 +1,31 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<book xml:id="book.pspell" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<?phpdoc extension-membership="bundledexternal" ?>
<?phpdoc extension-membership="pecl" ?>
<title>Pspell</title>

<!-- {{{ preface -->
<preface xml:id="intro.pspell">
&reftitle.intro;
<warning>
<simpara>
This extension is <emphasis>DEPRECATED</emphasis> and <emphasis>UNBUNDLED</emphasis> as of PHP 8.4.0.
</simpara>
</warning>
<para>
These functions allow you to check the spelling of a word and offer
suggestions.
</para>
</preface>
<!-- }}} -->

&reference.pspell.setup;
&reference.pspell.constants;
&reference.pspell.reference;
&reference.pspell.pspell.dictionary;
&reference.pspell.pspell.config;

</book>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand Down
40 changes: 26 additions & 14 deletions reference/pspell/configure.xml
Original file line number Diff line number Diff line change
@@ -1,25 +1,37 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="pspell.installation" xmlns="http://docbook.org/ns/docbook">
<section xml:id="pspell.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.install;
<para>
If you have the libraries needed add the
<option role="configure">--with-pspell[=dir]</option> option
when compiling PHP.
</para>
<note>
<title>Note to Win32 Users</title>
<section xml:id="pspell.installation.php84">
<title>PHP 8.4</title>
<para>
&ext.windows.path.dll;
<filename>aspell-15.dll</filename> from the
<filename>bin</filename> folder of the aspell installation.
&pecl.moved-ver;8.4.0
</para>
<para>
Win32 support requires at least aspell version 0.50.
&pecl.info;
<link xlink:href="&url.pecl.package;pspell">&url.pecl.package;pspell</link>.
</para>
</note>
</section>
</section>

<section xml:id="pspell.installation.phplt84">
<title>PHP &lt; 8.4</title>
<para>
To enable this extension compile PHP with the
<option role="configure">--with-pspell[=dir]</option> option.
</para>
<note>
<title>Note to Win32 Users</title>
<para>
&ext.windows.path.dll;
<filename>aspell-15.dll</filename> from the
<filename>bin</filename> folder of the aspell installation.
</para>
<para>
Win32 support requires at least aspell version 0.50.
</para>
</note>
</section>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand Down