Re: Contributions are ready for review

Please remove me from your mailing list. On Mon, Jul 2, 2018, 5:48 PM <phpdoc@lists.php.net> wrote: > 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/chapters/intro.xml > By: Barb H. on 2017-12-01 18:38:55 > =================================================================== > --- en/chapters/intro.xml > +++ en/chapters/intro.xml > @@ -1,5 +1,5 @@ > <?xml version="1.0" encoding="utf-8"?> > -<!-- $Revision: 345139 $ --> > +<!-- $Revision: 342891 $ --> > <chapter xml:id="introduction" > xmlns="http://docbook.org/ns/docbook" > xmlns:xlink="http://www.w3.org/1999/xlink"> > <info><title>Introduction</title></info> > > @@ -31,39 +31,55 @@ > ?> > > </body> > + <refsect1 role="description"><!-- {{{ --> > + &reftitle.description; > + <methodsynopsis> > + <!-- Example: All functions have this --> > + <type>thereturned type</type><methodname>func_name</methodname> > + <!-- Example: Required parameter --> > + > > <methodparam><type>param1type</type><parameter>firstparameter</parameter></methodparam> > + <!-- Example: Optional parameter, also by reference --> > + <methodparam choice="opt"><type>int</type><parameter > role="reference">secondparameter</parameter></methodparam> > + <!-- Example: If no methodparams exist (void), use this --> > + <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>&lt;?php</code> and > <code>?&gt;</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, macOS, 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/reflection/reflectionfunctionabstract/getstaticvariables.xml > By: anonymous on 2018-05-08 12:16:26 > =================================================================== > --- > en/reference/reflection/reflectionfunctionabstract/getstaticvariables.xml > +++ > en/reference/reflection/reflectionfunctionabstract/getstaticvariables.xml > @@ -31,6 +31,13 @@ > <para> > An <type>array</type> of static variables. > </para> > + > + <caution> > + <para> > + Parameters inherited from a higher scope passed to a closure by > reference will > + be references in this array. Altering them may have unintended > side-effects. > + </para> > + </caution> > </refsect1> > > <refsect1 role="seealso"> > > > => Put this change into your patches : > > https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=83286 > => Delete this change: > > https://edit.php.net/?project=php&action=deleteThisChange&idDB=83286 > > > ------------------------------------------------------------------ > > Modified: en/language/oop5/visibility.xml > By: rjhdby on 2018-05-17 06:02:53 > =================================================================== > --- en/language/oop5/visibility.xml > +++ en/language/oop5/visibility.xml > @@ -8,11 +8,12 @@ > <emphasis>protected</emphasis> or > <emphasis>private</emphasis>. Class members declared public can be > accessed everywhere. Members declared protected can be accessed > - only within the class itself and by inheriting and parent > - classes. Members declared as private may only be accessed by the > + only within the class itself and by inheriting. > + Members declared as private may only be accessed by the > class that defines the member. > </para> > - > + <note>You can access protected members of a class or object from > inherited methods. > + Do <emphasis>NOT</emphasis> rely on this behavior, because it can be > changed at any time.</note> > <sect2 xml:id="language.oop5.visibility-members"> > <title>Property Visibility</title> > <para> > > > => Put this change into your patches : > > https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=83547 > => Delete this change: > > https://edit.php.net/?project=php&action=deleteThisChange&idDB=83547 > > > ------------------------------------------------------------------ > > 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/exec/functions/shell-exec.xml > By: Renoir Faria on 2018-07-01 00:03:18 > =================================================================== > --- en/reference/exec/functions/shell-exec.xml > +++ en/reference/exec/functions/shell-exec.xml > @@ -68,15 +68,6 @@ > </para> > </refsect1> > > - <refsect1 role="notes"> > - &reftitle.notes; > - <note> > - <para> > - &sm.disabled; > - </para> > - </note> > - </refsect1> > - > <refsect1 role="seealso"> > &reftitle.seealso; > <para> > > > => Put this change into your patches : > > https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=84389 > => Delete this change: > > https://edit.php.net/?project=php&action=deleteThisChange&idDB=84389 > > > ------------------------------------------------------------------ > > Modified: en/reference/datetime/formats.xml > By: anonymous on 2018-07-02 05:53:29 > =================================================================== > --- en/reference/datetime/formats.xml > +++ en/reference/datetime/formats.xml > @@ -366,23 +366,23 @@ > </thead> > <tbody> > <row> > - <entry>Eight digit year, month and day</entry> > - <entry><literal>YY</literal> <literal>MM</literal> > <literal>DD</literal></entry> > + <entry>Four digit year, month and day</entry> > + <entry><literal>YYYY</literal> <literal>MM</literal> > <literal>DD</literal></entry> > <entry>"15810726", "19780417", > "18140517"</entry> > </row> > <row> > <entry>Four digit year, month and day with slashes</entry> > - <entry><literal>YY</literal> "/" > <literal>MM</literal> "/" > <literal>DD</literal></entry> > + <entry><literal>YYYY</literal> "/" > <literal>MM</literal> "/" > <literal>DD</literal></entry> > <entry>"2008/06/30", "1978/12/22"</entry> > </row> > <row> > <entry>Two digit year, month and day with dashes</entry> > - <entry><literal>yy</literal> "-" > <literal>MM</literal> "-" > <literal>DD</literal></entry> > + <entry><literal>YY</literal> "-" > <literal>MM</literal> "-" > <literal>DD</literal></entry> > <entry>"08-06-30", "78-12-22"</entry> > </row> > <row> > <entry>Four digit year with optional sign, month and day</entry> > - <entry>[+-]? <literal>YY</literal> "-" > <literal>MM</literal> "-" > <literal>DD</literal></entry> > + <entry>[+-]? <literal>YYYY</literal> "-" > <literal>MM</literal> "-" > <literal>DD</literal></entry> > <entry>"-0002-07-26", "+1978-04-17", > "1814-05-17"</entry> > </row> > </tbody> > > > => Put this change into your patches : > Êîeáß¾ÖÒp > `þ‚https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=84394 > => Delete this change: > > https://edit.php.net/?project=php&action=deleteThisChange&idDB=84394 > > > ------------------------------------------------------------------ > > > > > -- > https://edit.php.net/ > This email is send automatically by the Php Docbook Online Editor. >