consultnn/abstract-client

Abstract classes for api client

v1.0.1 2020-07-08 13:49 UTC

Requires

• php: >=5.4.0
• ext-curl: *
• psr/log: ~1.0.0

MIT

• ICC Ltd.
• Maxim Mironyuk

• api
• ConsultNN

README

Базовые классы:

• AbstractDomain - класс предметной области, он него наследуются классы реализующие методы доступа к api, как правило соответствует одному контроллеру в api. Реализованы методы getSingle, getInternalList, getMeta - получение одного объекта, массива или мета информации
• AbstractMapper - класс для маппинга данных, от него наследуются классы описывающие тот или иной тип данных
• ApiConnection - обёртка над curl

Пример использования:

Наследуемся от AbstractDomain, добавляем параметры инициализации

/**
 * Class Company
 * @package consultnn\api
 */
class PageDomain extends \consultnn\baseapi\AbstractDomain
{
    public function init()
    {
        //базовый путь для запросов вида http://api.example.com/<version>/<endpoint>
        $this->client->url = 'http://api.example.com';
    }

    public function getBySlug($slug, $type = null)
    {
        return $this->getSingle(
            'page/' . $slug,
            Page::class,
            [
                'attribute' => 'slug',
                'type' => $type
            ]
        );
    }

    public function getList($queryParams) {
        return $this->getInternalList('page', Page::class, $queryParams)
    }
}

Второй параметр в методе getSingle, указывает на класс используемый для маппинга данных

class Page extends AbstractMapper
{
    public $title;
    public $meta_keywords;
    public $meta_description;
    public $slug;
    public $h1;
    public $content;
}