Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edujugon/laradoo
Odoo ERP API for Laravel
https://github.com/edujugon/laradoo
api laravel odoo odoo-apps
Last synced: 5 days ago
JSON representation
Odoo ERP API for Laravel
- Host: GitHub
- URL: https://github.com/edujugon/laradoo
- Owner: Edujugon
- License: mit
- Created: 2017-05-16T15:10:37.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-31T14:00:59.000Z (about 1 year ago)
- Last Synced: 2024-10-12T10:44:29.505Z (26 days ago)
- Topics: api, laravel, odoo, odoo-apps
- Language: PHP
- Size: 319 KB
- Stars: 159
- Watchers: 12
- Forks: 99
- Open Issues: 27
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Laradoo
Odoo ERP API for Laravel. [Odoo website](https://www.odoo.com)
[](https://api.travis-ci.org/Edujugon/laradoo)
[](https://packagist.org/packages/edujugon/laradoo)
[](https://packagist.org/packages/edujugon/laradoo)
[](https://packagist.org/packages/edujugon/laradoo)
## Compatibility
| Laravel version | PHP version | Package version |
|---|---|---|
| ^5.1 | ^5.6 | ^V2.0 |
| ^5.1 | ^5.5 | ^V1.1 |
## Installation
type in console:
```shel
composer require edujugon/laradoo
```
Register Laradoo service by adding it to the providers array.
```php
'providers' => array(
...
Edujugon\Laradoo\Providers\OdooServiceProvider::class
)
```
Let's add the Alias facade, add it to the aliases array.
```php
'aliases' => array(
...
'Odoo' => Edujugon\Laradoo\Facades\Odoo::class,
)
```
Publish the package's configuration file to the application's own config directory
```php
php artisan vendor:publish --provider="Edujugon\Laradoo\Providers\OdooServiceProvider" --tag="config"
```
### Configuration
After publishing the package config file, the base configuration for laradoo package is located in config/laradoo.php
Also, you can dynamically update those values calling the available setter methods:
`host($url)`, `username($username)`, `password($password)`, `db($name)`, `apiSuffix($name)`
## Usage samples
Instance the main Odoo class:
```php
$odoo = new \Edujugon\Laradoo\Odoo();
```
You can get the Odoo API version just calling the version method:
```php
$version = $odoo->version();
```
> This methods doesn't require to be connected/Logged into the ERP.
Connect and log into the ERP:
```php
$odoo = $odoo->connect();
```
All needed configuration data is taken from `laradoo.php` config file. But you always may pass new values on the fly if required.
```php
$this->odoo = $this->odoo
->username('my-user-name')
->password('my-password')
->db('my-db')
->host('https://my-host.com')
->connect();
```
> // Note: `host` should contain 'http://' or 'https://'
After login, you can check the user identifier like follows:
```php
$userId= $this->odoo->getUid();
```
You always can check the permission on a specific model:
```php
$can = $odoo->can('read', 'res.partner');
```
> Permissions which can be checked: 'read','write','create','unlink'
Method `search provides a collection of ids based on your conditions:
```php
$ids = $odoo->where('customer', '=', true)
->search('res.partner');
```
You can limit the amount of data using `limit` method and use as many as condition you need:
```php
$ids = $odoo->where('is_company', true)
->where('customer', '=', true)
->limit(3)
->search('res.partner');
```
If need to get a list of models, use the `get` method:
```php
$models = $odoo->where('customer', true)
->limit(3)
->get('res.partner');
```
Instead of retrieving all properties of the models, you can reduce it by adding `fields` method before the method `get`
```php
$models = $odoo->where('customer', true)
->limit(3)
->fields('name')
->get('res.partner');
```
If not sure about what fields a model has, you can retrieve the model structure data by calling `fieldsOf` method:
```php
$structure = $odoo->fieldsOf('res.partner');
```
Till now we have only retrieved data from the ERP but you can also Create and Delete records.
In order to create a new record just call `create` method as follows:
```php
$id = $odoo->create('res.partner',['name' => 'Jonh Odoo']);
```
> The method returns the id of the new record.
For Deleting records we have the `delete` method:
```php
$result = $odoo->where('name', 'Jonh Odoo')
->delete('res.partner');
```
> Notice that before calling `delete` method you have to use `where`.
You can also remove records by ids like follows:
```php
$result = $odoo->deleteById('res.partner',$ids);
```
Update any record of your ERP:
```php
$updated = $odoo->where('name', 'John Odoo')
->update('res.partner',['name' => 'John Odoo Odoo','email' => '[email protected]']);
```
Notice that all `delete` and `update` methods always returns `true` except if there was an error.
`call` method is also available for those who want to set a custom API call:
```php
$odoo->call('res.partner', 'search',[
[
['is_company', '=', true],
['customer', '=', true]
]
],[
'offset'=>1,
'limit'=>5
]);
```
## [Full API list](https://edujugon.github.io/laradoo/build/master/Edujugon/Laradoo/Odoo.html)