Download the PHP package mallardduck/immutable-read-file without Composer
On this page you can find all versions of the php package mallardduck/immutable-read-file. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mallardduck/immutable-read-file
More information about mallardduck/immutable-read-file
Files in mallardduck/immutable-read-file
Package immutable-read-file
Short Description An experiment in making an 'immutable' wrapper for PHP's file functions.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package immutable-read-file
ImmutableReadFile - An immutable read-only file wrapper for PHP
If you've ever used fopen/SplFileObject and wanted the results to be idempotent1 this is de way.
With this library you get a read-only immutable wrapper for the basic SplFileObject - which is essentially the OOP fopen.
You probably would only rarely have a use case for this but if you do you'll know...and it may be hecking useful.
1 = Only technically because the wrapper tracks a "canonical" position to always work from.
Installation
You can install the package via composer:
Usage
Why! I don't get it?
So, you were warned that this would only be useful rarely - but when it is useful it's hecking useful. You did read that right?
The main way to understand when this is useful is to understand how it's different from fopen or SplFileObject.
Since this will be useful in cases when the default behavior of those is not desired.
So see for yourself! Examples...
How fopen works by default
The use of a second fopen, and the fseek, are to emulate what $step1->advanceBytePosition() does in the usage example.
How SplFileObject works by default
The use of a second new SplFileObject, and the $step2->fseek(1), are to emulate what $step1->advanceBytePosition() does in the usage example.
Summary
Comparing the ways that fopen and SplFileObject work we can see they are functionally identical to each other.
However, this also highlights how they are different from ImmutableReadFile.
When you use a method on either fopen/SplFileObject that returns content, then the current cursor position is incremented.
That means when you run fgetc on these you'll always get either: the next character, or the EOF.
However for ImmutableReadFile, these methods do not affect the cursor position.
This means that if you run fgetc, you'll always get the same exact character.
Only until you explicitly advance the byte position will you get a novel character.
When that happens you're actually getting a new instance of ImmutableFile too.
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Dan Pock
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
