Page History

...

• /plugins/
  • my_plugin/
    • controllers/
    • models/
    • views/
    • language/
    • my_plugin_controller.php
    • my_plugin_model.php
    • my_plugin_plugin.php
    • config.json (for version 3.1+)

my_plugin_controller.php is the plugin's parent controller. This controller can be used to add supporting methods for the other controllers to inherit. Similarly, my_plugin_model.php is the plugin's parent model and can be used to add supporting methods for the other models to inherit.

...

Finally, my_plugin_plugin.php is a special class that must extend the Plugin class of /components/plugins/lib/plugin.php. This class is used for installing, upgrading, uninstalling, and branding the plugin in conjunction with the config.json file.

Install Logic

If your plugin requires any code to execute when installed, place that logic in your plugin's install() method.

...

<?php
class MyPluginPlugin extends Plugin {

    public function __construct() {
        Loader::loadComponents($this, array("Input"));
    }

    ...

    public function upgrade($current_version, $plugin_id) {
        // Ensure new version is greater than installed version
        if (version_compare($this->version, $current_version) < 0) {
            $this->Input->setErrors(array(
                'version' => array(
                    'invalid' => "Downgrades are not allowed."
                )
            );
            return;
        }
    }
}
?>

Branding The Plugin

For version 3.1+ simply create a config.json file and include it in the constructor of your plugin.

{
    "version": "1.0.0",
    "name": "My Plugin Name",
    "description": "A plugin like no other!",
    "authors": [
        {
            "name": "Phillips Data, Inc.",
            "url": "http://www.blesta.com"
        }
    ]
}

<?php
class MyPluginPlugin extends Plugin {
    public function __construct() {
        $this->loadConfig(dirname(__FILE__) . DS . "config.json");
    }
}
?>

For version 3.0, you must define all of the branding details through methods.

<?php
class MyPluginPlugin extends Plugin {

    ...

    public function getName() {
		return "MyPlugin";
    }

	public function getVersion() {
		return "1.0.0";
	}

	public function getAuthors() {
		return array(
			array(
				'name' => "MyCompany",
				'url' => "http://www.mycompanyplugindevelopment.com"
			)
		);
	}
}
?>

...

<?php
class MyPluginPlugin extends Plugin {

    ...

    public function getLogo() {
		return "views" . DS . "default" . DS . "images" . DS . "some_other_logo.png";
    }
}
?>

Managing a Plugin

If your plugin requires certain configurable options, you can create a management link viewable to staff members that have access to installed plugins. To do so, all you need to do is create an AdminManagePlugin controller. This is a special controller that is initialized by Blesta internally, so all views must be returned (as strings) from the requested action methods.

...