]> source.dussan.org Git - nextcloud-server.git/commitdiff
Add PHP doc for events 22168/head
authorMorris Jobke <hey@morrisjobke.de>
Mon, 10 Aug 2020 12:24:24 +0000 (14:24 +0200)
committerMorris Jobke <hey@morrisjobke.de>
Mon, 10 Aug 2020 12:24:24 +0000 (14:24 +0200)
Signed-off-by: Morris Jobke <hey@morrisjobke.de>
15 files changed:
apps/files/lib/Event/LoadAdditionalScriptsEvent.php
lib/public/Authentication/Events/LoginFailedEvent.php
lib/public/DirectEditing/RegisterDirectEditorEvent.php
lib/public/Mail/Events/BeforeMessageSent.php
lib/public/Security/CSP/AddContentSecurityPolicyEvent.php
lib/public/Security/FeaturePolicy/AddFeaturePolicyEvent.php
lib/public/User/Events/BeforePasswordUpdatedEvent.php
lib/public/User/Events/BeforeUserCreatedEvent.php
lib/public/User/Events/BeforeUserLoggedInWithCookieEvent.php
lib/public/User/Events/BeforeUserLoggedOutEvent.php
lib/public/User/Events/PasswordUpdatedEvent.php
lib/public/User/Events/UserCreatedEvent.php
lib/public/User/Events/UserLoggedInWithCookieEvent.php
lib/public/User/Events/UserLoggedOutEvent.php
lib/public/WorkflowEngine/Events/LoadSettingsScriptsEvent.php

index d9c80a232071131a772b981cbb7f5ffb77887d39..458ec916f8f3fb9394cc719c22d27cc406849335 100644 (file)
@@ -28,6 +28,11 @@ namespace OCA\Files\Event;
 
 use OCP\EventDispatcher\Event;
 
+/**
+ * This event is triggered when the files app is rendered. It canb e used to add additional scripts to the files app.
+ *
+ * @since 17.0.0
+ */
 class LoadAdditionalScriptsEvent extends Event {
        private $hiddenFields = [];
 
index b946ba0c664884f796fc81a8df9c1c57157462a2..1e0a66a0b9911c94725c2474bc4aac3f834a2b7a 100644 (file)
@@ -29,9 +29,7 @@ namespace OCP\Authentication\Events;
 use OCP\EventDispatcher\Event;
 
 /**
- * Class LoginFailedEvent
- *
- * @package OCP\Authentication\Events
+ * Emitted when the authentication fails, but only if the login name can be associated with an existing user.
  *
  * @since 19.0.0
  */
index c9e04f23cfc69523b339a30bfb2c15474e86a834..d01bf92c58f930843ee0e250378540ff9a723299 100644 (file)
@@ -26,6 +26,8 @@ namespace OCP\DirectEditing;
 use OCP\EventDispatcher\Event;
 
 /**
+ * Event to allow to register the direct editor.
+ *
  * @since 18.0.0
  */
 class RegisterDirectEditorEvent extends Event {
index f9dc834c9b69c15557ed41e1de144ea2183fb5fe..f11b24151488e9dce8efcba89565e19a45976db5 100644 (file)
@@ -30,6 +30,8 @@ use OCP\EventDispatcher\Event;
 use OCP\Mail\IMessage;
 
 /**
+ * Emitted before a system mail is sent. It can be used to alter the message.
+ *
  * @since 19.0.0
  */
 class BeforeMessageSent extends Event {
index bcb25867075b150ccb4d607f3574d43d831a8861..2806cf7287166d9056504e814b1a8ced4a9ca202 100644 (file)
@@ -32,6 +32,16 @@ use OCP\AppFramework\Http\EmptyContentSecurityPolicy;
 use OCP\EventDispatcher\Event;
 
 /**
+ * Allows to inject something into the default content policy. This is for
+ * example useful when you're injecting Javascript code into a view belonging
+ * to another controller and cannot modify its Content-Security-Policy itself.
+ * Note that the adjustment is only applied to applications that use AppFramework
+ * controllers.
+ *
+ * WARNING: Using this API incorrectly may make the instance more insecure.
+ * Do think twice before adding whitelisting resources. Please do also note
+ * that it is not possible to use the `disallowXYZ` functions.
+ *
  * @since 17.0.0
  */
 class AddContentSecurityPolicyEvent extends Event {
index a900960c61242eb548129fdcfebc3a75f6b430b3..d349cb3f6f3616f2238d4a6afeb80f00a969978d 100644 (file)
@@ -32,6 +32,8 @@ use OCP\AppFramework\Http\EmptyFeaturePolicy;
 use OCP\EventDispatcher\Event;
 
 /**
+ * Event that allows to register a feature policy header to a request.
+ *
  * @since 17.0.0
  */
 class AddFeaturePolicyEvent extends Event {
index 85d609e672ff6019b1713a81adfe466df3868d3b..e2abddfd08429ea47d71392c1536002743d6d4b5 100644 (file)
@@ -30,6 +30,8 @@ use OCP\EventDispatcher\Event;
 use OCP\IUser;
 
 /**
+ * Emitted before the user password is updated.
+ *
  * @since 18.0.0
  */
 class BeforePasswordUpdatedEvent extends Event {
index ace929b8ee0ebbe9c86eb813a6369e741034cf9a..3ef55a185bb990eed5f8f1a87116a330e6f7724a 100644 (file)
@@ -29,6 +29,8 @@ namespace OCP\User\Events;
 use OCP\EventDispatcher\Event;
 
 /**
+ * Emitted before a new user is created on the back-end.
+ *
  * @since 18.0.0
  */
 class BeforeUserCreatedEvent extends Event {
index 7a4ff823f8a46f34ba4e10bdf9940a639f01b53a..07e7d30aadff5bb2fd1ce66639298cef9c9c7291 100644 (file)
@@ -29,6 +29,8 @@ namespace OCP\User\Events;
 use OCP\EventDispatcher\Event;
 
 /**
+ * Emitted before a user is logged in via remember-me cookies.
+ *
  * @since 18.0.0
  */
 class BeforeUserLoggedInWithCookieEvent extends Event {
index d470ec5de7fb25a3f6142e6233a7ed81bbeb58f9..db60a053ba08b483cca5e8e1de15bcba59cd4dd7 100644 (file)
@@ -30,6 +30,8 @@ use OCP\EventDispatcher\Event;
 use OCP\IUser;
 
 /**
+ * Emitted before a user is logged out.
+ *
  * @since 18.0.0
  */
 class BeforeUserLoggedOutEvent extends Event {
index 8913dc4c53a3b322794056a9c2d47614e34f4095..25e6efc80ccfd73742a5a2790fbaca7c501235de 100644 (file)
@@ -30,6 +30,8 @@ use OCP\EventDispatcher\Event;
 use OCP\IUser;
 
 /**
+ * Emitted when the user password has been updated.
+ *
  * @since 18.0.0
  */
 class PasswordUpdatedEvent extends Event {
index 4d5bb2c5b792c0cb446bf2904f0c67d2a51b9e34..4f2364e5c4437437e39d44254cd47909c9aeea61 100644 (file)
@@ -30,6 +30,8 @@ use OCP\EventDispatcher\Event;
 use OCP\IUser;
 
 /**
+ * Emitted when a new user has been created on the back-end.
+ *
  * @since 18.0.0
  */
 class UserCreatedEvent extends Event {
index 2827af3f90cc11335501f44e5d43c72ddcc04b8a..9ef84284151211df134f97e53b84d55cd210f9fb 100644 (file)
@@ -30,6 +30,8 @@ use OCP\EventDispatcher\Event;
 use OCP\IUser;
 
 /**
+ * Emitted when a user has been succesfully logged in via remember-me cookies.
+ *
  * @since 18.0.0
  */
 class UserLoggedInWithCookieEvent extends Event {
index 3b1f8745dfe0c297f8f3e9d5738d3aa27f913ae9..5791ec77d902bd2711a8851acb960dd08f41a98d 100644 (file)
@@ -30,6 +30,8 @@ use OCP\EventDispatcher\Event;
 use OCP\IUser;
 
 /**
+ * Emitted when a user has been logged out successfully.
+ *
  * @since 18.0.0
  */
 class UserLoggedOutEvent extends Event {
index 56fddc84031d78b9aa203daa74a3bd63bcc7cd10..6008f397952fa9d1ece86e9b0d82a6137ada9729 100644 (file)
@@ -28,6 +28,8 @@ namespace OCP\WorkflowEngine\Events;
 use OCP\EventDispatcher\Event;
 
 /**
+ * Emitted when the workflow engine settings page is loaded.
+ *
  * @since 20.0.0
  */
 class LoadSettingsScriptsEvent extends Event {