CKFinder 3 – PHP Connector Documentation
Thumbnail Class Reference
Inheritance diagram for Thumbnail:
ResizedImageAbstract

Public Member Functions

 __construct (ThumbnailRepository $thumbnailRepository, ResourceType $sourceFileResourceType, $sourceFileDir, $sourceFileName, $requestedWidth, $requestedHeight)
 
 getDirectory ()
 
 create ()
 
- Public Member Functions inherited from ResizedImageAbstract
 __construct (ResourceType $sourceFileResourceType, string $sourceFileDir, string $sourceFileName, int $requestedWidth, int $requestedHeight)
 
 getResourceType ()
 
 getFileName ()
 
 getFilePath ()
 
 getMimeType ()
 
 getTimestamp ()
 
 getSize ()
 
 getImageData ()
 
 setImageData ($imageData)
 
 exists ()
 
 save ()
 
 load ()
 
 readStream ()
 
 create ()
 
 getDirectory ()
 

Protected Member Functions

 adjustDimensions ()
 

Protected Attributes

 $thumbnailRepository
 
 $adjustedSizeInfo
 
- Protected Attributes inherited from ResizedImageAbstract
 $sourceFileResourceType
 
 $backend
 
 $sourceFileDir
 
 $sourceFileName
 
 $requestedWidth
 
 $requestedHeight
 
 $resizedImageFileName
 
 $resizedImageData
 
 $resizedImageSize
 
 $resizedImageMimeType
 
 $timestamp
 
ExtensionMimeTypeDetector $mimeTypeDetector
 

Detailed Description

The Thumbnail class.

A class representing a thumbnail.

Constructor & Destructor Documentation

◆ __construct()

__construct ( ThumbnailRepository  $thumbnailRepository,
ResourceType  $sourceFileResourceType,
  $sourceFileDir,
  $sourceFileName,
  $requestedWidth,
  $requestedHeight 
)
Parameters
string$sourceFileDir
string$sourceFileName
int$requestedWidth
int$requestedHeight

Member Function Documentation

◆ adjustDimensions()

adjustDimensions ( )
protected

Adjusts thumbnail dimensions.

Dimensions passed in $requestedWidth and $requestedHeight are adjusted to one of the allowed sizes. The smallest allowed thumbnail size that is bigger than the requested one is used.

◆ create()

create ( )

Creates a thumbnail.

Returns
bool
Exceptions

Exception

Reimplemented from ResizedImageAbstract.

◆ getDirectory()

getDirectory ( )

Returns backend-relative thumbnails directory.

Returns
string

Reimplemented from ResizedImageAbstract.


The documentation for this class was generated from the following file: