plugin: populate missing return type information

This commit is contained in:
Dylan K. Taylor 2020-01-19 17:09:33 +00:00
parent 8776b71d63
commit 1cc7027f92
4 changed files with 41 additions and 0 deletions

View File

@ -41,11 +41,15 @@ interface Plugin extends CommandExecutor{
/** /**
* Called when the plugin is loaded, before calling onEnable() * Called when the plugin is loaded, before calling onEnable()
*
* @return void
*/ */
public function onLoad(); public function onLoad();
/** /**
* Called when the plugin is enabled * Called when the plugin is enabled
*
* @return void
*/ */
public function onEnable(); public function onEnable();
@ -68,6 +72,8 @@ interface Plugin extends CommandExecutor{
/** /**
* Called when the plugin is disabled * Called when the plugin is disabled
* Use this to free open things and finish actions * Use this to free open things and finish actions
*
* @return void
*/ */
public function onDisable(); public function onDisable();
@ -120,6 +126,9 @@ interface Plugin extends CommandExecutor{
*/ */
public function getConfig() : Config; public function getConfig() : Config;
/**
* @return void
*/
public function saveConfig(); public function saveConfig();
/** /**
@ -127,6 +136,9 @@ interface Plugin extends CommandExecutor{
*/ */
public function saveDefaultConfig() : bool; public function saveDefaultConfig() : bool;
/**
* @return void
*/
public function reloadConfig(); public function reloadConfig();
/** /**

View File

@ -213,6 +213,7 @@ class PluginDescription{
/** /**
* Checks if the current PHP runtime has the extensions required by the plugin. * 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 * @throws PluginException if there are required extensions missing or have incompatible version, or if the version constraint cannot be parsed
*/ */
public function checkRequiredExtensions(){ public function checkRequiredExtensions(){

View File

@ -441,6 +441,8 @@ class PluginManager{
* @see PermissionManager::removePermission() * @see PermissionManager::removePermission()
* *
* @param string|Permission $permission * @param string|Permission $permission
*
* @return void
*/ */
public function removePermission($permission){ public function removePermission($permission){
PermissionManager::getInstance()->removePermission($permission); PermissionManager::getInstance()->removePermission($permission);
@ -463,6 +465,8 @@ class PluginManager{
* @see PermissionManager::recalculatePermissionDefaults() * @see PermissionManager::recalculatePermissionDefaults()
* *
* @param Permission $permission * @param Permission $permission
*
* @return void
*/ */
public function recalculatePermissionDefaults(Permission $permission){ public function recalculatePermissionDefaults(Permission $permission){
PermissionManager::getInstance()->recalculatePermissionDefaults($permission); PermissionManager::getInstance()->recalculatePermissionDefaults($permission);
@ -474,6 +478,8 @@ class PluginManager{
* *
* @param string $permission * @param string $permission
* @param Permissible $permissible * @param Permissible $permissible
*
* @return void
*/ */
public function subscribeToPermission(string $permission, Permissible $permissible){ public function subscribeToPermission(string $permission, Permissible $permissible){
PermissionManager::getInstance()->subscribeToPermission($permission, $permissible); PermissionManager::getInstance()->subscribeToPermission($permission, $permissible);
@ -485,6 +491,8 @@ class PluginManager{
* *
* @param string $permission * @param string $permission
* @param Permissible $permissible * @param Permissible $permissible
*
* @return void
*/ */
public function unsubscribeFromPermission(string $permission, Permissible $permissible){ public function unsubscribeFromPermission(string $permission, Permissible $permissible){
PermissionManager::getInstance()->unsubscribeFromPermission($permission, $permissible); PermissionManager::getInstance()->unsubscribeFromPermission($permission, $permissible);
@ -495,6 +503,8 @@ class PluginManager{
* @see PermissionManager::unsubscribeFromAllPermissions() * @see PermissionManager::unsubscribeFromAllPermissions()
* *
* @param Permissible $permissible * @param Permissible $permissible
*
* @return void
*/ */
public function unsubscribeFromAllPermissions(Permissible $permissible) : void{ public function unsubscribeFromAllPermissions(Permissible $permissible) : void{
PermissionManager::getInstance()->unsubscribeFromAllPermissions($permissible); PermissionManager::getInstance()->unsubscribeFromAllPermissions($permissible);
@ -518,6 +528,8 @@ class PluginManager{
* *
* @param bool $op * @param bool $op
* @param Permissible $permissible * @param Permissible $permissible
*
* @return void
*/ */
public function subscribeToDefaultPerms(bool $op, Permissible $permissible){ public function subscribeToDefaultPerms(bool $op, Permissible $permissible){
PermissionManager::getInstance()->subscribeToDefaultPerms($op, $permissible); PermissionManager::getInstance()->subscribeToDefaultPerms($op, $permissible);
@ -529,6 +541,8 @@ class PluginManager{
* *
* @param bool $op * @param bool $op
* @param Permissible $permissible * @param Permissible $permissible
*
* @return void
*/ */
public function unsubscribeFromDefaultPerms(bool $op, Permissible $permissible){ public function unsubscribeFromDefaultPerms(bool $op, Permissible $permissible){
PermissionManager::getInstance()->unsubscribeFromDefaultPerms($op, $permissible); PermissionManager::getInstance()->unsubscribeFromDefaultPerms($op, $permissible);
@ -567,6 +581,8 @@ class PluginManager{
/** /**
* @param Plugin $plugin * @param Plugin $plugin
*
* @return void
*/ */
public function enablePlugin(Plugin $plugin){ public function enablePlugin(Plugin $plugin){
if(!$plugin->isEnabled()){ if(!$plugin->isEnabled()){
@ -647,6 +663,9 @@ class PluginManager{
return $pluginCmds; return $pluginCmds;
} }
/**
* @return void
*/
public function disablePlugins(){ public function disablePlugins(){
foreach($this->getPlugins() as $plugin){ foreach($this->getPlugins() as $plugin){
$this->disablePlugin($plugin); $this->disablePlugin($plugin);
@ -655,6 +674,8 @@ class PluginManager{
/** /**
* @param Plugin $plugin * @param Plugin $plugin
*
* @return void
*/ */
public function disablePlugin(Plugin $plugin){ public function disablePlugin(Plugin $plugin){
if($plugin->isEnabled()){ if($plugin->isEnabled()){
@ -683,6 +704,9 @@ class PluginManager{
} }
} }
/**
* @return void
*/
public function clearPlugins(){ public function clearPlugins(){
$this->disablePlugins(); $this->disablePlugins();
$this->plugins = []; $this->plugins = [];
@ -697,6 +721,8 @@ class PluginManager{
* @see Event::call() * @see Event::call()
* *
* @param Event $event * @param Event $event
*
* @return void
*/ */
public function callEvent(Event $event){ public function callEvent(Event $event){
$event->call(); $event->call();

View File

@ -89,6 +89,8 @@ class RegisteredListener{
/** /**
* @param Event $event * @param Event $event
*
* @return void
*/ */
public function callEvent(Event $event){ public function callEvent(Event $event){
if($event instanceof Cancellable and $event->isCancelled() and $this->isIgnoringCancelled()){ if($event instanceof Cancellable and $event->isCancelled() and $this->isIgnoringCancelled()){