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/apcu/constants.xml By: Walt Sorensen on 2016-10-10 09:14:09 =================================================================== --- en/reference/apcu/constants.xml +++ en/reference/apcu/constants.xml @@ -5,6 +5,21 @@ &reftitle.constants; &extension.constants; + <title>The APCu Constants</title> + <titleabbrev>APCu Constants</titleabbrev> + + <partintro> + +<!-- {{{ APCu Constants intro --> + <section xml:id="apcu.constants.intro"> + &reftitle.intro; + <para> + The APCu Constants below are the same as defined in the APC extension, and will only be available when the extension has either been compiled into PHP or dynamically loaded at runtime. + </para> + </section> +<!-- }}} --> + </partintro> + <para> <variablelist> <varlistentry xml:id="constant.apcu-iter-all"> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=69094 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=69094 ------------------------------------------------------------------ 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/imagick/imagick/getsize.xml By: Gabriel Jean on 2017-02-06 18:19:00 =================================================================== --- en/reference/imagick/imagick/getsize.xml +++ en/reference/imagick/imagick/getsize.xml @@ -13,9 +13,13 @@ <void/> </methodsynopsis> <para> - Returns the size associated with the Imagick object as an array with the - keys "columns" and "rows". + Get the size in pixels associated with the Imagick object, previously set by <function>Imagick::setSize</function>. </para> + <note> + <para> + This method just returns the size that was set using <function>Imagick::setSize</function>. If you want to get the actual width / height of the image, use <function>Imagick::getImageWidth</function> and <function>Imagick::getImageHeight</function>. + </para> + </note> </refsect1> <refsect1 role="returnvalues"> @@ -25,6 +29,43 @@ keys "columns" and "rows". </para> </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>Getting the size of a raw RGB image set at 200x400, after scaling to 400x800 (compared to width / height)</title> + <programlisting role="php"> +<![CDATA[ +<?php +//Set size first and then load the raw image +$img = new Imagick(); +$img->setSize(200, 400); +$img->readImage("image.rgb"); + +$img->scaleImage(400, 800); + +$size = $img->getSize(); +print_r($size); + +echo "$img->getImageWidth()."x".$img->getImageHeight(); +?> +]]> + </programlisting> + &example.outputs; + <screen> +<![CDATA[ +Array +( + [columns] => 200 + [rows] => 400 +) +400x800 +]]> + </screen> + </example> + </para> + </refsect1> </refentry> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=72296 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=72296 ------------------------------------------------------------------ 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/imap/functions/imap-headerinfo.xml By: Ville Hukkamäki on 2017-02-21 22:35:27 =================================================================== --- en/reference/imap/functions/imap-headerinfo.xml +++ en/reference/imap/functions/imap-headerinfo.xml @@ -63,7 +63,7 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns the information in an object with following properties: + Returns <strong>FALSE</strong> on error or, if successful, the information in an object with following properties: <itemizedlist> <listitem> <simpara> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=72448 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=72448 ------------------------------------------------------------------ Modified: en/reference/imagick/imagick/identifyimage.xml By: anonymous on 2017-03-02 01:38:08 =================================================================== --- en/reference/imagick/imagick/identifyimage.xml +++ en/reference/imagick/imagick/identifyimage.xml @@ -26,6 +26,7 @@ <term><parameter>appendRawOutput</parameter></term> <listitem> <para> + If &true; then the raw output is appended to the array. </para> </listitem> </varlistentry> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=72523 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=72523 ------------------------------------------------------------------ Modified: en/reference/json/setup.xml By: Peter Kokot on 2017-03-17 05:20:43 =================================================================== --- en/reference/json/setup.xml +++ en/reference/json/setup.xml @@ -13,7 +13,8 @@ &reftitle.install; <para> As of PHP 5.2.0, the JSON extension is bundled and compiled into PHP by - default. + default, although it may be disabled by compiling with + <option role="configure">--disable-json</option>. </para> <para> &pecl.info; => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=73012 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=73012 ------------------------------------------------------------------ Modified: en/reference/fileinfo/configure.xml By: Peter Kokot on 2017-03-17 05:44:47 =================================================================== --- en/reference/fileinfo/configure.xml +++ en/reference/fileinfo/configure.xml @@ -3,7 +3,8 @@ <section xml:id="fileinfo.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> &reftitle.install; <para> - This extension is enabled by default as of PHP 5.3.0. Before this time, + This extension is enabled by default as of PHP 5.3.0. It may be disabled + by compiling with <option role="configure">--disable-fileinfo</option>. Before this time, fileinfo was a PECL extension but is no longer maintained there. However, versions prior to 5.3+ may use the <link xlink:href="&url.pecl.package;fileinfo">discontinued PECL extension</link>. => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=73013 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=73013 ------------------------------------------------------------------ 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/appendices/ini.core.xml By: Josh Worden on 2017-03-27 12:32:01 =================================================================== --- en/appendices/ini.core.xml +++ en/appendices/ini.core.xml @@ -877,7 +877,7 @@ </term> <listitem> <para> - When enabled, the SERVER and ENV variables are created when they're + When enabled, the SERVER, REQUEST, and ENV variables are created when they're first used (Just In Time) instead of when the script starts. If these variables are not used within a script, having this directive on will result in a performance gain. @@ -891,9 +891,12 @@ 5.1.3 it is not necessary to have <link linkend="ini.register-argc-argv">register_argc_argv</link> disabled. </para> + <para> + The REQUEST variable behavior was changed to JIT in PHP 5.4.0. + </para> <warning> <para> - Usage of SERVER and ENV variables is checked during the compile time + Usage of SERVER, REQUEST, and ENV variables is checked during the compile time so using them through e.g. <link linkend="language.variables.variable">variable variables</link> will not cause their initialization. => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=73117 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=73117 ------------------------------------------------------------------ -- https://edit.php.net/ This email is send automatically by the Php Docbook Online Editor.