SymfonyUidDoctrine - GitLite

KO | EN

gitlite — search

#swift #pytorch #dotnet #typescript #git #hacktoberfest #automation #macos #llm #github

SymfonyUidDoctrine

(★ 11)

A small and fast library which aim to provide Symfony/Uid support in Doctrine as a custom type

File Explorer

ZIP Download

- - configuration.yaml
  - project.yaml
- CONTRIBUTING.md
- - Dockerfile
- - UlidGenerator.php
  - UlidType.php
- - UuidGenerator.php
  - UuidType.php
- - UlidGeneratorTest.php
  - UlidTypeTest.php
- - UuidGeneratorTest.php
  - UuidTypeTest.php
.dockerignore
.gitignore
CHANGELOG.md
composer.json
composer.lock
docker-compose.yml
infection.json.dist
Makefile
phpunit.xml.dist
README.md

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

`composer`

View Details ▼

A package-based dependency manager for PHP projects.

composer init

Interactively create a `composer.json` file:

composer require {{user/package}}

Add a package as a dependency for this project, adding an entry to `composer.json`:

composer install

Install all the dependencies in this project's `composer.json` and create `composer.lock`:

# Project Badges

SymfonyUidDoctrine
SymfonyUidDoctrine - Configuration

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

The `guikingone/symfony-uid-doctrine` aim to provide the support of `Symfony/Uid` as a `Doctrine` type.

## Installation

Consider using `Packagist` and `Composer` when installing the following project:

```bash
composer require guikingone/symfony-uid-doctrine
```

## Configuration

### Uuid

```php
Doctrine\DBAL\Types\Type::addType('uuid', Guikingone\SymfonyUid\Doctrine\Uuid\UuidType::class);
```

```yaml
# config/packages/doctrine.yaml
doctrine:
    dbal:
        types:
            uuid: Guikingone\SymfonyUid\Doctrine\Uuid\UuidType
```

### Ulid

```php
Doctrine\DBAL\Types\Type::addType('ulid', Guikingone\SymfonyUid\Doctrine\Ulid\UlidType::class);
```

```yaml
# config/packages/doctrine.yaml
doctrine:
    dbal:
        types:
            ulid: Guikingone\SymfonyUid\Doctrine\Ulid\UlidType
```

## Usage

### Uuid

```php
use Doctrine\ORM\Mapping as ORM;
use Guikingone\SymfonyUid\Doctrine\Uuid\UuidGenerator;

/**
 * @ORM\Entity
 * @ORM\Table(name="posts")
 */
class Post
{
    /**
     * @var Symfony\Component\Uid\Uuid
     *
     * @ORM\Id
     * @ORM\Column(type="uuid", unique=true)
     * @ORM\GeneratedValue(strategy="CUSTOM")
     * @ORM\CustomIdGenerator(class=UuidGenerator::class)
     */
    protected $id;

public function getId(): Uuid
    {
        return $this->id;
    }
}
```

If you don't want to use the generator, consider using the `__construct()` method:

```php
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Uid\Uuid;

/**
 * @ORM\Entity
 * @ORM\Table(name="posts")
 */
class Post
{
    /**
     * @var Symfony\Component\Uid\Uuid
     *
     * @ORM\Id
     * @ORM\Column(type="uuid", unique=true)
     */
    protected $id;

public function __construct() 
    {
        $this->id = Uuid::v4();
    }

public function getId(): Uuid
    {
        return $this->id;
    }
}
```

### Ulid

```php
use Doctrine\ORM\Mapping as ORM;
use Guikingone\SymfonyUid\Doctrine\Ulid\UlidGenerator;

/**
 * @ORM\Entity
 * @ORM\Table(name="posts")
 */
class Post
{
    /**
     * @var Symfony\Component\Uid\Ulid
     *
     * @ORM\Id
     * @ORM\Column(type="ulid", unique=true)
     * @ORM\GeneratedValue(strategy="CUSTOM")
     * @ORM\CustomIdGenerator(class=UlidGenerator::class)
     */
    protected $id;

public function getId(): Ulid
    {
        return $this->id;
    }
}
```

If you don't want to use the generator, consider using the `__construct()` method:

```php
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Uid\Ulid;

/**
 * @ORM\Entity
 * @ORM\Table(name="posts")
 */
class Post
{
    /**
     * @var Symfony\Component\Uid\Ulid
     *
     * @ORM\Id
     * @ORM\Column(type="ulid", unique=true)
     */
    protected $id;

public function __construct() 
    {
        $this->id = new Ulid();
    }

public function getId(): Ulid
    {
        return $this->id;
    }
}
```

## Contributing

Contributions are welcome! Please read [CONTRIBUTING](.github/CONTRIBUTING.md) for details.