honey-comb / companies

0.3.3 2018-11-20 07:13 UTC

Requires

• php: ^7.1
• honey-comb/core: 0.3.*
• laravel/framework: 5.6.*

Requires (Dev)

• codedungeon/phpunit-result-printer: ^0.14
• mockery/mockery: ^1.0
• orchestra/testbench-browser-kit: ^3.6
• phpunit/phpunit: ~7.0

MIT

• Mantas Paulauskas
• Jevgenij Dmitrijev

• laravel
• companies
• honeycomb

Published on Packagist.org on 2018-11-20 07:14 UTC

README

Description

HoneyComb CMS Companies package, stores simple information about company. Currently contains integration with (rekvizitai.vz.lt) for automated company data retrieval for Lithuanian companies.

Requirement

• php: ^7.1
• laravel: ^5.6

Installation

Begin by installing this package through Composer.

	{
	    "require": {
	        "honey-comb/companies": "0.3.*"
	    }
	}

or

    composer require honey-comb/companies

Laravel integration

Firstly register the service provider and Facade by opening config/app.php

HoneyComb\Companies\Providers\HCCompanyServiceProvider::class,

Usage

In the .env file please add these parameters:

HC_COMPANY_REKVIZITAI_API_KEY=KEY
HC_COMPANY_REKVIZITAI_CLIENT_ID=ID

Through the help of HoneyComb\Companies\Services\HCCompanyService call findByCode('CODE') function

EXAMPLE

<?php

namespace HoneyComb\Companies\Http\Controllers\Admin;

use HoneyComb\Companies\Services\HCCompanyService;
use HoneyComb\Core\Http\Controllers\HCBaseController;

class HCCompanyController extends HCBaseController
{
    /**
     * @var HCCompanyService
     */
    private $service;

    public function __construct(HCCompanyService $service)
    {
        $this->service = $service;
    }

    public function findByCode(string $code): ?HCCompany
    {
        return $this->service->findByCode($code);
    }
    
    public function findAllFromRekvizitai(string $title): array
    {
        return $this->service->searchByTitleFromRekvizitai($title);
    }
}