php-basics-patterns

PHP Basics Series: Patterns & Conventions

This document captures specific patterns, conventions, and best practices observed in the php-basics series that should be replicated in new series.

Chapter Progression Philosophy

The php-basics series follows a deliberate learning path:

1. Foundation First (Ch 00-07): Core language features with no OOP
2. Paradigm Shift (Ch 08-10): Introduction to OOP concepts
3. Professional Tools (Ch 11-16): Real-world development practices
4. Application Building (Ch 17-19): Integrating all concepts into projects
5. Framework Introduction (Ch 20-22): Transition to frameworks with strong foundation

Key Principle: Don't introduce frameworks until fundamentals are mastered. Build understanding from scratch.

Step Structure Pattern

Every step follows this exact format:

## Step N: Descriptive Action Title (~X min)

### Goal

Single sentence stating the purpose of this step.

### Actions

1. **Do this first**: Explanation
2. **Then do this**: Explanation
3. **Code to write**:

```language
# filename: file.ext
code here
```

Expected Result

Exact output or state

Why It Works

Explanation of underlying concepts (2-4 sentences)

Troubleshooting

• Error message or symptom — Cause and solution
• Another common issue — Fix

**Rules:**
- Goal is always a single sentence
- Actions are numbered and use bold for the action verb
- Code examples always include filename comment
- Expected Result shows exact output
- Why It Works explains concepts, not just mechanics
- Troubleshooting includes at least 2-3 common issues

## Code Example Patterns

### PHP Script Pattern

```php
# filename: descriptive-name.php
<?php

declare(strict_types=1);

// Brief comment explaining the example
class Example
{
    // Implementation
}

// Usage demonstration
$example = new Example();
echo $example->doSomething();

Key Elements:

• Filename comment at top
• declare(strict_types=1); for modern examples
• Opening <?php tag always present
• No closing ?> tag for pure PHP files
• Brief explanatory comments
• Show both definition and usage
• Include output demonstration

Command Pattern