typo3/sysext/core/Classes/Resource/Hook/FileDumpEIDHookInterface.php

   1 <?php
   2 namespace TYPO3\CMS\Core\Resource\Hook;
   3
   4 /*
   5  * This file is part of the TYPO3 CMS project.
   6  *
   7  * It is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU General Public License, either version 2
   9  * of the License, or any later version.
  10  *
  11  * For the full copyright and license information, please read the
  12  * LICENSE.txt file that was distributed with this source code.
  13  *
  14  * The TYPO3 project - inspiring people to share!
  15  */
  16
  17 use Psr\Http\Message\ResponseInterface;
  18
  19 /**
  20  * Interface for FileDumpEID Hook to perform some custom security/access checks
  21  * when accessing file thought FileDumpEID
  22  */
  23 interface FileDumpEIDHookInterface
  24 {
  25     /**
  26      * Perform custom security/access when accessing file
  27      * Method should issue 403 if access is rejected
  28      * or 401 if authentication is required via an authorized HTTP authorization scheme.
  29      * A 401 header must be accompanied by a www-authenticate header!
  30      *
  31      * @param \TYPO3\CMS\Core\Resource\ResourceInterface $file
  32      * @return ResponseInterface|null
  33      */
  34     public function checkFileAccess(\TYPO3\CMS\Core\Resource\ResourceInterface $file);
  35 }