webravolab / layers
PHP abstraction layers
Requires
- php: >=7.1
- google/apiclient: ~2.2
- google/auth: ~1.0
- google/cloud-core: ~1.0
- google/cloud-datastore: ~1.0
- google/cloud-logging: ~1.0
- google/common-protos: ~1.0
- google/gax: ~1.0
- php-amqplib/php-amqplib: >=2.6.1
- psr/log: 1.1
- webpatser/laravel-uuid: ^3.0
- webravolab/cdn: dev-master
Requires (Dev)
- illuminate/console: ~5.2
- illuminate/filesystem: ~5.2
- illuminate/support: ~5.2
- orchestra/database: ~3.0
- orchestra/testbench: ~3.0
- phpunit/phpunit: ^4.8 || ^5.0 || ^6.5
- dev-master
- 1.1.1
- 1.1.0
- 1.0.49
- 1.0.48
- 1.0.47
- 1.0.46
- 1.0.45
- 1.0.44
- 1.0.43
- 1.0.42
- 1.0.41
- 1.0.40
- 1.0.39
- 1.0.38
- 1.0.37
- 1.0.36
- 1.0.35
- 1.0.34
- 1.0.33
- 1.0.32
- 1.0.31
- dev-1.3.2-beta
- dev-1.3.1-beta
- dev-2.2.0-beta
- dev-2.1.1-beta
- dev-2.1.0-beta
- dev-2.0.1-beta
- dev-2.0.0-beta
- dev-1.2.4-beta
- dev-1.2.3-beta
- dev-1.2.2-beta
- dev-1.2.2-dead
- dev-1.2.1-beta
- dev-1.2.0-beta
- dev-DataStore_refactoring
- dev-google-datastore
This package is auto-updated.
Last update: 2024-03-21 05:39:16 UTC
README
Laravel hexagonal architecture - Domain Driven Design abstraction layers
Includes:
- Generic queue handler using either RabbitMQ or Database
- Command bus (using generic queue handler)
- Generic Command to be extended from your commands
- Command bus dispatcher and remote command dispatcher
- Event sink (using generic queue handler)
- Generic Event to be extended from your events
- Event bus dispatcher and remote event dispatcher
- StackDriver logging (extending Monolog)
- Null logger (for testing)
- Eloquent persistence layer
- Generic configuration helper with override through database settings table
- Cdn image service (using webravolab/cdn package)
- File system service
- Abstract entity to be extended by your entities
- Abstract Value Objects and some simple implementations (url, guid, filename)
Installation
composer require webravolab/layers --no-dev
To perform tests omit the --no-dev to install the development dependencies.
The package is compatible with Laravel >= 5, not using (at the moment) any real version dependency.
Configuration
RabbitMQ Queue Handler
To use RabbitMQService you must have a running RabbitMQ server and copy the following file:
copy config/rabbitmq.php to laravel /config directory and customize configuration to access your RabbitMQ instance.
Database Queue Handler
DBQueueService is a DB based 100% replacement of RabbitMQ. It needs 3 tables to work:
jobs_queue
jobs
events
You can find the Laravel migrations to build these tables under tests/database/migrations.
Just replace the DB connection from testbench to whatever is your database name.
Testing
PhpUnit test suite is available. It creates a memory based SqLite database instance to create the required tables and perform tests.
It uses the package orchestra/testbench to simulate a full Laravel environment.
To test CdnService with Google Cloud Storage you must copy your service account json file to /tests folder (google-credentials.json).
Usage
To understand the generic Queue Handler behaviour plese refer to the included tests for usage examples.
To understand the queue strategies please refer to RabbitMQ documentation.
Notes
Stackdriver logging implementations require google/cloud-logging library and its dependencies.
It also needs a service account json key loaded in the project root directory. Refer to Google Cloud authentication docs for the details.
Config helper
Webravo\Infrastructure\Library\Configuration is a helper to access environment and config variables in a standard way, allowing variables override through a database table called settings.
You can find the Laravel migration to build the setting table under tests/database/migrations.
To enable settings override you must set the environment variable SETTINGS_DB_CONNECTION with the name of your DB connection where the settings table is located.