api/laravel/Session/FileSessionHandler.yaml
2024-09-26 02:03:21 -07:00

113 lines
2.4 KiB
YAML

name: FileSessionHandler
class_comment: null
dependencies:
- name: Filesystem
type: class
source: Illuminate\Filesystem\Filesystem
- name: Carbon
type: class
source: Illuminate\Support\Carbon
- name: SessionHandlerInterface
type: class
source: SessionHandlerInterface
- name: Finder
type: class
source: Symfony\Component\Finder\Finder
properties:
- name: files
visibility: protected
comment: '# * The filesystem instance.
# *
# * @var \Illuminate\Filesystem\Filesystem'
- name: path
visibility: protected
comment: '# * The path where sessions should be stored.
# *
# * @var string'
- name: minutes
visibility: protected
comment: '# * The number of minutes the session should be valid.
# *
# * @var int'
methods:
- name: __construct
visibility: public
parameters:
- name: files
- name: path
- name: minutes
comment: "# * The filesystem instance.\n# *\n# * @var \\Illuminate\\Filesystem\\\
Filesystem\n# */\n# protected $files;\n# \n# /**\n# * The path where sessions\
\ should be stored.\n# *\n# * @var string\n# */\n# protected $path;\n# \n# /**\n\
# * The number of minutes the session should be valid.\n# *\n# * @var int\n# */\n\
# protected $minutes;\n# \n# /**\n# * Create a new file driven handler instance.\n\
# *\n# * @param \\Illuminate\\Filesystem\\Filesystem $files\n# * @param string\
\ $path\n# * @param int $minutes\n# * @return void"
- name: open
visibility: public
parameters:
- name: savePath
- name: sessionName
comment: '# * {@inheritdoc}
# *
# * @return bool'
- name: close
visibility: public
parameters: []
comment: '# * {@inheritdoc}
# *
# * @return bool'
- name: read
visibility: public
parameters:
- name: sessionId
comment: '# * {@inheritdoc}
# *
# * @return string|false'
- name: write
visibility: public
parameters:
- name: sessionId
- name: data
comment: '# * {@inheritdoc}
# *
# * @return bool'
- name: destroy
visibility: public
parameters:
- name: sessionId
comment: '# * {@inheritdoc}
# *
# * @return bool'
- name: gc
visibility: public
parameters:
- name: lifetime
comment: '# * {@inheritdoc}
# *
# * @return int'
traits:
- Illuminate\Filesystem\Filesystem
- Illuminate\Support\Carbon
- SessionHandlerInterface
- Symfony\Component\Finder\Finder
interfaces:
- SessionHandlerInterface