Developer Documentation

Overview

This documentation provides a complete overview of all implemented features and changes since project inception.

Developer: Leon Pfaffe

Project: Printworks E-Commerce Shop

Last update of this documentation: 03.04.2026 14:59

Note: This website is continuously being developed. There are always new features and existing features are continuously improved.

Latest Changes (03.04.2026)

1. Shop System & Product Management

Shop Page (shop.php)

• Optimized Product Cards:
  • Only sizes and options are displayed on the card
  • Description and details button removed
  • Products are fully clickable (lead to detail page)
  • Review stars are displayed
• Comprehensive Filters & Sorting:
  • Status Filter: All / Active only / Inactive only products
  • Sorting: Active first / Price ascending / Price descending / Name A-Z / Name Z-A
  • Price Range: Min/Max price filter
  • Size Filter: Filter by available sizes (dynamically from all products)
  • Category Filter: Filter by product categories (left sidebar)
  • Seller Class Filter: Filter by seller class (e.g. "BEW2-25", "ZBW")
  • Automatic Sorting: Active products are ALWAYS displayed first
  • Reset button for all filters
  • Filter parameters preserved in URL
• Layout:
  • Search bar at the top
  • Filters and sorting options in left sidebar
  • Category filter in left sidebar
  • Product grid: 3 products per row on screens ≥968px
• Product Detail Page: Also accessible for unavailable products (reviews can be viewed)

Product Detail Page (product-detail.php)

• Amazon-like Product Detail Page:
  • Large product image with fallback
  • Complete product description
  • Features list
  • Review statistics with stars
• Variant Selection:
  • Colors as clickable buttons (visual color selection)
  • Sizes as clickable buttons
  • Dynamic price calculation based on variants
  • Price changes are displayed immediately
• Text Printing:
  • Text input field with max. length
  • Font selection
• Purchase Options:
  • "Add to Cart" button
  • "Direct to Checkout" button (skips cart)
• Reviews:
  • Review statistics (average, distribution by stars)
  • Review list with details
  • Verified purchase is displayed
  • Write review (only for logged-in users)
  • Helpful function for reviews
• Unavailable Products: Detail page is also accessible for unavailable products, shows warning but allows viewing reviews

Review System

• Database Structure:
  • product_reviews table for reviews
  • review_helpful table for "Helpful" markings
  • product_variants table for variants (colors, sizes with price changes)
• Review Features:
  • 1-5 star rating
  • Title (optional) and text
  • Verified purchase is automatically detected
  • Reviews must be approved by admin
  • Each user can only submit one review per product
• Admin Management (admin/reviews.php):
  • Overall statistics (average, count, approved/pending)
  • Top products by reviews
  • Filters (product, status, stars)
  • Approve/delete reviews
  • Detailed review analysis
• Permissions:
  • view_reviews - View reviews
  • manage_reviews - Manage reviews
  • approve_reviews - Approve reviews
  • delete_reviews - Delete reviews

Product Management (admin/products.php)

• Custom Fields Fully Supported:
  • Colors (comma-separated) - e.g. "Black, White, Red"
  • Sizes (comma-separated) - e.g. "XS, S, M, L, XL, 2XL, 3XL"
  • Features (one per line) - e.g. "100% Organic Cotton", "Sustainably Produced"
  • Text printing options with advanced settings:
    • Configurable maximum text length
    • Available fonts (comma-separated)
    • Default font
• Product Categories:
  • Category assignment for products
  • Category management in separate admin page (admin/product-categories.php)
  • Category filtering in shop
  • Permissions: view_product_categories, manage_product_categories, create_product_categories, edit_product_categories, delete_product_categories
• Seller Management:
  • Seller assignment (admin user) for products
  • Seller class field (e.g. "BEW2-25", "ZBW") for class/seller identification
  • Seller class displayed on product detail page
  • Clickable seller class filter link on product detail page
  • Seller filter in shop
• Product Visibility:
  • is_active: Product is purchasable via POS
  • is_visible: Product is shown in online shop
  • Products can be active but not visible online
  • Shop shows only products that are both active and visible
  • POS shows all active products
  • Products always clickable (even if inactive) to view details
• Complete Form: Creation and editing form with all options

Product Categories Management (admin/product-categories.php)

• CRUD Operations: Create, read, update, delete product categories
• Category Properties:
  • Name and slug (auto-generated from name)
  • Description
  • Display order
  • Active status
• Permissions: Granular permissions for viewing and managing categories
• Logging: All category actions logged in admin logs

2. Team Page & Mobile Navigation

• Mobile Swipe Navigation:
  • Left/right arrows for mobile devices (≤600px)
  • Touch swipe functionality to swipe between team members
  • Carousel with indicators (dots at bottom)
  • Keyboard navigation (arrow keys on mobile devices)
  • Automatic deactivation of arrows at start/end
• Desktop Layout: Grid layout remains on larger screens
• Responsive Design: Automatic switch between grid and carousel based on screen size

3. Inventory Management & Orders

Inventory Management (admin/inventory.php)

• Status System:
  • Status: test, kaputt, co, sonstiges, fertig, produktion, eingelagert
  • Sale Status: verkauft, testprodukt, ko, verfuegbar, nverkauf, veranstaltung_verkauf
  • Status and sale status combined in one column (more compact)
• Statistics by Categories:
  • Ready & Available
  • Ready & Sold
  • In Production
  • Stored
  • Quality & Issues (Test, Broken, CO)
  • Other
• Filters & Sorting:
  • Status Filter: All / Ready / Production / Test / Broken / CO / Other / Stored
  • Sale Status Filter: All / Available / Sold / Test Product / KO / Not for Sale / Event Sale
  • Product name search
  • Sorting: Newest first / Oldest first / Quantity high→low / Quantity low→high / Name A-Z / Name Z-A
  • CSV export with active filters
• Automatic Inventory Updates:
  • On order: Items are transferred to "Production" status
  • On cancellation: Items are made available again
  • Complete logging in inventory_logs

Orders

• POS Invoices: Password protection removed (QR code works without password)
• Online Orders: Retain password protection (customer number)
• Archive System:
  • Individual archive/unarchive buttons for each order
  • Bulk archive functionality with checkboxes
  • Archive view with tabs: Active Orders, Completed, Cancelled, All Archive
  • Archived orders excluded from dashboard and notifications
  • Unarchive functionality to restore orders to active view
  • Filter parameters preserved when archiving/unarchiving
  • All archive actions logged in admin logs

Worker Page (admin/worker.php)

• Production Overview: Shows all orders for production workers
• Archive View:
  • Archive tabs: Active Orders, Completed, Cancelled, All Archive
  • Archive/unarchive functionality directly from worker view
  • Bulk archive with checkboxes
  • Archived orders automatically excluded from active worker view
  • Unarchive redirects to active view
• Payment on Pickup: Orders with "Bezahlung bei Abholung" (payment on pickup) are now correctly displayed in worker view
• Filters: Status filter, design files filter, design contact filter, search functionality
• Order Details: Expandable order cards with items, design files, and customer information

4. OAuth Integration (Google Sign In)

• System Setting: Google Login can be enabled/disabled in system settings
• OAuth Registration:
  • New page /pages/oauth-complete-registration.php for address entry
  • Automatic adoption of name/email from Google
  • Address must be entered manually
  • Accounts are directly activated
  • Welcome email is automatically sent
• OAuth Service: Complete service for Google OAuth with callback handler
• OAuth Debug Page: /pages/oauth-debug.php shows expected redirect URI
• Documentation: docs/GOOGLE_OAUTH_SETUP.md for Google Cloud Console configuration

5. Admin Management

Admin Account Management

• Automatic Password Generation: No password needed when creating
• Account Activation:
  • 24-hour activation window
  • Automatic lockout if not activated
  • Email notification to dev@printworks-shop.de
  • Activation link can be resent
  • Mandatory Password Change: Newly activated admins must change password on first login
• Password Change System:
  • Automatic redirect to password change page after activation
  • Fallback buttons if redirect fails
  • 2FA setup prompt after password change (optional)
  • Existing admins are NOT required to change password
• 2FA Reminder System:
  • 30-day reminder for admins without 2FA
  • Dashboard prompt with skip option
  • Automatic tracking of last prompt date
• Reset Login Attempts: Super admins can reset login attempts for any admin
• Profile Pictures:
  • Upload profile pictures (max 5MB, JPEG/PNG/GIF/WebP)
  • Display in chat messages
  • Automatic fallback icon if image fails to load
  • Storage in storage/profile_pictures/
• Email Notifications:
  • On account creation (password + activation link in separate emails)
  • On account lockout/unlock
  • On failed login attempts
  • On login to locked account
  • On login attempt reset
• Password Formatting: Passwords in emails are in separate, copyable field without leading spaces

Admin Logs

• Login Attempts: Separate view for all login attempts (successful/failed)
• Admin Actions: All admin actions are logged
• Filters: Filterable by admin, module, action

Roles & Permissions

• Custom Roles: Super admins can create their own roles
• Over 100 Permissions: Fine-grained permission system
• Security Check: Admins cannot assign themselves higher privileges
• Pagination: Admin list shows 20 admins per page

6. Accounting (admin/accounting.php)

• Current Balances: Display of current bank and cash balance
• Mandatory Attachments: Invoices must be uploaded for income and expenses
• Money Transfer: Function to transfer money between bank and cash
• CSV Export: Export with invoice files

7. Invoice & Order System

• Automatic PDF generation on orders (TCPDF)
• Invoices are sent via email as attachment
• Download function for customers and administrators
• Password encryption: All invoices are encrypted with customer number
• Manual invoice creation in admin panel
• Invoice reminders via email
• RBAC permissions for invoice management

8. Maintenance Mode & System Health

• Admin dashboard integration for activation/deactivation
• Time-based maintenance phases with end date
• Custom maintenance message
• Automatic redirect for non-admin users
• Dedicated maintenance page (503 status code)
• Admin bypass for maintenance mode
• Automatic Maintenance Mode: Activates automatically on database problems
• System Health Check: Automatic check of all system components

9. Security

Website Security

• Custom 404 and 403 error pages
• .htaccess rules for directory protection
• Prevention of directory traversal
• Protection of sensitive files and directories
• Security headers (X-Frame-Options, X-Content-Type-Options, etc.)

Session Security

• HttpOnly cookies
• SameSite=Lax for CSRF protection
• Session strict mode
• Conditional secure cookies (HTTPS)

10. Role-Based Access Control (RBAC)

• Complete role and permission system
• Roles: super_admin, admin, accountant, support, viewer
• Over 100 fine-grained permissions
• Permission checks on all admin pages
• Comprehensive permission check in navigation

11. Email Notifications

• Order confirmations with PDF invoice
• Order status updates (paid, shipped, cancelled)
• Tracking number notifications
• Password reset (token-based, 25 minutes valid)
• Invoice reminders
• Ticket reply notifications
• Account deletion workflow
• Welcome email on OAuth registration
• Admin account notifications

12. Two-Factor Authentication (2FA) & Passkeys

• TOTP-based 2FA (Google Authenticator, etc.)
• QR code generation for setup
• Backup codes (10 codes, one-time use)
• WebAuthn-based passkey support
• Platform authenticators (fingerprint, Face ID, Touch ID)
• Cross-platform authenticators (QR code, USB security key)
• 30-Day Reminder System: Automatic prompts for admins without 2FA every 30 days

17. Admin Chat System

• Group Chats:
  • Role-based group chats (super_admin, admin, support)
  • "Alle Admins" group chat for all admins
  • Custom group chat creation (permission-based)
  • Group Members View: View all admins with access to a group chat via three-dot menu
• Private Chats:
  • One-on-one private chats between admins
  • Block/unblock functionality
  • Chat archiving
  • Chat Deletion: Delete chats completely from your view (not recoverable)
• Chat Options Menu (Three Dots):
  • Members: View all group chat members (for group chats only)
  • Archive Chat: Archive chat to hide it from main list
  • Block/Unblock Admin: Block or unblock admin in private chats
  • Delete Chat: Permanently delete chat from your view
• Mobile Optimization:
  • Mobile Navigation: Chat list and chat view switch on mobile (only one visible at a time)
  • Back Button: Back button in chat header to return to chat list
  • Touch Events: Long press on messages opens context menu (like WhatsApp)
  • Click on Messages: Click on message opens context menu with edit/delete/info options
  • GIF Picker Mobile: Full-screen modal on mobile (90vh), 2-column grid, touch feedback, auto-focus search
  • Menu Positioning: Fixed positioning relative to buttons for better mobile support
• Features:
  • Real-time message updates (AJAX polling every 2 seconds)
  • File uploads (images, PDFs, GIFs)
  • GIF picker with Giphy API integration (trending GIFs, search functionality)
  • Emoji picker
  • Typing indicators ("User xyz tippt...")
  • Read receipts (✓✓ gray for sent, ✓✓ green for read)
  • Message editing (in input field, only within 1 minute after sending)
  • Message deletion (only if unread and < 1 minute old)
  • Right-click context menu for messages (desktop)
  • Long-press context menu for messages (mobile)
  • Click context menu for messages (like WhatsApp)
  • Notification bell with unread count
  • Email notifications for >10 unread messages
• Message Restrictions:
  • Messages can only be edited within 1 minute after sending
  • Messages can only be deleted if unread AND within 15 minutes after sending
  • Read messages cannot be deleted
  • Deleted messages show generic "message deleted" in admin log
• Profile Pictures: Display in chat messages with fallback icon
• Whitespace Normalization: Automatic cleanup of excessive whitespace in messages
• POST-Redirect-GET Pattern: Prevents duplicate messages on page reload

13. Content Management System (CMS)

Stories Management

• Database-based stories
• Complete CRUD service
• Tag management
• Image upload (max. 5MB, JPG/PNG)
• Set display order

Team Management

• Database-based team members
• Complete management in admin panel
• Social media links
• Mobile swipe navigation (see section 2)

14. Technical Details

Backend

• PHP 8+ with strict_types
• PDO for database access
• Namespaces (Shop\Services, Shop\Database)
• Service-based architecture
• TCPDF for PDF generation
• PHPMailer for email sending
• Composer for dependencies (TwoFactorAuth, WebAuthn)

Frontend

• Vanilla JavaScript
• CSS with custom properties (CSS variables)
• Responsive design with Flexbox and Grid
• WebAuthn API for passkeys
• Touch swipe functionality for mobile devices

Database

• MySQL/MariaDB
• Normalized table structure
• Foreign keys for data integrity
• JSON fields for flexible data (custom_fields, items)

15. Code Quality

• JSDoc comments
• PHP DocBlocks for all methods
• Strict types (declare(strict_types=1))
• Error logging
• Try-catch blocks for error handling
• Consistent code formatting
• 14-line function limit (where possible)

16. Future Plans

The website is continuously being developed. Planned improvements:

• Global Review System: Review system for the entire website (not just products)
• Passkey Function: Improved cross-device support
• Design: Further design improvements and UX optimizations
• Performance: Optimizations for faster load times
• Features: Further features based on user feedback

Suggestions welcome!
Do you have ideas or suggestions for improving the website? We welcome your feedback!
support@printworks-shop.de

Developer

Leon Pfaffe

This website was completely developed, programmed and implemented by Leon Pfaffe.

Disclaimer:
Europe-Services (ES) and Leon Pfaffe assume no guarantee and no liability for the security, functionality, availability or content of this website. Responsibility lies solely with the operator Printworks.