README

ActiveRecord for API

This Yii2 extension provides ActiveRecord implementation that allows to access remote/web API same way as you do with normal Yii2 DB ActiveRecord.

Installation

The preferred way to install this yii2-extension is through composer.

composer require "hiqdev/yii2-hiart"

But if you prefer Guzzle transport use yii2-hiart-guzzle package:

composer require "hiqdev/yii2-hiart-guzzle"

Configuration

To use this extension, configure hiart component in your application config:

    'components' => [
        'hiart' => [
            'class' => \hiqdev\hiart\rest\Connection::class,
            'requestClass' => \hiqdev\hiart\auto\Request::class,
            'baseUri' => 'https://site.com/api/v3/',
        ],
    ],

Note three main options:

class specifies class that actually implements API to be accessed, REST in this case
requestClass specifies transport implementation to be used, auto in this case
baseUri specifies starting point of the API

Transports

Available transports are:

auto - autodetects best supported transport
PHP streams, the most generic fallback, included in this package
cURL, included in this package
Guzzle, provided with yii2-hiart-guzzle
yii2-httpclient, provided with yii2-hiart-httpclient

You can implement your own transport. All you need is to create two classes: Request and Response, it's not difficult see available implementations. Transport can be even non-HTTP based.

Query builders

QueryBuilder is what actually implements an API.

We are developing QueryBuilders for:

Basic REST API, included in this package
GitHub API, provided with yii2-hiart-github
HiPanel API, provided with hipanel-hiart

You can implement your own API. Basically all you need is create your QueryBuilder class with these methods:

buildMethod(Query $query)
buildHeaders(Query $query)
buildUri(Query $query)
buildQueryParams(Query $query)
buildBody(Query $query)
buildFormParams(Query $query)

See available implementations and ask questions using issues on GitHub.

Usage

Define your Model:

class User extends \hiqdev\hiart\ActiveRecord
{
    public function rules()
    {
        return [
            ['id', 'integer', 'min' => 1],
            ['login', 'string', 'min' => 2, 'max' => 32],
        ];
    }
}

Note that you use general hiqdev\hiart\ActiveRecord class not specific for certain API. API is specified in connection options and you don't need to change model classes when you change API.

Then you just use your models same way as DB ActiveRecord models.

$user = new User();
$user->login = 'sol';

$user->save();

$admins = User::find()->where(['type' => User::ADMIN_TYPE])->all();

Basically all the features of Yii2 ActiveRecord work if your API provides them.

License

This project is released under the terms of the BSD-3-Clause license. Read more here.

Acknowledgments

This project was started as fork from Yii2 Elasticsearch.

hiqdev / yii2-hiart

Maintainers

Details