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/install/unix/nginx.xml By: yangbai on 2018-06-08 02:34:57 =================================================================== --- en/install/unix/nginx.xml +++ en/install/unix/nginx.xml @@ -82,7 +82,7 @@ <screen> <![CDATA[ cp php.ini-development /usr/local/php/php.ini -cp /usr/local/etc/php-fpm.conf.default /usr/local/etc/php-fpm.conf +cp /usr/local/etc/php-fpm.d/www.conf.default /usr/local/etc/php-fpm.d/www.conf cp sapi/fpm/php-fpm /usr/local/bin ]]> </screen> @@ -134,7 +134,7 @@ <informalexample xml:id="install.unix.nginx.modify.phpfpm"> <screen> <![CDATA[ -vim /usr/local/etc/php-fpm.conf +vim /usr/local/etc/php-fpm.d/www.conf ]]> </screen> </informalexample> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=83720 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=83720 ------------------------------------------------------------------ Modified: en/reference/memcached/ini.xml By: Julien Boulen on 2018-08-23 06:08:26 =================================================================== --- en/reference/memcached/ini.xml +++ en/reference/memcached/ini.xml @@ -1,5 +1,6 @@ <?xml version="1.0" encoding="utf-8"?> -<!-- $Revision: 330930 $ --> +<!-- $Revision: 330931 $ --> +<!-- Reviewed: No --> <section xml:id="memcached.configuration" xmlns="http://docbook.org/ns/docbook"> &reftitle.runtime; @@ -23,76 +24,179 @@ <entry>PHP_INI_ALL</entry> <entry><!-- leave empty, this will be filled by an automatic script --></entry> </row> + <row> - <entry><link linkend="ini.memcached.sess-consistent-hash">memcached.sess_consistent_hash</link></entry> - <entry>0</entry> + <entry><link linkend="ini.memcached.sess-lock-wait-min">memcached.sess_lock_wait_min</link></entry> + <entry>150</entry> <entry>PHP_INI_ALL</entry> <entry><!-- leave empty, this will be filled by an automatic script --></entry> </row> + <row> - <entry><link linkend="ini.memcached.sess-binary">memcached.sess_binary</link></entry> - <entry>0</entry> + <entry><link linkend="ini.memcached.sess-lock-wait-max">memcached.sess_lock_wait_max</link></entry> + <entry>150</entry> <entry>PHP_INI_ALL</entry> <entry><!-- leave empty, this will be filled by an automatic script --></entry> </row> + + <row> + <entry><link linkend="ini.memcached.sess-lock-retries">memcached.sess_lock_retries</link></entry> + <entry>200</entry> + <entry>PHP_INI_ALL</entry> + <entry><!-- leave empty, this will be filled by an automatic script --></entry> + </row> + <row> - <entry><link linkend="ini.memcached.sess-lock-wait">memcached.sess_lock_wait</link></entry> - <entry>150000</entry> + <entry><link linkend="ini.memcached.sess-lock-expire">memcached.sess_lock_expire</link></entry> + <entry>0</entry> <entry>PHP_INI_ALL</entry> <entry><!-- leave empty, this will be filled by an automatic script --></entry> </row> + <row> <entry><link linkend="ini.memcached.sess-prefix">memcached.sess_prefix</link></entry> <entry>memc.sess.key.</entry> <entry>PHP_INI_ALL</entry> <entry><!-- leave empty, this will be filled by an automatic script --></entry> </row> + + <row> + <entry><link linkend="ini.memcached.sess-persistent">memcached.sess_persistent</link></entry> + <entry>Off</entry> + <entry>PHP_INI_ALL</entry> + <entry><!-- leave empty, this will be filled by an automatic script --></entry> + </row> + + <row> + <entry><link linkend="ini.memcached.sess-consistent-hash">memcached.sess_consistent_hash</link></entry> + <entry>On</entry> + <entry>PHP_INI_ALL</entry> + <entry><!-- leave empty, this will be filled by an automatic script --></entry> + </row> + + <row> + <entry><link linkend="ini.memcached.sess-consistent-hash-type">memcached.sess_consistent_hash_type</link></entry> + <entry>ketama</entry> + <entry>PHP_INI_ALL</entry> + <entry><!-- leave empty, this will be filled by an automatic script --></entry> + </row> + + <row> + <entry><link linkend="ini.memcached.sess-remove-failed-servers">memcached.sess_remove_failed_servers</link></entry> + <entry>Off</entry> + <entry>PHP_INI_ALL</entry> + <entry><!-- leave empty, this will be filled by an automatic script --></entry> + </row> + + <row> + <entry><link linkend="ini.memcached.sess-server-failure-limit">memcached.sess_server_failure_limit</link></entry> + <entry>0</entry> + <entry>PHP_INI_ALL</entry> + <entry><!-- leave empty, this will be filled by an automatic script --></entry> + </row> + <row> <entry><link linkend="ini.memcached.sess-number-of-replicas">memcached.sess_number_of_replicas</link></entry> <entry>0</entry> <entry>PHP_INI_ALL</entry> <entry><!-- leave empty, this will be filled by an automatic script --></entry> </row> + + <row> + <entry><link linkend="ini.memcached.sess-binary-protocol">memcached.sess_binary_protocol</link></entry> + <entry>On</entry> + <entry>PHP_INI_ALL</entry> + <entry><!-- leave empty, this will be filled by an automatic script --></entry> + </row> + <row> <entry><link linkend="ini.memcached.sess-randomize-replica-read">memcached.sess_randomize_replica_read</link></entry> - <entry>0</entry> + <entry>Off</entry> <entry>PHP_INI_ALL</entry> <entry><!-- leave empty, this will be filled by an automatic script --></entry> </row> + + <row> + <entry><link linkend="ini.memcached.sess-connect-timeout">memcached.sess_connect_timeout</link></entry> + <entry>1000</entry> + <entry>PHP_INI_ALL</entry> + <entry><!-- leave empty, this will be filled by an automatic script --></entry> + </row> + + <row> + <entry><link linkend="ini.memcached.sess-sasl-username">memcached.sess_sasl_username</link></entry> + <entry>null</entry> + <entry>PHP_INI_ALL</entry> + <entry><!-- leave empty, this will be filled by an automatic script --></entry> + </row> + + <row> + <entry><link linkend="ini.memcached.sess-sasl-password">memcached.sess_sasl_password</link></entry> + <entry>null</entry> + <entry>PHP_INI_ALL</entry> + <entry><!-- leave empty, this will be filled by an automatic script --></entry> + </row> + <row> <entry><link linkend="ini.memcached.sess-remove-failed">memcached.sess_remove_failed</link></entry> <entry>0</entry> <entry>PHP_INI_ALL</entry> <entry><!-- leave empty, this will be filled by an automatic script --></entry> </row> + <row> <entry><link linkend="ini.memcached.compression-type">memcached.compression_type</link></entry> <entry>fastlz</entry> <entry>PHP_INI_ALL</entry> <entry><!-- leave empty, this will be filled by an automatic script --></entry> </row> + <row> <entry><link linkend="ini.memcached.compression-factor">memcached.compression_factor</link></entry> <entry>1.3</entry> <entry>PHP_INI_ALL</entry> <entry><!-- leave empty, this will be filled by an automatic script --></entry> </row> + <row> <entry><link linkend="ini.memcached.compression-threshold">memcached.compression_threshold</link></entry> <entry>2000</entry> <entry>PHP_INI_ALL</entry> <entry><!-- leave empty, this will be filled by an automatic script --></entry> </row> + <row> <entry><link linkend="ini.memcached.serializer">memcached.serializer</link></entry> - <entry>php</entry> + <entry>igbinary</entry> <entry>PHP_INI_ALL</entry> <entry><!-- leave empty, this will be filled by an automatic script --></entry> </row> + <row> - <entry><link linkend="ini.memcached.use-sasl">memcached.use_sasl</link></entry> + <entry><link linkend="ini.memcached.store-retry-count">memcached.store_retry_count</link></entry> + <entry>2</entry> + <entry>PHP_INI_ALL</entry> + <entry><!-- leave empty, this will be filled by an automatic script --></entry> + </row> + + <row> + <entry><link linkend="ini.memcached.default-consistent-hash">memcached.default_consistent_hash</link></entry> + <entry>Off</entry> + <entry>PHP_INI_ALL</entry> + <entry><!-- leave empty, this will be filled by an automatic script --></entry> + </row> + + <row> + <entry><link linkend="ini.memcached.default-binary-protocol">memcached.default_binary_protocol</link></entry> + <entry>Off</entry> + <entry>PHP_INI_ALL</entry> + <entry><!-- leave empty, this will be filled by an automatic script --></entry> + </row> + + <row> + <entry><link linkend="ini.memcached.default-connect-timeout">memcached.default_connect_timeout</link></entry> <entry>0</entry> - <entry>PHP_INI_SYSTEM</entry> + <entry>PHP_INI_ALL</entry> <entry><!-- leave empty, this will be filled by an automatic script --></entry> </row> </tbody> @@ -104,217 +208,360 @@ <para> <variablelist> - <varlistentry xml:id="ini.memcached.sess-locking"> - <term> - <parameter>memcached.sess_locking</parameter> - <type>integer</type> - </term> - <listitem> - <para> - Use session locking. Valid values: On, Off, the default is On. - </para> - </listitem> - </varlistentry> - - <varlistentry xml:id="ini.memcached.sess-consistent-hash"> - <term> - <parameter>memcached.sess_consistent_hash</parameter> - <type>integer</type> - </term> - <listitem> - <para> - Memcached session consistent hash mode. If set to On, consistent - hashing is used for session handling. When consistent hashing is used, - one can add or remove cache node(s) without messing up too much with - existing keys. The default is Off. - </para> - </listitem> - </varlistentry> - - <varlistentry xml:id="ini.memcached.sess-binary"> - <term> - <parameter>memcached.sess_binary</parameter> - <type>integer</type> - </term> - <listitem> - <para> - Use memcached session binary mode. Libmemcached replicas only work if - binary mode is enabled. The default is Off. - </para> - </listitem> - </varlistentry> - - <varlistentry xml:id="ini.memcached.sess-lock-wait"> - <term> - <parameter>memcached.sess_lock_wait</parameter> - <type>integer</type> - </term> - <listitem> - <para> - Session spin lock retry wait time in microseconds. Be carefull when - setting this value. Valid values are integers, where 0 is interpreted - as the default value. Negative values result in a reduces locking to a - try lock. The default is 150000. - </para> - </listitem> - </varlistentry> - - <varlistentry xml:id="ini.memcached.sess-prefix"> - <term> - <parameter>memcached.sess_prefix</parameter> - <type>string</type> - </term> - <listitem> - <para> - Memcached session key prefix. Valid values are strings less than 219 - bytes long. The default value is "memc.sess.key." - </para> - </listitem> - </varlistentry> - - <varlistentry xml:id="ini.memcached.sess-number-of-replicas"> - <term> - <parameter>memcached.sess_number_of_replicas</parameter> - <type>integer</type> - </term> - <listitem> - <para> - The memcached session number of replicas. - </para> - </listitem> - </varlistentry> - - <varlistentry xml:id="ini.memcached.sess-randomize-replica-read"> - <term> - <parameter>memcached.sess_randomize_replica_read</parameter> - <type>integer</type> - </term> - <listitem> - <para> - Memcached session replica read randomize. - </para> - </listitem> - </varlistentry> - - <varlistentry xml:id="ini.memcached.sess-remove-failed"> - <term> - <parameter>memcached.sess_remove_failed</parameter> - <type>integer</type> - </term> - <listitem> - <para> - Allow failed memcached server to automatically be removed. - </para> - </listitem> - </varlistentry> - - <varlistentry xml:id="ini.memcached.compression-type"> - <term> - <parameter>memcached.compression_type</parameter> - <type>string</type> - </term> - <listitem> - <para> - Set the compression type, valid values are: fastlz, zlib. The default - is fastlz. - </para> - </listitem> - </varlistentry> - - <varlistentry xml:id="ini.memcached.compression-factor"> - <term> - <parameter>memcached.compression_factor</parameter> - <type>float</type> - </term> - <listitem> - <para> - Compression factor. Store compressed value only if the compression - factor (saving) exceeds the set limit. Store compressed if: - <literal>plain_len &gt; comp_len * factor</literal>. The default value - is 1.3 (23% space saving). - </para> - </listitem> - </varlistentry> - - <varlistentry xml:id="ini.memcached.compression-threshold"> - <term> - <parameter>memcached.compression_threshold</parameter> - <type>integer</type> - </term> - <listitem> - <para> - The compression threshold. Do not compress serialized values below this - threshold. The default is 2000 bytes. - </para> - </listitem> - </varlistentry> - - <varlistentry xml:id="ini.memcached.serializer"> - <term> - <parameter>memcached.serializer</parameter> - <type>string</type> - </term> - <listitem> - <para> - Set the default serializer for new memcached objects. Valid values - are: php, igbinary, json, json_array. - </para> - <variablelist> - <varlistentry> - <term>json</term> - <listitem> - <para> - Standard php JSON encoding. This serializer is fast and compact but - only works on UTF-8 encoded data and does not fully implement - serializing. See the JSON extension. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>json_array</term> - <listitem> - <para> - As json, but decodes into arrays. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>php</term> - <listitem> - <para> - The standard PHP serializer. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>igbinary</term> - <listitem> - <para> - A binary serializer - </para> - </listitem> - </varlistentry> - </variablelist> - <para> - The default is igbinary if available and php otherwise. - </para> - </listitem> - </varlistentry> - - <varlistentry xml:id="ini.memcached.use-sasl"> - <term> - <parameter>memcached.use_sasl</parameter> - <type>integer</type> - </term> - <listitem> - <para> - Use SASL authentication for connections. Valid values: On, Off. The - default is Off. - </para> - </listitem> - </varlistentry> - + <term> + <parameter>memcached.sess_locking</parameter> + <type>integer</type> + </term> + <listitem> + <para> + Use session locking. Valid values: On, Off, the default is On. + </para> + </listitem> + </varlistentry> + + <varlistentry xml:id="ini.memcached.sess-lock-wait-min"> + <term> + <parameter>memcached.sess_lock_wait_min</parameter> + <type>integer</type> + </term> + <listitem> + <para> + The minimum time, in milliseconds, to wait between session lock attempts. This value is double on each lock retry until memcached.sess_lock_wait_max is reached, after which any further retries will take sess_lock_wait_max seconds. The default is 150. + </para> + </listitem> + </varlistentry> + + <varlistentry xml:id="ini.memcached.sess-lock-wait-max"> + <term> + <parameter>memcached.sess_lock_wait_max</parameter> + <type>integer</type> + </term> + <listitem> + <para> + The maximum time, in milliseconds, to wait between session lock attempts. The default is 150. + </para> + </listitem> + </varlistentry> + + <varlistentry xml:id="ini.memcached.sess-lock-retries"> + <term> + <parameter>memcached.sess_lock_retries</parameter> + <type>integer</type> + </term> + <listitem> + <para> + The number of times to retry locking the session lock, not including the first attempt. Default is 200. + </para> + </listitem> + </varlistentry> + + <varlistentry xml:id="ini.memcached.sess-lock-expire"> + <term> + <parameter>memcached.sess_lock_retries</parameter> + <type>integer</type> + </term> + <listitem> + <para> + The time, in seconds, before a lock should release itself. Setting to 0 results in the default behaviour, which is to use PHP's max_execution_time. Default is 0. + </para> + </listitem> + </varlistentry> + + <varlistentry xml:id="ini.memcached.sess-prefix"> + <term> + <parameter>memcached.sess_prefix</parameter> + <type>string</type> + </term> + <listitem> + <para> + Memcached session key prefix. Valid values are strings less than 219 + bytes long. The default value is "memc.sess.key." + </para> + </listitem> + </varlistentry> + + <varlistentry xml:id="ini.memcached.sess-persistent"> + <term> + <parameter>memcached.sess_persistent</parameter> + <type>integer</type> + </term> + <listitem> + <para> + Whether or not to re-use the memcached connections corresponding to the value(s) of session.save_path after the execution of the script ends. Don't use this if certain settings (e.g. SASL settings, sess_binary_protocol) would be overridden between requests. Default is Off. + </para> + </listitem> + </varlistentry> + + <varlistentry xml:id="ini.memcached.sess-consistent-hash"> + <term> + <parameter>memcached.sess_consistent_hash</parameter> + <type>integer</type> + </term> + <listitem> + <para> + If set to On, consistent hashing (libketama) is used for session handling. When consistent hashing is used, one can add or remove cache node(s) without messing up too much with existing keys. Default is On. + </para> + </listitem> + </varlistentry> + + <varlistentry xml:id="ini.memcached.sess-consistent-hash-type"> + <term> + <parameter>memcached.sess_consistent_hash_type</parameter> + <type>string</type> + </term> + <listitem> + <para> + Memcached session consistent hash type if set to 'ketama', consistent hashing (libketama) is used for session handling (default for php-memcached 3.x) if set to 'ketama_weighted', weighted consistent hashing (libketama) is used for session handling (default for php-memcached 2.x). Default is "ketama". + </para> + </listitem> + </varlistentry> + + <varlistentry xml:id="ini.memcached.sess-remove-failed-servers"> + <term> + <parameter>memcached.sess_remove_failed_servers</parameter> + <type>integer</type> + </term> + <listitem> + <para> + Allow failed memcached server to automatically be removed. Default is Off. (In previous versions, this setting was called memcached.sess_remove_failed). + </para> + </listitem> + </varlistentry> + + <varlistentry xml:id="ini.memcached.sess-server-failure-limit"> + <term> + <parameter>memcached.sess_server_failure_limit</parameter> + <type>integer</type> + </term> + <listitem> + <para> + Set this value to enable the server be removed after configured number of continuous times connection failure. Default is 0. + </para> + </listitem> + </varlistentry> + + <varlistentry xml:id="ini.memcached.sess-number-of-replicas"> + <term> + <parameter>memcached.sess_number_of_replicas</parameter> + <type>integer</type> + </term> + <listitem> + <para> + Write data to a number of additional memcached servers. This is "poor man's HA" as libmemcached calls it. If this value is positive and sess_remove_failed is enabled when a memcached server fails the session will continue to be available from a replica. However, if the failed memcache server becomes available again it will read the session from there which could have old data or no data at all. Default is 0. + </para> + </listitem> + </varlistentry> + + <varlistentry xml:id="ini.memcached.sess-binary-protocol"> + <term> + <parameter>memcached.sess_binary_protocol</parameter> + <type>integer</type> + </term> + <listitem> + <para> + Use the memcached binary protocol for memcached sessions (Instead of the text protocol) libmemcached replicas work only if binary mode is enabled. However, certain proxies (such as twemproxy) will work only if the binary protocol is disabled. In older versions of php-memcached, this setting was Off and was called memcached.sess_binary. Default is On with libmemcached 1.0.18 or newer. Default is Off with older version. + </para> + </listitem> + </varlistentry> + + <varlistentry xml:id="ini.memcached.sess-randomize-replica-read"> + <term> + <parameter>memcached.sess_randomize_replica_read</parameter> + <type>integer</type> + </term> + <listitem> + <para> + Memcached session replica read randomize. + </para> + </listitem> + </varlistentry> + + <varlistentry xml:id="ini.memcached.sess-connect-timeout"> + <term> + <parameter>memcached.sess_connect_timeout</parameter> + <type>integer</type> + </term> + <listitem> + <para> + memcached connect timeout value + In non-blocking mode this changes the value of the timeout during socket connection in milliseconds. Specifying -1 means an infinite timeout. + </para> + </listitem> + </varlistentry> + + <varlistentry xml:id="ini.memcached.sess-sasl-username"> + <term> + <parameter>memcached.sess_sasl_username</parameter> + <type>string</type> + </term> + <listitem> + <para> + Session SASL username + Both username and password need to be set for SASL to be enabled In addition to this memcached.use_sasl needs to be on + </para> + </listitem> + </varlistentry> + + <varlistentry xml:id="ini.memcached.sess-sasl-password"> + <term> + <parameter>memcached.sess_sasl_password</parameter> + <type>string</type> + </term> + <listitem> + <para> + Session SASL password + </para> + </listitem> + </varlistentry> + + <varlistentry xml:id="ini.memcached.compression-type"> + <term> + <parameter>memcached.compression_type</parameter> + <type>string</type> + </term> + <listitem> + <para> + Set the compression type, valid values are: fastlz, zlib. The default + is fastlz. + </para> + </listitem> + </varlistentry> + + <varlistentry xml:id="ini.memcached.compression-factor"> + <term> + <parameter>memcached.compression_factor</parameter> + <type>float</type> + </term> + <listitem> + <para> + Compression factor. Store compressed value only if the compression + factor (saving) exceeds the set limit. Store compressed if: + <literal>plain_len &gt; comp_len * factor</literal>. The default value + is 1.3 (23% space saving). + </para> + </listitem> + </varlistentry> + + <varlistentry xml:id="ini.memcached.compression-threshold"> + <term> + <parameter>memcached.compression_threshold</parameter> + <type>integer</type> + </term> + <listitem> + <para> + The compression threshold. Do not compress serialized values below this + threshold. The default is 2000 bytes. + </para> + </listitem> + </varlistentry> + + <varlistentry xml:id="ini.memcached.serializer"> + <term> + <parameter>memcached.serializer</parameter> + <type>string</type> + </term> + <listitem> + <para> + Set the default serializer for new memcached objects. Valid values + are: php, igbinary, json, json_array. + </para> + <variablelist> + <varlistentry> + <term>json</term> + <listitem> + <para> + Standard php JSON encoding. This serializer is fast and compact but + only works on UTF-8 encoded data and does not fully implement + serializing. See the JSON extension. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>json_array</term> + <listitem> + <para> + As json, but decodes into arrays. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>php</term> + <listitem> + <para> + The standard PHP serializer. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>igbinary</term> + <listitem> + <para> + A binary serializer + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + The default is igbinary if available and php otherwise. + </para> + </listitem> + </varlistentry> + + <varlistentry xml:id="ini.memcached.store-retry-count"> + <term> + <parameter>memcached.store_retry_count</parameter> + <type>integer</type> + </term> + <listitem> + <para> + The amount of retries for failed store commands. + This mechanism allows transparent fail-over to secondary servers when set/increment/decrement/setMulti operations fail on the desired server in a multi-server environment. the default is 2 + </para> + </listitem> + </varlistentry> + + <varlistentry xml:id="ini.memcached.default-consistent-hash"> + <term> + <parameter>memcached.default_consistent_hash</parameter> + <type>integer</type> + </term> + <listitem> + <para> + Sets the default for consistent hashing for new connections. (To configure consistent hashing for session connections, use memcached.sess_consistent_hash instead) + + If set to On, consistent hashing (libketama) is used for session handling. When consistent hashing is used, one can add or remove cache node(s) without messing up too much with existing keys default is Off + </para> + </listitem> + </varlistentry> + + <varlistentry xml:id="ini.memcached.default-binary-protocol"> + <term> + <parameter>memcached.default_binary_protocol</parameter> + <type>integer</type> + </term> + <listitem> + <para> + Sets the default memcached protocol for new connections. (To configure the memcached protocol for connections used by sessions, use memcached.sess_binary_protocol instead) + + If set to On, the memcached binary protocol is used by default. If set to Off, the memcached text protocol is used. Default is Off + </para> + </listitem> + </varlistentry> + + <varlistentry xml:id="ini.memcached.default-connect-timeout"> + <term> + <parameter>memcached.default_connect_timeout</parameter> + <type>integer</type> + </term> + <listitem> + <para> + Sets the default memcached connection timeout for new connections. (To configure the memcached connection timeout for sessions, use memcached.sess_connect_timeout instead) + + In non-blocking mode this changes the value of the timeout. during socket connection in milliseconds. Specifying -1 means an infinite timeout. Specifying 0 means using the memcached library's default connection timeout. Default is 0. + </para> + </listitem> + </varlistentry> </variablelist> </para> </section> @@ -338,4 +585,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 ---> +--> No newline at end of file => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=85064 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=85064 ------------------------------------------------------------------ Modified: en/reference/sodium/functions/sodium-crypto-pwhash.xml By: Marcus Bointon on 2018-08-24 12:38:07 =================================================================== --- en/reference/sodium/functions/sodium-crypto-pwhash.xml +++ en/reference/sodium/functions/sodium-crypto-pwhash.xml @@ -19,11 +19,8 @@ <methodparam choice="opt"><type>int</type><parameter>alg</parameter></methodparam> </methodsynopsis> <para> - + This function provides low-level access to libsodium's crypto_pwhash key derivation function. Unless you have specific reason to use this function, you should use <function>sodium_crypto_pwhash_str</function> or <function>password_hash</function> functions instead. </para> - - &warn.undocumented.func; - </refsect1> <refsect1 role="parameters"> @@ -65,7 +62,7 @@ <term><parameter>memlimit</parameter></term> <listitem> <para> - The maximum amount of RAM that the function will use, in bytes. There are constants to help you choose an appropriate value, in order of size: <constant>SODIUM_CRYPTO_PWHASH_MEMLIMIT_INTERACTIVE</constant>, <constant>SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE</constant>, and <constant>SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE</constant>. Typically these should be paired with the matching opslimit values. + The maximum amount of RAM that the function will use, in bytes. There are constants to help you choose an appropriate value, in order of size: <constant>SODIUM_CRYPTO_PWHASH_MEMLIMIT_INTERACTIVE</constant>, <constant>SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE</constant>, and <constant>SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE</constant>. Typically these should be paired with the matching <parameter>opslimit</parameter> values. </para> </listitem> </varlistentry> @@ -73,7 +70,7 @@ <term><parameter>alg</parameter></term> <listitem> <para> - <type>integer</type> A number indicating the hash algorithm to use. By default <constant>SODIUM_CRYPTO_PWHASH_ALG_DEFAULT</constant> (the currently recommended algorithm, which can change from one version of libsodium to another), or explicitly using <constant>SODIUM_CRYPTO_PWHASH_ALG_ARGON2I13</constant>, representing the Argon2id algorithm version 1.3. + <type>integer</type> A number indicating the hash algorithm to use. By default <constant>SODIUM_CRYPTO_PWHASH_ALG_DEFAULT</constant> (the currently recommended algorithm, which can change from one version of libsodium to another), or explicitly using <constant>SODIUM_CRYPTO_PWHASH_ALG_ARGON2ID13</constant>, representing the Argon2id algorithm version 1.3. </para> </listitem> </varlistentry> @@ -83,31 +80,42 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns the hashed password, &return.falseforfailure;. - </para> - <para> - The used algorithm, opslimit, memlimit and salt are embedded within the hash, so - all information needed to verify the hash is included. This allows - the <function>password_verify</function> function to verify the hash without - needing separate storage for the salt or algorithm information. + Returns the derived key, &return.falseforfailure;. The return value is a binary string of the hash, not an ASCII-encoded representation, and does not contain additional information about the parameters used to create the hash, so you will need to keep that information if you are ever going to verify the password in future. Use <function>sodium_crypto_pwhash_str</function> to avoid needing to do all that. </para> </refsect1> - - <refsect1 role="notes"> - &reftitle.notes; - <note> - <para> - It is recommended that you test this function on your servers, and adjust the <parameter>opslimit</parameter> and <parameter>memlimit</parameter> parameters - so that execution of the function takes less than 100 milliseconds on interactive systems, and also verify that it fits with your PHP memory_limit setting. - The constants will help you choose good limits for your hardware. - </para> - <para> - In order to produce the same password hash from the same password, the same algorithm, the same salt, and the same values for <parameter>opslimit</parameter> and <parameter>memlimit</parameter> must to be used. Therefore, these parameters must be stored for each user, or be used consistently for your whole application. - </para> - </note> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>password_hash</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +//Need to keep the salt if we're ever going to be able to check this password +$salt = random_bytes(SODIUM_CRYPTO_PWHASH_SALTBYTES); +//Using bin2hex to keep output readable +echo bin2hex( + sodium_crypto_pwhash( + 16, // == 128 bits + 'password', + $salt, + SODIUM_CRYPTO_PWHASH_OPSLIMIT_INTERACTIVE, + SODIUM_CRYPTO_PWHASH_MEMLIMIT_INTERACTIVE, + SODIUM_CRYPTO_PWHASH_ALG_ARGON2ID13 + ) +); +?>]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +a18f346ba57992eb7e4ae6abf3fd30ee +]]> + </screen> + </example> + </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=85055 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=85055 ------------------------------------------------------------------ Modified: en/reference/sodium/functions/sodium-crypto-pwhash-str.xml By: Marcus Bointon on 2018-08-24 13:12:57 =================================================================== --- en/reference/sodium/functions/sodium-crypto-pwhash-str.xml +++ en/reference/sodium/functions/sodium-crypto-pwhash-str.xml @@ -4,7 +4,7 @@ <refentry xml:id="function.sodium-crypto-pwhash-str" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>sodium_crypto_pwhash_str</refname> - <refpurpose>Get an ASCII encoded hash</refpurpose> + <refpurpose>Get an ASCII-encoded hash</refpurpose> </refnamediv> <refsect1 role="description"> @@ -16,11 +16,8 @@ <methodparam><type>int</type><parameter>memlimit</parameter></methodparam> </methodsynopsis> <para> - +Uses a CPU- and memory-hard hash algorithm along with a randomly-generated salt, and memory and CPU limits to generate an ASCII-encoded hash suitable for password storage. </para> - - &warn.undocumented.func; - </refsect1> <refsect1 role="parameters"> @@ -30,7 +27,7 @@ <term><parameter>password</parameter></term> <listitem> <para> - + <type>string</type>; The password to generate a hash for. </para> </listitem> </varlistentry> @@ -38,7 +35,7 @@ <term><parameter>opslimit</parameter></term> <listitem> <para> - + Represents a maximum amount of computations to perform. Raising this number will make the function require more CPU cycles to compute a key. There are constants available to set the operations limit to appropriate values depending on intended use, in order of strength: <constant>SODIUM_CRYPTO_PWHASH_OPSLIMIT_INTERACTIVE</constant>, <constant>SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE</constant> and <constant>SODIUM_CRYPTO_PWHASH_OPSLIMIT_SENSITIVE</constant>. </para> </listitem> </varlistentry> @@ -46,7 +43,7 @@ <term><parameter>memlimit</parameter></term> <listitem> <para> - + The maximum amount of RAM that the function will use, in bytes. There are constants to help you choose an appropriate value, in order of size: <constant>SODIUM_CRYPTO_PWHASH_MEMLIMIT_INTERACTIVE</constant>, <constant>SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE</constant>, and <constant>SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE</constant>. Typically these should be paired with the matching opslimit values. </para> </listitem> </varlistentry> @@ -56,7 +53,61 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - + Returns the hashed password, &return.falseforfailure;. + </para> + <para> + In order to produce the same password hash from the same password, the same values for <parameter>opslimit</parameter> and <parameter>memlimit</parameter> must be used. These are embedded within the generated hash, so + everything that's needed to verify the hash is included. This allows + the <function>sodium_crypto_pwhash_str_verify</function> function to verify the hash without + needing separate storage for the other parameters. + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + Hashes are calculated using the Argon2ID algorithm, providing resistance to both GPU and side-channel attacks. In contrast to the <function>password_hash</function> function, there is no salt parameter (a salt is generated automatically), and the <parameter>opslimit</parameter> and <parameter>memlimit</parameter> parameters are not optional. + </para> + </note> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>password_hash</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +$password = 'password'; +echo sodium_crypto_pwhash_str( + $password, + SODIUM_CRYPTO_PWHASH_OPSLIMIT_INTERACTIVE, + SODIUM_CRYPTO_PWHASH_MEMLIMIT_INTERACTIVE +); +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +$argon2id$v=19$m=65536,t=2,p=1$oWIfdaXwWwhVmovOBc2NAQ$EbsZ+JnZyyavkafS0hoc4HdaOB0ILWZESAZ7kVGa+Iw +]]> + </screen> + </example> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>sodium_crypto_pwhash_str_verify</function></member> + <member><function>sodium_crypto_pwhash</function></member> + <member><function>password_hash</function></member> + <member><function>password_verify</function></member> + <member><link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://download.libsodium.org/doc/password_hashing/the_argon2i_function.html">Libsodium Argon2 docs</link></member> + </simplelist> </para> </refsect1> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=85054 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=85054 ------------------------------------------------------------------ Modified: en/reference/sodium/functions/sodium-crypto-pwhash-str-verify.xml By: Marcus Bointon on 2018-08-24 13:14:53 =================================================================== --- en/reference/sodium/functions/sodium-crypto-pwhash-str-verify.xml +++ en/reference/sodium/functions/sodium-crypto-pwhash-str-verify.xml @@ -4,7 +4,7 @@ <refentry xml:id="function.sodium-crypto-pwhash-str-verify" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>sodium_crypto_pwhash_str_verify</refname> - <refpurpose>Verify that hash is a valid password verification string</refpurpose> + <refpurpose>Verifies that a password matches a hash</refpurpose> </refnamediv> <refsect1 role="description"> @@ -15,10 +15,9 @@ <methodparam><type>string</type><parameter>password</parameter></methodparam> </methodsynopsis> <para> - + Checks that a password hash created using <function>sodium_crypto_pwhash_str</function> matches a given plain-text password. Note that the parameters are in the opposite order to the same parameters in the similar <function>password_hash</function> function. </para> - &warn.undocumented.func; </refsect1> @@ -29,7 +28,7 @@ <term><parameter>hash</parameter></term> <listitem> <para> - + &password.parameter.hash; </para> </listitem> </varlistentry> @@ -37,7 +36,7 @@ <term><parameter>password</parameter></term> <listitem> <para> - + &password.parameter.password; </para> </listitem> </varlistentry> @@ -47,10 +46,29 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - + Returns &true; if the password and hash match, or &false; otherwise. </para> </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + Hashes are calculated using the Argon2ID algorithm, providing resistance to both GPU and side-channel attacks. + </para> + </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>sodium_crypto_pwhash_str</function></member> + <member><function>password_hash</function></member> + <member><function>password_verify</function></member> + </simplelist> + </para> + </refsect1> </refentry> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=85058 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=85058 ------------------------------------------------------------------ Modified: en/reference/sodium/functions/sodium-crypto-sign-verify-detached.xml By: Craig Francis on 2018-08-26 12:43:21 =================================================================== --- en/reference/sodium/functions/sodium-crypto-sign-verify-detached.xml +++ en/reference/sodium/functions/sodium-crypto-sign-verify-detached.xml @@ -13,7 +13,7 @@ <type>bool</type><methodname>sodium_crypto_sign_verify_detached</methodname> <methodparam><type>string</type><parameter>signature</parameter></methodparam> <methodparam><type>string</type><parameter>msg</parameter></methodparam> - <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>string</type><parameter>public_key</parameter></methodparam> </methodsynopsis> <para> @@ -43,7 +43,7 @@ </listitem> </varlistentry> <varlistentry> - <term><parameter>key</parameter></term> + <term><parameter>public_key</parameter></term> <listitem> <para> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=85091 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=85091 ------------------------------------------------------------------ Modified: en/reference/ldap/functions/ldap-connect.xml By: heiglandreas on 2018-11-21 10:03:14 =================================================================== --- en/reference/ldap/functions/ldap-connect.xml +++ en/reference/ldap/functions/ldap-connect.xml @@ -31,11 +31,10 @@ <para> <variablelist> <varlistentry> - <term><parameter>host</parameter></term> + <term><parameter>LDAP-URI</parameter></term> <listitem> <para> - This field supports using a hostname or, with OpenLDAP 2.x.x and - later, a full LDAP URI of the form <literal>ldap://hostname:port</literal> + A full LDAP URI of the form <literal>ldap://hostname:port</literal> or <literal>ldaps://hostname:port</literal> for SSL encryption. </para> <para> @@ -44,34 +43,28 @@ <para> Note that <literal>hostname:port</literal> is not a supported LDAP URI as the schema is missing. </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>port</parameter></term> - <listitem> - <para> - The port to connect to. Not used when using LDAP URIs. - </para> + <para>For backwards compatibility this field supports using a single hostname or IP-address</para> </listitem> </varlistentry> </variablelist> </para> + <para>Note that this function also still supports passing a host (or IP) and a port as 2 separate parameters. This is merely for backwards compatibility and is considered deprecated and should not be used anymore!</para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns a positive LDAP link identifier when the provided hostname/port combination or LDAP URI - seems plausible. It's a syntactic check of the provided parameters but the server(s) will not + Returns a positive LDAP link identifier when the provided LDAP URI + seems plausible. It's a syntactic check of the provided parameter but the server(s) will not be contacted! If the syntactic check fails it returns &false;. - When OpenLDAP 2.x.x is used, <function>ldap_connect</function> will always + <function>ldap_connect</function> will otherwise return a <type>resource</type> as it does not actually connect but just initializes the connecting parameters. The actual connect happens with the next calls to ldap_* funcs, usually with <function>ldap_bind</function>. </para> <para> - If no arguments are specified then the link identifier of the already + If no argument is specified then the link identifier of the already opened link will be returned. </para> </refsect1> @@ -86,12 +79,11 @@ <?php // LDAP variables -$ldaphost = "ldap.example.com"; // your ldap servers -$ldapport = 389; // your ldap server's port number +$ldapuri = "ldap://ldap.example.com:389"; // your ldap-uri // Connecting to LDAP -$ldapconn = ldap_connect($ldaphost, $ldapport) - or die("Could not connect to $ldaphost"); +$ldapconn = ldap_connect($ldapuri) + or die("That LDAP-URI was not parseable"); ?> ]]> @@ -109,7 +101,7 @@ // Connecting to LDAP $ldapconn = ldap_connect($ldaphost) - or die("Could not connect to {$ldaphost}"); + or die("That LDAP-URI was not parseable"); ?> ]]> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=86812 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=86812 ------------------------------------------------------------------ Modified: en/reference/curl/functions/curl-getinfo.xml By: kasper Franz on 2018-11-22 05:25:19 =================================================================== --- en/reference/curl/functions/curl-getinfo.xml +++ en/reference/curl/functions/curl-getinfo.xml @@ -11,7 +11,7 @@ <methodsynopsis> <type>mixed</type><methodname>curl_getinfo</methodname> <methodparam><type>resource</type><parameter>ch</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>opt</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>opt</parameter><initializer>&null;</initializer></methodparam> </methodsynopsis> <para> Gets information about the last transfer. => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=86822 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=86822 ------------------------------------------------------------------ Modified: en/reference/curl/curlfile/construct.xml By: kasper Franz on 2018-11-22 05:40:38 =================================================================== --- en/reference/curl/curlfile/construct.xml +++ en/reference/curl/curlfile/construct.xml @@ -14,15 +14,15 @@ <methodsynopsis> <modifier>public</modifier> <methodname>CURLFile::__construct</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>mimetype</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>postname</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>mimetype</parameter><initializer>"application/octet-stream"</initializer></methodparam> + <methodparam choice="opt"><type>string</type><parameter>postname</parameter><initializer>"defaults to the name paramater."</initializer></methodparam> </methodsynopsis> <para>&style.procedural;</para> <methodsynopsis> <type>CURLFile</type><methodname>curl_file_create</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>mimetype</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>postname</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>mimetype</parameter><initializer>"application/octet-stream"</initializer></methodparam> + <methodparam choice="opt"><type>string</type><parameter>postname</parameter><initializer>"defaults to the name paramater."</initializer></methodparam> </methodsynopsis> <para> Creates a <classname>CURLFile</classname> object, used to upload a file with <constant>CURLOPT_POSTFIELDS</constant>. => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=86823 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=86823 ------------------------------------------------------------------ Modified: en/reference/dom/domdocument/createprocessinginstruction.xml By: kasper Franz on 2018-11-22 10:30:12 =================================================================== --- en/reference/dom/domdocument/createprocessinginstruction.xml +++ en/reference/dom/domdocument/createprocessinginstruction.xml @@ -10,7 +10,7 @@ <methodsynopsis> <modifier>public</modifier> <type>DOMProcessingInstruction</type><methodname>DOMDocument::createProcessingInstruction</methodname> <methodparam><type>string</type><parameter>target</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>data</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>data</parameter><initializer>&null;</initializer></methodparam> </methodsynopsis> <para> This function creates a new instance of class => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=86839 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=86839 ------------------------------------------------------------------ Modified: en/reference/dom/domdocument/createelementns.xml By: kasper Franz on 2018-11-22 10:31:02 =================================================================== --- en/reference/dom/domdocument/createelementns.xml +++ en/reference/dom/domdocument/createelementns.xml @@ -13,7 +13,7 @@ <modifier>public</modifier> <type>DOMElement</type><methodname>DOMDocument::createElementNS</methodname> <methodparam><type>string</type><parameter>namespaceURI</parameter></methodparam> <methodparam><type>string</type><parameter>qualifiedName</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>value</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>value</parameter><initializer>&null;</initializer></methodparam> </methodsynopsis> <para> This function creates a new element node with an associated namespace. => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=86841 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=86841 ------------------------------------------------------------------ Modified: en/reference/dom/domdocument/createelement.xml By: kasper Franz on 2018-11-22 10:32:07 =================================================================== --- en/reference/dom/domdocument/createelement.xml +++ en/reference/dom/domdocument/createelement.xml @@ -10,7 +10,7 @@ <methodsynopsis> <modifier>public</modifier> <type>DOMElement</type><methodname>DOMDocument::createElement</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>value</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>value</parameter><initializer>&null;</initializer></methodparam> </methodsynopsis> <para> This function creates a new instance of class => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=86844 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=86844 ------------------------------------------------------------------ Modified: en/reference/funchand/functions/func-get-args.xml By: HongWeipeng on 2018-12-07 00:56:17 =================================================================== --- en/reference/funchand/functions/func-get-args.xml +++ en/reference/funchand/functions/func-get-args.xml @@ -3,7 +3,7 @@ <refentry xml:id="function.func-get-args" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>func_get_args</refname> - <refpurpose>Returns an array comprising a function's argument list</refpurpose> + <refpurpose>Returns an array of arguments passed to the function</refpurpose> </refnamediv> <refsect1 role="description"> @@ -13,7 +13,7 @@ <void/> </methodsynopsis> <para> - Gets an array of the function's argument list. + Gets an array of arguments passed to the function. </para> <para> This function may be used in conjunction with => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=87517 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=87517 ------------------------------------------------------------------ Modified: en/reference/exec/functions/proc-open.xml By: kasper Franz on 2018-12-10 08:23:54 =================================================================== --- en/reference/exec/functions/proc-open.xml +++ en/reference/exec/functions/proc-open.xml @@ -15,9 +15,9 @@ <methodparam><type>string</type><parameter>cmd</parameter></methodparam> <methodparam><type>array</type><parameter>descriptorspec</parameter></methodparam> <methodparam><type>array</type><parameter role="reference">pipes</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>cwd</parameter></methodparam> - <methodparam choice="opt"><type>array</type><parameter>env</parameter></methodparam> - <methodparam choice="opt"><type>array</type><parameter>other_options</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>cwd</parameter><initializer>&null;</initializer></methodparam> + <methodparam choice="opt"><type>array</type><parameter>env</parameter><initializer>&null;</initializer></methodparam> + <methodparam choice="opt"><type>array</type><parameter>other_options</parameter><initializer>&null;</initializer></methodparam> </methodsynopsis> <para> <function>proc_open</function> is similar to <function>popen</function> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=87916 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=87916 ------------------------------------------------------------------ Modified: en/reference/ftp/functions/ftp-fput.xml By: Huiren Woo on 2018-12-26 04:22:13 =================================================================== --- en/reference/ftp/functions/ftp-fput.xml +++ en/reference/ftp/functions/ftp-fput.xml @@ -87,7 +87,7 @@ <row> <entry>7.3.0</entry> <entry> - The <parameter>mode</parameter> parameter is now optional. Formerly it + The <parameter>mode</parameter> parameter is now optional as the default transfer mode is set to <constant>FTP_BINARY</constant>. Formerly it has been mandatory. </entry> </row> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=88477 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=88477 ------------------------------------------------------------------ Modified: en/reference/array/functions/array-splice.xml By: girgias on 2018-12-28 11:39:52 =================================================================== --- en/reference/array/functions/array-splice.xml +++ en/reference/array/functions/array-splice.xml @@ -48,10 +48,13 @@ <term><parameter>offset</parameter></term> <listitem> <para> - If <parameter>offset</parameter> is positive then the start of removed - portion is at that offset from the beginning of the - <parameter>input</parameter> array. If <parameter>offset</parameter> - is negative then it starts that far from the end of the + If <parameter>offset</parameter> is positive then the start of the + removed portion is at that offset from the beginning of the + <parameter>input</parameter> array. + </para> + <para> + If <parameter>offset</parameter> is negative then the start of the + removed portion is at that offset from the end of the <parameter>input</parameter> array. </para> </listitem> @@ -61,18 +64,25 @@ <listitem> <para> If <parameter>length</parameter> is omitted, removes everything - from <parameter>offset</parameter> to the end of the array. If - <parameter>length</parameter> is specified and is positive, then - that many elements will be removed. If - <parameter>length</parameter> is specified and is negative then - the end of the removed portion will be that many elements from - the end of the array. If <parameter>length</parameter> is - specified and is zero, no elements will be removed. - Tip: to remove everything from - <parameter>offset</parameter> to the end of the array when - <parameter>replacement</parameter> is also specified, use - <literal>count($input)</literal> for - <parameter>length</parameter>. + from <parameter>offset</parameter> to the end of the array. + </para> + <para> + If <parameter>length</parameter> is specified and is positive, + then that many elements will be removed. + </para> + <para> + If <parameter>length</parameter> is specified and is negative, + then the end of the removed portion will be that many elements + from the end of the array. + </para> + <para> + If <parameter>length</parameter> is specified and is zero, + no elements will be removed. + </para> + <para> + Tip: to remove everything from <parameter>offset</parameter> to the end + of the array when <parameter>replacement</parameter> is also specified, + use <literal>count($input)</literal> for <parameter>length</parameter>. </para> </listitem> </varlistentry> @@ -87,12 +97,15 @@ If <parameter>offset</parameter> and <parameter>length</parameter> are such that nothing is removed, then the elements from the <parameter>replacement</parameter> array are inserted in the place - specified by the <parameter>offset</parameter>. Note that keys in - replacement array are not preserved. + specified by the <parameter>offset</parameter>. + </para> + <para> + Note that the keys in the <parameter>replacement</parameter> array + are not preserved. </para> <para> If <parameter>replacement</parameter> is just one element it is - not necessary to put <literal>array()</literal> + not necessary to put <literal>array()</literal> or square brackets around it, unless the element is an array itself, an object or &null;. </para> </listitem> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=88553 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=88553 ------------------------------------------------------------------ Modified: en/reference/array/functions/array-slice.xml By: girgias on 2018-12-28 11:53:17 =================================================================== --- en/reference/array/functions/array-slice.xml +++ en/reference/array/functions/array-slice.xml @@ -38,9 +38,13 @@ <listitem> <para> If <parameter>offset</parameter> is non-negative, the sequence will - start at that offset in the <parameter>array</parameter>. If - <parameter>offset</parameter> is negative, the sequence will + start at that offset in the <parameter>array</parameter>. + </para> + <para> + If <parameter>offset</parameter> is negative, the sequence will start that far from the end of the <parameter>array</parameter>. + </para> + <para> Note that the <parameter>offset</parameter> denotes the position in the array, not the key. </para> @@ -50,13 +54,19 @@ <term><parameter>length</parameter></term> <listitem> <para> - If <parameter>length</parameter> is given and is positive, then - the sequence will have up to that many elements in it. If the array - is shorter than the <parameter>length</parameter>, then only the - available array elements will be present. If - <parameter>length</parameter> is given and is negative then the - sequence will stop that many elements from the end of the - array. If it is omitted, then the sequence will have everything + If <parameter>length</parameter> is given and is positive, + then the sequence will have up to that many elements in it. + </para> + <para> + If the array is shorter than the <parameter>length</parameter>, + then only the available array elements will be present. + </para> + <para> + If <parameter>length</parameter> is given and is negative then the + sequence will stop that many elements from the end of the array. + </para> + <para> + If it is omitted, then the sequence will have everything from <parameter>offset</parameter> up until the end of the <parameter>array</parameter>. </para> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=88554 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=88554 ------------------------------------------------------------------ Modified: en/reference/var/functions/isset.xml By: girgias on 2018-12-29 21:09:38 =================================================================== --- en/reference/var/functions/isset.xml +++ en/reference/var/functions/isset.xml @@ -3,7 +3,7 @@ <refentry xml:id="function.isset" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>isset</refname> - <refpurpose>Determine if a variable is set and is not &null;</refpurpose> + <refpurpose>Determine if a variable is declared and is different than &null;</refpurpose> </refnamediv> <refsect1 role="description"> @@ -14,18 +14,20 @@ <methodparam choice="opt"><type>mixed</type><parameter>...</parameter></methodparam> </methodsynopsis> <para> - Determine if a variable is set and is not &null;. + Determine if a variable is considered set, + this means if a variable is declared and is different than &null;. </para> <para> - If a variable has been unset with <function>unset</function>, it will no - longer be set. <function>isset</function> will return &false; if testing a - variable that has been set to &null;. Also note that a null character - (<literal>" "</literal>) is not equivalent to the PHP &null; constant. + If a variable has been unset with the <function>unset</function> function, it will no longer be set. + </para> + <para> + <function>isset</function> will return &false; when checking a variable that has been assigned to &null;. + Also note that a null character (<literal>" "</literal>) is not equivalent to the PHP &null; constant. </para> <para> If multiple parameters are supplied then <function>isset</function> will - return &true; only if all of the parameters are set. Evaluation goes from - left to right and stops as soon as an unset variable is encountered. + return &true; only if all of the parameters are considered set. + Evaluation goes from left to right and stops as soon as an unset variable is encountered. </para> </refsect1> @@ -56,8 +58,7 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns &true; if <parameter>var</parameter> exists and has value other - than &null;. &false; otherwise. + Returns &true; if <parameter>var</parameter> exists and has any value other than &null;. &false; otherwise. </para> </refsect1> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=88620 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=88620 ------------------------------------------------------------------ Modified: en/reference/datetime/datetimezone/gettransitions.xml By: kasper Franz on 2019-01-03 11:08:23 =================================================================== --- en/reference/datetime/datetimezone/gettransitions.xml +++ en/reference/datetime/datetimezone/gettransitions.xml @@ -19,8 +19,8 @@ <methodsynopsis role="procedural"> <type>array</type><methodname>timezone_transitions_get</methodname> <methodparam><type>DateTimeZone</type><parameter>object</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>timestamp_begin</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>timestamp_end</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timestamp_begin</parameter><initializer><constant>PHP_INT_MIN</constant></initializer></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timestamp_end</parameter><initializer><constant>PHP_INT_MIN</constant></initializer></methodparam> </methodsynopsis> </refsect1> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=88940 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=88940 ------------------------------------------------------------------ Modified: en/reference/spl/functions/iterator-to-array.xml By: Joel Wurtz on 2019-01-09 08:31:37 =================================================================== --- en/reference/spl/functions/iterator-to-array.xml +++ en/reference/spl/functions/iterator-to-array.xml @@ -138,6 +138,44 @@ ]]> </screen> </example> + <example> + <title><function>iterator_to_array</function> with Generator example</title> + <programlisting role="php"> +<![CDATA[ +<?php + +function yield1() { + yield 'foo'; +} + +function yield2() { + yield 'bar'; + + yield from yield1(); +} + +var_dump(iterator_to_array(yield2(), false)); +var_dump(iterator_to_array(yield2(), true)); + +?> +]]> + </programlisting> + &example.outputs; + <screen> +<![CDATA[ +array(2) { + [0]=> + string(3) "bar" + [1]=> + string(3) "foo" +} +array(1) { + [0]=> + string(3) "foo" +} +]]> + </screen> + </example> </para> </refsect1> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89165 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89165 ------------------------------------------------------------------ Modified: en/reference/runkit/functions/runkit-method-add.xml By: girgias on 2019-01-10 22:24:00 =================================================================== --- en/reference/runkit/functions/runkit-method-add.xml +++ en/reference/runkit/functions/runkit-method-add.xml @@ -80,12 +80,6 @@ <constant>RUNKIT_ACC_PRIVATE</constant> optionally combined via bitwise OR with <constant>RUNKIT_ACC_STATIC</constant> (since 1.0.1) </para> - <note> - <para> - This parameter is only used as of PHP 5, because, prior to this, - all methods were public. - </para> - </note> </listitem> </varlistentry> <varlistentry> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89204 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89204 ------------------------------------------------------------------ Modified: en/reference/ldap/functions/ldap-mod-del.xml By: girgias on 2019-01-10 22:24:45 =================================================================== --- en/reference/ldap/functions/ldap-mod-del.xml +++ en/reference/ldap/functions/ldap-mod-del.xml @@ -61,6 +61,13 @@ </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="changelog"> &reftitle.changelog; <para> @@ -85,13 +92,6 @@ </para> </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - &return.success; - </para> - </refsect1> - <refsect1 role="seealso"> &reftitle.seealso; <para> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89205 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89205 ------------------------------------------------------------------ Modified: en/reference/strings/functions/echo.xml By: girgias on 2019-01-10 22:54:09 =================================================================== --- en/reference/strings/functions/echo.xml +++ en/reference/strings/functions/echo.xml @@ -85,44 +85,11 @@ <?php echo "Hello World"; -echo "This spans -multiple lines. The newlines will be -output as well"; - -echo "This spansnmultiple lines. The newlines will benoutput as well."; - -echo "Escaping characters is done "Like this"."; - -// You can use variables inside of an echo statement -$foo = "foobar"; -$bar = "barbaz"; - -echo "foo is $foo"; // foo is foobar - -// You can also use arrays -$baz = array("value" => "foo"); - -echo "this is {$baz['value']} !"; // this is foo ! - -// Using single quotes will print the variable name, not the value -echo 'foo is $foo'; // foo is $foo - -// If you are not using any other characters, you can just echo variables -echo $foo; // foobar -echo $foo,$bar; // foobarbarbaz - // Strings can either be passed individually as multiple arguments or // concatenated together and passed as a single argument echo 'This ', 'string ', 'was ', 'made ', 'with multiple parameters.', chr(10); echo 'This ' . 'string ' . 'was ' . 'made ' . 'with concatenation.' . "n"; -echo <<<END -This uses the "here document" syntax to output -multiple lines with $variable interpolation. Note -that the here document terminator must appear on a -line with just a semicolon. no extra whitespace! -END; - // Because echo does not behave like a function, the following code is invalid. ($some_var) ? echo 'true' : echo 'false'; @@ -130,6 +97,7 @@ ($some_var) ? print 'true' : print 'false'; // print is also a construct, but // it behaves like a function, so // it may be used in this context. + echo $some_var ? 'true': 'false'; // changing the statement around ?> ]]> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89209 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89209 ------------------------------------------------------------------ Modified: en/reference/array/functions/in-array.xml By: girgias on 2019-01-11 06:46:22 =================================================================== --- en/reference/array/functions/in-array.xml +++ en/reference/array/functions/in-array.xml @@ -14,7 +14,7 @@ <methodparam choice="opt"><type>bool</type><parameter>strict</parameter><initializer>&false;</initializer></methodparam> </methodsynopsis> <para> - Searches <parameter>haystack</parameter> for <parameter>needle</parameter> using loose comparison + Searches for <parameter>needle</parameter> in <parameter>haystack</parameter> using loose comparison unless <parameter>strict</parameter> is set. </para> </refsect1> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89214 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89214 ------------------------------------------------------------------ Modified: en/reference/array/functions/array-search.xml By: girgias on 2019-01-11 06:51:30 =================================================================== --- en/reference/array/functions/array-search.xml +++ en/reference/array/functions/array-search.xml @@ -14,7 +14,7 @@ <methodparam choice="opt"><type>bool</type><parameter>strict</parameter><initializer>&false;</initializer></methodparam> </methodsynopsis> <para> - Searches <parameter>haystack</parameter> for <parameter>needle</parameter>. + Searches for <parameter>needle</parameter> in <parameter>haystack</parameter>. </para> </refsect1> <refsect1 role="parameters"> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89215 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89215 ------------------------------------------------------------------ Modified: en/reference/array/functions/array-map.xml By: girgias on 2019-01-11 07:28:33 =================================================================== --- en/reference/array/functions/array-map.xml +++ en/reference/array/functions/array-map.xml @@ -11,17 +11,16 @@ <methodsynopsis> <type>array</type><methodname>array_map</methodname> <methodparam><type>callable</type><parameter>callback</parameter></methodparam> - <methodparam><type>array</type><parameter>array1</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>...</parameter></methodparam> </methodsynopsis> <para> - <function>array_map</function> returns an array containing all - the elements of <parameter>array1</parameter> after applying the - <parameter>callback</parameter> function to each one. + <function>array_map</function> returns an array containing + the results of applying the <parameter>callback</parameter> + function to the corresponding index of <parameter>...</parameter> + used as arguments of the callback. The number of parameters that the <parameter>callback</parameter> - function accepts - should match the number of arrays - passed to the <function>array_map</function> + function accepts should match the number of arrays + passed to the <function>array_map</function>. </para> </refsect1> @@ -38,14 +37,6 @@ </listitem> </varlistentry> <varlistentry> - <term><parameter>array1</parameter></term> - <listitem> - <para> - An array to run through the <parameter>callback</parameter> function. - </para> - </listitem> - </varlistentry> - <varlistentry> <term><parameter>...</parameter></term> <listitem> <para> @@ -61,8 +52,9 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns an array containing all the elements of <parameter>array1</parameter> - after applying the <parameter>callback</parameter> function to each one. + Returns an array containing the results of applying the <parameter>callback</parameter> + function to the corresponding index of <parameter>...</parameter> + used as arguments of the callback. </para> </refsect1> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89216 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89216 ------------------------------------------------------------------ Modified: en/reference/openssl/functions/openssl-encrypt.xml By: anonymous on 2019-01-13 05:08:52 =================================================================== --- en/reference/openssl/functions/openssl-encrypt.xml +++ en/reference/openssl/functions/openssl-encrypt.xml @@ -187,22 +187,23 @@ $ivlen = openssl_cipher_iv_length($cipher="AES-128-CBC"); $iv = openssl_random_pseudo_bytes($ivlen); $ciphertext_raw = openssl_encrypt($plaintext, $cipher, $key, $options=OPENSSL_RAW_DATA, $iv); -$hmac = hash_hmac('sha256', $ciphertext_raw, $key, $as_binary=true); -$ciphertext = base64_encode( $iv.$hmac.$ciphertext_raw ); - -//decrypt later.... +$hmac = hash_hmac('sha256', $iv.$ciphertext_raw, $key, $as_binary=true); +$ciphertext = base64_encode( $iv.$ciphertext_raw.$hmac ); +//decrypt later... +$sha2len = 32; $c = base64_decode($ciphertext); -$ivlen = openssl_cipher_iv_length($cipher="AES-128-CBC"); -$iv = substr($c, 0, $ivlen); -$hmac = substr($c, $ivlen, $sha2len=32); -$ciphertext_raw = substr($c, $ivlen+$sha2len); -$original_plaintext = openssl_decrypt($ciphertext_raw, $cipher, $key, $options=OPENSSL_RAW_DATA, $iv); -$calcmac = hash_hmac('sha256', $ciphertext_raw, $key, $as_binary=true); +$hmac = substr($c, -1*$sha2len); +$hmac_input = substr($c, 0, -1*$sha2len); +$calcmac = hash_hmac('sha256', $hmac_input, $key, $as_binary=true); if (hash_equals($hmac, $calcmac))//PHP 5.6+ timing attack safe comparison { + $ivlen = openssl_cipher_iv_length($cipher="AES-128-CBC"); + $iv = substr($c, 0, $ivlen); + $ciphertext_raw = substr($c, $ivlen, -1*$sha2len); + $original_plaintext = openssl_decrypt($ciphertext_raw, $cipher, $key, $options=OPENSSL_RAW_DATA, $iv); echo $original_plaintext."n"; } -?> + ]]> </programlisting> </example> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89229 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89229 ------------------------------------------------------------------ Modified: en/reference/reflection/reflectiongenerator/gettrace.xml By: girgias on 2019-01-17 08:10:54 =================================================================== --- en/reference/reflection/reflectiongenerator/gettrace.xml +++ en/reference/reflection/reflectiongenerator/gettrace.xml @@ -26,7 +26,7 @@ <term><parameter>options</parameter></term> <listitem> <para> - The value of <parameter>options</parameter> can be any of the following + The value of <parameter>options</parameter> can be any of the following flags. </para> <para> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89254 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89254 ------------------------------------------------------------------ Modified: en/reference/stream/constants.xml By: girgias on 2019-02-07 08:50:42 =================================================================== --- en/reference/stream/constants.xml +++ en/reference/stream/constants.xml @@ -14,7 +14,7 @@ </thead> <tbody> <row xml:id="constant.stream-filter-read"> - <entry><constant>STREAM_FILTER_READ</constant> *</entry> + <entry><constant>STREAM_FILTER_READ</constant></entry> <entry> Used with <function>stream_filter_append</function> and <function>stream_filter_prepend</function> to indicate @@ -23,7 +23,7 @@ </entry> </row> <row xml:id="constant.stream-filter-write"> - <entry><constant>STREAM_FILTER_WRITE</constant> *</entry> + <entry><constant>STREAM_FILTER_WRITE</constant></entry> <entry> Used with <function>stream_filter_append</function> and <function>stream_filter_prepend</function> to indicate @@ -32,27 +32,27 @@ </entry> </row> <row xml:id="constant.stream-filter-all"> - <entry><constant>STREAM_FILTER_ALL</constant> *</entry> + <entry><constant>STREAM_FILTER_ALL</constant></entry> <entry> This constant is equivalent to <code>STREAM_FILTER_READ | STREAM_FILTER_WRITE</code> </entry> </row> <row xml:id="constant.psfs-pass-on"> - <entry><constant>PSFS_PASS_ON</constant> *</entry> + <entry><constant>PSFS_PASS_ON</constant></entry> <entry><literal>Return Code</literal> indicating that the userspace filter returned buckets in <parameter>$out</parameter>. </entry> </row> <row xml:id="constant.psfs-feed-me"> - <entry><constant>PSFS_FEED_ME</constant> *</entry> + <entry><constant>PSFS_FEED_ME</constant></entry> <entry><literal>Return Code</literal> indicating that the userspace filter did not return buckets in <parameter>$out</parameter> (i.e. No data available). </entry> </row> <row xml:id="constant.psfs-err-fatal"> - <entry><constant>PSFS_ERR_FATAL</constant> *</entry> + <entry><constant>PSFS_ERR_FATAL</constant></entry> <entry><literal>Return Code</literal> indicating that the userspace filter encountered an unrecoverable error (i.e. Invalid data received). @@ -85,32 +85,32 @@ </entry> </row> <row xml:id="constant.stream-client-async-connect"> - <entry><constant>STREAM_CLIENT_ASYNC_CONNECT</constant> *</entry> + <entry><constant>STREAM_CLIENT_ASYNC_CONNECT</constant></entry> <entry>Open client socket asynchronously. This option must be used together with the <constant>STREAM_CLIENT_CONNECT</constant> flag. Used with <function>stream_socket_client</function>. </entry> </row> <row xml:id="constant.stream-client-connect"> - <entry><constant>STREAM_CLIENT_CONNECT</constant> *</entry> + <entry><constant>STREAM_CLIENT_CONNECT</constant></entry> <entry>Open client socket connection. Client sockets should always include this flag. Used with <function>stream_socket_client</function>. </entry> </row> <row xml:id="constant.stream-client-persistent"> - <entry><constant>STREAM_CLIENT_PERSISTENT</constant> *</entry> + <entry><constant>STREAM_CLIENT_PERSISTENT</constant></entry> <entry>Client socket opened with <function>stream_socket_client</function> should remain persistent between page loads. </entry> </row> <row xml:id="constant.stream-server-bind"> - <entry><constant>STREAM_SERVER_BIND</constant> *</entry> + <entry><constant>STREAM_SERVER_BIND</constant></entry> <entry>Tells a stream created with <function>stream_socket_server</function> to bind to the specified target. Server sockets should always include this flag. </entry> </row> <row xml:id="constant.stream-server-listen"> - <entry><constant>STREAM_SERVER_LISTEN</constant> *</entry> + <entry><constant>STREAM_SERVER_LISTEN</constant></entry> <entry>Tells a stream created with <function>stream_socket_server</function> and bound using the <constant>STREAM_SERVER_BIND</constant> flag to start listening on the socket. Connection-orientated transports (such as TCP) @@ -119,7 +119,7 @@ </entry> </row> <row xml:id="constant.stream-notify-resolve"> - <entry><constant>STREAM_NOTIFY_RESOLVE</constant> *</entry> + <entry><constant>STREAM_NOTIFY_RESOLVE</constant></entry> <entry> A remote address required for this stream has been resolved, or the resolution failed. See <parameter>severity</parameter> for an indication of which happened. @@ -169,7 +169,7 @@ </entry> </row> <row xml:id="constant.stream-notify-completed"> - <entry><constant>STREAM_NOTIFY_COMPLETED</constant> *</entry> + <entry><constant>STREAM_NOTIFY_COMPLETED</constant></entry> <entry> There is no more data available on the stream. </entry> @@ -365,12 +365,6 @@ </para> <note> <simpara> - The constants marked with <literal>*</literal> are just available since - PHP 5.0.0. - </simpara> - </note> - <note> - <simpara> The constants marked with <literal>+</literal> are available since PHP 5.1.0 and are meant to be used with <function>stream_socket_pair</function>. Please note that some of these => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89581 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89581 ------------------------------------------------------------------ Modified: en/reference/filesystem/functions/fopen.xml By: girgias on 2019-02-07 09:56:44 =================================================================== --- en/reference/filesystem/functions/fopen.xml +++ en/reference/filesystem/functions/fopen.xml @@ -315,16 +315,6 @@ added </entry> </row> - <row> - <entry>4.3.2</entry> - <entry> - As of PHP 4.3.2, the default mode is set to binary for all platforms - that distinguish between binary and text mode. If you are having - problems with your scripts after upgrading, try using the - <literal>'t'</literal> flag as a workaround until you have made your - script more portable as mentioned before - </entry> - </row> </tbody> </tgroup> </informaltable> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89583 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89583 ------------------------------------------------------------------ Modified: en/reference/filesystem/functions/copy.xml By: girgias on 2019-02-07 09:59:55 =================================================================== --- en/reference/filesystem/functions/copy.xml +++ en/reference/filesystem/functions/copy.xml @@ -95,14 +95,6 @@ Added context support. </entry> </row> - <row> - <entry>4.3.0</entry> - <entry> - Both <parameter>source</parameter> and <parameter>dest</parameter> - may now be URLs if the "fopen wrappers" have been enabled. - See <function>fopen</function> for more details. - </entry> - </row> </tbody> </tgroup> </informaltable> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89584 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89584 ------------------------------------------------------------------ Modified: en/reference/filesystem/functions/dirname.xml By: girgias on 2019-02-07 10:00:11 =================================================================== --- en/reference/filesystem/functions/dirname.xml +++ en/reference/filesystem/functions/dirname.xml @@ -95,12 +95,6 @@ Added the optional <parameter>levels</parameter> parameter. </entry> </row> - <row> - <entry>5.0.0</entry> - <entry> - <function>dirname</function> is now binary safe - </entry> - </row> </tbody> </tgroup> </informaltable> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89585 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89585 ------------------------------------------------------------------ Modified: en/reference/filesystem/functions/fgetcsv.xml By: girgias on 2019-02-07 10:03:50 =================================================================== --- en/reference/filesystem/functions/fgetcsv.xml +++ en/reference/filesystem/functions/fgetcsv.xml @@ -159,12 +159,6 @@ --> </entry> </row> - <row> - <entry>4.3.5</entry> - <entry> - <function>fgetcsv</function> is now binary safe - </entry> - </row> </tbody> </tgroup> </informaltable> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89586 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89586 ------------------------------------------------------------------ Modified: en/reference/filesystem/functions/fgets.xml By: girgias on 2019-02-07 10:04:36 =================================================================== --- en/reference/filesystem/functions/fgets.xml +++ en/reference/filesystem/functions/fgets.xml @@ -63,30 +63,6 @@ </para> </refsect1> - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>4.3.0</entry> - <entry> - <function>fgets</function> is now binary safe - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - <refsect1 role="examples"> &reftitle.examples; <para> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89587 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89587 ------------------------------------------------------------------ Modified: en/reference/filesystem/functions/file.xml By: girgias on 2019-02-07 10:05:28 =================================================================== --- en/reference/filesystem/functions/file.xml +++ en/reference/filesystem/functions/file.xml @@ -119,30 +119,6 @@ does not exist. </para> </refsect1> - - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>4.3.0</entry> - <entry> - <function>file</function> became binary safe - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> <refsect1 role="examples"> &reftitle.examples; => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89588 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89588 ------------------------------------------------------------------ Modified: en/reference/filesystem/functions/parse-ini-file.xml By: girgias on 2019-02-07 10:13:51 =================================================================== --- en/reference/filesystem/functions/parse-ini-file.xml +++ en/reference/filesystem/functions/parse-ini-file.xml @@ -120,19 +120,6 @@ evaluated as hexadecimals. </entry> </row> - <row> - <entry>5.0.0</entry> - <entry> - Values enclosed in double quotes can contain new lines. - </entry> - </row> - <row> - <entry>4.2.1</entry> - <entry> - This function is now affected by &safemode; - and <link linkend="ini.open-basedir">open_basedir</link>. - </entry> - </row> </tbody> </tgroup> </informaltable> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89589 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89589 ------------------------------------------------------------------ Modified: en/reference/filesystem/functions/rename.xml By: girgias on 2019-02-07 10:15:14 =================================================================== --- en/reference/filesystem/functions/rename.xml +++ en/reference/filesystem/functions/rename.xml @@ -87,26 +87,6 @@ Windows. </entry> </row> - <row> - <entry>5.0.0</entry> - <entry> - <function>rename</function> can now also be used with - <emphasis>some</emphasis> URL wrappers. Refer to <xref - linkend="wrappers"/> for a listing of which wrappers - support <function>rename</function>. - </entry> - </row> - <row> - <entry>4.3.3</entry> - <entry> - <function>rename</function> may now be able to rename files across - partitions on *nix based systems, provided the appropriate permissions - are held. Warnings may be generated if the destination filesystem - doesn't permit <literal>chown()</literal> or - <literal>chmod()</literal> system calls to be made on files — - for example, if the destination filesystem is a FAT filesystem. - </entry> - </row> </tbody> </tgroup> </informaltable> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89590 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89590 ------------------------------------------------------------------ Modified: en/reference/filesystem/functions/rmdir.xml By: girgias on 2019-02-07 10:15:38 =================================================================== --- en/reference/filesystem/functions/rmdir.xml +++ en/reference/filesystem/functions/rmdir.xml @@ -49,33 +49,6 @@ </para> </refsect1> - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>5.0.0</entry> - <entry> - As of PHP 5.0.0 <function>rmdir</function> can also be used with - <emphasis>some</emphasis> URL wrappers. Refer to <xref - linkend="wrappers"/> for a listing of which wrappers support - <function>rmdir</function>. - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - <refsect1 role="examples"> &reftitle.examples; <para> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89591 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89591 ------------------------------------------------------------------ Modified: en/reference/filesystem/functions/tempnam.xml By: girgias on 2019-02-07 10:16:29 =================================================================== --- en/reference/filesystem/functions/tempnam.xml +++ en/reference/filesystem/functions/tempnam.xml @@ -58,35 +58,6 @@ </para> </refsect1> - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>4.0.3</entry> - <entry> - This function's behavior changed in 4.0.3. The temporary file is also - created to avoid a race condition where the file might appear in the - filesystem between the time the string was generated and before - the script gets around to creating the file. Note, that you need - to remove the file in case you need it no more, it is not done - automatically. - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - <refsect1 role="examples"> &reftitle.examples; <para> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89592 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89592 ------------------------------------------------------------------ Modified: en/reference/filesystem/functions/unlink.xml By: girgias on 2019-02-07 10:17:06 =================================================================== --- en/reference/filesystem/functions/unlink.xml +++ en/reference/filesystem/functions/unlink.xml @@ -49,33 +49,6 @@ </para> </refsect1> - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>5.0.0</entry> - <entry> - As of PHP 5.0.0 <function>unlink</function> can also be used with - <emphasis>some</emphasis> URL wrappers. Refer to <xref - linkend="wrappers"/> for a listing of which wrappers support - <function>unlink</function>. - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - <refsect1 role="examples"> &reftitle.examples; <para> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89593 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89593 ------------------------------------------------------------------ Modified: en/reference/filesystem/constants.xml By: girgias on 2019-02-07 10:18:31 =================================================================== --- en/reference/filesystem/constants.xml +++ en/reference/filesystem/constants.xml @@ -210,7 +210,7 @@ <listitem> <simpara> Search for <parameter>filename</parameter> in - <link linkend="ini.include-path">include_path</link> (since PHP 5). + <link linkend="ini.include-path">include_path</link>. </simpara> </listitem> </varlistentry> @@ -242,7 +242,7 @@ </term> <listitem> <simpara> - Strip EOL characters (since PHP 5). + Strip EOL characters. </simpara> </listitem> </varlistentry> @@ -253,7 +253,7 @@ </term> <listitem> <simpara> - Skip empty lines (since PHP 5). + Skip empty lines. </simpara> </listitem> </varlistentry> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89594 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89594 ------------------------------------------------------------------ Modified: en/reference/stream/functions/stream-set-timeout.xml By: girgias on 2019-02-07 10:25:26 =================================================================== --- en/reference/stream/functions/stream-set-timeout.xml +++ en/reference/stream/functions/stream-set-timeout.xml @@ -64,33 +64,6 @@ &return.success; </para> </refsect1> - - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>4.3.0</entry> - <entry> - As of PHP 4.3, this function can (potentially) work on any kind of - stream. In PHP 4.3, socket based streams are still the only kind - supported in the PHP core, although streams from other extensions - may support this function. - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> <refsect1 role="examples"> &reftitle.examples; => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89595 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89595 ------------------------------------------------------------------ Modified: en/reference/session/functions/session-regenerate-id.xml By: girgias on 2019-02-07 10:44:24 =================================================================== --- en/reference/session/functions/session-regenerate-id.xml +++ en/reference/session/functions/session-regenerate-id.xml @@ -92,14 +92,6 @@ Added the <parameter>delete_old_session</parameter> parameter. </entry> </row> - <row> - <entry>4.3.3</entry> - <entry> - Since then, if session cookies are enabled, use of - <function>session_regenerate_id</function> will also submit a new - session cookie with the new session id. - </entry> - </row> </tbody> </tgroup> </informaltable> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89596 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89596 ------------------------------------------------------------------ Modified: en/reference/session/functions/session-set-save-handler.xml By: girgias on 2019-02-07 10:45:00 =================================================================== --- en/reference/session/functions/session-set-save-handler.xml +++ en/reference/session/functions/session-set-save-handler.xml @@ -183,6 +183,42 @@ </para> </refsect1> + <refsect1 role="changelog"> + &reftitle.changelog; + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>7.0.0</entry> + <entry> + Added the optional <parameter>validate_sid</parameter> and + <parameter>update_timestamp</parameter> parameters. + </entry> + </row> + <row> + <entry>5.5.1</entry> + <entry> + Added the optional <parameter>create_sid</parameter> parameter. + </entry> + </row> + <row> + <entry>5.4.0</entry> + <entry> + Added <interfacename>SessionHandlerInterface</interfacename> for implementing session handlers and + <classname>SessionHandler</classname> to expose internal PHP session handlers. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> @@ -349,42 +385,6 @@ </warning> </refsect1> - <refsect1 role="changelog"> - &reftitle.changelog; - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>7.0.0</entry> - <entry> - Added the optional <parameter>validate_sid</parameter> and - <parameter>update_timestamp</parameter> parameters. - </entry> - </row> - <row> - <entry>5.5.1</entry> - <entry> - Added the optional <parameter>create_sid</parameter> parameter. - </entry> - </row> - <row> - <entry>5.4.0</entry> - <entry> - Added <interfacename>SessionHandlerInterface</interfacename> for implementing session handlers and - <classname>SessionHandler</classname> to expose internal PHP session handlers. - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </refsect1> - <refsect1 role="seealso"> &reftitle.seealso; <para> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89597 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89597 ------------------------------------------------------------------ Modified: en/reference/session/functions/session-start.xml By: girgias on 2019-02-07 10:45:28 =================================================================== --- en/reference/session/functions/session-start.xml +++ en/reference/session/functions/session-start.xml @@ -109,15 +109,6 @@ Previously &true; was returned. </entry> </row> - <row> - <entry>4.3.3</entry> - <entry> - As of PHP 4.3.3, calling <function>session_start</function> - after the session was previously started will result in an - error of level <constant>E_NOTICE</constant>. Also, the - second session start will simply be ignored. - </entry> - </row> </tbody> </tgroup> </informaltable> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89598 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89598 ------------------------------------------------------------------ Modified: en/reference/mbstring/functions/mb-strlen.xml By: anonymous on 2019-02-07 20:14:43 =================================================================== --- en/reference/mbstring/functions/mb-strlen.xml +++ en/reference/mbstring/functions/mb-strlen.xml @@ -48,10 +48,14 @@ <parameter>encoding</parameter>. A multi-byte character is counted as 1. </para> + </refsect1> + + <refsect1 role="errors"> + &reftitle.errors; <para> - Returns &false; if the given <parameter>encoding</parameter> is invalid. + If the encoding is unknown, an error of level + <constant>E_WARNING</constant> is generated. </para> - &return.falseproblem; </refsect1> <refsect1 role="seealso"> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89599 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89599 ------------------------------------------------------------------ Modified: en/reference/misc/functions/sapi-windows-vt100-support.xml By: Florian Berberich on 2019-02-10 12:43:53 =================================================================== --- en/reference/misc/functions/sapi-windows-vt100-support.xml +++ en/reference/misc/functions/sapi-windows-vt100-support.xml @@ -15,7 +15,7 @@ <methodparam choice="opt"><type>bool</type><parameter>enable</parameter></methodparam> </methodsynopsis> <para> - If <parameter>enable</parameter> is omitted, the function return &true; if the stream <parameter>stream</parameter> has VT100 control codes enabled, &false; otherwise. + If <parameter>enable</parameter> is omitted, the function returns &true; if the stream <parameter>stream</parameter> has VT100 control codes enabled, &false; otherwise. </para> <para> If <parameter>enable</parameter> is specified, the function will try to enable or disable the VT100 features of the stream <parameter>stream</parameter>. @@ -24,9 +24,13 @@ <para> At startup, PHP tries to enable the VT100 feature of the <constant>STDOUT</constant>/<constant>STDERR</constant> streams. By the way, if those streams are redirected to a file, the VT100 features may not be enabled. </para> + <para> + If VT100 support is enabled, it is possible to use control sequences as they are known from the VT100 terminal. + They allow the modification of the terminal's output. On Windows these sequences are called Console Virtual Terminal Sequences. + </para> <warning> <simpara> - The function uses the <constant>ENABLE_VIRTUAL_TERMINAL_PROCESSING</constant> flag implemented in the Windows 10 API, so the VT100 feature may not be available on older Windows versions. + This function uses the <constant>ENABLE_VIRTUAL_TERMINAL_PROCESSING</constant> flag implemented in the Windows 10 API, so the VT100 feature may not be available on older Windows versions. </simpara> </warning> </refsect1><!-- }}} --> @@ -75,7 +79,9 @@ </programlisting> &example.outputs.similar; <screen> - true true +<![CDATA[ +true true +]]> </screen> <para> By the way, if a stream is redirected, the VT100 feature will not be enabled: @@ -98,7 +104,31 @@ </programlisting> &example.outputs.similar; <screen> - true false +<![CDATA[ +true false +]]> + </screen> + </example> + <example> + <title>Example usage of VT100 support enabled</title> + <programlisting role="php"> +<![CDATA[ +<?php +$out = fopen('php://stdout','w'); +fwrite($out, 'Just forgot a lettr.'); +// Moves the cursor two characters backwards +fwrite($out, " 33[2D"); +// Inserts one blank, shifting existing text to the right -> Just forgot a lett r. +fwrite($out, " 33[1@"); +fwrite($out, 'e'); +?> +]]> + </programlisting> + &example.outputs; + <screen> +<![CDATA[ +Just forgot a letter. +]]> </screen> </example> </refsect1> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89654 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89654 ------------------------------------------------------------------ -- https://edit.php.net/ This email is send automatically by the Php Docbook Online Editor.