PHPackages linkorb/filelist - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [File & Storage](/categories/file-storage) 4. / 5. linkorb/filelist Abandoned → [linkorb/filespace](/?search=linkorb%2Ffilespace)Library[File & Storage](/categories/file-storage) linkorb/filelist ================ Easily attach lists of files to any object in your application 21.9k↓50%1PHP Since May 15Pushed 11y ago2 watchersCompare [ Source](https://github.com/linkorb/filelist)[ Packagist](https://packagist.org/packages/linkorb/filelist)[ RSS](/packages/linkorb-filelist/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependenciesVersions (1)Used By (0) FileList library ================ [](#filelist-library) Easily manage lists of files attached to any object in your application **PLEASE READ**: This package is no longer maintained, and replaced by a better implementation. Please check out FileSpace instead: How does it work: ----------------- [](#how-does-it-work) First, you need to instantiate a `driver`. The driver allows you to chose where your files will be physically stored. The simplest driver is the `FileSystemDriver`. You can instantiate it like this: ``` $driver = new LinkORB\Component\FileList\Driver\FileSystemDriver("/data/myfilelists/"); ``` Second, you define a `key` for your new file-list. Here are some examples: - `user.joe.contracts`: This would store all contracts for a user called "joe" - `project.42.scans`: Here you would store all scans for a project with id "42" - `post.99.downloads`: Attach a list of downloads to a post with id "99" ... and so on. It's up to you and your app to choose these keys. They don't need to exist anywhere, or be registered. It will just work. Now that you've chosen a `key` for your list, you can retrieve your filelist instance: ``` $filelist = $driver->getFileListByKey('user.joe.contracts'); echo "Attached files: " . $filelist->getFileCount(); ``` Using the filelist instance, you can easily add, remove, and list files: ``` // Upload a local file to the filelist, and give it a name: $filelist->upload("/tmp/myphoto.png", "avatar.png"); // List all files on the filelist: foreach($filelist->getFiles() as $file) { echo "File: " . $file->getFilename() . "\n"; } // Download the file back from the filelist to a local directory: $filelist->download("/home/photo.png", "avatar.png"); // Delete the file from the filelist: $filelist->delete("avatar.png"); ``` Benefits -------- [](#benefits) One of the benefits of using FileList vs regular files, is that you can swap storage backends. It's quick and simple to write to files in directories directly, but as your application grows, you may want to start storing that data remotely in S3, GridFS, etc... Using the FileList library, this becomes a simple matter of attaching a different driver. For example, you can use the [objectstorage](http://www.github.com/linkorb/objectstorage) library to easily store your content in S3, GridFs, PDO etc. Console tool ------------ [](#console-tool) This library comes with a simple console application that uses the library. You can use it for testing and introspection. ### Example console commands: [](#example-console-commands) ``` # Upload a file to a filelist bin/console filelist:upload user.joe.photos /home/test/avatar.png # Download a file from a filelist bin/console filelist:download user.joe.photos avatar.png /home/test/output.png # List files on a filelist bin/console filelist:list user.joe.photos # Delete data from object storage bin/console filelist:delete user.joe.photos avatar.png ``` ### Configuration file [](#configuration-file) The console tool can be configured using a configuration file. It will look for a file called `filelist.conf` in the current directory. Alternatively it will look for `~/.filelist.conf` and finally for `/etc/filelist.conf`. You can also specify a config file explicity by using the option `--config myconfig.conf` ### Example config file: [](#example-config-file) This repository contains a file called `filelist.conf.dist` which you can use to copy to `filelist.conf` and add your own configuration. The comments in this file explain what options are available. Features -------- [](#features) - PSR-0 compatible, works with composer and is registered on packagist.org - PSR-1 and PSR-2 level coding style - List, Upload, Download, Delete, Get and Set commands. - Included with command line utility for testing and introspection Todo (Pull-requests welcome!) ----------------------------- [](#todo-pull-requests-welcome) - Integrate github.com/linkorb/objectstorage for S3, GridFs, PDO support Installing ---------- [](#installing) Check out [composer](http://www.getcomposer.org) for details about installing and running composer. Then, add `linkorb/objectstorage` to your project's `composer.json`: ``` { "require": { "linkorb/filelist": "dev-master" } } ``` Contributing ------------ [](#contributing) Ready to build and improve on this repo? Excellent! Go ahead and fork/clone this repo and we're looking forward to your pull requests! If you are unable to implement changes you like yourself, don't hesitate to open a new issue report so that we or others may take care of it. License ------- [](#license) Please check LICENSE.md for full license information Brought to you by the LinkORB Engineering team ---------------------------------------------- [](#brought-to-you-by-the-linkorb-engineering-team) [![](https://camo.githubusercontent.com/62fb66b034de7ea7fca9fd9776424b5348daa76ef8622caf92c2f7622003e5ef/687474703a2f2f7777772e6c696e6b6f72622e636f6d2f642f6d6574612f74696572312f696d616765732f6c696e6b6f7262656e67696e656572696e672d6c6f676f2e706e67)](https://camo.githubusercontent.com/62fb66b034de7ea7fca9fd9776424b5348daa76ef8622caf92c2f7622003e5ef/687474703a2f2f7777772e6c696e6b6f72622e636f6d2f642f6d6574612f74696572312f696d616765732f6c696e6b6f7262656e67696e656572696e672d6c6f676f2e706e67) Check out our other projects at [linkorb.com/engineering](http://www.linkorb.com/engineering). Btw, we're hiring! ### Health Score 26 — LowBetter than 43% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity23 Limited adoption so far Community9 Small or concentrated contributor base Maturity41 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/1db66b320db18b8036ea68211b7d8a39e7c6da97e6fd29f59a50380ebb69d0bb?d=identicon)[joostfaassen](/maintainers/joostfaassen) --- Top Contributors [![joostfaassen](https://avatars.githubusercontent.com/u/411113?v=4)](https://github.com/joostfaassen "joostfaassen (8 commits)") ### Embed Badge ![Health badge](/badges/linkorb-filelist/health.svg) ``` [![Health](https://phpackages.com/badges/linkorb-filelist/health.svg)](https://phpackages.com/packages/linkorb-filelist) ``` ### Alternatives [knplabs/gaufrette PHP library that provides a filesystem abstraction layer 2.5k39.8M123](/packages/knplabs-gaufrette)[superbalist/flysystem-google-storage Flysystem adapter for Google Cloud Storage 26320.6M30](/packages/superbalist-flysystem-google-storage)[illuminate/filesystem The Illuminate Filesystem package. 15161.6M2.6k](/packages/illuminate-filesystem)[creocoder/yii2-flysystem The flysystem extension for the Yii framework 2931.7M62](/packages/creocoder-yii2-flysystem)[flowjs/flow-php-server PHP library for handling chunk uploads. Works with flow.js html5 file uploads. 2451.6M15](/packages/flowjs-flow-php-server)[madnest/madzipper Easier zip file handling for Laravel applications. 1382.3M6](/packages/madnest-madzipper) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)