...

...

@@ -1,6 +1,5 @@

1

1

<?xml version="1.0" encoding="utf-8"?>

2

2

<!-- $Revision$ -->

3

-

4

3

<refentry xml:id="memcached.deletemulti" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">

5

4

<refnamediv>

6

5

<refname>Memcached::deleteMulti</refname>

...

...

@@ -9,27 +8,14 @@

9

8

10

9

<refsect1 role="description">

11

10

&reftitle.description;

12

-

<methodsynopsis>

13

-

<modifier>public</modifier> <type>bool</type><methodname>Memcached::deleteMulti</methodname>

11

+

<methodsynopsis role="Memcached">

12

+

<modifier>public</modifier> <type>array</type><methodname>Memcached::deleteMulti</methodname>

14

13

<methodparam><type>array</type><parameter>keys</parameter></methodparam>

15

14

<methodparam choice="opt"><type>int</type><parameter>time</parameter><initializer>0</initializer></methodparam>

16

15

</methodsynopsis>

17

16

<para>

18

-

<function>Memcached::deleteMulti</function> deletes the array of

19

-

<parameter>keys</parameter> from the server. The <parameter>time</parameter>

20

-

parameter is the amount of time in seconds (or Unix time until which) the

21

-

client wishes the server to refuse <literal>add</literal> and

22

-

<literal>replace</literal> commands for these keys. For this amount of time,

23

-

the item is put into a delete queue, which means that it won't be possible to

24

-

retrieve it by the <literal>get</literal> command, but

25

-

<literal>add</literal> and <literal>replace</literal> command with these keys

26

-

will also fail (the <literal>set</literal> command will succeed, however).

27

-

After the time passes, the item is finally deleted from server memory. The

28

-

parameter <parameter>time</parameter> defaults to 0 (which means that the

29

-

item will be deleted immediately and further storage commands with these keys

30

-

will succeed).

17

+

Delete the array of <parameter>keys</parameter> from the server.

31

18

</para>

32

-

33

19

</refsect1>

34

20

35

21

<refsect1 role="parameters">

...

...

@@ -50,6 +36,7 @@

50

36

<para>

51

37

The amount of time the server will wait to delete the items.

52

38

</para>

39

+

&memcached.note.delete-time;

53

40

</listitem>

54

41

</varlistentry>

55

42

</variablelist>

...

...

@@ -58,11 +45,7 @@

58

45

59

46

<refsect1 role="returnvalues">

60

47

&reftitle.returnvalues;

61

-

<para>

62

-

&return.success;

63

-

The <methodname>Memcached::getResultCode</methodname> will return

64

-

<constant>Memcached::RES_NOTFOUND</constant> if the key does not exist.

65

-

</para>

48

+

&memcached.result.delete-multi;

66

49

</refsect1>

67

50

68

51

<refsect1 role="seealso">

...

...

@@ -77,7 +60,6 @@

77

60

</refsect1>

78

61

79

62

</refentry>

80

-

81

63

<!-- Keep this comment at the end of the file

82

64

Local variables:

83

65

mode: sgml

84

66