PharPluginLoader Class Reference

Public Member Functions
	__construct (Server $server)
	loadPlugin ($file)
	getPluginDescription ($file)
	getPluginFilters ()
	enablePlugin (Plugin $plugin)
	disablePlugin (Plugin $plugin)

Detailed Description

Handles different types of plugins

Constructor & Destructor Documentation

__construct()

__construct

(

Server

$server

)

Parameters

Server

$server

                                               {
        $this->server = $server;
    }

Member Function Documentation

disablePlugin()

disablePlugin

(

Plugin

$plugin

)

Parameters

Plugin

$plugin

Implements PluginLoader.

                                                 {
        if($plugin instanceof PluginBase and $plugin->isEnabled()){
            $this->server->getLogger()->info($this->server->getLanguage()->translateString("pocketmine.plugin.disable", [$plugin->getDescription()->getFullName()]));

            $this->server->getPluginManager()->callEvent(new PluginDisableEvent($plugin));

            $plugin->setEnabled(false);
        }
    }

enablePlugin()

enablePlugin

(

Plugin

$plugin

)

Parameters

Plugin

$plugin

Implements PluginLoader.

                                                {
        if($plugin instanceof PluginBase and !$plugin->isEnabled()){
            $this->server->getLogger()->info($this->server->getLanguage()->translateString("pocketmine.plugin.enable", [$plugin->getDescription()->getFullName()]));

            $plugin->setEnabled(true);

            $this->server->getPluginManager()->callEvent(new PluginEnableEvent($plugin));
        }
    }

getPluginDescription()

getPluginDescription

(

$file

)

Gets the PluginDescription from the file

Parameters

string

$file

Returns

PluginDescription

Implements PluginLoader.

                                               {
        $phar = new \Phar($file);
        if(isset($phar["plugin.yml"])){
            $pluginYml = $phar["plugin.yml"];
            if($pluginYml instanceof \PharFileInfo){
                return new PluginDescription($pluginYml->getContent());
            }
        }

        return null;
    }

getPluginFilters()

getPluginFilters

(

)

Returns the filename patterns that this loader accepts

Returns

string

Implements PluginLoader.

                                      {
        return "/\\.phar$/i";
    }

loadPlugin()

loadPlugin

(

$file

)

Loads the plugin contained in $file

Parameters

string

$file

Returns

Plugin

Exceptions

Implements PluginLoader.

                                     {
        if(($description = $this->getPluginDescription($file)) instanceof PluginDescription){
            $this->server->getLogger()->info($this->server->getLanguage()->translateString("pocketmine.plugin.load", [$description->getFullName()]));
            $dataFolder = dirname($file) . DIRECTORY_SEPARATOR . $description->getName();
            if(file_exists($dataFolder) and !is_dir($dataFolder)){
                throw new \InvalidStateException("Projected dataFolder '" . $dataFolder . "' for " . $description->getName() . " exists and is not a directory");
            }
            $file = "phar://$file";
            $className = $description->getMain();
            $this->server->getLoader()->addPath("$file/src");

            if(class_exists($className, true)){
                $plugin = new $className();
                $this->initPlugin($plugin, $description, $dataFolder, $file);

                return $plugin;
            }else{
                throw new PluginException("Couldn't load plugin " . $description->getName() . ": main class not found");
            }
        }

        return null;
    }

---

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

• src/pocketmine/plugin/PharPluginLoader.php