Config

class · pocketmine\utils\Config · source

Config Class for simple config manipulation of multiple formats.

Constants

CNF

public const CNF = \pocketmine\utils\Config::PROPERTIES

DETECT

public const DETECT = -1

ENUM

public const ENUM = 5

ENUMERATION

public const ENUMERATION = \pocketmine\utils\Config::ENUM

JSON

public const JSON = 1

PROPERTIES

public const PROPERTIES = 0

SERIALIZED

public const SERIALIZED = 4

YAML

public const YAML = 2

Properties

$formats

public static array $formats

Methods

__construct()

public function __construct(string $file, int $type = \pocketmine\utils\Config::DETECT, array $default = [])

__get()

public function __get($k)

__isset()

public function __isset($k)

__set()

public function __set($k, $v) : void

__unset()

public function __unset($k)

disableJsonOption()

public function disableJsonOption(int $option) : \pocketmine\utils\Config

Disables the given option for the JSON encoding when saving

enableJsonOption()

public function enableJsonOption(int $option) : \pocketmine\utils\Config

Enables the given option in addition to the currently set JSON options

exists()

public function exists(string $k, bool $lowercase = false) : bool

fixYAMLIndexes()

public static function fixYAMLIndexes(string $str) : string

get()

public function get(string $k, mixed $default = false) : mixed

getAll()

public function getAll(bool $keys = false) : array

getJsonOptions()

public function getJsonOptions() : int

Returns the options for the JSON encoding when saving

getNested()

public function getNested(string $key, mixed $default = null) : mixed

getPath()

public function getPath() : string

Returns the path of the config.

hasChanged()

public function hasChanged() : bool

parseList()

public static function parseList(string $content) : array

parseProperties()

public static function parseProperties(string $content) : array

reload()

public function reload() : void

Removes all the changes in memory and loads the file again

remove()

public function remove(string $k) : void

removeNested()

public function removeNested(string $key) : void

save()

public function save() : void

Flushes the config to disk in the appropriate format.

set()

public function set(string $k, mixed $v = true) : void

setAll()

public function setAll(array $v) : void

setChanged()

public function setChanged(bool $changed = true) : void

setDefaults()

public function setDefaults(array $defaults) : void

setJsonOptions()

public function setJsonOptions(int $options) : \pocketmine\utils\Config

Sets the options for the JSON encoding when saving

setNested()

public function setNested(string $key, mixed $value) : void

writeList()

public static function writeList(array $entries) : string

writeProperties()

public static function writeProperties(array $config) : string