sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-15 16:38:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated the soft deprecation alternatives syntax

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@325976 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson 2012-06-05 04:25:50 +00:00
parent 203cd3e98e
commit b80218f662
13 changed files with 118 additions and 133 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
language-snippets.ent
View file

@ -1086,12 +1086,10 @@ field_offset</parameter></term><listitem><para>The numerical field offset. The
<parameter>field_offset</parameter> does not exist, an error of level
<constant>E_WARNING</constant> is also issued.</para></listitem></varlistentry>'>
<!ENTITY mysql.alternative.include 'Alternatives to this function include: '>
<!ENTITY mysql.alternative.note '<title xmlns="http://docbook.org/ns/docbook">Suggested alternatives</title>
<para xmlns="http://docbook.org/ns/docbook">Use of this extension is discouraged. Instead, the <link linkend="book.mysqli">MySQLi</link> or
<link linkend="ref.pdo-mysql">PDO_MySQL</link> extension should be used. See also <link linkend="mysqlinfo.api.choosing">MySQL:
choosing an API</link> for more information.</para>'>
choosing an API</link> for more information. Alternatives to this function include:</para>'>
<!-- Sybase Notes -->
<!ENTITY sybase.ct.only '<note xmlns="http://docbook.org/ns/docbook"><simpara>This function is only available when

23
reference/mysql/functions/mysql-client-encoding.xml
View file

@ -6,6 +6,15 @@
<refpurpose>Returns the name of the character set</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_character_set_name</function></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@ -58,20 +67,6 @@ The current character set is: latin1
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
&mysql.alternative.note;
<para>
&mysql.alternative.include;
<simplelist>
<member><function>mysqli_character_set_name</function></member>
<member><methodname>PDO::setAttribute</methodname> (e.g., <literal>$db->setAttribute(PDO::MYSQL_ATTR_INIT_COMMAND, "SET NAMES 'utf8'");</literal>)</member>
</simplelist>
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>

20
reference/mysql/functions/mysql-close.xml
View file

@ -6,6 +6,16 @@
<refpurpose>Close MySQL connection</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_close</function></member>
<member>PDO: Assign the value of &null; to the PDO object</member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@ -72,16 +82,6 @@ Connected successfully
<refsect1 role="notes">
&reftitle.notes;
<note>
&mysql.alternative.note;
<para>
&mysql.alternative.include;
<simplelist>
<member><function>mysqli_close</function></member>
<member>PDO: Assign the value of &null; to the PDO object</member>
</simplelist>
</para>
</note>
<note>
<para>
<function>mysql_close</function> will not close persistent links

20
reference/mysql/functions/mysql-connect.xml
View file

@ -6,6 +6,16 @@
<refpurpose>Open a connection to a MySQL Server</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_connect</function></member>
<member><methodname>PDO::__construct</methodname></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@ -212,16 +222,6 @@ mysql_close($link);
<refsect1 role="notes">
&reftitle.notes;
<note>
&mysql.alternative.note;
<para>
&mysql.alternative.include;
<simplelist>
<member><function>mysqli_connect</function></member>
<member><methodname>PDO::__construct</methodname></member>
</simplelist>
</para>
</note>
<note>
<para>
Whenever you specify &quot;localhost&quot; or

20
reference/mysql/functions/mysql-create-db.xml
View file

@ -6,6 +6,16 @@
<refpurpose>Create a MySQL database</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_query</function></member>
<member><methodname>PDO::query</methodname></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@ -83,16 +93,6 @@ Database my_db created successfully
<refsect1 role="notes">
&reftitle.notes;
<note>
&mysql.alternative.note;
<para>
&mysql.alternative.include;
<simplelist>
<member><function>mysqli_query</function></member>
<member><methodname>PDO::query</methodname></member>
</simplelist>
</para>
</note>
<note>
<para>
&info.deprecated.alias;

20
reference/mysql/functions/mysql-data-seek.xml
View file

@ -6,6 +6,16 @@
<refpurpose>Move internal result pointer</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_data_seek</function></member>
<member><constant>PDO::FETCH_ORI_ABS</constant></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@ -99,16 +109,6 @@ mysql_free_result($result);
<refsect1 role="notes">
&reftitle.notes;
<note>
&mysql.alternative.note;
<para>
&mysql.alternative.include;
<simplelist>
<member><function>mysqli_data_seek</function></member>
<member><constant>PDO::FETCH_ORI_ABS</constant></member>
</simplelist>
</para>
</note>
<note>
<para>
The function <function>mysql_data_seek</function> can be used in

18
reference/mysql/functions/mysql-db-name.xml
View file

@ -6,6 +6,15 @@
<refpurpose>Retrieves database name from the call to <function>mysql_list_dbs</function></refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member>Query: <literal>SELECT DATABASE()</literal></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@ -89,15 +98,6 @@ while ($i < $cnt) {
<refsect1 role="notes">
&reftitle.notes;
<note>
&mysql.alternative.note;
<para>
&mysql.alternative.include;
<simplelist>
<member>Query: <literal>SELECT DATABASE()</literal></member>
</simplelist>
</para>
</note>
<note>
<para>
&info.deprecated.alias;

20
reference/mysql/functions/mysql-db-query.xml
View file

@ -6,6 +6,16 @@
<refpurpose>Selects a database and executes a query on it</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_select_db</function> then the query</member>
<member><methodname>PDO::__construct</methodname></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@ -135,16 +145,6 @@ mysql_free_result($result);
<refsect1 role="notes">
&reftitle.notes;
<note>
&mysql.alternative.note;
<para>
&mysql.alternative.include;
<simplelist>
<member><function>mysqli_select_db</function> then the query</member>
<member><methodname>PDO::__construct</methodname></member>
</simplelist>
</para>
</note>
<note>
<para>
Be aware that this function does <emphasis role="strong">NOT</emphasis>

18
reference/mysql/functions/mysql-drop-db.xml
View file

@ -6,6 +6,15 @@
<refpurpose>Drop (delete) a MySQL database</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member>Execute a <literal>DROP DATABASE</literal> query</member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@ -74,15 +83,6 @@ if (mysql_query($sql, $link)) {
<refsect1 role="notes">
&reftitle.notes;
<note>
&mysql.alternative.note;
<para>
&mysql.alternative.include;
<simplelist>
<member>Execute a <literal>DROP DATABASE</literal> query</member>
</simplelist>
</para>
</note>
<warning>
<para>
This function will not be available if the MySQL extension was built

24
reference/mysql/functions/mysql-errno.xml
View file

@ -6,6 +6,16 @@
<refpurpose>Returns the numerical value of the error message from previous MySQL operation</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_errno</function></member>
<member><methodname>PDO::errorCode</methodname></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@ -76,20 +86,6 @@ if (!mysql_query("SELECT * FROM nonexistenttable", $link)) {
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
&mysql.alternative.note;
<para>
&mysql.alternative.include;
<simplelist>
<member><function>mysqli_errno</function></member>
<member><methodname>PDO::errorCode</methodname></member>
</simplelist>
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>

24
reference/mysql/functions/mysql-error.xml
View file

@ -6,6 +6,16 @@
<refpurpose>Returns the text of the error message from previous MySQL operation</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_error</function></member>
<member><methodname>PDO::errorInfo</methodname></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@ -71,20 +81,6 @@ echo mysql_errno($link) . ": " . mysql_error($link) . "\n";
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
&mysql.alternative.note;
<para>
&mysql.alternative.include;
<simplelist>
<member><function>mysqli_error</function></member>
<member><methodname>PDO::errorInfo</methodname></member>
</simplelist>
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>

20
reference/mysql/functions/mysql-escape-string.xml
View file

@ -6,6 +6,16 @@
<refpurpose>Escapes a string for use in a mysql_query</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_escape_string</function></member>
<member><methodname>PDO::quote</methodname></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@ -107,16 +117,6 @@ Escaped string: Zak\'s Laptop
<refsect1 role="notes">
&reftitle.notes;
<note>
&mysql.alternative.note;
<para>
&mysql.alternative.include;
<simplelist>
<member><function>mysqli_escape_string</function></member>
<member><methodname>PDO::quote</methodname></member>
</simplelist>
</para>
</note>
<note>
<para>
<function>mysql_escape_string</function> does not escape

20
reference/mysql/functions/mysql-set-charset.xml
View file

@ -6,6 +6,16 @@
<refpurpose>Sets the client character set</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_character_set_name</function></member>
<member><methodname>PDO::setAttribute</methodname> (e.g., <literal>$db->setAttribute(PDO::MYSQL_ATTR_INIT_COMMAND, "SET NAMES 'utf8'");</literal>)</member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@ -44,16 +54,6 @@
<refsect1 role="notes">
&reftitle.notes;
<note>
&mysql.alternative.note;
<para>
&mysql.alternative.include;
<simplelist>
<member><function>mysqli_character_set_name</function></member>
<member><methodname>PDO::setAttribute</methodname> (e.g., <literal>$db->setAttribute(PDO::MYSQL_ATTR_INIT_COMMAND, "SET NAMES 'utf8'");</literal>)</member>
</simplelist>
</para>
</note>
<note>
<para>
This function requires MySQL 5.0.7 or later.