CHANGELOG.rst 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  1. =========
  2. Changelog
  3. =========
  4. 4.0.0 (2024-06-19)
  5. ------------------
  6. * Changed the minimum PHP version to 7.4+
  7. * Created .gitattributes to avoid installing test folder
  8. https://github.com/ezimuel/guzzlestreams/pull/2
  9. 3.0.0 (2014-10-12)
  10. ------------------
  11. * Now supports creating streams from functions and iterators.
  12. * Supports creating buffered streams and asynchronous streams.
  13. * Removed ``functions.php``. Use the corresponding functions provided by
  14. ``GuzzleHttp\Streams\Utils`` instead.
  15. * Moved ``GuzzleHttp\Stream\MetadataStreamInterface::getMetadata`` to
  16. ``GuzzleHttp\Stream\StreamInterface``. MetadataStreamInterface is no longer
  17. used and is marked as deprecated.
  18. * Added ``attach()`` to ``GuzzleHttp\Stream\StreamInterface`` for PSR-7
  19. compatibility.
  20. * Removed ``flush()`` from StreamInterface.
  21. * Removed the ``$maxLength`` parameter from
  22. ``GuzzleHttp\Stream\StreamInterface::getContents()``. This function now
  23. returns the entire remainder of the stream. If you want to limit the maximum
  24. amount of data read from the stream, use the
  25. ``GuzzleHttp\Stream\Utils::copyToString()`` function.
  26. * Streams that return an empty string, ``''``, are no longer considered a
  27. failure. You MUST return ``false`` to mark the read as a failure, and ensure
  28. that any decorators you create properly return ``true`` in response to the
  29. ``eof()`` method when the stream is consumed.
  30. * ``GuzzleHttp\Stream\Stream::__construct``,
  31. ``GuzzleHttp\Stream\Stream::factory``, and
  32. ``GuzzleHttp\Stream\Utils::create`` no longer accept a size in the second
  33. argument. They now accept an associative array of options, including the
  34. "size" key and "metadata" key which can be used to provide custom metadata.
  35. * Added ``GuzzleHttp\Stream\BufferStream`` to add support for buffering data,
  36. and when read, shifting data off of the buffer.
  37. * Added ``GuzzleHttp\Stream\NullBuffer`` which can be used as a buffer that
  38. does not actually store any data.
  39. * Added ``GuzzleHttp\Stream\AsyncStream`` to provide support for non-blocking
  40. streams that can be filled by a remote source (e.g., an event-loop). If a
  41. ``drain`` option is provided, the stream can also act as if it is a blocking
  42. stream.
  43. 2.1.0 (2014-08-17)
  44. ------------------
  45. * Added an InflateStream to inflate gzipped or deflated content.
  46. * Added ``flush`` to stream wrapper.
  47. * Added the ability to easily register the GuzzleStreamWrapper if needed.
  48. 2.0.0 (2014-08-16)
  49. ------------------
  50. * Deprecated functions.php and moved all of those methods to
  51. ``GuzzleHttp\Streams\Utils``. Use ``GuzzleHttp\Stream\Stream::factory()``
  52. instead of ``GuzzleHttp\Stream\create()`` to create new streams.
  53. * Added ``flush()`` to ``StreamInterface``. This method is used to flush any
  54. underlying stream write buffers.
  55. * Added ``FnStream`` to easily decorate stream behavior with callables.
  56. * ``Utils::hash`` now throws an exception when the stream cannot seek to 0.
  57. 1.5.1 (2014-09-10)
  58. ------------------
  59. * Stream metadata is grabbed from the underlying stream each time
  60. ``getMetadata`` is called rather than returning a value from a cache.
  61. * Properly closing all underlying streams when AppendStream is closed.
  62. * Seek functions no longer throw exceptions.
  63. * LazyOpenStream now correctly returns the underlying stream resource when
  64. detached.
  65. 1.5.0 (2014-08-07)
  66. ------------------
  67. * Added ``Stream\safe_open`` to open stream resources and throw exceptions
  68. instead of raising errors.
  69. 1.4.0 (2014-07-19)
  70. ------------------
  71. * Added a LazyOpenStream
  72. 1.3.0 (2014-07-15)
  73. ------------------
  74. * Added an AppendStream to stream over multiple stream one after the other.
  75. 1.2.0 (2014-07-15)
  76. ------------------
  77. * Updated the ``detach()`` method to return the underlying stream resource or
  78. ``null`` if it does not wrap a resource.
  79. * Multiple fixes for how streams behave when the underlying resource is
  80. detached
  81. * Do not clear statcache when a stream does not have a 'uri'
  82. * Added a fix to LimitStream
  83. * Added a condition to ensure that functions.php can be required multiple times