SmartDocsFormatter.php in Apigee API Catalog 8
Same filename and directory in other branches
File
src/Plugin/Field/FieldFormatter/SmartDocsFormatter.phpView source
<?php
/**
* Copyright 2018 Google Inc.
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License version 2 as published by the
* Free Software Foundation.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
* License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc., 51
* Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
namespace Drupal\apigee_api_catalog\Plugin\Field\FieldFormatter;
use Drupal\Component\Serialization\Exception\InvalidDataTypeException;
use Drupal\Core\Field\FieldDefinitionInterface;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Logger\LoggerChannelFactoryInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Serialization\Yaml;
use Drupal\file\Plugin\Field\FieldFormatter\FileFormatterBase;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Drupal\Component\Serialization\Json;
/**
* Plugin implementation of the SmartDocs OpenAPI spec formatter.
*
* @FieldFormatter(
* id = "apigee_api_catalog_smartdocs",
* label = @Translation("SmartDocs"),
* description = @Translation("Formats OpenAPI specs with SmartDocs"),
* field_types = {
* "file"
* }
* )
*/
class SmartDocsFormatter extends FileFormatterBase implements ContainerFactoryPluginInterface {
/**
* The logger factory.
*
* @var \Drupal\Core\Logger\LoggerChannelFactoryInterface
*/
protected $loggerFactory;
/**
* Constructs a EntityReferenceEntityFormatter instance.
*
* @param string $plugin_id
* The plugin_id for the formatter.
* @param mixed $plugin_definition
* The plugin implementation definition.
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The definition of the field to which the formatter is associated.
* @param array $settings
* The formatter settings.
* @param string $label
* The formatter label display setting.
* @param string $view_mode
* The view mode.
* @param array $third_party_settings
* Any third party settings settings.
* @param \Drupal\Core\Logger\LoggerChannelFactoryInterface $loggerFactory
* The logger factory.
*/
public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, LoggerChannelFactoryInterface $loggerFactory) {
parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
$this->loggerFactory = $loggerFactory
->get('apigee_api_catalog');
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
->get('logger.factory'));
}
/**
* {@inheritdoc}
*/
public function view(FieldItemListInterface $items, $langcode = NULL) {
$elements = parent::view($items, $langcode);
// Add base tag for SmartDocs Angular application.
$xuacompatible = [
'#tag' => 'base',
'#attributes' => [
'href' => base_path(),
],
];
$elements['#attached']['html_head'][] = [
$xuacompatible,
'base-href',
];
return $elements;
}
/**
* {@inheritdoc}
*/
public function viewElements(FieldItemListInterface $items, $langcode) {
$entity = $items
->getEntity();
$entity_type = $entity
->getEntityTypeId();
// The list of OpenAPI specs to pass to SmartDocs Angular app.
$openapi_files = [];
/** @var \Drupal\file\Entity\File $file */
foreach ($this
->getEntitiesToView($items, $langcode) as $delta => $file) {
$openapi_files[] = [
// Get the URL of the file on server.
'fileUrl' => $file
->createFileUrl(FALSE),
'fileExtension' => pathinfo($file
->getFilename(), PATHINFO_EXTENSION),
];
}
$elements['#attached'] = [
'library' => [
'apigee_api_catalog/apigee_api_catalog.js_yaml',
'apigee_api_catalog/apigee_api_catalog.smartdocs_integration',
'apigee_api_catalog/apigee_api_catalog.smartdocs',
],
];
$elements['#attached']['drupalSettings']['smartdocsFieldFormatter'][$this->fieldDefinition
->getName()] = [
'openApiFiles' => $openapi_files,
'entityId' => $entity
->id(),
'entityType' => $entity_type,
];
foreach ($items as $delta => $item) {
$elements[$delta] = [
// Create tag on page for SmartDocs Angular app.
'#type' => 'html_tag',
'#tag' => 'app-root',
'#value' => $this
->t('Loading...'),
];
}
return $elements;
}
}
Classes
Name | Description |
---|---|
SmartDocsFormatter | Plugin implementation of the SmartDocs OpenAPI spec formatter. |