-
Notifications
You must be signed in to change notification settings - Fork 79
Expand file tree
/
Copy pathprepend.xml
More file actions
129 lines (121 loc) · 3.95 KB
/
prepend.xml
File metadata and controls
129 lines (121 loc) · 3.95 KB
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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 1d8068ecb070fdc360d750e0c1f3f15796e61ec0 Maintainer: shein Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="memcached.prepend" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Memcached::prepend</refname>
<refpurpose>Добавляет данные в начало существующей записи</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Memcached">
<modifier>public</modifier> <type class="union"><type>bool</type><type>null</type></type><methodname>Memcached::prepend</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
<function>Memcached::prepend</function> добавляет строку, переданную в параметре
<parameter>value</parameter> в начало существующей записи. Причина того что
<parameter>value</parameter> приводится к строковому типу в том, что добавление
значения в начало комплексных типов не определено.
</para>
<note>
<para>
Если установлен параметр <constant>Memcached::OPT_COMPRESSION</constant>, то выполнение данного
метода завершится неудачей и будет выведено предупреждение, потому что добавление сжатых данных
к значению, которое возможно уже сжато, невозможно.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
Ключ записи к которой происходит добавление в начало.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
Добавляемая строка.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
Возвращает &null;, если сжатие включено.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Возвращает &null; и выдаёт ошибку уровня <constant>E_WARNING</constant>, если сжатие включено.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования <function>Memcached::prepend</function></title>
<programlisting role="php">
<![CDATA[
<?php
$m = new Memcached();
$m->addServer('localhost', 11211);
$m->setOption(Memcached::OPT_COMPRESSION, false);
$m->set('foo', 'abc');
$m->prepend('foo', 'def');
var_dump($m->get('foo'));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
string(6) "defabc"
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>Memcached::prependByKey</methodname></member>
<member><methodname>Memcached::append</methodname></member>
</simplelist>
</para>
</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
-->