Contributions are ready for review

From:	phpdoc at lists dot php dot net	Date:	Mon, 02 Apr 2018 12:00:04 +0000
Subject:	Contributions are ready for review
Groups:	php.doc
Request:	Send a blank email to phpdoc+get-969386912@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 : ----------------------- New file: en/reference/phpdbg/reference.xml By: Grummfy on 2017-07-06 14:40:49 =================================================================== --- en/reference/phpdbg/reference.xml +++ en/reference/phpdbg/reference.xml @@ -0,0 +1,42 @@ +<?xml version="1.0" encoding="utf-8"?> + + +<reference xml:id="ref.extname" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title>PHPDbg &Functions;</title> + + + + &reference.phpdbg.entities.functions; + +</reference> + + + => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=74455 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=74455 ------------------------------------------------------------------ New file: en/reference/phpdbg/book.xml By: Grummfy on 2017-07-06 14:46:58 =================================================================== --- en/reference/phpdbg/book.xml +++ en/reference/phpdbg/book.xml @@ -0,0 +1,43 @@ +<?xml version="1.0" encoding="utf-8"?> + + +<book xml:id="book.extname" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title>PHPDbg</title> + <titleabbrev>PHPDbg</titleabbrev> + +  + <preface xml:id="intro.extname"> + &reftitle.intro; + <para> + Implemented as a SAPI module, phpdbg can exert complete control over the environment without impacting the functionality or performance of your code. + </para> + </preface> +  + + &reference.phpdbg.setup; + &reference.phpdbg.cli; + &reference.phpdbg.reference; + +</book> + + + => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=74454 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=74454 ------------------------------------------------------------------ New file: en/reference/phpdbg/setup.xml By: Grummfy on 2017-07-06 14:47:12 =================================================================== --- en/reference/phpdbg/setup.xml +++ en/reference/phpdbg/setup.xml @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="utf-8"?> + + +<chapter xml:id="phpdbg.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + &reftitle.setup; + +  + <section xml:id="phpdbg.requirements"> + &reftitle.required; + &no.requirement; + </section> +  + +  + <section xml:id="phpdbg.installation"> + &reftitle.install; + &no.install; + </section> +  +  + +  + <section xml:id="phpdbg.configuration"> + &reftitle.runtime; + &no.config; + </section> +  +  + +  + <section xml:id="phpdbg.resources"> + &reftitle.resources; + &no.resource; + </section> +  + +</chapter> + + + => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=74456 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=74456 ------------------------------------------------------------------ New file: en/reference/phpdbg/functions/phpdbg-start-oplog.xml By: Grummfy on 2017-07-06 15:13:23 =================================================================== --- en/reference/phpdbg/functions/phpdbg-start-oplog.xml +++ en/reference/phpdbg/functions/phpdbg-start-oplog.xml @@ -0,0 +1,46 @@ +<?xml version="1.0" encoding="utf-8"?> + + +<refentry xml:id="function.phpdbg-start-oplog" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>phpdbg_start_oplog</refname> + <refpurpose>Start registring code coverage</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>void</type><methodname>phpdbg_start_oplog</methodname> + <void/> + </methodsynopsis> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + No return value. + </para> + </refsect1> + +</refentry> + + => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=74458 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=74458 ------------------------------------------------------------------ New file: en/reference/misc/functions/sapi_windows_vt100_support.xml By: jhdxr on 2018-01-30 06:51:00 =================================================================== --- en/reference/misc/functions/sapi_windows_vt100_support.xml +++ en/reference/misc/functions/sapi_windows_vt100_support.xml @@ -0,0 +1,78 @@ +<?xml version="1.0" encoding="utf-8"?> + + +<refentry xml:id="function.func-name" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>sapi_windows_vt100_support</refname> + <refpurpose>get/set vt100 enable state for given stream on Windows</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis role="procedural"> + <type>bool</type><methodname>sapi_windows_vt100_support</methodname> + <methodparam><type>resource</type><parameter>stream</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>enable</parameter></methodparam> + </methodsynopsis> + <para> + + </para> + + &warn.undocumented.func; + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <variablelist> + <varlistentry> + <term><parameter>stream</parameter></term> + <listitem> + <para> + + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>enable</parameter></term> + <listitem> + <para> + + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + This function returns whether vt100 is supported for given stream when <parameter>enable</parameter> not provided. + </para> + <para> + &return.success; when <parameter>enable</parameter> provided. + </para> + </refsect1> + + +</refentry> + + => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=79445 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=79445 ------------------------------------------------------------------ New file: en/reference/var/functions/is-countable.xml By: Gabriel Caruso on 2018-03-10 13:29:13 =================================================================== --- en/reference/var/functions/is-countable.xml +++ en/reference/var/functions/is-countable.xml @@ -0,0 +1,99 @@ +<?xml version="1.0" encoding="utf-8"?> + +<refentry xml:id="function.is-countable" xmlns="http://docbook.org/ns/docbook"> + <refnamediv> + <refname>is_countable</refname> + <refpurpose> + Verify that the contents of a variable is a countable value + </refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>bool</type><methodname>is_countable</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> + <para> + Verify that the contents of a variable is an <type>array</type> or + an object implementing <classname>Countable</classname> + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>var</parameter></term> + <listitem> + <para> + The value to check + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if <parameter>var</parameter> is countable, &false; + otherwise. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>is_countable</function> examples</title> + <programlisting role="php"> +<![CDATA[ +<?php +var_dump(is_countable([1, 2, 3])); // bool(true) +var_dump(is_countable(new ArrayIterator(['foo', 'bar', 'baz']))); // bool(true) +var_dump(is_countable(new ArrayIterator())); // bool(true) +var_dump(is_countable(new stdClass())); // bool(false) + +]]> + </programlisting> + </example> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>is_array</function></member> + <member><function>is_object</function></member> + <member><function>is_iterable</function></member> + <member><function>is_bool</function></member> + </simplelist> + </para> + </refsect1> + +</refentry> + + => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=81407 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=81407 ------------------------------------------------------------------ New file: en/reference/intl/normalizer/get-raw-decomposition.xml By: Ekin on 2018-03-25 23:21:46 =================================================================== --- en/reference/intl/normalizer/get-raw-decomposition.xml +++ en/reference/intl/normalizer/get-raw-decomposition.xml @@ -1,33 +1,29 @@ <?xml version="1.0" encoding="utf-8"?> - + <refentry xml:id="normalizer.getrawdecomposition" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>Normalizer::getRawDecomposition</refname> <refname>normalizer_get_raw_decomposition</refname> - <refpurpose>Gets the Decomposition_Mapping property for the given UTF-8 encoded code point</refpurpose> + <refpurpose>Returns the Decomposition_Mapping property for the given UTF-8 encoded code point.</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <para>&style.oop;</para> <methodsynopsis role="oop"> - <modifier>public</modifier> - <modifier>static</modifier> - <type>string</type> - <methodname>Normalizer::getRawDecomposition</methodname> + <type>string|null</type><methodname>Normalizer::getRawDecomposition</methodname> <methodparam><type>string</type><parameter>input</parameter></methodparam> </methodsynopsis> <para>&style.procedural;</para> <methodsynopsis role="procedural"> - <type>string</type><methodname>normalizer_get_raw_decomposition</methodname> + <type>string|null</type><methodname>normalizer_get_raw_decomposition</methodname> <methodparam><type>string</type><parameter>input</parameter></methodparam> </methodsynopsis> <para> - Gets the Decomposition_Mapping property, as specified in the - Unicode Character Database (UCD), for the given UTF-8 encoded code point. + Returns the Decomposition_Mapping property for the given UTF-8 encoded code point. </para> </refsect1> @@ -38,7 +34,7 @@ <term><parameter>input</parameter></term> <listitem> <para> - The input string, which should be a single, UTF-8 encoded, code point. + The input string </para> </listitem> </varlistentry> @@ -48,22 +44,22 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns a <type>string</type> containing the Decomposition_Mapping property, if present in the UCD. - </para> - <para> - Returns &null; if there is no Decomposition_Mapping property for the character. + Returns null if there's no decomposition mapping property for the character. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; - <example xml:id="normalizer.getrawdecomposition.example.basic"> + <example xml:id="Normalizer.getRawDecomposition.example.basic"> <title><methodname>Normalizer::getRawDecomposition</methodname> example</title> + <para> + Consider the following set of strings. + </para> <programlisting role="php"> <![CDATA[ <?php -$result = ""; +$result = ''; $strings = [ "a", "u{FFDA}", @@ -71,7 +67,7 @@ "", "aa", "xF5", -]; + ]; foreach ($strings as $string) { $decomposition = Normalizer::getRawDecomposition($string); @@ -96,9 +92,10 @@ ?> ]]> </programlisting> + &example.outputs; <screen> -<![CDATA[ +<![CDATA[ --------------------- '61' has no decomposition mapping error info: 'U_ZERO_ERROR' (0) @@ -151,4 +148,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=81646 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=81646 ------------------------------------------------------------------ Modified: en/reference/mcrypt/constants.xml By: leigh on 2017-01-11 07:16:44 =================================================================== --- en/reference/mcrypt/constants.xml +++ en/reference/mcrypt/constants.xml @@ -16,40 +16,40 @@ <listitem> <simpara> <constant>MCRYPT_MODE_ECB</constant> (<literal>electronic - codebook</literal>) is suitable for random data, - such as encrypting other keys. Since data there is short and random, - the disadvantages of ECB have a favorable negative effect. + codebook</literal>) is a block cipher mode that is generally + unsuitable for most purposes. The use of this mode is not recommended. </simpara> </listitem> <listitem> <simpara> <constant>MCRYPT_MODE_CBC</constant> (<literal>cipher block - chaining</literal>) is especially suitable for - encrypting files where the security is increased over <literal>ECB</literal> - significantly. + chaining</literal>) is a block cipher mode that is significantly + more secure than <literal>ECB</literal> mode. </simpara> </listitem> <listitem> <simpara> <constant>MCRYPT_MODE_CFB</constant> (<literal>cipher - feedback</literal>) is the best mode for encrypting byte - streams where single bytes must be encrypted. + feedback, in 8-bit mode</literal>) is a stream cipher mode. + It is recommended to use <literal>NCFB</literal> mode rather + than <literal>CFB</literal> mode. </simpara> </listitem> <listitem> <simpara> <constant>MCRYPT_MODE_OFB</constant> (<literal>output feedback, in - 8bit</literal>) is comparable to <literal>CFB</literal>, but + 8-bit mode</literal>) is a stream cipher mode comparable to <literal>CFB</literal>, but can be used in applications where error propagation cannot - be tolerated. It's insecure (because it operates in 8bit - mode) so it is not recommended to use it. + be tolerated. + It is recommended to use <literal>NOFB</literal> mode rather + than <literal>OFB</literal> mode. </simpara> </listitem> <listitem> <simpara> <constant>MCRYPT_MODE_NOFB</constant> (<literal>output feedback, - in nbit</literal>) is comparable to OFB, but - more secure because it operates on the block size of the algorithm. + in n-bit mode</literal>) is comparable to <literal>OFB</literal> mode, + but operates on the full block size of the algorithm. </simpara> </listitem> <listitem> @@ -60,6 +60,25 @@ </listitem> </itemizedlist> </para> + + <para> + Mcrypt supports some other modes of operation for which there are no predefined constants. + They can be utilised by passing a string in place of the missing constants. + <itemizedlist> + <listitem> + <simpara> + <constant>"ctr"</constant> (<literal>counter mode</literal>) is a stream cipher mode. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>"ncfb"</constant> (<literal>cipher feedback, + in n-bit mode</literal>) is comparable to <literal>CFB</literal> mode, + but operates on the full block size of the algorithm. + </simpara> + </listitem> + </itemizedlist> + </para> <para> Some other mode and random device constants: => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=71828 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=71828 ------------------------------------------------------------------ Modified: en/reference/ldap/functions/ldap-modify.xml By: mcmic on 2017-11-09 04:57:12 =================================================================== --- en/reference/ldap/functions/ldap-modify.xml +++ en/reference/ldap/functions/ldap-modify.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> - + <refentry xml:id="function.ldap-modify" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>ldap_modify</refname> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=76254 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=76254 ------------------------------------------------------------------ Modified: en/reference/ldap/functions/ldap-mod-add.xml By: mcmic on 2017-11-09 05:19:02 =================================================================== --- en/reference/ldap/functions/ldap-mod-add.xml +++ en/reference/ldap/functions/ldap-mod-add.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> - + <refentry xml:id="function.ldap-mod-add" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>ldap_mod_add</refname> @@ -13,7 +13,6 @@ <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> <methodparam><type>string</type><parameter>dn</parameter></methodparam> <methodparam><type>array</type><parameter>entry</parameter></methodparam> - <methodparam choice="opt"><type>array</type><parameter>serverctrls</parameter></methodparam> </methodsynopsis> <para> Adds one or more attribute values to the specified <parameter>dn</parameter>. => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=76256 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=76256 ------------------------------------------------------------------ Modified: en/reference/ldap/functions/ldap-mod-del.xml By: mcmic on 2017-11-09 05:19:08 =================================================================== --- en/reference/ldap/functions/ldap-mod-del.xml +++ en/reference/ldap/functions/ldap-mod-del.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> - + <refentry xml:id="function.ldap-mod-del" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>ldap_mod_del</refname> @@ -13,7 +13,6 @@ <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> <methodparam><type>string</type><parameter>dn</parameter></methodparam> <methodparam><type>array</type><parameter>entry</parameter></methodparam> - <methodparam choice="opt"><type>array</type><parameter>serverctrls</parameter></methodparam> </methodsynopsis> <para> Removes one or more attribute values from the specified <parameter>dn</parameter>. => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=76257 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=76257 ------------------------------------------------------------------ Modified: en/reference/ldap/functions/ldap-mod-replace.xml By: mcmic on 2017-11-09 05:19:52 =================================================================== --- en/reference/ldap/functions/ldap-mod-replace.xml +++ en/reference/ldap/functions/ldap-mod-replace.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> - + <refentry xml:id="function.ldap-mod-replace" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>ldap_mod_replace</refname> @@ -13,7 +13,6 @@ <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> <methodparam><type>string</type><parameter>dn</parameter></methodparam> <methodparam><type>array</type><parameter>entry</parameter></methodparam> - <methodparam choice="opt"><type>array</type><parameter>serverctrls</parameter></methodparam> </methodsynopsis> <para> Replaces one or more attributes from the specified <parameter>dn</parameter>. => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=76255 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=76255 ------------------------------------------------------------------ Modified: en/chapters/intro.xml By: Barb H. on 2017-12-01 18:38:55 =================================================================== --- en/chapters/intro.xml +++ en/chapters/intro.xml @@ -31,39 +31,55 @@ ?> </body> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> +  + <type>thereturned type</type><methodname>func_name</methodname> +  + <methodparam><type>param1type</type><parameter>firstparameter</parameter></methodparam> +  + <methodparam choice="opt"><type>int</type><parameter role="reference">secondparameter</parameter></methodparam> +  + <void /> + </methodsynopsis> + <para> + The function description goes here. + </para> + </refsect1> </html> ]]> </programlisting> </example> </para> <para> - Instead of lots of commands to output HTML (as seen in C or Perl), + Rather than require a lot of commands to output HTML (as seen in C or Perl), PHP pages contain HTML with embedded code that does "something" (in this case, output "Hi, I'm a PHP script!"). The PHP code is enclosed in special <link linkend="language.basic-syntax.phpmode">start and end processing instructions <code><?php</code> and <code>?></code></link> - that allow you to jump into and out of "PHP mode." + that allow you to jump in and out of "PHP mode." </para> <para> What distinguishes PHP from something like client-side JavaScript is that the code is executed on the server, generating HTML which - is then sent to the client. The client would receive + is then sent to the client. The client receives the results of running that script, but would not know what the underlying code was. You can even configure your web server - to process all your HTML files with PHP, and then there's really no + to process all your HTML files with PHP, so there's really no way that users can tell what you have up your sleeve. </para> <para> - The best things in using PHP are that it is extremely simple + The best thing about using PHP is that it is extremely simple for a newcomer, but offers many advanced features for - a professional programmer. Don't be afraid reading the long - list of PHP's features. You can jump in, in a short time, and + a professional programmer. Don't be afraid to read the long + list of PHP's features. You can jump in and start writing simple scripts in a few hours. </para> <para> Although PHP's development is focused on server-side scripting, - you can do much more with it. Read on, and see more in the + you can do much more with it. To find out how much more, read the <link linkend="intro-whatcando">What can PHP do?</link> section, or go right to the <link linkend="tutorial">introductory tutorial</link> if you are only interested in web programming. @@ -74,81 +90,93 @@ <info><title>What can PHP do?</title></info> <para> Anything. PHP is mainly focused on server-side scripting, - so you can do anything any other CGI program can do, such + so you can do the same things any other CGI program can do, such as collect form data, generate dynamic page content, or - send and receive cookies. But PHP can do much more. + send and receive cookies. And PHP can do much more. </para> <para> There are three main areas where PHP scripts are used. <itemizedlist> <listitem> <simpara> - Server-side scripting. This is the most traditional - and main target field for PHP. You need three things - to make this work: the PHP parser (CGI or server - module), a web server and a web browser. You need to - run the web server, with a connected PHP installation. - You can access the PHP program output with a web browser, - viewing the PHP page through the server. All these can - run on your home machine if you are just experimenting - with PHP programming. See the + Server-Side Scripting: This is the most traditional + and main purpose of PHP. You need three pieces + to make this work: a PHP parser (CGI or server + module), a web server, and a web browser. The web server + runs with a connected PHP installation which parses PHP code. + You can see the PHP program output using a web browser + with a URL address to your files on the web server. If you + are just experimenting with PHP programming, all of these + pieces can run on your home machine. See the <link linkend="install">installation instructions</link> section for more information. </simpara> </listitem> <listitem> <simpara> - Command line scripting. You can make a PHP script - to run it without any server or browser. - You only need the PHP parser to use it this way. - This type of usage is ideal for scripts regularly - executed using cron (on *nix or Linux) or Task Scheduler (on + Command Line Scripting: You can run PHP code + without any server or browser. To be used this way, + only the PHP parser is required. + It is ideal for scripts regularly executed + using cron (on *nix or Linux) or Task Scheduler (on Windows). These scripts can also be used for simple text processing tasks. See the section about - <link linkend="features.commandline">Command line usage of PHP</link> + <link linkend="features.commandline">command line usage of PHP</link> for more information. </simpara> </listitem> <listitem> <simpara> - Writing desktop applications. PHP is probably - not the very best language to create a desktop - application with a graphical user interface, but if - you know PHP very well, and would like to use some - advanced PHP features in your client-side applications - you can also use PHP-GTK to write such programs. You also + Writing Desktop Applications: PHP is probably + not the best language to create a desktop + application with a graphical user interface, but the + PHP-GTK extension enables you to do this. As an + extension, it is not included in the main distribution. + If you know PHP very well and would like to use some + advanced PHP features in your client-side applications, + you can use PHP-GTK to write such programs. You also have the ability to write cross-platform applications this - way. PHP-GTK is an extension to PHP, not available in - the main distribution. If you are interested - in PHP-GTK, visit <link xlink:href="&url.php.gtk;">its + way. If you are interested in PHP-GTK, visit + <link xlink:href="&url.php.gtk;">its own website</link>. </simpara> </listitem> </itemizedlist> </para> <para> - PHP can be <link linkend="install">used</link> on all major operating systems, including + PHP can be <link linkend="install">installed</link> on all major operating systems, including Linux, many Unix variants (including HP-UX, Solaris and OpenBSD), - Microsoft Windows, Mac OS X, RISC OS, and probably others. + Microsoft Windows, Mac OS X, RISC OS, and others. PHP also has support for most of the web servers today. This - includes Apache, IIS, and many others. And this includes any + includes Apache, IIS, and many others as well as any web server that can utilize the FastCGI PHP binary, like lighttpd - and nginx. PHP works as either a module, or as a CGI processor. + and nginx. PHP can work either as a module or as a CGI processor. </para> <para> - So with PHP, you have the freedom of choosing an operating - system and a web server. Furthermore, you also have the choice + Not only does PHP offer you the freedom to choose your + operating system and web server, you also have the choice of using procedural programming or object oriented - programming (OOP), or a mixture of them both. - </para> - <para> - With PHP you are not limited to output HTML. PHP's abilities - includes outputting images, PDF files and even Flash movies - (using libswf and Ming) generated on the fly. You can also - output easily any text, such as XHTML and any other XML file. - PHP can autogenerate these files, and save them in the file - system, instead of printing it out, forming a server-side - cache for your dynamic content. + programming (OOP) or even a mixture of both. And your output + is not limited to HTML. PHP can output + images, PDF files and Flash movies, using + libswf and Ming, generated on the fly. + </para> + <para> + PHP has many useful <link linkend="refs.basic.text"> + text processing</link> features including tools for + working with Perl compatible regular expressions (<link + linkend="book.pcre">PCRE</link>) and + <link linkend="refs.xml">parsing and accessing XML</link>. + PHP standardizes all of the XML extensions on the solid + base of <link linkend="book.libxml">libxml2</link>. + The XML feature set of PHP is extended with support for + <link linkend="book.simplexml">SimpleXML</link>, <link + linkend="book.xmlreader">XMLReader</link> and + <link linkend="book.xmlwriter">XMLWriter</link>. + These text processing features enable you to easily + create text-based files such as XHTML and other XML files. + PHP can print them or save them in the file system + forming a server-side cache for your dynamic content. </para> <para> One of the strongest and most significant features in PHP is its @@ -162,37 +190,31 @@ like CouchDB. </para> <para> - PHP also has support for talking to other services using protocols + PHP supports talking to other services using protocols such as LDAP, IMAP, SNMP, NNTP, POP3, HTTP, COM (on Windows) and countless others. You can also open raw network sockets and interact using any other protocol. PHP has support for the WDDX complex data exchange between virtually all Web programming - languages. Talking about interconnection, PHP has support for + languages. PHP interconnection even offers support for instantiation of Java objects and using them transparently as PHP objects. </para> <para> - PHP has useful <link linkend="refs.basic.text">text processing</link> features, - which includes the Perl compatible regular expressions (<link linkend="book.pcre">PCRE</link>), - and many extensions and tools to <link linkend="refs.xml">parse and access XML documents</link>. - PHP standardizes all of the XML extensions on the solid base of <link linkend="book.libxml">libxml2</link>, - and extends the feature set adding <link linkend="book.simplexml">SimpleXML</link>, - <link linkend="book.xmlreader">XMLReader</link> and <link linkend="book.xmlwriter">XMLWriter</link> support. - </para> - <para> - And many other interesting extensions exist, which are categorized both - <link linkend="extensions">alphabetically</link> and by <link linkend="funcref">category</link>. - And there are additional PECL extensions that may or may not be documented - within the PHP manual itself, like <link xlink:href="&url.xdebug;">XDebug</link>. - </para> - <para> - As you can see this page is not enough to list all - the features and benefits PHP can offer. Read on in - the sections about <link linkend="install">installing - PHP</link>, and see the <link linkend="funcref">function - reference</link> part for explanation of the extensions - mentioned here. + Many other interesting extensions exist in PHP which are categorized both + <link linkend="extensions">alphabetically</link> and by <link linkend="funcref">category</link>. There are additional PECL extensions + that may or may not be documented within the PHP manual itself, like <link xlink:href="&url.xdebug;">XDebug</link>. + </para> + <para> + This page is not enough to list all + the features and benefits PHP offers. Get started by + <link linkend="install">installing + PHP</link>. Read the <link linkend="funcref">function + reference</link> for explanations of the extensions to PHP + mentioned here. With your PHP environment set up, check out + <link linkend="tutorial">a simple tutorial</link> or explore + <link linkend="langref">the language reference</link> section. </para> + </section> </chapter> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=76914 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=76914 ------------------------------------------------------------------ Modified: en/reference/funchand/functions/call-user-func.xml By: anonymous on 2017-12-17 16:19:24 =================================================================== --- en/reference/funchand/functions/call-user-func.xml +++ en/reference/funchand/functions/call-user-func.xml @@ -54,20 +54,21 @@ } $a = 0; +// Warning: Parameter 1 to increment() expected to be a reference, value given in ... call_user_func('increment', $a); -echo $a."n"; +echo "Passed by value: ".$a."n"; // You can use this instead call_user_func_array('increment', array(&$a)); -echo $a."n"; +echo "Passed by reference: ".$a."n"; ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ -0 -1 +Passed by value: 0 +Passed by reference: 1 ]]> </screen> </example> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=77526 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=77526 ------------------------------------------------------------------ Modified: en/reference/var/functions/unset.xml By: anonymous on 2018-01-01 13:15:30 =================================================================== --- en/reference/var/functions/unset.xml +++ en/reference/var/functions/unset.xml @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="utf-8"?> - + <refentry xml:id="function.unset" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>unset</refname> <refpurpose>Unset a given variable</refpurpose> </refnamediv> - + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -100,7 +100,7 @@ </programlisting> </informalexample> </para> - &example.outputs; + &example.outputs; <para> <informalexample> <screen> @@ -138,7 +138,7 @@ </programlisting> </informalexample> </para> - &example.outputs; + &example.outputs; <para> <informalexample> <screen> @@ -151,7 +151,7 @@ </informalexample> </para> </refsect1> - + <refsect1 role="parameters"> &reftitle.parameters; <para> @@ -175,14 +175,14 @@ </variablelist> </para> </refsect1> - + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.void; </para> </refsect1> - + <refsect1 role="examples"> &reftitle.examples; <para> @@ -206,11 +206,13 @@ <example> <title>Using <literal>(unset)</literal> casting</title> <para> + &warn.deprecated.feature-7-2-0; + </para> + <para> <literal>(unset)</literal> casting is often confused with the <function>unset</function> function. <literal>(unset)</literal> casting serves only as a <literal>NULL</literal>-type cast, for completeness. It does not alter the variable it's casting. - The (unset) cast is deprecated as of PHP 7.2.0. </para> <programlisting role="php"> <![CDATA[ @@ -232,7 +234,7 @@ </example> </para> </refsect1> - + <refsect1 role="notes"> &reftitle.notes; &note.language-construct; @@ -267,7 +269,7 @@ </simplelist> </para> </refsect1> - + </refentry>  + <refentry xml:id="function.socket-addrinfo-lookup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> @@ -16,11 +16,10 @@ <methodparam choice="opt"><type>array</type><parameter>hints</parameter></methodparam> </methodsynopsis> <para> - + Lookup different ways we can connect to <parameter>host</parameter>. The returned array contains + a set of resources that we can bind to using <function>socket_addrinfo_bind</function>. </para> - &warn.undocumented.func; - </refsect1> <refsect1 role="parameters"> @@ -30,7 +29,7 @@ <term><parameter>host</parameter></term> <listitem> <para> - + Hostname to search. </para> </listitem> </varlistentry> @@ -38,7 +37,8 @@ <term><parameter>service</parameter></term> <listitem> <para> - + The service to connect to. If service is a name, it is translated to the corresponding + port number. </para> </listitem> </varlistentry> @@ -46,7 +46,8 @@ <term><parameter>hints</parameter></term> <listitem> <para> - + Hints provide criteria for selecting addresses returned. You may specify the + hints as defined by getadrinfo. </para> </listitem> </varlistentry> @@ -56,7 +57,18 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - + Returns an array of AddrInfo resource handles that can be used with the other socket_addrinfo functions. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>socket_addrinfo_bind</function></member> + <member><function>socket_addrinfo_connect</function></member> + <member><function>socket_addrinfo_explain</function></member> + </simplelist> </para> </refsect1> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=79823 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=79823 ------------------------------------------------------------------ Modified: en/reference/sockets/functions/socket-listen.xml By: David Walker on 2018-02-05 08:42:08 =================================================================== --- en/reference/sockets/functions/socket-listen.xml +++ en/reference/sockets/functions/socket-listen.xml @@ -34,7 +34,8 @@ <term><parameter>socket</parameter></term> <listitem> <para> - A valid socket resource created with <function>socket_create</function>. + A valid socket resource created with <function>socket_create</function> + or <function>socket_addrinfo_bind</function> </para> </listitem> </varlistentry> @@ -84,6 +85,7 @@ <member><function>socket_connect</function></member> <member><function>socket_create</function></member> <member><function>socket_strerror</function></member> + <member><function>socket_addrinfo_bind</function></member> </simplelist> </para> </refsect1> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=79825 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=79825 ------------------------------------------------------------------ Modified: en/reference/sockets/functions/socket-addrinfo-connect.xml By: David Walker on 2018-02-05 08:44:14 =================================================================== --- en/reference/sockets/functions/socket-addrinfo-connect.xml +++ en/reference/sockets/functions/socket-addrinfo-connect.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> - + <refentry xml:id="function.socket-addrinfo-connect" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> @@ -14,11 +14,10 @@ <methodparam><type>resource</type><parameter>addr</parameter></methodparam> </methodsynopsis> <para> - + Create a Socket resource, and connect it to the provided AddrInfo resource. The return + value of this function may be used with the rest of the socket functions. </para> - &warn.undocumented.func; - </refsect1> <refsect1 role="parameters"> @@ -28,7 +27,7 @@ <term><parameter>addr</parameter></term> <listitem> <para> - + Resource created from <function>socket_addrinfo_lookup()</function> </para> </listitem> </varlistentry> @@ -38,7 +37,18 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - + Returns a Socket resource on success or &null; on failure. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>socket_addrinfo_bind</function></member> + <member><function>socket_addrinfo_explain</function></member> + <member><function>socket_addrinfo_lookup</function></member> + </simplelist> </para> </refsect1> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=79826 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=79826 ------------------------------------------------------------------ Modified: en/reference/sockets/functions/socket-addrinfo-bind.xml By: David Walker on 2018-02-05 08:44:16 =================================================================== --- en/reference/sockets/functions/socket-addrinfo-bind.xml +++ en/reference/sockets/functions/socket-addrinfo-bind.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> - + <refentry xml:id="function.socket-addrinfo-bind" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> @@ -14,11 +14,10 @@ <methodparam><type>resource</type><parameter>addr</parameter></methodparam> </methodsynopsis> <para> - + Create a Socket resource, and bind it to the provided AddrInfo resource. The return + value of this function may be used with <function>socket_listen</function>. </para> - &warn.undocumented.func; - </refsect1> <refsect1 role="parameters"> @@ -28,7 +27,7 @@ <term><parameter>addr</parameter></term> <listitem> <para> - + Resource created from <function>socket_addrinfo_lookup()</function>. </para> </listitem> </varlistentry> @@ -38,10 +37,22 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - + Returns a Socket resource on success or &null; on failure. </para> </refsect1> - + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>socket_addrinfo_connect</function></member> + <member><function>socket_addrinfo_explain</function></member> + <member><function>socket_addrinfo_lookup</function></member> + <member><function>socket_listen</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry xml:id="function.socket-addrinfo-explain" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> @@ -14,11 +14,10 @@ <methodparam><type>resource</type><parameter>addr</parameter></methodparam> </methodsynopsis> <para> - + <function>socket_addrinfo_explain()</function> exposed the underlying + <literal>addrinfo</literal> structure. </para> - &warn.undocumented.func; - </refsect1> <refsect1 role="parameters"> @@ -28,7 +27,7 @@ <term><parameter>addr</parameter></term> <listitem> <para> - + Resource created from <function>socket_addrinfo_lookup()</function> </para> </listitem> </varlistentry> @@ -38,7 +37,18 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - + Returns an array containing the fields in the <literal>addrinfo</literal> structure. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>socket_addrinfo_bind</function></member> + <member><function>socket_addrinfo_connect</function></member> + <member><function>socket_addrinfo_lookup</function></member> + </simplelist> </para> </refsect1> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=79827 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=79827 ------------------------------------------------------------------ Modified: en/reference/pcre/functions/preg-split.xml By: anonymous on 2018-02-10 05:03:36 =================================================================== --- en/reference/pcre/functions/preg-split.xml +++ en/reference/pcre/functions/preg-split.xml @@ -46,7 +46,7 @@ <para> If specified, then only substrings up to <parameter>limit</parameter> are returned with the rest of the string being placed in the last - substring. A <parameter>limit</parameter> of -1, 0 or &null; means "no limit" + substring. A <parameter>limit</parameter> of -1 or 0 means "no limit" and, as is standard across PHP, you can use &null; to skip to the <parameter>flags</parameter> parameter. </para> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=80020 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=80020 ------------------------------------------------------------------ Modified: en/reference/datetime/dateperiod.xml By: Craig Duncan on 2018-02-20 11:21:47 =================================================================== --- en/reference/datetime/dateperiod.xml +++ en/reference/datetime/dateperiod.xml @@ -46,7 +46,39 @@ <varname linkend="dateperiod.constants.exclude-start-date">DatePeriod::EXCLUDE_START_DATE</varname> <initializer>1</initializer> </fieldsynopsis> - + + <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo> + <fieldsynopsis> + <modifier>public</modifier> + <type>integer</type> + <varname linkend="dateperiod.props.recurrences">recurrences</varname> + </fieldsynopsis> + <fieldsynopsis> + <modifier>public</modifier> + <type>boolean</type> + <varname linkend="dateperiod.props.include_start_date">include_start_date</varname> + </fieldsynopsis> + <fieldsynopsis> + <modifier>public</modifier> + <type>DateTimeInterface</type> + <varname linkend="dateperiod.props.start">start</varname> + </fieldsynopsis> + <fieldsynopsis> + <modifier>public</modifier> + <type>DateTimeInterface</type> + <varname linkend="dateperiod.props.current">current</varname> + </fieldsynopsis> + <fieldsynopsis> + <modifier>public</modifier> + <type>DateTimeInterface</type> + <varname linkend="dateperiod.props.end">end</varname> + </fieldsynopsis> + <fieldsynopsis> + <modifier>public</modifier> + <type>DateInterval</type> + <varname linkend="dateperiod.props.interval">interval</varname> + </fieldsynopsis> + <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo> <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.dateperiod')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])"> <xi:fallback /> @@ -80,6 +112,61 @@ </section>  + <section xml:id="dateperiod.props"> + &reftitle.properties; + <variablelist> + <varlistentry xml:id="dateperiod.props.recurrences"> + <term><varname>recurrence</varname></term> + <listitem> + <para> + The number of recurrences. + </para> + </listitem> + </varlistentry> + <varlistentry xml:id="dateperiod.props.include_start_date"> + <term><varname>include_start_date</varname></term> + <listitem> + <para> + Whether to include the start date in the set of recurring dates or not. + </para> + </listitem> + </varlistentry> + <varlistentry xml:id="dateperiod.props.start"> + <term><varname>start</varname></term> + <listitem> + <para> + The start date of the period. + </para> + </listitem> + </varlistentry> + <varlistentry xml:id="dateperiod.props.current"> + <term><varname>current</varname></term> + <listitem> + <para> + During iteration this will contain the current date within the period. + </para> + </listitem> + </varlistentry> + <varlistentry xml:id="dateperiod.props.end"> + <term><varname>end</varname></term> + <listitem> + <para> + The end date of the period. + </para> + </listitem> + </varlistentry> + <varlistentry xml:id="dateperiod.props.interval"> + <term><varname>interval</varname></term> + <listitem> + <para> + An ISO 8601 repeating interval specification. + </para> + </listitem> + </varlistentry> + </variablelist> + </section> + + </partintro> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=80364 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=80364 ------------------------------------------------------------------ Modified: en/reference/sodium/configure.xml By: Michael Munger on 2018-02-21 14:25:44 =================================================================== --- en/reference/sodium/configure.xml +++ en/reference/sodium/configure.xml @@ -5,7 +5,7 @@ &reftitle.install; <para> - Use <option role="configure">--with-sodium[=DIR]</option> when compiling PHP. + Use <option role="configure">--with-sodium[=DIR]</option> when compiling PHP. </para> <para> => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=80401 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=80401 ------------------------------------------------------------------ Modified: en/appendices/migration72/incompatible.xml By: anonymous on 2018-03-16 04:47:35 =================================================================== --- en/appendices/migration72/incompatible.xml +++ en/appendices/migration72/incompatible.xml @@ -132,6 +132,7 @@ <?php var_dump( + count(null), // NULL is not countable count(1), // integers are not countable count('abc'), // strings are not countable count(new stdclass), // objects not implementing the Countable interface are not countable @@ -147,6 +148,9 @@ Warning: count(): Parameter must be an array or an object that implements Countable in %s on line %d Warning: count(): Parameter must be an array or an object that implements Countable in %s on line %d + +Warning: count(): Parameter must be an array or an object that implements Countable in %s on line %d +int(0) int(1) int(1) int(1) => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=81566 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=81566 ------------------------------------------------------------------ Modified: en/reference/intl/versions.xml By: Ekin on 2018-03-25 23:24:18 =================================================================== --- en/reference/intl/versions.xml +++ en/reference/intl/versions.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> - +  => Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=81648 => Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=81648 ------------------------------------------------------------------ -- https://edit.php.net/ This email is send automatically by the Php Docbook Online Editor.