doc-ru/reference/quickhash/quickhashstringinthash/delete.xml at master · php/doc-ru · GitHub

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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: bfe06c36ec1c0a37909704b292a204195b0bc14f Maintainer: sergey Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="quickhashstringinthash.delete">
 <refnamediv>
  <refname>QuickHashStringIntHash::delete</refname>
  <refpurpose>Удаляет запись из хеша</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>bool</type><methodname>QuickHashStringIntHash::delete</methodname>
   <methodparam><type>string</type><parameter>key</parameter></methodparam>
  </methodsynopsis>
  <simpara>
   Метод удаляет запись из хеша и возвращает информацию о том, удалилась ли запись.
   Соответствующие структуры памяти будут освобождены не сразу, а при освобождении самого хеша.
  </simpara>
  <simpara>
   Элементы нельзя удалить, если хеш используется в итераторе.
   Метод не выбросит исключение, а просто вернёт &false;, как это произошло бы при любой другой ошибке удаления.
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>key</parameter></term>
    <listitem>
     <simpara>
      Ключ записи, которую нужно удалить.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
   Метод возвращает &true;, если запись удалилась, иначе &false;.
  </simpara>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Пример использования метода <function>QuickHashStringIntHash::delete</function></title>
   <programlisting role="php">
<![CDATA[
<?php

$hash = new QuickHashStringIntHash(1024);

var_dump($hash->exists('four'));
var_dump($hash->add('four', 5));
var_dump($hash->get('four'));
var_dump($hash->delete('four'));
var_dump($hash->exists('four'));
var_dump($hash->get('four'));
var_dump($hash->delete('four'));

?>
]]>
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
bool(false)
bool(true)
int(5)
bool(true)
bool(false)
bool(false)
bool(false)
]]>
   </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
-->