PermissionAttachment Class Reference

Public Member Functions
	__construct (Plugin $plugin, Permissible $permissible)
	getPlugin ()
	setRemovalCallback (PermissionRemovedExecutor $ex)
	getRemovalCallback ()
	getPermissible ()
	getPermissions ()
	clearPermissions ()
	setPermissions (array $permissions)
	unsetPermissions (array $permissions)
	setPermission ($name, $value)
	unsetPermission ($name)
	remove ()

Constructor & Destructor Documentation

__construct()

__construct	(	Plugin	$plugin,
		Permissible	$permissible
	)

Parameters

Plugin	$plugin
Permissible	$permissible

Exceptions

PluginException

                                                                         {
        if(!$plugin->isEnabled()){
            throw new PluginException("Plugin " . $plugin->getDescription()->getName() . " is disabled");
        }

        $this->permissible = $permissible;
        $this->plugin = $plugin;
    }

Member Function Documentation

clearPermissions()

clearPermissions

(

)

                                      {
        $this->permissions = [];
        $this->permissible->recalculatePermissions();
    }

getPermissible()

getPermissible

(

)

Returns

Permissible

                                    {
        return $this->permissible;
    }

getPermissions()

getPermissions

(

)

Returns

bool[]

                                    {
        return $this->permissions;
    }

getPlugin()

getPlugin

(

)

Returns

Plugin

                               {
        return $this->plugin;
    }

getRemovalCallback()

getRemovalCallback

(

)

Returns

PermissionRemovedExecutor

                                        {
        return $this->removed;
    }

remove()

remove

(

)

Returns

void

                            {
        $this->permissible->removeAttachment($this);
    }

setPermission()

setPermission	(		$name,
			$value
	)

Parameters

string | Permission	$name
bool	$value

                                                {
        $name = $name instanceof Permission ? $name->getName() : $name;
        if(isset($this->permissions[$name])){
            if($this->permissions[$name] === $value){
                return;
            }
            unset($this->permissions[$name]); //Fixes children getting overwritten
        }
        $this->permissions[$name] = $value;
        $this->permissible->recalculatePermissions();
    }

setPermissions()

setPermissions

(

array

$permissions

)

Parameters

bool[]

$permissions

                                                      {
        foreach($permissions as $key => $value){
            $this->permissions[$key] = (bool) $value;
        }
        $this->permissible->recalculatePermissions();
    }

setRemovalCallback()

setRemovalCallback

(

PermissionRemovedExecutor

$ex

)

Parameters

PermissionRemovedExecutor

$ex

                                                                     {
        $this->removed = $ex;
    }

unsetPermission()

unsetPermission

(

$name

)

Parameters

string | Permission

$name

                                          {
        $name = $name instanceof Permission ? $name->getName() : $name;
        if(isset($this->permissions[$name])){
            unset($this->permissions[$name]);
            $this->permissible->recalculatePermissions();
        }
    }

unsetPermissions()

unsetPermissions

(

array

$permissions

)

Parameters

string[]

$permissions

                                                        {
        foreach($permissions as $node){
            unset($this->permissions[$node]);
        }
        $this->permissible->recalculatePermissions();
    }

---

The documentation for this class was generated from the following file:

• src/pocketmine/permission/PermissionAttachment.php