Contributions are ready for review
| From: | phpdoc at lists dot php dot net | Date: | Mon, 03 Nov 2014 13:00:03 +0000 |
| Subject: | Contributions are ready for review | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969385233@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/faq/installation.xml
By: mattficken on 2014-09-04 14:39:45
===================================================================
--- en/faq/installation.xml
+++ en/faq/installation.xml
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 334758 $ -->
+<!-- $Revision: 311461 $ -->
<chapter xml:id="faq.installation" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Installation</title>
<titleabbrev>Installation</titleabbrev>
@@ -394,9 +394,9 @@
<function>phpinfo</function>. Near the top, there will be a
listing called <literal>Configuration File (php.ini)</literal>.
This will tell you where PHP is looking for &php.ini; and
- whether or not it's being read. If just a directory <envar>PATH</envar>
exists,
+ whether or not it's being read. If just a directory PATH exists,
then it's not being read, and you should put your &php.ini;
- in that directory. If &php.ini; is included within the <envar>PATH</envar>,
+ in that directory. If &php.ini; is included within the PATH,
it is being read.
</para>
<para>
@@ -413,18 +413,16 @@
<qandaentry xml:id="faq.installation.addtopath">
<question>
<para>
- How do I add my PHP directory to the <envar>PATH</envar>
+ How do I add my PHP directory to the <varname>PATH</varname>
on Windows?
</para>
</question>
<answer>
<para>
- On Windows NT+ and Windows Server 2000+:
+ On Windows 7, XP, Vista, 2008, 2012 and up
<itemizedlist>
<listitem><para>
- Go to Control Panel and open the System icon (Start -> Settings
- -> Control Panel -> System, or just Start -> Control Panel
- -> System for Windows XP/2003+)
+ Go to Control Panel and open the System icon (Start -> Control Panel)
</para></listitem>
<listitem><para>
Go to the Advanced tab
@@ -450,107 +448,18 @@
</para></listitem>
</itemizedlist>
</para>
- <para>
- On Windows 98/Me you need to edit the <filename>autoexec.bat</filename>
- file:
- <itemizedlist>
- <listitem><para>
- Open the Notepad (Start -> Run and enter notepad)
- </para></listitem>
- <listitem><para>
- Open the <filename>C:autoexec.bat</filename> file
- </para></listitem>
- <listitem><para>
- Locate the line with PATH=C:WINDOWS;C:WINDOWSCOMMAND;..... and add:
- <literal>;C:php</literal> to the end of the line
- </para></listitem>
- <listitem><para>
- Save the file and restart your computer
- </para></listitem>
- </itemizedlist>
- </para>
- <note>
- <simpara>
- Be sure to reboot after following the steps above to ensure that the
- <envar>PATH</envar> changes are applied.
- </simpara>
- </note>
- <para>
- The PHP manual used to promote the copying of files into the Windows
- system directory, this is because this directory
+
+ <para>
+ The PHP manual used to promote the copying of files into the Windows
+ system directory, this is because this directory
(<filename>C:Windows</filename>, <filename>C:WINNT</filename>, etc.)
- is by default in the system's <envar>PATH</envar>. Copying files into the
Windows
+ is by default in the systems PATH. Copying files into the Windows
system directory has long since been deprecated and may cause problems.
</para>
</answer>
</qandaentry>
- <qandaentry xml:id="faq.installation.phprc">
- <question>
- <para>
- How do I make the &php.ini; file available to PHP on windows?
- </para>
- </question>
- <answer>
- <para>
- There are several ways of doing this. If you are using Apache, read
- their installation specific instructions (<link
- linkend="install.windows.apache1">Apache 1</link>, <link
- linkend="install.windows.apache2">Apache 2</link>), otherwise you must
- set the <varname>PHPRC</varname> environment variable:
- </para>
- <para>
- On Windows NT, 2000, XP and 2003:
- <itemizedlist>
- <listitem><para>
- Go to Control Panel and open the System icon (Start -> Settings
- -> Control Panel -> System, or just Start -> Control Panel
- -> System for Windows XP/2003)
- </para></listitem>
- <listitem><para>
- Go to the Advanced tab
- </para></listitem>
- <listitem><para>
- Click on the 'Environment Variables' button
- </para></listitem>
- <listitem><para>
- Look into the 'System variables' pane
- </para></listitem>
- <listitem><para>
- Click on 'New' and enter 'PHPRC' as the variable name and the
- directory where &php.ini; is located as the variable value (e.g.
- <literal>C:php</literal>)
- </para></listitem>
- <listitem><para>
- Press OK and restart your computer
- </para></listitem>
- </itemizedlist>
- </para>
- <para>
- On Windows 98/Me you need to edit the <filename>autoexec.bat</filename>
- file:
- <itemizedlist>
- <listitem><para>
- Open the Notepad (Start -> Run and enter notepad)
- </para></listitem>
- <listitem><para>
- Open the <filename>C:autoexec.bat</filename> file
- </para></listitem>
- <listitem><para>
- Add a new line to the end of the file: <literal>set
- PHPRC=C:php</literal> (replace <literal>C:php</literal> with the
- directory where &php.ini; is located). Please note that the path
- cannot contain spaces. For instance, if you have installed PHP in
- <filename>C:Program FilesPHP</filename>, you would enter
- <filename>C:PROGRA~1PHP</filename> instead.
- </para></listitem>
- <listitem><para>
- Save the file and restart your computer
- </para></listitem>
- </itemizedlist>
- </para>
- </answer>
- </qandaentry>
+
<qandaentry xml:id="faq.installation.apache.multiviews">
<question>
=> Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=57941
=> Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=57941
------------------------------------------------------------------
Modified: en/reference/reflection/reflectionparameter/allowsnull.xml
By: ajf on 2014-09-13 18:30:56
===================================================================
--- en/reference/reflection/reflectionparameter/allowsnull.xml
+++ en/reference/reflection/reflectionparameter/allowsnull.xml
@@ -14,7 +14,7 @@
<void />
</methodsynopsis>
<para>
- Checks whether the parameter allows &null;.
+ Checks whether the parameter is nullable, i.e. that it allows &null;.
</para>
&warn.undocumented.func;
@@ -29,7 +29,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- &true; if &null; is allowed, otherwise &false;
+ &true; if nullable, otherwise &false;
</para>
</refsect1>
=> Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=58093
=> Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=58093
------------------------------------------------------------------
Modified: en/reference/imap/functions/imap-search.xml
By: nathanb on 2014-09-15 17:19:37
===================================================================
--- en/reference/imap/functions/imap-search.xml
+++ en/reference/imap/functions/imap-search.xml
@@ -12,7 +12,7 @@
<methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>string</type><parameter>criteria</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>options</parameter><initializer>SE_FREE</initializer></methodparam>
- <methodparam
choice="opt"><type>string</type><parameter>charset</parameter><initializer>NIL</initializer></methodparam>
+ <methodparam
choice="opt"><type>string</type><parameter>charset</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
This function performs a search on the mailbox currently opened
=> Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=58112
=> Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=58112
------------------------------------------------------------------
Modified: en/appendices/ini.core.xml
By: on 2014-09-28 12:17:29
===================================================================
--- en/appendices/ini.core.xml
+++ en/appendices/ini.core.xml
@@ -638,12 +638,6 @@
</thead>
<tbody>
<row>
- <entry><link
linkend="ini.track-vars">track_vars</link></entry>
- <entry>"On"</entry>
- <entry>PHP_INI_??</entry>
- <entry></entry>
- </row>
- <row>
<entry><link
linkend="ini.arg-separator.output">arg_separator.output</link></entry>
<entry>"&"</entry>
<entry>PHP_INI_ALL</entry>
@@ -748,28 +742,6 @@
<para>
<variablelist>
- <varlistentry xml:id="ini.track-vars">
- <term>
- <parameter>track_vars</parameter>
- <type>boolean</type>
- </term>
- <listitem>
- <para>
- If enabled, then Environment, GET, POST, Cookie, and Server
- variables can be found in the global associative arrays
- <varname>$_ENV</varname>,
- <varname>$_GET</varname>,
- <varname>$_POST</varname>,
- <varname>$_COOKIE</varname>, and
- <varname>$_SERVER</varname>.
- </para>
- <para>
- Note that as of PHP 4.0.3, <systemitem
- role="directive">track_vars</systemitem> is always turned on.
- </para>
- </listitem>
- </varlistentry>
-
<varlistentry xml:id="ini.arg-separator.output">
<term>
<parameter>arg_separator.output</parameter>
=> Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=58690
=> Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=58690
------------------------------------------------------------------
Modified: en/reference/exec/functions/escapeshellarg.xml
By: Petr Hudeček on 2014-10-08 05:00:05
===================================================================
--- en/reference/exec/functions/escapeshellarg.xml
+++ en/reference/exec/functions/escapeshellarg.xml
@@ -22,6 +22,11 @@
include <function>exec</function>, <function>system</function> and the
<link linkend="language.operators.execution">backtick operator</link>.
</para>
+ <para>
+ On Windows, <function>escapeshellarg</function> instead removes percent
+ signs, replaces double quotes with spaces and adds double quotes around the
+ string.
+ </para>
</refsect1>
<refsect1 role="parameters">
=> Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=58764
=> Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=58764
------------------------------------------------------------------
Modified: en/language/basic-syntax.xml
By: ktretyak on 2014-10-10 15:51:48
===================================================================
--- en/language/basic-syntax.xml
+++ en/language/basic-syntax.xml
@@ -13,11 +13,11 @@
of opening and closing tags is ignored by the PHP parser.
</para>
<para>
- PHP also allows for short open tags <literal><?</literal> and
<literal>?></literal>
- (which are discouraged because they are only available if enabled with
+ PHP also allows for short open tag <literal><?</literal>
+ (which is discouraged because it is only available if enabled with
<link linkend="ini.short-open-tag">short_open_tag</link> &php.ini;
configuration
file directive, or if PHP was configured with the
<option>--enable-short-tags</option>
- option.
+ option).
</para>
<para>
If a file is pure PHP code, it is preferable to omit the PHP closing tag at the
@@ -111,18 +111,19 @@
<title>PHP Opening and Closing Tags</title>
<programlisting role="php">
<![CDATA[
-1. <?php echo 'if you want to serve XHTML or XML documents, do it like this'; ?>
+1. <?php echo 'if you want to serve PHP code in XHTML or XML documents,
+ use these tags'; ?>
2. <script language="php">
echo 'some editors (like FrontPage) don't
- like processing instructions';
+ like processing instructions within these tags';
</script>
-3. <? echo 'this is the simplest, an SGML processing instruction'; ?>
- <?= expression ?> This is a shortcut for "<? echo expression ?>"
+3. <? echo 'this code is within short tags'; ?>
+ Code within these tags <?= 'some text' ?> is a shortcut for this code <?
echo 'some text' ?>
4. <% echo 'You may optionally use ASP-style tags'; %>
- <%= $variable; %> This is a shortcut for "<% echo $variable; %>"
+ Code within these tags <%= $variable; %> is a shortcut for this code <% echo
$variable; %>
]]>
</programlisting>
</example>
=> Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=58783
=> Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=58783
------------------------------------------------------------------
Modified: en/reference/mysqli/mysqli/insert-id.xml
By: Kirk Bater on 2014-10-14 09:40:50
===================================================================
--- en/reference/mysqli/mysqli/insert-id.xml
+++ en/reference/mysqli/mysqli/insert-id.xml
@@ -10,7 +10,10 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
- <fieldsynopsis><type>mixed</type><varname
linkend="mysqli.insert-id">mysqli->insert_id</varname></fieldsynopsis>
+ <methodsynopsis>
+ <type>mixed</type>
+ <varname linkend="mysqli.insert-id">mysqli->insert_id</varname>
+ </methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis>
<type>mixed</type><methodname>mysqli_insert_id</methodname>
=> Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=58817
=> Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=58817
------------------------------------------------------------------
Modified: en/install/unix/apache2.xml
By: ktretyak on 2014-10-15 10:43:58
===================================================================
--- en/install/unix/apache2.xml
+++ en/install/unix/apache2.xml
@@ -114,8 +114,8 @@
<para>
Now, configure and build PHP. This is where you customize PHP
with various options, like which extensions will be enabled. Run
-./configure --help for a list of available options. In our example
-we'll do a simple configure with Apache 2 and MySQL support.
+<command>./configure --help</command> for a list of available options. In our
+example we'll do a simple configure with Apache 2 and MySQL support.
</para>
<para>
@@ -165,7 +165,8 @@
<para>
You may edit your .ini file to set PHP options. If you prefer having
- php.ini in another location, use --with-config-file-path=/some/path in
+ php.ini in another location, use
+ <command>--with-config-file-path=/some/path</command> in
step 5.
</para>
@@ -181,8 +182,8 @@
<para>
Edit your httpd.conf to load the PHP module. The path on the right hand
side of the LoadModule statement must point to the path of the PHP
- module on your system. The make install from above may have already
- added this for you, but be sure to check.
+ module on your system. The <command>make install</command> from above
+ may have already added this for you, but be sure to check.
</para>
<example>
@@ -307,7 +308,8 @@
Apache may be built multithreaded by selecting the
<filename>worker</filename> MPM, rather than the standard
<filename>prefork</filename> MPM, when Apache is built. This is done by
- adding the following option to the argument passed to ./configure, in
+ adding the following option to the argument passed to
+ <command>./configure</command>, in
step 3 above:
</para>
<example>
=> Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=58840
=> Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=58840
------------------------------------------------------------------
Modified: en/reference/misc/functions/usleep.xml
By: dima on 2014-10-19 17:06:58
===================================================================
--- en/reference/misc/functions/usleep.xml
+++ en/reference/misc/functions/usleep.xml
@@ -13,7 +13,7 @@
<methodparam><type>int</type><parameter>micro_seconds</parameter></methodparam>
</methodsynopsis>
<para>
- Delays program execution for the given number of micro seconds.
+ Delays program execution for the given number of microseconds.
</para>
</refsect1>
@@ -25,7 +25,7 @@
<term><parameter>micro_seconds</parameter></term>
<listitem>
<para>
- Halt time in micro seconds. A micro second is one millionth of a
+ Halt time in microseconds. A microsecond is one millionth of a
second.
</para>
</listitem>
=> Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=58912
=> Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=58912
------------------------------------------------------------------
Modified: en/reference/curl/functions/curl-getinfo.xml
By: François Bonzon on 2014-10-24 12:01:09
===================================================================
--- en/reference/curl/functions/curl-getinfo.xml
+++ en/reference/curl/functions/curl-getinfo.xml
@@ -81,7 +81,7 @@
</listitem>
<listitem>
<simpara>
- <constant>CURLINFO_REDIRECT_URL</constant> - URL of final transaction, with
the <constant>CURLOPT_FOLLOWLOCATION</constant> option enabled
+ <constant>CURLINFO_REDIRECT_URL</constant> - With the
<constant>CURLOPT_FOLLOWLOCATION</constant> option disabled: redirect URL found in the
last transaction, that should be requested manually next. With the
<constant>CURLOPT_FOLLOWLOCATION</constant> option enabled: this is empty. The redirect
URL in this case is available in <constant>CURLINFO_EFFECTIVE_URL</constant>
</simpara>
</listitem>
<listitem>
@@ -161,6 +161,11 @@
<constant>CURLINFO_CONTENT_TYPE</constant> -
<literal>Content-Type:</literal> of the requested document, NULL indicates server did
not send valid <literal>Content-Type:</literal> header
</simpara>
</listitem>
+ <listitem>
+ <simpara>
+ <constant>CURLINFO_PRIVATE</constant> - Private data associated with this
cURL handle, previously set with the <constant>CURLOPT_PRIVATE</constant> option of
<function>curl_setopt</function>
+ </simpara>
+ </listitem>
</itemizedlist>
</para>
</listitem>
@@ -313,6 +318,7 @@
</simpara>
</listitem>
</itemizedlist>
+ Note that private data is not included in the associative array and must be retrieved
individually with the <constant>CURLINFO_PRIVATE</constant> option.
</para>
</refsect1>
@@ -335,6 +341,12 @@
</entry>
</row>
<row>
+ <entry>5.2.4</entry>
+ <entry>
+ Introduced <constant>CURLINFO_PRIVATE</constant>.
+ </entry>
+ </row>
+ <row>
<entry>5.1.3</entry>
<entry>
Introduced <constant>CURLINFO_HEADER_OUT</constant>.
=> Put this change into your patches : https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=58946
=> Delete this change: https://edit.php.net/?project=php&action=deleteThisChange&idDB=58946
------------------------------------------------------------------
--
https://edit.php.net/
This email is send automatically by the Php Docbook Online Editor.