Skip to content

Latest commit

 

History

History
89 lines (58 loc) · 3.5 KB

CHANGELOG.md

File metadata and controls

89 lines (58 loc) · 3.5 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

Changed

  • Small cleanup to markdown/docs.
  • Updated dependencies (refreshed composer lock file).

6.0.0 - 2024-05-06

Added

  • Storage\FlatfileStorage which is default, and currently only, available storage implementation.
  • Trait\FormatterTrait which will be used by storage implementations to handle formatting the count display.
  • Configuration\FlatfileConfiguration which is the default, and currently only, available Storage implementation configuration.
    • Used by Storage\FlatfileStorage
  • Interface\CounterInterface which defines methods that must be implemented in each storage implementation.
  • Interface\ConfigurationInterface which defines methods that must be implemented in each Storage implementation configuration.
  • symonfy/options-resolver dependency added to handle counter options.
  • scripts/convertFiles.php which can be used by those moving from version <5 of the library, to convert their *.txt counter/ips files to json.
  • Can now enable honorDnt within Configuration to honor a visitors Do Not Track setting.

Changed

  • Now licensed under the MIT license.
  • Complete rewrite from the ground up. Breaking changes, and not backwards compatible with prior versions.
  • The files used in the counter/logs/ directory are no longer plain *.txt files.
    • jSON is now being used to handle the log data.
  • New icons for the default image set (0-9 'png' images found in counter/images/).
  • Esi\SimpleCounter\Counter is now just a wrapper for one of the *Storage classes found in src/Storage/.
  • Unit tests completely rewritten.

Removed

  • Removed 0-9 .gif images in counter/images/. See above, replaced with new icons

TODO

  • Improve on the documentation.

5.0.1 - 2024-03-04

CHANGED

  • Updated Esi\Utility to 2.0.0

5.0.0 - 2024-01-11

NOTE: Not backwards compatible with prior SimpleCounter versions.

Added

  • Added checkLogFiles and checkDirectories as strictly helper functions, that check the log and image directories and log files on instantiation.
  • Added PHP-CS-Fixer and Rector as dev dependencies.
  • Added PHPStan for static analysis
  • Added PHPUnit for unit testing.
  • Implements #5 (#5)

Changed

  • Bumped PHP version requirement to 8.2
  • Restructured to be installable with composer
  • Esi\SimpleCounter\Counter completely refactored
    • User configurable options are no longer class constants.
      • They are now normal class vars with protected visibility
      • Must be set upon instantiation with getInstance($options). See README.md for more information.
  • Split readWriteFile into read and write.

Pre-5.0

  • Unfortunately, no changelog was kept prior to v5.0