class FieldFormatterContext in Views field formatter 8.2

Class FieldFormatterContext.

Hierarchy

• class \Drupal\Tests\views_field_formatter\Behat\FieldFormatterContext extends \Drupal\DrupalExtension\Context\RawDrupalContext

File

tests/Behat/FieldFormatterContext.php, line 12

Namespace

Drupal\Tests\views_field_formatter\Behat

class FieldFormatterContext extends RawDrupalContext {

  /**
   * Enable a field in the entity view.
   *
   * @Given I enable the display of the :field field of the :bundle bundle of :entity entity
   * @Given I enable the display of the :field field of the :bundle bundle of :entity entity in :view_mode view mode
   */
  public function iEnableTheDisplayOfTheFieldOfTheBundleOfEntity($field, $bundle, $entity, $view_mode = 'default') {
    $config_name = \sprintf('core.entity_view_display.%s.%s.%s', $entity, $bundle, $view_mode);
    $config = \Drupal::configFactory()
      ->getEditable($config_name)
      ->getRawData();
    unset($config['hidden'][$field]);
    $config['content'][$field] = [
      'region' => 'content',
      'type' => NULL,
      'settings' => [],
      'third_party_settings' => [],
    ];
    \Drupal::configFactory()
      ->getEditable($config_name)
      ->setData($config)
      ->save();
  }

  /**
   * Hide the display of a field.
   *
   * @Given I hide the display of the :field field of the :bundle bundle of :entity entity
   * @Given I hide the display of the :field field of the :bundle bundle of :entity entity in :view_mode view mode
   */
  public function iHideTheDisplayOfTheFieldOfTheBundleOfEntity($field, $bundle, $entity, $view_mode = 'default') {
    $config_name = \sprintf('core.entity_view_display.%s.%s.%s', $entity, $bundle, $view_mode);
    $config = \Drupal::configFactory()
      ->getEditable($config_name)
      ->getRawData();
    if (!isset($config['content'][$field])) {

      // @todo Throw an error.
      return;
    }
    unset($config['content'][$field]);
    $config['hidden'][$field] = TRUE;
    \Drupal::configFactory()
      ->getEditable($config_name)
      ->setData($config)
      ->save();
  }

  /**
   * Reset a formatter.
   *
   * @Given I reset the formatter of the :field field of the :bundle bundle of :entity entity
   * @Given I reset the formatter of the :field field of the :bundle bundle of :entity entity in :view_mode view mode
   */
  public function iResetTheFormatterOfTheFieldOfTheBundleOfEntity($field, $bundle, $entity, $view_mode = 'default') {
    $config_name = \sprintf('core.entity_view_display.%s.%s.%s', $entity, $bundle, $view_mode);
    $config = \Drupal::configFactory()
      ->getEditable($config_name)
      ->getRawData();
    if (!isset($config['content'][$field]) || !isset($config['hidden'][$field])) {

      // @todo Throw an error.
      return;
    }
    $region = isset($config['content'][$field]) ? 'content' : 'hidden';
    if (!\is_array($config[$region][$field])) {
      $config[$region][$field] = [
        'type' => NULL,
        'settings' => [],
        'third_party_settings' => [],
      ];
    }
    else {
      $config[$region][$field]['type'] = NULL;
      $config[$region][$field]['settings'] = [];
      $config[$region][$field]['third_party_settings'] = [];
    }
    \Drupal::configFactory()
      ->getEditable($config_name)
      ->setData($config)
      ->save();
  }

  /**
   * Set a specific formatter to a field.
   *
   * @Given I set the :formatter formatter to the field :field of the :bundle bundle of :entity entity
   * @Given I set the :formatter formatter to the :field field of the :bundle bundle of :entity entity in :view_mode view mode
   */
  public function iSetTheFormatterToTheFieldOfTheBundleOfEntity($formatter, $field, $bundle, $entity, $view_mode = 'default') {
    $config_name = \sprintf('core.entity_view_display.%s.%s.%s', $entity, $bundle, $view_mode);
    $config = \Drupal::configFactory()
      ->getEditable($config_name)
      ->getRawData();
    $config['content'][$field] = [
      'region' => 'content',
      'type' => $formatter,
      'settings' => [],
      'third_party_settings' => [],
    ];
    \Drupal::configFactory()
      ->getEditable($config_name)
      ->setData($config)
      ->save();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FieldFormatterContext::iEnableTheDisplayOfTheFieldOfTheBundleOfEntity	public	function	Enable a field in the entity view.
FieldFormatterContext::iHideTheDisplayOfTheFieldOfTheBundleOfEntity	public	function	Hide the display of a field.
FieldFormatterContext::iResetTheFormatterOfTheFieldOfTheBundleOfEntity	public	function	Reset a formatter.
FieldFormatterContext::iSetTheFormatterToTheFieldOfTheBundleOfEntity	public	function	Set a specific formatter to a field.