Documentation

IndexerEventListener extends DefaultEventListener
in package

cloudrexx

core

mediasource

Event Listener for Media Source Events

Handle all events that affect the MediaSource module.

Properties

$cx : Cx
$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()
$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
__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
getComponentController() : SystemComponent: Returns the component controller for this component
getKeyAsString() : string: Returns this entity's key
getTranslatedFieldValue() : mixed: Returns the value of a translatable field using fallback mechanisms
index() : mixed: Get all file paths and get the appropriate index for each file to be able to index the file
initializeValidators() : mixed: Set $this->validators
isVirtual() : bool: Returns the virtuality of the entity
onEvent() : mixed: Call event method. This method is overwritten to get the whole array of $eventArgs as parameter in the event method, not only the first element.
setVirtual() : mixed: Set the virtuality of the entity
validate() : mixed
getAllFilePaths() : array<string|int, mixed>: Returns an array with all file paths of all files in this directory, including files located in another directory.
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
mediaSourceFileAdd() : mixed: Add event - add new index
mediaSourceFileRemove() : mixed: Remove event - remove an index Todo: Use file as param when FileSystem work smart
mediaSourceFileUpdate() : mixed: Update event - update an index

$cx


        protected
            Cx
    $cx

$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>, ...))

$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

$stringRepresentationFields

List of fields that should be available in the string representation


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

List of field names

$stringRepresentationFormat

Sprintf format for the string representation


        protected
            string
    $stringRepresentationFormat
     = ''

Sprintf format string

$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.

__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

Return values

mixed —

Return value of the method to call

__construct()


    public
                    __construct(Cx $cx) : mixed

Parameters

$cx : Cx

__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

#[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

getComponentController()

Returns the component controller for this component


    public
                    getComponentController() : SystemComponent

Return values

SystemComponent

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

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

index()

Get all file paths and get the appropriate index for each file to be able to index the file


    public
                    index(mixed $fileInfo) : mixed

This indexes the file identified by $fileInfo. $fileInfo is an array with the indexes "path" and "oldPath" set. To index new files or re-index existing ones "oldPath" needs to be an empty string. If a file has moved "oldPath" can be set to update the path in the index.

Parameters

$fileInfo : mixed: array Information about a file

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

onEvent()

Call event method. This method is overwritten to get the whole array of $eventArgs as parameter in the event method, not only the first element.


    public
                    onEvent(mixed $eventName, array<string|int, mixed> $eventArgs) : mixed

Parameters

$eventName : mixed
$eventArgs : array<string|int, 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

validate()


    public
                    validate() : mixed

getAllFilePaths()

Returns an array with all file paths of all files in this directory, including files located in another directory.


    protected
                    getAllFilePaths(mixed $fileList, mixed $path, mixed $folder, mixed $result) : array<string|int, mixed>

Parameters

$fileList : mixed: array all files and directorys
$path : mixed: string path from this directory
$folder : mixed: string in this directory
$result : mixed: array existing result

Return values

array<string|int, 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)

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

mediaSourceFileAdd()

Add event - add new index


    protected
                    mediaSourceFileAdd(mixed $info) : mixed

Parameters

$info : mixed: array information from file/ directory

mediaSourceFileRemove()

Remove event - remove an index Todo: Use file as param when FileSystem work smart


    protected
                    mediaSourceFileRemove(mixed $fileInfo) : mixed

Parameters

$fileInfo : mixed: array information from file/ directory

mediaSourceFileUpdate()

Update event - update an index


    protected
                    mediaSourceFileUpdate(mixed $info) : mixed

Parameters

$info : mixed: array information from file/ directory

IndexerEventListener extends DefaultEventListener in package cloudrexx core mediasource

Tags

Table of Contents

Properties

Methods

Properties

$cx

$localeCodes

Tags

$nestingCount

$stringRepresentationBlank

Tags

$stringRepresentationFields

Tags

$stringRepresentationFormat

Tags

$validators

$virtual

Methods

__call()

Parameters

Tags

Attributes

Return values

__construct()

Parameters

__get()

Parameters

Attributes

__toString()

Return values

getComponentController()

Return values

getKeyAsString()

Parameters

Return values

getTranslatedFieldValue()

Parameters

index()

Parameters

Tags

initializeValidators()

isVirtual()

Return values

onEvent()

Parameters

setVirtual()

Parameters

validate()

Tags

getAllFilePaths()

Parameters

Return values

getFallbackLocaleCodes()

Tags

Return values

getStringRepresentationBlank()

Return values

getStringRepresentationFields()

Return values

getStringRepresentationFormat()

Return values

mediaSourceFileAdd()

Parameters

mediaSourceFileRemove()

Parameters

mediaSourceFileUpdate()

Parameters

IndexerEventListener extends DefaultEventListener
in package

cloudrexx

core

mediasource