class DataUriNormalizer
Normalizes an {Denormalizes a data URI to a { @author Kévin Dunglas <dunglas@gmail.com>
Hierarchy
- class \Symfony\Component\Serializer\Normalizer\DataUriNormalizer implements \Symfony\Component\Serializer\Normalizer\NormalizerInterface, \Symfony\Component\Serializer\Normalizer\DenormalizerInterface
Expanded class hierarchy of DataUriNormalizer
See also
\SplFileInfo} object to a data URI.
\SplFileObject} object.
File
-
vendor/
symfony/ serializer/ Normalizer/ DataUriNormalizer.php, line 26
Namespace
Symfony\Component\Serializer\NormalizerView source
final class DataUriNormalizer implements NormalizerInterface, DenormalizerInterface {
private const SUPPORTED_TYPES = [
\SplFileInfo::class => true,
\SplFileObject::class => true,
File::class => true,
];
private readonly ?MimeTypeGuesserInterface $mimeTypeGuesser;
public function __construct(?MimeTypeGuesserInterface $mimeTypeGuesser = null) {
if (!$mimeTypeGuesser && class_exists(MimeTypes::class)) {
$mimeTypeGuesser = MimeTypes::getDefault();
}
$this->mimeTypeGuesser = $mimeTypeGuesser;
}
public function getSupportedTypes(?string $format) : array {
return self::SUPPORTED_TYPES;
}
public function normalize(mixed $object, ?string $format = null, array $context = []) : string {
if (!$object instanceof \SplFileInfo) {
throw new InvalidArgumentException('The object must be an instance of "\\SplFileInfo".');
}
$mimeType = $this->getMimeType($object);
$splFileObject = $this->extractSplFileObject($object);
$data = '';
$splFileObject->rewind();
while (!$splFileObject->eof()) {
$data .= $splFileObject->fgets();
}
if ('text' === explode('/', $mimeType, 2)[0]) {
return \sprintf('data:%s,%s', $mimeType, rawurlencode($data));
}
return \sprintf('data:%s;base64,%s', $mimeType, base64_encode($data));
}
public function supportsNormalization(mixed $data, ?string $format = null, array $context = []) : bool {
return $data instanceof \SplFileInfo;
}
/**
* Regex adapted from Brian Grinstead code.
*
* @see https://gist.github.com/bgrins/6194623
*
* @throws InvalidArgumentException
* @throws NotNormalizableValueException
*/
public function denormalize(mixed $data, string $type, ?string $format = null, array $context = []) : \SplFileInfo {
if (null === $data || !preg_match('/^data:([a-z0-9][a-z0-9\\!\\#\\$\\&\\-\\^\\_\\+\\.]{0,126}\\/[a-z0-9][a-z0-9\\!\\#\\$\\&\\-\\^\\_\\+\\.]{0,126}(;[a-z0-9\\-]+\\=[a-z0-9\\-]+)?)?(;base64)?,[a-z0-9\\!\\$\\&\\\'\\,\\(\\)\\*\\+\\;\\=\\-\\.\\_\\~\\:\\@\\/\\?\\%\\s]*\\s*$/i', $data)) {
throw NotNormalizableValueException::createForUnexpectedDataType('The provided "data:" URI is not valid.', $data, [
'string',
], $context['deserialization_path'] ?? null, true);
}
try {
switch ($type) {
case File::class:
if (!class_exists(File::class)) {
throw new InvalidArgumentException(\sprintf('Cannot denormalize to a "%s" without the HttpFoundation component installed. Try running "composer require symfony/http-foundation".', File::class));
}
return new File($data, false);
case 'SplFileObject':
case 'SplFileInfo':
return new \SplFileObject($data);
}
} catch (\RuntimeException $exception) {
throw NotNormalizableValueException::createForUnexpectedDataType($exception->getMessage(), $data, [
'string',
], $context['deserialization_path'] ?? null, false, $exception->getCode(), $exception);
}
throw new InvalidArgumentException(\sprintf('The class parameter "%s" is not supported. It must be one of "SplFileInfo", "SplFileObject" or "Symfony\\Component\\HttpFoundation\\File\\File".', $type));
}
public function supportsDenormalization(mixed $data, string $type, ?string $format = null, array $context = []) : bool {
return isset(self::SUPPORTED_TYPES[$type]);
}
/**
* Gets the mime type of the object. Defaults to application/octet-stream.
*/
private function getMimeType(\SplFileInfo $object) : string {
if ($object instanceof File) {
return $object->getMimeType();
}
return $this->mimeTypeGuesser?->guessMimeType($object->getPathname()) ?: 'application/octet-stream';
}
/**
* Returns the \SplFileObject instance associated with the given \SplFileInfo instance.
*/
private function extractSplFileObject(\SplFileInfo $object) : \SplFileObject {
if ($object instanceof \SplFileObject) {
return $object;
}
return $object->openFile();
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
DataUriNormalizer::$mimeTypeGuesser | private | property | ||
DataUriNormalizer::denormalize | public | function | Regex adapted from Brian Grinstead code. | Overrides DenormalizerInterface::denormalize |
DataUriNormalizer::extractSplFileObject | private | function | Returns the \SplFileObject instance associated with the given \SplFileInfo instance. | |
DataUriNormalizer::getMimeType | private | function | Gets the mime type of the object. Defaults to application/octet-stream. | |
DataUriNormalizer::getSupportedTypes | public | function | Returns the types potentially supported by this normalizer. | Overrides NormalizerInterface::getSupportedTypes |
DataUriNormalizer::normalize | public | function | Normalizes data into a set of arrays/scalars. | Overrides NormalizerInterface::normalize |
DataUriNormalizer::SUPPORTED_TYPES | private | constant | ||
DataUriNormalizer::supportsDenormalization | public | function | Checks whether the given class is supported for denormalization by this normalizer. | Overrides DenormalizerInterface::supportsDenormalization |
DataUriNormalizer::supportsNormalization | public | function | Checks whether the given class is supported for normalization by this normalizer. | Overrides NormalizerInterface::supportsNormalization |
DataUriNormalizer::__construct | public | function | ||
DenormalizerInterface::COLLECT_DENORMALIZATION_ERRORS | public | constant |