Pathwise Documentation

Pathwise is a PHP 8.4+ toolkit built as Flysystem + higher-level workflows. It provides safe file IO, directory automation, upload pipelines, policy checks, queue/audit tooling, and operational helpers.

Contents

• Overview
  • Why Pathwise
  • Quick Start
  • Read Next
• Installation
  • Where to Use First
• Capabilities
  • At a Glance
  • Primary Modules
  • Storage and Path Model
  • Runtime and Extensions
  • What to Read Next
• Storage Adapters
  • What StorageFactory Supports
  • Official Adapter Coverage
  • Basic Local Example
  • Any Adapter Example (S3)
  • Custom Driver Registration
  • Helper Functions (autoloaded)
  • Processor Integration Notes
  • Recommended Operational Pattern
• Unified Pathwise Facade
  • Path-Bound Access
  • Directory + Compression via Same Entry
  • Static Gateways
  • Storage from Facade
  • Operational Tooling from Facade
• Quickstart
  • 1) Install
  • 2) Basic File Lifecycle
  • 3) Mount a Storage and Use Scheme Paths
  • 4) Directory Sync with Diff Report
  • 5) Upload Validation and Chunk Finalization
  • 6) Compression with Filters + Progress
  • 7) Observability and Guardrails
• Recipes
  • Recipe 1: Ingest -> Audit -> Retain
  • Recipe 2: Mirror + Zip + Checksum
  • Recipe 3: Duplicate Scan + Optional Dedupe
  • Recipe 4: Mounted Storage Workflow
• File Manager
  • FileOperations
  • SafeFileReader
  • SafeFileWriter
  • FileCompression
• Directory Manager
  • Example
• Upload Processing
  • Security Hardening Controls
  • Examples
• Download Processing
  • Security controls
  • Examples
• Security
  • Example
• Queue
  • Example
• Observability
  • Example
• Indexing
  • Example
• Retention
  • Example
• Utilities
  • Examples
• Helper Functions
  • Example
• Native Execution
  • Where to use
  • Example