Documentation

ThumbnailGenerator extends EntityBase
in package

Class ThumbnailGenerator

Tags
copyright

Cloudrexx AG

author

Robin Glauser robin.glauser@comvation.com

Table of Contents

Properties

$cx  : Cx
$localeCodes  : array<string|int, mixed>
List of locale codes ordered by translation fallback order per Cx instance
$mediaSourceManager  : MediaSourceManager
$nestingCount  : int
Counts the nesting level of __call()
$stringRepresentationBlank  : bool
Whether blank string representations are valid
$stringRepresentationFields  : array<string|int, mixed>
List of fields that should be available in the string representation
$stringRepresentationFormat  : string
Sprintf format for the string representation
$thumbnails  : array<string|int, mixed>
List with thumbnails
$validators  : array<string|int, mixed>
Initialize this array as follows: array( 'columName' => Zend_Validate )
$virtual  : bool
Defines if an entity is virtual and therefore not persistable.

Methods

__call()  : mixed
Route methods like getName(), getType(), getDirectory(), etc.
__construct()  : mixed
ThumbnailGenerator constructor.
__get()  : mixed
This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.
__toString()  : string
Returns this entity's identifying value
createThumbnail()  : array<string|int, mixed>
Create the thumbnails for an image file
createThumbnailFromPath()  : array<string|int, mixed>
Create thumbnail images for the given original path
getComponentController()  : SystemComponent
Returns the component controller for this component
getKeyAsString()  : string
Returns this entity's key
getThumbnailFilename()  : string
Return the thumbnail file path of the smallest size
getThumbnails()  : array<string|int, mixed>
Get Thumbnails from database
getThumbnailsFromFile()  : array<string|int, mixed>
Return the path of thumbnail images for all known sizes
getTranslatedFieldValue()  : mixed
Returns the value of a translatable field using fallback mechanisms
initializeValidators()  : mixed
Set $this->validators
isVirtual()  : bool
Returns the virtuality of the entity
setVirtual()  : mixed
Set the virtuality of the entity
validate()  : mixed
getFallbackLocaleCodes()  : array<string|int, mixed>
Returns a list of all locale codes ordered by fallback order
getStringRepresentationBlank()  : bool
Whether blank string representations are valid
getStringRepresentationFields()  : array<string|int, mixed>
Returns a list of fields available in the string representation
getStringRepresentationFormat()  : string
Returns the sprintf() format for the string representation
loadThumbnails()  : mixed
Loads thumbnails from database

Properties

$localeCodes

List of locale codes ordered by translation fallback order per Cx instance

protected static array<string|int, mixed> $localeCodes = array()

Array in the form: array(<instanceId> => array(<localeCode>, ...))

Tags
see
getFallbackLocaleCodes()

$nestingCount

Counts the nesting level of __call()

protected static int $nestingCount = 0

$stringRepresentationBlank

Whether blank string representations are valid

protected bool $stringRepresentationBlank = false

Whether blank string representations are valid

Tags
see
getStringRepresentationBlank()

$stringRepresentationFields

List of fields that should be available in the string representation

protected array<string|int, mixed> $stringRepresentationFields = array()

List of field names

Tags
see
getStringRepresentationFields()

$stringRepresentationFormat

Sprintf format for the string representation

protected string $stringRepresentationFormat = ''

Sprintf format string

Tags
see
getStringRepresentationFormat()

$validators

Initialize this array as follows: array( 'columName' => Zend_Validate )

protected array<string|int, mixed> $validators = array()

$virtual

Defines if an entity is virtual and therefore not persistable.

protected bool $virtual = false

Defaults to FALSE - not virtual.

Methods

__call()

Route methods like getName(), getType(), getDirectory(), etc.

public __call(string $methodName, array<string|int, mixed> $arguments) : mixed
Parameters
$methodName : string

Name of method to call

$arguments : array<string|int, mixed>

List of arguments for the method to call

Tags
throws
Exception

If __call() nesting level reaches 20

Attributes
#[ReturnTypeWillChange]
Return values
mixed —

Return value of the method to call

__construct()

ThumbnailGenerator constructor.

public __construct(mixed $cx, mixed $mediaSourceManager) : mixed
Parameters
$cx : mixed

Cx

$mediaSourceManager : mixed

MediaSourceManager

__get()

This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.

public __get(mixed $name) : mixed
Parameters
$name : mixed
Attributes
#[ReturnTypeWillChange]

__toString()

Returns this entity's identifying value

public __toString() : string

By default this returns the same as getKeyAsString(), but this method might get overridden by subclasses.

Return values
string —

Identifying value for this entity

createThumbnail()

Create the thumbnails for an image file

public createThumbnail(string $path, string $fileNamePlain, string $fileExtension, ImageManager $imageManager[, bool $generateThumbnailByRatio = false ][, bool $force = false ]) : array<string|int, mixed>

Returns an array of thumbnail image file names, without any folder path. For SVG images, returns an array with the original file name. Example:

Parameters
$path : string

Virtual or absolute path to the file

$fileNamePlain : string

Base file name, without extension

$fileExtension : string

File extension

$imageManager : ImageManager
$generateThumbnailByRatio : bool = false
$force : bool = false
Return values
array<string|int, mixed> —

Thumbnail file names

createThumbnailFromPath()

Create thumbnail images for the given original path

public createThumbnailFromPath(string $filePath[, bool $force = false ]) : array<string|int, mixed>

Returns the result of calling createThumbnail().

Parameters
$filePath : string
$force : bool = false

Defaults to false

Return values
array<string|int, mixed>

getKeyAsString()

Returns this entity's key

public final getKeyAsString([string $separator = '/' ]) : string

If this entity has a composite key, the fields are separated by $separator.

Parameters
$separator : string = '/'

(optional) Separator for composite key fields, default "/"

Return values
string —

Entity key as string

getThumbnailFilename()

Return the thumbnail file path of the smallest size

public getThumbnailFilename(string $file) : string

Returns the original path for SVG images.

Parameters
$file : string

File path

Return values
string —

Thumbnail file path

getThumbnails()

Get Thumbnails from database

public getThumbnails() : array<string|int, mixed>
Return values
array<string|int, mixed>

getThumbnailsFromFile()

Return the path of thumbnail images for all known sizes

public getThumbnailsFromFile(string $path, string $filename[, bool $create = false ][, bool $rebuild = false ]) : array<string|int, mixed>

For SVG images, returns the original path for all sizes.

Parameters
$path : string

Folder path

$filename : string

File name

$create : bool = false

Create missing thumbnails if true

$rebuild : bool = false

If $create is true, recreate existing ones

Return values
array<string|int, mixed> —

thumbnail name array

getTranslatedFieldValue()

Returns the value of a translatable field using fallback mechanisms

public getTranslatedFieldValue(string $fieldName) : mixed

If the field is not translatable its value is returned anyway. Tries to return the value in the following locales (if non-empty):

  • Current locale
  • Default locale
  • All other locales
Parameters
$fieldName : string

Name of a translatable field

initializeValidators()

Set $this->validators

public initializeValidators() : mixed

Validators can be found in lib/FRAMEWORK/Validator.class.php These will be executed if validate() is called

isVirtual()

Returns the virtuality of the entity

public isVirtual() : bool
Return values
bool —

TRUE if the entity is virtual, otherwise FALSE

setVirtual()

Set the virtuality of the entity

public setVirtual(bool $virtual) : mixed
Parameters
$virtual : bool

TRUE to set the entity as virtual or otherwise to FALSE

getFallbackLocaleCodes()

Returns a list of all locale codes ordered by fallback order

protected getFallbackLocaleCodes() : array<string|int, mixed>
  • First entry is the current locale
  • Second entry is the default locale (if different from current, it's omitted otherwise)
  • Then all other locales follow (in no particular order)
Tags
todo

Order the array by the fallback order (same as in ContentManager)

Return values
array<string|int, mixed> —

List of locale codes

getStringRepresentationBlank()

Whether blank string representations are valid

protected getStringRepresentationBlank() : bool
Return values
bool —

Whether blank string representations are valid

getStringRepresentationFields()

Returns a list of fields available in the string representation

protected getStringRepresentationFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —

List of field names

getStringRepresentationFormat()

Returns the sprintf() format for the string representation

protected getStringRepresentationFormat() : string
Return values
string —

sprintf() format string


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results