# godunme/barcode_scanner architecture

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

- Interactive diagram: https://gitdiagram.com/godunme/barcode_scanner
- Repository: https://github.com/godunme/barcode_scanner

## Overview

This PHP barcode-scanner app lets shoppers scan or browse products, look up prices, and maintain a cart; administrators authenticate to manage products, categories, and product images. The visible PHP APIs delegate product, category, and user operations to models backed by MySQL, while upload endpoints manage files in uploads/. The README documents the product capabilities; client-to-API wiring is not visible in the sampled JavaScript, so those links are marked unverified.

Main entry points: [`admin/admin.js`](https://github.com/godunme/barcode_scanner/blob/main/admin/admin.js) (Admin interactions), [`includes/functions.php`](https://github.com/godunme/barcode_scanner/blob/main/includes/functions.php) (Request and security helpers), [`api/categories.php`](https://github.com/godunme/barcode_scanner/blob/main/api/categories.php) (Categories API), [`api/products.php`](https://github.com/godunme/barcode_scanner/blob/main/api/products.php) (Products API)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_shopper["Shopper experience"]
  node_scanner_page["Scanner page<br/>[index.php]"]
  node_shopper_client["Scanner and cart<br/>[app.js]"]
end

subgraph group_admin["Administration"]
  node_admin_page["Admin page<br/>[index.php]"]
  node_admin_client["Admin interactions<br/>[admin.js]"]
end

subgraph group_api["HTTP APIs"]
  node_auth_api["Authentication API<br/>[auth.php]"]
  node_products_api["Products API<br/>[products.php]"]
  node_categories_api["Categories API<br/>[categories.php]"]
  node_upload_api["Image upload API<br/>[upload.php]"]
  node_delete_upload_api["Image deletion API<br/>[delete_upload.php]"]
end

subgraph group_domain["Domain models"]
  node_product_model["Product model<br/>[Product.php]"]
  node_category_model["Category model<br/>[Category.php]"]
  node_user_model["User model<br/>[User.php]"]
end

subgraph group_infra["Persistence and files"]
  node_helpers["Request and security helpers<br/>[functions.php]"]
  node_database[("MySQL connection<br/>[database.php]")]
  node_uploads[("Uploaded images")]
end

node_shopper_actor(("Shopper"))
node_admin_actor(("Administrator"))

node_shopper_actor -->|"uses"| node_scanner_page
node_scanner_page -->|"loads"| node_shopper_client
node_shopper_client -.->|"requests products"| node_products_api
node_shopper_client -.->|"requests categories"| node_categories_api
node_admin_actor -->|"uses"| node_admin_page
node_admin_page -.->|"loads interactions"| node_admin_client
node_admin_client -.->|"requests authentication"| node_auth_api
node_admin_client -.->|"requests product CRUD"| node_products_api
node_admin_client -.->|"requests category CRUD"| node_categories_api
node_admin_client -.->|"uploads images"| node_upload_api
node_admin_client -.->|"deletes images"| node_delete_upload_api
node_auth_api -->|"authenticates users"| node_user_model
node_auth_api -->|"checks sessions and CSRF"| node_helpers
node_products_api -->|"handles product operations"| node_product_model
node_products_api -->|"validates requests"| node_helpers
node_categories_api -->|"handles category operations"| node_category_model
node_categories_api -->|"checks category table"| node_database
node_categories_api -->|"checks request source"| node_helpers
node_upload_api -->|"checks access and CSRF"| node_helpers
node_upload_api -->|"writes images"| node_uploads
node_delete_upload_api -->|"checks access and CSRF"| node_helpers
node_delete_upload_api -->|"removes images"| node_uploads
node_product_model -->|"reads and writes"| node_database
node_user_model -->|"reads and writes"| node_database
node_user_model -->|"generates user IDs"| node_helpers
node_product_model -->|"loads shared helpers"| node_helpers

click node_scanner_page "https://github.com/godunme/barcode_scanner/blob/main/index.php"
click node_shopper_client "https://github.com/godunme/barcode_scanner/blob/main/js/app.js"
click node_admin_page "https://github.com/godunme/barcode_scanner/blob/main/admin/index.php"
click node_admin_client "https://github.com/godunme/barcode_scanner/blob/main/admin/admin.js"
click node_auth_api "https://github.com/godunme/barcode_scanner/blob/main/api/auth.php"
click node_products_api "https://github.com/godunme/barcode_scanner/blob/main/api/products.php"
click node_categories_api "https://github.com/godunme/barcode_scanner/blob/main/api/categories.php"
click node_upload_api "https://github.com/godunme/barcode_scanner/blob/main/api/upload.php"
click node_delete_upload_api "https://github.com/godunme/barcode_scanner/blob/main/api/delete_upload.php"
click node_product_model "https://github.com/godunme/barcode_scanner/blob/main/models/Product.php"
click node_category_model "https://github.com/godunme/barcode_scanner/blob/main/models/Category.php"
click node_user_model "https://github.com/godunme/barcode_scanner/blob/main/models/User.php"
click node_helpers "https://github.com/godunme/barcode_scanner/blob/main/includes/functions.php"
click node_database "https://github.com/godunme/barcode_scanner/blob/main/config/database.php"
click node_uploads "https://github.com/godunme/barcode_scanner/tree/main/uploads"

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_scanner_page,node_shopper_client toneBlue
class node_admin_page,node_admin_client toneAmber
class node_auth_api,node_products_api,node_categories_api,node_upload_api,node_delete_upload_api toneMint
class node_product_model,node_category_model,node_user_model toneRose
class node_helpers,node_database,node_uploads,node_shopper_actor,node_admin_actor toneIndigo
```

## Components

### Shopper experience

- [Scanner page](https://github.com/godunme/barcode_scanner/blob/main/index.php): `index.php`
- [Scanner and cart](https://github.com/godunme/barcode_scanner/blob/main/js/app.js): `js/app.js`

### Administration

- [Admin page](https://github.com/godunme/barcode_scanner/blob/main/admin/index.php): `admin/index.php`
- [Admin interactions](https://github.com/godunme/barcode_scanner/blob/main/admin/admin.js): `admin/admin.js`

### HTTP APIs

- [Authentication API](https://github.com/godunme/barcode_scanner/blob/main/api/auth.php): `api/auth.php`
- [Products API](https://github.com/godunme/barcode_scanner/blob/main/api/products.php): `api/products.php`
- [Categories API](https://github.com/godunme/barcode_scanner/blob/main/api/categories.php): `api/categories.php`
- [Image upload API](https://github.com/godunme/barcode_scanner/blob/main/api/upload.php): `api/upload.php`
- [Image deletion API](https://github.com/godunme/barcode_scanner/blob/main/api/delete_upload.php): `api/delete_upload.php`

### Domain models

- [Product model](https://github.com/godunme/barcode_scanner/blob/main/models/Product.php): `models/Product.php`
- [Category model](https://github.com/godunme/barcode_scanner/blob/main/models/Category.php): `models/Category.php`
- [User model](https://github.com/godunme/barcode_scanner/blob/main/models/User.php): `models/User.php`

### Persistence and files

- [Request and security helpers](https://github.com/godunme/barcode_scanner/blob/main/includes/functions.php): `includes/functions.php`
- [MySQL connection](https://github.com/godunme/barcode_scanner/blob/main/config/database.php): `config/database.php`
- [Uploaded images](https://github.com/godunme/barcode_scanner/tree/main/uploads): `uploads`

### Other components

- **Shopper**
- **Administrator**

## Connections

- Shopper → Scanner page: uses (evidence: `README.md`)
- Scanner page → Scanner and cart: loads (evidence: `index.php`)
- Scanner and cart → Products API: requests products
- Scanner and cart → Categories API: requests categories
- Administrator → Admin page: uses (evidence: `README.md`)
- Admin page → Admin interactions: loads interactions
- Admin interactions → Authentication API: requests authentication
- Admin interactions → Products API: requests product CRUD
- Admin interactions → Categories API: requests category CRUD
- Admin interactions → Image upload API: uploads images
- Admin interactions → Image deletion API: deletes images
- Authentication API → User model: authenticates users (evidence: `api/auth.php`)
- Authentication API → Request and security helpers: checks sessions and CSRF (evidence: `api/auth.php`)
- Products API → Product model: handles product operations (evidence: `api/products.php`)
- Products API → Request and security helpers: validates requests (evidence: `api/products.php`)
- Categories API → Category model: handles category operations (evidence: `api/categories.php`)
- Categories API → MySQL connection: checks category table (evidence: `api/categories.php`)
- Categories API → Request and security helpers: checks request source (evidence: `api/categories.php`)
- Image upload API → Request and security helpers: checks access and CSRF (evidence: `api/upload.php`)
- Image upload API → Uploaded images: writes images (evidence: `api/upload.php`)
- Image deletion API → Request and security helpers: checks access and CSRF (evidence: `api/delete_upload.php`)
- Image deletion API → Uploaded images: removes images (evidence: `api/delete_upload.php`)
- Product model → MySQL connection: reads and writes (evidence: `models/Product.php`)
- User model → MySQL connection: reads and writes (evidence: `models/User.php`)
- User model → Request and security helpers: generates user IDs (evidence: `models/User.php`)
- Product model → Request and security helpers: loads shared helpers (evidence: `models/Product.php`)
