You are here

Home » API reference » Fastly 8.3 » FastlyEdgeModulesController.php

class FastlyEdgeModulesController in Fastly 8.3

Class FastlyEdgeModulesController

@package Drupal\fastly\Controller

Hierarchy

Expanded class hierarchy of FastlyEdgeModulesController

File

src/Controller/FastlyEdgeModulesController.php, line 21

Namespace

Drupal\fastly\Controller
View source 
class FastlyEdgeModulesController extends ControllerBase {

  /**
   * @var \Drupal\fastly\Api
   */
  protected $api;

  /**
   * @var VclHandler
   */
  protected $vclHandler;

  /**
   * @var FileSystem
   */
  protected $fileSystem;

  /**
   * @var \Drupal\Core\Messenger\Messenger
   */
  protected $messenger;

  /**
   * FastlyEdgeModulesController constructor.
   *
   * @param Api $api
   * @param VclHandler $vcl_handler
   * @param FileSystem $file_system
   * @param Messenger $messenger
   */
  public function __construct(Api $api, VclHandler $vcl_handler, FileSystem $file_system, Messenger $messenger) {
    $this->api = $api;
    $this->vclHandler = $vcl_handler;
    $this->fileSystem = $file_system;
    $this->messenger = $messenger;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('fastly.api'), $container
      ->get('fastly.vclhandler'), $container
      ->get('file_system'), $container
      ->get('messenger'));
  }

  /**
   * List all edge modules
   */
  public function getEdgeModules() {
    $apiCheck = $this->api
      ->testFastlyApiConnection();
    if (!$apiCheck['status']) {
      $this->messenger
        ->addError($apiCheck['message']);
      return [];
    }
    $snippets = $this->vclHandler
      ->getAllSnippets();
    $data['title'] = [
      '#markup' => 'Fastly Edge Modules is a framework that allows you to enable specific functionality on Fastly without needing to write any VCL code. Below is a list of functions you can enable. Some may have additional options you can configure. To enable or disable click on the <strong>Manage</strong> button next to the functionality you want to enable, configure any available options then click <strong>Upload</strong>. To disable/remove the module click on <strong>Manage</strong> then click on <strong>Disable</strong>.',
    ];
    $data['modules'] = [
      '#type' => 'table',
      '#header' => [
        t('Module'),
        t('Description'),
        t('Status'),
        t('Operations'),
      ],
    ];
    foreach (FastlyEdgeModulesHelper::getModules() as $id => $module) {
      $data['modules'][$id]['label'] = [
        '#plain_text' => $module['name'],
      ];
      $data['modules'][$id]['description'] = [
        '#plain_text' => $module['description'],
      ];
      $data['modules'][$id]['status'] = [
        '#plain_text' => t('Disabled'),
      ];
      foreach ($snippets as $snippet) {
        if (substr($snippet->name, 0, strlen(FastlyEdgeModulesHelper::FASTLY_EDGE_MODULE_PREFIX . $id)) === FastlyEdgeModulesHelper::FASTLY_EDGE_MODULE_PREFIX . $id) {
          $date = DrupalDateTime::createFromFormat("Y-m-d\\TH:i:s\\Z", $snippet->updated_at);
          $data['modules'][$id]['status'] = [
            '#markup' => t('Enabled') . '<br>',
          ];
          $data['modules'][$id]['status'][] = [
            '#markup' => '<small><i>' . t('Uploaded: ') . $date
              ->format('Y/m/d') . '</i></small>',
          ];
        }
      }
      $data['modules'][$id]['operations'] = [
        '#type' => 'operations',
        '#links' => [],
      ];
      if (isset($module['vcl'])) {
        $data['modules'][$id]['operations']['#links']['edit'] = [
          'title' => 'Manage',
          'url' => Url::fromRoute('fastly.get_module_form', [
            'module' => $id,
          ]),
          'attributes' => [
            'class' => [
              'use-ajax',
            ],
            'data-dialog-type' => 'modal',
            'data-dialog-options' => Json::encode([
              'width' => '40%',
            ]),
          ],
        ];
      }
    }
    return $data;
  }

  /**
   * Get module Form.
   *
   * @param $module
   * @return array
   */
  public function getModuleForm($module) {
    $modules = explode('_', $module);
    foreach ($modules as $key => $module) {
      $modules[$key] = ucfirst($module);
    }
    $string = implode("", $modules);
    return $this
      ->formBuilder()
      ->getForm('\\Drupal\\fastly\\Form\\' . $string . 'Form');
  }

  /**
   * Title callback.
   *
   * @param $module
   * @return array
   */
  public function titleCallback($module) {
    $moduleConfig = FastlyEdgeModulesHelper::getModules();
    return $moduleConfig[$module]['name'];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
FastlyEdgeModulesController::$api protected property
FastlyEdgeModulesController::$fileSystem protected property
FastlyEdgeModulesController::$messenger protected property Overrides MessengerTrait::$messenger
FastlyEdgeModulesController::$vclHandler protected property
FastlyEdgeModulesController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
FastlyEdgeModulesController::getEdgeModules public function List all edge modules
FastlyEdgeModulesController::getModuleForm public function Get module Form.
FastlyEdgeModulesController::titleCallback public function Title callback.
FastlyEdgeModulesController::__construct public function FastlyEdgeModulesController constructor.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.