api/laravel/Contracts/Cache/Lock.yaml
2024-09-26 02:03:21 -07:00

62 lines
1.1 KiB
YAML

name: Lock
class_comment: null
dependencies: []
properties: []
methods:
- name: get
visibility: public
parameters:
- name: callback
default: 'null'
comment: '# * Attempt to acquire the lock.
# *
# * @param callable|null $callback
# * @return mixed'
- name: block
visibility: public
parameters:
- name: seconds
- name: callback
default: 'null'
comment: '# * Attempt to acquire the lock for the given number of seconds.
# *
# * @param int $seconds
# * @param callable|null $callback
# * @return mixed
# *
# * @throws \Illuminate\Contracts\Cache\LockTimeoutException'
- name: release
visibility: public
parameters: []
comment: '# * Release the lock.
# *
# * @return bool'
- name: owner
visibility: public
parameters: []
comment: '# * Returns the current owner of the lock.
# *
# * @return string'
- name: forceRelease
visibility: public
parameters: []
comment: '# * Releases this lock in disregard of ownership.
# *
# * @return void'
traits: []
interfaces: []