MetadataNamedEvent
extends AMetadataEvent
in package
MetadataNamedEvent is an event similar to MetadataBackgroundEvent completed with a target name, used to limit the refresh of metadata only listeners capable of filtering themselves out.
Meaning that when using this event, your app must implement a filter on the event's registered name returned by getName()
This event is mostly triggered when a registered name is added to the files scan i.e. ./occ files:scan --generate-metadata [name]
Tags
Table of Contents
Properties
- $metadata : IFilesMetadata
- $node : Node
- $name : string
- $propagationStopped : bool
Methods
- __construct() : mixed
- Compatibility constructor
- getMetadata() : IFilesMetadata
- returns metadata. if known, it already contains data from the database.
- getName() : string
- get the assigned name for the event.
- 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
$name
private
string
$name
= ''
$propagationStopped
private
bool
$propagationStopped
= false
Tags
Methods
__construct()
Compatibility constructor
public
__construct(Node $node, IFilesMetadata $metadata[, string $name = '' ]) : mixed
Parameters
- $node : Node
- $metadata : IFilesMetadata
- $name : string = ''
-
name assigned to the event
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
IFilesMetadatagetName()
get the assigned name for the event.
public
getName() : string
This is used to know if your app is the called one when running the ./occ files:scan --generate-metadata [name]
Tags
Return values
stringgetNode()
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