Page History

<?php
class MyPluginPluginMyPlgnPlugin extends Plugin {

    ...

    public function install($plugin_id) {
        #
        # TODO: Place installation logic here
        #
    }
}
?>

<?php 
class MyPluginPluginMyPlgnPlugin extends Plugin { 

    ... 

    public function uninstall($plugin_id, $last_instance) {
        #
        # TODO: Place uninstallation logic here 
        #
    } 
} 
?>

<?php
class MyPluginPluginMyPlgnPlugin extends Plugin {

    ...

    public function upgrade($current_version, $plugin_id) {
        #
        # TODO: Place upgrade logic here
        #
    }

}
?>

<?php
class MyPluginPluginMyPlgnPlugin 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;
        }
    }
}
?>

All that any plugin truly requires is branding. These options come from three methods: getName(), getVersion(), getAuthors().

<?php
class MyPluginPluginMyPlgnPlugin 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"
			)]
		)];
	}
}
?>

The getAuthors() method requires a multi-dimensional array, so you can specify multiple authors if needed.

Lastly, each plugin needs a logo. By default these are loaded from /plugins/my_pluginplgn/views/default/images/logo.png. You can override the location of the logo file by implementing the getLogo() method in your plugin.

<?php
class MyPluginPluginMyPlgnPlugin extends Plugin {
    ...
    public function getLogo() {
        return "views" . DS . "default" . DS . "images" . DS . "some_other_logo.png";
    }
}
?>

Use the Language library to help internationalize your plugin. Just create a language directory in your plugin, then a directory for each language (i.e. /plugins/my_pluginplgn/language/en_us/) and place your language files in there. See Translating Blesta for how to load, format, and use language definitions.

<?php
class AdminManagePlugin extends AppController {

    /**
     * Performs necessary initialization
     */
    private function init()
    {
        // Set the view to render for all actions under this controller
        $this->view->setView(null, 'MyPlgn.default');
    }<?php
class AdminManagePlugin extends AppController {

    public function index() {
        $this->init();

		$var1 = "hello";
		$var2 = "world";
		return $this->partial("admin_manage_plugin", compact("var1", "var2"));
    }

	public function foo() {
        $this->init();

		return $this->partial("admin_manage_plugin_foo");
	}
}
?>

<a href="<?php echo $this->Html->safe($this->base_uri . "settings/company/plugins/manage/" . $this->Html->_($plugin_id, true) . "/?controller=admin_manage_plugin&action=foo");?>">Link to other action</a>