README

工作中。欢迎PR！！

Survey Monkey API Client 的 Symfony 集成包

入门指南

以下说明将帮助您将此包运行到您的项目中。

先决条件

Symfony 项目 3.* 及以上版本（理论上应适用于 2.x 项目，但目前正在为项目开发，因此在 2.x 上尚未测试）

安装

###1. 添加 composer 依赖项并安装包

composer require davidwnek/survey-monkey-api-client-bundle dev-master

###2. 在 AppKernel.php 中启用包

    // app/AppKernel.php

        public function registerBundles()
        {
        $bundles = array(
            // ...
            new davidwnek\SurveyMonkeyApiClientBundle\SurveyMonkeyApiClientBundle(),
        );
        }

###3. 配置 config.yml

//app/config/config.yml
survey_monkey_api_client:
    client_id: '%sm.client_id%'
    client_secret: '%sm.secret%'
    redirect_url: '%sm.redirect_url%'
    #These fields are optional if you use your own Authentication controller as explained later.
    authentication_success_redirect_route_name: {INSERT_SUCCESS_REDIRECT_ROUTE}
    authentication_failed_redirect_route_name: {INSERT_FAILED_REDIRECT_ROUTE}

###4. 配置 parameters.yml/.dist

//app/config/parameters.yml.dist

    sm.client_id: ~
    sm.secret: ~
    sm.redirect_url: ~

请将实际值放入 parameters.yml 中，以将敏感数据保留在仓库外！client_id、secret 可生成：[https://developer.surveymonkey.com/apps/](https://developer.surveymonkey.com/apps/)

创建新应用或使用现有应用。在凭据下放置 parameters.yml 中提供的 Client ID 和 Secret

重定向 URL 需要在 Survey Monkey 开发者面板和代码中匹配。它用于 OAuth 过程完成后返回到您的应用程序。

此包已提供处理 Survey Monkey 的代码响应的操作，如果选择使用它。您始终可以创建自己的操作并以这种方式处理代码响应。

重定向 URL 示例

本地开发使用内置控制器：[https://:8000/survey_monkey/code](https://:8000/survey_monkey/code)

对于预发布、测试和生产分支，请将 parameters.yml 修改为包含您域名的实际主机名。请注意，您还需要在 Survey Money 中设置重定向_url。对于不同环境，拥有多个应用是有益的。

//app/config/parameters.yml

    sm.client_id: {INSERT ACTUAL CLIENT ID}
    sm.secret: {INSERT ACTUAL CLIENT SECRET}
    sm.redirect_url: {INSERT ACTUAL REDIRECT_URL}

###5. 设置 routing.yml 此步骤是可选的，如果您选择不使用内置的 AuthenticationController.php

//app/config/routing.yml

survey_monkey_api_client:
    resource: "@SurveyMonkeyApiClientBundle/Controller"
    type: annotation

示例

TODO：很快将提供演示项目，展示如何使用此包。

贡献

请随时提交拉取请求。请记住，这是一个正在进行的项目，并将随着时间的推移继续扩展。所有帮助都受欢迎。

版本控制

TODO

作者

• David Wnek - 初始工作 - [https://github.com/DavidWnek](https://github.com/DavidWnek)
• Josh Schroeder - 咨询和代码审查 - [https://github.com/jschroed91](https://github.com/jschroed91)
• Anthony White - 代码审查 - [https://github.com/AnthonyWhiteCaxy](https://github.com/AnthonyWhiteCaxy)

许可证

本项目受 Apache License 2.0 许可证保护 - 详细信息请参阅 LICENSE.md 文件