Code Conventions

class ProductService
{
    // 1. Constructor (dependency injection)
    public function __construct(
        private CatalogInterface $catalog,
    ) {}

    // 2. Public methods (called by controllers)
    public function createProduct(array $data): Product { }
    public function updateProduct(Product $product, array $data): Product { }
    public function deleteProduct(Product $product): void { }

    // 3. Private methods (internal helpers)
    private function attachVariants(Product $product, array $variants): void { }
    private function validateStock(array $items): void { }
}

class ProductController extends Controller
{
    // Constructor with service injection
    public function __construct(private ProductService $productService) {}

    // Standard CRUD methods in order
    public function index(Request $request) { }
    public function store(CreateProductRequest $request) { }
    public function show(string $id) { }
    public function update(UpdateProductRequest $request, string $id) { }
    public function destroy(string $id) { }

    // Custom action methods
    public function activate(string $id) { }
}

// Good
enum ProductStatus: string
{
    case ACTIVE = 'active';
    case DRAFT = 'draft';
}

// Bad
const STATUS_ACTIVE = 'active';

// Good — depend on interface
public function __construct(private CatalogInterface $catalog) {}

// Bad — depend on concrete class from another package
public function __construct(private CatalogService $catalog) {}

// Good
$company = company();
$profile = userProfile();

// Bad
$company = auth()->user()->currentProfile->company;

// Good — validation in FormRequest
public function store(CreateProductRequest $request) {
    $this->productService->create($request->validated());
}

// Bad — validation in controller
public function store(Request $request) {
    $request->validate(['title' => 'required']);
}