Permission Class Reference

Public Member Functions
	__construct ($name, $description=null, $defaultValue=null, array $children=[])
	getName ()
&	getChildren ()
	getDefault ()
	setDefault ($value)
	getDescription ()
	setDescription ($value)
	getPermissibles ()
	recalculatePermissibles ()
	addParent ($name, $value)

Static Public Member Functions
static	getByName ($value)
static	loadPermissions (array $data, $default=self::DEFAULT_OP)
static	loadPermission ($name, array $data, $default=self::DEFAULT_OP, &$output=[])

Data Fields
const	DEFAULT_OP = "op"
const	DEFAULT_NOT_OP = "notop"
const	DEFAULT_TRUE = "true"
const	DEFAULT_FALSE = "false"

Static Public Attributes
static	$DEFAULT_PERMISSION = self::DEFAULT_OP

Detailed Description

Represents a permission

Constructor & Destructor Documentation

__construct()

__construct	(		$name,
			$description = null,
			$defaultValue = null,
		array	$children = []
	)

Creates a new Permission object to be attached to Permissible objects

Parameters

string	$name
string	$description
string	$defaultValue
	Permission[]	$children

                                                                                                       {
        $this->name = $name;
        $this->description = $description !== null ? $description : "";
        $this->defaultValue = $defaultValue !== null ? $defaultValue : self::$DEFAULT_PERMISSION;
        $this->children = $children;

        $this->recalculatePermissibles();
    }

Member Function Documentation

addParent()

addParent	(		$name,
			$value
	)

Parameters

string | Permission	$name
	$value

Returns

Permission|null Permission if $name is a string, void if it's a Permission

                                            {
        if($name instanceof Permission){
            $name->getChildren()[$this->getName()] = $value;
            $name->recalculatePermissibles();
            return null;
        }else{
            $perm = Server::getInstance()->getPluginManager()->getPermission($name);
            if($perm === null){
                $perm = new Permission($name);
                Server::getInstance()->getPluginManager()->addPermission($perm);
            }

            $this->addParent($perm, $value);

            return $perm;
        }
    }

getByName()

static getByName (   $value )

static

Parameters

$value

Returns

string

                                            {
        if(is_bool($value)){
            if($value === true){
                return "true";
            }else{
                return "false";
            }
        }
        switch(strtolower($value)){
            case "op":
            case "isop":
            case "operator":
            case "isoperator":
            case "admin":
            case "isadmin":
                return self::DEFAULT_OP;

            case "!op":
            case "notop":
            case "!operator":
            case "notoperator":
            case "!admin":
            case "notadmin":
                return self::DEFAULT_NOT_OP;

            case "true":
                return self::DEFAULT_TRUE;

            default:
                return self::DEFAULT_FALSE;
        }
    }

getChildren()

& getChildren

(

)

Returns

string[]

                                  {
        return $this->children;
    }

getDefault()

getDefault

(

)

Returns

string

                                {
        return $this->defaultValue;
    }

getDescription()

getDescription

(

)

Returns

string

                                    {
        return $this->description;
    }

getName()

getName

(

)

Returns

string

                              : string{
        return $this->name;
    }

getPermissibles()

getPermissibles

(

)

Returns

Permissible[]

                                     {
        return Server::getInstance()->getPluginManager()->getPermissionSubscriptions($this->name);
    }

loadPermission()

static loadPermission (   $name, array  $data,   $default = self::DEFAULT_OP, &  $output = []  )

static

Parameters

string	$name
array	$data
string	$default
array	$output

Returns

Permission

Exceptions

                                                                                                       {
        $desc = null;
        $children = [];
        if(isset($data["default"])){
            $value = Permission::getByName($data["default"]);
            if($value !== null){
                $default = $value;
            }else{
                throw new \InvalidStateException("'default' key contained unknown value");
            }
        }

        if(isset($data["children"])){
            if(is_array($data["children"])){
                foreach($data["children"] as $k => $v){
                    if(is_array($v)){
                        if(($perm = self::loadPermission($k, $v, $default, $output)) !== null){
                            $output[] = $perm;
                        }
                    }
                    $children[$k] = true;
                }
            }else{
                throw new \InvalidStateException("'children' key is of wrong type");
            }
        }

        if(isset($data["description"])){
            $desc = $data["description"];
        }

        return new Permission($name, $desc, $default, $children);

    }

loadPermissions()

static loadPermissions ( array  $data,   $default = self::DEFAULT_OP  )

static

Parameters

array	$data
	$default

Returns

Permission[]

                                                                                  {
        $result = [];
        foreach($data as $key => $entry){
            $result[] = self::loadPermission($key, $entry, $default, $result);
        }

        return $result;
    }

recalculatePermissibles()

recalculatePermissibles

(

)

                                             {
        $perms = $this->getPermissibles();

        Server::getInstance()->getPluginManager()->recalculatePermissionDefaults($this);

        foreach($perms as $p){
            $p->recalculatePermissions();
        }
    }

setDefault()

setDefault

(

$value

)

Parameters

string

$value

                                      {
        if($value !== $this->defaultValue){
            $this->defaultValue = $value;
            $this->recalculatePermissibles();
        }
    }

setDescription()

setDescription

(

$value

)

Parameters

string

$value

                                          {
        $this->description = $value;
    }

Field Documentation

$DEFAULT_PERMISSION

$DEFAULT_PERMISSION = self::DEFAULT_OP

static

DEFAULT_FALSE

const DEFAULT_FALSE = "false"

DEFAULT_NOT_OP

const DEFAULT_NOT_OP = "notop"

DEFAULT_OP

const DEFAULT_OP = "op"

DEFAULT_TRUE

const DEFAULT_TRUE = "true"

---

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

• src/pocketmine/permission/Permission.php