permission: populate missing return type information

PermissibleBase has some redundant phpdoc removed so that the Permissible interface can provide return types.
This commit is contained in:
Dylan K. Taylor 2020-01-19 17:23:52 +00:00
parent fffeeddca6
commit facca13139
8 changed files with 71 additions and 19 deletions

View File

@ -61,6 +61,11 @@ class BanEntry{
return $this->creationDate;
}
/**
* @param \DateTime $date
*
* @return void
*/
public function setCreated(\DateTime $date){
self::validateDate($date);
$this->creationDate = $date;
@ -70,6 +75,11 @@ class BanEntry{
return $this->source;
}
/**
* @param string $source
*
* @return void
*/
public function setSource(string $source){
$this->source = $source;
}
@ -83,6 +93,8 @@ class BanEntry{
/**
* @param \DateTime|null $date
*
* @return void
*/
public function setExpires(\DateTime $date = null){
if($date !== null){
@ -101,6 +113,11 @@ class BanEntry{
return $this->reason;
}
/**
* @param string $reason
*
* @return void
*/
public function setReason(string $reason){
$this->reason = $reason;
}

View File

@ -61,6 +61,8 @@ class BanList{
/**
* @param bool $flag
*
* @return void
*/
public function setEnabled(bool $flag){
$this->enabled = $flag;
@ -104,6 +106,8 @@ class BanList{
/**
* @param BanEntry $entry
*
* @return void
*/
public function add(BanEntry $entry){
$this->list[$entry->getName()] = $entry;
@ -132,6 +136,8 @@ class BanList{
/**
* @param string $name
*
* @return void
*/
public function remove(string $name){
$name = strtolower($name);
@ -141,6 +147,9 @@ class BanList{
}
}
/**
* @return void
*/
public function removeExpired(){
foreach($this->list as $name => $entry){
if($entry->hasExpired()){
@ -149,6 +158,9 @@ class BanList{
}
}
/**
* @return void
*/
public function load(){
$this->list = [];
$fp = @fopen($this->file, "r");
@ -175,6 +187,8 @@ class BanList{
/**
* @param bool $writeHeader
*
* @return void
*/
public function save(bool $writeHeader = true){
$this->removeExpired();

View File

@ -43,6 +43,9 @@ abstract class DefaultPermissions{
return PermissionManager::getInstance()->getPermission($perm->getName());
}
/**
* @return void
*/
public static function registerCorePermissions(){
$parent = self::registerPermission(new Permission(self::ROOT, "Allows using all PocketMine commands and utilities"));

View File

@ -55,34 +55,18 @@ class PermissibleBase implements Permissible{
}
}
/**
* @return bool
*/
public function isOp() : bool{
return $this->opable->isOp();
}
/**
* @param bool $value
*/
public function setOp(bool $value){
$this->opable->setOp($value);
}
/**
* @param Permission|string $name
*
* @return bool
*/
public function isPermissionSet($name) : bool{
return isset($this->permissions[$name instanceof Permission ? $name->getName() : $name]);
}
/**
* @param Permission|string $name
*
* @return bool
*/
public function hasPermission($name) : bool{
if($name instanceof Permission){
$name = $name->getName();
@ -127,9 +111,6 @@ class PermissibleBase implements Permissible{
return $result;
}
/**
* @param PermissionAttachment $attachment
*/
public function removeAttachment(PermissionAttachment $attachment){
if(isset($this->attachments[spl_object_hash($attachment)])){
unset($this->attachments[spl_object_hash($attachment)]);
@ -165,6 +146,9 @@ class PermissibleBase implements Permissible{
Timings::$permissibleCalculationTimer->stopTiming();
}
/**
* @return void
*/
public function clearPermissions(){
$permManager = PermissionManager::getInstance();
$permManager->unsubscribeFromAllPermissions($this->parent ?? $this);

View File

@ -192,6 +192,8 @@ class Permission{
/**
* @param string $value
*
* @return void
*/
public function setDefault(string $value){
if($value !== $this->defaultValue){
@ -209,6 +211,8 @@ class Permission{
/**
* @param string $value
*
* @return void
*/
public function setDescription(string $value){
$this->description = $value;
@ -221,6 +225,9 @@ class Permission{
return PermissionManager::getInstance()->getPermissionSubscriptions($this->name);
}
/**
* @return void
*/
public function recalculatePermissibles(){
$perms = $this->getPermissibles();

View File

@ -65,6 +65,8 @@ class PermissionAttachment{
/**
* @param PermissionRemovedExecutor $ex
*
* @return void
*/
public function setRemovalCallback(PermissionRemovedExecutor $ex){
$this->removed = $ex;
@ -91,6 +93,9 @@ class PermissionAttachment{
return $this->permissions;
}
/**
* @return void
*/
public function clearPermissions(){
$this->permissions = [];
$this->permissible->recalculatePermissions();
@ -98,6 +103,8 @@ class PermissionAttachment{
/**
* @param bool[] $permissions
*
* @return void
*/
public function setPermissions(array $permissions){
foreach($permissions as $key => $value){
@ -108,6 +115,8 @@ class PermissionAttachment{
/**
* @param string[] $permissions
*
* @return void
*/
public function unsetPermissions(array $permissions){
foreach($permissions as $node){
@ -119,6 +128,8 @@ class PermissionAttachment{
/**
* @param string|Permission $name
* @param bool $value
*
* @return void
*/
public function setPermission($name, bool $value){
$name = $name instanceof Permission ? $name->getName() : $name;
@ -134,6 +145,8 @@ class PermissionAttachment{
/**
* @param string|Permission $name
*
* @return void
*/
public function unsetPermission($name){
$name = $name instanceof Permission ? $name->getName() : $name;

View File

@ -79,6 +79,8 @@ class PermissionManager{
/**
* @param string|Permission $permission
*
* @return void
*/
public function removePermission($permission){
if($permission instanceof Permission){
@ -103,6 +105,8 @@ class PermissionManager{
/**
* @param Permission $permission
*
* @return void
*/
public function recalculatePermissionDefaults(Permission $permission){
if(isset($this->permissions[$permission->getName()])){
@ -141,6 +145,8 @@ class PermissionManager{
/**
* @param string $permission
* @param Permissible $permissible
*
* @return void
*/
public function subscribeToPermission(string $permission, Permissible $permissible){
if(!isset($this->permSubs[$permission])){
@ -152,6 +158,8 @@ class PermissionManager{
/**
* @param string $permission
* @param Permissible $permissible
*
* @return void
*/
public function unsubscribeFromPermission(string $permission, Permissible $permissible){
if(isset($this->permSubs[$permission])){
@ -186,6 +194,8 @@ class PermissionManager{
/**
* @param bool $op
* @param Permissible $permissible
*
* @return void
*/
public function subscribeToDefaultPerms(bool $op, Permissible $permissible){
if($op){
@ -198,6 +208,8 @@ class PermissionManager{
/**
* @param bool $op
* @param Permissible $permissible
*
* @return void
*/
public function unsubscribeFromDefaultPerms(bool $op, Permissible $permissible){
if($op){

View File

@ -36,6 +36,8 @@ interface ServerOperator{
* Sets the operator permission for the current object
*
* @param bool $value
*
* @return void
*/
public function setOp(bool $value);
}