class ClientModuleController in farmOS 2.x

Serves JavaScript files for client modules.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\farm_client\Controller\ClientModuleController

File

modules/core/client/src/Controller/ClientModuleController.php, line 15

Namespace

Drupal\farm_client\Controller

class ClientModuleController extends ControllerBase {

  /**
   * The library discovery service.
   *
   * @var \Drupal\Core\Asset\LibraryDiscoveryInterface
   */
  protected $libraryDiscovery;

  /**
   * ClientModuleController constructor.
   *
   * @param \Drupal\Core\Asset\LibraryDiscoveryInterface $library_discovery
   *   The library discovery service.
   */
  public function __construct(LibraryDiscoveryInterface $library_discovery) {
    $this->libraryDiscovery = $library_discovery;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('library.discovery'));
  }

  /**
   * Returns the ClientModule JS.
   *
   * @param \Drupal\farm_client\Entity\ClientModuleInterface $client_module
   *   The ClientModule config entity.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *   A response containing the ClientModule JS or a 422 error response.
   */
  public function index(ClientModuleInterface $client_module) {

    // Get the client module library.
    $library = $client_module
      ->getLibrary();
    [
      $extension,
      $name,
    ] = explode('/', $library, 2);
    $definition = $this->libraryDiscovery
      ->getLibraryByName($extension, $name);

    // Bail if no JS library is provided.
    if (empty($definition['js'])) {
      throw new UnprocessableEntityHttpException('The client module does not have a valid JS library configured.');
    }

    // Try loading the raw JS data.
    $raw = file_get_contents($definition['js'][0]['data']);
    if (empty($raw)) {
      throw new UnprocessableEntityHttpException('The client module JS library could not be loaded.');
    }

    // Return a response with the JS asset.
    $response = new Response();
    $response->headers
      ->set('Content-Type', 'application/javascript; utf-8');
    $response
      ->setContent($raw);
    return $response;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ClientModuleController::$libraryDiscovery	protected	property	The library discovery service.
ClientModuleController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
ClientModuleController::index	public	function	Returns the ClientModule JS.
ClientModuleController::__construct	public	function	ClientModuleController constructor.
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::$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::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.
ControllerBase::state	protected	function	Returns the state storage 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.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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.	4
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.