gkite13/vtiger-api-bundle

v1.0.3 2022-02-14 06:03 UTC

Requires

• php: >=7.4
• ext-json: *
• symfony/config: ^5.0
• symfony/dependency-injection: ^5.0
• symfony/http-kernel: ^5.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3
• matthiasnoback/symfony-config-test: ^4.3
• matthiasnoback/symfony-dependency-injection-test: ^4.1
• symfony/browser-kit: ^5.0
• symfony/framework-bundle: ^5.0
• symfony/http-client: ^5.4
• symfony/phpunit-bridge: ^6.0

MIT

• Aleksey Grednikov

README

Installation

$ composer require gkite13/vtiger-api-bundle

Configuration

# config/packages/gkite13_vtiger_api.yaml
gkite13_vtiger_api:
    api:
        site_url: "http://your_crm_url"
        user: "user_name"
        access_key: "user_access_key"

For configure cache pool

# config/packages/cache
pools:
# ...
  my_cache_pool:
    adapter: cache.adapter.filesystem

# config/packages/gkite13_vtiger_api.yaml
gkite13_vtiger_api:
# ...
  cache:
    pool: my_cache_pool

Usage

Query

$queryString = "SELECT * FROM ModuleName";
$result = $this->vtigerApi->query($queryString);

Retrieve

To retrieve a record, you need a vtiger_ws_entity id and entityId.

$leadId = "10x12345";
$result = $this->vtigerApi->retrieve($leadId);

Create

$lead = new \stdClass();
$lead->property1 = 'test';
$lead->property2 = 12345;
$result = $this->vtigerApi->create('EntityType', $lead);

Update

$leadId = "10x12345";
$lead = $this->vtigerApi->retrieve($leadId);
$lead->property1 = 'test2';
$lead->property2 = 123;
$result = $this->vtigerApi->update($lead);

Delete

$leadId = "10x12345";
$result = $this->vtigerApi->delete($leadId);