class FieldTest in Token 8

Tests field tokens.

@group token

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\Tests\token\Kernel\KernelTestBase uses TokenTestTrait
  - class \Drupal\Tests\token\Kernel\FieldTest uses TaxonomyTestTrait

Expanded class hierarchy of FieldTest

File

tests/src/Kernel/FieldTest.php, line 27

Namespace

Drupal\Tests\token\Kernel

View source

class FieldTest extends KernelTestBase {
  use TaxonomyTestTrait;

  /**
   * @var \Drupal\filter\FilterFormatInterface
   */
  protected $testFormat;

  /**
   * Vocabulary for testing chained token support.
   *
   * @var \Drupal\taxonomy\VocabularyInterface
   */
  protected $vocabulary;

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'node',
    'text',
    'field',
    'filter',
    'contact',
    'options',
    'taxonomy',
    'language',
    'datetime',
    'datetime_range',
  ];

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('user');
    $this
      ->installEntitySchema('node');
    $this
      ->installEntitySchema('taxonomy_term');

    // Create the article content type with a text field.
    $node_type = NodeType::create([
      'type' => 'article',
    ]);
    $node_type
      ->save();
    $field_storage = FieldStorageConfig::create([
      'field_name' => 'test_field',
      'entity_type' => 'node',
      'type' => 'text',
    ]);
    $field_storage
      ->save();
    $field = FieldConfig::create([
      'field_name' => 'test_field',
      'entity_type' => 'node',
      'bundle' => 'article',
      'label' => 'Test field',
    ]);
    $field
      ->save();

    // Create a reference field with the same name on user.
    $field_storage = FieldStorageConfig::create([
      'field_name' => 'test_field',
      'entity_type' => 'user',
      'type' => 'entity_reference',
    ]);
    $field_storage
      ->save();
    $field = FieldConfig::create([
      'field_name' => 'test_field',
      'entity_type' => 'user',
      'bundle' => 'user',
      'label' => 'Test field',
    ]);
    $field
      ->save();
    $this->testFormat = FilterFormat::create([
      'format' => 'test',
      'weight' => 1,
      'filters' => [
        'filter_html_escape' => [
          'status' => TRUE,
        ],
      ],
    ]);
    $this->testFormat
      ->save();

    // Create a multi-value list_string field.
    $field_storage = FieldStorageConfig::create([
      'field_name' => 'test_list',
      'entity_type' => 'node',
      'type' => 'list_string',
      'cardinality' => 2,
      'settings' => [
        'allowed_values' => [
          'key1' => 'value1',
          'key2' => 'value2',
        ],
      ],
    ]);
    $field_storage
      ->save();
    $this->field = FieldConfig::create([
      'field_name' => 'test_list',
      'entity_type' => 'node',
      'bundle' => 'article',
    ])
      ->save();

    // Add an untranslatable node reference field.
    FieldStorageConfig::create([
      'field_name' => 'test_reference',
      'type' => 'entity_reference',
      'entity_type' => 'node',
      'settings' => [
        'target_type' => 'node',
      ],
      'translatable' => FALSE,
    ])
      ->save();
    FieldConfig::create([
      'field_name' => 'test_reference',
      'entity_type' => 'node',
      'bundle' => 'article',
      'label' => 'Test reference',
    ])
      ->save();

    // Add an untranslatable taxonomy term reference field.
    $this->vocabulary = $this
      ->createVocabulary();
    FieldStorageConfig::create([
      'field_name' => 'test_term_reference',
      'type' => 'entity_reference',
      'entity_type' => 'node',
      'settings' => [
        'target_type' => 'taxonomy_term',
      ],
      'translatable' => FALSE,
    ])
      ->save();
    FieldConfig::create([
      'field_name' => 'test_term_reference',
      'entity_type' => 'node',
      'bundle' => 'article',
      'label' => 'Test term reference',
      'settings' => [
        'handler' => 'default:taxonomy_term',
        'handler_settings' => [
          'target_bundles' => [
            $this->vocabulary
              ->id() => $this->vocabulary
              ->id(),
          ],
        ],
      ],
    ])
      ->save();

    // Add a field to terms of the created vocabulary.
    $storage = FieldStorageConfig::create([
      'field_name' => 'term_field',
      'entity_type' => 'taxonomy_term',
      'type' => 'text',
    ]);
    $storage
      ->save();
    $field = FieldConfig::create([
      'field_name' => 'term_field',
      'entity_type' => 'taxonomy_term',
      'bundle' => $this->vocabulary
        ->id(),
    ]);
    $field
      ->save();

    // Add a second language.
    $language = ConfigurableLanguage::create([
      'id' => 'de',
      'label' => 'German',
    ]);
    $language
      ->save();

    // Add a datetime field.
    $field_datetime_storage = FieldStorageConfig::create([
      'field_name' => 'field_datetime',
      'type' => 'datetime',
      'entity_type' => 'node',
      'settings' => [
        'datetime_type' => DateTimeItem::DATETIME_TYPE_DATETIME,
      ],
      'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
    ]);
    $field_datetime_storage
      ->save();
    $field_datetime = FieldConfig::create([
      'field_storage' => $field_datetime_storage,
      'bundle' => 'article',
    ]);
    $field_datetime
      ->save();

    // Add a daterange field.
    $field_daterange_storage = FieldStorageConfig::create([
      'field_name' => 'field_daterange',
      'type' => 'daterange',
      'entity_type' => 'node',
      'settings' => [
        'datetime_type' => DateRangeItem::DATETIME_TYPE_DATETIME,
      ],
      'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
    ]);
    $field_daterange_storage
      ->save();
    $field_daterange = FieldConfig::create([
      'field_storage' => $field_daterange_storage,
      'bundle' => 'article',
    ]);
    $field_daterange
      ->save();

    // Add a timestamp field.
    $field_timestamp_storage = FieldStorageConfig::create([
      'field_name' => 'field_timestamp',
      'type' => 'timestamp',
      'entity_type' => 'node',
      'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
    ]);
    $field_timestamp_storage
      ->save();
    $field_timestamp = FieldConfig::create([
      'field_storage' => $field_timestamp_storage,
      'bundle' => 'article',
    ]);
    $field_timestamp
      ->save();
  }

  /**
   * Tests [entity:field_name] tokens.
   */
  public function testEntityFieldTokens() {

    // Create a node with a value in its fields and test its tokens.
    $entity = Node::create([
      'title' => 'Test node title',
      'type' => 'article',
      'test_field' => [
        'value' => 'foo',
        'format' => $this->testFormat
          ->id(),
      ],
      'test_list' => [
        'value1',
        'value2',
      ],
    ]);
    $entity
      ->save();
    $this
      ->assertTokens('node', [
      'node' => $entity,
    ], [
      'test_field' => Markup::create('foo'),
      'test_field:0' => Markup::create('foo'),
      'test_field:0:value' => 'foo',
      'test_field:value' => 'foo',
      'test_field:0:format' => $this->testFormat
        ->id(),
      'test_field:format' => $this->testFormat
        ->id(),
      'test_list:0' => Markup::create('value1'),
      'test_list:1' => Markup::create('value2'),
      'test_list:0:value' => Markup::create('value1'),
      'test_list:value' => Markup::create('value1'),
      'test_list:1:value' => Markup::create('value2'),
    ]);

    // Verify that no third token was generated for the list_string field.
    $this
      ->assertNoTokens('node', [
      'node' => $entity,
    ], [
      'test_list:2',
      'test_list:2:value',
    ]);

    // Test the test_list token metadata.
    $tokenService = \Drupal::service('token');
    $token_info = $tokenService
      ->getTokenInfo('node', 'test_list');
    $this
      ->assertEquals('test_list', $token_info['name']);
    $this
      ->assertEquals('token', $token_info['module']);
    $this
      ->assertEquals('list<node-test_list>', $token_info['type']);
    $typeInfo = $tokenService
      ->getTypeInfo('list<node-test_list>');
    $this
      ->assertEquals('List of test_list values', $typeInfo['name']);
    $this
      ->assertEquals('list<node-test_list>', $typeInfo['type']);

    // Create a node type that does not have test_field field.
    $node_type = NodeType::create([
      'type' => 'page',
    ]);
    $node_type
      ->save();
    $node_without_test_field = Node::create([
      'title' => 'Node without test_field',
      'type' => 'page',
    ]);
    $node_without_test_field
      ->save();

    // Ensure that trying to generate tokens for a non-existing field does not
    // throw an exception.
    $this
      ->assertNoTokens('node', [
      'node' => $node_without_test_field,
    ], [
      'test_field',
    ]);

    // Create a node without a value in the text field and test its token.
    $entity = Node::create([
      'title' => 'Test node title',
      'type' => 'article',
    ]);
    $entity
      ->save();
    $this
      ->assertNoTokens('node', [
      'node' => $entity,
    ], [
      'test_field',
    ]);
  }

  /**
   * Tests the token metadata for a field token.
   */
  public function testFieldTokenInfo() {

    /** @var \Drupal\token\Token $tokenService */
    $tokenService = \Drupal::service('token');

    // Test the token info of the text field of the artcle content type.
    $token_info = $tokenService
      ->getTokenInfo('node', 'test_field');
    $this
      ->assertEquals('Test field', $token_info['name'], 'The token info name is correct.');
    $this
      ->assertEquals('Text (formatted) field.', $token_info['description'], 'The token info description is correct.');
    $this
      ->assertEquals('token', $token_info['module'], 'The token info module is correct.');

    // Now create two more content types that share the field but the last
    // of them sets a different label. This should show an alternative label
    // at the token info.
    $node_type = NodeType::create([
      'type' => 'article2',
    ]);
    $node_type
      ->save();
    $field = FieldConfig::create([
      'field_name' => 'test_field',
      'entity_type' => 'node',
      'bundle' => 'article2',
      'label' => 'Test field',
    ]);
    $field
      ->save();
    $node_type = NodeType::create([
      'type' => 'article3',
    ]);
    $node_type
      ->save();
    $field = FieldConfig::create([
      'field_name' => 'test_field',
      'entity_type' => 'node',
      'bundle' => 'article3',
      'label' => 'Different test field',
    ]);
    $field
      ->save();
    $token_info = $tokenService
      ->getTokenInfo('node', 'test_field');
    $this
      ->assertEquals('Test field', $token_info['name'], 'The token info name is correct.');
    $this
      ->assertEquals('Text (formatted) field. Also known as <em class="placeholder">Different test field</em>.', (string) $token_info['description'], 'When a field is used in several bundles with different labels, this is noted at the token info description.');
    $this
      ->assertEquals('token', $token_info['module'], 'The token info module is correct.');
    $this
      ->assertEquals('node-test_field', $token_info['type'], 'The field property token info type is correct.');

    // Test field property token info.
    $token_info = $tokenService
      ->getTokenInfo('node-test_field', 'value');
    $this
      ->assertEquals('Text', $token_info['name'], 'The field property token info name is correct.');

    // This particular field property description happens to be empty.
    $this
      ->assertEquals('', (string) $token_info['description'], 'The field property token info description is correct.');
    $this
      ->assertEquals('token', $token_info['module'], 'The field property token info module is correct.');
  }

  /**
   * Test tokens on node with the token view mode overriding default formatters.
   */
  public function testTokenViewMode() {
    $value = 'A really long string that should be trimmed by the special formatter on token view we are going to have.';

    // The formatter we are going to use will eventually call Unicode::strlen.
    // This expects that the Unicode has already been explicitly checked, which
    // happens in DrupalKernel. But since that doesn't run in kernel tests, we
    // explicitly call this here.
    Unicode::check();

    // Create a node with a value in the text field and test its token.
    $entity = Node::create([
      'title' => 'Test node title',
      'type' => 'article',
      'test_field' => [
        'value' => $value,
        'format' => $this->testFormat
          ->id(),
      ],
    ]);
    $entity
      ->save();
    $this
      ->assertTokens('node', [
      'node' => $entity,
    ], [
      'test_field' => Markup::create($value),
    ]);

    // Now, create a token view mode which sets a different format for
    // test_field. When replacing tokens, this formatter should be picked over
    // the default formatter for the field type.
    // @see field_tokens().
    $view_mode = EntityViewMode::create([
      'id' => 'node.token',
      'targetEntityType' => 'node',
    ]);
    $view_mode
      ->save();
    $entity_display = \Drupal::service('entity_display.repository')
      ->getViewDisplay('node', 'article', 'token');
    $entity_display
      ->setComponent('test_field', [
      'type' => 'text_trimmed',
      'settings' => [
        'trim_length' => 50,
      ],
    ]);
    $entity_display
      ->save();
    $this
      ->assertTokens('node', [
      'node' => $entity,
    ], [
      'test_field' => Markup::create(substr($value, 0, 50)),
    ]);
  }

  /**
   * Test that tokens are properly created for an entity's base fields.
   */
  public function testBaseFieldTokens() {

    // Create a new contact_message entity and verify that tokens are generated
    // for its base fields. The contact_message entity type is used because it
    // provides no tokens by default.
    $contact_form = ContactForm::create([
      'id' => 'form_id',
    ]);
    $contact_form
      ->save();
    $entity = Message::create([
      'contact_form' => 'form_id',
      'uuid' => '123',
      'langcode' => 'en',
      'name' => 'Test name',
      'mail' => 'Test mail',
      'subject' => 'Test subject',
      'message' => 'Test message',
      'copy' => FALSE,
    ]);
    $entity
      ->save();
    $this
      ->assertTokens('contact_message', [
      'contact_message' => $entity,
    ], [
      'uuid' => Markup::create('123'),
      'langcode' => Markup::create('English'),
      'name' => Markup::create('Test name'),
      'mail' => Markup::create('Test mail'),
      'subject' => Markup::create('Test subject'),
      'message' => Markup::create('Test message'),
      'copy' => 'Off',
    ]);

    // Test the metadata of one of the tokens.
    $tokenService = \Drupal::service('token');
    $token_info = $tokenService
      ->getTokenInfo('contact_message', 'subject');
    $this
      ->assertEquals($token_info['name'], 'Subject');
    $this
      ->assertEquals($token_info['description'], 'Text (plain) field.');
    $this
      ->assertEquals($token_info['module'], 'token');

    // Verify that node entity type doesn't have a uid token.
    $this
      ->assertNull($tokenService
      ->getTokenInfo('node', 'uid'));
  }

  /*
   * Tests chaining entity reference tokens.
   */
  public function testEntityReferenceTokens() {
    $reference = Node::create([
      'title' => 'Test node to reference',
      'type' => 'article',
      'test_field' => [
        'value' => 'foo',
        'format' => $this->testFormat
          ->id(),
      ],
    ]);
    $reference
      ->save();
    $term_reference_field_value = $this
      ->randomString();
    $term_reference = $this
      ->createTerm($this->vocabulary, [
      'name' => 'Term to reference',
      'term_field' => [
        'value' => $term_reference_field_value,
        'format' => $this->testFormat
          ->id(),
      ],
    ]);
    $entity = Node::create([
      'title' => 'Test entity reference',
      'type' => 'article',
      'test_reference' => [
        'target_id' => $reference
          ->id(),
      ],
      'test_term_reference' => [
        'target_id' => $term_reference
          ->id(),
      ],
    ]);
    $entity
      ->save();
    $this
      ->assertTokens('node', [
      'node' => $entity,
    ], [
      'test_reference:entity:title' => Markup::create('Test node to reference'),
      'test_reference:entity:test_field' => Markup::create('foo'),
      'test_term_reference:entity:term_field' => Html::escape($term_reference_field_value),
      'test_reference:target_id' => $reference
        ->id(),
      'test_term_reference:target_id' => $term_reference
        ->id(),
      'test_term_reference:entity:url:path' => '/' . $term_reference
        ->toUrl('canonical')
        ->getInternalPath(),
      // Expects the entity's label to be returned for :entity tokens.
      'test_reference:entity' => $reference
        ->label(),
      'test_term_reference:entity' => $term_reference
        ->label(),
    ]);

    // Test some non existent tokens.
    $this
      ->assertNoTokens('node', [
      'node' => $entity,
    ], [
      'test_reference:1:title',
      'test_reference:entity:does_not_exist',
      'test_reference:does_not:exist',
      'test_term_reference:does_not_exist',
      'test_term_reference:does:not:exist',
      'test_term_reference:does_not_exist:0',
      'non_existing_field:entity:title',
    ]);

    /** @var \Drupal\token\Token $token_service */
    $token_service = \Drupal::service('token');
    $token_info = $token_service
      ->getTokenInfo('node', 'test_reference');
    $this
      ->assertEquals('Test reference', $token_info['name']);
    $this
      ->assertEquals('Entity reference field.', (string) $token_info['description']);
    $this
      ->assertEquals('token', $token_info['module']);
    $this
      ->assertEquals('node-test_reference', $token_info['type']);

    // Test target_id field property token info.
    $token_info = $token_service
      ->getTokenInfo('node-test_reference', 'target_id');
    $this
      ->assertEquals('Content ID', $token_info['name']);
    $this
      ->assertEquals('token', $token_info['module']);
    $this
      ->assertEquals('token', $token_info['module']);

    // Test entity field property token info.
    $token_info = $token_service
      ->getTokenInfo('node-test_reference', 'entity');
    $this
      ->assertEquals('Content', $token_info['name']);
    $this
      ->assertEquals('The referenced entity', $token_info['description']);
    $this
      ->assertEquals('token', $token_info['module']);
    $this
      ->assertEquals('node', $token_info['type']);

    // Test entity field property token info of the term reference.
    $token_info = $token_service
      ->getTokenInfo('node-test_term_reference', 'entity');
    $this
      ->assertEquals('Taxonomy term', $token_info['name']);
    $this
      ->assertEquals('The referenced entity', $token_info['description']);
    $this
      ->assertEquals('token', $token_info['module']);
    $this
      ->assertEquals('term', $token_info['type']);
  }

  /**
   * Tests support for cardinality > 1 for entity reference tokens.
   */
  public function testEntityReferenceTokensCardinality() {

    /** @var \Drupal\field\FieldStorageConfigInterface $storage */
    $storage = FieldStorageConfig::load('node.test_term_reference');
    $storage
      ->setCardinality(FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
    $storage
      ->save();

    // Add a few terms.
    $terms = [];
    $terms_value = [];
    foreach (range(1, 3) as $i) {
      $terms_value[$i] = $this
        ->randomString();
      $terms[$i] = $this
        ->createTerm($this->vocabulary, [
        'name' => $this
          ->randomString(),
        'term_field' => [
          'value' => $terms_value[$i],
          'format' => $this->testFormat
            ->id(),
        ],
      ]);
    }
    $entity = Node::create([
      'title' => 'Test multivalue chained tokens',
      'type' => 'article',
      'test_term_reference' => [
        [
          'target_id' => $terms[1]
            ->id(),
        ],
        [
          'target_id' => $terms[2]
            ->id(),
        ],
        [
          'target_id' => $terms[3]
            ->id(),
        ],
      ],
    ]);
    $entity
      ->save();
    $this
      ->assertTokens('node', [
      'node' => $entity,
    ], [
      'test_term_reference:0:entity:term_field' => Html::escape($terms[1]->term_field->value),
      'test_term_reference:1:entity:term_field' => Html::escape($terms[2]->term_field->value),
      'test_term_reference:2:entity:term_field' => Html::escape($terms[3]->term_field->value),
      'test_term_reference:0:target_id' => $terms[1]
        ->id(),
      'test_term_reference:1:target_id' => $terms[2]
        ->id(),
      'test_term_reference:2:target_id' => $terms[3]
        ->id(),
      // Expects the entity's label to be returned for :entity tokens.
      'test_term_reference:0:entity' => $terms[1]
        ->label(),
      'test_term_reference:1:entity' => $terms[2]
        ->label(),
      'test_term_reference:2:entity' => $terms[3]
        ->label(),
      // To make sure tokens without an explicit delta can also be replaced in
      // the same token replacement call.
      'test_term_reference:entity:term_field' => Html::escape($terms[1]->term_field->value),
      'test_term_reference:target_id' => $terms[1]
        ->id(),
    ]);

    // Test some non existent tokens.
    $this
      ->assertNoTokens('node', [
      'node' => $entity,
    ], [
      'test_term_reference:3:term_field',
      'test_term_reference:0:does_not_exist',
      'test_term_reference:1:does:not:exist',
      'test_term_reference:1:2:does_not_exist',
    ]);
  }

  /**
   * Test tokens for multilingual fields and entities.
   */
  public function testMultilingualFields() {

    // Create an english term and add a german translation for it.
    $term = $this
      ->createTerm($this->vocabulary, [
      'name' => 'english-test-term',
      'langcode' => 'en',
      'term_field' => [
        'value' => 'english-term-field-value',
        'format' => $this->testFormat
          ->id(),
      ],
    ]);
    $term
      ->addTranslation('de', [
      'name' => 'german-test-term',
      'term_field' => [
        'value' => 'german-term-field-value',
        'format' => $this->testFormat
          ->id(),
      ],
    ])
      ->save();
    $german_term = $term
      ->getTranslation('de');

    // Create an english node, add a german translation for it and add the
    // english term to the english node's entity reference field and the
    // german term to the german's entity reference field.
    $node = Node::create([
      'title' => 'english-node-title',
      'type' => 'article',
      'test_term_reference' => [
        'target_id' => $term
          ->id(),
      ],
      'test_field' => [
        'value' => 'test-english-field',
        'format' => $this->testFormat
          ->id(),
      ],
    ]);
    $node
      ->addTranslation('de', [
      'title' => 'german-node-title',
      'test_term_reference' => [
        'target_id' => $german_term
          ->id(),
      ],
      'test_field' => [
        'value' => 'test-german-field',
        'format' => $this->testFormat
          ->id(),
      ],
    ])
      ->save();

    // Verify the :title token of the english node and the :name token of the
    // english term it refers to. Also verify the value of the term's field.
    $this
      ->assertTokens('node', [
      'node' => $node,
    ], [
      'title' => 'english-node-title',
      'test_term_reference:entity:name' => 'english-test-term',
      'test_term_reference:entity:term_field:value' => 'english-term-field-value',
      'test_term_reference:entity:term_field' => 'english-term-field-value',
      'test_field' => 'test-english-field',
      'test_field:value' => 'test-english-field',
    ]);

    // Same test for the german node and its german term.
    $german_node = $node
      ->getTranslation('de');
    $this
      ->assertTokens('node', [
      'node' => $german_node,
    ], [
      'title' => 'german-node-title',
      'test_term_reference:entity:name' => 'german-test-term',
      'test_term_reference:entity:term_field:value' => 'german-term-field-value',
      'test_term_reference:entity:term_field' => 'german-term-field-value',
      'test_field' => 'test-german-field',
      'test_field:value' => 'test-german-field',
    ]);

    // If the langcode is specified, it should have priority over the node's
    // active language.
    $tokens = [
      'test_field' => 'test-german-field',
      'test_field:value' => 'test-german-field',
      'test_term_reference:entity:term_field' => 'german-term-field-value',
      'test_term_reference:entity:term_field:value' => 'german-term-field-value',
    ];
    $this
      ->assertTokens('node', [
      'node' => $node,
    ], $tokens, [
      'langcode' => 'de',
    ]);
  }

  /**
   * Tests support for a datetime fields.
   */
  public function testDatetimeFieldTokens() {
    $node = Node::create([
      'title' => 'Node for datetime field',
      'type' => 'article',
    ]);
    $node
      ->set('field_datetime', [
      '1925-09-28T00:00:00',
      '1930-10-28T00:00:00',
    ])
      ->save();
    $this
      ->assertTokens('node', [
      'node' => $node,
    ], [
      'field_datetime:date:custom:Y' => '1925',
      'field_datetime:date:html_month' => '1925-09',
      'field_datetime:date' => $node
        ->get('field_datetime')->date
        ->getTimestamp(),
      'field_datetime:0:date:custom:Y' => '1925',
      'field_datetime:0:date:html_month' => '1925-09',
      'field_datetime:0:date' => $node
        ->get('field_datetime')->date
        ->getTimestamp(),
      'field_datetime:1:date:custom:Y' => '1930',
      'field_datetime:1:date:html_month' => '1930-10',
      'field_datetime:1:date' => $node
        ->get('field_datetime')
        ->get(1)->date
        ->getTimestamp(),
    ]);
  }

  /**
   * Tests support for a daterange fields.
   */
  public function testDatetimeRangeFieldTokens() {

    /** @var \Drupal\node\NodeInterface $node */
    $node = Node::create([
      'title' => 'Node for daterange field',
      'type' => 'article',
    ]);
    $node
      ->get('field_daterange')->value = '2013-12-22T00:00:00';
    $node
      ->get('field_daterange')->end_value = '2016-08-26T00:00:00';
    $node
      ->get('field_daterange')
      ->appendItem([
      'value' => '2014-08-22T00:00:00',
      'end_value' => '2017-12-20T00:00:00',
    ]);
    $node
      ->get('field_daterange')->value = '2013-12-22T00:00:00';
    $node
      ->get('field_daterange')->end_value = '2016-08-26T00:00:00';
    $node
      ->save();
    $this
      ->assertTokens('node', [
      'node' => $node,
    ], [
      'field_daterange:start_date:html_month' => '2013-12',
      'field_daterange:start_date:custom:Y' => '2013',
      'field_daterange:end_date:custom:Y' => '2016',
      'field_daterange:start_date' => $node
        ->get('field_daterange')->start_date
        ->getTimestamp(),
      'field_daterange:0:start_date:html_month' => '2013-12',
      'field_daterange:0:start_date:custom:Y' => '2013',
      'field_daterange:0:end_date:custom:Y' => '2016',
      'field_daterange:0:start_date' => $node
        ->get('field_daterange')->start_date
        ->getTimestamp(),
      'field_daterange:1:start_date:html_month' => '2014-08',
      'field_daterange:1:start_date:custom:Y' => '2014',
      'field_daterange:1:end_date:custom:Y' => '2017',
      'field_daterange:1:end_date' => $node
        ->get('field_daterange')
        ->get(1)->end_date
        ->getTimestamp(),
    ]);
  }

  /**
   * Tests support for a timestamp fields.
   */
  public function testTimestampFieldTokens() {
    $node = Node::create([
      'title' => 'Node for timestamp field',
      'type' => 'article',
    ]);
    $node
      ->set('field_timestamp', [
      '1277540209',
      '1532593009',
    ])
      ->save();
    $this
      ->assertTokens('node', [
      'node' => $node,
    ], [
      'field_timestamp:date:custom:Y' => '2010',
      'field_timestamp:date:html_month' => '2010-06',
      'field_timestamp:date' => $node
        ->get('field_timestamp')->value,
      'field_timestamp:0:date:custom:Y' => '2010',
      'field_timestamp:0:date:html_month' => '2010-06',
      'field_timestamp:0:date' => $node
        ->get('field_timestamp')->value,
      'field_timestamp:1:date:custom:Y' => '2018',
      'field_timestamp:1:date:html_month' => '2018-07',
      'field_timestamp:1:date' => $node
        ->get('field_timestamp')
        ->get(1)->value,
    ]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertContentTrait::$content	protected	property	The current raw content.
AssertContentTrait::$drupalSettings	protected	property	The drupalSettings value from the current raw $content.
AssertContentTrait::$elements	protected	property	The XML structure parsed from the current raw $content.	1
AssertContentTrait::$plainTextContent	protected	property	The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField	protected	function	Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById	protected	function	Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName	protected	function	Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked	protected	function	Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink	protected	function	Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref	protected	function	Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds	protected	function	Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped	protected	function	Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField	protected	function	Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById	protected	function	Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName	protected	function	Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink	protected	function	Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref	protected	function	Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion	protected	function	Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption	protected	function	Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected	protected	function	Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern	protected	function	Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw	protected	function	Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle	protected	function	Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText	protected	function	Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper	protected	function	Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern	protected	function	Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput	protected	function	Asserts themed output.
AssertContentTrait::assertTitle	protected	function	Pass if the page title is the given string.
AssertContentTrait::assertUniqueText	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper	protected	function	Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery	protected	function	Builds an XPath query.
AssertContentTrait::constructFieldXpath	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect	protected	function	Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions	protected	function	Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings	protected	function	Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent	protected	function	Gets the current raw content.
AssertContentTrait::getSelectedItem	protected	function	Get the selected value from a select field.
AssertContentTrait::getTextContent	protected	function	Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl	protected	function	Get the current URL from the cURL handler.	1
AssertContentTrait::parse	protected	function	Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace	protected	function	Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings	protected	function	Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent	protected	function	Sets the raw content (e.g. HTML).
AssertContentTrait::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings	protected static	function	Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose	protected	function
ConfigTestTrait::configImporter	protected	function	Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig	protected	function	Copies configuration objects from source storage to target storage.
FieldTest::$modules	public static	property	Modules to enable. Overrides KernelTestBase::$modules
FieldTest::$testFormat	protected	property
FieldTest::$vocabulary	protected	property	Vocabulary for testing chained token support.
FieldTest::setUp	public	function	Overrides KernelTestBase::setUp
FieldTest::testBaseFieldTokens	public	function	Test that tokens are properly created for an entity's base fields.
FieldTest::testDatetimeFieldTokens	public	function	Tests support for a datetime fields.
FieldTest::testDatetimeRangeFieldTokens	public	function	Tests support for a daterange fields.
FieldTest::testEntityFieldTokens	public	function	Tests [entity:field_name] tokens.
FieldTest::testEntityReferenceTokens	public	function
FieldTest::testEntityReferenceTokensCardinality	public	function	Tests support for cardinality > 1 for entity reference tokens.
FieldTest::testFieldTokenInfo	public	function	Tests the token metadata for a field token.
FieldTest::testMultilingualFields	public	function	Test tokens for multilingual fields and entities.
FieldTest::testTimestampFieldTokens	public	function	Tests support for a timestamp fields.
FieldTest::testTokenViewMode	public	function	Test tokens on node with the token view mode overriding default formatters.
KernelTestBase::$backupGlobals	protected	property	Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes	protected	property	Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist	protected	property	Contains a few static class properties for performance.
KernelTestBase::$classLoader	protected	property
KernelTestBase::$configImporter	protected	property	@todo Move into Config test base class.	7
KernelTestBase::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
KernelTestBase::$container	protected	property
KernelTestBase::$databasePrefix	protected	property
KernelTestBase::$preserveGlobalState	protected	property	Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root	protected	property	The app root.
KernelTestBase::$runTestInSeparateProcess	protected	property	Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory	protected	property
KernelTestBase::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	6
KernelTestBase::$vfsRoot	protected	property	The virtual filesystem root directory.
KernelTestBase::assertPostConditions	protected	function		1
KernelTestBase::bootEnvironment	protected	function	Bootstraps a basic test environment.
KernelTestBase::bootKernel	private	function	Bootstraps a kernel for a test.
KernelTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules	protected	function	Disables modules for this test.
KernelTestBase::enableModules	protected	function	Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo	protected	function	Returns the Database connection info to be used for this test.	1
KernelTestBase::getDatabasePrefix	public	function
KernelTestBase::getExtensionsForModules	private	function	Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable	private static	function	Returns the modules to enable for this test.
KernelTestBase::initFileCache	protected	function	Initializes the FileCache component.
KernelTestBase::installConfig	protected	function	Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema	protected	function	Installs the storage schema for a specific entity type.
KernelTestBase::installSchema	protected	function	Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated	protected	function	Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate	protected	function
KernelTestBase::register	public	function	Registers test-specific services. Overrides ServiceProviderInterface::register	26
KernelTestBase::render	protected	function	Renders a render array.	1
KernelTestBase::setInstallProfile	protected	function	Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting	protected	function	Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass	public static	function		1
KernelTestBase::setUpFilesystem	protected	function	Sets up the filesystem, so things like the file directory.	2
KernelTestBase::stop	protected	function	Stops test execution.
KernelTestBase::tearDown	protected	function		6
KernelTestBase::tearDownCloseDatabaseConnection	public	function	@after
KernelTestBase::vfsDump	protected	function	Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated	public	function	BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep	public	function	Prevents serializing any properties.
PathAliasTestTrait::assertPathAliasExists	protected	function	Asserts that a path alias exists in the storage.
PathAliasTestTrait::assertPathAliasNotExists	protected	function	Asserts that a path alias does not exist in the storage.
PathAliasTestTrait::createPathAlias	protected	function	Creates a new path alias.
PathAliasTestTrait::loadPathAliasByConditions	protected	function	Gets the first result from a 'load by properties' storage call.
PhpunitCompatibilityTrait::getMock Deprecated	public	function	Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated	public	function	Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator	protected	property	The random generator.
RandomGeneratorTrait::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName	protected	function	Generates a unique random string containing letters and numbers.	1
RandomGeneratorTrait::randomObject	public	function	Generates a random PHP object.
RandomGeneratorTrait::randomString	public	function	Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate	public	function	Callback for random string validation.
StorageCopyTrait::replaceStorageContents	protected static	function	Copy the configuration from one storage to another and remove stale items.
TaxonomyTestTrait::createTerm	public	function	Returns a new term with random properties given a vocabulary.
TaxonomyTestTrait::createVocabulary	public	function	Returns a new vocabulary with random properties.
TestRequirementsTrait::checkModuleRequirements	private	function	Checks missing module requirements.
TestRequirementsTrait::checkRequirements	protected	function	Check module requirements for the Drupal use case.	1
TestRequirementsTrait::getDrupalRoot	protected static	function	Returns the Drupal root directory.
TokenTestTrait::assertNoTokens		function
TokenTestTrait::assertPageTokens		function	Make a page request and test for token generation.
TokenTestTrait::assertToken		function
TokenTestTrait::assertTokens		function
TokenTestTrait::mapTokenNames		function
TokenTestTrait::saveAlias		function
TokenTestTrait::saveEntityAlias		function

You are here

class FieldTest in Token 8

Hierarchy

File

Namespace

Members

API Navigation