README

TimeularPublicApiBundle是集成您的时序跟踪与Timeular ZEI°设备到Symfony应用中的方法，但需要的工作更少，配置简单且预定义了有用的过滤器。

使用以下命令安装包

composer require tuc0w/timeular-public-api-bundle --dev

这就完成了！如果您没有使用Symfony Flex，您还需要在您的AppKernel.php文件中启用Tuc0w\TimeularPublicApiBundle\Tuc0wTimeularPublicApiBundle。

配置

需要通过创建一个新的config/packages/tuc0w_timeular_public_api.yaml文件来直接配置一些内容。默认值如下

# config/packages/tuc0w_timeular_public_api.yaml
tuc0w_timeular_public_api:
    timeular:
        api_base_url:    https://api.timeular.com
        api_key:         your_api_key
        api_secret:      your_api_secret
        api_timeout:     30.0
        api_version:     /api/v2

使用方法

此包提供了一个用于访问API的单个服务，您可以通过使用TimeularClient类型提示来自动注入。

// src/Controller/SomeController.php
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\Routing\Annotation\Route;
use Tuc0w\TimeularPublicApiBundle\Service\Client as TimeularClient;

class SomeController extends AbstractController {
    private $timeular;

    public function __construct(TimeularClient $timeular) {
        $this->timeular = $timeular;
    }

    /**
     * @Route("/", name="app_homepage")
     */
    public function index() {
        $this->timeular->signIn();

        // get the time entries from today
        return new JsonResponse(
            $this->timeular->getTimeEntries(
                new \DateTime(),
                new \DateTime()
            )
        );
    }
}

您也可以使用ID tuc0w_timeular_public_api.client直接访问此服务。

$timeular = $container->get('tuc0w_timeular_public_api.client');

可用方法

目前只有少数方法可用

待办事项

• 基本功能
• 创建自定义过滤器方法
• 集成缺失的端点

贡献

请随时提交问题或拉取请求：所有贡献和问题都深受欢迎 :)