README

abdulsalamemesh/what-to-do-api-client 是一个用于与 what-to-do-api.com API 通信的简单客户端。

安装

您可以通过 composer 安装此包

composer require abdulsalamemesh/what-to-do-api-client

用法

获取随机任务

您可以使用外观 AbdulsalamEmesh\WhatToDo\Facades\WhatToDo 获取一个随机任务

use AbdulsalamEmesh\WhatToDo\Facades\WhatToDo;

WhatToDo::getTask();

过滤任务

您可以在调用时绑定以下方法来过滤结果。

方法包括：category、person、cost、language、identifier。

示例

$task = WhatToDo::category('fun')->person(1)->cost('$')->language('en')->identifier('1sdre5')->getTask();

创建任务

您可以通过在外观上调用 create 方法并传入数据来创建任务。

API 将接受您的任务和您选择的语言，并将其用作基础语言来将任务翻译成所有支持的语言。

$data = [
    'language' => 'en',
    'task'     => 'play football',
    'category' => 'fun',
    'person'   => 4,
    'cost'     => '$',
    'links'    => [
      'en' => 'https://www.google.com/'
      'de' => 'https://www.google.com/?hl=de'
    ],
];

$task = WhatToDo::create($data);

dd($task);
// return a collection of the following data:
[
    "identifier" => "8892a2"
    "task" =>  [
      "en-US" => "play football"
      "de" => "Fußball spielen"
      "es" => "jugar al fútbol"
      "fr" => "jouer au football"
      "it" => "giocare a calcio"
      "tr" => "futbol oynamak"
      "uk" => "грати у футбол"
    ]
    "category" => "fun"
    "person" => 4
    "cost" => "$"
    "links" => [
      "en" => "https://www.google.com/"
      "de" => "https://www.google.com/?hl=de"
      "es" => ""
      "fr" => ""
      "it" => ""
      "tr" => ""
      "uk" => ""
    ]
  ]

支持的语言

支持的语言有

$supportedLanguages = [
        'en-US' => 'english',
        'de'    => 'german',
        'es'    => 'spanish',
        'fr'    => 'french',
        'it'    => 'italian',
        'tr'    => 'turkish',
        'uk'    => 'ukrainian',
];

支持的费用

支持的费用有

$supportedCosts = ['free', '$', '$$', '$$$'];

人数

最小为 1，最大为 10

测试

composer test

贡献

请参阅 CONTRIBUTING 获取详细信息。

安全

如果您发现任何与安全相关的问题，请通过电子邮件 contact@abdulsalam-emesh.me 联系，而不是使用问题跟踪器。

鸣谢

许可证

MIT 许可证（MIT）。有关更多信息，请参阅许可证文件。

abdulsalamemesh / what-to-do-api-client

维护者

详细信息