SystemTagsEntityEvent

class OCP\SystemTag\SystemTagsEntityEvent
Class SystemTagsEntityEvent
Source:lib/public/SystemTag/SystemTagsEntityEvent.php#38
Parent:OCP\EventDispatcher\Event

Constants

EVENT_ENTITY = OCP\SystemTag\ISystemTagManager::registerEntity
Source:lib/public/SystemTag/SystemTagsEntityEvent.php#43
Deprecated:22.0.0

Properties

protected static property OCP\SystemTag\SystemTagsEntityEvent::$event
Source:lib/public/SystemTag/SystemTagsEntityEvent.php#46
Type:string
protected static property OCP\SystemTag\SystemTagsEntityEvent::$collections
Source:lib/public/SystemTag/SystemTagsEntityEvent.php#48
Type:\Closure[]

Methods

public OCP\SystemTag\SystemTagsEntityEvent::__construct($event)
SystemTagsEntityEvent constructor.
Source:

lib/public/SystemTag/SystemTagsEntityEvent.php#56

Parameters:
  • $event (string)
Since:

9.1.0

public OCP\SystemTag\SystemTagsEntityEvent::addEntityCollection($name, $entityExistsFunction)
Source:

lib/public/SystemTag/SystemTagsEntityEvent.php#70

Parameters:
  • $name (string)
  • $entityExistsFunction (Closure) The closure should take one

argument, which is the id of the entity, that tags should be handled for. The return should then be bool, depending on whether tags are allowed (true) or not.

Throws:

\OutOfBoundsException when the entity name is already taken

Since:

9.1.0

public OCP\SystemTag\SystemTagsEntityEvent::getEntityCollections()
Source:lib/public/SystemTag/SystemTagsEntityEvent.php#82
Returns:\Closure[]
Since:9.1.0