symfony/filesystem
Filesystem
This is a PHP filesystem utility library that provides tools for manipulating files, directories, and symbolic links. It serves as a specialized set of tools for atomic writing, path normalization, recursive directory management, and cross-platform file manipulation.
The project features a dedicated atomic file writer that saves content to temporary locations before moving them to a final destination to prevent data corruption. It includes a recursive directory manager for creating, deleting, and modifying permissions for nested folder structures and their contents, as well as a path normalization tool for resolving relative paths and identifying shared root directories.
The library covers a broad surface of filesystem primitives, including file and directory copying, renaming, and deletion. It provides capabilities for path management, such as root extraction and segment joining, and includes security tools for managing file ownership and access permissions recursively across directories.
Features
- Atomic File Writes - Implements a specialized atomic file writer that prevents data corruption by using temporary files before renaming.
- Directory Creation - Provides functionality to create nested directory structures and their missing parent hierarchies recursively.
- Filesystem Manipulation Utilities - Provides a consistent PHP API for reading, writing, copying, moving, and deleting files and directories across operating systems.
- Recursive Hierarchy Management - Creates recursive folder structures and manages access permissions or ownership for complex directory hierarchies.
- Path Manipulations - Provides tools for constructing, parsing, and manipulating filesystem path strings for consistency.
- Filesystem API Abstractions - Wraps low-level PHP filesystem functions to provide a consistent, OS-agnostic interface for files and symbolic links.
- Recursive Directory Managers - Offers utilities for the recursive creation, removal, and permission management of nested folder structures.
- File System Operations - Provides standardized functions for core filesystem tasks including creation, deletion, and modification.
- Cross-Platform File Operations - Provides unified interfaces for performing basic file operations like copy, move, and delete across different operating systems.
- Recursive Directory Traversers - Recursively walks through nested directory structures to apply permissions, ownership, or deletion operations.
- Path Normalizers - Standardizes file separators and resolves relative segments to ensure consistent path behavior across different operating systems.
- Path Relation Calculations - Provides utilities to calculate the relative distance and relationship between two filesystem paths.
- Symbolic Link Managers - Implements utilities for creating symbolic links and resolving their absolute target locations on disk.
- File Existence Checks - Verifies if one or more files or directories exist on the disk.
- Timestamp-Based Overwrite Policies - Determines whether to overwrite destination files by comparing source and destination modification timestamps.
- Directory Copying - Duplicates files or entire directory trees and uses modification dates to manage overwrites.
- File Renaming and Relocations - Changes the name or directory location of specific files and folders within the filesystem.
- File Write and Append Operations - Allows adding content to the end of files while automatically ensuring parent directories exist.
- Filesystem Deletion Utilities - Removes files, folders, and symbolic links from the storage system.
- Timestamp Modification - Sets and updates access and modification times for files to track metadata changes.
- Temporary File Generators - Generates uniquely named files in system temporary locations for short-term application data storage.
- Common Path Finders - Analyzes multiple absolute paths to identify the longest shared root directory among them.
- Path Root Extractors - Extracts the parent directory or system root from a filesystem path across different environments.
- Path Segment Joiners - Concatenates multiple path segments into a single normalized filesystem path by resolving separators.
- Full File Readings - Reads the full text of a file into a string and provides error reporting for invalid paths.
