You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: fix duplicate object description of increment
Check User Guide syntax: user_guide_src/source/libraries/caching.rst#L182
duplicate object description of increment, other instance in /github/workspace/user_guide_src/source/database/query_builder.rst
Performs atomic decrementation of a raw stored value.
199
+
:param string $key: Cache ID
200
+
:param int $offset: Step/value to reduce by
201
+
:returns: New value on success, ``false`` on failure
202
+
:rtype: mixed
203
203
204
-
Example:
204
+
Performs atomic decrementation of a raw stored value.
205
205
206
-
.. literalinclude:: caching/008.php
206
+
Example:
207
207
208
-
.. php:method:: clean()
208
+
.. literalinclude:: caching/008.php
209
209
210
-
:returns: ``true`` on success, ``false`` on failure
211
-
:rtype: bool
210
+
.. php:method:: clean()
212
211
213
-
This method will 'clean' the entire cache. If the deletion of the
214
-
cache files fails, the method will return false.
212
+
:returns: ``true`` on success, ``false`` on failure
213
+
:rtype: bool
215
214
216
-
Example:
215
+
This method will 'clean' the entire cache. If the deletion of the
216
+
cache files fails, the method will return false.
217
217
218
-
.. literalinclude:: caching/009.php
218
+
Example:
219
219
220
-
.. php:method:: getCacheInfo()
220
+
.. literalinclude:: caching/009.php
221
221
222
-
:returns: Information on the entire cache database
223
-
:rtype: mixed
222
+
.. php:method:: getCacheInfo()
224
223
225
-
This method will return information on the entire cache.
224
+
:returns: Information on the entire cache database
225
+
:rtype: mixed
226
226
227
-
Example:
227
+
This method will return information on the entire cache.
228
228
229
-
.. literalinclude:: caching/010.php
229
+
Example:
230
230
231
-
.. note:: The information returned and the structure of the data is dependent
232
-
on which adapter is being used.
231
+
.. literalinclude:: caching/010.php
233
232
234
-
.. php:method:: getMetadata(string $key)
233
+
.. note:: The information returned and the structure of the data is dependent
234
+
on which adapter is being used.
235
235
236
-
:param string $key: Cache item name
237
-
:returns: Metadata for the cached item. ``null`` for missing items, or an array with at least the "expire" key for absolute epoch expiry (``null`` for never expires).
238
-
:rtype: array|null
236
+
.. php:method:: getMetadata(string $key)
239
237
240
-
This method will return detailed information on a specific item in the
241
-
cache.
238
+
:param string $key: Cache item name
239
+
:returns: Metadata for the cached item. ``null`` for missing items, or an array with at least the "expire" key for absolute epoch expiry (``null`` for never expires).
240
+
:rtype: array|null
242
241
243
-
Example:
242
+
This method will return detailed information on a specific item in the
243
+
cache.
244
244
245
-
.. literalinclude:: caching/011.php
245
+
Example:
246
246
247
-
.. note:: The information returned and the structure of the data is dependent
248
-
on which adapter is being used. Some adapters (File, Memcached, Wincache)
0 commit comments