CommentsEntityEvent¶
-
class
OCP\Comments\
CommentsEntityEvent
¶ - Class CommentsEntityEvent
Source: lib/public/Comments/CommentsEntityEvent.php#34 Parent: OCP\EventDispatcher\Event
Constants¶
-
EVENT_ENTITY = OCP\Comments\ICommentsManager::registerEntity
Source: lib/public/Comments/CommentsEntityEvent.php#38 Deprecated: 22.0.0
Properties¶
-
protected static property
OCP\Comments\CommentsEntityEvent::$
event
¶ Source: lib/public/Comments/CommentsEntityEvent.php#41 Type: string
-
protected static property
OCP\Comments\CommentsEntityEvent::$
collections
¶ Source: lib/public/Comments/CommentsEntityEvent.php#43 Type: \Closure[]
Methods¶
-
public
OCP\Comments\CommentsEntityEvent::
__construct
($event)¶ - DispatcherEvent constructor.
Source: Parameters: - $event (string)
Since: 9.1.0
-
public
OCP\Comments\CommentsEntityEvent::
addEntityCollection
($name, $entityExistsFunction)¶ Source: Parameters: - $name (string)
- $entityExistsFunction (
Closure
) The closure should take one
argument, which is the id of the entity, that comments should be handled for. The return should then be bool, depending on whether comments are allowed (true) or not.
Throws: \OutOfBoundsException
when the entity name is already takenSince: 9.1.0
-
public
OCP\Comments\CommentsEntityEvent::
getEntityCollections
()¶ Source: lib/public/Comments/CommentsEntityEvent.php#77 Returns: \Closure[]
Since: 9.1.0