OdooApiBundle

Symfony integration of the package ang3/php-odoo-api-client - Please read the documentation of the client to know how to use it.

This bundle helps you to manage your Odoo connections by providing a registry and your clients as services.

Installation

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require ang3/odoo-api-bundle

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.

Step 2: Enable the Bundle

This step is done automatically on symfony >=4.0

Then, enable the bundle by adding it to the list of registered bundles in the app/AppKernel.php file of your project:

<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
  public function registerBundles()
  {
    $bundles = array(
      // ...
      new Ang3\Bundle\OdooApiBundle\Ang3OdooApiBundle(),
    );

    // ...
  }

  // ...
}

Step 3: Configure your app

Depends on your symfony version, enable the configuration of the bundle:

# app/config/config.yml or config/packages/ang3_odoo_api.yaml
ang3_odoo_api:
  default_connection: default
  default_logger: '<logger_service_name>' # Instance of \Psr\Log\LoggerInterface
  # If set, the default logger is used if no logger was set for a connection
  connections:
    default:
      url: <database_url>
      database: <database_name>
      user: <username>
      password: <password>
      logger: '<logger_service_name>' # Instance of \Psr\Log\LoggerInterface

The parameter default_connection is used to define the default connection to use.

Usage

First, configure your connections in the package configuration file. That should be done in step 3 of the installation section.

Registry

If you want to work with all your configured clients, then you may want to get the registry. It stores all configured clients by connection name. You can get it by dependency injection:

use Ang3\Bundle\OdooApiBundle\ClientRegistry;

class MyService
{
    private $clientRegistry;

    public function __construct(ClientRegistry $clientRegistry)
    {
        $this->clientRegistry = $clientRegistry;
    }
}

The registry contains three useful methods:

• public function set(string $connectionName, Client $client): self Set a client by connection name.
• public function get(string $connectionName): Client Get the client of a connection. A \LogicException is thrown if the connection was not found.
• public function has(string $connectionName): bool Check if a connection exists by name.

If you don't use autowiring, you must pass the service as argument of your service:

# app/config/services.yml or config/services.yaml
# ...
MyClass:
    arguments:
        $clientRegistry: '@ang3_odoo_api.client_registry'

Clients

It could be useful to get a client directly without working with the registry.

For example, the get the default client by autowiring, use the argument Ang3\Component\Odoo\Client $client:

use Ang3\Component\Odoo\Client;

class MyService
{
    private $client;

    public function __construct(Client $client)
    {
        $this->client = $client;
    }
}

Run the command php bin/console debug:autowiring Client to get the list of autowired clients.

• If the connection name is acme, then the autowiring argument is Ang3\Component\Odoo\Client $acmeClient

Finally, if you don't use autowiring, you must pass the service as argument of your service:

# app/config/services.yml or config/services.yaml
# ...
MyClass:
    arguments:
        $clientRegistry: '@ang3_odoo_api.client.<connection_name>' # Or '@ang3_odoo_api.client' for the default connection

For each client, the bundle creates a public alias following this naming convention: ang3_odoo_api.client.<connection_name>.

Validator

This bundle provides a validator according to the package symfony/validator to validate a record by ID, domains and/or connection. It resides to a basic annotation.

Here is an example of an object storing the ID of a company and invoice:

use Ang3\Bundle\OdooApiBundle\Validator\Constraints\OdooRecord;

class MyEntity
{
    /**
     * @var int
     *
     * @OdooRecord("res.company")
     * ...
     */
    private $companyId;

    /**
     * @var int
     *
     * @OdooRecord(model="account.move", domains="expr.eq('company_id.id', this.companyId)", connection="default")
     * ...
     */
    private $invoiceId;
}

Here is the list of all options you can pass to the annotation:

• model (required string) The model name of the record.
• domains (string) An expression which evaluation must returns valid client criteria.
• connection (string) the name of the connection to use
  • By default the default connection is used.
• typeErrorMessage (string) The error message if the value is not a positive integer
  • By default the message is: This value must be a positive integer.
• notFoundMessage (string) The message if the record was not found
  • By default the message is: The record of ID {{ model_id }} from "{{ model_name }}" was not found.

As you can see, the validator uses both symfony/expression-language and the expression builder provided with the client. By this way, you can filter allowed records easily.

Here are the variable passed to the evaluated expression:

• expr the expression builder
• this the object that the property/getter belongs to
• user the user of the request Symfony\Component\Security\Core\User\UserInterface|null

Upgrades

v1.0.2

• Updated client version to v5.1.1 (no BC).
• Fixed logger injection.

v1.0.1

• Added file Resources/config/services.yaml
• Fixed bundle extension
• Configured bundle autowiring

From 1.* to 2.*

What you have to do:

• Follow upgrade instructions From 4.* to 5.* of the client
• Replace Ang3\Component\Odoo\ExternalApiClient with Ang3\Component\Odoo\Client.
• Create and use your own helpers.

Logs:

• Added Odoo record validator.
• Updated composer.json for Symfony ^5.0 support.
• Updated client to version 5.0 for latest feature (expression builder).
• Implemented client parameter autowiring.
• Deleted helpers before the model names depend on Odoo server version.