README

Charcoal contrib guide 是一个贡献集，用于在 charcoal-admin 界面中添加视频（youtube 的，有时还有 vimeo 的）作为教程。

安装后，您将获得

安装

首选（也是唯一支持）的方法是使用 Composer

$ composer require locomotivemtl/charcoal-contrib-guide

依赖关系

要求

PHP 5.6+: 推荐使用 PHP 7。
charcoal-admin: >=0.15=

PSR

PSR-7: HTTP 消息的通用接口。由 Slim 实现。
PSR-11: 依赖容器的通用接口。由 Pimple 实现。

配置

在你的项目的配置文件中，需要通知模块

{
    "modules": {
        "charcoal/admin/guide/guide": {}
    }
}

然后，添加一个 youtube API 密钥：要查找 API 密钥，请访问 https://console.cloud.google.com，找到 可计费项目，然后转到凭据，并添加一个 API 密钥。必须启用 Youtube Data Api 以相应地限制密钥。要启用 API，请转到 库，然后搜索 Youtube Data Api。

{
    "apis": {
        "google": {
            "youtube": {
                "key": "xxxxxxx"
            }
        }
    }
}

使用

安装后，您将在系统菜单中获得一个新项目 视频教程，这将带您进入 charcoal-admin 指南界面。要查看抓取界面和视频关联界面，您需要具有超级用户访问权限或访问 charcoal/admin/guide/edit。如果没有适当的访问权限，您只能看到视频列表。

抓取 youtube 视频

转到 admin/guide/scrape-video，输入播放列表 ID，然后按 导入。您将被重定向到包含所有新导入视频的 admin/guide/video 页面，或者如果没有原因无法访问播放列表，则无视频。导入视频将会覆盖现有的视频，您不能导入多个 youtube 播放列表。导入视频将删除在 admin/guide/associate-video 页面中先前定义的所有关联视频。

关联视频

截至版本 0.1.0，您可以将视频关联到 表单 或 表格（小部件）。这意味着您只能将视频关联到 对象，而不是 模板。对象列表来自管理员菜单。

要关联视频，请选择一个 小部件，然后当定义了（大多数情况下是 template_ident）时选择一个 属性，然后当然，实际的 视频。不定义任何属性将导致默认行为，即将视频应用于所选对象的所有条目。然后您可以在侧边栏中按 保存，这样就完成了。JavaScript 解释器将定义表单或表格是否关联了视频。

重要提示

您定义视频的顺序会影响显示的视频，因为每个对象条目只能分配一个视频。例如，如果您选择为没有定义属性的表单分配视频，则将跳过所有后续视频。

开发

要安装开发环境

$ composer install

要运行脚本（phplint，phpcs 和 phpunit）

$ composer test

开发依赖

[php-coveralls/php-coveralls][phpcov]
[phpunit/phpunit][phpunit]
[squizlabs/php_codesniffer][phpcs]

待办事项列表

添加对 vimeo 的支持
添加对自定义视频 URL 的支持
添加在不覆盖所有内容的情况下添加视频的支持
添加支持模板而不是小部件

编码风格

炭黑-contrib-guide 模块遵循炭黑编码风格

PSR-1
PSR-2
PSR-4，因此自动加载由 Composer 提供。
phpDocumentor 注释。
有关编码标准，请参阅 phpcs.xml.dist 和 .editorconfig。

可以使用 composer phpcs 执行编码风格验证/强制执行。还提供了自动修复程序，使用 composer phpcbf。

致谢

Locomotive

许可证

炭黑遵循 MIT 许可协议。有关详细信息，请参阅 LICENSE。

locomotivemtl / charcoal-contrib-guide

维护者

详细信息