README

![软件许可][盾牌-许可]

状态：建设中

路线图

• 实施环境
• 添加更多文档

依赖项

• PHP: ^8.1

安装

您可以通过 Composer 安装此包

composer require composite/laravel-tecdoc

在 Laravel 5.5 或更高版本中，服务提供程序将自动注册。在框架的旧版本中，只需将服务提供程序添加到 config/app.php 文件中即可

'providers' => [
    ...
    /*
     * Package Service Providers...
     */
    Composite\TecDoc\TecDocServiceProvider::class,
    ...
],

'aliases' => [
    ...
    'TecDoc' => Composite\TecDoc\Facades\TecDoc::class,
    ...
],

您可以使用以下命令发布配置文件

php artisan vendor:publish --provider="Composite\TecDoc\TecDocServiceProvider" --tag=config

发布后，config/tecdoc.php 配置文件 包含

<?php

return [

    /*
    |--------------------------------------------------------------------------
    | TecDoc service url
    |--------------------------------------------------------------------------
    |
    | The service url of TecDoc REST API
    |
    */

    'service_url' => env('TEC_DOC_SERVICE_URL', "https://webservice.tecalliance.services/pegasus-3-0/services/TecdocToCatDLB.jsonEndpoint"),
    
    /*
    |--------------------------------------------------------------------------
    | API key (optional if IP is whitelisted)
    |--------------------------------------------------------------------------
    |
    | The user's API key for TecDoc REST API service.
    |
    */

    'api_key' => env('TECDOC_API_KEY'),
    
    /*
    |--------------------------------------------------------------------------
    | Provider ID
    |--------------------------------------------------------------------------
    |
    | The user's provider ID for TecDoc REST API service
    |
    */
    
    'provider_id' => env('TECDOC_PROVIDER_ID'),
    
    /*
    |--------------------------------------------------------------------------
    | Country code (ISO 3166)
    |--------------------------------------------------------------------------
    |
    | The user's registered country code (Country code according to ISO 3166)
    |
    */
    
    'country' => env('TECDOC_COUNTRY'),
    
    /*
    |--------------------------------------------------------------------------
    | Language code (ISO 639)
    |--------------------------------------------------------------------------
    |
    | Chosen language code for response (Language code according to ISO 639)
    |
    */
    
    'lang' => env('TECDOC_LANG'),
     
];

使用方法

• 制造商，请参阅 manufacturers.md
• 车型系列，请参阅 modelSeries.md
• 车辆，请参阅 vehicles.md
• 文章，请参阅 articles.md
• 地址，请参阅 addresses.md
• 装配组，请参阅 assemblyGroups.md

TecDoc::get(string $uri, array $payload = []);

TecDoc::post(string $uri, array $payload = []);

TecDoc::put(string $uri, array $payload = []);

TecDoc::delete(string $uri, array $payload = []);

TecDoc::manufacturers()->all(array $filter = null);

TecDoc::modelSeries()->findByNumber(int $manuId, array $filter = null);

TecDoc::vehicles()->find(int $carId, array $filter = null);

TecDoc::vehicles()->findByNumber(int $manuId, int $modId, array $filter = null);

TecDoc::articles()->filter(array $filter);

TecDoc::articles()->find(int $articleId, array $filter = null);

TecDoc::articles()->findByNumber(int $articleNumber, array $filter = null);

TecDoc::addresses()->add(string $address, int $validityHours = null);

TecDoc::assemblyGroups()->filter(int $linkingTargetId, string $linkingTargetType = null, array $filter = null, bool $recursive = false);

测试

composer lint

贡献

安全漏洞

如果您发现任何与安全相关的问题，请通过电子邮件 btamba@composite.hu 联系，而不是使用问题跟踪器。所有安全漏洞都将得到及时处理。

许可

Laravel TecDoc 包是开源软件，许可协议为 MIT 许可协议。