FolderPluginLoader Class Reference

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

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()){
            MainLogger::getLogger()->info("Disabling " . $plugin->getDescription()->getFullName());

            Server::getInstance()->getPluginManager()->callEvent(new PluginDisableEvent($plugin));

            $plugin->setEnabled(false);
        }
    }

enablePlugin()

enablePlugin

(

Plugin

$plugin

)

Parameters

Plugin

$plugin

Implements PluginLoader.

                                                {
        if($plugin instanceof PluginBase and !$plugin->isEnabled()){
            MainLogger::getLogger()->info("Enabling " . $plugin->getDescription()->getFullName());

            $plugin->setEnabled(true);

            Server::getInstance()->getPluginManager()->callEvent(new PluginEnableEvent($plugin));
        }
    }

getPluginDescription()

getPluginDescription

(

$file

)

Gets the PluginDescription from the file

Parameters

string

$file

Returns

PluginDescription

Implements PluginLoader.

                                               {
        if(is_dir($file) and file_exists($file . "/plugin.yml")){
            $yaml = @file_get_contents($file . "/plugin.yml");
            if($yaml != ""){
                return new PluginDescription($yaml);
            }
        }

        return null;
    }

getPluginFilters()

getPluginFilters

(

)

Returns the filename patterns that this loader accepts

Returns

array|string

Implements PluginLoader.

                                      {
        return "/[^\\.]/";
    }

loadPlugin()

loadPlugin

(

$file

)

Loads the plugin contained in $file

Parameters

string

$file

Returns

Plugin

Implements PluginLoader.

                                     {
        if(is_dir($file) and file_exists($file . "/plugin.yml") and file_exists($file . "/src/")){
            if(($description = $this->getPluginDescription($file)) instanceof PluginDescription){
                MainLogger::getLogger()->info(TextFormat::LIGHT_PURPLE . "Loading (Source) " . $description->getFullName());
                $dataFolder = dirname($file) . DIRECTORY_SEPARATOR . $description->getName();
                if(file_exists($dataFolder) and !is_dir($dataFolder)){
                    trigger_error("Projected dataFolder '" . $dataFolder . "' for " . $description->getName() . " exists and is not a directory", E_USER_WARNING);

                    return null;
                }


                $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{
                    trigger_error("Couldn't load source plugin " . $description->getName() . ": main class not found", E_USER_WARNING);

                    return null;
                }
            }
        }

        return null;
    }

---

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

• src/pocketmine/plugin/FolderPluginLoader.php