mirzaev
/
yii2-arangodb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Edit readme

This commit is contained in:
Ilya Rumyancev (MacBook) 2017-04-14 00:48:32 +03:00
parent 9f02264965
commit d164b955c9
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -14,13 +14,13 @@ The preferred way to install this extension is through [composer](http://getcomp
Either run Either run
``` ```
php composer.phar require --prefer-dist devgroup/yii2-arangodb "*" php composer.phar require --prefer-dist explosivebit/yii2-arangodb "*"
``` ```
or add or add
``` ```
"devgroup/yii2-arangodb": "*" "explosivebit/yii2-arangodb": "*"
``` ```
to the require section of your composer.json. to the require section of your composer.json.
@ -36,7 +36,7 @@ return [
//.... //....
'components' => [ 'components' => [
'arangodb' => [ 'arangodb' => [
'class' => '\devgroup\arangodb\Connection', 'class' => '\explosivebit\arangodb\Connection',
'connectionOptions' => [ 'connectionOptions' => [
triagens\ArangoDb\ConnectionOptions::OPTION_DATABASE => "mydatabase", triagens\ArangoDb\ConnectionOptions::OPTION_DATABASE => "mydatabase",
triagens\ArangoDb\ConnectionOptions::OPTION_ENDPOINT => 'tcp://127.0.0.1:8529', triagens\ArangoDb\ConnectionOptions::OPTION_ENDPOINT => 'tcp://127.0.0.1:8529',
@ -51,10 +51,10 @@ return [
Using the connection instance you may access databases, collections and documents. Using the connection instance you may access databases, collections and documents.
To perform "find" queries, you should use [[\devgroup\arangodb\Query]]: To perform "find" queries, you should use [[\explosivebit\arangodb\Query]]:
```php ```php
use devgroup\arangodb\Query; use explosivebit\arangodb\Query;
$query = new Query; $query = new Query;
// compose the query // compose the query
@ -70,11 +70,11 @@ Using the ArangoDB ActiveRecord
------------------------------ ------------------------------
This extension provides ActiveRecord solution similar ot the [[\yii\db\ActiveRecord]]. This extension provides ActiveRecord solution similar ot the [[\yii\db\ActiveRecord]].
To declare an ActiveRecord class you need to extend [[\devgroup\arangodb\ActiveRecord]] and To declare an ActiveRecord class you need to extend [[\explosivebit\arangodb\ActiveRecord]] and
implement the `collectionName` and 'attributes' methods: implement the `collectionName` and 'attributes' methods:
```php ```php
use devgroup\arangodb\ActiveRecord; use explosivebit\arangodb\ActiveRecord;
class Customer extends ActiveRecord class Customer extends ActiveRecord
{ {
@ -98,11 +98,11 @@ class Customer extends ActiveRecord
Note: collection primary key name ('_key') should be always explicitly setup as an attribute. Note: collection primary key name ('_key') should be always explicitly setup as an attribute.
You can use [[\yii\data\ActiveDataProvider]] with [[\devgroup\arangodb\Query]] and [[\devgroup\arangodb\ActiveQuery]]: You can use [[\yii\data\ActiveDataProvider]] with [[\explosivebit\arangodb\Query]] and [[\explosivebit\arangodb\ActiveQuery]]:
```php ```php
use yii\data\ActiveDataProvider; use yii\data\ActiveDataProvider;
use devgroup\arangodb\Query; use explosivebit\arangodb\Query;
$query = new Query; $query = new Query;
$query->from('customer')->where(['status' => 2]); $query->from('customer')->where(['status' => 2]);
@ -132,7 +132,7 @@ $models = $provider->getModels();
Using Migrations Using Migrations
---------------- ----------------
ArangoDB migrations are managed via [[devgroup\arangodb\console\controllers\MigrateController]], which is an analog of regular ArangoDB migrations are managed via [[explosivebit\arangodb\console\controllers\MigrateController]], which is an analog of regular
[[\yii\console\controllers\MigrateController]]. [[\yii\console\controllers\MigrateController]].
In order to enable this command you should adjust the configuration of your console application: In order to enable this command you should adjust the configuration of your console application:
@ -141,7 +141,7 @@ In order to enable this command you should adjust the configuration of your cons
return [ return [
// ... // ...
'controllerMap' => [ 'controllerMap' => [
'arangodb-migrate' => 'devgroup\arangodb\console\controllers\MigrateController' 'arangodb-migrate' => 'explosivebit\arangodb\console\controllers\MigrateController'
], ],
]; ];
``` ```
@ -172,7 +172,7 @@ return [
'debug' => 'yii\debug\Module', 'debug' => 'yii\debug\Module',
'panels' => [ 'panels' => [
'arango' => [ 'arango' => [
'class' => 'devgroup\arangodb\panels\arangodb\ArangoDbPanel', 'class' => 'explosivebit\arangodb\panels\arangodb\ArangoDbPanel',
], ],
], ],
... ...