2017 © Pedro Peláez
 

library file-fetcher

Simple file fetching interface

image

jeroen/file-fetcher

Simple file fetching interface

  • PHP
  • 5 Dependents
  • 0 Suggesters
  • 2 Forks
  • 0 Open issues
  • 14 Versions
  • 9 % Grown

The README.md

FileFetcher

Build Status codecov Type Coverage Psalm level Latest Stable Version Download count, (*1)

The philosophy behind this library is to provide a very basic interface (FileFetcher) that is ideal for 95% of network access cases, such as your typical file_get_contents call. It explicitly does not try to deal with the more complex cases., (*2)

Several basic implementations are provided. These include the test doubles you typically need to test services that use the FileFetcher interface. You can easily create an adapter to a more heavy network access library (such as Guzzle) in your own codebase., (*3)

Usage

$fileContent = $fileFetcher->fetchFile($fileLocation);

The library provides some trivial implementations of the FileFetcher interface at its heart:, (*4)

  • 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
  • CallbackFileFetcher: Adapter around a callback
  • LazyStubFileFetcher: Return a lazily retrieved stub value for all calls

It also provides a number of decorators:, (*5)

Decorators provided by jeroen/file-fetcher-cache:, (*6)

  • PsrCacheFileFetcher: Caches file contents via PSR-16 SimpleCache
  • CachingFileFetcher: Caches file contents. Requires jeroen/simple-cache to be loaded

Decorators provided by jeroen/file-fetcher-stopwatch:, (*7)

  • StopwatchFileFetcher: Profiles calls using Symfony Stopwatch. Requires symfony/stopwatch to be loaded

Installation

You can use Composer to download and install this package as well as its dependencies., (*8)

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 6.x:, (*9)

{
    "require": {
        "jeroen/file-fetcher": "~6.0"
    }
}

Development

Start by installing the project dependencies by executing, (*10)

composer update

You can run the tests by executing, (*11)

make test

You can run the style checks by executing, (*12)

make cs

To run all CI checks, execute, (*13)

make ci

You can also invoke PHPUnit directly to pass it arguments, as follows, (*14)

vendor/bin/phpunit --filter SomeClassNameOrFilter

Release notes

6.1.0 (2022-04-26)

  • Added support for installation with psr/log 2.x and 3.x
  • Raised minimum PHP version from 7.1 to 7.3
  • Improved type documentation

6.0.0 (2019-01-17)

Breaking changes to increase package stability and avoid the need for breaking changes in the future., (*15)

  • Removed PsrCacheFileFetcher, now part of jeroen/file-fetcher-cache
  • Removed CachingFileFetcher, now part of jeroen/file-fetcher-cache
  • Removed StopwatchFileFetcher, now part of jeroen/file-fetcher-stopwatch

5.0.1 (2019-01-16)

  • PsrCacheFileFetcher now ensures cache keys are valid

5.0.0 (2019-01-16)

  • Added PsrCacheFileFetcher
  • Added StopwatchFileFetcher
  • jeroen/simple-cache, which is needed by CachingFileFetcher is no longer loaded by default

4.5.0 (2018-12-19)

  • Switched License from GPL-2.0-or-later to BSD-3-Clause

4.4.0 (2018-05-31)

  • Dropped support for PHP 7.0
  • Added CallbackFileFetcher
  • Added LazyStubFileFetcher

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:, (*16)

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

Other changes:, (*17)

  • 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

The Versions

05/07 2018

dev-master

9999999-dev https://github.com/JeroenDeDauw/FileFetcher

Simple file fetching interface

  Sources   Download

GPL-2.0+ GPL-2.0-or-later

The Requires

 

The Development Requires

by Avatar Jeroen De Dauw

curl cache file_get_contents wget file fetcher

31/05 2018

4.4.0

4.4.0.0 https://github.com/JeroenDeDauw/FileFetcher

Simple file fetching interface

  Sources   Download

GPL-2.0-or-later

The Requires

 

The Development Requires

by Avatar Jeroen De Dauw

curl cache file_get_contents wget file fetcher

30/05 2018

dev-suchlazy

dev-suchlazy https://github.com/JeroenDeDauw/FileFetcher

Simple file fetching interface

  Sources   Download

GPL-2.0-or-later

The Requires

 

The Development Requires

by Avatar Jeroen De Dauw

curl cache file_get_contents wget file fetcher

03/02 2018

4.3.0

4.3.0.0 https://github.com/JeroenDeDauw/FileFetcher

Simple file fetching interface

  Sources   Download

GPL-2.0-or-later

The Requires

 

The Development Requires

by Avatar Jeroen De Dauw

curl cache file_get_contents wget file fetcher

07/06 2017

4.2.0

4.2.0.0 https://github.com/JeroenDeDauw/FileFetcher

Simple file fetching interface

  Sources   Download

GPL-2.0+

The Requires

 

The Development Requires

by Avatar Jeroen De Dauw

curl cache file_get_contents wget file fetcher

11/05 2017

4.1.0

4.1.0.0 https://github.com/JeroenDeDauw/FileFetcher

Simple file fetching interface

  Sources   Download

GPL-2.0+

The Requires

 

The Development Requires

by Avatar Jeroen De Dauw

curl cache file_get_contents wget file fetcher

09/05 2017

4.0.0

4.0.0.0 https://github.com/JeroenDeDauw/FileFetcher

Simple file fetching interface

  Sources   Download

GPL-2.0+

The Requires

 

The Development Requires

by Avatar Jeroen De Dauw

curl cache file_get_contents wget file fetcher

18/08 2016

dev-SpyingFileFetcher

dev-SpyingFileFetcher https://github.com/JeroenDeDauw/FileFetcher

Simple file fetching interface

  Sources   Download

GPL-2.0+

The Requires

 

The Development Requires

by Avatar Jeroen De Dauw

curl cache file_get_contents wget file fetcher

07/01 2016

3.1.0

3.1.0.0 https://github.com/JeroenDeDauw/FileFetcher

Simple file fetching interface

  Sources   Download

GPL-2.0+

The Requires

 

The Development Requires

by Avatar Jeroen De Dauw

curl cache file_get_contents wget file fetcher

07/01 2016

dev-null

dev-null https://github.com/JeroenDeDauw/FileFetcher

Simple file fetching interface

  Sources   Download

GPL-2.0+

The Requires

 

The Development Requires

by Avatar Jeroen De Dauw

curl cache file_get_contents wget file fetcher

21/08 2015

3.0.0

3.0.0.0 https://github.com/JeroenDeDauw/FileFetcher

Simple file fetching interface

  Sources   Download

GPL-2.0+

The Requires

 

The Development Requires

by Avatar Jeroen De Dauw

curl cache file_get_contents wget file fetcher

19/08 2014

2.0.0

2.0.0.0 https://github.com/JeroenDeDauw/FileFetcher

Simple file fetching interface

  Sources   Download

GPL-2.0+

The Requires

 

by Avatar Jeroen De Dauw

curl cache file_get_contents wget file fetcher

06/07 2013

1.0.1

1.0.1.0 https://github.com/JeroenDeDauw/FileFetcher

Simple file fetching interface

  Sources   Download

GPL-2.0+

The Requires

 

by Avatar Jeroen De Dauw

file fetcher

06/07 2013

1.0

1.0.0.0 https://github.com/JeroenDeDauw/FileFetcher

Simple file fetching interface

  Sources   Download

GPL-2.0+

The Requires

 

by Avatar Jeroen De Dauw

file fetcher