Scope Exit Laravel Package

Getting Started

Use the scope_exit() helper to register cleanup logic that runs automatically when the current scope exits — even on exceptions. Start by installing (if available via Composer), then wrap resource management with a closure:

$lock = acquireLock('task');
scope_exit(fn() => releaseLock($lock));
// ... critical section ...

Your first real use case: managing temporary files, streams, or locks without sprawling try/finally. Read README.md if present, but expect sparse docs — the API is minimal (just one function).

Implementation Patterns

• Atomic Resource Lifecycle: Open/lock first, defer release immediately after — keeps cleanup proximate to allocation:

  $resource = fopen('php://temp', 'r+');
  scope_exit(fn() => fclose($resource));
  fwrite($resource, 'data');
  

• Transaction Rollback Safety: Ensure rollback runs unless explicitly committed:

  DB::beginTransaction();
  $committed = false;
  scope_exit(fn() => $committed ? : DB::rollBack());
  // ... operations ...
  DB::commit();
  $committed = true; // prevents rollback on exit
  

• Contextual Logging/Timing: Measure execution cost inline:

  $startTime = hrtime(true);
  scope_exit(fn() => logger()->debug('Operation took ' . (hrtime(true) - $startTime)/1e6 . ' ms'));
  // ... work ...
  

• Test Isolation: Restore global state safely after test assertions:

  $originalEnv = $_ENV;
  scope_exit(fn() => $_ENV = $originalEnv);
  putenv('TEST_MODE=1');
  // ... assertions ...
  

Gotchas and Tips

• Variable Capture: Defaults to by-reference for variables used inside the closure. Use use ($value) to capture by value — otherwise, changes before scope exit may affect your cleanup:

  $x = 1;
  scope_exit(fn() => echo $x); // prints 2 if $x is changed later
  $x = 2;
  

• LIFO Execution: Exits run reverse-order (last-in, first-out). Place related cleans together — e.g., unlock after commit, but close before log flush.
• Exception Propagation Risk: If a scope-exit closure throws, subsequent closures still run, but the original exception is lost. Wrap cleanup in try/catch for critical operations:

  scope_exit(fn() => {
      try { cleanup(); } catch (\Throwable $e) { /* log & ignore */ }
  });
  

• Cancellation Workaround: Since there’s no native cancel(), use a mutable flag (e.g., &$skip = false):

  $skipCleanup = false;
  scope_exit(fn() => $skipCleanup ?: $this->deleteTempFile());
  // ... on success ...
  $skipCleanup = true;
  

• IDE Limitations: Type inference may falter on closures passed to scope_exit(). Add explicit callable type hints or PHPDoc to avoid IDE errors.