Contributions are ready for review

Hello PHP EN Documentation team, There are contributions within the online editor queue for this language. Please review, then commit or delete these patches. Patches for review : ----------------------- Modified: en/reference/mcrypt/constants.xml By: leigh on 2017-01-11 07:16:44 =================================================================== --- en/reference/mcrypt/constants.xml +++ en/reference/mcrypt/constants.xml @@ -16,40 +16,40 @@ <listitem> <simpara> <constant>MCRYPT_MODE_ECB</constant> (<literal>electronic - codebook</literal>) is suitable for random data, - such as encrypting other keys. Since data there is short and random, - the disadvantages of ECB have a favorable negative effect. + codebook</literal>) is a block cipher mode that is generally + unsuitable for most purposes. The use of this mode is not recommended. </simpara> </listitem> <listitem> <simpara> <constant>MCRYPT_MODE_CBC</constant> (<literal>cipher block - chaining</literal>) is especially suitable for - encrypting files where the security is increased over <literal>ECB</literal> - significantly. + chaining</literal>) is a block cipher mode that is significantly + more secure than <literal>ECB</literal> mode. </simpara> </listitem> <listitem> <simpara> <constant>MCRYPT_MODE_CFB</constant> (<literal>cipher - feedback</literal>) is the best mode for encrypting byte - streams where single bytes must be encrypted. + feedback, in 8-bit mode</literal>) is a stream cipher mode. + It is recommended to use <literal>NCFB</literal> mode rather + than <literal>CFB</literal> mode. </simpara> </listitem> <listitem> <simpara> <constant>MCRYPT_MODE_OFB</constant> (<literal>output feedback, in - 8bit</literal>) is comparable to <literal>CFB</literal>, but + 8-bit mode</literal>) is a stream cipher mode comparable to <literal>CFB</literal>, but can be used in applications where error propagation cannot - be tolerated. It's insecure (because it operates in 8bit - mode) so it is not recommended to use it. + be tolerated. + It is recommended to use <literal>NOFB</literal> mode rather + than <literal>OFB</literal> mode. </simpara> </listitem> <listitem> <simpara> <constant>MCRYPT_MODE_NOFB</constant> (<literal>output feedback, - in nbit</literal>) is comparable to OFB, but - more secure because it operates on the block size of the algorithm. + in n-bit mode</literal>) is comparable to <literal>OFB</literal> mode, + but operates on the full block size of the algorithm. </simpara> </listitem> <listitem> @@ -60,6 +60,25 @@ </listitem> </itemizedlist> </para> + + <para> + Mcrypt supports some other modes of operation for which there are no predefined constants. + They can be utilised by passing a string in place of the missing constants. + <itemizedlist> + <listitem> + <simpara> + <constant>"ctr"</constant> (<literal>counter mode</literal>) is a stream cipher mode. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>"ncfb"</constant> (<literal>cipher feedback, + in n-bit mode</literal>) is comparable to <literal>CFB</literal> mode, + but operates on the full block size of the algorithm. + </simpara> + </listitem> + </itemizedlist> + </para> <para> Some other mode and random device constants: => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=71828 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=71828 ------------------------------------------------------------------ Modified: en/reference/mbstring/overloading.xml By: kelunik on 2017-02-09 05:20:32 =================================================================== --- en/reference/mbstring/overloading.xml +++ en/reference/mbstring/overloading.xml @@ -1,14 +1,18 @@ <?xml version="1.0" encoding="utf-8"?> -<!-- $Revision: 342126 $ --> +<!-- $Revision: 297028 $ --> <chapter xml:id="mbstring.overload" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <title> Function Overloading Feature </title> - - <para> - &warn.deprecated.feature-7-2-0; - </para> + <caution> + <para> + This directive will break any code that relies on these fundamental + string functions to operate on bytes instead of code points. Its use + has thus been discouraged. It will be deprecated in PHP 7.2.0 and + removed in PHP 8. + </para> + </caution> <para> You might often find it difficult to get an existing PHP application to work in a given multibyte environment. This happens because most @@ -140,14 +144,6 @@ </tgroup> </table> </para> - <note> - <para> - It is not recommended to use the function overloading option in - the per-directory context, because it's not confirmed yet to be - stable enough in a production environment and may lead to undefined - behaviour. - </para> - </note> </chapter> <!-- Keep this comment at the end of the file => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=72330 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=72330 ------------------------------------------------------------------ Modified: en/reference/win32service/functions/win32-get-last-control-message.xml By: Jean-Baptiste Nahan on 2017-03-25 06:23:33 =================================================================== --- en/reference/win32service/functions/win32-get-last-control-message.xml +++ en/reference/win32service/functions/win32-get-last-control-message.xml @@ -33,6 +33,15 @@ </para> </refsect1> +<refsect1 role="notes"> +&reftitle.notes; +<caution> +<para> +Since version 0.2.0, this function work only in "cli" SAPI. On other SAPI the function is disabled. +</para> +</caution> +</refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=73075 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=73075 ------------------------------------------------------------------ Modified: en/reference/win32service/functions/win32-set-service-status.xml By: Jean-Baptiste Nahan on 2017-03-25 06:23:46 =================================================================== --- en/reference/win32service/functions/win32-set-service-status.xml +++ en/reference/win32service/functions/win32-set-service-status.xml @@ -67,6 +67,15 @@ </para> </refsect1> +<refsect1 role="notes"> +&reftitle.notes; +<caution> +<para> +Since version 0.2.0, this function work only in "cli" SAPI. On other SAPI the function is disabled. +</para> +</caution> +</refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=73074 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=73074 ------------------------------------------------------------------ Modified: en/reference/win32service/functions/win32-start-service-ctrl-dispatcher.xml By: Jean-Baptiste Nahan on 2017-03-25 06:23:59 =================================================================== --- en/reference/win32service/functions/win32-start-service-ctrl-dispatcher.xml +++ en/reference/win32service/functions/win32-start-service-ctrl-dispatcher.xml @@ -90,6 +90,15 @@ </para> </refsect1> +<refsect1 role="notes"> +&reftitle.notes; +<caution> +<para> +Since version 0.2.0, this function work only in "cli" SAPI. On other SAPI the function is disabled. +</para> +</caution> +</refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=73073 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=73073 ------------------------------------------------------------------ Modified: en/reference/ldap/functions/ldap-get-option.xml By: heiglandreas on 2017-04-17 11:06:45 =================================================================== --- en/reference/ldap/functions/ldap-get-option.xml +++ en/reference/ldap/functions/ldap-get-option.xml @@ -37,135 +37,164 @@ <para> The parameter <parameter>option</parameter> can be one of: <informaltable> - <tgroup cols="2"> + <tgroup cols="3"> <thead> <row> <entry>Option</entry> <entry>Type</entry> + <entry>since</entry> </row> </thead> <tbody> <row> <entry><constant>LDAP_OPT_DEREF</constant></entry> <entry>integer</entry> + <entry></entry> </row> <row> <entry><constant>LDAP_OPT_SIZELIMIT</constant></entry> <entry>integer</entry> + <entry></entry> </row> <row> <entry><constant>LDAP_OPT_TIMELIMIT</constant></entry> <entry>integer</entry> + <entry></entry> </row> <row> <entry><constant>LDAP_OPT_NETWORK_TIMEOUT</constant></entry> <entry>integer</entry> + <entry></entry> </row> <row> <entry><constant>LDAP_OPT_PROTOCOL_VERSION</constant></entry> <entry>integer</entry> + <entry></entry> </row> <row> <entry><constant>LDAP_OPT_ERROR_NUMBER</constant></entry> <entry>integer</entry> + <entry></entry> </row> <row> <entry><constant>LDAP_OPT_REFERRALS</constant></entry> <entry>bool</entry> + <entry></entry> </row> <row> <entry><constant>LDAP_OPT_RESTART</constant></entry> <entry>bool</entry> + <entry></entry> </row> <row> <entry><constant>LDAP_OPT_HOST_NAME</constant></entry> <entry>string</entry> + <entry></entry> </row> <row> <entry><constant>LDAP_OPT_ERROR_STRING</constant></entry> <entry>string</entry> + <entry></entry> </row> <row> <entry><constant>LDAP_OPT_MATCHED_DN</constant></entry> <entry>string</entry> + <entry></entry> </row> <row> <entry><constant>LDAP_OPT_SERVER_CONTROLS</constant></entry> <entry>array</entry> + <entry></entry> </row> <row> <entry><constant>LDAP_OPT_CLIENT_CONTROLS</constant></entry> <entry>array</entry> + <entry></entry> </row> <row> <entry><constant>LDAP_OPT_X_KEEPALIVE_IDLE</constant></entry> <entry>int</entry> - <entry></entry> + <entry>7.1</entry> </row> <row> <entry><constant>LDAP_OPT_X_KEEPALIVE_PROBES</constant></entry> <entry>int</entry> - <entry></entry> + <entry>7.1</entry> </row> <row> <entry><constant>LDAP_OPT_X_KEEPALIVE_INTERVAL</constant></entry> <entry>int</entry> - <entry></entry> + <entry>7.1</entry> </row> <row> <entry><constant>LDAP_OPT_X_TLS_CACERTDIR</constant></entry> <entry>string</entry> - <entry></entry> + <entry>7.1</entry> </row> <row> <entry><constant>LDAP_OPT_X_TLS_CACERTFILE</constant></entry> <entry>string</entry> - <entry></entry> + <entry>7.1</entry> </row> <row> <entry><constant>LDAP_OPT_X_TLS_CERTFILE</constant></entry> <entry>string</entry> - <entry></entry> + <entry>7.1</entry> </row> <row> <entry><constant>LDAP_OPT_X_TLS_CIPHER_SUITE</constant></entry> <entry>string</entry> - <entry></entry> + <entry>7.1</entry> </row> <row> <entry><constant>LDAP_OPT_X_TLS_CRLCHECK</constant></entry> <entry>integer</entry> - <entry></entry> + <entry>7.1</entry> + </row> + <row> + <entry><constant>LDAP_OPT_X_TLS_CRL_NONE</constant></entry> + <entry>integer</entry> + <entry>7.1</entry> + </row> + <row> + <entry><constant>LDAP_OPT_X_TLS_CRL_PEER</constant></entry> + <entry>integer</entry> + <entry>7.1</entry> + </row> + <row> + <entry><constant>LDAP_OPT_X_TLS_CRL_ALL</constant></entry> + <entry>integer</entry> + <entry>7.1</entry> </row> <row> <entry><constant>LDAP_OPT_X_TLS_CRLFILE</constant></entry> <entry>string</entry> - <entry></entry> + <entry>7.1</entry> </row> <row> <entry><constant>LDAP_OPT_X_TLS_DHFILE</constant></entry> <entry>string</entry> - <entry></entry> + <entry>7.1</entry> </row> <row> <entry><constant>LDAP_OPT_X_TLS_KEYILE</constant></entry> <entry>string</entry> - <entry></entry> + <entry>7.1</entry> </row> <row> <entry><constant>LDAP_OPT_X_TLS_PACKAGE</constant></entry> <entry>string</entry> - <entry></entry> + <entry>7.1</entry> </row> <row> <entry><constant>LDAP_OPT_X_TLS_PROTOCOL_MIN</constant></entry> <entry>integer</entry> - <entry></entry> + <entry>7.1</entry> </row> <row> <entry><constant>LDAP_OPT_X_TLS_RANDOM_FILE</constant></entry> <entry>string</entry> - <entry></entry> + <entry>7.1</entry> </row> <row> <entry><constant>LDAP_OPT_X_TLS_REQUIRE_CERT</constant></entry> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=73610 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=73610 ------------------------------------------------------------------ Modified: en/language/functions.xml By: anonymous on 2017-04-26 02:54:48 =================================================================== --- en/language/functions.xml +++ en/language/functions.xml @@ -450,6 +450,13 @@ </entry> <entry>PHP 7.0.0</entry> </row> + <row> + <entry><literal>iterable</literal></entry> + <entry> + The parameter must be either an <type>array</type> or an &instanceof; <classname>Traversable</classname>. + </entry> + <entry>PHP 7.1.0</entry> + </row> </tbody> </tgroup> </informaltable> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=73813 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=73813 ------------------------------------------------------------------ Modified: en/appendices/migration70/new-features.xml By: anonymous on 2017-05-04 04:58:31 =================================================================== --- en/appendices/migration70/new-features.xml +++ en/appendices/migration70/new-features.xml @@ -300,9 +300,9 @@ class A {private $x = 1;} // Pre PHP 7 code -$getXCB = function() {return $this->x;}; -$getX = $getXCB->bindTo(new A, 'A'); // intermediate closure -echo $getX(); +$getX = function() {return $this->x;}; +$getXCB = $getX->bindTo(new A, 'A'); // intermediate closure +echo $getXCB(); // PHP 7+ code $getX = function() {return $this->x;}; => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=73888 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=73888 ------------------------------------------------------------------ Modified: en/reference/sqlsrv/configure.xml By: Jean-Baptiste Nahan on 2017-05-04 13:43:08 =================================================================== --- en/reference/sqlsrv/configure.xml +++ en/reference/sqlsrv/configure.xml @@ -14,7 +14,7 @@ </para> <para> The most recent version of the driver is available for download here: - <link xlink:href="&url.sqlsrv;">SQLSRV 3.0 download</link>. If you need support + <link xlink:href="&url.sqlsrv;">SQLSRV 4.0 download</link>. If you need support for PHP 5.2 and/or PHP compiled with VC6, use the 2.0 release of the driver: <link xlink:href="&url.sqlsrv.v2driverdownload;">SQLSRV 2.0 download</link>. </para> @@ -23,7 +23,7 @@ <link xlink:href="&url.sqlsrv.system.requirements;">SQLSRV System Requirements</link>. </para> <para> - The SQLSRV extension is only compatible with PHP running on Windows. + The SQLSRV extension is only compatible with PHP 5 running on Windows. Since version 4.0 the SQLSRV extension is compatilbe only with PHP 7.0 running on Linux or Windows. </para> </section> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=73905 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=73905 ------------------------------------------------------------------ Modified: en/reference/sqlsrv/setup.xml By: Jean-Baptiste Nahan on 2017-05-04 21:22:57 =================================================================== --- en/reference/sqlsrv/setup.xml +++ en/reference/sqlsrv/setup.xml @@ -36,7 +36,7 @@ </para> <para> The most recent version of the driver is available for download here: - <link xlink:href="&url.sqlsrv;">SQLSRV 3.0 download</link>. If you need support + <link xlink:href="&url.sqlsrv;">SQLSRV 4.0 download</link>. If you need support for PHP 5.2 and/or PHP compiled with VC6, use the 2.0 release of the driver: <link xlink:href="&url.sqlsrv.v2driverdownload;">SQLSRV 2.0 download</link>. </para> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=73907 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=73907 ------------------------------------------------------------------ Modified: en/reference/misc/functions/pack.xml By: sskaje on 2017-05-07 20:19:41 =================================================================== --- en/reference/misc/functions/pack.xml +++ en/reference/misc/functions/pack.xml @@ -138,10 +138,26 @@ <entry>float (machine dependent size and representation)</entry> </row> <row> + <entry>g</entry> + <entry>float (machine dependent size, little endian byte order)</entry> + </row> + <row> + <entry>G</entry> + <entry>float (machine dependent size, big endian byte order)</entry> + </row> + <row> <entry>d</entry> <entry>double (machine dependent size and representation)</entry> </row> <row> + <entry>e</entry> + <entry>double (machine dependent size, little endian byte order)</entry> + </row> + <row> + <entry>E</entry> + <entry>double (machine dependent size, big endian byte order)</entry> + </row> + <row> <entry>x</entry> <entry>NUL byte</entry> </row> @@ -194,6 +210,12 @@ </thead> <tbody> <row> + <entry>7.0.15,7.1.1</entry> + <entry> + The "e", "E", "g" and "G" codes were added to enable byte order support for float and double. + </entry> + </row> + <row> <entry>5.6.3</entry> <entry> The "q", "Q", "J" and "P" codes were added to enable working with 64-bit numbers. => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=73929 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=73929 ------------------------------------------------------------------ Modified: en/reference/openssl/functions/openssl-pkcs12-export.xml By: jelle van der Waa on 2017-05-10 02:12:23 =================================================================== --- en/reference/openssl/functions/openssl-pkcs12-export.xml +++ en/reference/openssl/functions/openssl-pkcs12-export.xml @@ -56,6 +56,8 @@ <term><parameter>args</parameter></term> <listitem> <para> + Optional Array, provide an key "extracerts" with as value an array of extra certificates or a single certificate to be included in the PKCS#12 file. + Provide an key "friendlyname" with as value an string to be used for the supplied certificate and key. </para> </listitem> </varlistentry> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=73938 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=73938 ------------------------------------------------------------------ Modified: en/reference/memcached/constants.xml By: Martin Georgiev on 2017-05-15 05:40:48 =================================================================== --- en/reference/memcached/constants.xml +++ en/reference/memcached/constants.xml @@ -323,6 +323,37 @@ </listitem> </varlistentry> + <varlistentry xml:id="memcached.constants.have-msgpack"> + <term><constant>Memcached::HAVE_MSGPACK</constant></term> + <listitem> + <para>Indicates whether msgpack serializer support is available.</para> + <para>Type: <literal>boolean</literal>. Available since v3.0</para> + </listitem> + </varlistentry> + + <varlistentry xml:id="memcached.constants.have-session"> + <term><constant>Memcached::HAVE_SESSION</constant></term> + <listitem> + <para>Type: <literal>boolean</literal>. Available since v3.0</para> + </listitem> + </varlistentry> + + <varlistentry xml:id="memcached.constants.have-sasl"> + <term><constant>Memcached::HAVE_SASL</constant></term> + <listitem> + <para>Type: <literal>boolean</literal>. Available since v3.0</para> + </listitem> + </varlistentry> + + <varlistentry xml:id="memcached.constants.get-extended"> + <term><constant>Memcached::GET_EXTENDED</constant></term> + <listitem> + <para>A flag for <function>Memcached::get</function>, <function>Memcached::getMulti</function> and + <function>Memcached::getMultiByKey</function> to ensure that the CAS token values + are returned as well. Available since v3.0</para> + </listitem> + </varlistentry> + <varlistentry xml:id="memcached.constants.get-preserve-order"> <term><constant>Memcached::GET_PRESERVE_ORDER</constant></term> <listitem> @@ -484,6 +515,55 @@ </listitem> </varlistentry> + <varlistentry xml:id="memcached.constants.res-auth-problem"> + <term><constant>Memcached::RES_AUTH_PROBLEM</constant></term> + <listitem> + <para>Available since v3.0</para> + </listitem> + </varlistentry> + + <varlistentry xml:id="memcached.constants.res-auth-failure"> + <term><constant>Memcached::RES_AUTH_FAILURE</constant></term> + <listitem> + <para>Available since v3.0</para> + </listitem> + </varlistentry> + + <varlistentry xml:id="memcached.constants.res-auth-continue"> + <term><constant>Memcached::RES_AUTH_CONTINUE</constant></term> + <listitem> + <para>Available since v3.0</para> + </listitem> + </varlistentry> + + <varlistentry xml:id="memcached.constants.res-e2big"> + <term><constant>Memcached::RES_E2BIG</constant></term> + <listitem> + <para>Available since v3.0</para> + </listitem> + </varlistentry> + + <varlistentry xml:id="memcached.constants.res-key-too-big"> + <term><constant>Memcached::RES_KEY_TOO_BIG</constant></term> + <listitem> + <para>Available since v3.0</para> + </listitem> + </varlistentry> + + <varlistentry xml:id="memcached.constants.res-server-temporarily-disabled"> + <term><constant>Memcached::RES_SERVER_TEMPORARILY_DISABLED</constant></term> + <listitem> + <para>Available since v3.0</para> + </listitem> + </varlistentry> + + <varlistentry xml:id="memcached.constants.res-server-memory-allocation-failure"> + <term><constant>Memcached::RES_SERVER_MEMORY_ALLOCATION_FAILURE</constant></term> + <listitem> + <para>Available since v3.0</para> + </listitem> + </varlistentry> + </variablelist> </appendix> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=73966 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=73966 ------------------------------------------------------------------ Modified: en/reference/memcached/memcached/getmulti.xml By: Martin Georgiev on 2017-05-15 06:05:00 =================================================================== --- en/reference/memcached/memcached/getmulti.xml +++ en/reference/memcached/memcached/getmulti.xml @@ -6,41 +6,39 @@ <refname>Memcached::getMulti</refname> <refpurpose>Retrieve multiple items</refpurpose> </refnamediv> - + <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>mixed</type><methodname>Memcached::getMulti</methodname> <methodparam><type>array</type><parameter>keys</parameter></methodparam> - <methodparam choice="opt"><type>array</type><parameter role="reference">cas_tokens</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> </methodsynopsis> <para> <function>Memcached::getMulti</function> is similar to <methodname>Memcached::get</methodname>, but instead of a single key item, it retrieves multiple items the keys of which are specified in the - <parameter>keys</parameter> array. If <parameter>cas_tokens</parameter> - variable is provided, it is filled with the CAS token values for the found - items. + <parameter>keys</parameter> array. <note> <para> - Unlike <methodname>Memcached::get</methodname> it is not possible to - specify a read-through cache callback for - <function>Memcached::getMulti</function>, because the memcache protocol - does not provide information on which keys were not found in the multi-key - request. + Before v3.0 a second argument <parameter role="reference">cas_tokens</parameter> was in use. + It was filled with the CAS token values for the found items. + The <parameter role="reference">cas_tokens</parameter> parameter was removed in v3.0 of the extension. + It was replaced with a new flag <constant>Memcached::GET_EXTENDED</constant> + that needs is to be used as the value for <paramater>flags</paramater>. </para> </note> </para> <para> The <parameter>flags</parameter> parameter can be used to specify - additional options for <function>Memcached::getMulti</function>. Currently, - the only available option is - <constant>Memcached::GET_PRESERVE_ORDER</constant> that ensures that the + additional options for <function>Memcached::getMulti</function>. + <constant>Memcached::GET_PRESERVE_ORDER</constant> ensures that the keys are returned in the same order as they were requested in. + <constant>Memcached::GET_EXTENDED</constant> ensures that the + CAS tokens will be fetched too. </para> </refsect1> - + <refsect1 role="parameters"> &reftitle.parameters; <para> @@ -54,14 +52,6 @@ </listitem> </varlistentry> <varlistentry> - <term><parameter>cas_tokens</parameter></term> - <listitem> - <para> - The variable to store the CAS tokens for the found items. - </para> - </listitem> - </varlistentry> - <varlistentry> <term><parameter>flags</parameter></term> <listitem> <para> @@ -72,7 +62,7 @@ </variablelist> </para> </refsect1> - + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> @@ -80,15 +70,53 @@ &memcached.result.getresultcode; </para> </refsect1> - + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title><function>Memcached::getMulti</function> example</title> + <title><function>Memcached::getMulti</function> example for Memcached v3</title> + <programlisting role="php"> +<![CDATA[ +<?php +// Valid for v3 of the extension + +$m = new Memcached(); +$m->addServer('localhost', 11211); + +$items = array( + 'key1' => 'value1', + 'key2' => 'value2', + 'key3' => 'value3' +); +$m->setMulti($items); +$result = $m->getMulti(array('key1', 'key3', 'badkey')); +var_dump($result); +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +array(2) { + ["key1"]=> + string(6) "value1" + ["key3"]=> + string(6) "value3" +} +]]> + </screen> + </example> + </para> + + <para> + <example> + <title><function>Memcached::getMulti</function> example for Memcached v1 and v2</title> <programlisting role="php"> <![CDATA[ <?php +// Valid for v1 and v2 of the extension + $m = new Memcached(); $m->addServer('localhost', 11211); @@ -122,12 +150,60 @@ </screen> </example> </para> + <para> <example> - <title><constant>Memcached::GET_PRESERVE_ORDER</constant> example</title> + <title><constant>Memcached::GET_PRESERVE_ORDER</constant> example for Memcached v3</title> <programlisting role="php"> <![CDATA[ <?php +// Valid for v3 of the extension + +$m = new Memcached(); +$m->addServer('localhost', 11211); + +$data = array( + 'foo' => 'foo-data', + 'bar' => 'bar-data', + 'baz' => 'baz-data', + 'lol' => 'lol-data', + 'kek' => 'kek-data', +); + +$m->setMulti($data, 3600); + +$keys = array_keys($data); +$keys[] = 'zoo'; +$got = $m->getMulti($keys, Memcached::GET_PRESERVE_ORDER); + +foreach ($got as $k => $v) { + echo "$k $vn"; +} +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +foo foo-data +bar bar-data +baz baz-data +lol lol-data +kek kek-data +zoo +]]> + </screen> + </example> + </para> + + <para> + <example> + <title><constant>Memcached::GET_PRESERVE_ORDER</constant> example for Memcached v1 and v2</title> + <programlisting role="php"> +<![CDATA[ +<?php +// Valid for v1 and v2 of the extension + $m = new Memcached(); $m->addServer('localhost', 11211); @@ -166,7 +242,31 @@ </example> </para> </refsect1> - + + + <refsect1 role="changelog"> + &reftitle.changelog; + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>3.0.0</entry> + <entry> + The <parameter role="reference">cas_tokens</parameter> parameter was removed. + The <constant>Memcached::GET_EXTENDED</constant> was added and when passed as a flag it ensures the CAS tokens to be fetched. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> @@ -177,7 +277,7 @@ </simplelist> </para> </refsect1> - + </refentry> <!-- Keep this comment at the end of the file => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=73964 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=73964 ------------------------------------------------------------------ Modified: en/reference/memcached/memcached/get.xml By: Martin Georgiev on 2017-05-15 06:11:12 =================================================================== --- en/reference/memcached/memcached/get.xml +++ en/reference/memcached/memcached/get.xml @@ -13,13 +13,13 @@ <modifier>public</modifier> <type>mixed</type><methodname>Memcached::get</methodname> <methodparam><type>string</type><parameter>key</parameter></methodparam> <methodparam choice="opt"><type>callable</type><parameter>cache_cb</parameter></methodparam> - <methodparam choice="opt"><type>float</type><parameter role="reference">cas_token</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>$flags</parameter></methodparam> </methodsynopsis> <para> <function>Memcached::get</function> returns the item that was previously stored under the <parameter>key</parameter>. If the item is found and - <parameter>cas_token</parameter> variable is provided, it will contain the - CAS token value for the item. See + for <parameter>flags</parameter> is given <constant>Memcached::GET_EXTENDED</constant>, + it will return the CAS token value for the item. See <methodname>Memcached::cas</methodname> for how to use CAS tokens. <link linkend="memcached.callbacks">Read-through caching callback</link> may be specified via <parameter>cache_cb</parameter> parameter. @@ -49,10 +49,11 @@ </listitem> </varlistentry> <varlistentry> - <term><parameter>cas_token</parameter></term> + <term><parameter>flags</parameter></term> <listitem> <para> - The variable to store the CAS token in. + Flags to control the returned result. When value of <constant>Memcached::GET_EXTENDED</constant> + is given will return the CAS token. </para> </listitem> </varlistentry> @@ -115,6 +116,29 @@ </example> </para> </refsect1> + + <refsect1 role="changelog"> + &reftitle.changelog; + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>3.0.0</entry> + <entry> + The <parameter role="reference">cas_token</parameter> parameter was removed. + Instead <parameter>flags</parameter> was added and when it is given the value of <constant>Memcached::GET_EXTENDED</constant> it will ensure the CAS token to be fetched. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </refsect1> <refsect1 role="seealso"> &reftitle.seealso; => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=73967 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=73967 ------------------------------------------------------------------ Modified: en/reference/memcached/memcached/getbykey.xml By: Martin Georgiev on 2017-05-15 06:12:43 =================================================================== --- en/reference/memcached/memcached/getbykey.xml +++ en/reference/memcached/memcached/getbykey.xml @@ -14,7 +14,7 @@ <methodparam><type>string</type><parameter>server_key</parameter></methodparam> <methodparam><type>string</type><parameter>key</parameter></methodparam> <methodparam choice="opt"><type>callable</type><parameter>cache_cb</parameter></methodparam> - <methodparam choice="opt"><type>float</type><parameter role="reference">cas_token</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> </methodsynopsis> <para> <function>Memcached::getByKey</function> is functionally equivalent to @@ -53,10 +53,11 @@ </listitem> </varlistentry> <varlistentry> - <term><parameter>cas_token</parameter></term> + <term><parameter>flags</parameter></term> <listitem> <para> - The variable to store the CAS token in. + Flags to control the returned result. When value of <constant>Memcached::GET_EXTENDED</constant> + is given will return the CAS token. </para> </listitem> </varlistentry> @@ -72,6 +73,29 @@ <constant>Memcached::RES_NOTFOUND</constant> if the key does not exist. </para> </refsect1> + + <refsect1 role="changelog"> + &reftitle.changelog; + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>3.0.0</entry> + <entry> + The <parameter role="reference">cas_token</parameter> parameter was removed. + Instead <parameter>flags</parameter> was added and when it is given the value of <constant>Memcached::GET_EXTENDED</constant> it will ensure the CAS token to be fetched. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </refsect1> <refsect1 role="seealso"> &reftitle.seealso; => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=73968 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=73968 ------------------------------------------------------------------ Modified: en/reference/memcached/memcached/getmultibykey.xml By: Martin Georgiev on 2017-05-15 06:13:33 =================================================================== --- en/reference/memcached/memcached/getmultibykey.xml +++ en/reference/memcached/memcached/getmultibykey.xml @@ -13,7 +13,6 @@ <modifier>public</modifier> <type>array</type><methodname>Memcached::getMultiByKey</methodname> <methodparam><type>string</type><parameter>server_key</parameter></methodparam> <methodparam><type>array</type><parameter>keys</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter role="reference">cas_tokens</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> </methodsynopsis> <para> @@ -45,14 +44,6 @@ </listitem> </varlistentry> <varlistentry> - <term><parameter>cas_tokens</parameter></term> - <listitem> - <para> - The variable to store the CAS tokens for the found items. - </para> - </listitem> - </varlistentry> - <varlistentry> <term><parameter>flags</parameter></term> <listitem> <para> @@ -71,6 +62,29 @@ &memcached.result.getresultcode; </para> </refsect1> + + <refsect1 role="changelog"> + &reftitle.changelog; + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>3.0.0</entry> + <entry> + The <parameter role="reference">cas_tokens</parameter> parameter was removed. + The <constant>Memcached::GET_EXTENDED</constant> was added and when passed as a flag it ensures the CAS tokens to be fetched. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </refsect1> <refsect1 role="seealso"> &reftitle.seealso; => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=73969 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=73969 ------------------------------------------------------------------ Modified: en/language/types/string.xml By: anonymous on 2017-05-15 18:08:31 =================================================================== --- en/language/types/string.xml +++ en/language/types/string.xml @@ -609,15 +609,18 @@ <programlisting role="php"> <![CDATA[ <?php -$array = [-3 => 'foo']; -echo "The element at index -3 is $array[-3].", PHP_EOL; +$string = 'string'; +echo "The character at index -2 is $string[-2].", PHP_EOL; +$string[-3] = 'o'; +echo "Changing the character at index -3 to o gives $string.", PHP_EOL; ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ -The element at index -3 is foo. +The character at index -2 is n. +Changing the character at index -3 to o gives strong. ]]> </screen> </example> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=73971 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=73971 ------------------------------------------------------------------ Modified: en/reference/imagick/book.xml By: anonymous on 2017-05-18 15:54:01 =================================================================== --- en/reference/imagick/book.xml +++ en/reference/imagick/book.xml @@ -16,7 +16,7 @@ <!-- {{{ About Imagick --> <section xml:id="imagick.aboutimagemagick"> <para> - ImageMagick is a software suite to create, edit, and compose bitmap images.. + ImageMagick is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (over 100) including DPX, EXR, GIF, JPEG, JPEG-2000, PDF, PhotoCD, PNG, Postscript, SVG, and TIFF. </para> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=73989 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=73989 ------------------------------------------------------------------ Modified: en/reference/imagick/setup.xml By: anonymous on 2017-05-18 16:02:28 =================================================================== --- en/reference/imagick/setup.xml +++ en/reference/imagick/setup.xml @@ -21,7 +21,7 @@ <title>Installation requirements on other platforms</title> <para> PHP &gt;= 5.1.3 and ImageMagick &gt;= 6.2.4 is required. The amount of - formats supported is by Imagick is entirely dependent upon the amount + file formats supported by Imagick depends entirely upon the amount of formats supported by your ImageMagick installation. For example, Imagemagick requires ghostscript to conduct PDF operations. </para> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=73990 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=73990 ------------------------------------------------------------------ Modified: en/language/generators.xml By: Jordi Domènech on 2017-06-04 16:16:35 =================================================================== --- en/language/generators.xml +++ en/language/generators.xml @@ -132,9 +132,10 @@ <note> <para> - A generator cannot return a value: doing so will result in a compile - error. An empty <command>return</command> statement is valid syntax within - a generator and it will terminate the generator. + In PHP 5, a generator could not return a value: doing so would result in a compile + error. An empty <command>return</command> statement was valid syntax within + a generator and it would terminate the generator. Since PHP 7.0, a generator can + return values, which can be retieved using <methodname>Generator::getReturn</methodname>. </para> </note> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=74114 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=74114 ------------------------------------------------------------------ -- https://edit.php.net/ This email is send automatically by the Php Docbook Online Editor.