Pull merge.
[yaffs-website] / vendor / zendframework / zend-stdlib / CHANGELOG.md
1 # Changelog
2
3 All notable changes to this project will be documented in this file, in reverse chronological order by release.
4
5 ## 3.2.1 - 2018-08-28
6
7 ### Added
8
9 - Nothing.
10
11 ### Changed
12
13 - Nothing.
14
15 ### Deprecated
16
17 - Nothing.
18
19 ### Removed
20
21 - Nothing.
22
23 ### Fixed
24
25 - [#92](https://github.com/zendframework/zend-stdlib/pull/92) fixes serialization of `SplPriorityQueue` by ensuring its `$serial`
26   property is also serialized.
27
28 - [#91](https://github.com/zendframework/zend-stdlib/pull/91) fixes behavior in the `ArrayObject` implementation that was not
29   compatible with PHP 7.3.
30
31 ## 3.2.0 - 2018-04-30
32
33 ### Added
34
35 - [#87](https://github.com/zendframework/zend-stdlib/pull/87) adds support for PHP 7.2.
36
37 ### Changed
38
39 - Nothing.
40
41 ### Deprecated
42
43 - Nothing.
44
45 ### Removed
46
47 - [#87](https://github.com/zendframework/zend-stdlib/pull/87) removes support for HHVM.
48
49 ### Fixed
50
51 - Nothing.
52
53 ## 3.1.1 - 2018-04-12
54
55 ### Added
56
57 - Nothing.
58
59 ### Changed
60
61 - [#67](https://github.com/zendframework/zend-stdlib/pull/67) changes the typehint of the `$content` property
62   of the `Message` class to indicate it is a string. All known implementations
63   already assumed this.
64
65 ### Deprecated
66
67 - Nothing.
68
69 ### Removed
70
71 - Nothing.
72
73 ### Fixed
74
75 - [#60](https://github.com/zendframework/zend-stdlib/pull/60) fixes an issue whereby calling `remove()` would
76   incorrectly re-calculate the maximum priority stored in the queue.
77
78 - [#60](https://github.com/zendframework/zend-stdlib/pull/60) fixes an infinite loop condition that can occur when
79   inserting an item at 0 priority.
80
81 ## 3.1.0 - 2016-09-13
82
83 ### Added
84
85 - [#63](https://github.com/zendframework/zend-stdlib/pull/63) adds a new
86   `Zend\Stdlib\ConsoleHelper` class, providing minimal support for writing
87   output to `STDOUT` and `STDERR`, with optional colorization, when the console
88   supports that feature.
89
90 ### Deprecated
91
92 - [#38](https://github.com/zendframework/zend-stdlib/pull/38) deprecates
93   `Zend\Stdlib\JsonSerializable`, as all supported version of PHP now support
94   it.
95
96 ### Removed
97
98 - Nothing.
99
100 ### Fixed
101
102 - Nothing.
103
104 ## 3.0.1 - 2016-04-12
105
106 ### Added
107
108 - Nothing.
109
110 ### Deprecated
111
112 - Nothing.
113
114 ### Removed
115
116 - Nothing.
117
118 ### Fixed
119
120 - [#59](https://github.com/zendframework/zend-stdlib/pull/59) fixes a notice
121   when defining the `Zend\Json\Json::GLOB_BRACE` constant on systems using
122   non-gcc glob implementations.
123
124 ## 3.0.0 - 2016-02-03
125
126 ### Added
127
128 - [#51](https://github.com/zendframework/zend-stdlib/pull/51) adds PHP 7 as a
129   supported PHP version.
130 - [#51](https://github.com/zendframework/zend-stdlib/pull/51) adds a migration
131   document from v2 to v3. Hint: if you use hydrators, you need to be using
132   zend-hydrator instead!
133 - [#51](https://github.com/zendframework/zend-stdlib/pull/51) adds automated
134   documentation builds to gh-pages.
135
136 ### Deprecated
137
138 - Nothing.
139
140 ### Removed
141
142 - [#33](https://github.com/zendframework/zend-stdlib/pull/33) - removed
143   deprecated classes
144   - *All Hydrator classes* see #22.
145   - `Zend\Stdlib\CallbackHandler` see #35
146 - [#37](https://github.com/zendframework/zend-stdlib/pull/37) - removed
147   deprecated classes and polyfills:
148   - `Zend\Stdlib\DateTime`; this had been deprecated since 2.5, and only
149     existed as a polyfill for the `createFromISO8601()` support, now standard
150     in all PHP versions we support.
151   - `Zend\Stdlib\Exception\InvalidCallbackException`, which was unused since #33.
152   - `Zend\Stdlib\Guard\GuardUtils`, which duplicated `Zend\Stdlib\Guard\AllGuardsTrait`
153     to allow usage with pre-PHP 5.4 versions.
154   - `src/compatibility/autoload.php`, which has been dprecated since 2.5.
155 - [#37](https://github.com/zendframework/zend-stdlib/pull/37) - removed
156   unneeded dependencies:
157   - zend-config (used only in testing ArrayUtils, and the test was redundant)
158   - zend-serializer (no longer used)
159 - [#51](https://github.com/zendframework/zend-stdlib/pull/51) removes the
160   documentation for hydrators, as those are part of the zend-hydrator
161   component.
162
163 ### Fixed
164
165 - Nothing.
166
167 ## 2.7.4 - 2015-10-15
168
169 ### Added
170
171 - Nothing.
172
173 ### Deprecated
174
175 - [#35](https://github.com/zendframework/zend-stdlib/pull/35) deprecates
176   `Zend\Stdlib\CallbackHandler`, as the one component that used it,
177   zend-eventmanager, will no longer depend on it starting in v3.
178
179 ### Removed
180
181 - Nothing.
182
183 ### Fixed
184
185 - Nothing.
186
187 ## 2.7.3 - 2015-09-24
188
189 ### Added
190
191 - Nothing.
192
193 ### Deprecated
194
195 - Nothing.
196
197 ### Removed
198
199 - Nothing.
200
201 ### Fixed
202
203 - [#27](https://github.com/zendframework/zend-stdlib/pull/27) fixes a race
204   condition in the `FastPriorityQueue::remove()` logic that occurs when removing
205   items iteratively from the same priority of a queue.
206
207 ## 2.7.2 - 2015-09-23
208
209 ### Added
210
211 - Nothing.
212
213 ### Deprecated
214
215 - Nothing.
216
217 ### Removed
218
219 - Nothing.
220
221 ### Fixed
222
223 - [#26](https://github.com/zendframework/zend-stdlib/pull/26) fixes a subtle
224   inheritance issue with deprecation in the hydrators, and updates the
225   `HydratorInterface` to also extend the zend-hydrator `HydratorInterface` to
226   ensure LSP is preserved.
227
228 ## 2.7.1 - 2015-09-22
229
230 ### Added
231
232 - Nothing.
233
234 ### Deprecated
235
236 - Nothing.
237
238 ### Removed
239
240 - Nothing.
241
242 ### Fixed
243
244 - [#24](https://github.com/zendframework/zend-stdlib/pull/24) fixes an import in
245   `FastPriorityQueue` to alias `SplPriorityQueue` in order to disambiguate with
246   the local override present in the component.
247
248 ## 2.7.0 - 2015-09-22
249
250 ### Added
251
252 - [#19](https://github.com/zendframework/zend-stdlib/pull/19) adds a new
253   `FastPriorityQueue` implementation. It follows the same signature as
254   `SplPriorityQueue`, but uses a performance-optimized algorithm:
255
256   - inserts are 2x faster than `SplPriorityQueue` and 3x faster than the
257     `Zend\Stdlib\PriorityQueue` implementation.
258   - extracts are 4x faster than `SplPriorityQueue` and 4-5x faster than the
259     `Zend\Stdlib\PriorityQueue` implementation.
260
261   The intention is to use this as a drop-in replacement in the
262   `zend-eventmanager` component to provide performance benefits.
263
264 ### Deprecated
265
266 - [#20](https://github.com/zendframework/zend-stdlib/pull/20) deprecates *all
267   hydrator* classes, in favor of the new [zend-hydrator](https://github.com/zendframework/zend-hydrator)
268   component. All classes were updated to extend their zend-hydrator equivalents,
269   and marked as `@deprecated`, indicating the equivalent class from the other
270   repository.
271
272   Users *should* immediately start changing their code to use the zend-hydrator
273   equivalents; in most cases, this can be as easy as removing the `Stdlib`
274   namespace from import statements or hydrator configuration. Hydrators will be
275   removed entirely from zend-stdlib in v3.0, and all future updates to hydrators
276   will occur in the zend-hydrator library.
277
278   Changes with backwards compatibility implications:
279
280   - Users implementing `Zend\Stdlib\Hydrator\HydratorAwareInterface` will need to
281     update their `setHydrator()` implementation to typehint on
282     `Zend\Hydrator\HydratorInterface`. This can be done by changing the import
283     statement for that interface as follows:
284
285     ```php
286     // Replace this:
287     use Zend\Stdlib\Hydrator\HydratorInterface;
288     // with this:
289     use Zend\Hydrator\HydratorInterface;
290     ```
291
292     If you are not using imports, change the typehint within the signature itself:
293
294     ```php
295     // Replace this:
296     public function setHydrator(\Zend\Stdlib\Hydrator\HydratorInterface $hydrator)
297     // with this:
298     public function setHydrator(\Zend\Hydrator\HydratorInterface $hydrator)
299     ```
300
301     If you are using `Zend\Stdlib\Hydrator\HydratorAwareTrait`, no changes are
302     necessary, unless you override that method.
303
304   - If you were catching hydrator-generated exceptions, these were previously in
305     the `Zend\Stdlib\Exception` namespace. You will need to update your code to
306     catch exceptions in the `Zend\Hydrator\Exception` namespace.
307
308   - Users who *do* migrate to zend-hydrator may end up in a situation where
309     their code will not work with existing libraries that are still type-hinting
310     on the zend-stdlib interfaces. We will be attempting to address that ASAP,
311     but the deprecation within zend-stdlib is necessary as a first step.
312
313     In the meantime, you can write hydrators targeting zend-stdlib still in
314     order to guarantee compatibility.
315
316 ### Removed
317
318 - Nothing.
319
320 ### Fixed
321
322 - Nothing.
323
324 ## 2.6.0 - 2015-07-21
325
326 ### Added
327
328 - [#13](https://github.com/zendframework/zend-stdlib/pull/13) adds
329   `Zend\Stdlib\Hydrator\Iterator`, which provides mechanisms for hydrating
330   objects when iterating a traversable. This allows creating generic collection
331   resultsets; the original idea was pulled from
332   [PhlyMongo](https://github.com/phly/PhlyMongo), where it was used to hydrate
333   collections retrieved from MongoDB.
334
335 ### Deprecated
336
337 - Nothing.
338
339 ### Removed
340
341 - Nothing.
342
343 ### Fixed
344
345 - Nothing.
346
347 ## 2.5.2 - 2015-07-21
348
349 ### Added
350
351 - Nothing.
352
353 ### Deprecated
354
355 - Nothing.
356
357 ### Removed
358
359 - Nothing.
360
361 ### Fixed
362
363 - [#9](https://github.com/zendframework/zend-stdlib/pull/9) fixes an issue with
364   count incrementation during insert in PriorityList, ensuring that incrementation only
365   occurs when the item inserted was not previously present in the list.
366
367 ## 2.4.4 - 2015-07-21
368
369 ### Added
370
371 - Nothing.
372
373 ### Deprecated
374
375 - Nothing.
376
377 ### Removed
378
379 - Nothing.
380
381 ### Fixed
382
383 - [#9](https://github.com/zendframework/zend-stdlib/pull/9) fixes an issue with
384   count incrementation during insert in PriorityList, ensuring that incrementation only
385   occurs when the item inserted was not previously present in the list.