https://github.com/edumarques/dynamophp-symfony
DynamoPHP Symfony Bundle integrates DynamoPHP into Symfony applications, providing seamless configuration and service registration.
https://github.com/edumarques/dynamophp-symfony
aws aws-dynamodb data-mapper dynamodb dynamodb-orm no-sql odm orm php single-table-design strongly-typed symfony symfony-bundle type-safe
Last synced: 2 months ago
JSON representation
DynamoPHP Symfony Bundle integrates DynamoPHP into Symfony applications, providing seamless configuration and service registration.
- Host: GitHub
- URL: https://github.com/edumarques/dynamophp-symfony
- Owner: edumarques
- License: mit
- Created: 2025-05-06T07:55:44.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-05-18T13:53:37.000Z (8 months ago)
- Last Synced: 2025-06-21T22:17:11.332Z (7 months ago)
- Topics: aws, aws-dynamodb, data-mapper, dynamodb, dynamodb-orm, no-sql, odm, orm, php, single-table-design, strongly-typed, symfony, symfony-bundle, type-safe
- Language: PHP
- Homepage:
- Size: 95.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
DynamoPHP Symfony Bundle
================
---
The **DynamoPHP Symfony Bundle** integrates [DynamoPHP](https://github.com/edumarques/dynamophp)
into [Symfony](https://symfony.com) applications, providing seamless configuration and service registration for Amazon
DynamoDB operations.
## Features
- Auto-wiring of DynamoPHP services
- Configurable AWS SDK DynamoDB client, Marshaler and Serializer
- Sandbox application for testing and development
## Installation
Install via Composer:
```shell
composer require edumarques/dynamophp-symfony
```
If your Symfony application is not configured to use Symfony Flex for automatic bundle registration, you need to
register it manually in `config/bundles.php`:
```php
# config/bundles.php
return [
// ... other bundles
EduardoMarques\DynamoPHPBundle\DynamoPHPBundle::class => ['all' => true],
];
```
## Configuration
After installation, you must configure the bundle by creating a `dynamo_php.yaml` file in your `config/packages/`
directory:
```yaml
# config/packages/dynamo_php.yaml
dynamo_php:
client: dynamodb_client # set the service ID of the AWS DynamoDB client registered in your app
marshaler: marshaler # set the service ID of the AWS Marshaler registered in your app
serializer: serializer # set the service ID of the Symfony serializer registered in your app
```
## Usage
Once configured, you can inject DynamoPHP services into your Symfony services or controllers. For example, to use the
EntityManager:
```php
use EduardoMarques\DynamoPHP\ODM\EntityManager;
class YourService
{
public function __construct(
private EntityManager $entityManager,
) {
}
// Your methods here
}
```
## Contributing
Contributors are always welcome! For more information on how you can contribute, please read
our [contribution guideline](CONTRIBUTING.md).
For any questions, feel free to reach out to me directly by
email: [eduardomarqs1@gmail.com](mailto:eduardomarqs1@gmail.com).
For more information on DynamoPHP, visit the [DynamoPHP repository](https://github.com/edumarques/dynamophp).