Class MOXMAN_Vfs_StreamEventArgs
Inheritance | MOXMAN_Vfs_StreamEventArgs » MOXMAN_Util_EventArgs |
---|
This class is passed out from various stream events for example when a file is uploaded/downloaded.
Public Methods
Method | Description | Defined By |
---|---|---|
__construct() | Constructs a new stream event. | MOXMAN_Vfs_StreamEventArgs |
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 |
getFile() | Returns file associated with stream event. | MOXMAN_Vfs_StreamEventArgs |
getHttpContext() | Returns the http context used for the stream event. | MOXMAN_Vfs_StreamEventArgs |
getSender() | Returns the sender instance that dispatched the event. | MOXMAN_Util_EventArgs |
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 |
setFile() | Sets the file associated with stream event. | MOXMAN_Vfs_StreamEventArgs |
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 |
Method Details
Constructs a new stream event.
public void __construct ( MOXMAN_Http_Context $httpContext, MOXMAN_Vfs_IFile $file ) | ||
$httpContext | MOXMAN_Http_Context | Http context instance. |
$file | MOXMAN_Vfs_IFile | File instance. |
Returns file associated with stream event.
public MOXMAN_Vfs_IFile getFile ( ) | ||
return | MOXMAN_Vfs_IFile | File instance for stream event. |
---|
Returns the http context used for the stream event.
public MOXMAN_Http_Context getHttpContext ( ) | ||
return | MOXMAN_Http_Context | HTTP context used for the stream event. |
---|
Sets the file associated with stream event.
public void setFile ( MOXMAN_Vfs_IFile $file ) | ||
$file | MOXMAN_Vfs_IFile | File instance for stream event. |