Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hiqsol committed Mar 30, 2017
1 parent d7a000e commit 5998c9c
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 10 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ To use this extension, configure hiart component in your application config:
'components' => [
'hiart' => [
'class' => \hiqdev\hiart\rest\Connection::class,
'requestClass' => \hiqdev\hiart\curl\Request::class,
'requestClass' => \hiqdev\hiart\auto\Request::class,
'baseUri' => 'https://site.com/api/v3/',
],
],
Expand All @@ -53,15 +53,16 @@ To use this extension, configure hiart component in your application config:
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, **cURL** 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:

- [PHP streams](http://php.net/manual/en/book.stream.php), **default**, included in this package
- [cURL](http://php.net/manual/en/book.curl.php), provided with [yii2-hiart-curl](https://github.com/hiqdev/yii2-hiart-curl)
- **auto** - auto detects best supported transport
- [PHP streams](http://php.net/manual/en/book.stream.php), the most generic fallback, included in this package
- [cURL](http://php.net/manual/en/book.curl.php), included in this package
- [Guzzle](https://github.com/guzzle/guzzle), provided with [yii2-hiart-guzzle](https://github.com/hiqdev/yii2-hiart-guzzle)
- [yii2-httpclient](https://github.com/yiisoft/yii2-httpclient), provided with [yii2-hiart-httpclient](https://github.com/hiqdev/yii2-hiart-httpclient)

Expand Down Expand Up @@ -123,7 +124,7 @@ $user->save();
$admins = User::find()->where(['type' => User::ADMIN_TYPE])->all();
```

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

[Yii2 ActiveRecord]: http://www.yiiframework.com/doc-2.0/guide-db-active-record.html

Expand Down
9 changes: 5 additions & 4 deletions docs/readme/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ To use this extension, configure hiart component in your application config:
'components' => [
'hiart' => [
'class' => \hiqdev\hiart\rest\Connection::class,
'requestClass' => \hiqdev\hiart\curl\Request::class,
'requestClass' => \hiqdev\hiart\auto\Request::class,
'baseUri' => 'https://site.com/api/v3/',
],
],
Expand All @@ -13,15 +13,16 @@ To use this extension, configure hiart component in your application config:
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, **cURL** 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:

- [PHP streams](http://php.net/manual/en/book.stream.php), **default**, included in this package
- [cURL](http://php.net/manual/en/book.curl.php), provided with [yii2-hiart-curl](https://github.com/hiqdev/yii2-hiart-curl)
- **auto** - auto detects best supported transport
- [PHP streams](http://php.net/manual/en/book.stream.php), the most generic fallback, included in this package
- [cURL](http://php.net/manual/en/book.curl.php), included in this package
- [Guzzle](https://github.com/guzzle/guzzle), provided with [yii2-hiart-guzzle](https://github.com/hiqdev/yii2-hiart-guzzle)
- [yii2-httpclient](https://github.com/yiisoft/yii2-httpclient), provided with [yii2-hiart-httpclient](https://github.com/hiqdev/yii2-hiart-httpclient)

Expand Down
2 changes: 1 addition & 1 deletion docs/readme/Usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ $user->save();
$admins = User::find()->where(['type' => User::ADMIN_TYPE])->all();
```

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

[Yii2 ActiveRecord]: http://www.yiiframework.com/doc-2.0/guide-db-active-record.html

0 comments on commit 5998c9c

Please sign in to comment.