filejet / filejet-bundle
FileJet PHP 库的 Symfony 扩展包
v3.0.2
2024-07-29 09:54 UTC
Requires
- php: ^7.1|^8.0
- filejet/filejet-php: v3.0.2
- symfony/framework-bundle: ^2.8.50|^3.4.26|^4.1.12|^5.3.0|^6.0
- twig/twig: ^1.35|^2.4
README
提供与基于 Symfony 的项目的无缝集成 FileJet 服务。
有关纯 PHP 库和 FileJet 文档,请访问 filejet/filejet-php 仓库。
安装
您可以通过 Composer 轻松安装 FileJet 扩展包。
composer require filejet/filejet-bundle ^2.3
如果您尚未安装任何 HTTPlug 兼容包,我们建议在安装 FileJet 扩展包之前安装以下包。
composer require php-http/guzzle6-adapter ^1.1 composer require php-http/message ^1.6
安装后,请通过 Symfony 的扩展包系统 注册扩展包。
升级扩展包
我们建议使用 --with-dependencies
选项来升级扩展包。
composer update filejet/filejet-bundle --with-dependencies
配置
您需要在配置文件中提供 API 密钥和存储 ID。
file_jet: storage_id: <your storage id> api_key: <your api key> signature_secret: <your signature secret> # optional - needed for usage with external files auto_mode: true/false # defaults to true custom_domain: <your custom domain> # optional, without scheme, e.g. cdn.example.com
更多关于 自动优化模式 的信息。
使用方法
该扩展包提供了一个 Twig 扩展,用于生成您文件的公共和私有(签名)URL。
file_url(publicFile, 'resize_100_100') external_file_url(publiclyAccessibleImageUrl, 'resize_100_100') private_file_url(privateFileIdentifier, expiresInSeconds)
file_url
接受需要实现 FileJet\FileInterface
接口的对象。作为第二个参数,您可以可选地提供突变字符串(如果您想生成图像的 URL)- 查看 mutations 文档
external_file_url
接受公开访问图像的 URL 作为第一个参数,突变作为第二个参数。
private_file_url
接受文件标识字符串作为第一个参数,以及签名的 URL 将有效的秒数。该函数内部调用 FileJet API 并返回私有文件的签名 URL。此函数可以用于包含敏感信息的文件,因为文件不是公开可访问的,下载链接仅在选定的时段内有效,然后它就会过期。每次调用此函数都会调用 FileJet API,因此此函数可能相当昂贵。
该扩展包还提供 @FileJet\FileJet
服务,该服务自动连接到 Symfony 的容器。文档可以在 filejet/filejet-php 找到。