consultnn / abstract-client
Abstract classes for api client
Installs: 2 895
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 9
Forks: 0
Open Issues: 0
Requires
- php: >=5.4.0
- ext-curl: *
- psr/log: ~1.0.0
This package is auto-updated.
Last update: 2024-11-08 23:07:28 UTC
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;
}