MetadataBackgroundEvent
extends AMetadataEvent
in package
MetadataBackgroundEvent is an event similar to MetadataLiveEvent but dispatched on a background thread instead of live thread. Meaning there is no limit to the time required for the generation of your metadata.
Tags
Table of Contents
Properties
- $metadata : IFilesMetadata
- $node : Node
- $propagationStopped : bool
Methods
- __construct() : mixed
- Compatibility constructor
- getMetadata() : IFilesMetadata
- returns metadata. if known, it already contains data from the database.
- getNode() : Node
- returns related node
- isPropagationStopped() : bool
- {@inheritDoc}
- stopPropagation() : void
- Stops the propagation of the event to further event listeners
Properties
$metadata
protected
IFilesMetadata
$metadata
$node
protected
Node
$node
$propagationStopped
private
bool
$propagationStopped
= false
Tags
Methods
__construct()
Compatibility constructor
public
__construct(Node $node, IFilesMetadata $metadata) : mixed
Parameters
- $node : Node
- $metadata : IFilesMetadata
Tags
getMetadata()
returns metadata. if known, it already contains data from the database.
public
getMetadata() : IFilesMetadata
If the object is modified using its setters, changes are stored in database at the end of the event.
Tags
Return values
IFilesMetadatagetNode()
returns related node
public
getNode() : Node
Tags
Return values
NodeisPropagationStopped()
{@inheritDoc}
public
isPropagationStopped() : bool
Tags
Return values
boolstopPropagation()
Stops the propagation of the event to further event listeners
public
stopPropagation() : void