sandwave-io/freshdesk-php

Freshdesk REST API的PHP SDK。

0.4.0 2023-03-13 19:05 UTC

This package is auto-updated.

Last update: 2024-09-09 11:16:05 UTC


README

Freshdesk API - PHP SDK

GitHub Workflow Status Packagist PHP Version Support Packagist PHP Version Support Packagist Downloads

支持的API

此SDK目前支持以下API

是否缺少功能?请自由创建问题,或发送拉取请求。

如何使用(REST API)

composer require sandwave-io/freshdesk-php
<?php

use SandwaveIo\Freshdesk\SerializerFactory;
use SandwaveIo\Freshdesk\FreshdeskClient;
use SandwaveIo\Freshdesk\Client\RestClient;
use SandwaveIo\Freshdesk\RestClientFactory;

$factory = new RestClientFactory(
    'api-endpoint',
    'API key',
);

// The optional logger should implement \Psr\Log\LoggerInterface
$logger = new YourFavoritePSRLogger();

$serializer = SerializerFactory::create();
$restClient = new RestClient(
    $factory->create(),
    $serializer,
    $logger
);

$freshdeskClient = new FreshdeskClient($restClient);
$freshdeskClient->getTicketClient()->get(123);

如何贡献

如果您有任何改进的想法,请自由创建PR。或者创建一个问题。

  • 添加代码时,请确保为其添加测试(phpunit)。
  • 确保代码遵循我们的编码标准(使用php-cs-fixer进行检查/修复)。
  • 还要确保PHPStan没有找到任何错误。
composer analyze # this will (dry)run php-cs-fixer, phpstan and phpunit

composer phpcs-fix # this will actually let php-cs-fixer run to fix

这些工具也将运行在GitHub actions上的PR和主分支的推送上。