Plugin setup page

Setting up your plugin made easy for our customers

To create a new plugin is always a lot of work, so you are building your plugin to comfort the PowerPanel customers that don't have to develop it themselves. You also need to make sure your plugin is easy to setup. A lot of users don't understand terms like json, php, xml, rest and so on. So we need to take care not bothering the users with complex settings and a complex plugin setup. Therefore we created a universal plugin setup system. All plugins interact with different modules in PowerPanel, but the plugin setup is the same for all plugins. You are free to use as many setup parameters you need, but always keep in mind to "keep it simple".

Each setup parameter your plugin needs, you will have to give it a label and a small description. You can use the following input types:

• text (gives a input text box)
• password (gives a password input box, always use this for passwords or hashes)
• switch (gives a nice switch, use this for true of false values)
• select (gives a select box, you can supply options also, check this document for details)

The plugin setup also supports multi language. English (en) is the default. If 'en' is not defined your plugin will be rejected, so make sure you have always English included. All other languages are free to add.

The plugin setup supports one image, this can be used for a logo or other related image.

If all the information is added to the plugin setup parameters, it will look like the images below:

The image above shows how it looks in the PowerPanel marketplace and on our website.

This image shows the setup page for the user that has to enter the information to use this plugin.

Okay, how do I create this setup page for my Plugin?

Short awnser: Create 3 json objects bundles of your plugin and you're good to go:

Object 1: Plugin description:

{
  "title": {
    "nl": "Short plugin title",
    "en": "Korte plugin titel",
    "es":""
  },
  "subject": {
    "en": "Something interesting for your plugin",
    "nl": "Iets interessants over jouw plugin",
    "es":""
  },
  "description": {
    "en": "Description about your plugins, what is does and how it can help your customers.",
    "nl": "Omschrijving van je plugin wat het doet en hoe het je klant kan helpen.",
    "es":""
  }
}

Object 2: Plugin setup settings:

{
  "address": {
    "label": {
      "en": "Field name / label",
      "nl": "Veld naam / label"
    },
    "type": "text",
    "tooltip": {
      "en": "This is a tooltip showing extra information on the label",
      "nl": "Dit is een tooltip met extra informatie welke getoond wordt bij het label"
    },
    "value": "default value"
  }
}

Object 3: Plugin extra settings: In same cases you need extra information to have your plugin working correctly, in this case you can discuss the options with our developers. Below there is an example on how to use:

• add a 'function' array, this functions will executed on plugin setup. So (if needed) the plugin can start the/these function(s) after enabling the plugin. Use this for retrieving information or license settings.
• add an object called 'server_support'. This one is mandatory and need to have at least this function: 'testConnection'. To make sure customer has enter the correct details in the plugin setup.

{
  "function": ["getTLDPrices", "retrieveDomains"],
  "server_support": {
    "testConnection": [
      "address",
      "login",
      "hash"
    ]
  }
}

Sure, now give me some more details!

You created the plugin and if you have followed the documentation you have created a constructor in your plugin.

Let's say you created the below constructor:

public function __construct($settings) {
	$this->setCredentials(
		$settings['address'],
		$settings['login'],
		$settings['hash']
	);
}

So your constructor needs to have four settings needed to get the work done:

• address
• login
• hash

(again, you can give them any name you want and as many your plugin need (less is more))

So your settings (object 2) will look like this:

{
  "address": {
    "label": {
      "nl": "API Adres",
      "en": "API Address"
    },
    "type": "text",
    "tooltip": {
      "nl": "Vul de servernaam van de API server in",
      "en": "Enter the hostname of the API server"
    },
    "value": "https://api.openprovider.eu"
  },
  "login": {
    "label": {
      "nl": "API gebruikersnaam",
      "en": "API username"
    },
    "type": "text",
    "tooltip": {
      "nl": "Vul de gebruikersnaam van de API gebruiker in",
      "en": "Enter the username for the API user"
    },
    "value": ""
  },
  "hash": {
    "label": {
      "nl": "API versleuteld wachtwoord",
      "en": "API access key"
    },
    "type": "password",
    "tooltip": {
      "nl": "Vul jouw API versleuteld wachtwoord in om toegang te krijgen tot de OpenProvider API. Deze kan teruggevonden worden in jouw OpenProvider account. Ga naar Account -> Contactgegevens <username>.",
      "en": "Enter the API key to get access to the OpenProvider API. You can find this in your OpenProvider Account. Go to Account -> Contact <username>."
    }
  }
}

You see the object keys matches between the settings fields in your constructor and in the json object?

Example Plugin description Json Object 1:

{
  "description": {
    "en": "Manage your domains and let your customers manage their domains with this plugin. You and your customers can also order new domainnames at OpenProvider in the integrated webshop of PowerPanel ",
    "nl": "Met deze plugin is het mogelijk om je domeinnamen te beheren via PowerPanel. Ook is het mogelijk om je klanten nieuwe domeinnamen te laten bestellen via de webshop."
  },
  "subject": {
    "en": "Connect your OpenProvider domain account",
    "nl": "Koppel je OpenProvider domein account"
  },
  "title": {
    "nl": "Openprovider domeinnamen",
    "en": "Openprovider Domains"
  }
}

Example Plugin settings Json Object 2: This example has a switch and a option select box (option select box supports on this moment only english text items)

{
  "ssl_enable": {
    "label": {
      "nl": "SSL inschakelen",
      "en": "Enable SSL"
    },
    "type": "switch",
    "tooltip": {
      "nl": "Wil je SSL activeren schakel deze optie dan in",
      "en": "Do you want to use SSL, enable this option"
    }
  },
  "ssl_version": {
    "type": "select",
    "label": {
      "nl": "Kies de SSL versie",
      "en": "Choose the SSL version"
    },
    "tooltip": {
      "nl": "Kies de SSL versie welke door de API wordt ondersteund",
      "en": "Choose the SSL version supported by the API"
    },
    "options": [
      {
        "id": "1",
        "option": "SSL 3.0"
      },
      {
        "id": "2",
        "option": "TLS 1.0"
      },
      {
        "id": "3",
        "option": "TLS 1.1"
      },
      {
        "id": "4",
        "option": "TLS 1.2"
      }
    ]
  }