Download the PHP package patterns/filesystem without Composer

On this page you can find all versions of the php package patterns/filesystem. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of patterns/filesystem

Informations about the package filesystem

Patterns — Filesystem

Where your files land is a deployment detail. This is the contract that makes it one.

Seven operations that a local disk, an object store and an array in a test can all honour — plus one optional capability for the backends that can describe a path. The code that writes a file stops caring which of them it is talking to.

Part of the Patterns collection: small, focused building blocks. One pattern, one package.

Install

Contracts only — no implementation ships. A local disk, S3 through the official SDK, memory in a test: each is a small class of its own, and none of them belongs in the pattern.

The problem

Something writes a file. In development it lands on a disk, in production in a bucket, in a test it should land nowhere at all — and the code that writes it has to look the same in all three.

Without a contract, "where files live" leaks into every call site: file_put_contents() in one, $s3Client->putObject() in another, sys_get_temp_dir() in a third. Then a test needs a disk, a bucket needs credentials, and the decision can no longer be made in one place.

The pattern

Seven operations. A path is always a string. Failures throw — a missing file is not a value to branch on inside the port, and a caller who wants a Result can wrap the call. An adapter that returned one would force every other adapter to build one, which is policy, not shape.

Why exactly these seven

Everything else was left out on purpose:

Left out Because
chmod() Permission bits are POSIX authority. Object stores have none, so a port promising it cannot be satisfied by half the backends it describes.
clear() readDir() plus deleteFile() in a loop. Anything derivable is not a port's business.
copyFile(), copyDirectory() Composable from read and write. Copying a million files is an infrastructure decision, not an interface.
stat() Not every backend can answer. See below.
readFileSync(), writeFileAsync() An implementation's era, not a contract.
Caching A correctness hazard wearing an optimisation's coat. A cached exists() is the one answer you cannot afford to be wrong.
Retries, backoff, timeouts Transport policy.
Streams and resource handles The port promises text. A stream is an optimisation with its own lifecycle.
Globbing, symlinks, mkdir -p folklore Local filesystem trivia, not a contract.
Fetching an HTTP URL It is not a file operation. When a "filesystem" quietly reaches the network, you can no longer reason about it — pass an HTTP client instead.

Describing a path is a capability, not a promise

A local disk can answer "how big is this, and when did it change". S3 can. A write-only sink cannot, and a memory backend may not care. PHP has no optional interface methods, so the honest answer is a second, one-method interface:

Adapters that can, implement it. Callers that need it, ask:

A facade that wraps an adapter can only be as capable as the adapter it was handed. Saying so at runtime — one clear error — beats returning zeros that look like answers.

FileStats

Four facts, and no more:

mode, isSymbolicLink and atime are deliberately absent: they are POSIX detail, and a shape that half the backends implementing IStatable cannot fill is a lie told in the type system.

FileStats is a plain, immutable class — four readonly properties and typed accessors, no base class, no dependencies.

modified is stored as an ISO-8601 string rather than a date object, so JSON and a round trip through persisted data agree on one representation. Whatever the backend hands over — an epoch, a date string, a DateTimeInterface — create() normalizes it.

Implementing it

An in-memory backend is the whole port in about fifty lines, and it is the proof that the contract is small:

The same four lines describe the shape of every other adapter:

  1. Implement IFilesystem — seven methods, no base class, no trait.
  2. Throw on failure. Swap the message, keep the contract.
  3. Never reach for the network from a path. That is a different port.
  4. Implement IStatable only if you really can describe a path.
  5. Return bare names from readDir() — the same shape as readdir() — so one loop works over every backend.

A note on the name

Filesystem, one word — the way PHP spells it in FilesystemIterator, and the way Symfony, Laravel, Flysystem and Composer all spell it. FileSystem is the older, Java-flavoured spelling, and mixing the two in one codebase is a permanent papercut.

Testing

24 tests, 101 assertions. The suite runs without composer install — tests/bootstrap.php self-autoloads the package. It pins the shape of both contracts (add a method and it fails), proves the port is satisfiable by an array with no base class, and checks that FileStats normalizes, round-trips and cannot be mutated.

License

MIT

All versions of filesystem with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package patterns/filesystem contains the following files

Loading the files please wait ...