From 1cc7027f920eed393724f510442387780db50a6b Mon Sep 17 00:00:00 2001 From: "Dylan K. Taylor" Date: Sun, 19 Jan 2020 17:09:33 +0000 Subject: [PATCH] plugin: populate missing return type information --- src/pocketmine/plugin/Plugin.php | 12 +++++++++ src/pocketmine/plugin/PluginDescription.php | 1 + src/pocketmine/plugin/PluginManager.php | 26 ++++++++++++++++++++ src/pocketmine/plugin/RegisteredListener.php | 2 ++ 4 files changed, 41 insertions(+) diff --git a/src/pocketmine/plugin/Plugin.php b/src/pocketmine/plugin/Plugin.php index fbef35765..2af2f2e75 100644 --- a/src/pocketmine/plugin/Plugin.php +++ b/src/pocketmine/plugin/Plugin.php @@ -41,11 +41,15 @@ interface Plugin extends CommandExecutor{ /** * Called when the plugin is loaded, before calling onEnable() + * + * @return void */ public function onLoad(); /** * Called when the plugin is enabled + * + * @return void */ public function onEnable(); @@ -68,6 +72,8 @@ interface Plugin extends CommandExecutor{ /** * Called when the plugin is disabled * Use this to free open things and finish actions + * + * @return void */ public function onDisable(); @@ -120,6 +126,9 @@ interface Plugin extends CommandExecutor{ */ public function getConfig() : Config; + /** + * @return void + */ public function saveConfig(); /** @@ -127,6 +136,9 @@ interface Plugin extends CommandExecutor{ */ public function saveDefaultConfig() : bool; + /** + * @return void + */ public function reloadConfig(); /** diff --git a/src/pocketmine/plugin/PluginDescription.php b/src/pocketmine/plugin/PluginDescription.php index e092ae250..cf2da4ebc 100644 --- a/src/pocketmine/plugin/PluginDescription.php +++ b/src/pocketmine/plugin/PluginDescription.php @@ -213,6 +213,7 @@ class PluginDescription{ /** * Checks if the current PHP runtime has the extensions required by the plugin. * + * @return void * @throws PluginException if there are required extensions missing or have incompatible version, or if the version constraint cannot be parsed */ public function checkRequiredExtensions(){ diff --git a/src/pocketmine/plugin/PluginManager.php b/src/pocketmine/plugin/PluginManager.php index 48e8e12a1..c49d15795 100644 --- a/src/pocketmine/plugin/PluginManager.php +++ b/src/pocketmine/plugin/PluginManager.php @@ -441,6 +441,8 @@ class PluginManager{ * @see PermissionManager::removePermission() * * @param string|Permission $permission + * + * @return void */ public function removePermission($permission){ PermissionManager::getInstance()->removePermission($permission); @@ -463,6 +465,8 @@ class PluginManager{ * @see PermissionManager::recalculatePermissionDefaults() * * @param Permission $permission + * + * @return void */ public function recalculatePermissionDefaults(Permission $permission){ PermissionManager::getInstance()->recalculatePermissionDefaults($permission); @@ -474,6 +478,8 @@ class PluginManager{ * * @param string $permission * @param Permissible $permissible + * + * @return void */ public function subscribeToPermission(string $permission, Permissible $permissible){ PermissionManager::getInstance()->subscribeToPermission($permission, $permissible); @@ -485,6 +491,8 @@ class PluginManager{ * * @param string $permission * @param Permissible $permissible + * + * @return void */ public function unsubscribeFromPermission(string $permission, Permissible $permissible){ PermissionManager::getInstance()->unsubscribeFromPermission($permission, $permissible); @@ -495,6 +503,8 @@ class PluginManager{ * @see PermissionManager::unsubscribeFromAllPermissions() * * @param Permissible $permissible + * + * @return void */ public function unsubscribeFromAllPermissions(Permissible $permissible) : void{ PermissionManager::getInstance()->unsubscribeFromAllPermissions($permissible); @@ -518,6 +528,8 @@ class PluginManager{ * * @param bool $op * @param Permissible $permissible + * + * @return void */ public function subscribeToDefaultPerms(bool $op, Permissible $permissible){ PermissionManager::getInstance()->subscribeToDefaultPerms($op, $permissible); @@ -529,6 +541,8 @@ class PluginManager{ * * @param bool $op * @param Permissible $permissible + * + * @return void */ public function unsubscribeFromDefaultPerms(bool $op, Permissible $permissible){ PermissionManager::getInstance()->unsubscribeFromDefaultPerms($op, $permissible); @@ -567,6 +581,8 @@ class PluginManager{ /** * @param Plugin $plugin + * + * @return void */ public function enablePlugin(Plugin $plugin){ if(!$plugin->isEnabled()){ @@ -647,6 +663,9 @@ class PluginManager{ return $pluginCmds; } + /** + * @return void + */ public function disablePlugins(){ foreach($this->getPlugins() as $plugin){ $this->disablePlugin($plugin); @@ -655,6 +674,8 @@ class PluginManager{ /** * @param Plugin $plugin + * + * @return void */ public function disablePlugin(Plugin $plugin){ if($plugin->isEnabled()){ @@ -683,6 +704,9 @@ class PluginManager{ } } + /** + * @return void + */ public function clearPlugins(){ $this->disablePlugins(); $this->plugins = []; @@ -697,6 +721,8 @@ class PluginManager{ * @see Event::call() * * @param Event $event + * + * @return void */ public function callEvent(Event $event){ $event->call(); diff --git a/src/pocketmine/plugin/RegisteredListener.php b/src/pocketmine/plugin/RegisteredListener.php index 7db4cadea..fed6d24c2 100644 --- a/src/pocketmine/plugin/RegisteredListener.php +++ b/src/pocketmine/plugin/RegisteredListener.php @@ -89,6 +89,8 @@ class RegisteredListener{ /** * @param Event $event + * + * @return void */ public function callEvent(Event $event){ if($event instanceof Cancellable and $event->isCancelled() and $this->isIgnoringCancelled()){