Hi %FNAME%,
Thank you for signing up! We're excited to have you on board.
Your account email is: %EMAIL%
Thanks,
The %SITE_NAME% Team
No clients found.
| Name | Phone | Actions | |
|---|---|---|---|
| View Edit |
Email: data['client']['email']); ?>
Phone: data['client']['phone'] ?? '-'); ?>
No orders yet.
| Order ID | Total | Date |
|---|---|---|
| # | $ |
";
echo "Error: " . $e->getMessage() . "\n";
echo "File: " . $e->getFile() . "\n";
echo "Line: " . $e->getLine() . "\n";
echo "\nStack Trace:\n" . $e->getTraceAsString();
echo "";
} else {
// Generic error in production
$this->view->data['error'] = 'An error occurred. Please try again.';
$this->view->data['form_data'] = $_POST;
$this->view->render('clients/create', true, 'site');
// Log the error
error_log("Client creation failed: " . $e->getMessage());
}
}
}
private function validateClientData($data)
{
if (!Validator::required($data['name'] ?? '')) {
throw new ValidationException('Name is required');
}
if (!Validator::email($data['email'] ?? '')) {
throw new ValidationException('Valid email is required');
}
// Check for duplicate email
$existing = Db::getRow("SELECT id FROM clients WHERE email = :email",
[':email' => $data['email']]
);
if ($existing) {
throw new ValidationException('A client with this email already exists');
}
}
}
// Custom exception for validation errors
class ValidationException extends Exception {}
```
### API Error Handling
```php
validateProduct($input);
$productId = Db::insert('products', [
'name' => $input['name'],
'price' => $input['price'],
'created_at' => date('Y-m-d H:i:s')
]);
http_response_code(201);
echo json_encode([
'success' => true,
'data' => ['id' => $productId]
]);
} catch (ApiException $e) {
http_response_code($e->getCode());
echo json_encode([
'success' => false,
'error' => $e->getMessage()
]);
} catch (Exception $e) {
http_response_code(500);
echo json_encode([
'success' => false,
'error' => DEBUG ? $e->getMessage() : 'Internal server error'
]);
error_log("API Error: " . $e->getMessage());
}
}
private function validateProduct($data)
{
if (!isset($data['name']) || empty(trim($data['name']))) {
throw new ApiException('Product name is required', 400);
}
if (!isset($data['price']) || !is_numeric($data['price'])) {
throw new ApiException('Valid price is required', 400);
}
if ($data['price'] < 0) {
throw new ApiException('Price cannot be negative', 400);
}
}
}
// Custom exception for API errors
class ApiException extends Exception {
public function __construct($message, $code = 400) {
parent::__construct($message, $code);
}
}
```
### Command Error Handling
```php
$order['id'],
'error' => $e->getMessage()
];
echo "E";
}
}
echo "\n\n";
echo "Processed: $processed\n";
echo "Errors: " . count($errors) . "\n";
if (!empty($errors)) {
echo "\nFailed Orders:\n";
foreach ($errors as $error) {
echo "Order #{$error['order_id']}: {$error['error']}\n";
}
exit(1); // Exit with error code
}
} catch (Exception $e) {
echo "\nFATAL ERROR: " . $e->getMessage() . "\n";
exit(1);
}
function processOrder($order) {
// Order processing logic
// Throw exceptions on failures
}
```
# Common Configurations & Features
## `config.php` - Framework Configuration
The `config.php` file is the central hub for all framework-wide configurations. It handles security-related keys, API keys, debugging settings, and various integration parameters.
### Security Configurations
It is **highly recommended** to change all security-related values for each new project.
* **`define('DEBUG', false);`**: Set to `true` to enable error reporting for development. **Always set to `false` in production.**
* **`define('SECUREAPI', false);`**: Set to `true` to require an authorization key for API access.
* **`define('AUTHORIZATION', 'your_secret_api_key');`**: The secret key required when `SECUREAPI` is true. **Always change this to a strong, random value.**
**Example: Generating a secure API key**
```php
// Generate a random API key
define('AUTHORIZATION', bin2hex(random_bytes(32)));
```
### Database Configuration
```php
// Database settings
define('DB_HOST', 'localhost');
define('DB_NAME', 'your_database');
define('DB_USER', 'your_username');
define('DB_PASS', 'your_password');
define('DB_CHARSET', 'utf8mb4');
```
### API Keys and Integrations
All third-party API keys (Stripe, PHPMailer, etc.) are managed in this file, making them globally accessible via their defined constants.
```php
// Stripe
define('STRIPE_SECRET_KEY', 'sk_test_...');
define('STRIPE_PUBLIC_KEY', 'pk_test_...');
// Email (PHPMailer)
define('SMTP_HOST', 'smtp.gmail.com');
define('SMTP_PORT', 587);
define('SMTP_USER', 'your-email@gmail.com');
define('SMTP_PASS', 'your-app-password');
define('SMTP_FROM', 'noreply@yoursite.com');
define('SMTP_FROM_NAME', 'Your Site Name');
// AWS S3
define('AWS_KEY', 'your-aws-key');
define('AWS_SECRET', 'your-aws-secret');
define('AWS_REGION', 'us-east-1');
define('AWS_BUCKET', 'your-bucket-name');
// Other services
define('RECAPTCHA_SITE_KEY', 'your-site-key');
define('RECAPTCHA_SECRET_KEY', 'your-secret-key');
```
### Path Constants
```php
// Define base paths
define('ROOT_PATH', __DIR__);
define('APP_PATH', ROOT_PATH . '/app');
define('PUBLIC_PATH', ROOT_PATH . '/public');
define('TEMPLATES_PATH', ROOT_PATH . '/templates');
define('UPLOADS_PATH', PUBLIC_PATH . '/uploads');
```
### Environment-Specific Configuration
```php
// Determine environment
define('ENVIRONMENT', getenv('APP_ENV') ?: 'production');
// Environment-specific settings
if (ENVIRONMENT === 'development') {
define('DEBUG', true);
define('BASE_URL', 'http://localhost:8000');
} else {
define('DEBUG', false);
define('BASE_URL', 'https://yoursite.com');
}
```
## .htaccess and SSL
The root `.htaccess` file includes a rule for automatic redirection to HTTPS. It is recommended to temporarily disable this rule when setting up a new SSL certificate (e.g., with Let's Encrypt) to avoid issues with the verification process.
```apache
# Force HTTPS
# Comment out these lines when setting up SSL certificate
RewriteCond %{HTTPS} off
RewriteRule ^(.*)$ https://%{HTTP_HOST}%{REQUEST_URI} [L,R=301]
# Standard routing
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php [QSA,L]
```
## Public Assets Structure
The `public/assets` directory is organized to promote performance and streamline debugging by using page-specific CSS and JavaScript files.
```
public/assets/
├── css/
│ ├── global.css # Site-wide styles
│ ├── clients.css # Page-specific: clients
│ ├── products.css # Page-specific: products
│ └── dashboard.css # Page-specific: dashboard
├── js/
│ ├── global.js # Site-wide scripts
│ ├── clients.js # Page-specific: clients
│ ├── products.js # Page-specific: products
│ └── dashboard.js # Page-specific: dashboard
└── images/
├── logo.png
└── icons/
```
**Wrapper automatically loads page-specific assets:**
```php
getControllerName());
if (file_exists(PUBLIC_PATH . "/assets/css/{$controller}.css")) {
echo "";
}
?>
```
## View System
### Wrappers (Header & Footer)
A "wrapper" is the main site template (`header.php` and `footer.php`). You can control which wrapper to use or disable it entirely, which is useful for pages like a login screen.
**Wrapper Location:**
```
templates/wrappers/
├── site/ # Main site wrapper
│ ├── header.php
│ └── footer.php
├── admin/ # Admin panel wrapper
│ ├── header.php
│ └── footer.php
└── minimal/ # Minimal wrapper (login, etc.)
├── header.php
└── footer.php
```
**Usage Examples:**
```php
// Use default 'site' wrapper
$this->view->render('clients/index', true, 'site');
// Use admin wrapper
$this->view->render('admin/dashboard', true, 'admin');
// Use minimal wrapper (login page)
$this->view->render('auth/login', true, 'minimal');
// No wrapper at all
$this->view->render('auth/login', false);
```
**Example Wrapper (`templates/wrappers/site/header.php`):**
```php
Hi %FNAME%,
Thank you for signing up! We're excited to have you on board.
Your account email is: %EMAIL%
Thanks,
The %SITE_NAME% Team