Configuration

Addons use multiple configuration files to define metadata, settings, and navigation. This guide covers all configuration options.

Addon Metadata (Settings/config.php)

The Settings/config.php file defines how your addon appears in the admin panel:

<?php

$setting = [
    // Display Information
    'name' => 'Email Validator',
    'vendor' => 'Your Company',
    'type' => 'Integration',
    'logo' => 'logo.png',
    'slider' => 'banner.png',

    // Version Control
    'version' => '1.2.0',
    'new_version_url' => 'https://yoursite.com/addon/version.json',
    'update_url' => 'https://yoursite.com/addon/download',

    // Routing
    'route' => 'email-validator',
    'install_dir' => 'EmailValidator',

    // Licensing
    'license_type' => 'marketplace',
    'license_key' => ''
];

Field Reference

Field	Type	Description
name	string	Display name in addon manager
vendor	string	Developer/company name
type	string	Category: Integration, Feature, Utility, etc.
logo	string	Logo filename (stored in Settings/)
slider	string	Banner image for addon details
version	string	Current version (semantic versioning)
new_version_url	string	URL returning JSON with latest version
update_url	string	URL to download update package
route	string	Base URL prefix for addon routes
install_dir	string	Directory name under /Addons
license_type	string	License model (see below)
license_key	string	License key if pre-configured

License Types

Type	Description
native	Verified against Mumara's main license server
marketplace	Verified via Mumara Marketplace API
remote	Custom verification against your own server
free	No license required

Version Checking

For automatic update checking, your new_version_url should return:

{
    "version": "1.3.0",
    "changelog": "Bug fixes and performance improvements",
    "release_date": "2024-01-15"
}

Application Config (Config/config.php)

The Config/config.php file contains runtime configuration that can be published and overridden:

<?php

return [
    'name' => 'Email Validator',

    // API Settings
    'api' => [
        'endpoint' => env('EMAIL_VALIDATOR_API_URL', 'https://api.example.com'),
        'timeout' => env('EMAIL_VALIDATOR_TIMEOUT', 30),
        'retry_attempts' => 3,
    ],

    // Feature Flags
    'features' => [
        'real_time_validation' => true,
        'batch_processing' => true,
        'webhook_notifications' => false,
    ],

    // Cache Settings
    'cache' => [
        'enabled' => true,
        'ttl' => 3600, // seconds
        'prefix' => 'email_validator_',
    ],

    // Default Settings
    'defaults' => [
        'validation_level' => 'standard',
        'max_batch_size' => 1000,
    ],
];

Accessing Configuration

// Get single value
$endpoint = config('emailvalidator.api.endpoint');

// Get with default
$timeout = config('emailvalidator.api.timeout', 60);

// Get entire section
$apiConfig = config('emailvalidator.api');

// Check if exists
if (config()->has('emailvalidator.features.webhooks')) {
    // ...
}

Publishing Configuration

Users can publish and customize config:

php artisan vendor:publish --tag=emailvalidator-config

This copies your config to config/emailvalidator.php where users can modify it.

Register publishing in your service provider:

public function boot(): void
{
    $this->publishes([
        module_path($this->moduleName, 'Config/config.php')
            => config_path($this->moduleNameLower . '.php'),
    ], 'config');
}

Environment Variables

Use environment variables for sensitive or environment-specific values:

// Config/config.php
'api_key' => env('EMAIL_VALIDATOR_API_KEY'),
'debug' => env('EMAIL_VALIDATOR_DEBUG', false),

Users add to their .env:

EMAIL_VALIDATOR_API_KEY=your-api-key-here
EMAIL_VALIDATOR_DEBUG=true

Menu Configuration (menu.json)

The menu.json file defines sidebar navigation entries:

Simple Menu Item

[
    {
        "title": "Email Validator",
        "icon": "<i class='kt-menu__link-icon flaticon-email'></i>",
        "url": "email-validator",
        "hidden": false,
        "hasChild": false,
        "childrens": []
    }
]

Menu with Children

[
    {
        "title": "Email Validator",
        "icon": "<i class='kt-menu__link-icon flaticon-email'></i>",
        "url": "#",
        "hidden": false,
        "hasChild": true,
        "childrens": [
            {
                "title": "Dashboard",
                "icon": "<i class='menu-bullet menu-bullet-dot'><span></span></i>",
                "url": "email-validator",
                "hidden": false
            },
            {
                "title": "Validate Emails",
                "icon": "<i class='menu-bullet menu-bullet-dot'><span></span></i>",
                "url": "email-validator/validate",
                "hidden": false
            },
            {
                "title": "History",
                "icon": "<i class='menu-bullet menu-bullet-dot'><span></span></i>",
                "url": "email-validator/history",
                "hidden": false
            },
            {
                "title": "Settings",
                "icon": "<i class='menu-bullet menu-bullet-dot'><span></span></i>",
                "url": "email-validator/settings",
                "hidden": false
            }
        ]
    }
]

Menu Field Reference

Field	Type	Description
title	string	Display text
icon	string	HTML icon element
url	string	Route path (relative) or "#" for parent
hidden	boolean	Hide from menu if true
hasChild	boolean	Has submenu items
childrens	array	Submenu items

Common Icons

<!-- Flaticon (Metronic theme) -->
<i class='kt-menu__link-icon flaticon-email'></i>
<i class='kt-menu__link-icon flaticon-settings'></i>
<i class='kt-menu__link-icon flaticon-analytics'></i>
<i class='kt-menu__link-icon flaticon-users'></i>
<i class='kt-menu__link-icon flaticon-list'></i>

<!-- Font Awesome -->
<i class='kt-menu__link-icon fas fa-envelope'></i>
<i class='kt-menu__link-icon fas fa-cog'></i>
<i class='kt-menu__link-icon fas fa-chart-bar'></i>

<!-- Submenu bullet -->
<i class='menu-bullet menu-bullet-dot'><span></span></i>
<i class='menu-bullet menu-bullet-line'><span></span></i>

Module Manifest (module.json)

The module.json file is the addon's manifest:

{
    "name": "EmailValidator",
    "alias": "emailvalidator",
    "description": "Real-time email validation and verification",
    "keywords": ["email", "validation", "verification", "hygiene"],
    "priority": 0,
    "providers": [
        "Addons\\EmailValidator\\Providers\\EmailValidatorServiceProvider",
        "Addons\\EmailValidator\\Providers\\EventServiceProvider"
    ],
    "files": [
        "Helpers/functions.php"
    ],
    "requires": []
}

Field Reference

Field	Type	Description
name	string	Addon name (PascalCase, must match directory)
alias	string	Lowercase identifier for views/routes
description	string	Brief description
keywords	array	Search keywords
priority	integer	Load order (lower = earlier)
providers	array	Service providers to register
files	array	PHP files to autoload
requires	array	Dependencies on other addons

Dependencies

If your addon depends on another addon:

{
    "requires": [
        "OtherAddon"
    ]
}

The system ensures dependencies are loaded first.

Composer Dependencies (composer.json)

Define PHP package dependencies:

{
    "name": "yourcompany/emailvalidator",
    "description": "Email validation addon for Mumara Campaigns",
    "type": "library",
    "require": {
        "guzzlehttp/guzzle": "^7.0",
        "egulias/email-validator": "^4.0"
    },
    "autoload": {
        "psr-4": {
            "Addons\\EmailValidator\\": ""
        }
    }
}

After modifying, run:

cd Addons/EmailValidator
composer install

Asset Compilation (webpack.mix.js)

Configure Laravel Mix for asset compilation:

const mix = require('laravel-mix');
require('laravel-mix-merge-manifest');

mix.setPublicPath('../../public').mergeManifest();

mix.js(__dirname + '/Resources/assets/js/app.js', 'js/emailvalidator.js')
   .sass(__dirname + '/Resources/assets/sass/app.scss', 'css/emailvalidator.css');

if (mix.inProduction()) {
    mix.version();
}

Build assets:

cd Addons/EmailValidator
npm install
npm run dev        # Development
npm run production # Production with versioning

Storing Addon Settings

For user-configurable settings, store in the database:

Create Settings Model

// Entities/AddonSetting.php
namespace Addons\EmailValidator\Entities;

use Illuminate\Database\Eloquent\Model;

class AddonSetting extends Model
{
    protected $table = 'email_validator_settings';

    protected $fillable = ['key', 'value', 'user_id'];

    protected $casts = [
        'value' => 'json',
    ];

    public static function get(string $key, $default = null, ?int $userId = null)
    {
        $query = static::where('key', $key);

        if ($userId) {
            $query->where('user_id', $userId);
        }

        $setting = $query->first();

        return $setting ? $setting->value : $default;
    }

    public static function set(string $key, $value, ?int $userId = null): void
    {
        static::updateOrCreate(
            ['key' => $key, 'user_id' => $userId],
            ['value' => $value]
        );
    }
}

Create Migration

Schema::create('email_validator_settings', function (Blueprint $table) {
    $table->id();
    $table->string('key');
    $table->json('value')->nullable();
    $table->foreignId('user_id')->nullable()->constrained()->onDelete('cascade');
    $table->timestamps();

    $table->unique(['key', 'user_id']);
});

Usage

use Addons\EmailValidator\Entities\AddonSetting;

// Get setting
$apiKey = AddonSetting::get('api_key');

// Get with default
$batchSize = AddonSetting::get('batch_size', 100);

// Get user-specific setting
$userLimit = AddonSetting::get('daily_limit', 1000, auth()->id());

// Set setting
AddonSetting::set('api_key', 'your-key');

// Set user-specific setting
AddonSetting::set('daily_limit', 500, auth()->id());