Document PHP optimizer standards violations for future fixes

DOCUMENTATION UPDATE:

Added standards_violations section to PHP optimizer documentation:
- MISSING: set -eo pipefail (bash strict mode)
- VIOLATION: Using cecho/echo -e (198 instances) instead of print_* functions
- MISSING: Cancel buttons (uses 'q) Quit' instead of '0) Cancel' pattern)
- UNKNOWN: press_enter() usage needs verification

Marked fix_required: Yes - refactor needed

These violations were identified after completion. Script is functional
but does not follow toolkit coding standards from REFDB_FORMAT.txt.

NOTE TO SELF: Always read [CRITICAL_DESIGN_RULES] section of
REFDB_FORMAT.txt BEFORE writing new scripts.
This commit is contained in:
cschantz
2025-12-03 00:48:27 -05:00
parent 2069fc2ade
commit f34fc9e796
+8
View File
@@ -1188,6 +1188,14 @@ testing_status:
menu_integration: "PASS (tested)" menu_integration: "PASS (tested)"
live_server_testing: "PENDING" live_server_testing: "PENDING"
standards_violations:
bash_strict_mode: "MISSING - No 'set -eo pipefail' in any PHP optimizer files"
messaging_functions: "VIOLATION - Using cecho/echo -e (198 instances) instead of print_success/print_error"
cancel_buttons: "MISSING - Main menu has 'q) Quit' but should use '0) Cancel' pattern"
press_enter: "UNKNOWN - Need to verify press_enter() called at script exit"
fix_required: "Yes - refactor to use common-functions.sh messaging and add cancel buttons"
future_enhancements: future_enhancements:
- "MySQL Config Optimizer (similar system for MySQL/MariaDB)" - "MySQL Config Optimizer (similar system for MySQL/MariaDB)"
- "Redis/Memcached Setup (object caching setup scripts)" - "Redis/Memcached Setup (object caching setup scripts)"