Smart File System Laravel Package

Getting Started

Begin by installing the package via Composer (composer require symplify/smart-file-system)—despite its archived status, it remains functional. Import the core Symplify\SmartFileSystem\SmartFileInfo class and instantiate it with a file path:

use Symplify\SmartFileSystem\SmartFileInfo;

$fileInfo = new SmartFileInfo('/path/to/file.php');

A common first use case is safely reading file contents:

$contents = $fileInfo->getContents(); // Throws FileNotFoundException if missing

Check file validity with intuitive methods like isReadable(), isFile(), or isEmpty() before operations.

Implementation Patterns

• Reliable File I/O: Replace file_get_contents()/file_put_contents() with SmartFileInfo::getContents(), setContents(), and append()—all throw descriptive exceptions on failure.
• Path Sanitization: Chain methods like getRelativePathname(), getFilenameWithoutExtension(), or getPathInfo() to avoid error-prone basename()/pathinfo() misuse.
• Bulk File Processing: Use with Laravel’s File::allFiles() or Symfony’s Finder to build SmartFileInfo[] collections, then iterate uniformly for linting, migration scripts, or code generation (e.g., foreach ($files as $info) { $info->getContents(); }).
• Test Fixtures: In unit tests, wrap fixture paths with SmartFileInfo to assert file properties (e.g., assert($fileInfo->isFile() && $fileInfo->isReadable())) without boilerplate.

Gotchas and Tips

• ⚠️ Archived & Unmaintained: No compatibility guarantees beyond PHP 7.x/Laravel 6–7. Test rigorously against PHP 8.0+—return type declarations or scalar types may cause runtime errors.
• ⚠️ Exception Handling: Methods like getContents() throw FileNotFoundException (not ErrorException). Always wrap in try/catch when file presence is uncertain.
• 💡 Extend Strategically: Copy SmartFileInfo locally into your project to add domain-specific helpers (e.g., isConfigFile() checks for .env, .json, .xml). Its minimal surface area (<200 lines) makes this trivial and future-proof.
• 💡 Avoid Path Concatenation: Use SmartFileInfo::getRelativePathname() + __DIR__ instead of string concatenation to prevent path separator issues on Windows/macOS.
• 🔧 Fallback Strategy: If dependency conflicts arise (e.g., with nette/utils), sidestep the package entirely—Laravel’s File facade (File::get(), File::put()) and Storage API cover 95% of use cases with active support.