Download the PHP package jhofm/flysystem-iterator without Composer
On this page you can find all versions of the php package jhofm/flysystem-iterator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jhofm/flysystem-iterator
More information about jhofm/flysystem-iterator
Files in jhofm/flysystem-iterator
Package flysystem-iterator
Short Description Iterator plugin for league/flysystem
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 flysystem-iterator
flysystem-iterator (deprecated)
Deprecation
This package is deprecated. league/flysystem v2.0 supports filterable recursive iterators out of the box. You can still use this plugin if for some reason you are unable to upgrade from version v1.x.
About
Provides a plugin that creates an Iterator to iterate over paths in a Flysystem\FileSystem, supporting recursion and custom filters.
Recursive iteration is more memory-efficient than Flysystem's recursive listContents lookup
($filesystem->listContents('', true)), since only directory contents that are part
of the current item's ancestry are kept in memory.
The returned iterator is seekable, countable and jsonserializable. Using these functions will often require a complete recursion over all items in the filesystem.
Requirements
- PHP 7.0 - 7.4
Installation
The library can be added to your project via composer.
`
Quick Start
Configuration options
Iterator behaviour can be controlled by passing a key/value configuration array to the plugin. Constants exist in the Options\Options class for all available option keys and string values.
Iterator recursion is enabled by default, and can be disabled by passing:
When recursion is enabled, the first value returned by the iterator will be the directory that is iterated over. To ignore the root directory and start iteration with the directories contents you can pass the parameter
This parameter has no effect if recursion is disabled.
The iterator will return a numerical index as the key and the file information array returned by listContents() for the current item.
Additional filesystem metadata can be added to the items by passing an array of additional properties to the configuration array. Allowed property names are the same as in Flysystem's ListWith plugin.
Alternatively, the path of the current item, relative to the directory being iterated, may be returned as the value instead of the info array. Unlike the paths in filesystem's info array directories will have a trailing slash, so it is possible to distinguish files from directories without the type information.
The paths that the iterator returns can be filtered by passing a filter closure. The current list item is passed to the filter. The item will be included in the result if the closure returns true. The following example only returns files (directories are skipped) with a size of 1kb or more.
A filter factory is included that provides a number of ready to use filter callbacks, including boolean wrappers.
A subdirectory can be specified as an optional second parameter to the createIterator() function. If omitted, the iterator will use the directory set by the filesystem adapter.
Known Issues
- Filters do not work with path return values
