Documentation

MediaBrowser extends EntityBase
in package

Class MediaBrowser

Tags
copyright

Cloudrexx AG

author

Robin Glauser robin.glauser@comvation.com

Table of Contents

Properties

$callingSystemComponentController  : SystemComponentController
The SystemComponentController that did instanciate this MediaBrowser instance.
$entity  : string
$localeCodes  : array<string|int, mixed>
List of locale codes ordered by translation fallback order per Cx instance
$nestingCount  : int
Counts the nesting level of __call()
$options  : array<string|int, mixed>
The set options for the mediabrowser
$optionValues  : mixed
$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
$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
Create new instance of mediabrowser and register in componentcontroller.
__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
addClass()  : self
Add a class to the button
getComponentController()  : SystemComponent
Returns the component controller for this component
getImageChooserMarkup()  : string
Returns the markup to show an image chooser form element with preview
getKeyAsString()  : string
Returns this entity's key
getOption()  : string
Get a option
getOptionsString()  : string
Get all Options as a String
getTranslatedFieldValue()  : mixed
Returns the value of a translatable field using fallback mechanisms
getXHtml()  : string
Get the rendered mediabrowser button
initializeValidators()  : mixed
Set $this->validators
isVirtual()  : bool
Returns the virtuality of the entity
setCallback()  : mixed
Set a Javascript callback when the modal gets closed
setOptions()  : mixed
Set a mediabrowser option
setVirtual()  : mixed
Set the virtuality of the entity
validate()  : mixed
addOption()  : mixed
getFallbackLocaleCodes()  : array<string|int, mixed>
Returns a list of all locale codes ordered by fallback order
getFileWithFallback()  : FileInterface
Handles cleanup/sanitation for FileInterface instances or file path variables
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

Properties

$callingSystemComponentController

The SystemComponentController that did instanciate this MediaBrowser instance.

protected SystemComponentController $callingSystemComponentController

SystemComponentController that instanciated this MediaBrowser instance

$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

$options

The set options for the mediabrowser

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

$optionValues

protected static mixed $optionValues = ['views', 'startview', 'startmediatype', 'mediatypes', 'multipleselect', 'modalopened', 'modalclosed']

$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()

Create new instance of mediabrowser and register in componentcontroller.

public __construct([SystemComponentController $systemComponentController = null ][, string $entity = '' ]) : mixed

If $systemComponentController is not specified, the call trace is searched for the component calling this constructor.

Parameters
$systemComponentController : SystemComponentController = null

(optional) ComponentController of the component that uses the object generated by this constructor

$entity : string = ''

MediaBrowser instantiated with optional entity

Tags
throws
MediaBrowserException

If no $systemComponentController is provided and none can be found

__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

addClass()

Add a class to the button

public addClass(mixed $class) : self
Parameters
$class : mixed
Return values
self

getImageChooserMarkup()

Returns the markup to show an image chooser form element with preview

public getImageChooserMarkup(string $fieldName, FileInterface|string $imagePath[, string $startMediaType = 'files' ][, string $mediaTypes = 'all' ][, string $startView = 'filebrowser' ][, string $views = 'filebrowser,uploader' ][, FileInterface|string $imagePlaceholderPath = '' ][, FileInterface|string $imageThumbnailPath = '' ]) : string

Automatically displays a thumbnail of the supplied image if available.

For MediaBrowser options see Mediabrowser options

Parameters
$fieldName : string

Name of the form field to contain the selected image src

$imagePath : FileInterface|string
$startMediaType : string = 'files'

(optional) Media type to start MediaBrowser with

$mediaTypes : string = 'all'

(optional) Media types available in MediaBrowser

$startView : string = 'filebrowser'

(optional) View to start MediaBrowser with

$views : string = 'filebrowser,uploader'

(optional) Views to show in MediaBrowser

$imagePlaceholderPath : FileInterface|string = ''
$imageThumbnailPath : FileInterface|string = ''
Return values
string —

HTML code

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

getOption()

Get a option

public getOption(mixed $option) : string
Parameters
$option : mixed
Return values
string

getOptionsString()

Get all Options as a String

public getOptionsString() : string
Return values
string

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

getXHtml()

Get the rendered mediabrowser button

public getXHtml([string $buttonName = "MediaBrowser" ]) : string
Parameters
$buttonName : string = "MediaBrowser"
Return values
string

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

setCallback()

Set a Javascript callback when the modal gets closed

public setCallback(mixed $callback) : mixed
Parameters
$callback : mixed

array Callback function name

setOptions()

Set a mediabrowser option

public setOptions(mixed $options) : mixed
Parameters
$options : mixed

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

addOption()

protected addOption(mixed $optionName, mixed $value) : mixed
Parameters
$optionName : mixed
$value : mixed

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

getFileWithFallback()

Handles cleanup/sanitation for FileInterface instances or file path variables

protected getFileWithFallback(FileInterface|string $file, FileInterface $fallbackFile) : FileInterface

If $file is a string it's converted to a FileInterface instance. If the file does not exist (or the file path was empty) the fallback file is used instead.

Parameters
$file : FileInterface|string

The file to sanitize

$fallbackFile : FileInterface

The FileInterface instance to use as fallback

Return values
FileInterface —

The resulting FileInterface instance

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