public function TypedDataTest::testGetAndSet in Drupal 8

Same name and namespace in other branches

1. 9 core/tests/Drupal/KernelTests/Core/TypedData/TypedDataTest.php \Drupal\KernelTests\Core\TypedData\TypedDataTest::testGetAndSet()
2. 10 core/tests/Drupal/KernelTests/Core/TypedData/TypedDataTest.php \Drupal\KernelTests\Core\TypedData\TypedDataTest::testGetAndSet()

Tests the basics around constructing and working with typed data objects.

File

core/tests/Drupal/KernelTests/Core/TypedData/TypedDataTest.php, line 67

Class

TypedDataTest

Tests the functionality of all core data types.

Namespace

Drupal\KernelTests\Core\TypedData

Code

public function testGetAndSet() {

  // Boolean type.
  $typed_data = $this
    ->createTypedData([
    'type' => 'boolean',
  ], TRUE);
  $this
    ->assertInstanceOf(BooleanInterface::class, $typed_data);
  $this
    ->assertTrue($typed_data
    ->getValue() === TRUE, 'Boolean value was fetched.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue(FALSE);
  $this
    ->assertTrue($typed_data
    ->getValue() === FALSE, 'Boolean value was changed.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $this
    ->assertIsString($typed_data
    ->getString());
  $typed_data
    ->setValue(NULL);
  $this
    ->assertNull($typed_data
    ->getValue(), 'Boolean wrapper is null-able.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue('invalid');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 1, 'Validation detected invalid value.');

  // String type.
  $value = $this
    ->randomString();
  $typed_data = $this
    ->createTypedData([
    'type' => 'string',
  ], $value);
  $this
    ->assertInstanceOf(StringInterface::class, $typed_data);
  $this
    ->assertTrue($typed_data
    ->getValue() === $value, 'String value was fetched.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $new_value = $this
    ->randomString();
  $typed_data
    ->setValue($new_value);
  $this
    ->assertTrue($typed_data
    ->getValue() === $new_value, 'String value was changed.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);

  // Funky test.
  $this
    ->assertIsString($typed_data
    ->getString());
  $typed_data
    ->setValue(NULL);
  $this
    ->assertNull($typed_data
    ->getValue(), 'String wrapper is null-able.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue([
    'no string',
  ]);
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 1, 'Validation detected invalid value.');

  // Integer type.
  $value = rand();
  $typed_data = $this
    ->createTypedData([
    'type' => 'integer',
  ], $value);
  $this
    ->assertInstanceOf(IntegerInterface::class, $typed_data);
  $this
    ->assertTrue($typed_data
    ->getValue() === $value, 'Integer value was fetched.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $new_value = rand();
  $typed_data
    ->setValue($new_value);
  $this
    ->assertTrue($typed_data
    ->getValue() === $new_value, 'Integer value was changed.');
  $this
    ->assertIsString($typed_data
    ->getString());
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue(NULL);
  $this
    ->assertNull($typed_data
    ->getValue(), 'Integer wrapper is null-able.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue('invalid');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 1, 'Validation detected invalid value.');

  // Float type.
  $value = 123.45;
  $typed_data = $this
    ->createTypedData([
    'type' => 'float',
  ], $value);
  $this
    ->assertInstanceOf(FloatInterface::class, $typed_data);
  $this
    ->assertTrue($typed_data
    ->getValue() === $value, 'Float value was fetched.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $new_value = 678.9;
  $typed_data
    ->setValue($new_value);
  $this
    ->assertTrue($typed_data
    ->getValue() === $new_value, 'Float value was changed.');
  $this
    ->assertIsString($typed_data
    ->getString());
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue(NULL);
  $this
    ->assertNull($typed_data
    ->getValue(), 'Float wrapper is null-able.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue('invalid');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 1, 'Validation detected invalid value.');

  // Date Time type; values with timezone offset.
  $value = '2014-01-01T20:00:00+00:00';
  $typed_data = $this
    ->createTypedData([
    'type' => 'datetime_iso8601',
  ], $value);
  $this
    ->assertInstanceOf(DateTimeInterface::class, $typed_data);
  $this
    ->assertTrue($typed_data
    ->getValue() == $value, 'Date value was fetched.');
  $this
    ->assertEqual($typed_data
    ->getValue(), $typed_data
    ->getDateTime()
    ->format('c'), 'Value representation of a date is ISO 8601');
  $this
    ->assertSame('+00:00', $typed_data
    ->getDateTime()
    ->getTimezone()
    ->getName());
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $new_value = '2014-01-02T20:00:00+00:00';
  $typed_data
    ->setValue($new_value);
  $this
    ->assertTrue($typed_data
    ->getDateTime()
    ->format('c') === $new_value, 'Date value was changed and set by an ISO8601 date.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $this
    ->assertTrue($typed_data
    ->getDateTime()
    ->format('Y-m-d') == '2014-01-02', 'Date value was changed and set by date string.');
  $this
    ->assertSame('+00:00', $typed_data
    ->getDateTime()
    ->getTimezone()
    ->getName());
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue(NULL);
  $this
    ->assertNull($typed_data
    ->getDateTime(), 'Date wrapper is null-able.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue('invalid');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 1, 'Validation detected invalid value.');

  // Check implementation of DateTimeInterface.
  $typed_data = $this
    ->createTypedData([
    'type' => 'datetime_iso8601',
  ], '2014-01-01T20:00:00+00:00');
  $this
    ->assertInstanceOf(DrupalDateTime::class, $typed_data
    ->getDateTime());
  $this
    ->assertSame('+00:00', $typed_data
    ->getDateTime()
    ->getTimezone()
    ->getName());
  $typed_data
    ->setDateTime(new DrupalDateTime('2014-01-02T20:00:00+00:00'));
  $this
    ->assertSame('+00:00', $typed_data
    ->getDateTime()
    ->getTimezone()
    ->getName());
  $this
    ->assertEqual($typed_data
    ->getValue(), '2014-01-02T20:00:00+00:00');
  $typed_data
    ->setValue(NULL);
  $this
    ->assertNull($typed_data
    ->getDateTime());

  // Date Time type; values without timezone offset.
  $value = '2014-01-01T20:00';
  $typed_data = $this
    ->createTypedData([
    'type' => 'datetime_iso8601',
  ], $value);
  $this
    ->assertInstanceOf(DateTimeInterface::class, $typed_data);
  $this
    ->assertTrue($typed_data
    ->getValue() == $value, 'Date value was fetched.');

  // @todo Uncomment this assertion in https://www.drupal.org/project/drupal/issues/2716891.
  // $this->assertEqual($typed_data->getValue(), $typed_data->getDateTime()->format('c'), 'Value representation of a date is ISO 8601');
  $this
    ->assertSame('UTC', $typed_data
    ->getDateTime()
    ->getTimezone()
    ->getName());
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $new_value = '2014-01-02T20:00';
  $typed_data
    ->setValue($new_value);

  // @todo Uncomment this assertion in https://www.drupal.org/project/drupal/issues/2716891.
  // $this->assertTrue($typed_data->getDateTime()->format('c') === $new_value, 'Date value was changed and set by an ISO8601 date.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $this
    ->assertTrue($typed_data
    ->getDateTime()
    ->format('Y-m-d') == '2014-01-02', 'Date value was changed and set by date string.');
  $this
    ->assertSame('UTC', $typed_data
    ->getDateTime()
    ->getTimezone()
    ->getName());
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue(NULL);
  $this
    ->assertNull($typed_data
    ->getDateTime(), 'Date wrapper is null-able.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue('invalid');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 1, 'Validation detected invalid value.');

  // Check implementation of DateTimeInterface.
  $typed_data = $this
    ->createTypedData([
    'type' => 'datetime_iso8601',
  ], '2014-01-01T20:00:00');
  $this
    ->assertInstanceOf(DrupalDateTime::class, $typed_data
    ->getDateTime());
  $this
    ->assertSame('UTC', $typed_data
    ->getDateTime()
    ->getTimezone()
    ->getName());

  // When setting datetime without a timezone offset, the default timezone is
  // used (Australia/Sydney). DateTimeIso8601::setDateTime() converts this
  // DrupalDateTime object to a string using ::format('c'), it gets converted
  // to an offset. The offset for Australia/Sydney is +11:00.
  $typed_data
    ->setDateTime(new DrupalDateTime('2014-01-02T20:00:00'));
  $this
    ->assertSame('+11:00', $typed_data
    ->getDateTime()
    ->getTimezone()
    ->getName());
  $this
    ->assertEqual($typed_data
    ->getValue(), '2014-01-02T20:00:00+11:00');
  $typed_data
    ->setValue(NULL);
  $this
    ->assertNull($typed_data
    ->getDateTime());

  // Timestamp type.
  $value = REQUEST_TIME;
  $typed_data = $this
    ->createTypedData([
    'type' => 'timestamp',
  ], $value);
  $this
    ->assertInstanceOf(DateTimeInterface::class, $typed_data);
  $this
    ->assertTrue($typed_data
    ->getValue() == $value, 'Timestamp value was fetched.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $new_value = REQUEST_TIME + 1;
  $typed_data
    ->setValue($new_value);
  $this
    ->assertTrue($typed_data
    ->getValue() === $new_value, 'Timestamp value was changed and set.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue(NULL);
  $this
    ->assertNull($typed_data
    ->getDateTime(), 'Timestamp wrapper is null-able.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue('invalid');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 1, 'Validation detected invalid value.');

  // Check implementation of DateTimeInterface.
  $typed_data = $this
    ->createTypedData([
    'type' => 'timestamp',
  ], REQUEST_TIME);
  $this
    ->assertInstanceOf(DrupalDateTime::class, $typed_data
    ->getDateTime());
  $typed_data
    ->setDateTime(DrupalDateTime::createFromTimestamp(REQUEST_TIME + 1));
  $this
    ->assertEqual($typed_data
    ->getValue(), REQUEST_TIME + 1);
  $typed_data
    ->setValue(NULL);
  $this
    ->assertNull($typed_data
    ->getDateTime());

  // DurationIso8601 type.
  $value = 'PT20S';
  $typed_data = $this
    ->createTypedData([
    'type' => 'duration_iso8601',
  ], $value);
  $this
    ->assertInstanceOf(DurationInterface::class, $typed_data);
  $this
    ->assertIdentical($typed_data
    ->getValue(), $value, 'DurationIso8601 value was fetched.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue('P40D');
  $this
    ->assertEqual($typed_data
    ->getDuration()->d, 40, 'DurationIso8601 value was changed and set by duration string.');
  $this
    ->assertIsString($typed_data
    ->getString());
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue(NULL);
  $this
    ->assertNull($typed_data
    ->getValue(), 'DurationIso8601 wrapper is null-able.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue('invalid');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 1, 'Validation detected invalid value.');

  // Check implementation of DurationInterface.
  $typed_data = $this
    ->createTypedData([
    'type' => 'duration_iso8601',
  ], 'PT20S');
  $this
    ->assertInstanceOf(\DateInterval::class, $typed_data
    ->getDuration());
  $typed_data
    ->setDuration(new \DateInterval('P40D'));

  // @todo: Should we make this "nicer"?
  $this
    ->assertEqual($typed_data
    ->getValue(), 'P0Y0M40DT0H0M0S');
  $typed_data
    ->setValue(NULL);
  $this
    ->assertNull($typed_data
    ->getDuration());

  // Time span type.
  $value = 20;
  $typed_data = $this
    ->createTypedData([
    'type' => 'timespan',
  ], $value);
  $this
    ->assertInstanceOf(DurationInterface::class, $typed_data);
  $this
    ->assertIdentical($typed_data
    ->getValue(), $value, 'Time span value was fetched.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue(60 * 60 * 4);
  $this
    ->assertEqual($typed_data
    ->getDuration()->s, 14400, 'Time span was changed');
  $this
    ->assertIsString($typed_data
    ->getString());
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue(NULL);
  $this
    ->assertNull($typed_data
    ->getValue(), 'Time span wrapper is null-able.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue('invalid');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 1, 'Validation detected invalid value.');

  // Check implementation of DurationInterface.
  $typed_data = $this
    ->createTypedData([
    'type' => 'timespan',
  ], 20);
  $this
    ->assertInstanceOf(\DateInterval::class, $typed_data
    ->getDuration());
  $typed_data
    ->setDuration(new \DateInterval('PT4H'));
  $this
    ->assertEqual($typed_data
    ->getValue(), 60 * 60 * 4);
  $typed_data
    ->setValue(NULL);
  $this
    ->assertNull($typed_data
    ->getDuration());

  // URI type.
  $uri = 'http://example.com/foo/';
  $typed_data = $this
    ->createTypedData([
    'type' => 'uri',
  ], $uri);
  $this
    ->assertInstanceOf(UriInterface::class, $typed_data);
  $this
    ->assertTrue($typed_data
    ->getValue() === $uri, 'URI value was fetched.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue($uri . 'bar.txt');
  $this
    ->assertTrue($typed_data
    ->getValue() === $uri . 'bar.txt', 'URI value was changed.');
  $this
    ->assertIsString($typed_data
    ->getString());
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue(NULL);
  $this
    ->assertNull($typed_data
    ->getValue(), 'URI wrapper is null-able.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue('invalid');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 1, 'Validation detected invalid value.');
  $typed_data
    ->setValue('public://field/image/Photo on 4-28-14 at 12.01 PM.jpg');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0, 'Filename with spaces is valid.');

  // Generate some files that will be used to test the binary data type.
  $files = [];
  for ($i = 0; $i < 3; $i++) {
    $path = "public://example_{$i}.png";
    \Drupal::service('file_system')
      ->copy($this->root . '/core/misc/druplicon.png', $path);
    $image = File::create([
      'uri' => $path,
    ]);
    $image
      ->save();
    $files[] = $image;
  }

  // Email type.
  $value = $this
    ->randomString();
  $typed_data = $this
    ->createTypedData([
    'type' => 'email',
  ], $value);
  $this
    ->assertInstanceOf(StringInterface::class, $typed_data);
  $this
    ->assertIdentical($typed_data
    ->getValue(), $value, 'Email value was fetched.');
  $new_value = 'test@example.com';
  $typed_data
    ->setValue($new_value);
  $this
    ->assertIdentical($typed_data
    ->getValue(), $new_value, 'Email value was changed.');
  $this
    ->assertIsString($typed_data
    ->getString());
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue(NULL);
  $this
    ->assertNull($typed_data
    ->getValue(), 'Email wrapper is null-able.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue('invalidATexample.com');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 1, 'Validation detected invalid value.');

  // Binary type.
  $typed_data = $this
    ->createTypedData([
    'type' => 'binary',
  ], $files[0]
    ->getFileUri());
  $this
    ->assertInstanceOf(BinaryInterface::class, $typed_data);
  $this
    ->assertIsResource($typed_data
    ->getValue());
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);

  // Try setting by URI.
  $typed_data
    ->setValue($files[1]
    ->getFileUri());
  $this
    ->assertEqual(fgets($typed_data
    ->getValue()), fgets(fopen($files[1]
    ->getFileUri(), 'r')), 'Binary value was changed.');
  $this
    ->assertIsString($typed_data
    ->getString());
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);

  // Try setting by resource.
  $typed_data
    ->setValue(fopen($files[2]
    ->getFileUri(), 'r'));
  $this
    ->assertEqual(fgets($typed_data
    ->getValue()), fgets(fopen($files[2]
    ->getFileUri(), 'r')), 'Binary value was changed.');
  $this
    ->assertIsString($typed_data
    ->getString());
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue(NULL);
  $this
    ->assertNull($typed_data
    ->getValue(), 'Binary wrapper is null-able.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue('invalid');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 1, 'Validation detected invalid value.');

  // Any type.
  $value = [
    'foo',
  ];
  $typed_data = $this
    ->createTypedData([
    'type' => 'any',
  ], $value);
  $this
    ->assertIdentical($typed_data
    ->getValue(), $value, 'Any value was fetched.');
  $new_value = 'test@example.com';
  $typed_data
    ->setValue($new_value);
  $this
    ->assertIdentical($typed_data
    ->getValue(), $new_value, 'Any value was changed.');
  $this
    ->assertIsString($typed_data
    ->getString());
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue(NULL);
  $this
    ->assertNull($typed_data
    ->getValue(), 'Any wrapper is null-able.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);

  // We cannot test invalid values as everything is valid for the any type,
  // but make sure an array or object value passes validation also.
  $typed_data
    ->setValue([
    'entry',
  ]);
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue((object) [
    'entry',
  ]);
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
}