grafstorm/hittase-php-api-for-laravel

0.1.0 2021-05-26 21:10 UTC

This package is not auto-updated.

Last update: 2024-09-26 12:37:21 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

此包使用Hitta.se API PHP包grafstorm/hitta_php_package并将其打包为Laravel。您需要做的只是将正确的callerId和apiKey设置在您的.env文件中。

有关可用字段的更多信息,请参阅http://hitta.github.io/public/http-api/

这是一个非官方包,目前处于测试阶段。

安装

您可以通过composer安装此包

composer require grafstorm/hittase-php-api-for-laravel

配置

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

php artisan vendor:publish --provider="Grafstorm\Hitta\HittaServiceProvider" --tag="hittase-php-api-for-laravel-config"

确保在您的.env文件中添加callerId和apiKey

HITTA_CALLER_ID=## your caller id ## 
HITTA_API_KEY=## your api key ##

这是发布配置文件的内容

return [
    'callerId' => env('HITTA_CALLER_ID'),
    'apiKey' => env('HITTA_API_KEY'),
];

用法

// Hitta.se API Wrapper as a Laravel Package
// Search for Swedish companies and people

// Combined search. You can also explicitly call Hitta::combined()
Hitta::what('Luke Skywalker')
  ->where('Kiruna')
  ->find();
  
$result = Hitta::combined()
  ->what('Empire')
  ->where('Deathstar')
  ->find();

foreach($result->companies as $company) {
  echo $company->displayName . "\n";
}

foreach($result->people as $person) {
  echo $person->displayName . "\n";
}

// Only Search for people
Hitta::people()
  ->what('Luke Skywalker')
  ->find();
  
// Only Search for companies
Hitta::companies()
  ->what('Empire')
  ->find();
  
// Optional search parameters
Hitta::companies()
  ->what('Luke Skywalker')
  ->where('Kiruna')
  ->pageNumber(1)
  ->pageSize(10)
  ->rangeFrom(100)
  ->rangeTo(150)
  ->find();

// Fetching details of a company or person with findPerson and findCompany.
$result = Hitta::people()
  ->what('Luke Skywalker')
  ->find();
  
$personId = collect($result->people)->first()->id;
$companyId = collect($result->companies)->first()->id;

Hitta::findPerson($personId);
Hitta::findCompany($companyId);

测试

请参阅grafstorm/hitta_php_package以获取测试信息。

composer test

变更日志

请参阅CHANGELOG以获取有关最近更改的更多信息。

贡献

请参阅CONTRIBUTING以获取详细信息。

安全漏洞

请查看我们的安全策略,了解如何报告安全漏洞。

致谢

许可证

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