Contributions are ready for review

From: Date: Mon, 18 Feb 2019 13:00:06 +0000
Subject: Contributions are ready for review
Groups: php.doc 
Request: Send a blank email to phpdoc+get-969387173@lists.php.net to get a copy of this message
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/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/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/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/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-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/array/functions/array-map.xml By: girgias on 2019-02-12 14:57:21 =================================================================== --- en/reference/array/functions/array-map.xml +++ en/reference/array/functions/array-map.xml @@ -15,13 +15,14 @@ <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>array1</parameter> + (and <parameter>...</parameter> if more arrays are provided) + used as arguments for 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 <function>array_map</function>. </para> </refsect1> @@ -49,7 +50,7 @@ <term><parameter>...</parameter></term> <listitem> <para> - Variable list of array arguments to run through the + Supplementary variable list of array arguments to run through the <parameter>callback</parameter> function. </para> </listitem> @@ -61,8 +62,10 @@ <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>array1</parameter> + (and <parameter>...</parameter> if more arrays are provided) + used as arguments for 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/strings/functions/sprintf.xml By: girgias on 2019-02-12 19:59:18 =================================================================== --- en/reference/strings/functions/sprintf.xml +++ en/reference/strings/functions/sprintf.xml @@ -31,140 +31,245 @@ ordinary characters (excluding <literal>%</literal>) that are copied directly to the result and <emphasis>conversion specifications</emphasis>, each of which results in fetching its - own parameter. This applies to both <function>sprintf</function> - and <function>printf</function>. + own parameter. </para> + <para> - Each conversion specification consists of a percent sign - (<literal>%</literal>), followed by one or more of these - elements, in order: - <orderedlist> - <listitem> - <simpara> - An optional <emphasis>sign specifier</emphasis> that forces a sign - (- or +) to be used on a number. By default, only the - sign is used - on a number if it's negative. This specifier forces positive numbers - to have the + sign attached as well. - </simpara> - </listitem> - <listitem> - <simpara> - An optional <emphasis>padding specifier</emphasis> that says - what character will be used for padding the results to the - right string size. This may be a space character or a - <literal>0</literal> (zero character). The default is to pad - with spaces. An alternate padding character can be specified - by prefixing it with a single quote (<literal>'</literal>). - See the examples below. - </simpara> - </listitem> - <listitem> - <simpara> - An optional <emphasis>alignment specifier</emphasis> that says - if the result should be left-justified or right-justified. - The default is right-justified; a <literal>-</literal> - character here will make it left-justified. - </simpara> - </listitem> - <listitem> - <simpara> - An optional number, a <emphasis>width specifier</emphasis> - that says how many characters (minimum) this conversion should - result in. - </simpara> - </listitem> - <listitem> + A conversion specification follows this prototype: + <literal>%[flags][width][.precision]specifier</literal>. + </para> + + <para> + <table> + <title>Flags</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Flag</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>-</literal></entry> + <entry> + Left-justify within the given field width; + Right justification is the default + </entry> + </row> + <row> + <entry><literal>+</literal></entry> + <entry> + Prefix positive numbers with a plus sign + <literal>+</literal>; Default only negative + are prefixed with a negative sign. + </entry> + </row> + <row> + <entry><literal> </literal>(space)</entry> + <entry> + Pads the result with spaces. + This is the default. + </entry> + </row> + <row> + <entry><literal>0</literal></entry> + <entry> + Only left-pads numbers with zeros. + With <literal>s</literal> specifiers this can + also right-pad with zeros. + </entry> + </row> + <row> + <entry><literal>'</literal>(char)</entry> + <entry> + Pads the result with the character (char). + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + + <formalpara> + <title>Width</title> + <para> + An integer that says how many characters (minimum) + this conversion should result in. + </para> + </formalpara> + + <formalpara> + <title>Precision</title> + <para> + A period <literal>.</literal> followed by an integer + who's meaning depends on the specifier: + <itemizedlist> + <listitem> + <simpara> + For <literal>e</literal>, <literal>E</literal>, + <literal>f</literal> and <literal>F</literal> + specifiers: this is the number of digits to be printed + after the decimal point (by default, this is 6). + </simpara> + </listitem> + <listitem> + <simpara> + For <literal>g</literal> and <literal>G</literal> + specifiers: this is the maximum number of significant + digits to be printed. + </simpara> + </listitem> + <listitem> + <simpara> + For <literal>s</literal> specifier: it acts as a cutoff point, + setting a maximum character limit to the string. + </simpara> + </listitem> + </itemizedlist> + <note> <simpara> - An optional <emphasis>precision specifier</emphasis> in the form - of a period (<literal>.</literal>) followed by an optional decimal digit string - that says how many decimal digits should be displayed for - floating-point numbers. When using this specifier on a string, - it acts as a cutoff point, setting a maximum character limit to - the string. Additionally, the character to use when padding a - number may optionally be specified between the period and the - digit. + If the period is specified without an explicit value for precision, + 0 is assumed. </simpara> - </listitem> - <listitem> - <para> - A <emphasis>type specifier</emphasis> that says what type the - argument data should be treated as. Possible types: - <simplelist> - <member> - <literal>%</literal> - a literal percent character. No - argument is required. - </member> - <member> - <literal>b</literal> - the argument is treated as an - integer and presented as a binary number. - </member> - <member> - <literal>c</literal> - the argument is treated as an - integer and presented as the character with that ASCII - value. - </member> - <member> - <literal>d</literal> - the argument is treated as an - integer and presented as a (signed) decimal number. - </member> - <member> - <literal>e</literal> - the argument is treated as scientific - notation (e.g. 1.2e+2). + </note> + </para> + </formalpara> + + <para> + <table> + <title>Specifiers</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Specifier</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>%</literal></entry> + <entry> + A literal percent character. No argument is required. + </entry> + </row> + <row> + <entry><literal>b</literal></entry> + <entry> + The argument is treated as an integer and presented + as a binary number. + </entry> + </row> + <row> + <entry><literal>c</literal></entry> + <entry> + The argument is treated as an integer and presented + as the character with that ASCII. + </entry> + </row> + <row> + <entry><literal>d</literal></entry> + <entry> + The argument is treated as an integer and presented + as a (signed) decimal number. + </entry> + </row> + <row> + <entry><literal>e</literal></entry> + <entry> + The argument is treated as scientific notation (e.g. 1.2e+2). The precision specifier stands for the number of digits after the decimal point since PHP 5.2.1. In earlier versions, it was taken as number of significant digits (one less). - </member> - <member> - <literal>E</literal> - like <literal>%e</literal> but uses + </entry> + </row> + <row> + <entry><literal>E</literal></entry> + <entry> + Like the <literal>e</literal> specifier but uses uppercase letter (e.g. 1.2E+2). - </member> - <member> - <literal>f</literal> - the argument is treated as a - float and presented as a floating-point number (locale aware). - </member> - <member> - <literal>F</literal> - the argument is treated as a - float and presented as a floating-point number (non-locale aware). - Available since PHP 5.0.3. - </member> - <member> - <literal>g</literal> - shorter of <literal>%e</literal> and - <literal>%f</literal>. - </member> - <member> - <literal>G</literal> - shorter of <literal>%E</literal> and - <literal>%F</literal>. - </member> - <member> - <literal>o</literal> - the argument is treated as an - integer and presented as an octal number. - </member> - <member> - <literal>s</literal> - the argument is treated as and - presented as a string. - </member> - <member> - <literal>u</literal> - the argument is treated as an - integer and presented as an unsigned decimal number. - </member> - <member> - <literal>x</literal> - the argument is treated as an integer - and presented as a hexadecimal number (with lowercase - letters). - </member> - <member> - <literal>X</literal> - the argument is treated as an integer - and presented as a hexadecimal number (with uppercase - letters). - </member> - </simplelist> - </para> - </listitem> - </orderedlist> + </entry> + </row> + <row> + <entry><literal>f</literal></entry> + <entry> + The argument is treated as a float and presented + as a floating-point number (locale aware). + </entry> + </row> + <row> + <entry><literal>F</literal></entry> + <entry> + The argument is treated as a float and presented + as a floating-point number (non-locale aware). + Available as of PHP 5.0.3. + </entry> + </row> + <row> + <entry><literal>g</literal></entry> + <entry> + <para> + General format. + </para> + <para> + Let P equal the precision if nonzero, 6 if the precision is omitted, + or 1 if the precision is zero. + Then, if a conversion with style E would have an exponent of X: + </para> + <para> + If P > X ≥ −4, the conversion is with style f and precision P − (X + 1). + Otherwise, the conversion is with style e and precision P − 1. + </para> + </entry> + </row> + <row> + <entry><literal>G</literal></entry> + <entry> + Like the <literal>g</literal> specifier but uses + <literal>E</literal> and <literal>F</literal>. + </entry> + </row> + <row> + <entry><literal>o</literal></entry> + <entry> + The argument is treated as an integer and presented + as an octal number. + </entry> + </row> + <row> + <entry><literal>s</literal></entry> + <entry> + the argument is treated and presented as a string. + </entry> + </row> + <row> + <entry><literal>x</literal></entry> + <entry> + The argument is treated as an integer and presented + as a hexadecimal number (with lowercase letters). + </entry> + </row> + <row> + <entry><literal>X</literal></entry> + <entry> + The argument is treated as an integer and presented + as a hexadecimal number (with uppercase letters). + </entry> + </row> + </tbody> + </tgroup> + </table> </para> + + <warning> + <para> + The <literal>c</literal> type specifier ignores padding and width + </para> + </warning> + <para> Variables will be co-erced to a suitable type for the specifier: - <table xml:id="sprintf.coercion"> + <table> <title>Type Handling</title> <tgroup cols="2"> <thead> @@ -205,11 +310,13 @@ </tgroup> </table> </para> + <warning> <para> Attempting to use a combination of the string and width specifiers with character sets that require more than one byte per character may result in unexpected results </para> </warning> + <para> The format string supports argument numbering/swapping. Here is an example: @@ -319,11 +426,6 @@ <function>sprintf</function> generating warnings. </para> </note> - <warning> - <para> - The <literal>c</literal> type specifier ignores padding and width - </para> - </warning> </listitem> </varlistentry> <varlistentry> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89713 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89713 ------------------------------------------------------------------ Modified: en/reference/win32service/constants.xml By: jbnahan on 2019-02-15 13:41:32 =================================================================== --- en/reference/win32service/constants.xml +++ en/reference/win32service/constants.xml @@ -815,6 +815,51 @@ </table> </section> + <section xml:id="win32service.constants.recovery-action"> + <table> + <title>Win32 Recovery action</title> + <tgroup cols="3"> + <thead> + <row> + <entry>Constant</entry> + <entry>Value</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row xml:id="constant.win32-sc-action-none"> + <entry><constant>WIN32_SC_ACTION_NONE</constant></entry> + <entry>0x00000000</entry> + <entry> + No action. + </entry> + </row> + <row xml:id="constant.win32-sc-action-reboot"> + <entry><constant>WIN32_SC_ACTION_REBOOT</constant></entry> + <entry>0x00000001</entry> + <entry> + Restart the server. + </entry> + </row> + <row xml:id="constant.win32-sc-action-restart"> + <entry><constant>WIN32_SC_ACTION_RESTART</constant></entry> + <entry>0x00000002</entry> + <entry> + Restart the service. + </entry> + </row> + <row xml:id="constant.win32-sc-action-run-command"> + <entry><constant>WIN32_SC_ACTION_RUN_COMMAND</constant></entry> + <entry>0x00000003</entry> + <entry> + Run an command. + </entry> + </row> + </tbody> + </tgroup> + </table> + </section> + <section xml:id="win32service.constants.serviceinfos"> <table> <title>Win32 Service informations</title> @@ -828,53 +873,137 @@ </thead> <tbody> <row xml:id="constant.win32-info-service"> - <entry><constant>Win32_INFO_SERVICE</constant></entry> + <entry><constant>WIN32_INFO_SERVICE</constant></entry> <entry>"service"</entry> <entry> </entry> </row> <row xml:id="constant.win32-info-display"> - <entry><constant>Win32_INFO_DISPLAY</constant></entry> + <entry><constant>WIN32_INFO_DISPLAY</constant></entry> <entry>"display"</entry> <entry> </entry> </row> <row xml:id="constant.win32-info-user"> - <entry><constant>Win32_INFO_USER</constant></entry> + <entry><constant>WIN32_INFO_USER</constant></entry> <entry>"user"</entry> <entry> </entry> </row> <row xml:id="constant.win32-info-password"> - <entry><constant>Win32_INFO_PASSWORD</constant></entry> + <entry><constant>WIN32_INFO_PASSWORD</constant></entry> <entry>"password"</entry> <entry> </entry> </row> <row xml:id="constant.win32-info-path"> - <entry><constant>Win32_INFO_PATH</constant></entry> + <entry><constant>WIN32_INFO_PATH</constant></entry> <entry>"path"</entry> <entry> </entry> </row> <row xml:id="constant.win32-info-params"> - <entry><constant>Win32_INFO_PARAMS</constant></entry> + <entry><constant>WIN32_INFO_PARAMS</constant></entry> <entry>"params"</entry> <entry> </entry> </row> <row xml:id="constant.win32-info-description"> - <entry><constant>Win32_INFO_DESCRIPTION</constant></entry> + <entry><constant>WIN32_INFO_DESCRIPTION</constant></entry> <entry>"description"</entry> <entry> </entry> </row> <row xml:id="constant.win32-info-start-type"> - <entry><constant>Win32_INFO_START_TYPE</constant></entry> + <entry><constant>WIN32_INFO_START_TYPE</constant></entry> <entry>"start_type"</entry> <entry> </entry> </row> + <row xml:id="constant.win32-info-load-order"> + <entry><constant>INFO_LOAD_ORDER</constant></entry> + <entry>"load_order"</entry> + <entry> + </entry> + </row> + <row xml:id="constant.win32-info-svc-type"> + <entry><constant>INFO_SVC_TYPE</constant></entry> + <entry>"svc_type"</entry> + <entry> + </entry> + </row> + <row xml:id="constant.win32-info-error-control"> + <entry><constant>INFO_ERROR_CONTROL</constant></entry> + <entry>"error_control"</entry> + <entry> + </entry> + </row> + <row xml:id="constant.win32-info-delayed-start"> + <entry><constant>INFO_DELAYED_START</constant></entry> + <entry>"delayed_start"</entry> + <entry> + </entry> + </row> + <row xml:id="constant.win32-info-base-priority"> + <entry><constant>INFO_BASE_PRIORITY</constant></entry> + <entry>"base_priority"</entry> + <entry> + </entry> + </row> + <row xml:id="constant.win32-info-dependencies"> + <entry><constant>INFO_DEPENDENCIES</constant></entry> + <entry>"dependencies"</entry> + <entry> + </entry> + </row> + <row xml:id="constant.win32-info-recovery-delay"> + <entry><constant>INFO_RECOVERY_DELAY</constant></entry> + <entry>"recovery_delay"</entry> + <entry> + </entry> + </row> + <row xml:id="constant.win32-info-recovery-action-1"> + <entry><constant>INFO_RECOVERY_ACTION_1</constant></entry> + <entry>"recovery_action_1"</entry> + <entry> + </entry> + </row> + <row xml:id="constant.win32-info-recovery-action-2"> + <entry><constant>INFO_RECOVERY_ACTION_2</constant></entry> + <entry>"recovery_action_2"</entry> + <entry> + </entry> + </row> + <row xml:id="constant.win32-info-recovery-action-3"> + <entry><constant>INFO_RECOVERY_ACTION_3</constant></entry> + <entry>"recovery_action_3"</entry> + <entry> + </entry> + </row> + <row xml:id="constant.win32-info-recovery-reset-period"> + <entry><constant>INFO_RECOVERY_RESET_PERIOD</constant></entry> + <entry>"recovery_reset_period"</entry> + <entry> + </entry> + </row> + <row xml:id="constant.win32-info-recovery-enabled"> + <entry><constant>INFO_RECOVERY_ENABLED</constant></entry> + <entry>"recovery_enabled"</entry> + <entry> + </entry> + </row> + <row xml:id="constant.win32-info-recovery-reboot-msg"> + <entry><constant>INFO_RECOVERY_REBOOT_MSG</constant></entry> + <entry>"recovery_reboot_msg"</entry> + <entry> + </entry> + </row> + <row xml:id="constant.win32-info-recovery-command"> + <entry><constant>INFO_RECOVERY_COMMAND</constant></entry> + <entry>"recovery_command"</entry> + <entry> + </entry> + </row> </tbody> </tgroup> </table> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89777 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89777 ------------------------------------------------------------------ Modified: en/reference/win32service/functions/win32-query-service-status.xml By: jbnahan on 2019-02-15 15:03:49 =================================================================== --- en/reference/win32service/functions/win32-query-service-status.xml +++ en/reference/win32service/functions/win32-query-service-status.xml @@ -83,7 +83,7 @@ <constant>WIN32_ERROR_SERVICE_SPECIFIC_ERROR</constant> if the exit mode is not gracefuly. See <link linkend="win32service.constants.errors">Win32Service error codes</link> and - <link linkend="function.win32-set-service-exit-mode"><function>win32_set_service_exit_mode</function></link> + <function>win32_set_service_exit_mode</function> </para> </listitem> </varlistentry> @@ -93,7 +93,7 @@ <para> If the service exited with an error condition, the service specific code that is logged in the event log is visible here. This value is equal - to the value defined by <link linkend="function.win32-set-service-exit-code"><function>win32_set_service_exit_code</function></link> + to the value defined by <function>win32_set_service_exit_code</function> </para> </listitem> </varlistentry> @@ -122,7 +122,7 @@ <term><parameter>ProcessId</parameter></term> <listitem> <para> - The Windows process identifier. If 0, the process is not running. + The Windows process identifier. If 0, the process is not running. </para> </listitem> </varlistentry> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89779 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89779 ------------------------------------------------------------------ Modified: en/reference/session/security.xml By: girgias on 2019-02-16 09:29:09 =================================================================== --- en/reference/session/security.xml +++ en/reference/session/security.xml @@ -7,9 +7,9 @@ External links: <link xlink:href="&url.session-fixation;">Session fixation</link> </para> <para> - HTTP session management is the core of web security. All mitigations - should be adopted to make sure sessions are secured. Developers should - also enable/use applicable security measures. + HTTP session management is the core of web security. All possible + mitigation measures SHOULD be adopted to ensure sessions are secured. + Developers should also enable/use applicable security measures. </para> <sect1 xml:id="features.session.security.management"> @@ -19,40 +19,41 @@ <title>Session Security</title> <para> - The session module cannot guarantee that the information you store - in a session is only viewed by the user who created the session. You - need to take additional measures to protect the confidentiality + The session module can NOT guarantee that the information stored + in a session is only viewed by the user who created the session. + Additional measures are needed to protect the confidentiality of the session, depending on the value associated with it. </para> <para> - Assess the importance of the data carried by your sessions and - deploy additional protections -- this usually comes at a price, - reduced convenience for the user. For example, if you want to - protect users from simple social engineering tactics, you need to - enable <literal>session.use_only_cookies</literal>. In that case, - cookies must be enabled unconditionally on the user side, or - sessions will not work. + The importance of the data carried in the session needs to be + assessed and additional protection may be deployed -- this + usually comes at a price, reduced convenience for the user. + For example, to protect users from simple social engineering + tactics, <literal>session.use_only_cookies</literal> + needs to be enabled. In that case, cookies must be enabled + unconditionally on the user side, or sessions will not work. </para> <para> There are several ways to leak an existing session ID to third - parties. e.g. JavaScript injections, session ID in URLs, packet - sniffing, physical access to device. A leaked session ID enables + parties. e.g. JavaScript injections, session IDs in URLs, packet + sniffing, physical access to the device. A leaked session ID enables the third party to access all resources which are associated with - a specific ID. First, URLs carrying session IDs. If you link to - an external site, the URL including the session ID might be + a specific ID. First, URLs carrying session IDs. + If there are links to an external site or resource, the URL + including the session ID might be stored in the external site's referrer logs. Second, a more - active attacker might listen to your network traffic. If it is + active attacker might listen to network traffic. If it is not encrypted, session IDs will flow in plain text over the - network. The solution here is to implement SSL/TLS on your server - and make it mandatory for users. HSTS should be used for better - security. + network. The solution here is to implement SSL/TLS on the server + and make it mandatory for users. + HSTS should be used for better security. </para> <note> <simpara> - Even HTTPS cannot protect confidential data at all times. + Even HTTPS can NOT protect confidential data at all times. For example the CRIME and Beast vulnerabilities may enable an attacker to read the data. Also note that there are many networks that use HTTPS MITM proxies for audit purposes. Attackers may also @@ -66,12 +67,12 @@ <title>Non-Adaptive Session Management</title> <para> - PHP's session manager is adaptive by default currently. Adaptive session manager - has additional risks. + PHP's session manager is adaptive by default currently. + An adaptive session manager has additional risks. </para> <para> - Since PHP 5.5.2, <link linkend="ini.session.use-strict-mode">session.use_strict_mode</link> + As of PHP 5.5.2, <link linkend="ini.session.use-strict-mode">session.use_strict_mode</link> is available. When it is enabled, and the session save handler supports it, an uninitialized session ID is rejected and a new session ID is created. This prevents an attack that forces users to use known session @@ -92,7 +93,8 @@ </warning> <para> - The session ID cookie could be set with domain, path, httponly and secure + The session ID cookie could be set with domain, path, httponly, secure + and, as of PHP 7.3, SameSite attributes. There is precedence defined by browsers. By using the precedence, attacker can set session ID that could be used permanently. Use of <link @@ -109,41 +111,41 @@ Even though <link linkend="ini.session.use-strict-mode">session.use_strict_mode</link> mitigates the risk of adoptive session management, attacker can force - users to use initialized session ID which is created by attacker. e.g. - JavaScript injection. This attack could be mitigated by this manual's - recommendations. + users to use an initialized session ID which is created by an attacker. + e.g. JavaScript injection. + This attack can be mitigated by this manual's recommendations. </simpara> <simpara> - If you follow this manual, you will enable <link + By following this manual developers should enable, <link linkend="ini.session.use-strict-mode">session.use_strict_mode</link>, - use time-stamp based session management, and regenerate session ID - by <function>session_regenerate_id</function> with recommended procedure. - If you do all of these, attacker generated session ID will eventually - deleted. + use time-stamp based session management, and regenerate session IDs with + <function>session_regenerate_id</function> with recommended procedure. + If developers follow all of the above, an attacker generated session ID + will eventually be deleted. </simpara> <simpara> - When obsolete session access happened, you should save all active - session data for the user. It will be useful for investigation later. - Then force the user to logout from all sessions. i.e. Require users - to re-authenticate. This way, you can prevent attackers from - keep abusing stolen sessions. + When an access to an obsolete session occurs, developers should save + all active session date of the user. As this information will be relevant + for future investigation. Users should be forcefully logged out of all + sessions, i.e. require users to re-authenticate. This prevents attackers + from abusing stolen sessions. </simpara> </note> <warning> <simpara> - Access to obsolete session data does not mean attack always. - Unstable network and/or immediate active session deletion will - cause legitimate users to use obsolete sessions. + Access to an obsolete session does not necessarily mean an attack. + Unstable network and/or immediate deletion of active session will + result in legitimate users using obsolete sessions. </simpara> </warning> <para> - Since PHP 7.1.0, <function>session_create_id</function> is added. - This function could be used to prefix session ID by user ID to - access active sessions for a user efficiently. Enabling + As of PHP 7.1.0, <function>session_create_id</function> has been added. + This function can be used to prefix the session ID with the user ID to + access active sessions of a user efficiently. Enabling <link linkend="ini.session.use-strict-mode">session.use_strict_mode</link> is very important with this setup. Otherwise, malicious users can set malicious session ID for other users. @@ -151,12 +153,12 @@ <note> <simpara> - Users prior to PHP 7.1.0 should use CSPRNG, e.g. /dev/urandom, or + Users prior to PHP 7.1.0 SHOULD use CSPRNG, e.g. /dev/urandom, or <function>random_bytes</function> and hash functions to generate - new session ID. <function>session_create_id</function> has - collision detection and generates session ID according to session - INI settings. Use of <function>session_create_id</function> is - preferred. + a new session ID. <function>session_create_id</function> has + collision detection and generates session ID according to the + session's INI settings. + Use of <function>session_create_id</function> is preferred. </simpara> </note> @@ -167,96 +169,95 @@ <para> <link linkend="ini.session.use-strict-mode">session.use_strict_mode</link> - is good mitigation, but it is not enough mitigation. Developer must use + is a good mitigation, however not sufficient. Developer must also use <function>session_regenerate_id</function> for session security. </para> <para> - Session ID regeneration reduces risk of stolen session ID, thus + Session ID regeneration reduces the risk of stolen session ID, thus <function>session_regenerate_id</function> must be called periodically. - e.g. Regenerate session ID for every 15 minutes for security - sensitive content. Even when session ID is stolen, either legitimate - user or attacker session will be expired. i.e. User or attacker access - will generate obsolete session access error. + e.g. Regenerate session ID every 15 minutes for security sensitive content. + Even if a session ID is stolen, both the legitimate user and the attacker's + session will expire. In other words access by the user or the attacker + will generate an obsolete session access error. </para> <para> - Session ID must be regenerated when user is authenticated. - <function>session_regenerate_id</function> must be called prior to - set authentication information to $_SESSION. (Since PHP 7.0.0, + Session ID must be regenerated when user privileges are elevated, + such as authenticating. + <function>session_regenerate_id</function> MUST be called prior to + setting authentication information to $_SESSION. (As of PHP 7.0.0, <function>session_regenerate_id</function> saves current session - data automatically in order to save time-stamp/etc to current session.) - Make sure only new session contains authenticated flag. + data automatically in order to save timestamp/etc to current session.) + Ensure only new the session contains the authenticated flag. </para> <para> - Developer must NOT rely on session ID expiration by <link + Developer MUST NOT rely on session ID expiration by <link linkend="ini.session.gc-maxlifetime">session.gc_maxlifetime</link>. - Attackers may access victim's session ID periodically to prevent - expiration and keep exploiting victim's session ID including - authenticated sessions. + Attackers may access a victim's session ID periodically to prevent + expiration and keep exploiting the victim's session ID including + an authenticated sessions. </para> <para> - Instead, you must implement time-stamp based session data management - by yourself. + Instead, developers must implement timestamp based session data management. </para> <warning> <simpara> - Although session manager can manage time-stamp transparently, but this - feature is not implemented. Old session data must be kept until - GC. At the same time, developers must make sure obsolete session data - is removed. However, developers must NOT remove active session data - immediately. - i.e. Never call <literal>session_regenerate_id(true);</literal> - and <function> session_destroy</function> for active session. - This may sound contradictory, but this is the mandatory requirement. + Although the session manager can manage timestamp transparently, this + feature is not implemented. Old session data must be kept until GC. + At the same time, developers must assure themselves obsolete session data + is removed. However, developers must NOT remove active session data immediately. + i.e. <literal>session_regenerate_id(true);</literal> and + <function>session_destroy</function> must never be called together for active session. + This may sound contradictory, but this is a mandatory requirement. </simpara> </warning> <para> - <function>session_regenerate_id</function> does not delete - old session by default. Old authenticated session may be available + <function>session_regenerate_id</function> does NOT delete + old sessions by default. Old authenticated session may be available for use. Developers must prevent old session to be used by anyone, - must prohibit access to obsolete session data by themselves using - time-stamp. + they must prohibit access to obsolete session data by themselves using + timestamps. </para> <warning> <simpara> - Immediate active session removal has unwanted side effects. - Session could be vanished when there are concurrent connections - to web application and/or network is unstable. + The immediate removal of active session has unwanted side effects. + Sessions can vanish when there are concurrent connections + to the web application and/or the network is unstable. </simpara> <simpara> - Possibly malicious access cannot be detected with immediate active - session removal also. + Potential malicious access can also not be detected with immediate removal + of active sessions. </simpara> <simpara> - Instead of deleting old session immediately, you must set short term - expiration time (time-stamp) in $_SESSION, and prohibit access to - the session data by yourself. + Instead of deleting old session immediately, developers must set + a short term expiration time (timestamp) in $_SESSION, + and prohibit access to the session data by themselves. </simpara> <simpara> - You must not prohibit access to old session data immediately after - <function>session_regenerate_id</function>. It must be prohibited - a little later. e.g. A few seconds later for stable wired network. - A few minutes later for unstable network such as mobile or WiFi. + Developers must not prohibit access to old session data immediately after + <function>session_regenerate_id</function>. It must be prohibited at a + later stage, e.g. a few seconds later for stable wired networks and a few + minutes later for unstable networks such as cell phones or Wi-Fi. </simpara> <simpara> - If user accesses to obsolete session(expired session), - deny access to it. It is recommended to remove authenticated status - from all of the users' session because it is likely an attack. + If a user accesses an obsolete session (expired session), access to it + should be denied. It is also recommended to remove the authenticated status + from all of the user's sessions as it is likely to be an attack. </simpara> </warning> <para> Proper use of <link linkend="ini.session.use-only-cookies">session.use_only_cookies</link> - and <function>session_regenerate_id</function> could cause personal - DoS by undeletable cookies set by attackers. When this is the case, - you may ask users to remove cookies and warn users that there could - be possible security issues. Attackers may set malicious cookies via + and <function>session_regenerate_id</function> can cause personal + DoS with undeletable cookies set by attackers. In this case, developers + may ask users to remove cookies and warn them that they may be affected + by a security issue. Attackers may set malicious cookies via vulnerable web application, vulnerable/malicious browser plugins, physically compromised device, etc. </para> @@ -285,38 +286,39 @@ </para> <para> - Obsolete session data is better to be removed as soon as possible. + Obsolete session data SHOULD to be removed as soon as possible. However, active sessions MUST NOT be removed immediately. To satisfy - these requirements, you MUST implement time-stamp based session - data management by yourself. + those requirements, developers MUST implement timestamp based session + data management by themselves. </para> <para> - Set and manage expiration time-stamp in $_SESSION. Prohibit access - to obsolete session data. When obsolete session data access is detected, + Set and manage expiration timestamp in $_SESSION. Prohibit access + to obsolete session data. When access of obsolete session data is detected, it is advised to remove all authenticated status from the user's sessions - and force them to re-authenticated. Obsolete session data access could be - an attack. To do this, you must keep track active sessions per user. + and force them to re-authenticated. Access to obsolete session data can be + an attack. To achieve this, developers must keep track of all active session + of every user. </para> <note> <simpara> - Access to obsolete session could happen by unstable network and/or - concurrent access to web site also. Server tried to set new session - ID via cookie, but Set-Cookie packet may not be reached to client due to - lost connection. One connection may issue new session ID by - <function>session_regenerate_id</function>, but another conncurrent - connection may not get the new session ID yet. - Therefore, you must prohibit access to obsolete session a while later. - i.e. Time-stamp based session management is mandatory. + Access to an obsolete session can also happen because of an unstable network + and/or concurrent access to web site. The server tried to set a new session + ID via a cookie, but the Set-Cookie packet may not have reached the client due to + loss of connection. One connection may issue new session ID by + <function>session_regenerate_id</function>, but another concurrent + connection may not have received the new session ID yet. + Therefore, developers must prohibit access to obsolete session at a later stage. + i.e. Timestamp based session management is mandatory. </simpara> </note> <para> - In short, do not destroy session data by <function>session_regenerate_id</function> - nor <function>session_destroy</function>, but use time-stamp to control - access to session data. Let <function>session_gc</function> to remove - obsolete data from session data storage. + In short, session data must not be destroyed with <function>session_regenerate_id</function> + nor <function>session_destroy</function>, but timestamps must be used to control + access to session data. Let <function>session_gc</function> remove obsolete data + from the session data storage. </para> </sect2> @@ -325,24 +327,24 @@ <title>Session and Locking</title> <para> - Session data is locked to avoid races by default. Locking is mandatory + Session data is locked to avoid race conditions by default. Locking is mandatory to keep session data consistent across requests. </para> <para> - However, locking can be abused by attacker to perform DoS attacks. To - mitigate risks of DoS by session lock, minimize lock. Use read - only sessions when session data update is not required. - Use 'read_and_close' option with <function>session_start</function>. + However, session locking can be abused by attackers to perform DoS attacks. + To mitigate risks of DoS by session locking, minimize locks. + Use read only sessions when session data does not need to be updated. + Use the 'read_and_close' option with <function>session_start</function>. <literal>session_start(['read_and_close'=>1]);</literal> - Close session as soon as you finish updating $_SESSION by + Close the session as soon as possible after updating $_SESSION by using <function>session_commit</function>. </para> <para> Current session module does not detect $_SESSION modification while - session is inactive. It is your responsibility not to modify $_SESSION - when session is inactive. + the session is inactive. It is the developers responsibility + not to modify $_SESSION when the session is inactive. </para> </sect2> @@ -351,30 +353,30 @@ <title>Active Sessions</title> <para> - Developers should keep track active sessions per user and notify the user - how many active sessions, from which IP (and area), how long is active, etc. - PHP does not keep track these. You are supposed to do so. + Developers should keep track of all active sessions for every user and notify the user + of how many active sessions, from which IP (and area), how long it has been active, etc. + PHP does not keep track of these. Developers are supposed to do so. </para> <para> - There are number of ways for the implementation. You may setup a - database that keeps track required data and store information - to it. Since session data is GCed, you have to take care of GCed data + There exist various ways to implement this. On implementation is setting up a + database that keeps track of the required data and stores relevant information. + Since session data is GCed, developers must take care of GCed data to maintain the active session database consistency. </para> <para> One of the simplest implementation is "User ID prefixed session ID" and store required information to $_SESSION. Many databases have good - performance for selecting string prefix. You can use + performance for selecting string prefix. Developers can use <function>session_regenerate_id</function> and <function>session_create_id</function> for this. </para> <warning> <simpara> - Never use confidential data as prefix. If user ID is confidential, - consider to use <function>hash_hmac</function>. + Never use confidential data as a prefix. If the user ID is confidential, + consider using <function>hash_hmac</function>. </simpara> </warning> @@ -387,10 +389,10 @@ </warning> <para> - Time-stamp based session management is mandatory to detect obsolete session - access. When access to obsolete session is detected, you should remove authentication - flags from all of active sessions for the user. This prevents attackers to - keep exploiting stolen session. + Timestamp based session management is mandatory to detect obsolete session access. + When access to an obsolete session is detected, authentication flags should be + removed from all active sessions of the user. + This prevents attackers to keep exploiting stolen session. </para> </sect2> @@ -399,46 +401,45 @@ <title>Session and Auto Login</title> <para> - Developers must NOT use long life session ID for auto login because it - increases risk of stolen session. Auto login should be implemented - by developer. + Developers must NOT use long life session IDs for auto login because it + increases the risk of stolen sessions. An auto login feature should be + implemented by the developer. </para> <para> - Use secure one time hash key as auto login key using - <function>setcookie</function>. Use secure hash stronger than SHA-2. + Use secure one time hash key as an auto login key using + <function>setcookie</function>. Use a secure hash stronger than SHA-2. e.g. SHA-256 or greater with random data from <function>random_bytes</function> or /dev/urandom. </para> <para> - If user is not authenticated, check the one time auto login key is - valid or not. If key is valid, authenticate user and set new secure - one time hash key. Auto login key must be able to be used - only once. i.e. Never reuse auto login key, generate new auto login key - always. + If the user is not authenticated, check if the one time auto login key is + valid or not. If key is valid, authenticate the user and set a new secure + one time hash key. An auto login key MUST only be used once, + i.e. never reuse an auto login key, always generate a new auto login key. </para> <para> - Auto login key is long life authentication key, this key should be - protected as much as possible. Use path/httponly/secure - cookie attributes to protect. i.e. Never transmit auto login key + An auto login key is a long life authentication key, this key should be + protected as much as possible. Use path/httponly/secure/SameSite + cookie attributes to protect it. i.e. Never transmit the auto login key unless it is required. </para> <para> - Developer must implement feature that disables auto login and removes + Developer must implement the features that disables auto login and removes unneeded auto login key cookie. </para> </sect2> <sect2 xml:id="features.session.security.management.csrf"> - <title>CSRF(Cross Site Request Forgeries)</title> + <title>CSRF (Cross Site Request Forgeries)</title> <para> - Session and authentication does not protect against CSRF attack. Developers - must implement CSRF protection by themselves. + Session and authentication does not protect against CSRF attack. + Developers must implement CSRF protection by themselves. </para> <para> @@ -450,15 +451,20 @@ <simpara> PHP prior to 7.2.0 uses the same output buffer and INI setting as trans sid. Therefore, use of <function>output_add_rewrite_var</function> - with PHP prior to 7.2.0 is not recommended. + with PHP prior to version 7.2.0 is not recommended. </simpara> </note> <para> - Most web application frameworks support CSRF protection. Refer - to your web application framework manual for details. + Most web application frameworks support CSRF protection. + Refer to the web application framework manual for details. </para> + <para> + As of PHP 7.3 the SameSite attribute for the session cookie + can be set. This is an additional measure which can mitigate + CSRF vulnerabilities. + </para> </sect2> </sect1> @@ -466,9 +472,9 @@ <title>Securing Session INI Settings</title> <para> - By securing session related INI settings, you can improve session security. - Some of important INI settings do not have recommended settings. You - are responsible to hardening session settings. + By securing session related INI settings, developers can improve session security. + Some important INI settings do not have recommended settings. + Developers are responsible to hardening session settings. </para> <itemizedlist> @@ -477,15 +483,18 @@ <link linkend="ini.session.cookie-lifetime">session.cookie_lifetime</link>=0 </para> <para> - 0 have special meaning. It tells browsers not to store cookie to - permanent storage. Therefore, when browser is terminated, session - ID cookie is deleted immediately. If developer set other than 0, it may - allow other users to use the session ID. Most applications should - use "0" for this. + <literal>0</literal> has a special meaning. + It tells browsers not to store the cookie to permanent storage. + Therefore, when the browser is terminated, the session + ID cookie is deleted immediately. If developer set this other than 0, it may + allow other users to use the session ID. + Most applications should use "<literal>0</literal>" for this. </para> <para> - If auto login feature is required, implement your own secure auto login - feature. Do not use long life session ID for it. + If an auto login feature is required, developers must implement their own secure + auto login feature. + Do not use long life session ID for it. + More information can be founded above in the relevant section. </para> </listitem> @@ -497,15 +506,15 @@ <link linkend="ini.session.use-only-cookies">session.use_only_cookies</link>=On </para> <para> - Although HTTP cookie has some problems, cookie is preferred way to - manage session ID. Use only cookies for session ID management when - it is possible. Most applications should use cookie for session - ID. + Although HTTP cookies have some problems, cookies are the preferred way to + manage session IDs. Only use cookies for session ID management when + it is possible. + Most applications should use cookie for session ID. </para> <para> If <literal>session.use_only_cookies</literal>=Off, session module will use session ID values set by GET/POST/URL when - session ID cookie is not initialized already. + the session ID cookie is not initialized already. </para> </listitem> @@ -520,22 +529,23 @@ <para> This prevents session module to use uninitialized session ID. In other word, session module only accepts valid session ID generated - by session module. It rejects session ID supplied by - users. + by session module. + It rejects session ID supplied by users. </para> <para> - Because of cookie spec, attackers are able to set undeletable session ID + Because of the cookie specification, + attackers are able to set undeletable session ID cookies via locally setting cookie database or JavaScript injections. <literal>session.use_strict_mode</literal> can prevent attacker initialized session ID being used. </para> <note> <para> - Attackers may initialize session ID by their device and may set the - session ID to victim. They must keep the session ID active to abuse. + Attackers may initialize session ID with their device and may set the + session ID of the victim. They must keep the session ID active to abuse. Attackers require additional steps to perform attack with this attack scenario. Therefore, <literal>session.use_strict_mode</literal> works - as the mitigation. + as a mitigation. </para> </note> </listitem> @@ -545,11 +555,11 @@ <link linkend="ini.session.cookie-httponly">session.cookie_httponly</link>=On </para> <para> - Disallow access to session cookie by JavaScript. This setting + Disallow access to the session cookie by JavaScript. This setting prevents cookies stolen by JavaScript injection. </para> <para> - It is possible to use session ID as CSRF protection key, but this is not + It is possible to use session ID as a CSRF protection key, but this is not recommended. For example, HTML source may be saved and sent to other users. Developer should not write session ID in web pages for better security. Almost all applications must use httponly attribute for @@ -568,17 +578,15 @@ <link linkend="ini.session.cookie-secure">session.cookie_secure</link>=On </para> <para> - Allows access to session ID cookie only when protocol is HTTPS. If - your web site is HTTPS only web site, you must enable this - setting. + Allows access to session ID cookie only when protocol is HTTPS. + If a web site is an HTTPS only web site, it SHOULD enable this setting. </para> <para> HSTS should be considered for HTTPS only web site. </para> <para> - Allows access to session ID cookie only when protocol is HTTPS. If - your web site is HTTPS only web site, you must enable this - setting. + Allows access to session ID cookie only when the protocol is HTTPS. + If a web site is an HTTPS only web site, it SHOULD enable this setting. </para> </listitem> @@ -589,7 +597,7 @@ <link linkend="ini.session.cookie-samesite">session.cookie_samesite</link>="Strict" </para> <para> - As of PHP 7.3 you can set the <literal>"samesite"</literal> cookie flag for + As of PHP 7.3 the <literal>"samesite"</literal> cookie flag can be set for the session ID cookie. This flag is a way to mitigate CSRF (Cross Site Request Forgery) attacks. </para> @@ -607,26 +615,27 @@ </para> <para> <literal>session.gc_maxlifetime</literal> - is setting for deleting obsolete session ID. Reliance on this setting - is NOT recommend. You should manage session life time by time-stamp - by yourself. + is a setting for deleting obsolete session ID. Reliance on this setting + is NOT recommended. Developers should manage session life time by timestamp + by themselves. </para> <para> - Session GC(garbage collection) is better to be performed by <function>session_gc</function>. - <function>session_gc</function> function is better to be executed by task + Session GC (garbage collection) is best performed by using <function>session_gc</function>. + The <function>session_gc</function> function should be executed by a task managers. e.g. cron on UNIX like systems. </para> <para> GC is performed by probability by default. This setting does not - guarantee old session deletion. Although developer cannot rely - on this setting, setting this to smallest possible value is + guarantee old session deletion. Although developer can not rely + on this setting, setting this to the smallest possible value is recommended. Adjust <link linkend="ini.session.gc-probability">session.gc_probability</link> and <link linkend="ini.session.gc-divisor">session.gc_divisor</link> so - that obsolete sessions are deleted by appropriate frequency. If - auto login feature is required, implement your own secure auto - login feature. Never use long life session ID for it. + that obsolete sessions are deleted at an appropriate frequency. + If an auto login feature is required, developers must implement + their own secure auto login feature, see above for more information. + Never use long life session ID for this feature. </para> <note> <para> @@ -642,15 +651,14 @@ <link linkend="ini.session.use-trans-sid">session.use_trans_sid</link>=Off </para> <para> - Use of transparent session ID management is not prohibited. You - may use it when it is needed. However, disabling transparent - session ID management would improve general session ID security by - removing possibility of session ID injection and session ID leak. + Use of a transparent session ID management is not prohibited. + Developers may use it when it is needed. However, disabling transparent + session ID management improves general session ID security by + removing the possibility of a session ID injection and a session ID leak. </para> <note> <para> - Session ID may leak from bookmarked URL, e-mailed URL, saved HTML - source. + Session ID may leak from bookmarked URL, e-mailed URL, saved HTML source. </para> </note> </listitem> @@ -660,9 +668,10 @@ <link linkend="ini.session.trans-sid-tags">session.trans_sid_tags</link>=[limited tags] </para> <para> - (PHP 7.1.0 &gt;=) You should not rewrite unneeded HTML tags. Default - would be good enough for most usage. Older PHP uses - <link linkend="ini.url-rewriter.tags">url_rewriter.tags</link> for this. + (PHP 7.1.0 &gt;=) Developers should not rewrite unneeded HTML tags. + Default value should be sufficient for most usages. + Older PHP versions use + <link linkend="ini.url-rewriter.tags">url_rewriter.tags</link> for this. </para> </listitem> @@ -679,18 +688,18 @@ <listitem> <para> - <link linkend="ini.session.referer-check">session.referer_check</link>=[your originating URL] + <link linkend="ini.session.referer-check">session.referer_check</link>=[originating URL] </para> <para> When <link linkend="ini.session.use-trans-sid">session.use_trans_sid</link> is enabled. - It reduces risk of session ID injection. If your site is - http://example.com/, set http://example.com/ to it. Note that when - HTTPS is used the browser will not send the referrer header. Browsers may - not send the referrer header by configuration. Use of this - setting is recommended Therefore, this setting - is not reliable security measure. + It reduces the risk of session ID injection. If a website is + http://example.com/, set http://example.com/ to it. + Note that when HTTPS is used the browser will not send the referrer header. + Browsers may not send the referrer header by configuration. + Use of this setting is recommended. + Therefore, this setting is not a reliable security measure. </para> </listitem> @@ -699,11 +708,11 @@ <link linkend="ini.session.cache-limiter">session.cache_limiter</link>=nocache </para> <para> - Make sure HTTP contents are not cached for authenticated - session. Allow caching only when contents are not private. + Make sure HTTP contents are not cached for authenticated session. + Allow caching only when contents are not private. Otherwise, contents may be exposed. "private" may be used - if HTTP content does not include security sensitive data. Note - that "private" may leave private data cached by shared + if HTTP content does not include security sensitive data. + Note that "private" may leave private data cached by shared clients. "public" may be used only when HTTP content does not contain any private data at all. </para> @@ -714,9 +723,9 @@ <link linkend="ini.session.sid-length">session.sid_length</link>="48" </para> <para> - (PHP 7.1.0 &gt;=) Longer session ID results in stronger session - ID. Developer should consider session ID length 32 chars or more. At - least 26 chars is required when + (PHP 7.1.0 &gt;=) Longer session ID results in stronger session ID. + Developer should consider a session ID length of 32 characters or more. + At least 26 characters are required when <link linkend="ini.session.sid-bits-per-character">session.sid_bits_per_character</link>="5". </para> </listitem> @@ -726,8 +735,9 @@ <link linkend="ini.session.sid-bits-per-character">session.sid_bits_per_character</link>="6" </para> <para> - (PHP 7.1.0 &gt;=) The more bits in a session ID char, session module - generates stronger session ID for the same session ID length. + (PHP 7.1.0 &gt;=) The more bits are in a session ID character, + the stronger the session ID generated by the session module + is for an identical session ID length. </para> </listitem> @@ -737,11 +747,12 @@ </para> <para> (PHP 7.1.0 &lt;) Stronger hash function will generates stronger session - ID. Although hash collision is unlikely even with MD5 hash, developers - should use SHA-2 or stronger hash functions for the task. Developers may - use stronger hashes like sha384 and sha512. Make sure you feed long - enough <link linkend="ini.session.entropy-length">entropy</link> for - the hash function used. + ID. Although hash collision is unlikely even with the MD5 hashing algorithm, + developers should use SHA-2 or a stronger hashing functions for this task. + Developers may use stronger hashing algorithms such as sha384 and sha512. + Developers must ensure they feed a long enough + <link linkend="ini.session.entropy-length">entropy</link> + for the hashing function used. </para> </listitem> @@ -770,4 +781,3 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> - => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89780 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89780 ------------------------------------------------------------------ Modified: en/reference/reflection/reflectionclass/getconstant.xml By: Florian Berberich on 2019-02-17 03:01:51 =================================================================== --- en/reference/reflection/reflectionclass/getconstant.xml +++ en/reference/reflection/reflectionclass/getconstant.xml @@ -29,7 +29,7 @@ <term><parameter>name</parameter></term> <listitem> <para> - Name of the constant. + The name of the class constant to get. </para> </listitem> </varlistentry> @@ -40,7 +40,43 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Value of the constant. + Value of the constant with the name <parameter>name</parameter>. + </para> + <para> + Returns &false; if the constant was not found in the class. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>Usage of <methodname>ReflectionClass::getConstant</methodname></title> + <programlisting role="php"> +<![CDATA[ +<?php + +class Example { + const C1 = false; + const C2 = 'I am a constant'; +} + +$reflection = new ReflectionClass('Example'); + +var_dump($reflection->getConstant('C1')); +var_dump($reflection->getConstant('C2')); +var_dump($reflection->getConstant('C3')); +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +bool(false) +string(15) "I am a constant" +bool(false) +]]> + </screen> + </example> </para> </refsect1> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89785 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89785 ------------------------------------------------------------------ Modified: en/reference/reflection/reflectionclass/getdoccomment.xml By: Florian Berberich on 2019-02-17 03:08:18 =================================================================== --- en/reference/reflection/reflectionclass/getdoccomment.xml +++ en/reference/reflection/reflectionclass/getdoccomment.xml @@ -14,11 +14,11 @@ <void /> </methodsynopsis> <para> - Gets doc comments from a class. + Gets doc comments from a class. Doc comments start with /**. + If there are multiple doc comments above the class definition, + the one closest to the class will be taken. </para> - &warn.undocumented.func; - </refsect1> <refsect1 role="parameters"> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89788 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89788 ------------------------------------------------------------------ Modified: en/reference/reflection/reflectionclass/getmodifiers.xml By: Florian Berberich on 2019-02-17 03:35:34 =================================================================== --- en/reference/reflection/reflectionclass/getmodifiers.xml +++ en/reference/reflection/reflectionclass/getmodifiers.xml @@ -31,12 +31,113 @@ modifier constants</link>. </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>7.2.0</entry> + <entry> + The returned bitfield now only consists on the value of the + <link linkend="reflectionclass.constants.modifiers">modifier constants.</link> + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><methodname>ReflectionClass::getModifiers</methodname> example</title> + <programlisting role="php"> +<![CDATA[ +<?php + +trait Trait1 { + +} + +trait Trait2 { + abstract function abstract1(); +} + +interface Interface1 { + +} + +interface Interface2 { + function abstract2(); +} + +abstract class Abstract1 { + +} + +abstract class Abstract2 { + abstract function abstract3(); +} + +class Class1 { + +} + +final class Class2 { + +} + +$refTrait1 = new ReflectionClass('Trait1'); +$refTrait2 = new ReflectionClass('Trait2'); // implicit abstract +$refInterface1 = new ReflectionClass('Interface1'); +$refInterface2 = new ReflectionClass('Interface2'); // implicit abstract +$refAbstract1 = new ReflectionClass('Abstract1'); // explicit abstract +$refAbstract2 = new ReflectionClass('Abstract2'); // implicit and explicit abstract +$refClass1 = new ReflectionClass('Class1'); +$refClass2 = new ReflectionClass('Class2'); // final + +var_dump($refTrait1->getModifiers()); +var_dump($refTrait2->getModifiers()); +var_dump($refInterface1->getModifiers()); +var_dump($refInterface2->getModifiers()); +var_dump($refAbstract1->getModifiers()); +var_dump($refAbstract2->getModifiers()); +var_dump($refClass1->getModifiers()); +var_dump($refClass2->getModifiers()); +]]> + </programlisting> + &example.outputs; + <screen> +<![CDATA[ +int(0) +int(16) +int(0) +int(16) +int(32) +int(48) +int(0) +int(4) +]]> + </screen> + </example> + </para> + </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><methodname>ReflectionClass::getProperties</methodname></member> <member><methodname>Reflection::getModifierNames</methodname></member> </simplelist> </para> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89789 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89789 ------------------------------------------------------------------ Modified: en/reference/reflection/reflectionclass/isiterateable.xml By: Florian Berberich on 2019-02-17 03:36:25 =================================================================== --- en/reference/reflection/reflectionclass/isiterateable.xml +++ en/reference/reflection/reflectionclass/isiterateable.xml @@ -14,9 +14,21 @@ <void /> </methodsynopsis> <para> - Checks whether the class is iterateable. + Checks whether the class implements the interface <interfacename>Traversable</interfacename>. </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <title>Alias of <methodname>ReflectionClass::isIterable</methodname></title> + <simpara> + Since PHP 7.2.0 this method is an alias of <methodname>ReflectionClass::isIterable</methodname>. + For the behavior of this method since PHP 7.2.0 visit + <linked link="reflectionclass.isiterable">ReflectionClass::isIterable</linked> + </simpara> + </note> + </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -29,6 +41,31 @@ &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>7.2.0</entry> + <entry> + This method is now an alias of <linked link="reflectionclass.isiterable"> + ReflectionClass::isIterable</linked> + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> <refsect1 role="examples"> &reftitle.examples; @@ -39,7 +76,7 @@ <![CDATA[ <?php -class IteratorClass implements Iterator { +abstract class IteratorClass implements Iterator { public function __construct() { } public function key() { } public function current() { } => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89790 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89790 ------------------------------------------------------------------ Modified: en/reference/reflection/reflectionclass.xml By: Florian Berberich on 2019-02-17 03:37:49 =================================================================== --- en/reference/reflection/reflectionclass.xml +++ en/reference/reflection/reflectionclass.xml @@ -2,13 +2,13 @@ <!-- $Revision: 321705 $ --> <phpdoc:classref xml:id="class.reflectionclass" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"> - + <title>The ReflectionClass class</title> <titleabbrev>ReflectionClass</titleabbrev> - + <partintro> - -<!-- {{{ ReflectionClass intro --> + + <!-- {{{ ReflectionClass intro --> <section xml:id="reflectionclass.intro"> &reftitle.intro; <para> @@ -16,16 +16,16 @@ information about a class. </para> </section> -<!-- }}} --> - + <!-- }}} --> + <section xml:id="reflectionclass.synopsis"> &reftitle.classsynopsis; - -<!-- {{{ Synopsis --> + + <!-- {{{ Synopsis --> <classsynopsis> <ooclass><classname>ReflectionClass</classname></ooclass> - -<!-- {{{ Class synopsis --> + + <!-- {{{ Class synopsis --> <classsynopsisinfo> <ooclass> <classname>ReflectionClass</classname> @@ -35,7 +35,7 @@ <interfacename>Reflector</interfacename> </oointerface> </classsynopsisinfo> -<!-- }}} --> + <!-- }}} --> <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo> <fieldsynopsis> <modifier>const</modifier> @@ -53,25 +53,25 @@ <modifier>const</modifier> <type>integer</type> <varname linkend="reflectionclass.constants.is-final">ReflectionClass::IS_FINAL</varname> - <initializer>64</initializer> + <initializer>4</initializer> </fieldsynopsis> - + <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo> <fieldsynopsis> <modifier>public</modifier> <varname linkend="reflectionclass.props.name">name</varname> </fieldsynopsis> - + <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo> <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.reflectionclass')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" /> </classsynopsis> -<!-- }}} --> - + <!-- }}} --> + </section> - -<!-- {{{ ReflectionClass properties --> + + <!-- {{{ ReflectionClass properties --> <section xml:id="reflectionclass.props"> &reftitle.properties; <variablelist> @@ -86,36 +86,39 @@ </varlistentry> </variablelist> </section> -<!-- }}} --> - + <!-- }}} --> -<!-- {{{ ReflectionClass constants --> + + <!-- {{{ ReflectionClass constants --> <section xml:id="reflectionclass.constants"> &reftitle.constants; <section xml:id="reflectionclass.constants.modifiers"> <title>ReflectionClass Modifiers</title> <variablelist> - + <varlistentry xml:id="reflectionclass.constants.is-implicit-abstract"> <term><constant>ReflectionClass::IS_IMPLICIT_ABSTRACT</constant></term> <listitem> <para> - Indicates class that is <link linkend="language.oop5.abstract"> - abstract</link> because it has some abstract methods. + Indicates class is <link linkend="language.oop5.abstract"> + abstract</link> because it has some abstract methods. This may + also be true for interfaces and traits that containt abstract + methods. </para> </listitem> </varlistentry> - + <varlistentry xml:id="reflectionclass.constants.is-explicit-abstract"> <term><constant>ReflectionClass::IS_EXPLICIT_ABSTRACT</constant></term> <listitem> <para> - Indicates class that is <link linkend="language.oop5.abstract"> - abstract</link> because of its definition. + Indicates class is <link linkend="language.oop5.abstract"> + abstract</link> because of its definition. This is only true for + abstract classes. </para> </listitem> </varlistentry> - + <varlistentry xml:id="reflectionclass.constants.is-final"> <term><constant>ReflectionClass::IS_FINAL</constant></term> <listitem> @@ -125,17 +128,72 @@ </para> </listitem> </varlistentry> - + </variablelist> </section> </section> -<!-- }}} --> - - + <!-- }}} --> + + <section role="changelog" xml:id="reflectionclass.changelog"><!-- {{{ --> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>7.2.0</entry> + <entry> + Added method: <methodname>isIterable</methodname>. + <methodname>isIterateable</methodname> is now an alias of + the new method. + </entry> + </row> + <row> + <entry>7.1.0</entry> + <entry> + Added methods: <methodname>getReflectionConstant</methodname> + and <methodname>getReflectionConstants</methodname>. + </entry> + </row> + <row> + <entry>7.0.0</entry> + <entry> + The value of <constant>ReflectionClass::IS_FINAL</constant> + changed from 64 to 4. + </entry> + </row> + <row> + <entry>7.0.0</entry> + <entry> + Added method: <methodname>isAnonymous</methodname> + </entry> + </row> + <row> + <entry>5.4.0</entry> + <entry> + Added methods: <methodname>isCloneable</methodname>, + <methodname>newInstanceWithoutConstructor</methodname>, + <methodname>getTraits</methodname>, <methodname> + getTraitNames</methodname>, <methodname>getTraitAliases + </methodname> and <methodname>isTrait</methodname>. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </section><!-- }}} --> + </partintro> - + &reference.reflection.entities.reflectionclass; - + </phpdoc:classref> <!-- Keep this comment at the end of the file => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89783 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89783 ------------------------------------------------------------------ Modified: en/reference/reflection/reflectionclass/isiterable.xml By: Florian Berberich on 2019-02-17 03:41:52 =================================================================== --- en/reference/reflection/reflectionclass/isiterable.xml +++ en/reference/reflection/reflectionclass/isiterable.xml @@ -13,6 +13,10 @@ <modifier>public</modifier> <type>bool</type><methodname>ReflectionClass::isIterable</methodname> <void /> </methodsynopsis> + <para> + Checks whether the class implements the interface <interfacename>Traversable</interfacename> + and is actually iterable. Therefore abstract classes are not iterable. + </para> </refsect1> <refsect1 role="parameters"> @@ -23,12 +27,56 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns &true; if this class is iterable (can be used inside &foreach;), - &false; otherwise. + &return.success; </para> </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><methodname>ReflectionClass::isIterable</methodname> example</title> + <programlisting role="php"> +<![CDATA[ +<?php + +abstract class IteratorClass implements Iterator { + public function __construct() { } + public function key() { } + public function current() { } + function next() { } + function valid() { } + function rewind() { } +} +class DerivedClass extends IteratorClass { } +class NonIterator { } +function dump_iterateable($class) { + $reflection = new ReflectionClass($class); + var_dump($reflection->isIterateable()); +} + +$classes = array("ArrayObject", "IteratorClass", "DerivedClass", "NonIterator"); + +foreach ($classes as $class) { + echo "Is $class iterateable? "; + dump_iterateable($class); +} +?> +]]> + </programlisting> + &example.outputs; + <screen> +<![CDATA[ +Is ArrayObject iterateable? bool(true) +Is IteratorClass iterateable? bool(false) +Is DerivedClass iterateable? bool(true) +Is NonIterator iterateable? bool(false) +]]> + </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=89791 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89791 ------------------------------------------------------------------ Modified: en/reference/strings/functions/strrpos.xml By: Florian Berberich on 2019-02-17 05:52:29 =================================================================== --- en/reference/strings/functions/strrpos.xml +++ en/reference/strings/functions/strrpos.xml @@ -41,10 +41,15 @@ <varlistentry> <term><parameter>offset</parameter></term> <listitem> + <para> + If specified and positive, the search will stop this number of characters + counted from the beginning of the string, starting at the string's last + character. + </para> <para> - If specified, search will start this number of characters counted from the - beginning of the string. If the value is negative, search will instead start - from that many characters from the end of the string, searching backwards. + If specified and negative, the search will start looking for the needle + at the given position from the end of the string, stopping at the + string's frist character. </para> </listitem> </varlistentry> @@ -56,8 +61,7 @@ &reftitle.returnvalues; <para> Returns the position where the needle exists relative to the beginning of - the <parameter>haystack</parameter> string (independent of search direction - or offset). + the <parameter>haystack</parameter> string (independent of the offset). Also note that string positions start at 0, and not 1. </para> <para> @@ -130,6 +134,12 @@ // string. Result: int(27) var_dump(strrpos($foo, '7', 28)); // Result: bool(false) + +var_dump(strrpos($foo, 'c', -2)); // Result: bool(false) as the needle can + // not start two characters from the right + +var_dump(strrpos($foo, '9c', -2)); // Result: int(29) as the needle starts + // two characters from the right ?> ]]> </programlisting> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89795 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89795 ------------------------------------------------------------------ Modified: en/reference/win32service/functions/win32-create-service.xml By: jbnahan on 2019-02-18 00:50:34 =================================================================== --- en/reference/win32service/functions/win32-create-service.xml +++ en/reference/win32service/functions/win32-create-service.xml @@ -14,7 +14,7 @@ <methodparam choice="opt"><type>string</type><parameter>machine</parameter></methodparam> </methodsynopsis> <para> - Attempts to add a service into the SCM database. Administrative + Attempts to add a service into the SCM database. Administrative privileges are required for this to succeed. </para> </refsect1> @@ -168,6 +168,111 @@ </para> </listitem> </varlistentry> + <varlistentry> + <term><parameter>dependencies</parameter></term> + <listitem> + <para> + To define the dependencies for your service, it may be necessary to set + this parameter with the list of the services names in an array. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>recovery_delay</parameter></term> + <listitem> + <para> + This parametter define the delay between the fail and the execution + of recovery action. The value is in millisecond. + </para> + <para> + The default value is 60000. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>recovery_action_1</parameter></term> + <listitem> + <para> + The action will be executed on first failure. The default value is + <constant>WIN32_SC_ACTION_NONE</constant>. + </para> + <para> + The <parameter>recovery_action_1</parameter> can be set to one of the + constants define in + <link linkend="win32service.constants.recovery-action">Win32 Recovery action</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>recovery_action_2</parameter></term> + <listitem> + <para> + The action will be executed on second failure. The default value is + <constant>WIN32_SC_ACTION_NONE</constant>. + </para> + <para> + The <parameter>recovery_action_2</parameter> can be set to one of the + constants define in + <link linkend="win32service.constants.recovery-action">Win32 Recovery action</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>recovery_action_3</parameter></term> + <listitem> + <para> + The action will be executed on next failures. The default value is + <constant>WIN32_SC_ACTION_NONE</constant>. + </para> + <para> + The <parameter>recovery_action_3</parameter> can be set to one of the + constants define in + <link linkend="win32service.constants.recovery-action">Win32 Recovery action</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>recovery_reset_period</parameter></term> + <listitem> + <para> + The failure count will be reset after the delay defined in the parameter. The delay is exprimed in second. + </para> + <para> + The default value is 86400. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>recovery_enabled</parameter></term> + <listitem> + <para> + Set this parameter at &true; for enable the recovery settings, &false; + otherwise. + </para> + <para> + The default value is &false; + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>recovery_reboot_msg</parameter></term> + <listitem> + <para> + Set this parameter for define the message saved into the Windows Event + Log before the reboot. Used only if one action is set to + <constant>WIN32_SC_ACTION_REBOOT</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>recovery_command</parameter></term> + <listitem> + <para> + Set this parameter for define the command executed when one action is define on + <constant>WIN32_SC_ACTION_RUN_COMMAND</constant>. + </para> + </listitem> + </varlistentry> </variablelist> </para> </listitem> @@ -204,10 +309,61 @@ <![CDATA[ <?php $x = win32_create_service(array( - 'service' => 'dummyphp', # the name of your service - 'display' => 'sample dummy PHP service', # short description - 'description' => 'This is a dummy Windows service created using PHP.', # long description - 'params' => '"' . __FILE__ . '" run', # path to the script and parameters + 'service' => 'dummyphp', // the name of your service + 'display' => 'sample dummy PHP service', // short description + 'description' => 'This is a dummy Windows service created using PHP.', // long description + 'params' => '"' . __FILE__ . '" run', // path to the script and parameters +)); +debug_zval_dump($x); +?> +]]> + </programlisting> + </example> + </para> + <para> + <example> + <title>A <function>win32_create_service</function> example with dependencies</title> + <para> + Create a service with the short name 'dummyphp' and dependencies. + </para> + <programlisting role="php"> +<![CDATA[ +<?php +$x = win32_create_service(array( + 'service' => 'dummyphp', // the name of your service + 'display' => 'sample dummy PHP service', // short description + 'description' => 'This is a dummy Windows service created using PHP.', // long description + 'params' => '"' . __FILE__ . '" run', // path to the script and parameters + 'dependencies' => array("Netman"), // The list of the dedendencies +)); +debug_zval_dump($x); +?> +]]> + </programlisting> + </example> + </para> + <para> + <example> + <title>A <function>win32_create_service</function> example with recovery</title> + <para> + Create a service with the short name 'dummyphp' and recovery settings. + </para> + <programlisting role="php"> +<![CDATA[ +<?php +$x = win32_create_service(array( + 'service' => 'dummyphp', // the name of your service + 'display' => 'sample dummy PHP service', // short description + 'description' => 'This is a dummy Windows service created using PHP.', // long description + 'params' => '"' . __FILE__ . '" run', // path to the script and parameters + 'recovery_delay' => 120000, // Recovery action is execute after 2 minutes + 'recovery_action_1' => WIN32_SC_ACTION_RESTART, // On first failure, restart the service + 'recovery_action_2' => WIN32_SC_ACTION_RUN_COMMAND, // On second failure, execute the commmand + 'recovery_action_3' => WIN32_SC_ACTION_NONE, // On other failure, do nothing + 'recovery_reset_period' => 86400, // Reset the fails counter after 1 day + 'recovery_enabled' => true, // Enable the recovery parameter + 'recovery_reboot_msg' => null, // Do not define an reboot message, it's not needed here + 'recovery_command' => "c:clean-service.bat", // When the action is WIN32_SC_ACTION_RUN_COMMAND, execute this command )); debug_zval_dump($x); ?> @@ -217,12 +373,37 @@ </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>0.4.0</entry> +<entry> + This <parameter>dependencies</parameter>, <parameter>recovery_delay</parameter>,<parameter>recovery_action_1</parameter>, <parameter>recovery_action_2</parameter>, <parameter>recovery_action_3</parameter>, <parameter>recovery_reset_period</parameter>, <parameter>recovery_enabled</parameter>, <parameter>recovery_reboot_msg</parameter> and <parameter>recovery_command</parameter> parameters has been added. +</entry> +</row> +</tbody> +</tgroup> +</informaltable> +</para> +</refsect1><!-- }}} --> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>win32_delete_service</function></member> <member><link linkend="win32service.constants.basepriorities">Win32 Base Priority Classes</link></member> + <member><link linkend="win32service.constants.recovery-action">Win32 Recovery action</link></member> <member><link linkend="win32service.constants.errors">Win32 Error Codes</link></member> </simplelist> </para> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=89778 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=89778 ------------------------------------------------------------------ -- https://edit.php.net/ This email is send automatically by the Php Docbook Online Editor.

« previous php.doc (#969387173) next »