sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-17 01:18:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

MySQLi: various updates [2] - method modifiers (mysqli)

Browse source 
Add modifiers to the class methods for the mysqli class to make the [Class Synopsos](https://www.php.net/manual/en/class.mysqli.php#mysqli.synopsis) more consistent.

Based on the [stub](https://github.com/php/php-src/blob/master/ext/mysqli/mysqli.stub.php) all methods in the class are `public`, so I've annotated them as such.

Includes minor indentation fixes.

Patch contributed by jrfnl.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350059 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Christoph Michael Becker 2020-06-20 14:54:52 +00:00
parent cb9c00b594
commit 46319b5952
34 changed files with 38 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
reference/mysqli/mysqli/autocommit.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>bool</type><methodname>mysqli::autocommit</methodname>
<modifier>public</modifier> <type>bool</type><methodname>mysqli::autocommit</methodname>
<methodparam><type>bool</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>

2
reference/mysqli/mysqli/change-user.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>bool</type><methodname>mysqli::change_user</methodname>
<modifier>public</modifier> <type>bool</type><methodname>mysqli::change_user</methodname>
<methodparam><type>string</type><parameter>user</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
<methodparam><type>string</type><parameter>database</parameter></methodparam>

2
reference/mysqli/mysqli/character-set-name.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>string</type><methodname>mysqli::character_set_name</methodname>
<modifier>public</modifier> <type>string</type><methodname>mysqli::character_set_name</methodname>
<void />
</methodsynopsis>
<para>&style.procedural;</para>

2
reference/mysqli/mysqli/close.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>bool</type><methodname>mysqli::close</methodname>
<modifier>public</modifier> <type>bool</type><methodname>mysqli::close</methodname>
<void />
</methodsynopsis>
<para>&style.procedural;</para>

2
reference/mysqli/mysqli/commit.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>bool</type><methodname>mysqli::commit</methodname>
<modifier>public</modifier> <type>bool</type><methodname>mysqli::commit</methodname>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>

4
reference/mysqli/mysqli/construct.xml
View file

@ -12,7 +12,7 @@
&reftitle.description;
<para>&style.oop;</para>
<constructorsynopsis>
<methodname>mysqli::__construct</methodname>
<modifier>public</modifier> <methodname>mysqli::__construct</methodname>
<methodparam choice="opt"><type>string</type><parameter>host</parameter><initializer>ini_get("mysqli.default_host")</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>username</parameter><initializer>ini_get("mysqli.default_user")</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>passwd</parameter><initializer>ini_get("mysqli.default_pw")</initializer></methodparam>
@ -21,7 +21,7 @@
<methodparam choice="opt"><type>string</type><parameter>socket</parameter><initializer>ini_get("mysqli.default_socket")</initializer></methodparam>
</constructorsynopsis>
<methodsynopsis role="oop">
<type>void</type><methodname>mysqli::connect</methodname>
<modifier>public</modifier> <type>void</type><methodname>mysqli::connect</methodname>
<methodparam choice="opt"><type>string</type><parameter>host</parameter><initializer>ini_get("mysqli.default_host")</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>username</parameter><initializer>ini_get("mysqli.default_user")</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>passwd</parameter><initializer>ini_get("mysqli.default_pw")</initializer></methodparam>

2
reference/mysqli/mysqli/debug.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>bool</type><methodname>mysqli::debug</methodname>
<modifier>public</modifier> <type>bool</type><methodname>mysqli::debug</methodname>
<methodparam><type>string</type><parameter>message</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>

2
reference/mysqli/mysqli/dump-debug-info.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>bool</type><methodname>mysqli::dump_debug_info</methodname>
<modifier>public</modifier> <type>bool</type><methodname>mysqli::dump_debug_info</methodname>
<void/>
</methodsynopsis>
<para>&style.procedural;</para>

2
reference/mysqli/mysqli/get-charset.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>object</type><methodname>mysqli::get_charset</methodname>
<modifier>public</modifier> <type>object</type><methodname>mysqli::get_charset</methodname>
<void />
</methodsynopsis>
<para>&style.procedural;</para>

2
reference/mysqli/mysqli/get-client-info.xml
View file

@ -13,7 +13,7 @@
<para>&style.oop;</para>
<fieldsynopsis><type>string</type><varname linkend="mysqli.get-client-info">mysqli->client_info</varname></fieldsynopsis>
<methodsynopsis role="oop">
<type>string</type><methodname>mysqli::get_client_info</methodname>
<modifier>public</modifier> <type>string</type><methodname>mysqli::get_client_info</methodname>
<void />
</methodsynopsis>
<para>&style.procedural;</para>

2
reference/mysqli/mysqli/get-connection-stats.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>bool</type><methodname>mysqli::get_connection_stats</methodname>
<modifier>public</modifier> <type>bool</type><methodname>mysqli::get_connection_stats</methodname>
<void/>
</methodsynopsis>
<para>&style.procedural;</para>

2
reference/mysqli/mysqli/get-warnings.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>mysqli_warning</type><methodname>mysqli::get_warnings</methodname>
<modifier>public</modifier> <type>mysqli_warning</type><methodname>mysqli::get_warnings</methodname>
<void />
</methodsynopsis>
<para>&style.procedural;</para>

2
reference/mysqli/mysqli/init.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>mysqli</type><methodname>mysqli::init</methodname>
<modifier>public</modifier> <type>mysqli</type><methodname>mysqli::init</methodname>
<void/>
</methodsynopsis>
<para>&style.procedural;</para>

2
reference/mysqli/mysqli/kill.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>bool</type><methodname>mysqli::kill</methodname>
<modifier>public</modifier> <type>bool</type><methodname>mysqli::kill</methodname>
<methodparam><type>int</type><parameter>processid</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>

2
reference/mysqli/mysqli/more-results.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>bool</type><methodname>mysqli::more_results</methodname>
<modifier>public</modifier> <type>bool</type><methodname>mysqli::more_results</methodname>
<void />
</methodsynopsis>
<para>&style.procedural;</para>

2
reference/mysqli/mysqli/multi-query.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>bool</type><methodname>mysqli::multi_query</methodname>
<modifier>public</modifier> <type>bool</type><methodname>mysqli::multi_query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>

2
reference/mysqli/mysqli/next-result.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>bool</type><methodname>mysqli::next_result</methodname>
<modifier>public</modifier> <type>bool</type><methodname>mysqli::next_result</methodname>
<void />
</methodsynopsis>
<para>&style.procedural;</para>

2
reference/mysqli/mysqli/options.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>bool</type><methodname>mysqli::options</methodname>
<modifier>public</modifier> <type>bool</type><methodname>mysqli::options</methodname>
<methodparam><type>int</type><parameter>option</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>

2
reference/mysqli/mysqli/ping.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>bool</type><methodname>mysqli::ping</methodname>
<modifier>public</modifier> <type>bool</type><methodname>mysqli::ping</methodname>
<void/>
</methodsynopsis>
<para>&style.procedural;</para>

2
reference/mysqli/mysqli/prepare.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>mysqli_stmt</type><methodname>mysqli::prepare</methodname>
<modifier>public</modifier> <type>mysqli_stmt</type><methodname>mysqli::prepare</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>

2
reference/mysqli/mysqli/query.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>mixed</type><methodname>mysqli::query</methodname>
<modifier>public</modifier> <type>mixed</type><methodname>mysqli::query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>resultmode</parameter><initializer>MYSQLI_STORE_RESULT</initializer></methodparam>
</methodsynopsis>

2
reference/mysqli/mysqli/real-connect.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>bool</type><methodname>mysqli::real_connect</methodname>
<modifier>public</modifier> <type>bool</type><methodname>mysqli::real_connect</methodname>
<methodparam choice="opt"><type>string</type><parameter>host</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>passwd</parameter></methodparam>

2
reference/mysqli/mysqli/real-escape-string.xml
View file

@ -12,7 +12,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>string</type><methodname>mysqli::escape_string</methodname>
<modifier>public</modifier> <type>string</type><methodname>mysqli::escape_string</methodname>
<methodparam><type>string</type><parameter>escapestr</parameter></methodparam>
</methodsynopsis>
<methodsynopsis role="oop">

8
reference/mysqli/mysqli/real-query.xml
View file

@ -10,10 +10,10 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>bool</type><methodname>mysqli::real_query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>bool</type><methodname>mysqli::real_query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_real_query</methodname>

2
reference/mysqli/mysqli/rollback.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>bool</type><methodname>mysqli::rollback</methodname>
<modifier>public</modifier> <type>bool</type><methodname>mysqli::rollback</methodname>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>

2
reference/mysqli/mysqli/rpl-query-type.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>int</type><methodname>mysqli::rpl_query_type</methodname>
<modifier>public</modifier> <type>int</type><methodname>mysqli::rpl_query_type</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>

2
reference/mysqli/mysqli/select-db.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>bool</type><methodname>mysqli::select_db</methodname>
<modifier>public</modifier> <type>bool</type><methodname>mysqli::select_db</methodname>
<methodparam><type>string</type><parameter>dbname</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>

2
reference/mysqli/mysqli/send-query.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>bool</type><methodname>mysqli::send_query</methodname>
<modifier>public</modifier> <type>bool</type><methodname>mysqli::send_query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>

2
reference/mysqli/mysqli/set-charset.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>bool</type><methodname>mysqli::set_charset</methodname>
<modifier>public</modifier> <type>bool</type><methodname>mysqli::set_charset</methodname>
<methodparam><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>

2
reference/mysqli/mysqli/ssl-set.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>bool</type><methodname>mysqli::ssl_set</methodname>
<modifier>public</modifier> <type>bool</type><methodname>mysqli::ssl_set</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>string</type><parameter>cert</parameter></methodparam>
<methodparam><type>string</type><parameter>ca</parameter></methodparam>

2
reference/mysqli/mysqli/stat.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>string</type><methodname>mysqli::stat</methodname>
<modifier>public</modifier> <type>string</type><methodname>mysqli::stat</methodname>
<void />
</methodsynopsis>
<para>&style.procedural;</para>

2
reference/mysqli/mysqli/stmt-init.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>mysqli_stmt</type><methodname>mysqli::stmt_init</methodname>
<modifier>public</modifier> <type>mysqli_stmt</type><methodname>mysqli::stmt_init</methodname>
<void/>
</methodsynopsis>
<para>&style.procedural;</para>

2
reference/mysqli/mysqli/store-result.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>mysqli_result</type><methodname>mysqli::store_result</methodname>
<modifier>public</modifier> <type>mysqli_result</type><methodname>mysqli::store_result</methodname>
<methodparam choice="opt"><type>int</type><parameter>option</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>

2
reference/mysqli/mysqli/use-result.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>mysqli_result</type><methodname>mysqli::use_result</methodname>
<modifier>public</modifier> <type>mysqli_result</type><methodname>mysqli::use_result</methodname>
<void />
</methodsynopsis>
<para>&style.procedural;</para>