Home / Module Development / Module Interface

Module Interface

Understanding the ModuleInterface

Module Interface

All modules must implement the ModuleInterface interface.

Required Methods

  • getName(): Returns module internal name
  • getType(): Returns module type (gateway/registrar/server)
  • getConfigFields(): Returns configuration fields
  • initialize(array $config): Initializes module with config
  • execute($action, $params): Executes module actions
  • isEnabled(): Returns enabled status

Module Types

  • Gateway: Payment processing modules
  • Registrar: Domain registration modules
  • Server: Server provisioning modules

See the module development guides for detailed examples.