vendor/ramsey/uuid-doctrine/src/UuidType.php line 58

Open in your IDE?
  1. <?php
  3. /**
  4.  * This file is part of the ramsey/uuid-doctrine library
  5.  *
  6.  * For the full copyright and license information, please view the LICENSE
  7.  * file that was distributed with this source code.
  8.  *
  9.  * @copyright Copyright (c) Ben Ramsey <http://benramsey.com>
  10.  * @license http://opensource.org/licenses/MIT MIT
  11.  */
  13. namespace Ramsey\Uuid\Doctrine;
  15. use InvalidArgumentException;
  16. use Ramsey\Uuid\Uuid;
  17. use Ramsey\Uuid\UuidInterface;
  18. use Doctrine\DBAL\Types\ConversionException;
  19. use Doctrine\DBAL\Types\GuidType;
  20. use Doctrine\DBAL\Platforms\AbstractPlatform;
  22. /**
  23.  * Field type mapping for the Doctrine Database Abstraction Layer (DBAL).
  24.  *
  25.  * UUID fields will be stored as a string in the database and converted back to
  26.  * the Uuid value object when querying.
  27.  */
  28. class UuidType extends GuidType
  29. {
  30.     /**
  31.      * @var string
  32.      */
  33.     const NAME = 'uuid';
  35.     /**
  36.      * {@inheritdoc}
  37.      *
  38.      * @param string|UuidInterface|null $value
  39.      * @param AbstractPlatform $platform
  40.      *
  41.      * @return UuidInterface|null
  42.      *
  43.      * @throws ConversionException
  44.      */
  45.     public function convertToPHPValue($value, AbstractPlatform $platform)
  46.     {
  47.         if ($value === null || $value === '') {
  48.             return null;
  49.         }
  51.         if ($value instanceof UuidInterface) {
  52.             return $value;
  53.         }
  55.         try {
  56.             $uuid = Uuid::fromString($value);
  57.         } catch (InvalidArgumentException $e) {
  58.             throw ConversionException::conversionFailed($value, static::NAME);
  59.         }
  61.         return $uuid;
  62.     }
  64.     /**
  65.      * {@inheritdoc}
  66.      *
  67.      * @param UuidInterface|string|null $value
  68.      * @param AbstractPlatform $platform
  69.      *
  70.      * @return string|null
  71.      *
  72.      * @throws ConversionException
  73.      */
  74.     public function convertToDatabaseValue($value, AbstractPlatform $platform)
  75.     {
  76.         if ($value === null || $value === '') {
  77.             return null;
  78.         }
  80.         if (
  81.             $value instanceof UuidInterface
  82.             || (
  83.                 (is_string($value)
  84.                 || (is_object($value) && method_exists($value, '__toString')))
  85.                 && Uuid::isValid((string) $value)
  86.             )
  87.         ) {
  88.             return (string) $value;
  89.         }
  91.         throw ConversionException::conversionFailed($value, static::NAME);
  92.     }
  94.     /**
  95.      * {@inheritdoc}
  96.      *
  97.      * @return string
  98.      */
  99.     public function getName()
  100.     {
  101.         return static::NAME;
  102.     }
  104.     /**
  105.      * {@inheritdoc}
  106.      *
  107.      * @param AbstractPlatform $platform
  108.      *
  109.      * @return bool
  110.      */
  111.     public function requiresSQLCommentHint(AbstractPlatform $platform)
  112.     {
  113.         return true;
  114.     }
  116.     /**
  117.      * @param AbstractPlatform $platform
  118.      *
  119.      * @return array
  120.      */
  121.     public function getMappedDatabaseTypes(AbstractPlatform $platform)
  122.     {
  123.         return [self::NAME];
  124.     }
  125. }