supercool / fetch
用于 Craft CMS 集成视频的字段类型
Requires
- ext-curl: *
- ext-json: *
- craftcms/cms: ^4.5.5
This package is auto-updated.
Last update: 2024-09-22 12:55:28 UTC
README
用于 Craft CMS 集成视频的字段类型
需求
此插件需要 Craft CMS 3.0.0 或更高版本。
安装
要安装此插件,请按照以下说明操作。
-
打开您的终端并转到您的 Craft 项目目录
cd /path/to/project
-
然后告诉 Composer 加载插件
composer require supercool/fetch
-
在控制面板中,转到设置 → 插件,然后点击 Fetch 的“安装”按钮。
用法
支持的提供商(以下链接仅为示例)
- Vimeo - 视频(例如 https://vimeo.com/437391842)
- Twitter - 推文(例如 https://twitter.com/Telegraph/status/1284153855098355712)
- Youtube - 视频(例如 https://www.youtube.com/watch?v=1DxRko3ER4Q)
- Flickr - 图片(例如 https://www.flickr.com/photos/53889145@N02/7029097495/)
- Soundcloud - 音频(例如 https://soundcloud.com/queen-69312/dont-stop-me-now-remastered)
- Instagram - 帖子,不是故事(例如 https://www.instagram.com/p/CCxzeaeDGxV/)
设置
插件
"validateUrlsOnSave" - Lightswitch - 当禁用时,即使链接无效或服务无响应,元素也可以保存。这可以在类似 linode 被 YouTube 黑名单的情况中使用。
字段
每个可用的提供商都将有一个开关,允许您为该字段启用/禁用它们。默认情况下将启用。
Twig
如果字段为空,它将返回 null 或空字符串。
如果字段已填充且没有问题,它将返回一个 FetchModel(以下详细说明)
如果字段已填充并且获取嵌入时出错,它将返回一个不包含数据的 FetchModel
FetchModel
可用方法
{{ field.success }}
or
{{ field.getSuccess() }}
返回一个布尔值,如果有任何错误获取嵌入则为 false,如果没有则为 true
{{ field.errorMessage }}
or
{{ field.getErrorMessage() }}
如果嵌入获取失败,返回错误消息,否则返回 null
{{ field.twig }}
or
{{ field.getTwig() }}
返回嵌入的 twig,如果有错误获取嵌入则为空字符串
{{ field.html }}
or
{{ field.getHtml() }}
与 .twig / .getTwig()
相同,但返回作为 html 的标记而不是 twig_markup
{{ field.provider }}
or
{{ field.getProvider() }}
返回用于 url 的提供程序标识,为小写(例如 youtube),如果有错误则为 null
{{ field.object }}
or
{{ field.getObject() }}
返回从 oembed api 接收的数据,如果有错误则为 null。
这些数据会根据不同的 api 而有所不同,最好通过查看相关的 api 文档来查找。例如,对于 Instagram,请参阅 https://developers.facebook.com/docs/instagram/embedding/。
由 Supercool Ltd 提供