Documentation

MediaSourceManager extends EntityBase
in package

Class MediaSourceManager

Tags
copyright

Cloudrexx AG

author

Tobias Schmoker tobias.schmoker@comvation.com

author

Robin Glauser robin.glauser@comvation.com

subpackage

core_mediasource

Table of Contents

Properties

$allMediaTypePaths  : array<string|int, MediaSource>
$cx  : Cx
$localeCodes  : array<string|int, mixed>
List of locale codes ordered by translation fallback order per Cx instance
$lockedMediaTypes  : mixed
$mediaTypePaths  : array<string|int, mixed>
$mediaTypes  : mixed
$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
$thumbnailGenerator  : ThumbnailGenerator
$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
__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
addMediaType()  : mixed
checkPermissions()  : bool
Checks permission
getAbsolutePath()  : string
Get the absolute path from the virtual path.
getAllMediaTypePaths()  : mixed
getComponentController()  : SystemComponent
Returns the component controller for this component
getKeyAsString()  : string
Returns this entity's key
getLockedMediaType()  : MediaSource
Returns all MediaSources the current user does not have access to
getMediaSourceByComponent()  : MediaSource
Get MediaSource by given component
getMediaSourceByPath()  : MediaSource
Get MediaSource by the given path
getMediaSourceFileFromPath()  : File|null|false
Get MediaSourceFile from the given path
getMediaType()  : MediaSource
getMediaTypePaths()  : array<string|int, mixed>
getMediaTypePathsbyName()  : array<string|int, mixed>
getMediaTypePathsbyNameAndOffset()  : string
Get the path to the MediaSource's filesystem
getMediaTypes()  : array<string|int, MediaSource>
getThumbnailGenerator()  : ThumbnailGenerator
getTranslatedFieldValue()  : mixed
Returns the value of a translatable field using fallback mechanisms
initializeValidators()  : mixed
Set $this->validators
isSubdirectory()  : bool
Checks if $subdirectory is a subdirectory of $path.
isVirtual()  : bool
Returns the virtuality of the entity
isVirtualPath()  : bool
Check if a path is virtual or real.
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

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

__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

checkPermissions()

Checks permission

public static checkPermissions(mixed $path) : bool
Parameters
$path : mixed
Return values
bool

getAbsolutePath()

Get the absolute path from the virtual path.

public static getAbsolutePath(mixed $virtualPath) : string

If the path is already absolute nothing will happen to it.

Parameters
$virtualPath : mixed

string The virtual Path

Return values
string —

The absolute Path

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

getLockedMediaType()

Returns all MediaSources the current user does not have access to

public getLockedMediaType(string $name) : MediaSource

This method must not be used outside MediaSource itself!

Parameters
$name : string

Name of the MediaSource to load

Tags
todo

This is a dirty hack to allow the API control over permissions. As soon as DataSource can load the correct MediaSource instance directly, this should be removed.

Return values
MediaSource —

Requested MediaSource or null

getMediaSourceFileFromPath()

Get MediaSourceFile from the given path

public getMediaSourceFileFromPath(string $path[, bool $privileged = false ]) : File|null|false

This method returns an object which implements the File interface, but only if the file exists within a registered MediaSource. If no matching MediaSource was found it returns null. If a matching MediaSource was found, but the file does not exist, it returns false.

Parameters
$path : string

File path

$privileged : bool = false

If set to true, then access permissions will be ignored.

Return values
File|null|false —

See description

getMediaTypePaths()

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

getMediaTypePathsbyName()

public getMediaTypePathsbyName(mixed $name) : array<string|int, mixed>
Parameters
$name : mixed
Return values
array<string|int, mixed>

getMediaTypePathsbyNameAndOffset()

Get the path to the MediaSource's filesystem

public getMediaTypePathsbyNameAndOffset(string $name, inteter $offset[, string $scope = 'read' ]) : string
Parameters
$name : string

The identifier of the MediaSource

$offset : inteter

Set to one of:

  • 0: to return the absolute file system path to the MediaSource's filesystem
  • 1: to return the web path (relative to the document root) of the MeidaSource's filesystem
$scope : string = 'read'

Set to one of:

  • read: verify read access permission
  • write: verify write access permission
Tags
todo

The naming of this method is misleading as it does not return multiple paths as the method name woudl suggest.

Return values
string —

The path to the MediaSource's filesystem. Either absoute (on the system's filesystem) or relativ to the document root, depending on the argument $offset.

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

isSubdirectory()

Checks if $subdirectory is a subdirectory of $path.

public static isSubdirectory(mixed $path, mixed $subdirectory) : bool

You can use a virtual path as a parameter.

Parameters
$path : mixed
$subdirectory : mixed
Return values
bool

isVirtual()

Returns the virtuality of the entity

public isVirtual() : bool
Return values
bool —

TRUE if the entity is virtual, otherwise FALSE

isVirtualPath()

Check if a path is virtual or real.

public static isVirtualPath(mixed $path) : bool 
\Cx\Core_Modules\MediaBrowser\Model\FileSystem::isVirtualPath('files/Movies'); // Returns true
Parameters
$path : mixed
Return values
bool

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