FileAccessFormatterControlHandlerInterface.php

Same filename in other branches
  1. 9 core/modules/file/src/FileAccessFormatterControlHandlerInterface.php
  2. 8.9.x core/modules/file/src/FileAccessFormatterControlHandlerInterface.php
  3. 10 core/modules/file/src/FileAccessFormatterControlHandlerInterface.php

Namespace

Drupal\file

File

core/modules/file/src/FileAccessFormatterControlHandlerInterface.php

View source
<?php

namespace Drupal\file;

use Drupal\Core\Entity\EntityAccessControlHandlerInterface;

/**
 * Defines an interface for file access handlers that need to run on file formatters.
 *
 * \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase,
 * which file and image formatters extend, checks 'view' access on the
 * referenced files before displaying them. That check would be useless and
 * costly with Core's default access control implementation for files
 * (\Drupal\file\FileAccessControlHandler grants access based on whether
 * there are existing entities with granted access that reference the file). But
 * it might be needed if a different access control handler with different logic
 * is swapped in.
 *
 * \Drupal\file\Plugin\Field\FieldFormatter\FileFormatterBase thus adjusts that
 * behavior, and only checks access if the access control handler in use for
 * files opts in by implementing this interface.
 *
 * @see \Drupal\file\Plugin\Field\FieldFormatter\FileFormatterBase::needsAccessCheck()
 */
interface FileAccessFormatterControlHandlerInterface extends EntityAccessControlHandlerInterface {

}

Interfaces

Title Deprecated Summary
FileAccessFormatterControlHandlerInterface Defines an interface for file access handlers that need to run on file formatters.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.