‪TYPO3CMS  ‪main
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Frontend\Controller\ShowImageController Class Reference

Public Member Functions

 initialize ()
 
 main ()
 
ResponseInterface processRequest (ServerRequestInterface $request)
 

Protected Member Functions

TYPO3 CMS Core Resource ProcessedFile processImage ()
 
 isFileValid (FileInterface $file)
 

Protected Attributes

const ALLOWED_PARAMETER_NAMES = ['width', 'height', 'crop', 'bodyTag', 'title']
 
Psr Http Message ServerRequestInterface $request
 
File Folder null $file
 
string $width
 
int $height
 
string $crop
 
int $frame
 
string $bodyTag = '<body>'
 
string $title = 'Image'
 
string $content =
 
string $imageTag = '<img src="###publicUrl###" alt="###alt###" title="###title###" width="###width###" height="###height###" />'
 

Detailed Description

eID-Script "tx_cms_showpic"

Shows a picture from FAL in enlarged format in a separate window. Picture file and settings is supplied by GET-parameters:

  • ‪file = fileUid or Combined Identifier
  • ‪encoded in a parameter Array (with weird format - see ContentObjectRenderer about ll. 1500)
  • ‪width, height = usual width an height, m/c supported
  • ‪frame
  • ‪bodyTag
  • ‪title

this is a concrete TYPO3 implementation and solely used for EXT:frontend and not part of TYPO3's Core API.

Definition at line 49 of file ShowImageController.php.

Member Function Documentation

◆ initialize()

TYPO3\CMS\Frontend\Controller\ShowImageController::initialize ( )

Init function, setting the input vars in the global space.

Exceptions

Definition at line 110 of file ShowImageController.php.

References TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), and TYPO3\CMS\Frontend\Controller\ShowImageController\isFileValid().

Referenced by TYPO3\CMS\Frontend\Controller\ShowImageController\processRequest().

◆ isFileValid()

TYPO3\CMS\Frontend\Controller\ShowImageController::isFileValid ( FileInterface  $file)
protected

Definition at line 220 of file ShowImageController.php.

References TYPO3\CMS\Frontend\Controller\ShowImageController\$file, TYPO3\CMS\Core\Resource\AbstractFile\getIdentifier(), and TYPO3\CMS\Core\Resource\AbstractFile\getStorage().

Referenced by TYPO3\CMS\Frontend\Controller\ShowImageController\initialize().

◆ main()

TYPO3\CMS\Frontend\Controller\ShowImageController::main ( )

Main function which creates the image if needed and outputs the HTML code for the page displaying the image. Accumulates the content in $this->content

Definition at line 156 of file ShowImageController.php.

References TYPO3\CMS\Frontend\Controller\ShowImageController\$bodyTag, TYPO3\CMS\Frontend\Controller\ShowImageController\$imageTag, TYPO3\CMS\Frontend\Controller\ShowImageController\$title, and TYPO3\CMS\Frontend\Controller\ShowImageController\processImage().

Referenced by TYPO3\CMS\Frontend\Controller\ShowImageController\processRequest().

◆ processImage()

TYPO3 CMS Core Resource ProcessedFile TYPO3\CMS\Frontend\Controller\ShowImageController::processImage ( )
protected

Does the actual image processing

Returns
‪\TYPO3\CMS\Core\Resource\ProcessedFile

Definition at line 181 of file ShowImageController.php.

References TYPO3\CMS\Frontend\Controller\ShowImageController\$crop, TYPO3\CMS\Frontend\Controller\ShowImageController\$frame, TYPO3\CMS\Frontend\Controller\ShowImageController\$height, TYPO3\CMS\Frontend\Controller\ShowImageController\$width, TYPO3\CMS\Core\Resource\ProcessedFile\CONTEXT_IMAGECROPSCALEMASK, and TYPO3\CMS\Core\Utility\MathUtility\forceIntegerInRange().

Referenced by TYPO3\CMS\Frontend\Controller\ShowImageController\main().

◆ processRequest()

ResponseInterface TYPO3\CMS\Frontend\Controller\ShowImageController::processRequest ( ServerRequestInterface  $request)

Fetches the content and builds a content file out of it

Parameters
ServerRequestInterface$request‪the current request object
Returns
‪ResponseInterface the modified response

Definition at line 202 of file ShowImageController.php.

References TYPO3\CMS\Frontend\Controller\ShowImageController\$request, TYPO3\CMS\Frontend\Controller\ShowImageController\initialize(), and TYPO3\CMS\Frontend\Controller\ShowImageController\main().

Member Data Documentation

◆ $bodyTag

string TYPO3\CMS\Frontend\Controller\ShowImageController::$bodyTag = '<body>'
protected

Definition at line 79 of file ShowImageController.php.

Referenced by TYPO3\CMS\Frontend\Controller\ShowImageController\main().

◆ $content

string TYPO3\CMS\Frontend\Controller\ShowImageController::$content =
protected

Definition at line 87 of file ShowImageController.php.

◆ $crop

string TYPO3\CMS\Frontend\Controller\ShowImageController::$crop
protected

Definition at line 71 of file ShowImageController.php.

Referenced by TYPO3\CMS\Frontend\Controller\ShowImageController\processImage().

◆ $file

File Folder null TYPO3\CMS\Frontend\Controller\ShowImageController::$file
protected

Definition at line 59 of file ShowImageController.php.

Referenced by TYPO3\CMS\Frontend\Controller\ShowImageController\isFileValid().

◆ $frame

int TYPO3\CMS\Frontend\Controller\ShowImageController::$frame
protected

Definition at line 75 of file ShowImageController.php.

Referenced by TYPO3\CMS\Frontend\Controller\ShowImageController\processImage().

◆ $height

int TYPO3\CMS\Frontend\Controller\ShowImageController::$height
protected

Definition at line 67 of file ShowImageController.php.

Referenced by TYPO3\CMS\Frontend\Controller\ShowImageController\processImage().

◆ $imageTag

string TYPO3\CMS\Frontend\Controller\ShowImageController::$imageTag = '<img src="###publicUrl###" alt="###alt###" title="###title###" width="###width###" height="###height###" />'
protected

Definition at line 102 of file ShowImageController.php.

Referenced by TYPO3\CMS\Frontend\Controller\ShowImageController\main().

◆ $request

Psr Http Message ServerRequestInterface TYPO3\CMS\Frontend\Controller\ShowImageController::$request
protected

Definition at line 55 of file ShowImageController.php.

Referenced by TYPO3\CMS\Frontend\Controller\ShowImageController\processRequest().

◆ $title

string TYPO3\CMS\Frontend\Controller\ShowImageController::$title = 'Image'
protected

Definition at line 83 of file ShowImageController.php.

Referenced by TYPO3\CMS\Frontend\Controller\ShowImageController\main().

◆ $width

string TYPO3\CMS\Frontend\Controller\ShowImageController::$width
protected

Definition at line 63 of file ShowImageController.php.

Referenced by TYPO3\CMS\Frontend\Controller\ShowImageController\processImage().

◆ ALLOWED_PARAMETER_NAMES

const TYPO3\CMS\Frontend\Controller\ShowImageController::ALLOWED_PARAMETER_NAMES = ['width', 'height', 'crop', 'bodyTag', 'title']
protected

Definition at line 51 of file ShowImageController.php.