Class MOXMAN_Vfs_CustomInfoEventArgs

InheritanceMOXMAN_Vfs_CustomInfoEventArgs » MOXMAN_Util_EventArgs

Instances of this event arguments class will be passed to custom info events. This enables you to add your own custom data when for example a file is inserted into a form/editor or when files are listed.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() Constructs a new custom info event. MOXMAN_Vfs_CustomInfoEventArgs
cancel() Cancels the action to be executed after the event. This is normally used in events called just before an action is to be performed. MOXMAN_Util_EventArgs
extendInfo() Extends the custom info data with new items. MOXMAN_Vfs_CustomInfoEventArgs
getFile() Returns the file instance that the custom info is to be added for. MOXMAN_Vfs_CustomInfoEventArgs
getInfo() Returns the custom info array. Custom info will be passed out when you insert a file and can include extra details about the file. MOXMAN_Vfs_CustomInfoEventArgs
getSender() Returns the sender instance that dispatched the event. MOXMAN_Util_EventArgs
getType() Returns the custom info type. For example "insert" or "list". MOXMAN_Vfs_CustomInfoEventArgs
isCancelled() Returns true/false if the event is cancelled or not. This will block the action followed by the event. This is normally used to cancel an action on a event called before the action. MOXMAN_Util_EventArgs
isStopped() Returns true/false if the event is stopped. If it's stopped other event handlers won't be executed. MOXMAN_Util_EventArgs
setSender() Sets the sender that dispatched the event. MOXMAN_Util_EventArgs
stop() Stops the event from being passed to other event handlers. MOXMAN_Util_EventArgs

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
INSERT_TYPE "insert" Type when a file is selected to be inserted back to a form or TinyMCE. MOXMAN_Vfs_CustomInfoEventArgs
LIST_TYPE "list" Type when a file is added to a file list. MOXMAN_Vfs_CustomInfoEventArgs

Property Details

$customInfo protected property
protected array $customInfo null
$file protected property
protected MOXMAN_Vfs_IFile $file null
$type protected property
protected string $type null

Method Details

__construct() public method

Constructs a new custom info event.

public void __construct ( $type, MOXMAN_Vfs_IFile $file )
$type string

Custom info type to create.

$file MOXMAN_Vfs_IFile

File instance for the custom info.

extendInfo() public method

Extends the custom info data with new items.

public \MOXMAN_CustomInfoEventArgs extendInfo ( $info )
$info Array

Array with custom info to extend the existing one with.

return \MOXMAN_CustomInfoEventArgs

Instance reference.

getFile() public method

Returns the file instance that the custom info is to be added for.

public MOXMAN_Vfs_IFile getFile ( )
return MOXMAN_Vfs_IFile

File instance for the custom info.

getInfo() public method

Returns the custom info array. Custom info will be passed out when you insert a file and can include extra details about the file.

public Array getInfo ( )
return Array

Custom info data for the action.

getType() public method

Returns the custom info type. For example "insert" or "list".

public String getType ( )
return String

Custom info type name.