Added soft-deprecation-notice for each function, including ext/mysqli and PDO alternatives

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@325980 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson 2012-06-05 07:55:24 +00:00
parent b80218f662
commit c53a5feeaf
34 changed files with 331 additions and 0 deletions

View file

@ -6,6 +6,16 @@
<refpurpose>Fetch a result row as an associative array, a numeric array, or both</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_fetch_array</function></member>
<member><methodname>PDOStatement::fetch</methodname></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,16 @@
<refpurpose>Fetch a result row as an associative array</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_fetch_assoc</function></member>
<member><methodname>PDOStatement::fetch(PDO::FETCH_ASSOC)</methodname></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,16 @@
<refpurpose>Get column information from a result and return as an object</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_fetch_field</function></member>
<member><methodname>PDOStatement::getColumnMeta</methodname></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,16 @@
<refpurpose>Get the length of each output in a result</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_fetch_lengths</function></member>
<member><methodname>PDOStatement::getColumnMeta</methodname></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,16 @@
<refpurpose>Fetch a result row as an object</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_fetch_object</function></member>
<member><methodname>PDOStatement::fetch(PDO::FETCH_OBJ)</methodname></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,16 @@
<refpurpose>Get a result row as an enumerated array</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_fetch_row</function></member>
<member><methodname>PDOStatement::fetch(PDO::FETCH_NUM)</methodname></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,16 @@
<refpurpose>Get the flags associated with the specified field in a result</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_fetch_fields</function> (flags)</member>
<member><methodname>PDOStatement::getColumnMeta</methodname> (flags)</member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,16 @@
<refpurpose>Returns the length of the specified field</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_fetch_field_direct</function> (length)</member>
<member><methodname>PDOStatement::getColumnMeta</methodname> (len)</member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,16 @@
<refpurpose>Get the name of the specified field in a result</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_fetch_field_direct</function> (name or orgname)</member>
<member><methodname>PDOStatement::getColumnMeta</methodname> (name)</member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,17 @@
<refpurpose>Set result pointer to a specified field offset</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_field_seek</function></member>
<!-- @TODO Expand on the following -->
<member><methodname>PDOStatement::fetch</methodname> using optional parameters</member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,16 @@
<refpurpose>Get name of the table the specified field is in</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_fetch_field_direct</function> (table or orgtable)</member>
<member><methodname>PDOStatement::getColumnMeta</methodname> (table)</member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,16 @@
<refpurpose>Get the type of the specified field in a result</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_fetch_field_direct</function> (type)</member>
<member><methodname>PDOStatement::getColumnMeta</methodname> (driver:decl_type or pdo_type)</member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,16 @@
<refpurpose>Free result memory</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_free_result</function></member>
<member>Assign the value of &null; to the PDO object, or <methodname>PDOStatement::closeCursor</methodname></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,16 @@
<refpurpose>Get MySQL client info</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_get_client_info</function></member>
<member><methodname>PDO::getAttribute(PDO::ATTR_CLIENT_VERSION)</methodname></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,16 @@
<refpurpose>Get MySQL host info</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_get_host_info</function></member>
<member><methodname>PDO::getAttribute(PDO::ATTR_CONNECTION_STATUS)</methodname></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,15 @@
<refpurpose>Get MySQL protocol info</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_get_proto_info</function></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,16 @@
<refpurpose>Get MySQL server info</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_get_server_info</function></member>
<member><methodname>PDO::getAttribute(PDO::ATTR_SERVER_VERSION)</methodname></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,15 @@
<refpurpose>Get information about the most recent query</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_info</function></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,16 @@
<refpurpose>Get the ID generated in the last query</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_insert_id</function></member>
<member><methodname>PDO::lastInsertId</methodname></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,15 @@
<refpurpose>List databases available on a MySQL server</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member>SQL Query: <literal>SHOW DATABASES</literal></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,15 @@
<refpurpose>List MySQL table fields</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member>SQL Query: <literal>SHOW COLUMNS FROM sometable</literal></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,15 @@
<refpurpose>List MySQL processes</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_thread_id</function></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,15 @@
<refpurpose>List tables in a MySQL database</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member>SQL Query: <literal>SHOW TABLES FROM sometable</literal></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,16 @@
<refpurpose>Get number of fields in result</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_field_count</function></member>
<member><methodname>PDOStatement::columnCount</methodname></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,16 @@
<refpurpose>Get number of rows in result</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_stmt_num_rows</function></member>
<member><methodname>PDOStatement::rowCount</methodname></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,16 @@
<refpurpose>Open a persistent connection to a MySQL server</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_connect</function> with <literal>p:</literal> host prefix</member>
<member><methodname>PDO::__construct</methodname> with <constant>PDO::ATTR_PERSISTENT</constant> as a driver option</member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,15 @@
<refpurpose>Ping a server connection or reconnect if there is no connection</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_ping</function></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,16 @@
<refpurpose>Send a MySQL query</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>

View file

@ -6,6 +6,16 @@
<refpurpose>Escapes special characters in a string for use in an SQL statement</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_real_escape_string</function></member>
<member><methodname>PDO::quote</methodname></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,16 @@
<refpurpose>Select a MySQL database</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_select_db</function></member>
<member><methodname>PDO::__construct</methodname> (part of dsn)</member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,16 @@
<refpurpose>Get current system status</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_stat</function></member>
<member><methodname>PDO::getAttribute(PDO::ATTR_SERVER_INFO)</methodname></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,15 @@
<refpurpose>Get table name of field</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member>SQL Query: <literal>SHOW TABLES</literal></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,15 @@
<refpurpose>Return the current thread ID</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member><function>mysqli_thread_id</function></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

View file

@ -6,6 +6,15 @@
<refpurpose>Send an SQL query to MySQL without fetching and buffering the result rows.</refpurpose>
</refnamediv>
<refsynopsisdiv role="soft-deprecation-notice">
<sidebar>
&mysql.alternative.note;
<simplelist role="alternatives">
<member>See: <link linkend="mysqlinfo.concepts.buffering">Buffered and Unbuffered queries</link></member>
</simplelist>
</sidebar>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>