Markdown Reader

partners Documentation › PARTNERS_DOCUMENTATION_EN

Partners Documentation En

Feature: Partners #

Internal directory of partners and suppliers. Stores contact details, contacts, partnership type and internal notes. Restricted to administrators.

Installation and Configuration

Via FTP: Upload the partners/ directory into /plugins/.

Via package manager: Select partners from the available plugins list.

Paths:

  • Main plugin: /plugins/partners/partners.php
  • Configuration: /plugins/partners/conf/partners.conf.inc.php
  • Locales: /plugins/partners/locale/

Access restricted: secure('PARTNERS_LEVEL_ADMIN').

Required SQL table: partners

Usage

Partner Fields #

  • Name: company name
  • Type: 5 available categories (supplier, client, contractor, etc.)
  • Address: composite format address § country § postal code § email (separator §)
  • Contact: composite format name § phone § email
  • Internal notes
  • Country (dropdown selector)

Interface #

  • Partner list with type filtering
  • Partner detail card
  • Create/edit form
  • Deletion

Hooks and Entry Points

text
?obj=partners.php             — Partner list (admin)
?obj=partners.php&view=ID     — Partner card
?obj=partners.php&add=1       — Create form (GET)
?obj=partners.php&del=ID      — Delete

Create/edit via POST.

Dependencies

  • Beamreactor\Database\SQL
  • Beamreactor\Sanitizer\Parser

Technical note: composite fields use § as an internal separator. Reading must account for backwards compatibility with a prior encoding on some installations.