README

本示例旨在为想要通过快速调试示例探索 Quicksilver 潜力的用户提供。

需求

虽然这些脚本可以单独下载，但它们旨在与 Composer 一起使用。请参阅下一节中的安装说明。

• Quicksilver 脚本项目和脚本名称本身应保持命名规范一致。
• README 应包含关于脚本应运行的类型钩子和阶段的建议。
  • 例如，"此脚本应在 clone_database 和 after 阶段运行。
  • 提供一个可以粘贴到 pantheon.yml 文件中的代码片段。

安装

该项目设计为从站点的 composer.json 文件中包含，并由 Composer Installers 放置到适当的安装目录。

为了使其正常工作，您应该在 composer.json 文件中包含以下内容

{
  "require": {
    "composer/installers": "^1"
  },
  "extra": {
    "installer-paths": {
      "web/private/scripts/quicksilver": ["type:quicksilver-script"]
    }
  }
}

可以使用以下命令包含该项目

composer require pantheon-quicksilver/debugging-example

如果您使用的是以下示例 PR 工作流程项目之一（以您的站点为起点）：Drupal 8、Drupal 9、WordPress，则这些条目应该已经存在于您的 composer.json 中。

示例 pantheon.yml

以下是一个示例，如果这是您想要使用的唯一 Quicksilver 操作，您的 pantheon.yml 将会是什么样子。

api_version: 1

workflows:
  clear_cache:
    after:
      - type: webphp
        description: Dump debugging output
        script: private/scripts/quicksilver/debugging-example/debugging-example.php

示例 terminus workflow:watch 输出

从仪表板触发缓存清除时，您应该会看到如下所示的调试输出

$> terminus workflow:watch your-site-name
[2015-12-15 03:17:26] [info] Watching workflows...
[2015-12-15 03:17:50] [info] Started 1c5421b8-a2db-11e5-8a28-bc764e10b0ce Clear cache for "dev" (dev)
[2015-12-15 03:17:58] [info] Finished Workflow 1c5421b8-a2db-11e5-8a28-bc764e10b0ce Clear cache for "dev" (dev)
[2015-12-15 03:18:00] [info]
------ Operation: Dump debugging output finished in 2s ------
Quicksilver Debuging Output


========= START PAYLOAD ===========
Array
(
    [wf_type] => clear_cache
    [user_id] => ed828d9d-2389-4e8d-9f71-bd2fcafc93c2
    [site_id] => 6c5ee454-9427-4cce-8193-a44d6c54172c
    [user_role] => owner
    [trace_id] => 1c4b90c0-a2db-11e5-9ca4-efb1318547fc
    [environment] => dev
    [wf_description] => Clear cache for "dev"
    [user_email] => josh@getpantheon.com
)

========== END PAYLOAD ============

wf_type、wf_description 和 user_email 的值可能特别有趣。您可以从 $_SERVER 和 $_ENV 超全局变量中获取更多信息。您还可以查询 git 仓库的状态，以及启动 CMS。有很多可能性！尽情享受 Quicksilver 带来的乐趣！