CodeExplorer
You are a developer and looking for Shopware projects?
Apply Now!
encode example
$this->validateIfNeeded($field, $existence, $data, $parameters);
$value = $data->getValue() ?? $field->getDefault();
if ($value !== null && !empty($field->getPropertyMapping())) {
$value = $this->validateMapping($field, $value, $parameters);
}
if ($value !== null) {
$value = Json::encode($value);
}
yield $field->getStorageName() => $value;
}
public function decode(Field $field, mixed $value): mixed
{
if (!$field instanceof JsonField) {
throw DataAbstractionLayerException::invalidSerializerField(JsonField::class, $field);
}
$serializer = new TestFieldSerializer(
$validator,
$this->createMock(DefinitionInstanceRegistry::class)
);
static::assertSame(0, $serializer->getConstraintsCallCounter);
$entityExistence = new EntityExistence('test', ['id' => Uuid::randomHex()], true, false, false, []);
$field = new StringField('test', 'test');
$data = new KeyValuePair('foo', 'bar', true);
static::assertNotNull($serializer->encode($field, $entityExistence, $data, $this->createMock(WriteParameterBag::class))->current());
static::assertSame(1, $serializer->getConstraintsCallCounter);
static::assertNotNull($serializer->encode($field, $entityExistence, $data, $this->createMock(WriteParameterBag::class))->current());
static::assertSame(1, $serializer->getConstraintsCallCounter);
}
public function testCaching(): void
{
$validator = $this->createMock(ValidatorInterface::class);
$validator->method('validate')->willReturn(new ConstraintViolationList());
$serializer = new TestFieldSerializer(
$validator,
$this->createMock(DefinitionInstanceRegistry::class)
);
static::assertSame(0, $serializer->getConstraintsCallCounter);
$entityExistence = new EntityExistence('test', ['id' => Uuid::randomHex()], true, false, false, []);
$field = new StringField('test', 'test');
$data = new KeyValuePair('foo', 'bar', true);
static::assertNotNull($serializer->encode($field, $entityExistence, $data, $this->createMock(WriteParameterBag::class))->current());
static::assertSame(1, $serializer->getConstraintsCallCounter);
static::assertNotNull($serializer->encode($field, $entityExistence, $data, $this->createMock(WriteParameterBag::class))->current());
static::assertSame(1, $serializer->getConstraintsCallCounter);
}
public function testCaching(): void
{
$validator = $this->createMock(ValidatorInterface::class);
$validator->method('validate')->willReturn(new ConstraintViolationList());
$serializer = new TestFieldSerializer(
catch (GuzzleException) {
return null;
}
}
/** * @return array<string, mixed> */
private function getRequestOptions(SourcedPayloadInterface $payload, AppEntity $app, Context $context): array
{
$payload->setSource($this->buildSource($app));
$encoded = $this->encode($payload);
$jsonPayload = json_encode($encoded, \JSON_THROW_ON_ERROR);
if (!$jsonPayload) {
if ($payload instanceof PaymentPayloadInterface) {
throw PaymentException::asyncProcessInterrupted($payload->getOrderTransaction()->getId(), \sprintf('Empty payload, got: %s', var_export($jsonPayload, true)));
}
throw PaymentException::validatePreparedPaymentInterrupted(\sprintf('Empty payload, got: %s', var_export($jsonPayload, true)));
}
$secret = $app->getAppSecret();
return null;
}
}
/** * @return array<string, mixed> */
private function getRequestOptions(SourcedPayloadInterface $payload, AppEntity $app, Context $context): array
{
$payload->setSource($this->buildSource($app));
$encoded = $this->encode($payload);
$jsonPayload = json_encode($encoded, \JSON_THROW_ON_ERROR);
if (!$jsonPayload) {
if ($payload instanceof PaymentPayloadInterface) {
throw PaymentException::asyncProcessInterrupted($payload->getOrderTransaction()->getId(), \sprintf('Empty payload, got: %s', var_export($jsonPayload, true)));
}
throw PaymentException::validatePreparedPaymentInterrupted(\sprintf('Empty payload, got: %s', var_export($jsonPayload, true)));
}
$secret = $app->getAppSecret();
/**
* @param array<EncoderInterface> $encoders
*/
public function __construct(
private readonly array $encoders = []
) {
}
final public function encode(mixed $data, string $format, array $context = []): string
{
return $this->getEncoder($format, $context)->encode($data, $format, $context);
}
public function supportsEncoding(string $format, array $context = []): bool
{
try {
$this->getEncoder($format, $context);
} catch (RuntimeException) {
return false;
}
return true;
}
public function __construct(
private readonly array $encoders = []
) {
}
final public function encode(mixed $data, string $format, array $context = []): string
{
return $this->getEncoder($format, $context)->encode($data, $format, $context);
}
public function supportsEncoding(string $format, array $context = []): bool
{
try {
$this->getEncoder($format, $context);
} catch (RuntimeException) {
return false;
}
return true;
}
'core/drupal.ajax',
],
],
],
'no_close_modal' => [
'#title' => 'Hidden close button modal!',
'#type' => 'link',
'#url' => Url::fromRoute('dialog_renderer_test.modal_content'),
'#attributes' => [
'class' => ['use-ajax'],
'data-dialog-type' => 'modal',
'data-dialog-options' => Json::encode([
'dialogClass' => 'no-close',
]),
],
'#attached' => [
'library' => [
'core/drupal.ajax',
'dialog_renderer_test/dialog_test',
],
],
],
'button_pane_modal' => [
],
],
],
'no_close_modal' => [
'#title' => 'Hidden close button modal!',
'#type' => 'link',
'#url' => Url::fromRoute('dialog_renderer_test.modal_content'),
'#attributes' => [
'class' => ['use-ajax'],
'data-dialog-type' => 'modal',
'data-dialog-options' => Json::encode([
'dialogClass' => 'no-close',
]),
],
'#attached' => [
'library' => [
'core/drupal.ajax',
'dialog_renderer_test/dialog_test',
],
],
],
'button_pane_modal' => [
$match_limit = isset($selection_settings['match_limit']) ? (int) $selection_settings['match_limit'] : 10;
$entity_labels = $handler->getReferenceableEntities($string, $match_operator, $match_limit);
// Loop through the entities and convert them into autocomplete output. foreach ($entity_labels as $values) {
foreach ($values as $entity_id => $label) {
$key = "$label ($entity_id)";
// Strip things like starting/trailing white spaces, line breaks and // tags. $key = preg_replace('/\s\s+/', ' ', str_replace("\n", '', trim(Html::decodeEntities(strip_tags($key)))));
// Names containing commas or quotes must be wrapped in quotes. $key = Tags::encode($key);
$matches[] = ['value' => $key, 'label' => $label];
}
}
}
return $matches;
}
}
$entity_labels = $handler->getReferenceableEntities($string, $match_operator, $match_limit);
// Loop through the entities and convert them into autocomplete output. foreach ($entity_labels as $values) {
foreach ($values as $entity_id => $label) {
$key = "$label ($entity_id)";
// Strip things like starting/trailing white spaces, line breaks and // tags. $key = preg_replace('/\s\s+/', ' ', str_replace("\n", '', trim(Html::decodeEntities(strip_tags($key)))));
// Names containing commas or quotes must be wrapped in quotes. $key = Tags::encode($key);
$matches[] = ['value' => $key, 'label' => $label];
}
}
}
return $matches;
}
}
// Check the actual file data.
$this->assertSame($this->testFileData, file_get_contents('public://foobar/example_0.txt'));
$this->assertTrue($this->fileStorage->loadUnchanged(1)->isTemporary());
// Verify that we can create an entity that references the uploaded file. $entity_test_post_url = Url::fromRoute('rest.entity.entity_test.POST')
->setOption('query', ['_format' => static::$format]);
$request_options = [];
$request_options[RequestOptions::HEADERS]['Content-Type'] = static::$mimeType;
$request_options = NestedArray::mergeDeep($request_options, $this->getAuthenticationRequestOptions('POST'));
$request_options[RequestOptions::BODY] = $this->serializer->encode($this->getNormalizedPostEntity(), static::$format);
$response = $this->request('POST', $entity_test_post_url, $request_options);
$this->assertResourceResponse(201, FALSE, $response);
$this->assertTrue($this->fileStorage->loadUnchanged(1)->isPermanent());
$this->assertSame([
[
'target_id' => '1',
'display' => NULL,
'description' => "The most fascinating file ever!",
],
], EntityTest::load(2)->get('field_rest_file_test')->getValue());
}
$this->assertTrue($this->fileStorage->loadUnchanged(1)->isTemporary());
// Verify that we can create an entity that references the uploaded file. $entity_test_post_url = Url::fromRoute('rest.entity.entity_test.POST')
->setOption('query', ['_format' => static::$format]);
$request_options = [];
$request_options[RequestOptions::HEADERS]['Content-Type'] = static::$mimeType;
$request_options = NestedArray::mergeDeep($request_options, $this->getAuthenticationRequestOptions('POST'));
$request_options[RequestOptions::BODY] = $this->serializer->encode($this->getNormalizedPostEntity(), static::$format);
$response = $this->request('POST', $entity_test_post_url, $request_options);
$this->assertResourceResponse(201, FALSE, $response);
$this->assertTrue($this->fileStorage->loadUnchanged(1)->isPermanent());
$this->assertSame([
[
'target_id' => '1',
'display' => NULL,
'description' => "The most fascinating file ever!",
],
], EntityTest::load(2)->get('field_rest_file_test')->getValue());
}
$this->serializer = new VariantListingConfigFieldSerializer($definitionRegistry, $validator);
}
public function testSingleMainVariant(): void
{
$data = [
'displayParent' => 1,
'mainVariantId' => Uuid::randomHex(),
'configuratorGroupConfig' => [],
];
$result = $this->encode($data);
static::assertArrayHasKey('variant_listing_config', $result);
$result = json_decode($result['variant_listing_config'], true, 512, \JSON_THROW_ON_ERROR);
static::assertSame($data['displayParent'], $result['displayParent']);
static::assertSame($data['mainVariantId'], $result['mainVariantId']);
static::assertSame($data['configuratorGroupConfig'], $result['configuratorGroupConfig']);
}
public function testExpandedList(): void
{
$data = [
}
public function testSingleMainVariant(): void
{
$data = [
'displayParent' => 1,
'mainVariantId' => Uuid::randomHex(),
'configuratorGroupConfig' => [],
];
$result = $this->encode($data);
static::assertArrayHasKey('variant_listing_config', $result);
$result = json_decode($result['variant_listing_config'], true, 512, \JSON_THROW_ON_ERROR);
static::assertSame($data['displayParent'], $result['displayParent']);
static::assertSame($data['mainVariantId'], $result['mainVariantId']);
static::assertSame($data['configuratorGroupConfig'], $result['configuratorGroupConfig']);
}
public function testExpandedList(): void
{
$data = [
/**
* @var \Drupal\Component\Serialization\SerializationInterface
*/
protected static $mock;
public static function setMock($mock) {
static::$mock = $mock;
}
public static function encode($data) {
return static::$mock->encode($data);
}
public static function decode($raw) {
return static::$mock->decode($raw);
}
public static function getFileExtension() {
return static::$mock->getFileExtension();
}
}
protected static $mock;
public static function setMock($mock) {
static::$mock = $mock;
}
public static function encode($data) {
return static::$mock->encode($data);
}
public static function decode($raw) {
return static::$mock->decode($raw);
}
public static function getFileExtension() {
return static::$mock->getFileExtension();
}
}
$list[$name] = $data;
}
}
return $list;
}
/** * {@inheritdoc} */
public function write($name, array $data) {
try {
$encoded_data = $this->encode($data);
}
catch (InvalidDataTypeException $e) {
throw new StorageException("Invalid data type in config $name: {$e->getMessage()}");
}
$target = $this->getFilePath($name);
$status = @file_put_contents($target, $encoded_data);
if ($status === FALSE) {
// Try to make sure the directory exists and try writing again. $this->ensureStorage();
$status = @file_put_contents($target, $encoded_data);
}
}
}
return $list;
}
/** * {@inheritdoc} */
public function write($name, array $data) {
try {
$encoded_data = $this->encode($data);
}
catch (InvalidDataTypeException $e) {
throw new StorageException("Invalid data type in config $name: {$e->getMessage()}");
}
$target = $this->getFilePath($name);
$status = @file_put_contents($target, $encoded_data);
if ($status === FALSE) {
// Try to make sure the directory exists and try writing again. $this->ensureStorage();
$status = @file_put_contents($target, $encoded_data);
}
$sequences = $value['sequences'];
$value['sequences'] = array_map(fn ($item) => array_merge([
'parentId' => null,
'ruleId' => null,
'position' => 1,
'displayGroup' => 1,
'trueCase' => 0,
], $item), $sequences);
yield $field->getStorageName() => Json::encode($value);
}
protected function getConstraints(Field $field): array
{
return [
new Collection([
'allowExtraFields' => true,
'allowMissingFields' => false,
'fields' => [
'eventName' => [new NotBlank(), new Type('string')],
'description' => [new Type('string')],
$value['sequences'] = array_map(fn ($item) => array_merge([
'parentId' => null,
'ruleId' => null,
'position' => 1,
'displayGroup' => 1,
'trueCase' => 0,
], $item), $sequences);
yield $field->getStorageName() => Json::encode($value);
}
protected function getConstraints(Field $field): array
{
return [
new Collection([
'allowExtraFields' => true,
'allowMissingFields' => false,
'fields' => [
'eventName' => [new NotBlank(), new Type('string')],
'description' => [new Type('string')],
// Asserts the expected JSON:API normalization.
// @todo Remove line below in favor of commented line in https://www.drupal.org/project/drupal/issues/2878463.
$url = Url::fromRoute('jsonapi.entity_test--entity_test.individual', ['entity' => $this->entity->uuid()]);
// $url = $this->entity->toUrl('jsonapi'); $client = $this->getSession()->getDriver()->getClient()->getClient();
$response = $client->request('GET', $url->setAbsolute(TRUE)->toString());
$document = Json::decode((string) $response->getBody());
$this->assertSame($expected_value_jsonapi_normalization, $document['data']['attributes']['field_test']);
// Asserts the expected JSON:API denormalization. $request_options = [];
$request_options[RequestOptions::BODY] = Json::encode([
'data' => [
'type' => 'entity_test--entity_test',
'attributes' => [
'field_test' => static::VALUE_OVERRIDDEN,
],
],
]);
$request_options[RequestOptions::HEADERS]['Content-Type'] = 'application/vnd.api+json';
$response = $client->request('POST', Url::fromRoute('jsonapi.entity_test--entity_test.collection.post')->setAbsolute(TRUE)->toString(), $request_options);
$document = Json::decode((string) $response->getBody());
$this->assertSame(static::VALUE_OVERRIDDEN, $document['data']['attributes']['field_test']);
// $url = $this->entity->toUrl('jsonapi'); $client = $this->getSession()->getDriver()->getClient()->getClient();
$response = $client->request('GET', $url->setAbsolute(TRUE)->toString());
$document = Json::decode((string) $response->getBody());
$this->assertSame($expected_value_jsonapi_normalization, $document['data']['attributes']['field_test']);
// Asserts the expected JSON:API denormalization. $request_options = [];
$request_options[RequestOptions::BODY] = Json::encode([
'data' => [
'type' => 'entity_test--entity_test',
'attributes' => [
'field_test' => static::VALUE_OVERRIDDEN,
],
],
]);
$request_options[RequestOptions::HEADERS]['Content-Type'] = 'application/vnd.api+json';
$response = $client->request('POST', Url::fromRoute('jsonapi.entity_test--entity_test.collection.post')->setAbsolute(TRUE)->toString(), $request_options);
$document = Json::decode((string) $response->getBody());
$this->assertSame(static::VALUE_OVERRIDDEN, $document['data']['attributes']['field_test']);
use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;
use Symfony\Component\Messenger\Transport\Serialization\PhpSerializer;
class PhpSerializerTest extends TestCase
{
public function testEncodedIsDecodable()
{
$serializer = $this->createPhpSerializer();
$envelope = new Envelope(new DummyMessage('Hello'));
$encoded = $serializer->encode($envelope);
$this->assertStringNotContainsString("\0", $encoded['body'], 'Does not contain the binary characters');
$this->assertEquals($envelope, $serializer->decode($encoded));
}
public function testDecodingFailsWithMissingBodyKey()
{
$this->expectException(MessageDecodingFailedException::class);
$this->expectExceptionMessage('Encoded envelope should have at least a "body", or maybe you should implement your own serializer');
$serializer = $this->createPhpSerializer();
use Symfony\Component\Messenger\Transport\Serialization\PhpSerializer;
class PhpSerializerTest extends TestCase
{
public function testEncodedIsDecodable()
{
$serializer = $this->createPhpSerializer();
$envelope = new Envelope(new DummyMessage('Hello'));
$encoded = $serializer->encode($envelope);
$this->assertStringNotContainsString("\0", $encoded['body'], 'Does not contain the binary characters');
$this->assertEquals($envelope, $serializer->decode($encoded));
}
public function testDecodingFailsWithMissingBodyKey()
{
$this->expectException(MessageDecodingFailedException::class);
$this->expectExceptionMessage('Encoded envelope should have at least a "body", or maybe you should implement your own serializer');
$serializer = $this->createPhpSerializer();
'data-drupal-announce-trigger' => '',
'class' => [
'toolbar-icon',
'toolbar-item',
'toolbar-icon-announce',
'use-ajax',
'announce-canvas-link',
'announce-default',
],
'data-dialog-renderer' => 'off_canvas',
'data-dialog-type' => 'dialog',
'data-dialog-options' => Json::encode(
[
'announce' => TRUE,
'width' => '25%',
'classes' => [
'ui-dialog' => 'announce-dialog',
'ui-dialog-titlebar' => 'announce-titlebar',
'ui-dialog-title' => 'announce-title',
'ui-dialog-titlebar-close' => 'announce-close',
'ui-dialog-content' => 'announce-body',
],
]),
],
'class' => [
'toolbar-icon',
'toolbar-item',
'toolbar-icon-announce',
'use-ajax',
'announce-canvas-link',
'announce-default',
],
'data-dialog-renderer' => 'off_canvas',
'data-dialog-type' => 'dialog',
'data-dialog-options' => Json::encode(
[
'announce' => TRUE,
'width' => '25%',
'classes' => [
'ui-dialog' => 'announce-dialog',
'ui-dialog-titlebar' => 'announce-titlebar',
'ui-dialog-title' => 'announce-title',
'ui-dialog-titlebar-close' => 'announce-close',
'ui-dialog-content' => 'announce-body',
],
]),
],
$this->parameters = new WriteParameterBag(
$definition,
WriteContext::createFromContext(Context::createDefaultContext()),
'',
new WriteCommandQueue()
);
}
public static function encodeProvider(): array
{
return [
[new JsonField('data', 'data'), ['foo' => 'bar'], Json::encode(['foo' => 'bar'])],
[new JsonField('data', 'data'), ['foo' => 1], Json::encode(['foo' => 1])],
[new JsonField('data', 'data'), ['foo' => 5.3], Json::encode(['foo' => 5.3])],
[new JsonField('data', 'data'), ['foo' => ['bar' => 'baz']], Json::encode(['foo' => ['bar' => 'baz']])],
[new JsonField('data', 'data'), null, null],
[new JsonField('data', 'data', [], []), null, Json::encode([])],
[new JsonField('data', 'data', [], ['foo' => 'bar']), null, Json::encode(['foo' => 'bar'])],
[new JsonField('data', 'data', [], ['foo' => 1]), null, Json::encode(['foo' => 1])],
[new JsonField('data', 'data', [], ['foo' => 5.3]), null, Json::encode(['foo' => 5.3])],
[new JsonField('data', 'data', [], ['foo' => ['bar' => 'baz']]), null, Json::encode(['foo' => ['bar' => 'baz']])],
];
$definition,
WriteContext::createFromContext(Context::createDefaultContext()),
'',
new WriteCommandQueue()
);
}
public static function encodeProvider(): array
{
return [
[new JsonField('data', 'data'), ['foo' => 'bar'], Json::encode(['foo' => 'bar'])],
[new JsonField('data', 'data'), ['foo' => 1], Json::encode(['foo' => 1])],
[new JsonField('data', 'data'), ['foo' => 5.3], Json::encode(['foo' => 5.3])],
[new JsonField('data', 'data'), ['foo' => ['bar' => 'baz']], Json::encode(['foo' => ['bar' => 'baz']])],
[new JsonField('data', 'data'), null, null],
[new JsonField('data', 'data', [], []), null, Json::encode([])],
[new JsonField('data', 'data', [], ['foo' => 'bar']), null, Json::encode(['foo' => 'bar'])],
[new JsonField('data', 'data', [], ['foo' => 1]), null, Json::encode(['foo' => 1])],
[new JsonField('data', 'data', [], ['foo' => 5.3]), null, Json::encode(['foo' => 5.3])],
[new JsonField('data', 'data', [], ['foo' => ['bar' => 'baz']]), null, Json::encode(['foo' => ['bar' => 'baz']])],
];