bankiru/doctrine-api-bundle

This package is abandoned and no longer maintained. No replacement package was suggested.

Doctrine-faced RPC API Client Bundle

2.0 2017-05-23 13:26 UTC

Requires

• php: ~5.5 | ~7.0
• bankiru/doctrine-api-client: ~2.0
• symfony/config: ~2.8 | ~3.0
• symfony/dependency-injection: ~2.8 | ~3.0
• symfony/http-kernel: ~2.8 | ~3.0
• symfony/property-access: ~2.8 | ~3.0

Requires (Dev)

• phpunit/phpunit: ^4.8.35 | ^5.5 | ^6.0
• sensio/framework-extra-bundle: ~3.0
• symfony/monolog-bundle: ^2.8 | ^3.0
• symfony/phpunit-bridge: ^2.8 | ^3.0
• symfony/stopwatch: ~2.8 | ~3.0
• symfony/web-profiler-bundle: ~2.8 | ~3.0

Suggests

• sensio/framework-extra-bundle: For ParamConverter controller arguments support
• symfony/monolog-bundle: For logging API requests
• symfony/stopwatch: For profiling API requests
• symfony/web-profiler-bundle: For integrating to web-profiling bundle

MIT

• Pavel Batanov

README

Doctrine-faced RPC Bundle

This bundle incorporates doctrine API library bankiru/doctrine-api-client

Services

This bundle provides the only public service to use - @bankiru_api.entity_manager. This service implements ApiEntityManager extends ObjectManager interface

Features

Automatic bundle metadata registration

This bundle automatically registers all bundles yaml annotations if they are stored at @BundleName\Resources\config\api location.

Client aggregation

This bundle automatically registers all services, marked with rpc_client tag into the library client registry, i.e

  bankiru_api.test.client:
    class: Bankiru\Api\Tests\TestClient
    arguments:
    - "@bankiru_api.test.client_mock"
    tags:
    - { name: rpc_client, client_name: test_client }

Profiling

This bundle enables RPC client profiling and time tracing with internal Symfony components - stopwatch and web debug toolbar.

@Todo: populate with screenshots

Cache configuration

# TTL only
api_client:
    cache:
        configuration:
            Bankiru\Api\Doctrine\Test\Entity\TestEntity: 900

# Default
api_client:
    cache:
        configuration:
            Bankiru\Api\Doctrine\Test\Entity\TestEntity:
                enabled: false

# Enabled defaults
api_client:
    cache:
        configuration:
            Bankiru\Api\Doctrine\Test\Entity\TestEntity:
                enabled: true
                ttl: ~
                extra: {}

# Extra keys would be available within API entity cache via CacheConfigurationInterface
api_client:
    cache:
        configuration:
            Bankiru\Api\Doctrine\Test\Entity\TestEntity:
                enabled: true
                ttl: 900
                extra:
                    quick_search: true