/
arrayinsert.xml
144 lines (134 loc) · 4.17 KB
/
arrayinsert.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: ee52285714f7f7371364a3e5233d2ca2da078706 Maintainer: samesch Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="mysql-xdevapi-collectionmodify.arrayinsert" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>CollectionModify::arrayInsert</refname>
<refpurpose>Fügt ein Element in das Array eines Feldes ein</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mysql_xdevapi\CollectionModify</type><methodname>mysql_xdevapi\CollectionModify::arrayInsert</methodname>
<methodparam><type>string</type><parameter>collection_field</parameter></methodparam>
<methodparam><type>string</type><parameter>expression_or_literal</parameter></methodparam>
</methodsynopsis>
<para>
Fügt dem Feld eines Dokuments ein Element hinzu. Mehrere Elemente eines
Feldes werden als Array dargestellt. Im Gegensatz zu
<methodname>CollectionModify::arrayAppend</methodname>, wo das neue Element
immer am Ende des Arrays angehängt wird, kann bei dieser Methode die
Position für ein neues Element angegeben werden.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>collection_field</parameter></term>
<listitem>
<para>
Bezeichnet das Element im Array, nach dem das neue Element eingefügt
wird. Das Format dieses Parameters ist
<literal><replaceable>FIELD_NAME[ INDEX ]</replaceable></literal>, wobei
<replaceable>FIELD_NAME</replaceable> der Name des Dokumentfeldes ist,
dem das Element hinzugefügt werden soll, und
<replaceable>INDEX</replaceable> der Index des Elements innerhalb des
Feldes ist.
</para>
<para>
Das Feld INDEX ist nullbasiert, &dh; das erste Element des Arrays hat
einen Index von 0.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>expression_or_literal</parameter></term>
<listitem>
<para>
Das neue Element, das nach FIELD_NAME[ INDEX ] eingefügt wird
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Gibt ein <classname>CollectionModify</classname>-Objekt zurück, das
verwendet werden kann, um den Befehl auszuführen oder um weitere
Operationen hinzuzufügen.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>mysql_xdevapi\CollectionModify::arrayInsert</function>-Beispiel</title>
<programlisting role="php">
<![CDATA[
<?php
$session = mysql_xdevapi\getSession("mysqlx://user:password@localhost");
$session->sql("DROP DATABASE IF EXISTS addressbook")->execute();
$session->sql("CREATE DATABASE addressbook")->execute();
$schema = $session->getSchema("addressbook");
$collection = $schema->createCollection("people");
$result = $collection
->add(
'{"name": "Bernie",
"traits": ["Friend", "Brother", "Human"]}')
->execute();
$collection
->modify("name in ('Bernie', 'Jane')")
->arrayInsert('traits[1]', 'Happy')
->execute();
$result = $collection
->find()
->execute();
print_r($result->fetchAll());
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Array
(
[0] => Array
(
[_id] => 00005b6b5361000000000000010d
[name] => Bernie
[traits] => Array
(
[0] => Friend
[1] => Happy
[2] => Brother
[3] => Human
)
)
)
]]>
</screen>
</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
-->