<?php

require_once 'vendor/autoload.php';

use Ang3\Component\Odoo\Client;

// Option 1: by calling the constructor...
$client = new Client('<host>', '<database>', '<username>', '<password>', $logger = null);

// Option 2 : by calling the static method ::createFromConfig() with configuration as array
$client = Client::createFromConfig([
    'host' => '<host>',
    'database' => '<database>',
    'user' => '<user>',
    'password' => '<password>',
], $logger = null);

$result = $client->call($name, $method, $parameters = [], $options = []);

$data = [
    'field_name' => 'value'
];

$recordId = $client->create('model_name', $data);

$ids = [1,2,3]; // Can be a value of type int|array<int>

$data = [
    'field_name' => 'value'
];

$client->update('model_name', $ids, $data); // void

$ids = [1,2,3]; // Can be a value of type int|array<int>
$records = $client->read('model_name', $ids);

$id = 1; // Must be an integer
$record = $client->find('model_name', $id, $options = []);

$record = $client->findOneBy('model_name', $criteria = null, $options = []);

$records = $client->findBy('model_name', $criteria = null, $options = []);

$recordIds = $client->searchOne('model_name', $criteria = null, $options = []);

$recordIds = $client->searchAll('model_name', $options = []);

$recordIds = $client->search('model_name', $criteria = null, $options = []);

$id = 1; // Must be an integer
$recordExists = $client->exists('model_name', $id);

$nbRecords = $client->count('model_name', $criteria = null);

$ids = [1,2,3]; // Can be a value of type int|array<int>
$client->delete('model_name', $ids);

$expr = $client->getExpressionBuilder();
// Or $expr = $client->expr();

use Ang3\Component\Odoo\Expression\ExpressionBuilder;

$expr = new ExpressionBuilder();

// $client instanceof Client

// Get the expression builder
$expr = $client->expr();

$result = $client->findBy('model_name', $expr->andX( // Logical node "AND"
	$expr->gte('id', 10), // id >= 10
	$expr->lte('id', 100), // id <= 10
), $options = []);

$result = $client->findBy('model_name', $expr->andX(
    $expr->orX(
        $expr->eq('A', 1),
        $expr->eq('B', 1)
    ),
    $expr->orX(
        $expr->eq('C', 1),
        $expr->eq('D', 1),
        $expr->eq('E', 1)
    )
), $options = []);

/**
 * Create a logical operation "AND".
 */
public function andX(DomainInterface ...$domains): CompositeDomain;

/**
 * Create a logical operation "OR".
 */
public function orX(DomainInterface ...$domains): CompositeDomain;

/**
 * Create a logical operation "NOT".
 */
public function notX(DomainInterface ...$domains): CompositeDomain;

/**
 * Check if the field is EQUAL TO the value.
 *
 * @param mixed $value
 */
public function eq(string $fieldName, $value): Comparison;

/**
 * Check if the field is NOT EQUAL TO the value.
 *
 * @param mixed $value
 */
public function neq(string $fieldName, $value): Comparison;

/**
 * Check if the field is UNSET OR EQUAL TO the value.
 *
 * @param mixed $value
 */
public function ueq(string $fieldName, $value): Comparison;

/**
 * Check if the field is LESS THAN the value.
 *
 * @param mixed $value
 */
public function lt(string $fieldName, $value): Comparison;

/**
 * Check if the field is LESS THAN OR EQUAL the value.
 *
 * @param mixed $value
 */
public function lte(string $fieldName, $value): Comparison;

/**
 * Check if the field is GREATER THAN the value.
 *
 * @param mixed $value
 */
public function gt(string $fieldName, $value): Comparison;

/**
 * Check if the field is GREATER THAN OR EQUAL the value.
 *
 * @param mixed $value
 */
public function gte(string $fieldName, $value): Comparison;

/**
 * Check if the variable is LIKE the value.
 *
 * An underscore _ in the pattern stands for (matches) any single character
 * A percent sign % matches any string of zero or more characters.
 *
 * If $strict is set to FALSE, the value pattern is "%value%" (automatically wrapped into signs %).
 *
 * @param mixed $value
 */
public function like(string $fieldName, $value, bool $strict = false, bool $caseSensitive = true): Comparison;

/**
 * Check if the field is IS NOT LIKE the value.
 *
 * @param mixed $value
 */
public function notLike(string $fieldName, $value, bool $caseSensitive = true): Comparison;

/**
 * Check if the field is IN values list.
 */
public function in(string $fieldName, array $values = []): Comparison;

/**
 * Check if the field is NOT IN values list.
 */
public function notIn(string $fieldName, array $values = []): Comparison;

// $client instanceof Client

// Get the expression builder
$expr = $client->expr();

// Prepare new record data
$data = [
    'foo' => 'bar',
    'bar_ids' => [ // Field of type "manytoMany"
        $expr->addRecord(3), // Add the record of ID 3 to the set
        $expr->createRecord([  // Create a new sub record and add it to the set
            'bar' => 'baz'
            // ...
        ])
    ]
];

$result = $client->create('model_name', $data);

/**
 * Adds a new record created from data.
 */
public function createRecord(array $data): array;

/**
 * Updates an existing record of id $id with data.
 * /!\ Can not be used in record insert query.
 */
public function updateRecord(int $id, array $data): array;

/**
 * Adds an existing record of id $id to the collection.
 */
public function addRecord(int $id): array;

/**
 * Removes the record of id $id from the collection, but does not delete it.
 * /!\ Can not be used in record insert query.
 */
public function removeRecord(int $id): array;

/**
 * Removes the record of id $id from the collection, then deletes it from the database.
 * /!\ Can not be used in record insert query.
 */
public function deleteRecord(int $id): array;

/**
 * Replaces all existing records in the collection by the $ids list,
 * Equivalent to using the command "clear" followed by a command "add" for each id in $ids.
 */
public function replaceRecords(array $ids = []): array;

/**
 * Removes all records from the collection, equivalent to using the command "remove" on every record explicitly.
 * /!\ Can not be used in record insert query.
 */
public function clearRecords(): array;