More nullable and void typehints

This commit is contained in:
Dylan K. Taylor
2019-03-02 10:29:11 +00:00
parent 1f5c901f29
commit 6c8fa8ae28
108 changed files with 392 additions and 384 deletions

View File

@ -66,7 +66,7 @@ class BanEntry{
*
* @throws \InvalidArgumentException
*/
public function setCreated(\DateTime $date){
public function setCreated(\DateTime $date) : void{
self::validateDate($date);
$this->creationDate = $date;
}
@ -75,14 +75,14 @@ class BanEntry{
return $this->source;
}
public function setSource(string $source){
public function setSource(string $source) : void{
$this->source = $source;
}
/**
* @return \DateTime|null
*/
public function getExpires(){
public function getExpires() : ?\DateTime{
return $this->expirationDate;
}
@ -90,7 +90,7 @@ class BanEntry{
* @param \DateTime|null $date
* @throws \InvalidArgumentException
*/
public function setExpires(?\DateTime $date){
public function setExpires(?\DateTime $date) : void{
if($date !== null){
self::validateDate($date);
}
@ -108,7 +108,7 @@ class BanEntry{
return $this->reason;
}
public function setReason(string $reason){
public function setReason(string $reason) : void{
$this->reason = $reason;
}

View File

@ -62,7 +62,7 @@ class BanList{
/**
* @param bool $flag
*/
public function setEnabled(bool $flag){
public function setEnabled(bool $flag) : void{
$this->enabled = $flag;
}
@ -105,7 +105,7 @@ class BanList{
/**
* @param BanEntry $entry
*/
public function add(BanEntry $entry){
public function add(BanEntry $entry) : void{
$this->list[$entry->getName()] = $entry;
$this->save();
}
@ -133,7 +133,7 @@ class BanList{
/**
* @param string $name
*/
public function remove(string $name){
public function remove(string $name) : void{
$name = strtolower($name);
if(isset($this->list[$name])){
unset($this->list[$name]);
@ -141,7 +141,7 @@ class BanList{
}
}
public function removeExpired(){
public function removeExpired() : void{
foreach($this->list as $name => $entry){
if($entry->hasExpired()){
unset($this->list[$name]);
@ -149,7 +149,7 @@ class BanList{
}
}
public function load(){
public function load() : void{
$this->list = [];
$fp = @fopen($this->file, "r");
if(is_resource($fp)){
@ -176,7 +176,7 @@ class BanList{
/**
* @param bool $writeHeader
*/
public function save(bool $writeHeader = true){
public function save(bool $writeHeader = true) : void{
$this->removeExpired();
$fp = @fopen($this->file, "w");
if(is_resource($fp)){

View File

@ -45,7 +45,7 @@ abstract class DefaultPermissions{
return PermissionManager::getInstance()->getPermission($perm->getName());
}
public static function registerCorePermissions(){
public static function registerCorePermissions() : void{
$manager = PermissionManager::getInstance();
foreach(PermissionParser::loadPermissions(yaml_parse(file_get_contents(\pocketmine\RESOURCE_PATH . 'default_permissions.yml'))) as $permission){
$manager->addPermission($permission);

View File

@ -59,13 +59,13 @@ interface Permissible extends ServerOperator{
*
* @return void
*/
public function removeAttachment(PermissionAttachment $attachment);
public function removeAttachment(PermissionAttachment $attachment) : void;
/**
* @return void
*/
public function recalculatePermissions();
public function recalculatePermissions() : void;
/**
* @return PermissionAttachmentInfo[]

View File

@ -65,7 +65,7 @@ class PermissibleBase implements Permissible{
/**
* @param bool $value
*/
public function setOp(bool $value){
public function setOp(bool $value) : void{
$this->opable->setOp($value);
}
@ -130,7 +130,7 @@ class PermissibleBase implements Permissible{
/**
* @param PermissionAttachment $attachment
*/
public function removeAttachment(PermissionAttachment $attachment){
public function removeAttachment(PermissionAttachment $attachment) : void{
if(isset($this->attachments[spl_object_id($attachment)])){
unset($this->attachments[spl_object_id($attachment)]);
if(($ex = $attachment->getRemovalCallback()) !== null){
@ -143,7 +143,7 @@ class PermissibleBase implements Permissible{
}
public function recalculatePermissions(){
public function recalculatePermissions() : void{
Timings::$permissibleCalculationTimer->startTiming();
$this->clearPermissions();
@ -165,7 +165,7 @@ class PermissibleBase implements Permissible{
Timings::$permissibleCalculationTimer->stopTiming();
}
public function clearPermissions(){
public function clearPermissions() : void{
$permManager = PermissionManager::getInstance();
$permManager->unsubscribeFromAllPermissions($this->parent ?? $this);
@ -180,7 +180,7 @@ class PermissibleBase implements Permissible{
* @param bool $invert
* @param PermissionAttachment|null $attachment
*/
private function calculateChildPermissions(array $children, bool $invert, ?PermissionAttachment $attachment){
private function calculateChildPermissions(array $children, bool $invert, ?PermissionAttachment $attachment) : void{
$permManager = PermissionManager::getInstance();
foreach($children as $name => $v){
$perm = $permManager->getPermission($name);

View File

@ -93,7 +93,7 @@ class Permission{
/**
* @param string $value
*/
public function setDefault(string $value){
public function setDefault(string $value) : void{
if($value !== $this->defaultValue){
$this->defaultValue = $value;
$this->recalculatePermissibles();
@ -110,7 +110,7 @@ class Permission{
/**
* @param string $value
*/
public function setDescription(string $value){
public function setDescription(string $value) : void{
$this->description = $value;
}
@ -121,7 +121,7 @@ class Permission{
return PermissionManager::getInstance()->getPermissionSubscriptions($this->name);
}
public function recalculatePermissibles(){
public function recalculatePermissibles() : void{
$perms = $this->getPermissibles();
PermissionManager::getInstance()->recalculatePermissionDefaults($this);
@ -138,7 +138,7 @@ class Permission{
*
* @return Permission|null Permission if $name is a string, null if it's a Permission
*/
public function addParent($name, bool $value){
public function addParent($name, bool $value) : ?Permission{
if($name instanceof Permission){
$name->getChildren()[$this->getName()] = $value;
$name->recalculatePermissibles();

View File

@ -66,14 +66,14 @@ class PermissionAttachment{
/**
* @param PermissionRemovedExecutor $ex
*/
public function setRemovalCallback(PermissionRemovedExecutor $ex){
public function setRemovalCallback(PermissionRemovedExecutor $ex) : void{
$this->removed = $ex;
}
/**
* @return PermissionRemovedExecutor|null
*/
public function getRemovalCallback(){
public function getRemovalCallback() : ?PermissionRemovedExecutor{
return $this->removed;
}
@ -91,7 +91,7 @@ class PermissionAttachment{
return $this->permissions;
}
public function clearPermissions(){
public function clearPermissions() : void{
$this->permissions = [];
$this->permissible->recalculatePermissions();
}
@ -99,7 +99,7 @@ class PermissionAttachment{
/**
* @param bool[] $permissions
*/
public function setPermissions(array $permissions){
public function setPermissions(array $permissions) : void{
foreach($permissions as $key => $value){
$this->permissions[$key] = (bool) $value;
}
@ -109,7 +109,7 @@ class PermissionAttachment{
/**
* @param string[] $permissions
*/
public function unsetPermissions(array $permissions){
public function unsetPermissions(array $permissions) : void{
foreach($permissions as $node){
unset($this->permissions[$node]);
}
@ -120,7 +120,7 @@ class PermissionAttachment{
* @param string|Permission $name
* @param bool $value
*/
public function setPermission($name, bool $value){
public function setPermission($name, bool $value) : void{
$name = $name instanceof Permission ? $name->getName() : $name;
if(isset($this->permissions[$name])){
if($this->permissions[$name] === $value){
@ -135,7 +135,7 @@ class PermissionAttachment{
/**
* @param string|Permission $name
*/
public function unsetPermission($name){
public function unsetPermission($name) : void{
$name = $name instanceof Permission ? $name->getName() : $name;
if(isset($this->permissions[$name])){
unset($this->permissions[$name]);
@ -146,7 +146,7 @@ class PermissionAttachment{
/**
* @return void
*/
public function remove(){
public function remove() : void{
$this->permissible->removeAttachment($this);
}
}

View File

@ -69,7 +69,7 @@ class PermissionAttachmentInfo{
/**
* @return PermissionAttachment|null
*/
public function getAttachment(){
public function getAttachment() : ?PermissionAttachment{
return $this->attachment;
}

View File

@ -57,7 +57,7 @@ class PermissionManager{
*
* @return null|Permission
*/
public function getPermission(string $name){
public function getPermission(string $name) : ?Permission{
return $this->permissions[$name] ?? null;
}
@ -80,7 +80,7 @@ class PermissionManager{
/**
* @param string|Permission $permission
*/
public function removePermission($permission){
public function removePermission($permission) : void{
if($permission instanceof Permission){
unset($this->permissions[$permission->getName()]);
}else{
@ -104,7 +104,7 @@ class PermissionManager{
/**
* @param Permission $permission
*/
public function recalculatePermissionDefaults(Permission $permission){
public function recalculatePermissionDefaults(Permission $permission) : void{
if(isset($this->permissions[$permission->getName()])){
unset($this->defaultPermsOp[$permission->getName()]);
unset($this->defaultPerms[$permission->getName()]);
@ -115,7 +115,7 @@ class PermissionManager{
/**
* @param Permission $permission
*/
private function calculatePermissionDefault(Permission $permission){
private function calculatePermissionDefault(Permission $permission) : void{
Timings::$permissionDefaultTimer->startTiming();
if($permission->getDefault() === Permission::DEFAULT_OP or $permission->getDefault() === Permission::DEFAULT_TRUE){
$this->defaultPermsOp[$permission->getName()] = $permission;
@ -132,7 +132,7 @@ class PermissionManager{
/**
* @param bool $op
*/
private function dirtyPermissibles(bool $op){
private function dirtyPermissibles(bool $op) : void{
foreach($this->getDefaultPermSubscriptions($op) as $p){
$p->recalculatePermissions();
}
@ -142,7 +142,7 @@ class PermissionManager{
* @param string $permission
* @param Permissible $permissible
*/
public function subscribeToPermission(string $permission, Permissible $permissible){
public function subscribeToPermission(string $permission, Permissible $permissible) : void{
if(!isset($this->permSubs[$permission])){
$this->permSubs[$permission] = [];
}
@ -153,7 +153,7 @@ class PermissionManager{
* @param string $permission
* @param Permissible $permissible
*/
public function unsubscribeFromPermission(string $permission, Permissible $permissible){
public function unsubscribeFromPermission(string $permission, Permissible $permissible) : void{
if(isset($this->permSubs[$permission])){
unset($this->permSubs[$permission][spl_object_id($permissible)]);
if(count($this->permSubs[$permission]) === 0){
@ -187,7 +187,7 @@ class PermissionManager{
* @param bool $op
* @param Permissible $permissible
*/
public function subscribeToDefaultPerms(bool $op, Permissible $permissible){
public function subscribeToDefaultPerms(bool $op, Permissible $permissible) : void{
if($op){
$this->defSubsOp[spl_object_id($permissible)] = $permissible;
}else{
@ -199,7 +199,7 @@ class PermissionManager{
* @param bool $op
* @param Permissible $permissible
*/
public function unsubscribeFromDefaultPerms(bool $op, Permissible $permissible){
public function unsubscribeFromDefaultPerms(bool $op, Permissible $permissible) : void{
if($op){
unset($this->defSubsOp[spl_object_id($permissible)]);
}else{

View File

@ -31,5 +31,5 @@ interface PermissionRemovedExecutor{
*
* @return void
*/
public function attachmentRemoved(PermissionAttachment $attachment);
public function attachmentRemoved(PermissionAttachment $attachment) : void;
}

View File

@ -37,5 +37,5 @@ interface ServerOperator{
*
* @param bool $value
*/
public function setOp(bool $value);
public function setOp(bool $value) : void;
}