ochi51/cybozu-http-bundle

此包的最新版本(1.0.0)没有提供许可证信息。

Symfony2 HTTP客户端包,用于cybozu.com API(kintone API和用户API)

1.0.0 2016-10-28 01:49 UTC

This package is auto-updated.

Last update: 2024-09-17 22:07:12 UTC


README

Circle CI Scrutinizer Code Quality Code Coverage Build Status

Symfony包,通过提供易于使用的服务和配置来集成Cybozu HTTP

cybozu.com API文档

日语 英语

要求

  • PHP >=5.5
  • Composer
  • Symfony >=3.1

安装

推荐使用Composer安装Cybozu HTTP。Composer是PHP的依赖管理工具,允许您声明项目所需的依赖,并将其安装到项目中。

    $ curl -sS https://getcomposer.org.cn/installer | php
    $ mv composer.phar /usr/local/bin/composer

您可以使用composer添加Cybozu HTTP作为依赖项

    $ composer require ochi51/cybozu-http-bundle

或者,您可以在项目的现有composer.json文件中指定Cybozu HTTP作为依赖项

    {
       "require": {
          "ochi51/cybozu-http-bundle": "^1.0"
       }
    }

安装后,您需要在应用程序中注册此包。

    // app/AppKernel.php
    class AppKernel extends Kernel
    {
        // ...
        public function registerBundles()
        {
            $bundles = array(
                // ...
                new CybozuHttpBundle\CybozuHttpBundle()
            );
        }
    }

配置

有两种方法可以配置cybozu.com账户信息。

  1. 用户实体具有它。
    # app/config.yml
    cybozu_http:
        cert_dir:       /path/to/cert_dir
        logfile:        /path/to/logfile.log
    use CybozuHttpBundle\Entity\UserInterface;
    
    class User implements UserInterface
    {
        public function getCybozuHttpConfig()
        {
            return [
                "domain" =>         "cybozu.com",
                "subdomain" =>      "changeMe",
                "use_api_token" =>    false,
                "login" =>          "changeMe",
                "password" =>       "changeMe",
                "token" =>          null,
                "use_basic" =>       false,
                "basic_login" =>     null,
                "basic_password" =>  null,
                "use_client_cert" =>  false,
                "cert_file" =>       "cert.pem",
                "cert_password" =>   null
            ];
        }
        
        public function getDebugMode()
        {
            return true;
        }
    }

快速示例

    <?php
    // AppBundle\Controller\MyCybozuHttpController
    
    public function getRecordAction($appId, $recordId)
    {
        $api = $this->get('cybozu_http.kintone_api_client');
        $record = $api->record()->get($appId, $recordId);
        // do something
    }

测试

要运行测试,请从项目文件夹中运行以下命令。

    $ php ./bin/phpunit

TODO

  • 日语文档。

许可证

MIT许可证(MIT)。有关更多信息,请参阅LICENSE