jeroen-de-dauw/file-fetcher

This package is abandoned and no longer maintained. The author suggests using the jeroen/file-fetcher package instead.

Simple file fetching interface

4.2.0 2017-06-07 00:07 UTC

README

Build Status Code Coverage Scrutinizer Code Quality Latest Stable Version Download count

The philosophy behind this library is to provide a very basic interface (FileFetcher) that while insufficient for plenty of use cases, is ideal for a great many, in particular replacing procedural file_get_contents calls. The provided implementations are to facilitate testing and common generic tasks around the actual file fetching. You are encouraged to create your own core file fetching implementation in your codebase, presumably an adapter to a library that focuses on this task such as Guzzle.

Usage

The library provides some trivial implementations of the FileFetcher interface at its heart:

  • SimpleFileFetcher: Adapter around file_get_contents
  • InMemoryFileFetcher: Adapter around an array provided to its constructor
  • ThrowingFileFetcher: Throws a FileFetchingException for all calls
  • NullFileFetcher: Returns an empty string for all calls
  • StubFileFetcher: Returns a stub value for all calls

It also provides a number of generic decorators:

Installation

You can use Composer to download and install this package as well as its dependencies.

To add this package as a local, per-project dependency to your project, simply add a dependency on jeroen/file-fetcher to your project's composer.json file. Here is a minimal example of a composer.json file that just defines a dependency on FileFetcher 4.x:

{
    "require": {
        "jeroen/file-fetcher": "^4.0.0"
    }
}

Running the tests

For tests only

composer test

For style checks only

composer cs

For a full CI run

composer ci

Release notes

4.3.0 (2017-06-10)

  • Added getFirstFetchedUrl to SpyingFileFetcher
  • Added $defaultContent constructor parameter to InMemoryFileFetcher

4.2.0 (2017-06-07)

  • Added StubFileFetcher

4.1.0 (2017-05-11)

  • Added ThrowingFileFetcher
  • Added NullFileFetcher

4.0.0 (2017-05-09)

Breaking changes:

  • Added scalar type hints to the FileFetcher interface and its implementations
  • Added scalar type hints to FileFetchingException

Other changes:

  • Dropped support for PHP 5.x
  • Added ErrorLoggingFileFetcher
  • Added SpyingFileFetcher

3.1.0 (2016-01-07)

  • Added InMemoryFileFetcher

3.0.0 (2015-08-21)

  • Added FileFetchingException, which should now be thrown by implementations of FileFetcher on error
  • The non-public fields and methods of CachingFileFetcher are now private rather than protected
  • Added PHPCS and PHPMD integration

2.0.0 (2014-08-19)

  • Removed FileFetcher.php entry point. Autoloading is now done via Composers PSR-4 support.

1.0.1 (2013-07-06)

  • Added SimpleFileFetcher implementation

1.0.0 (2013-07-06)

  • Initial release with FileFetcher interface and CachingFileFetcher implementation

Links