platform/api/laravel/Filesystem/AwsS3V3Adapter.yaml
2024-09-02 10:44:11 -07:00

112 lines
2.4 KiB
YAML

name: AwsS3V3Adapter
class_comment: null
dependencies:
- name: S3Client
type: class
source: Aws\S3\S3Client
- name: Conditionable
type: class
source: Illuminate\Support\Traits\Conditionable
- name: S3Adapter
type: class
source: League\Flysystem\AwsS3V3\AwsS3V3Adapter
- name: FilesystemOperator
type: class
source: League\Flysystem\FilesystemOperator
- name: Conditionable
type: class
source: Conditionable
properties:
- name: client
visibility: protected
comment: '# * The AWS S3 client.
# *
# * @var \Aws\S3\S3Client'
methods:
- name: __construct
visibility: public
parameters:
- name: driver
- name: adapter
- name: config
- name: client
comment: "# * The AWS S3 client.\n# *\n# * @var \\Aws\\S3\\S3Client\n# */\n# protected\
\ $client;\n# \n# /**\n# * Create a new AwsS3V3FilesystemAdapter instance.\n#\
\ *\n# * @param \\League\\Flysystem\\FilesystemOperator $driver\n# * @param\
\ \\League\\Flysystem\\AwsS3V3\\AwsS3V3Adapter $adapter\n# * @param array \
\ $config\n# * @param \\Aws\\S3\\S3Client $client\n# * @return void"
- name: url
visibility: public
parameters:
- name: path
comment: '# * Get the URL for the file at the given path.
# *
# * @param string $path
# * @return string
# *
# * @throws \RuntimeException'
- name: providesTemporaryUrls
visibility: public
parameters: []
comment: '# * Determine if temporary URLs can be generated.
# *
# * @return bool'
- name: temporaryUrl
visibility: public
parameters:
- name: path
- name: expiration
- name: options
default: '[]'
comment: '# * Get a temporary URL for the file at the given path.
# *
# * @param string $path
# * @param \DateTimeInterface $expiration
# * @param array $options
# * @return string'
- name: temporaryUploadUrl
visibility: public
parameters:
- name: path
- name: expiration
- name: options
default: '[]'
comment: '# * Get a temporary upload URL for the file at the given path.
# *
# * @param string $path
# * @param \DateTimeInterface $expiration
# * @param array $options
# * @return array'
- name: getClient
visibility: public
parameters: []
comment: '# * Get the underlying S3 client.
# *
# * @return \Aws\S3\S3Client'
traits:
- Aws\S3\S3Client
- Illuminate\Support\Traits\Conditionable
- League\Flysystem\FilesystemOperator
- Conditionable
interfaces: []