PHP download

Download the PHP package hiqdev/yii2-hiart without Composer

On this page you can find all versions of the php package hiqdev/yii2-hiart. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download hiqdev/yii2-hiart
More information about hiqdev/yii2-hiart
Files in hiqdev/yii2-hiart

Vendor hiqdev
Package yii2-hiart
Short Description ActiveRecord for API
License BSD-3-Clause
Homepage https://github.com/hiqdev/yii2-hiart

Keywords rest api extension activerecord yii2

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of hiqdev/yii2-hiart

Informations about the package yii2-hiart

HiArt

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.

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

Configuration

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, 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:

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.

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.

All versions of yii2-hiart with dependencies

PHP Build Version

Package Version

Version 0.4.0 Release 20. Feb 2019
create-project require 0 people chose require and
0 people chose create-project.

Download

Download latest version of yii2-hiart from vendor hiqdev

Requires yiisoft/yii2 Version ~2.0.0

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package hiqdev/yii2-hiart contains the following files

Loading the files please wait ....