PluginBase Class Reference

Public Member Functions
	onLoad ()
	onEnable ()
	onDisable ()
	isEnabled ()
	setEnabled ($boolean=true)
	isDisabled ()
	getDataFolder ()
	getDescription ()
	init (PluginLoader $loader, Server $server, PluginDescription $description, $dataFolder, $file)
	getLogger ()
	isInitialized ()
	getCommand ($name)
	onCommand (CommandSender $sender, Command $command, $label, array $args)
	getResource ($filename)
	saveResource ($filename, $replace=false)
	getResources ()
	getConfig ()
	saveConfig ()
	saveDefaultConfig ()
	reloadConfig ()
	getServer ()
	getName ()
	getFullName ()
	getPluginLoader ()

Protected Member Functions
	isPhar ()
	getFile ()

Member Function Documentation

getCommand()

getCommand

(

$name

)

Parameters

string

$name

Returns

Command|PluginIdentifiableCommand

                                     {
        $command = $this->getServer()->getPluginCommand($name);
        if($command === null or $command->getPlugin() !== $this){
            $command = $this->getServer()->getPluginCommand(strtolower($this->description->getName()) . ":" . $name);
        }

        if($command instanceof PluginIdentifiableCommand and $command->getPlugin() === $this){
            return $command;
        }else{
            return null;
        }
    }

getConfig()

getConfig

(

)

Returns

Config

Implements Plugin.

                               {
        if(!isset($this->config)){
            $this->reloadConfig();
        }

        return $this->config;
    }

getDataFolder()

getDataFolder ( )

final

Returns

string

Implements Plugin.

                                         {
        return $this->dataFolder;
    }

getDescription()

getDescription ( )

final

Returns

PluginDescription

Implements Plugin.

                                          {
        return $this->description;
    }

getFile()

getFile ( )

protected

Returns

mixed

                                {
        return $this->file;
    }

getFullName()

getFullName ( )

final

Returns

string

                                       {
        return $this->description->getFullName();
    }

getLogger()

getLogger

(

)

Returns

PluginLogger

Implements Plugin.

                               {
        return $this->logger;
    }

getName()

getName ( )

final

Returns

string

Implements Plugin.

                                   {
        return $this->description->getName();
    }

getPluginLoader()

getPluginLoader

(

)

Returns

PluginLoader

Implements Plugin.

                                     {
        return $this->loader;
    }

getResource()

getResource

(

$filename

)

Gets an embedded resource on the plugin file. WARNING: You must close the resource given using fclose()

Parameters

string

$filename

Returns

resource Resource data, or null

Implements Plugin.

                                          {
        $filename = rtrim(str_replace("\\", "/", $filename), "/");
        if(file_exists($this->file . "resources/" . $filename)){
            return fopen($this->file . "resources/" . $filename, "rb");
        }

        return null;
    }

getResources()

getResources

(

)

Returns all the resources packaged with the plugin

Returns

string[]

Implements Plugin.

                                  {
        $resources = [];
        if(is_dir($this->file . "resources/")){
            foreach(new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($this->file . "resources/")) as $resource){
                $resources[] = $resource;
            }
        }

        return $resources;
    }

getServer()

getServer ( )

final

Returns

Server

Implements Plugin.

                                     {
        return $this->server;
    }

init()

init ( PluginLoader  $loader, Server  $server, PluginDescription  $description,   $dataFolder,   $file  )

final

Parameters

PluginLoader	$loader
Server	$server
PluginDescription	$description
	$dataFolder
	$file

                                                                                                                        {
        if($this->initialized === false){
            $this->initialized = true;
            $this->loader = $loader;
            $this->server = $server;
            $this->description = $description;
            $this->dataFolder = rtrim($dataFolder, "\\/") . "/";
            $this->file = rtrim($file, "\\/") . "/";
            $this->configFile = $this->dataFolder . "config.yml";
            $this->logger = new PluginLogger($this);
        }
    }

isDisabled()

isDisabled ( )

final

Returns

bool

Implements Plugin.

                                      {
        return $this->isEnabled === false;
    }

isEnabled()

isEnabled ( )

final

Returns

bool

Implements Plugin.

                                     {
        return $this->isEnabled === true;
    }

isInitialized()

isInitialized ( )

final

Returns

bool

                                         {
        return $this->initialized;
    }

isPhar()

isPhar ( )

protected

Returns

bool

                               {
        return substr($this->file, 0, 7) === "phar://";
    }

onCommand()

onCommand	(	CommandSender	$sender,
		Command	$command,
			$label,
		array	$args
	)

Parameters

CommandSender	$sender
Command	$command
string	$label
array	$args

Returns

bool

Implements CommandExecutor.

                                                                                           {
        return false;
    }

onDisable()

onDisable

(

)

Called when the plugin is disabled Use this to free open things and finish actions

Implements Plugin.

                               {

    }

onEnable()

onEnable

(

)

Called when the plugin is enabled

Implements Plugin.

                              {

    }

onLoad()

onLoad

(

)

Called when the plugin is loaded, before calling onEnable()

Implements Plugin.

                            {

    }

reloadConfig()

reloadConfig

(

)

Returns

mixed

Implements Plugin.

                                  {
        $this->config = new Config($this->configFile);
        if(($configStream = $this->getResource("config.yml")) !== null){
            $this->config->setDefaults(yaml_parse(Config::fixYAMLIndexes(stream_get_contents($configStream))));
            fclose($configStream);
        }
    }

saveConfig()

saveConfig

(

)

Returns

mixed

Implements Plugin.

                                {
        if($this->getConfig()->save() === false){
            $this->getLogger()->critical("Could not save config to " . $this->configFile);
        }
    }

saveDefaultConfig()

saveDefaultConfig

(

)

Returns

mixed

Implements Plugin.

                                       {
        if(!file_exists($this->configFile)){
            $this->saveResource("config.yml", false);
        }
    }

saveResource()

saveResource	(		$filename,
			$replace = false
	)

Parameters

string	$filename
bool	$replace

Returns

bool

Implements Plugin.

                                                             {
        if(trim($filename) === ""){
            return false;
        }

        if(($resource = $this->getResource($filename)) === null){
            return false;
        }

        $out = $this->dataFolder . $filename;
        if(!file_exists(dirname($out))){
            mkdir(dirname($out), 0755, true);
        }

        if(file_exists($out) and $replace !== true){
            return false;
        }

        $ret = stream_copy_to_stream($resource, $fp = fopen($out, "wb")) > 0;
        fclose($fp);
        fclose($resource);
        return $ret;
    }

setEnabled()

setEnabled (   $boolean = true )

final

Parameters

bool

$boolean

                                                     {
        if($this->isEnabled !== $boolean){
            $this->isEnabled = $boolean;
            if($this->isEnabled === true){
                $this->onEnable();
            }else{
                $this->onDisable();
            }
        }
    }

---

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

• src/pocketmine/plugin/PluginBase.php