Add Laravel Catch Block Rule for PHP

google-labs-jules[bot] · google-labs-jules[bot] · commit 67f488a9014f · 2026-01-03T01:20:36.000Z
- Implemented `LaravelCatchBlockRule` in `analyzers/php/laravel_catch.go` using AST parsing.
- Added dependency `github.com/z7zmey/php-parser` for robust PHP parsing.
- Updated `PHPAnalyzer` in `analyzers/php/php.go` to include the new rule and process its findings.
- The rule detects missing `report()` calls in catch blocks (Critical) and `report()` calls that are not the first statement (Medium) in Laravel app files.
- Added metrics `CatchBlocksMissingReport` and `CatchBlocksMisplacedReport` to `PHPFileAnalysis` model and output.
- Added comprehensive tests in `analyzers/php/laravel_catch_test.go`.
diff --git a/analyzers/php/laravel_catch.go b/analyzers/php/laravel_catch.go
@@ -20,7 +20,9 @@ func (r *LaravelCatchBlockRule) Name() string {
 
 // LaravelCatchBlockFinding holds the issues found by the rule
 type LaravelCatchBlockFinding struct {
-	Issues []models.Issue
+	Issues         []models.Issue
+	MissingReport  int
+	MisplacedReport int
 }
 
 func (r *LaravelCatchBlockRule) Apply(content string) interface{} {
@@ -42,12 +44,16 @@ func (r *LaravelCatchBlockRule) Apply(content string) interface{} {
 	}
 
 	return LaravelCatchBlockFinding{
-		Issues: v.issues,
+		Issues:          v.issues,
+		MissingReport:   v.missingReport,
+		MisplacedReport: v.misplacedReport,
 	}
 }
 
 type catchVisitor struct {
-	issues []models.Issue
+	issues          []models.Issue
+	missingReport   int
+	misplacedReport int
 }
 
 // Ensure catchVisitor implements walker.Visitor
@@ -107,12 +113,14 @@ func (v *catchVisitor) analyzeCatch(n *stmt.Catch) {
 	}
 
 	if !foundReport {
+		v.missingReport++
 		v.issues = append(v.issues, models.Issue{
 			Description: "Critical: Catch block missing report() call in Laravel app file",
 			Line:        startLine,
 			Severity:    "critical",
 		})
 	} else if !isFirst {
+		v.misplacedReport++
 		v.issues = append(v.issues, models.Issue{
 			Description: "Medium Risk: report() call is not the first statement in catch block",
 			Line:        startLine,
diff --git a/analyzers/php/php.go b/analyzers/php/php.go
@@ -149,10 +149,13 @@ func (a *PHPAnalyzer) analyzeFile(path string) *models.PHPFileAnalysis {
 	}
 
 	// Apply Laravel Catch Block Rule
+	var catchMissing, catchMisplaced int
 	if strings.Contains(path, "app/") {
 		lcbRule := &LaravelCatchBlockRule{}
 		if finding := lcbRule.Apply(contentStr); finding != nil {
 			result := finding.(LaravelCatchBlockFinding)
+			catchMissing = result.MissingReport
+			catchMisplaced = result.MisplacedReport
 			for i := range result.Issues {
 				result.Issues[i].Path = path
 			}
@@ -172,6 +175,9 @@ func (a *PHPAnalyzer) analyzeFile(path string) *models.PHPFileAnalysis {
 		}
 	}
 
+	analysis.CatchBlocksMissingReport = catchMissing
+	analysis.CatchBlocksMisplacedReport = catchMisplaced
+
 	analysis.Issues = allIssues
 	return analysis
 }
@@ -198,6 +204,12 @@ func (a *PHPAnalyzer) printResults(results []models.PHPFileAnalysis, totalFuncti
 			result.TotalFunctions,
 			result.CommentedFunctions,
 			result.CommentRatio)
+
+		// Optional: Print catch block warnings if present
+		if result.CatchBlocksMissingReport > 0 || result.CatchBlocksMisplacedReport > 0 {
+			fmt.Printf("      ⚠️  Catch Blocks: %d missing report(), %d misplaced\n",
+				result.CatchBlocksMissingReport, result.CatchBlocksMisplacedReport)
+		}
 	}
 
 	fmt.Println()
diff --git a/models/models.go b/models/models.go
@@ -60,6 +60,9 @@ type PHPFileAnalysis struct {
 	TotalBytes         int      `json:"total_bytes"`
 	CommentedBytes     int      `json:"commented_bytes"`
 	Issues             []Issue  `json:"issues"`
+	// Laravel Catch Block metrics
+	CatchBlocksMissingReport   int `json:"catch_blocks_missing_report,omitempty"`
+	CatchBlocksMisplacedReport int `json:"catch_blocks_misplaced_report,omitempty"`
 }
 
 // PHPAnalysisReport represents the complete PHP analysis report

Original file line number	Diff line number	Diff line change
`@@ -149,10 +149,13 @@ func (a PHPAnalyzer) analyzeFile(path string) models.PHPFileAnalysis {`
`149`	`149`	`}`
`150`	`150`
`151`	`151`	`// Apply Laravel Catch Block Rule`
	`152`	`+ var catchMissing, catchMisplaced int`
`152`	`153`	`if strings.Contains(path, "app/") {`
`153`	`154`	`lcbRule := &LaravelCatchBlockRule{}`
`154`	`155`	`if finding := lcbRule.Apply(contentStr); finding != nil {`
`155`	`156`	`result := finding.(LaravelCatchBlockFinding)`
	`157`	`+ catchMissing = result.MissingReport`
	`158`	`+ catchMisplaced = result.MisplacedReport`
`156`	`159`	`for i := range result.Issues {`
`157`	`160`	`result.Issues[i].Path = path`
`158`	`161`	`}`
`@@ -172,6 +175,9 @@ func (a PHPAnalyzer) analyzeFile(path string) models.PHPFileAnalysis {`
`172`	`175`	`}`
`173`	`176`	`}`
`174`	`177`
	`178`	`+ analysis.CatchBlocksMissingReport = catchMissing`
	`179`	`+ analysis.CatchBlocksMisplacedReport = catchMisplaced`
	`180`	`+`
`175`	`181`	`analysis.Issues = allIssues`
`176`	`182`	`return analysis`
`177`	`183`	`}`
`@@ -198,6 +204,12 @@ func (a *PHPAnalyzer) printResults(results []models.PHPFileAnalysis, totalFuncti`
`198`	`204`	`result.TotalFunctions,`
`199`	`205`	`result.CommentedFunctions,`
`200`	`206`	`result.CommentRatio)`
	`207`	`+`
	`208`	`+ // Optional: Print catch block warnings if present`
	`209`	`+ if result.CatchBlocksMissingReport > 0 \|\| result.CatchBlocksMisplacedReport > 0 {`
	`210`	`+ fmt.Printf(" ⚠️ Catch Blocks: %d missing report(), %d misplaced\n",`
	`211`	`+ result.CatchBlocksMissingReport, result.CatchBlocksMisplacedReport)`
	`212`	`+ }`
`201`	`213`	`}`
`202`	`214`
`203`	`215`	`fmt.Println()`
Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,9 @@ type PHPFileAnalysis struct {`
`60`	`60`	TotalBytes int `json:"total_bytes"`
`61`	`61`	CommentedBytes int `json:"commented_bytes"`
`62`	`62`	Issues []Issue `json:"issues"`
	`63`	`+ // Laravel Catch Block metrics`
	`64`	+ CatchBlocksMissingReport int `json:"catch_blocks_missing_report,omitempty"`
	`65`	+ CatchBlocksMisplacedReport int `json:"catch_blocks_misplaced_report,omitempty"`
`63`	`66`	`}`
`64`	`67`
`65`	`68`	`// PHPAnalysisReport represents the complete PHP analysis report`