class ThemeCompilerController in Theme Compiler 8

Defines the theme compiler controller.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\theme_compiler\Controller\ThemeCompilerController implements ThemeCompilerControllerInterface

1 string reference to 'ThemeCompilerController'

theme_compiler.services.yml in ./theme_compiler.services.yml

theme_compiler.services.yml

1 service uses ThemeCompilerController

theme_compiler.controller in ./theme_compiler.services.yml

Drupal\theme_compiler\Controller\ThemeCompilerController

File

src/Controller/ThemeCompilerController.php, line 16

Namespace

Drupal\theme_compiler\Controller

class ThemeCompilerController extends ControllerBase implements ThemeCompilerControllerInterface {

  /**
   * The theme compiler plugin manager service provided by this module.
   *
   * @var \Drupal\theme_compiler\Plugin\ThemeCompilerPluginManager
   */
  protected $compilerPluginManager;

  /**
   * Drupal's configuration factory service.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * Constructs a ThemeCompilerController.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   Drupal's configuration factory service.
   * @param \Drupal\theme_compiler\Plugin\ThemeCompilerPluginManager $compiler_plugin_manager
   *   The theme compiler plugin manager service provided by this module.
   */
  public function __construct(ConfigFactoryInterface $config_factory, ThemeCompilerPluginManager $compiler_plugin_manager) {
    $this->compilerPluginManager = $compiler_plugin_manager;
    $this->configFactory = $config_factory;
  }

  /**
   * {@inheritdoc}
   */
  public function serve(ThemeCompilerTargetContext $context) {

    // Retrieve the compiler configured for this target context.
    $compiler = $context
      ->getCompiler();

    // Attempt to load the specified compiler plugin using the target context.
    if ($plugin = $this->compilerPluginManager
      ->createInstance($compiler)) {

      // Delegate this controller method to the compiler plugin.
      $response = $plugin
        ->serve($context);

      // Fetch the theme's configuration so that it can be added as a cacheable
      // dependency to the response.
      $global = $this->configFactory
        ->get('system.theme.global');
      $theme = $this->configFactory
        ->get("{$context->getTheme()}.settings");

      // Configure additional cacheability metadata common to all responses.
      $response
        ->getCacheableMetadata()
        ->addCacheableDependency($global)
        ->addCacheableDependency($theme)
        ->addCacheTags([
        'theme_compiler',
        "theme_compiler:{$context->getTheme()}",
        "theme_compiler:{$context->getTheme()}.{$context->getCompiler()}",
      ]);
      return $response;
    }

    // If the plugin can't be found, return an error code for this request.
    return new CacheableResponse('', CacheableResponse::HTTP_NOT_FOUND);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	40
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.
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	protected	property	The messenger.	29
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.
ThemeCompilerController::$compilerPluginManager	protected	property	The theme compiler plugin manager service provided by this module.
ThemeCompilerController::$configFactory	protected	property	Drupal's configuration factory service. Overrides ControllerBase::$configFactory
ThemeCompilerController::serve	public	function	Compiles and serves a response containing the requested compiler target. Overrides ThemeCompilerPluginInterface::serve
ThemeCompilerController::__construct	public	function	Constructs a ThemeCompilerController.
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.