class ImceController in FileField Sources 8

Controller routines for imce routes.

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\filefield_sources\Controller\ImceController

Expanded class hierarchy of ImceController

File

src/Controller/ImceController.php, line 15

Namespace

Drupal\filefield_sources\Controller

View source

class ImceController extends ControllerBase {

  /**
   * @var Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;
  public static function create(ContainerInterface $container) {
    $instance = new static();
    $instance->entityTypeManager = $container
      ->get('entity_type.manager');

    // $instance->connection = $container->get('');
    return $instance;
  }

  /**
   * Outputs the IMCE browser for FileField.
   */
  public function page($entity_type, $bundle_name, $field_name, Request $request) {

    // Check access.
    if (!\Drupal::moduleHandler()
      ->moduleExists('imce') || !Imce::access() || !($instance = $this->entityTypeManager
      ->getStorage('field_config')
      ->load($entity_type . '.' . $bundle_name . '.' . $field_name))) {
      throw new AccessDeniedHttpException();
    }
    $settings = $instance
      ->getSettings();
    $imceFM = Imce::userFM(\Drupal::currentUser(), $settings['uri_scheme'], $request);

    // Override scanner.
    if (!empty($imceFM)) {
      $scanner = \Drupal::service('filefield_sources.imce_scanner');
      $widget = $this->entityTypeManager
        ->getStorage('entity_form_display')
        ->load($entity_type . '.' . $bundle_name . '.' . 'default');

      // Full mode.
      if (!empty($widget['third_party_settings']['filefield_sources']['filefield_sources']['source_imce']['imce_mode'])) {
        $imceFM
          ->setConf('scanner', [
          $scanner,
          'customScanFull',
        ]);

        // Set context.
        $scanner
          ->setContext([
          'scheme' => $imceFM
            ->getConf('scheme'),
        ]);
      }
      else {
        $imceFM
          ->setConf('scanner', [
          $scanner,
          'customScanRestricted',
        ]);

        // Make field directory the only accessible one.
        $field_uri = static::getUploadLocation($settings);
        static::disablePerms($imceFM, $field_uri, [
          'browse_files',
        ]);

        // Set context.
        $scanner
          ->setContext([
          'entity_type' => $entity_type,
          'field_name' => $field_name,
          'uri' => $field_uri,
          'is_rool' => $is_root,
        ]);
      }

      // Disable absolute URLs.
      \Drupal::configFactory()
        ->getEditable('imce.settings')
        ->set('abs_urls', FALSE);
      return $imceFM
        ->pageResponse();
    }
  }

  /**
   * Determines the URI for a file field.
   *
   * @param array $data
   *   An array of token objects to pass to token_replace().
   *
   * @return string
   *   A file directory URI with tokens replaced.
   *
   * @see token_replace()
   */
  protected static function getUploadLocation($settings, $data = []) {
    $destination = trim($settings['file_directory'], '/');

    // Replace tokens. To ensure that render context is empty, pass a bubbleable
    // metadata object to the replace method.
    $bubbleable_metadata = new BubbleableMetadata();
    $destination = \Drupal::token()
      ->replace($destination, $data, [], $bubbleable_metadata);
    return $settings['uri_scheme'] . '://' . $destination;
  }

  /**
   * Disable IMCE profile permissions.
   */
  protected static function disablePerms($imceFM, $field_uri, $exceptions = []) {
    $scheme = $imceFM
      ->getConf('scheme');
    $root = $scheme . '://';
    $is_root = $field_uri == $root;
    $path = $is_root ? '.' : substr($field_uri, strlen($root));
    $folders = $imceFM
      ->getConf('folders');
    $perms = \Drupal::service('plugin.manager.imce.plugin')
      ->permissionInfo();
    $folders['.']['permissions']['all'] = FALSE;
    $folders[$path]['permissions']['all'] = FALSE;
    foreach ($perms as $perm => $title) {
      $folders['.']['permissions'][$perm] = FALSE;
      $folders[$path]['permissions'][$perm] = in_array($perm, [
        'browse_files',
      ]) ? TRUE : FALSE;
    }
    $imceFM
      ->setConf('folders', $folders);
  }

}

Members

Name	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::$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.
ImceController::$entityTypeManager	protected	property	Overrides ControllerBase::$entityTypeManager
ImceController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
ImceController::disablePerms	protected static	function	Disable IMCE profile permissions.
ImceController::getUploadLocation	protected static	function	Determines the URI for a file field.
ImceController::page	public	function	Outputs the IMCE browser for FileField.
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.
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.

You are here

class ImceController in FileField Sources 8

Hierarchy

File

Namespace

Members

API Navigation