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

Fixes here and there; renamed or removed methods

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@345442 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson 2018-08-07 23:40:10 +00:00
parent ab387e780b
commit e266c58515
9 changed files with 23 additions and 273 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarningcount.xml → reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarningscount.xml
View file

@ -1,16 +1,16 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mysql-xdevapi-baseresult.getwarningcount" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xml:id="mysql-xdevapi-baseresult.getwarningscount" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>BaseResult::getWarningCount</refname>
<refname>BaseResult::getWarningsCount</refname>
<refpurpose>Fetch warning count from last operation</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>abstract</modifier> <modifier>public</modifier> <type>integer</type><methodname>mysql_xdevapi\BaseResult::getWarningCount</methodname>
<modifier>abstract</modifier> <modifier>public</modifier> <type>integer</type><methodname>mysql_xdevapi\BaseResult::getWarningsCount</methodname>
<void />
</methodsynopsis>
<para>

16
reference/mysql_xdevapi/mysql_xdevapi/collectionfind/skip.xml → reference/mysql_xdevapi/mysql_xdevapi/collectionfind/offet.xml
View file

@ -1,21 +1,21 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mysql-xdevapi-collectionfind.skip" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xml:id="mysql-xdevapi-collectionfind.offset" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>CollectionFind::skip</refname>
<refname>CollectionFind::offset</refname>
<refpurpose>Skip given number of elements to be returned</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mysql_xdevapi\CollectionFind</type><methodname>mysql_xdevapi\CollectionFind::skip</methodname>
<modifier>public</modifier> <type>mysql_xdevapi\CollectionFind</type><methodname>mysql_xdevapi\CollectionFind::offset</methodname>
<methodparam><type>integer</type><parameter>position</parameter></methodparam>
</methodsynopsis>
<para>
For the result set of a find operation, skip the first N elements that would be returned by the find operation.
If the amout of element skipped is bigger than the size of the result set then the find operation will return an empty set.
If the amount of element skipped is bigger than the size of the result set then the find operation will return an empty set.
</para>
</refsect1>
@ -44,7 +44,7 @@
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>mysql_xdevapi\CollectionFind::skip</function> example</title>
<title><function>mysql_xdevapi\CollectionFind::offset</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -52,12 +52,12 @@
//Assuming $coll is a valid Collection object
//Find all the documents for which the 'job' field is equal to 'Programmatore', skip the first 3
$res = $coll->find('job like \'Programmatore\'')->skip(3)->execute();
$res = $coll->find('job like \'Programmatore\'')->offset(3)->execute();
?>
]]>
</programlisting>
</example>
</programlisting>
</example>
</refsect1>

93
reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/arraydelete.xml
View file

@ -1,93 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mysql-xdevapi-collectionmodify.arraydelete" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>CollectionModify::arrayDelete</refname>
<refpurpose>Delete element</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mysql_xdevapi\CollectionModify</type><methodname>mysql_xdevapi\CollectionModify::arrayDelete</methodname>
<methodparam><type>string</type><parameter>collection_field</parameter></methodparam>
</methodsynopsis>
<para>
Delete a document field element. If the deleted element is the only
element then the field is removed.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>collection_field</parameter></term>
<listitem>
<para>
The format of this parameter is <literal>FIELD_NAME[ INDEX ]</literal> where FIELD_NAME is the name of the document
field to remove the element from, and INDEX is the INDEX of the element within the field.
</para>
<para>
The INDEX field is zero based, so the leftmost item from the array has an index of 0.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A CollectionModify object that can be used to execute the command, or to add further operations
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>mysql_xdevapi\CollectionModify::arrayDelete</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// Assuming $coll is a valid Collection object
// Remove the first element from the array of 'jobs' for all the documents
// with name like Riccardo or Carlo
$coll->modify("name in ('Riccardo', 'Carlo')")->arrayDelete('job[0]')->execute();
// Remove the second element from the documents which `age` field is greater than 30
$coll->modify('age > 30')->arrayDelete('job[1]')->execute();
?>
]]>
</programlisting>
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

83
reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/merge.xml
View file

@ -1,83 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mysql-xdevapi-collectionmodify.merge" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>CollectionModify::merge</refname>
<refpurpose>Merge attributes to document</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mysql_xdevapi\CollectionModify</type><methodname>mysql_xdevapi\CollectionModify::merge</methodname>
<methodparam><type>string</type><parameter>document</parameter></methodparam>
</methodsynopsis>
<para>
Adds attributes taken from a document into the documents in a collection.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>document</parameter></term>
<listitem>
<para>
The document with attributes to merge.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A CollectionModify object.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>mysql_xdevapi\CollectionModify::merge</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$res = $coll->modify("Married like 'NO'")->merge("{'Divorced' : 'NO', 'Vegan' : 'YES'}")->execute();
?>
]]>
</programlisting>
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

8
reference/mysql_xdevapi/mysql_xdevapi/docresult/getwarningcount.xml → reference/mysql_xdevapi/mysql_xdevapi/docresult/getwarningscount.xml
View file

@ -1,16 +1,16 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mysql-xdevapi-docresult.getwarningcount" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xml:id="mysql-xdevapi-docresult.getwarningscount" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DocResult::getWarningCount</refname>
<refname>DocResult::getWarningsCount</refname>
<refpurpose>Get warning count from last operation</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>integer</type><methodname>mysql_xdevapi\DocResult::getWarningCount</methodname>
<modifier>public</modifier> <type>integer</type><methodname>mysql_xdevapi\DocResult::getWarningsCount</methodname>
<void />
</methodsynopsis>
<para>
@ -36,7 +36,7 @@
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>mysql_xdevapi\DocResult::getWarningCount</function> example</title>
<title><function>mysql_xdevapi\DocResult::getWarningsCount</function> example</title>
<programlisting role="php">
<![CDATA[
<?php

74
reference/mysql_xdevapi/mysql_xdevapi/result/getaffecteditemscount.xml
View file

@ -1,74 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mysql-xdevapi-result.getaffecteditemscount" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Result::getAffectedItemsCount</refname>
<refpurpose>Get affected row count</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>mysql_xdevapi\Result::getAffectedItemsCount</methodname>
<void />
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>mysql_xdevapi\Result::getAffectedItemsCount</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* ... */
?>
]]>
</programlisting>
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

8
reference/mysql_xdevapi/mysql_xdevapi/result/getwarningcount.xml → reference/mysql_xdevapi/mysql_xdevapi/result/getwarningscount.xml
View file

@ -1,16 +1,16 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mysql-xdevapi-result.getwarningcount" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xml:id="mysql-xdevapi-result.getwarningscount" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Result::getWarningCount</refname>
<refname>Result::getWarningsCount</refname>
<refpurpose>Get warning count from last operation</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>integer</type><methodname>mysql_xdevapi\Result::getWarningCount</methodname>
<modifier>public</modifier> <type>integer</type><methodname>mysql_xdevapi\Result::getWarningsCount</methodname>
<void />
</methodsynopsis>
<para>
@ -36,7 +36,7 @@
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>mysql_xdevapi\Result::getWarningCount</function> example</title>
<title><function>mysql_xdevapi\Result::getWarningsCount</function> example</title>
<programlisting role="php">
<![CDATA[
<?php

8
reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarningcount.xml → reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarningscount.xml
View file

@ -1,16 +1,16 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mysql-xdevapi-rowresult.getwarningcount" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xml:id="mysql-xdevapi-rowresult.getwarningscount" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>RowResult::getWarningCount</refname>
<refname>RowResult::getWarningsCount</refname>
<refpurpose>Get warning count from last operation</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>integer</type><methodname>mysql_xdevapi\RowResult::getWarningCount</methodname>
<modifier>public</modifier> <type>integer</type><methodname>mysql_xdevapi\RowResult::getWarningsCount</methodname>
<void />
</methodsynopsis>
<para>
@ -36,7 +36,7 @@
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>mysql_xdevapi\RowResult::getWarningCount</function> example</title>
<title><function>mysql_xdevapi\RowResult::getWarningsCount</function> example</title>
<programlisting role="php">
<![CDATA[
<?php

0
reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarningcount.xml → reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarningscount.xml
View file