Download the PHP package brandoriented/uuid-doctrine without Composer
On this page you can find all versions of the php package brandoriented/uuid-doctrine. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download brandoriented/uuid-doctrine
More information about brandoriented/uuid-doctrine
Files in brandoriented/uuid-doctrine
Package uuid-doctrine
Short Description Allow the use of ramsey/uuid as a Doctrine field type.
License MIT
Homepage https://github.com/ramsey/uuid-doctrine
Informations about the package uuid-doctrine
ramsey/uuid-doctrine
The ramsey/uuid-doctrine package provides the ability to use ramsey/uuid as a Doctrine field type.
This project adheres to a Contributor Code of Conduct. By participating in this project and its community, you are expected to uphold this code.
Installation
The preferred method of installation is via Packagist and Composer. Run
the following command to install the package and add it as a requirement to
your project's composer.json
:
Examples
Configuration
To configure Doctrine to use ramsey/uuid as a field type, you'll need to set up the following in your bootstrap:
In Symfony:
In Zend Framework:
Usage
Then, in your models, you may annotate properties by setting the @Column
type to uuid
, and defining a custom generator of Ramsey\Uuid\UuidGenerator
.
Doctrine will handle the rest.
If you use the XML Mapping instead of PHP annotations.
You can also use the YAML Mapping.
Binary Database Columns
In the previous example, Doctrine will create a database column of type CHAR(36)
,
but you may also use this library to store UUIDs as binary strings. The
UuidBinaryType
helps accomplish this.
In your bootstrap, place the following:
In Symfony:
Then, when annotating model class properties, use uuid_binary
instead of uuid
:
@Column(type="uuid_binary")
InnoDB-optimised binary UUIDs
More suitable if you want to use UUIDs as primary key. Note that this can cause unintended effects if:
- decoding bytes that were not generated using this method
- another code (that isn't aware of this method) attempts to decode the resulting bytes
More information in this Percona article and UUID Talk by Ben Ramsey (starts at slide 58).
In Symfony:
Then, in your models, you may annotate properties by setting the @Column
type to uuid_binary_ordered_time
, and defining a custom generator of
Ramsey\Uuid\UuidOrderedTimeGenerator
. Doctrine will handle the rest.
If you use the XML Mapping instead of PHP annotations.
You can use this format in mysql cli with these two functions:
Test:
More Information
For more information on getting started with Doctrine, check out the "Getting Started with Doctrine" tutorial.
Contributing
Contributions are welcome! Please read CONTRIBUTING for details.
Copyright and License
The ramsey/uuid-doctrine library is copyright © Ben Ramsey and licensed for use under the MIT License (MIT). Please see LICENSE for more information.
All versions of uuid-doctrine with dependencies
doctrine/orm Version ^2
doctrine/dbal Version ^2.5 | ^3.0
ramsey/uuid Version ^4