PermissibleBase Class Reference

Public Member Functions
	__construct (ServerOperator $opable)
	__destruct ()
	isOp ()
	setOp ($value)
	isPermissionSet ($name)
	hasPermission ($name)
	addAttachment (Plugin $plugin, $name=null, $value=null)
	removeAttachment (PermissionAttachment $attachment)
	recalculatePermissions ()
	clearPermissions ()
	getEffectivePermissions ()

Constructor & Destructor Documentation

__construct()

__construct

(

ServerOperator

$opable

)

Parameters

ServerOperator

$opable

                                                       {
        $this->opable = $opable;
        if($opable instanceof Permissible){
            $this->parent = $opable;
        }
    }

__destruct()

__destruct

(

)

                                {
        $this->parent = null;
        $this->opable = null;
    }

Member Function Documentation

addAttachment()

addAttachment	(	Plugin	$plugin,
			$name = null,
			$value = null
	)

//TODO: tick scheduled attachments

Parameters

Plugin	$plugin
string	$name
bool	$value

Returns

PermissionAttachment

Exceptions

PluginException

Implements Permissible.

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

        $result = new PermissionAttachment($plugin, $this->parent !== null ? $this->parent : $this);
        $this->attachments[spl_object_hash($result)] = $result;
        if($name !== null and $value !== null){
            $result->setPermission($name, $value);
        }

        $this->recalculatePermissions();

        return $result;
    }

clearPermissions()

clearPermissions

(

)

                                      {
        foreach(array_keys($this->permissions) as $name){
            Server::getInstance()->getPluginManager()->unsubscribeFromPermission($name, $this->parent !== null ? $this->parent : $this);
        }

        Server::getInstance()->getPluginManager()->unsubscribeFromDefaultPerms(false, $this->parent !== null ? $this->parent : $this);
        Server::getInstance()->getPluginManager()->unsubscribeFromDefaultPerms(true, $this->parent !== null ? $this->parent : $this);

        $this->permissions = [];
    }

getEffectivePermissions()

getEffectivePermissions

(

)

Returns

PermissionAttachmentInfo[]

Implements Permissible.

                                             {
        return $this->permissions;
    }

hasPermission()

hasPermission

(

$name

)

Parameters

Permission | string

$name

Returns

bool

Implements Permissible.

                                        {
        if($name instanceof Permission){
            $name = $name->getName();
        }

        if($this->isPermissionSet($name)){
            return $this->permissions[$name]->getValue();
        }

        if(($perm = Server::getInstance()->getPluginManager()->getPermission($name)) !== null){
            $perm = $perm->getDefault();

            return $perm === Permission::DEFAULT_TRUE or ($this->isOp() and $perm === Permission::DEFAULT_OP) or (!$this->isOp() and $perm === Permission::DEFAULT_NOT_OP);
        }else{
            return Permission::$DEFAULT_PERMISSION === Permission::DEFAULT_TRUE or ($this->isOp() and Permission::$DEFAULT_PERMISSION === Permission::DEFAULT_OP) or (!$this->isOp() and Permission::$DEFAULT_PERMISSION === Permission::DEFAULT_NOT_OP);
        }

    }

isOp()

isOp

(

)

Returns

bool

Implements ServerOperator.

                          {
        if($this->opable === null){
            return false;
        }else{
            return $this->opable->isOp();
        }
    }

isPermissionSet()

isPermissionSet

(

$name

)

Parameters

Permission | string

$name

Returns

bool

Implements Permissible.

                                          {
        return isset($this->permissions[$name instanceof Permission ? $name->getName() : $name]);
    }

recalculatePermissions()

recalculatePermissions

(

)

Returns

void

Implements Permissible.

                                            {
        Timings::$permissibleCalculationTimer->startTiming();

        $this->clearPermissions();
        $defaults = Server::getInstance()->getPluginManager()->getDefaultPermissions($this->isOp());
        Server::getInstance()->getPluginManager()->subscribeToDefaultPerms($this->isOp(), $this->parent !== null ? $this->parent : $this);

        foreach($defaults as $perm){
            $name = $perm->getName();
            $this->permissions[$name] = new PermissionAttachmentInfo($this->parent !== null ? $this->parent : $this, $name, null, true);
            Server::getInstance()->getPluginManager()->subscribeToPermission($name, $this->parent !== null ? $this->parent : $this);
            $this->calculateChildPermissions($perm->getChildren(), false, null);
        }

        foreach($this->attachments as $attachment){
            $this->calculateChildPermissions($attachment->getPermissions(), false, $attachment);
        }

        Timings::$permissibleCalculationTimer->stopTiming();
    }

removeAttachment()

removeAttachment

(

PermissionAttachment

$attachment

)

Parameters

PermissionAttachment

$attachment

Exceptions

Implements Permissible.

                                                                      {
        if($attachment === null){
            throw new \InvalidStateException("Attachment cannot be null");
        }

        if(isset($this->attachments[spl_object_hash($attachment)])){
            unset($this->attachments[spl_object_hash($attachment)]);
            if(($ex = $attachment->getRemovalCallback()) !== null){
                $ex->attachmentRemoved($attachment);
            }

            $this->recalculatePermissions();

        }

    }

setOp()

setOp

(

$value

)

Parameters

bool

$value

Exceptions

Implements ServerOperator.

                                 {
        if($this->opable === null){
            throw new \LogicException("Cannot change op value as no ServerOperator is set");
        }else{
            $this->opable->setOp($value);
        }
    }

---

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

• src/pocketmine/permission/PermissibleBase.php