PHP code example of harmonicdigital / dynamodb-odm

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

harmonicdigital / dynamodb-odm example snippets

use HarmonicDigital\DynamodbOdm\Attribute\Field;
use HarmonicDigital\DynamodbOdm\Attribute\Item;
use HarmonicDigital\DynamodbOdm\Attribute\PartitionKey;
use HarmonicDigital\DynamodbOdm\Attribute\SortKey;

#[Item(tableName: 'my_table', partitionKeyPrefix: 'MYPREFIX#')]
class MyItem
{
    #[Field] // Type 'S'
    #[PartitionKey] // Use as the partition key
    private string $id;

    #[Field(name: 'full_name')] // Use a different name for the DynamoDB Field, type S implied
    private string $name;

    #[Field] // Type 'N'
    #[SortKey] // Use as the sort key
    private int $age;
    
    #[Field(type: 'SS')] // Force a string set for a string list
    /** @var list<string> */
    private array $stringList;
    
    public function __construct(
        string $id = '',
        string $name = '',
        int $age = 0,
        array $stringList = []
    ) {
        $this->id = $id;
        $this->name = $name;
        $this->age = $age;
        $this->stringList = $stringList;
    }
    ) {}

    // Getters and setters...
}

use Aws\DynamoDb\DynamoDbClient;
use HarmonicDigital\DynamodbOdm\ItemManager;
use App\Test\Model\MyItem;

$dynamoDbClient = new DynamoDbClient([
    'region' => 'us-west-2',
    'version' => 'latest',
    'credentials' => [
        'key' => 'your-access-key-id',
        'secret' => 'your-secret-access-key',
    ],
]);

$itemManager = new ItemManager(
    $dynamoDbClient,
    [MyItem::class => 'my_item_table'] // optional parameters if you want to override the table an item is stored in
    );

// Create the table
$itemManager->createTable(MyItem::class);

// Create a new item
$item = new MyItem('id', 'My Full Name', 30, ['string1', 'string2']);

$itemManager->put($item);

// Retrieve an item
$result = $itemManager->getItem(MyItem::class, 'id', 30);
if ($result !== null) {
    echo $result->getName(); // Output: name
}

// Delete an item
$itemManager->delete($item);

// Create a table
$itemManager->createTable(MyItem::class);

namespace HarmonicDigital\DynamodbOdm\Transformer;

use HarmonicDigital\DynamodbOdm\Transformer\Exception\TransformationException;

#[\Attribute(\Attribute::TARGET_PROPERTY)]
class DateTimeTransformer implements Transformer
{
    public function __construct(
        public string $format = 'U.u'
    ) {}

    public function toDatabase(mixed $value, \ReflectionProperty $property): string
    {
        if (!$value instanceof \DateTimeInterface) {
            throw new TransformationException('Value must be an instance of \DateTimeInterface');
        }

        return $value->format($this->format);
    }

    public function fromDatabase(null|array|bool|float|int|string $value, \ReflectionProperty $property): \DateTimeInterface
    {
        $type = $property->getType();
        $declaredType = null;

        if ($type instanceof \ReflectionNamedType) {
            $declaredType = $type->getName();
        }

        if (\DateTime::class === $declaredType) {
            return \DateTime::createFromFormat($this->format, $value);
        }

        return \DateTimeImmutable::createFromFormat($this->format, $value);
    }
}

use HarmonicDigital\DynamodbOdm\Attribute\Field;
use HarmonicDigital\DynamodbOdm\Attribute\Item;
use HarmonicDigital\DynamodbOdm\Attribute\PartitionKey;
use HarmonicDigital\DynamodbOdm\Attribute\SortKey;
use HarmonicDigital\DynamodbOdm\Transformer\DateTimeTransformer;

#[Item(tableName: 'my_table')]
class MyItem
{
    #[Field] // Type 'S'
    #[PartitionKey] // Use as the partition key
    private string $id;

    #[Field(name: 'full_name')] // Use a different name for the DynamoDB Field
    private string $name;

    #[Field] // Type 'N'
    #[SortKey] // Use as the sort key
    private int $age;
    
    #[Field(type: 'N')] // Treats the string as a numeric-string
    /** @var numeric-string */
    private string $numericString;
    
    #[Field(type: 'B')] // Treats the string as a binary
    private string $binaryString;
    
    #[Field(type: 'SS')] // Force a string set for a string list
    /** @var list<string> */
    private array $stringList;
    
    #[Field]
    #[DateTimeTransformer] // Use the date-time transformer for database value storage
    private \DateTimeImmutable $createdAt;
    
    public function __construct(
        string $id = '',
        string $name = '',
        int $age = 0,
        array $stringList = []
    ) {
        $this->id = $id;
        $this->name = $name;
        $this->age = $age;
        $this->stringList = $stringList;
        $this->createdAt = new \DateTimeImmutable();
    }
    ) {}

    // Getters and setters...
}

use HarmonicDigital\DynamodbOdm\Attribute\Field;
use HarmonicDigital\DynamodbOdm\Attribute\Item;
use HarmonicDigital\DynamodbOdm\Attribute\PartitionKey;
use HarmonicDigital\DynamodbOdm\Transformer\Mapable;

class EmbeddedItem implements Mapable
{
    public static function fromMap(array $data): self
    {
        return new self(
            $data['name'],
            $data['value'],
        );
    }
    
    public function __construct(
        public string $name,
        public int $value,
    ) {}

    public function toMap(): array
    {
        return [
            'name' => $this->name,
            'value' => $this->value,
        ];
    }
}

#[Item]
class TestEmbeddedObject
{
    public function __construct(
        #[Field]
        #[PartitionKey]
        public string $id,
        #[Field]
        public EmbeddedItem $embeddedItem,
    ) {}
}