mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
Fixes and clarifications; sorry for mixing in whitespace changes but this shouldn't be translated yet
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344929 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson
parent
f73a9831d2
commit
d3d74d26a2
10 changed files with 78 additions and 36 deletions
|
|
@ -27,11 +27,27 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
The schema object on success, or &null; if the object cannot be retrieved
|
||||
The schema object on success, or &null; if the object cannot be retrieved
|
||||
for the given collection.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<example>
|
||||
<title><function>mysql_xdevapi\Collection::getSchema</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
|
||||
$schema = $collection->getSchema();
|
||||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
|||
|
|
@ -31,6 +31,22 @@
|
|||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<example>
|
||||
<title><function>mysql_xdevapi\Collection::getSession</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
|
||||
$session = $coll->getSession();
|
||||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@
|
|||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier> <type>mysql_xdevapi\Result</type><methodname>mysql_xdevapi\CollectionFind::execute</methodname>
|
||||
<modifier>public</modifier> <type>mysql_xdevapi\DocResult</type><methodname>mysql_xdevapi\CollectionFind::execute</methodname>
|
||||
<void />
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
|
|
@ -28,7 +28,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
A Result object that can be used to query the status of the operation
|
||||
A DocResult object that can be used to query the status of the operation
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -48,8 +48,8 @@ $res = $coll->find('name IN ("Marco","Lucio")')->execute();
|
|||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</programlisting>
|
||||
</example>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -12,10 +12,10 @@
|
|||
<methodsynopsis>
|
||||
<modifier>public</modifier> <type>mysql_xdevapi\CollectionModify</type><methodname>mysql_xdevapi\CollectionModify::replace</methodname>
|
||||
<methodparam><type>string</type><parameter>collection_field</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>string</type><parameter>expression_or_literal</parameter></methodparam>
|
||||
<methodparam><type>string</type><parameter>expression_or_literal</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Replace (update) a given field value with a new one.
|
||||
Replace (update) a given field value with a new one.
|
||||
</para>
|
||||
|
||||
&warn.undocumented.func;
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@
|
|||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier> <type>mysql_xdevapi\CollectionModify</type><methodname>mysql_xdevapi\CollectionModify::unset</methodname>
|
||||
<methodparam><type>array</type><parameter>variables</parameter></methodparam>
|
||||
<methodparam><type>array</type><parameter>fields</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Removes attributes from documents in a collection.
|
||||
|
|
@ -25,7 +25,7 @@
|
|||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>variables</parameter></term>
|
||||
<term><parameter>fields</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The attributes to remove from documents in a collection.
|
||||
|
|
@ -54,8 +54,8 @@ $res = $coll->modify('job like :job_name')->unset(["age", "name"])->bind(['job_n
|
|||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</programlisting>
|
||||
</example>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,6 @@
|
|||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier> <type>bool</type><methodname>mysql_xdevapi\Schema::dropCollection</methodname>
|
||||
<methodparam><type>string</type><parameter>schema_name</parameter></methodparam>
|
||||
<methodparam><type>string</type><parameter>collection_name</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
|
|
@ -25,19 +24,11 @@
|
|||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>schema_name</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>collection_name</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
|
||||
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
@ -47,7 +38,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -41,7 +41,7 @@
|
|||
<![CDATA[
|
||||
<?php
|
||||
|
||||
/* ... */
|
||||
$session = $schema->getSession();
|
||||
|
||||
?>
|
||||
]]>
|
||||
|
|
|
|||
|
|
@ -11,12 +11,12 @@
|
|||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier> <type>void</type><methodname>mysql_xdevapi\Session::releaseSavepoint</methodname>
|
||||
<methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam>
|
||||
<methodparam><type>string</type><parameter>name</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Release a previously set savepoint.
|
||||
</para>
|
||||
|
||||
|
||||
&warn.undocumented.func;
|
||||
|
||||
</refsect1>
|
||||
|
|
@ -28,7 +28,7 @@
|
|||
<term><parameter>name</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
|
||||
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
@ -38,7 +38,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -11,12 +11,12 @@
|
|||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier> <type>void</type><methodname>mysql_xdevapi\Session::rollbackTo</methodname>
|
||||
<methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam>
|
||||
<methodparam><type>string</type><parameter>name</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Rollback the transaction back to the savepoint.
|
||||
</para>
|
||||
|
||||
|
||||
&warn.undocumented.func;
|
||||
|
||||
</refsect1>
|
||||
|
|
@ -28,7 +28,7 @@
|
|||
<term><parameter>name</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
|
||||
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
@ -38,7 +38,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,8 @@
|
|||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier> <type>mysql_xdevapi\TableSelect</type><methodname>mysql_xdevapi\Table::select</methodname>
|
||||
<void />
|
||||
<methodparam><type>mixed</type><parameter>columns</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>mixed</type><parameter>...</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Creates a new TableSelect object.
|
||||
|
|
@ -21,7 +22,25 @@
|
|||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
&no.function.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>columns</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The columns to select data from. Can be an array
|
||||
with one or more values, or a string.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>...</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Additional columns parameter definitions.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
|
|
@ -43,8 +62,8 @@ $res = $table->select(['age', 'name'])->execute();
|
|||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</programlisting>
|
||||
</example>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue