You are here

Home » API reference » Swagger UI Field Formatter 8 » SwaggerUIFormatter.php

class SwaggerUIFormatter in Swagger UI Field Formatter 8

Plugin implementation of the 'swagger_ui' formatter.

Plugin annotation


@FieldFormatter(
  id = "swagger_ui",
  label = @Translation("Swagger UI"),
  description = @Translation("Formats file fields with Swagger YAML or JSON files with a rendered Swagger UI"),
  field_types = {
    "file"
  }
)

Hierarchy

Expanded class hierarchy of SwaggerUIFormatter

File

src/Plugin/Field/FieldFormatter/SwaggerUIFormatter.php, line 21

Namespace

Drupal\swagger_ui_formatter\Plugin\Field\FieldFormatter
View source 
class SwaggerUIFormatter extends FileFormatterBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'validator' => 'default',
      'validator_url' => '',
      'doc_expansion' => 'list',
      'show_top_bar' => FALSE,
      'sort_tags_by_name' => FALSE,
      'supported_submit_methods' => [],
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $form['validator'] = [
      '#type' => 'select',
      '#title' => $this
        ->t("Validator"),
      '#description' => $this
        ->t("Default=Swagger.io's online validator, None= No validation, Custom=Provide a custom validator url"),
      '#default_value' => $this
        ->getSetting('validator'),
      '#options' => [
        'none' => $this
          ->t('None'),
        'default' => $this
          ->t('Default'),
        'custom' => $this
          ->t('Custom'),
      ],
    ];
    $form['validator_url'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t("Validator URL"),
      '#description' => $this
        ->t("The custom validator url to be used to validated the swagger files."),
      '#default_value' => $this
        ->getSetting('validator_url'),
      '#states' => [
        'visible' => [
          ':input[name="fields[' . $this->fieldDefinition
            ->getName() . '][settings_edit_form][settings][validator]"]' => [
            'value' => 'custom',
          ],
        ],
      ],
    ];
    $form['doc_expansion'] = [
      '#type' => 'select',
      '#title' => $this
        ->t("Doc Expansion"),
      '#description' => $this
        ->t("Controls how the API listing is displayed."),
      '#default_value' => $this
        ->getSetting('doc_expansion'),
      '#options' => [
        'none' => $this
          ->t('None - Expands nothing'),
        'list' => $this
          ->t('List - Expands only tags'),
        'full' => $this
          ->t('Full - Expands tags and operations'),
      ],
    ];
    $form['show_top_bar'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t("Show Top Bar"),
      '#description' => $this
        ->t("Controls whether the Swagger UI top bar should be displayed or not."),
      '#default_value' => $this
        ->getSetting('show_top_bar'),
    ];
    $form['sort_tags_by_name'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t("Sort tags by name"),
      '#description' => $this
        ->t("Controls whether the tag groups should be ordered alphabetically or not."),
      '#default_value' => $this
        ->getSetting('sort_tags_by_name'),
    ];
    $form['supported_submit_methods'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t("Try it out support for HTTP Methods"),
      '#description' => $this
        ->t("List of HTTP methods that have the Try it out feature enabled. Selecting none disables Try it out for all operations. This does not filter the operations from the display."),
      '#default_value' => $this
        ->getSetting('supported_submit_methods'),
      '#options' => [
        'get' => $this
          ->t('GET'),
        'put' => $this
          ->t('PUT'),
        'post' => $this
          ->t('POST'),
        'delete' => $this
          ->t('DELETE'),
        'options' => $this
          ->t('OPTIONS'),
        'head' => $this
          ->t('HEAD'),
        'patch' => $this
          ->t('PATCH'),
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $supported_submit_methods = array_filter($this
      ->getSetting('supported_submit_methods'));
    $summary[] = $this
      ->t('Uses %validator validator, Doc Expansion of %doc_expansion, Shows top bar: %show_top_bar, Tags sorted by name: %sort_tags_by_name, Try it out support for HTTP Methods: %supported_submit_methods.', [
      '%validator' => $this
        ->getSetting('validator'),
      '%doc_expansion' => $this
        ->getSetting('doc_expansion'),
      '%show_top_bar' => $this
        ->getSetting('show_top_bar') ? $this
        ->t('Yes') : $this
        ->t('No'),
      '%sort_tags_by_name' => $this
        ->getSetting('sort_tags_by_name') ? $this
        ->t('Yes') : $this
        ->t('No'),
      '%supported_submit_methods' => !empty($supported_submit_methods) ? implode(', ', array_map('strtoupper', $supported_submit_methods)) : $this
        ->t('None'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function view(FieldItemListInterface $items, $langcode = NULL) {
    $swagger_files = [];

    /** @var \Drupal\file\Entity\File $file */
    foreach ($this
      ->getEntitiesToView($items, $langcode) as $delta => $file) {
      $swagger_files[] = file_create_url($file
        ->getFileUri());
    }
    $elements = parent::view($items, $langcode);
    $elements['#attached'] = [
      'library' => [
        'swagger_ui_formatter/swagger_ui_formatter.swagger_ui',
      ],
    ];
    $elements['#attached']['drupalSettings']['swaggerUIFormatter'][$this->fieldDefinition
      ->getName()] = [
      'swaggerFiles' => $swagger_files,
      'validator' => $this
        ->getSetting('validator'),
      'validatorUrl' => $this
        ->getSetting('validator_url'),
      'docExpansion' => $this
        ->getSetting('doc_expansion'),
      'showTopBar' => $this
        ->getSetting('show_top_bar'),
      'sortTagsByName' => $this
        ->getSetting('sort_tags_by_name'),
      'supportedSubmitMethods' => array_keys(array_filter($this
        ->getSetting('supported_submit_methods'))),
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $element = [];
    foreach ($this
      ->getEntitiesToView($items, $langcode) as $delta => $file) {
      $element[$delta] = [
        '#theme' => 'swagger_ui_field_item',
        '#field_name' => $this->fieldDefinition
          ->getName(),
        '#delta' => $delta,
      ];
    }
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EntityReferenceFormatterBase::getEntitiesToView protected function Returns the referenced entities for display. 1
EntityReferenceFormatterBase::prepareView public function Loads the entities referenced in that field across all the entities being viewed. Overrides FormatterBase::prepareView
FileFormatterBase::checkAccess protected function Checks access to the given entity. Overrides EntityReferenceFormatterBase::checkAccess
FileFormatterBase::needsEntityLoad protected function Returns whether the entity referenced by an item needs to be loaded. Overrides EntityReferenceFormatterBase::needsEntityLoad 1
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
FormatterBase::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct 11
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
SwaggerUIFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
SwaggerUIFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
SwaggerUIFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
SwaggerUIFormatter::view public function Builds a renderable array for a fully themed field. Overrides EntityReferenceFormatterBase::view
SwaggerUIFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements