public function TypedDataTest::testGetAndSet

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

File

drupal/core/modules/system/lib/Drupal/system/Tests/TypedData/TypedDataTest.php, line 70

Definition of Drupal\system\Tests\TypedData\TypedDataTest.

Class

TypedDataTest

Tests primitive data types.

Namespace

Code

public function testGetAndSet() {

  // Boolean type.
  $typed_data = $this
    ->createTypedData(array(
    'type' => 'boolean',
  ), TRUE);
  $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
    ->assertTrue(is_string($typed_data
    ->getString()), 'Boolean value was converted to string');
  $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(array(
    'type' => 'string',
  ), $value);
  $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
    ->assertTrue(is_string($typed_data
    ->getString()), 'String value was converted to string');
  $typed_data
    ->setValue(NULL);
  $this
    ->assertNull($typed_data
    ->getValue(), 'String wrapper is null-able.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue(array(
    'no string',
  ));
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 1, 'Validation detected invalid value.');

  // Integer type.
  $value = rand();
  $typed_data = $this
    ->createTypedData(array(
    'type' => 'integer',
  ), $value);
  $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
    ->assertTrue(is_string($typed_data
    ->getString()), 'Integer value was converted to string');
  $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(array(
    'type' => 'float',
  ), $value);
  $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
    ->assertTrue(is_string($typed_data
    ->getString()), 'Float value was converted to string');
  $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 type.
  $value = new DrupalDateTime();
  $typed_data = $this
    ->createTypedData(array(
    'type' => 'date',
  ), $value);
  $this
    ->assertTrue($typed_data
    ->getValue() === $value, 'Date 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()
    ->getTimestamp() === $new_value, 'Date value was changed and set by timestamp.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue('2000-01-01');
  $this
    ->assertTrue($typed_data
    ->getValue()
    ->format('Y-m-d') == '2000-01-01', 'Date value was changed and set by date string.');
  $this
    ->assertTrue(is_string($typed_data
    ->getString()), 'Date value was converted to string');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue(NULL);
  $this
    ->assertNull($typed_data
    ->getValue(), '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.');

  // Duration type.
  $value = new DateInterval('PT20S');
  $typed_data = $this
    ->createTypedData(array(
    'type' => 'duration',
  ), $value);
  $this
    ->assertTrue($typed_data
    ->getValue() === $value, 'Duration value was fetched.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue(10);
  $this
    ->assertTrue($typed_data
    ->getValue()->s == 10, 'Duration value was changed and set by time span in seconds.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue('P40D');
  $this
    ->assertTrue($typed_data
    ->getValue()->d == 40, 'Duration value was changed and set by duration string.');
  $this
    ->assertTrue(is_string($typed_data
    ->getString()), 'Duration value was converted to string');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);

  // Test getting the string and passing it back as value.
  $duration = $typed_data
    ->getString();
  $typed_data
    ->setValue($duration);
  $this
    ->assertEqual($typed_data
    ->getString(), $duration, 'Duration formatted as string can be used to set the duration value.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue(NULL);
  $this
    ->assertNull($typed_data
    ->getValue(), 'Duration 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.');

  // URI type.
  $uri = 'http://example.com/foo/';
  $typed_data = $this
    ->createTypedData(array(
    'type' => 'uri',
  ), $uri);
  $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
    ->assertTrue(is_string($typed_data
    ->getString()), 'URI value was converted to string');
  $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.');

  // Generate some files that will be used to test the binary data type.
  $files = array();
  for ($i = 0; $i < 3; $i++) {
    $path = "public://example_{$i}.png";
    file_unmanaged_copy(DRUPAL_ROOT . '/core/misc/druplicon.png', $path);
    $image = entity_create('file', array(
      'uri' => $path,
    ));
    $image
      ->save();
    $files[] = $image;
  }

  // Email type.
  $value = $this
    ->randomString();
  $typed_data = $this
    ->createTypedData(array(
    'type' => 'email',
  ), $value);
  $this
    ->assertIdentical($typed_data
    ->getValue(), $value, 'E-mail value was fetched.');
  $new_value = 'test@example.com';
  $typed_data
    ->setValue($new_value);
  $this
    ->assertIdentical($typed_data
    ->getValue(), $new_value, 'E-mail value was changed.');
  $this
    ->assertTrue(is_string($typed_data
    ->getString()), 'E-mail value was converted to string');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue(NULL);
  $this
    ->assertNull($typed_data
    ->getValue(), 'E-mail 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(array(
    'type' => 'binary',
  ), $files[0]->uri);
  $this
    ->assertTrue(is_resource($typed_data
    ->getValue()), 'Binary value was fetched.');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);

  // Try setting by URI.
  $typed_data
    ->setValue($files[1]->uri);
  $this
    ->assertEqual(is_resource($typed_data
    ->getValue()), fopen($files[1]->uri, 'r'), 'Binary value was changed.');
  $this
    ->assertTrue(is_string($typed_data
    ->getString()), 'Binary value was converted to string');
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);

  // Try setting by resource.
  $typed_data
    ->setValue(fopen($files[2]->uri, 'r'));
  $this
    ->assertEqual(is_resource($typed_data
    ->getValue()), fopen($files[2]->uri, 'r'), 'Binary value was changed.');
  $this
    ->assertTrue(is_string($typed_data
    ->getString()), 'Binary value was converted to string');
  $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 = array(
    'foo',
  );
  $typed_data = $this
    ->createTypedData(array(
    '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
    ->assertTrue(is_string($typed_data
    ->getString()), 'Any value was converted to string');
  $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(array(
    'entry',
  ));
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
  $typed_data
    ->setValue((object) array(
    'entry',
  ));
  $this
    ->assertEqual($typed_data
    ->validate()
    ->count(), 0);
}