প্লাগইন ও থিম

Almost everything that connects AIOBilling to the outside world is a plugin: payment gateways, domain registrars, the modules that create hosting accounts, fraud checks and the SMS notices. Themes change how the client area and the admin area look. Both are folders you can add with a ZIP file, and the licence decides which premium ones may run. Hosting companies know this idea as addon modules, so it will feel familiar.

What comes with the script

Nineteen plugins ship inside the download and are free. They are marked as built in, so their folders are never deleted from disk.

Every one of them has its own chapter in this part of the manual, with every setting, what the provider needs from you and how to test it. Two free themes are built in as well: Blend for the admin area and Lagoon for the client area.

What you can buy

Three extras are premium. You buy each one once at license.faruk.bd and it is yours with your licence.

The monthly packages give a discount on premium plugins and themes: 10% on Business up to 1,000 and up to 2,500 clients, 15% on Business up to 5,000, and 20% on Business 10,000+. The Owned package (unlimited clients, one payment) already includes every premium plugin and theme. Plus and Professional pay the full price. See The licence.

The Addon Modules page

Open Setup → Addon Modules. You need the Configure Addon Modules permission.

The page has four parts.

1. Upload a plugin - choose a ZIP and press Upload and install.
2. One card per category - Payment gateways, Domain registrars, Provisioning, Fraud protection, Notifications, Support, Reports, Themes and Other. A category without plugins is not shown.
3. Available on faruk.bd - the addons that your licence includes but that are not on disk yet, each with a link. Download the ZIP from your account and upload it above.
4. Plugin problems - a plugin that failed to load, a hook that failed, and the last lines of the plugin log. A healthy site says No plugin failed to load and no hook failed.

Each plugin row shows the name and a one-line description, the version, the author, whether it is Free or Premium, the type (Gateway, Registrar, Server, Addon) and the status.

A plugin that is off does not run any code. A premium plugin without its addon refuses to switch on and says Premium - needs the "notify-sms" addon on your licence. If the addon is lost later, the plugin stays on the page but stops running.

Adding a plugin from a ZIP

The ZIP must contain plugin.php at its top or inside one folder, and the file must say its code in a getCode() method. The script unpacks the files into plugins/<code>/ and answers Plugin ... uploaded. Switch it on to use it. Uploading needs the PHP zip extension (see Requirements).

After you buy a premium plugin, press Check now on Setup → Licence so the licence learns about the new addon, then upload and activate. PHP must be allowed to write into the plugins/ folder; see Troubleshooting for permissions.

Settings pages

Most plugins have a settings page at Configure. It is drawn from the plugin's list of fields: text, number, password, yes/no, choice and colour, grouped under small headings. A password field is always shown empty with the hint (unchanged); leave it empty to keep the saved value, type a new one to replace it. Gateways and registrars have their own pages as well (Setup → Payment Gateways, Setup → Domain Registrars), and the same settings form is used in both places.

A plugin can add entries to the admin top menu (under Addons unless it names another group) and to the client area account menu. Your administrators see them only if their role allows.

Themes

Setup → Themes & Appearance has one table for the Client Area and one for the Admin Area. Press Use to switch, Preview to open the site, and open Options of ... to change colours, texts and switches. Save Options keeps them and Reset to defaults clears them. At the bottom of each table you can upload a theme ZIP that has a theme.json inside. A premium theme without its addon cannot be chosen, and if one was chosen before the addon ran out the page shows a warning and the site falls back to the default theme. Every administrator can also pick their own admin theme under My Account. See Nova and Lumen.

Writing your own plugin

A plugin is a folder plugins/<code>/ with a plugin.php. The class is the code in CamelCase followed by Plugin, so payment-acme becomes PaymentAcmePlugin. It extends one of four base classes:

• AbstractPlugin for an ordinary addon;
• AbstractGateway for a payment gateway;
• AbstractRegistrar for a domain registrar;
• AbstractServerModule for a provisioning module.

The class states its code, name, description, version, tier (free or premium), the addon it needs, its category and its icon. It can register hooks in boot(), add menu entries with adminMenu() and clientMenu(), describe its settings in getConfigFields(), create tables in install() and drop them in uninstall(), and run something every five minutes in cron(). Pages go in pages/admin/ and pages/client/ and open at plugin/<code>/<page>.

One rule matters: a plugin must never call a function of another plugin, because that plugin may be off. Talk through hooks (add_action, add_filter) instead. Put .builtin in the folder only for plugins that ship with the script.