platform/api/laravel/Contracts/Cache/Store.yaml
2024-09-02 10:44:11 -07:00

135 lines
2.2 KiB
YAML

name: Store
class_comment: null
dependencies: []
properties: []
methods:
- name: get
visibility: public
parameters:
- name: key
comment: '# * Retrieve an item from the cache by key.
# *
# * @param string $key
# * @return mixed'
- name: many
visibility: public
parameters:
- name: keys
comment: '# * Retrieve multiple items from the cache by key.
# *
# * Items not found in the cache will have a null value.
# *
# * @param array $keys
# * @return array'
- name: put
visibility: public
parameters:
- name: key
- name: value
- name: seconds
comment: '# * Store an item in the cache for a given number of seconds.
# *
# * @param string $key
# * @param mixed $value
# * @param int $seconds
# * @return bool'
- name: putMany
visibility: public
parameters:
- name: values
- name: seconds
comment: '# * Store multiple items in the cache for a given number of seconds.
# *
# * @param array $values
# * @param int $seconds
# * @return bool'
- name: increment
visibility: public
parameters:
- name: key
- name: value
default: '1'
comment: '# * Increment the value of an item in the cache.
# *
# * @param string $key
# * @param mixed $value
# * @return int|bool'
- name: decrement
visibility: public
parameters:
- name: key
- name: value
default: '1'
comment: '# * Decrement the value of an item in the cache.
# *
# * @param string $key
# * @param mixed $value
# * @return int|bool'
- name: forever
visibility: public
parameters:
- name: key
- name: value
comment: '# * Store an item in the cache indefinitely.
# *
# * @param string $key
# * @param mixed $value
# * @return bool'
- name: forget
visibility: public
parameters:
- name: key
comment: '# * Remove an item from the cache.
# *
# * @param string $key
# * @return bool'
- name: flush
visibility: public
parameters: []
comment: '# * Remove all items from the cache.
# *
# * @return bool'
- name: getPrefix
visibility: public
parameters: []
comment: '# * Get the cache key prefix.
# *
# * @return string'
traits: []
interfaces: []