# slims/slims9_bulian architecture

> Architecture diagram of the GitHub repository slims/slims9_bulian, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/slims/slims9_bulian
- Repository: https://github.com/slims/slims9_bulian

## Overview

SLiMS 9 Bulian is a library-management system for managing collections, circulation, membership, and related administration. Its main user-facing workflow spans catalog management and discovery, member services, lending and returns, and operational reporting; these are distinct capabilities, not a source-proven sequential pipeline. Staff also administer configuration and stock takes, while API routes expose library-resource controllers. The graph preserves documented capabilities and sampled search-engine internals; many module internals were not excerpted, so their links are limited to README statements or omitted.

Main entry points: [`lib/SearchEngine/Engine.php`](https://github.com/slims/slims9_bulian/blob/master/lib/SearchEngine/Engine.php) (Search engine registry), [`lib/SearchEngine/SphinxSearchEngine.php`](https://github.com/slims/slims9_bulian/blob/master/lib/SearchEngine/SphinxSearchEngine.php) (Sphinx search), [`lib/SearchEngine/FuzzySearchEngine.php`](https://github.com/slims/slims9_bulian/blob/master/lib/SearchEngine/FuzzySearchEngine.php) (Fuzzy search), [`admin/modules/system/search-engine-setting.php`](https://github.com/slims/slims9_bulian/blob/master/admin/modules/system/search-engine-setting.php) (Search settings)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_catalog["Catalog and discovery"]
  node_catalogue["Collection management"]
  node_search["Bibliography search"]
  node_search_registry["Search engine registry<br/>[Engine.php]"]
  node_default_search["Default search<br/>[DefaultEngine.php]"]
  node_fuzzy_search["Fuzzy search"]
  node_sphinx_search["Sphinx search"]
end

subgraph group_circulation["Library operations"]
  node_membership["Membership"]
  node_circulation["Loans and reserves"]
  node_stocktake["Stock taking"]
  node_serials["Serial control"]
end

subgraph group_insights["Reporting and APIs"]
  node_reporting["Reports"]
  node_api_routes["API routes<br/>[routes.php]"]
  node_api_controllers["API controllers"]
end

subgraph group_platform["Administration and platform"]
  node_search_settings["Search settings"]
  node_system_admin["System administration"]
end

node_staff(("Library staff"))
node_sphinx_service{{"Sphinx service"}}
node_mysql[("MySQL database")]
node_api_client(("API client"))

node_staff -->|"manages collections"| node_catalogue
node_staff -->|"manages members"| node_membership
node_staff -->|"manages circulation"| node_circulation
node_staff -->|"takes stock"| node_stocktake
node_staff -->|"manages serials"| node_serials
node_staff -->|"views reports"| node_reporting
node_staff -.->|"administers system"| node_system_admin
node_api_client -.->|"requests API"| node_api_routes
node_api_routes -->|"routes to"| node_api_controllers
node_search_registry -->|"registers engine"| node_default_search
node_search_registry -->|"registers engine"| node_search
node_search_registry -->|"registers engine"| node_fuzzy_search
node_search_registry -->|"registers engine"| node_sphinx_search
node_search_settings -->|"configures engine"| node_fuzzy_search
node_search_settings -->|"configures engine"| node_sphinx_search
node_search -->|"queries records"| node_mysql
node_fuzzy_search -.->|"searches index tables"| node_mysql
node_sphinx_search -->|"queries index"| node_sphinx_service
node_sphinx_search -->|"loads record details"| node_mysql

click node_catalogue "https://github.com/slims/slims9_bulian/tree/master/admin/modules/bibliography"
click node_search "https://github.com/slims/slims9_bulian/blob/master/lib/SearchEngine/SearchBiblioEngine.php"
click node_search_registry "https://github.com/slims/slims9_bulian/blob/master/lib/SearchEngine/Engine.php"
click node_default_search "https://github.com/slims/slims9_bulian/blob/master/lib/SearchEngine/DefaultEngine.php"
click node_fuzzy_search "https://github.com/slims/slims9_bulian/blob/master/lib/SearchEngine/FuzzySearchEngine.php"
click node_sphinx_search "https://github.com/slims/slims9_bulian/blob/master/lib/SearchEngine/SphinxSearchEngine.php"
click node_search_settings "https://github.com/slims/slims9_bulian/blob/master/admin/modules/system/search-engine-setting.php"
click node_membership "https://github.com/slims/slims9_bulian/tree/master/admin/modules/membership"
click node_circulation "https://github.com/slims/slims9_bulian/tree/master/admin/modules/circulation"
click node_stocktake "https://github.com/slims/slims9_bulian/tree/master/admin/modules/stock_take"
click node_serials "https://github.com/slims/slims9_bulian/tree/master/admin/modules/serial_control"
click node_reporting "https://github.com/slims/slims9_bulian/tree/master/admin/modules/reporting"
click node_api_routes "https://github.com/slims/slims9_bulian/blob/master/api/v1/routes.php"
click node_api_controllers "https://github.com/slims/slims9_bulian/tree/master/api/v1/controllers"
click node_system_admin "https://github.com/slims/slims9_bulian/tree/master/admin/modules/system"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_catalogue,node_search,node_search_registry,node_default_search,node_fuzzy_search,node_sphinx_search,node_api_client toneBlue
class node_membership,node_circulation,node_stocktake,node_serials,node_mysql toneAmber
class node_reporting,node_api_routes,node_api_controllers toneMint
class node_search_settings,node_system_admin toneRose
class node_staff,node_sphinx_service toneIndigo
```

## Components

### Catalog and discovery

- [Collection management](https://github.com/slims/slims9_bulian/tree/master/admin/modules/bibliography): `admin/modules/bibliography`
- [Bibliography search](https://github.com/slims/slims9_bulian/blob/master/lib/SearchEngine/SearchBiblioEngine.php): `lib/SearchEngine/SearchBiblioEngine.php`
- [Search engine registry](https://github.com/slims/slims9_bulian/blob/master/lib/SearchEngine/Engine.php): `lib/SearchEngine/Engine.php`
- [Default search](https://github.com/slims/slims9_bulian/blob/master/lib/SearchEngine/DefaultEngine.php): `lib/SearchEngine/DefaultEngine.php`
- [Fuzzy search](https://github.com/slims/slims9_bulian/blob/master/lib/SearchEngine/FuzzySearchEngine.php): `lib/SearchEngine/FuzzySearchEngine.php`
- [Sphinx search](https://github.com/slims/slims9_bulian/blob/master/lib/SearchEngine/SphinxSearchEngine.php): `lib/SearchEngine/SphinxSearchEngine.php`

### Library operations

- [Membership](https://github.com/slims/slims9_bulian/tree/master/admin/modules/membership): `admin/modules/membership`
- [Loans and reserves](https://github.com/slims/slims9_bulian/tree/master/admin/modules/circulation): `admin/modules/circulation`
- [Stock taking](https://github.com/slims/slims9_bulian/tree/master/admin/modules/stock_take): `admin/modules/stock_take`
- [Serial control](https://github.com/slims/slims9_bulian/tree/master/admin/modules/serial_control): `admin/modules/serial_control`

### Reporting and APIs

- [Reports](https://github.com/slims/slims9_bulian/tree/master/admin/modules/reporting): `admin/modules/reporting`
- [API routes](https://github.com/slims/slims9_bulian/blob/master/api/v1/routes.php): `api/v1/routes.php`
- [API controllers](https://github.com/slims/slims9_bulian/tree/master/api/v1/controllers): `api/v1/controllers`

### Administration and platform

- [Search settings](https://github.com/slims/slims9_bulian/blob/master/admin/modules/system/search-engine-setting.php): `admin/modules/system/search-engine-setting.php`
- [System administration](https://github.com/slims/slims9_bulian/tree/master/admin/modules/system): `admin/modules/system`

### Other components

- **Library staff**
- **Sphinx service**
- **MySQL database**
- **API client**

## Connections

- Library staff → Collection management: manages collections
- Library staff → Membership: manages members
- Library staff → Loans and reserves: manages circulation
- Library staff → Stock taking: takes stock
- Library staff → Serial control: manages serials
- Library staff → Reports: views reports
- Library staff → System administration: administers system
- API client → API routes: requests API
- API routes → API controllers: routes to (evidence: `api/v1/routes.php`)
- Search engine registry → Default search: registers engine (evidence: `lib/SearchEngine/Engine.php`)
- Search engine registry → Bibliography search: registers engine (evidence: `lib/SearchEngine/Engine.php`)
- Search engine registry → Fuzzy search: registers engine (evidence: `lib/SearchEngine/Engine.php`)
- Search engine registry → Sphinx search: registers engine (evidence: `lib/SearchEngine/Engine.php`)
- Search settings → Fuzzy search: configures engine (evidence: `admin/modules/system/search-engine-setting.php`)
- Search settings → Sphinx search: configures engine (evidence: `admin/modules/system/search-engine-setting.php`)
- Bibliography search → MySQL database: queries records (evidence: `lib/SearchEngine/SearchBiblioEngine.php`)
- Fuzzy search → MySQL database: searches index tables
- Sphinx search → Sphinx service: queries index (evidence: `lib/SearchEngine/SphinxSearchEngine.php`)
- Sphinx search → MySQL database: loads record details (evidence: `lib/SearchEngine/SphinxSearchEngine.php`)
