Skip to content

Latest commit

 

History

History
251 lines (198 loc) · 12.6 KB

CHANGELOG.md

File metadata and controls

251 lines (198 loc) · 12.6 KB

Change Log

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.

[3.7] - In Development

✨ Added

  • Casting support for update_values of a model, similar to laravel's casts, e.g.: uploaded_at:date. Supports bool, int, float, date, string, trim (a trimmed string), none (to prevent from casting empty values to NULL)
  • Queue daemon which can run the queue reliably twice each minute, similar to the cron daemon
  • New method to generate a random filename with 25 characters: C::Storage()->getRandomFilename()

🔧 Changed

  • Redis usage in the whole system is now optional, works fine without redis at all [#40]
  • The environment config file app/app.env is now a proper ini-file. Kept legacy support but preferred syntax is now e.g. ENVIRONMENT=Prod.

[3.6] - 12 December 2024

✨ Added

  • Garbage collector config options, improve default garbage collection in session module
  • Facade classes for modules: Config, DB (eloquent connection, similar to laravel's DB facade), Log, Request, Router, Session
  • New methods to delete a directory and its content: C::Storage()->deleteDirectory($dir) and C::Storage()->deleteFilesInDirectory($dir)
  • Model methods: beforeDelete() + afterDelete(), simplified cache handling on save / on delete
  • Set multiple request values at once via array (for C::Request()->set([]) and C::Request()->setMultiple([]))
  • Charm\Storage\File class for file related methods, added SHA256 + MD5 checksum methods
  • Support for multiple loggers, including logging to file, redis, syslog, process, errorlog

🔧 Changed

  • Improve performance and code structure of C::Storage()->scanDir() and the filtered scanDirFor...() methods
  • Update composer packages

🐞 Fixed

  • Fix URL construction in Router module for URLs with ports + fragments

[3.5] - 18 August 2024

✨ Added

  • Model filtering via filterBasedOnRequest() and getFilteredPaginatedData() can now be customized with a custom callback which allows adjusting the QueryBuilder
  • Run cron jobs via a dedicated daemon: bob cron:daemon start/stop/info, works beautifully with a systemd service
  • Uploaded files can now directly be transformed into an Image object for easy image manipulation / conversion
  • Add base64 support for fetching multiple files in a single upload (array of base64 strings)
  • Create and validate a CSRF token in a session via C::Session()->generateCsrfToken()
  • A string can now easily be escaped via C::Formatter()->escape($str)
  • New module C::Header() for easy handling of request / response headers with handy methods to set the most common headers directly, including CORS and security related headers
  • Login throttling via C::Guard()->throttleLogin(), check if a client is blocked via C::Guard()->isBlocked()
  • Logging of the stack trace when an exception happens during a cron job

🔧 Changed

  • Replace symfony/process with exec for better detachment of cron jobs in background
  • Move dev packages (debugbar, kint, phpunit, whoops) to require-dev, made their usage optional in the framework
  • Failed login attempts are stored more intelligently and expired failed logins are removed automatically

🐞 Fixed

  • A bug when a view is rendered via CLI where the Session module is not available

🔥 Removed

  • Polyfill for apache_request_headers() since we now have an own module C::Header()

[3.4] - 20 April 2024

✨ Added

  • New console command cron:info which shows all cron jobs and allows the creation of systemd service + timer files
  • New console command sys:info which displays some basic information of the app
  • Caching to Model's getFilteredPaginatedData()
  • Caching to Json outputs via Json::makeWithCache(...), can automatically append a unique hash based on the request
  • New CLI command method $this->io->writelnVerbose($message) to output a message only if output verbosity is verbose
  • CLI command helper constants for verbose output, input option and input arguments

🔧 Changed

  • The formatted duration of a Performance Metric only returns the seconds if duration is below 1 minute
  • The module installer is now called via bob c:mod and is prepared to install and uninstall modules (still WIP!)
  • When using C::Cache()->remember(...) you can now also specify optional tags to apply to the saved entry
  • Creating a Token via C::Token()->createToken($length) is now improved and returns a better string utilizing the whole alphabet instead of base64, also adding C::Token()->generateSecureToken($length) for simple token string generation

[3.3] - 14 March 2024

✨ Added

  • UserModel class which is the new base model for the app's User model.
  • Types, refactoring and default values for EngineManager
  • C::Arrays()->array_merge_recursive(...) now allows any data type as input arrays and will cast them into arrays.
  • When creating a View output object you can now access the twig environment to modify it as you like.
  • Model properties can now be filtered as array_like, so you can provide multiple values which all must be contained in the property.
  • When getting the current user via C::Guard()->getUser(true) you can now set a bool parameter to decide if the user data should be fetched from the cache (true, default) or from the database via a query (false).

🔧 Changed

  • Maintenance mode commands are now c:up and c:down to harmonize the namespace of charm's own CLI commands
  • Merge charm creator CLI commands into a single c:new, only c:env stays the same
  • C::Arrays()->get(...) and C::Arrays()->has(...) now take any type as an array input and will cast it into an array.
  • Add total runtime metric method and refine time measurement. You can easily get the Metric object of the total runtime via C::Performance()->getTotalRuntimeMetric() and easily adjust the start and end time of Metric objects.
  • When an error occurs while outputting the error exception will be thrown instead of a generic one. This gives you the correct stack trace for debugging, if exception throwing is enabled.
  • The CLI's $this->io CommandHelper class now has own setters for input and output objects and can be created without any of them.

🐞 Fixed

  • The database migrator command bob db:sync now displays the stats correctly.
  • Command's $this->io->choice(...) worke fine again.
  • Performance tracking of CLI commands

🔥 Removed

  • Dropped support for FTP filesystems (SFTP is preferred if needed at all).
  • Removed kint-twig package to remove unnecessary overhead, if needed it can be added and linked manually.

[3.2] - 1 March 2024

Added

  • Handy ViewExtension default functions
  • C::Router()->constructUrl(...) method to create custom URLs with parameters
  • Module specific config files can be overridden by the same config in the App (and its environment config file)
  • Add custom config values via C::Config()->set(...) which are stored in the AppStorage for runtime only (but can also be stored in AppStorage cache depending on user's app)
  • Model's filterBasedOnRequest() can now also filter fields with custom callback, check for isnull / notnull
  • C::Formatter()->removeTrailingZeros(...) method which removes trailing zeros and dots
  • When using the Smtp driver in Mailman you can now directly access the PHPMailer instance and the mime message as well
  • C::Formatter()->sanitizeUrl(...) method now easily allows to sanitize a URL.
  • C::Arrays()->from($array) method which creates a CArray collection from the specified array
  • C::Http()->... for easy access to APIs. Simply make requests and work with responses. Built upon the awesome GuzzleHttp library.
  • C::Validator()->... module for easy validation of strings and access to versatile validations based on the awesome Respect-Validation package.
  • DataExporter can now export to XLSX, ODS, CSV and HTML and is working with the latest PHPSpreadsheet version
  • C::Request()->isSameOrigin() method which returns bool based on HTTP_ORIGIN and app's base URL
  • Maintenance mode including middleware and output handling. Use the CLI commands cc:down and cc:up to turn the mode on / off or create file var/maintenance.lock manually.
  • Cron job to remove log files older than main:logging.keep_days days. Same for debugbar cache files after main:debug.log_keep_days days.
  • Cron jobs can now be organized in subdirectories inside app/Jobs/Cron and will be loaded recursively.
  • C::Session()->saveAndClose() to easily write and end the session, so you can prevent session blocking
  • C::Http()->withGenericUserAgent()->get(...) easily allows to make requests using a generic common user agent
  • C::Performance()->... module to easily access key metrics of the app and to create custom measurements.
  • More methods to C::Server()->... to get different parts of uname data of the server.

Changed

  • Improved security of DebugBar
  • C::Formatter()->translate(...) now returns mixed data, including arrays
  • C::Router()->getCurrentUrl($with_query_params) now has an optional parameter to decide if you want the current URL with or without the query parameters
  • Refactoring of the Arrays module, including strict types and utilizing CArray
  • Crown module now has strict type and return codes for run method (breaking changes, please adjust your cron jobs!)
  • Crown module now smoothly supports multiple jobs each run which run in own threads in parallel
  • For main framework access we now use the magic magnet Charm\Vivid\C as the default class instead of the alternative class Charm\Vivid\Charm, which can be used as well, depending on the dev's preferences
  • Moved the ProgressBar class to the Bob module
  • Improved and extended the available CommandHelper methods
  • EventListener fire methods can now have a parameter passed to when the event is fired
  • Console commands have a new structure, now simplifying the general structure. Easy access of input and output is possible via $this->io->....

Fixed

  • Small bug fixes due to wrong return types
  • Errors due to sequential cron job handling which led to some cron jobs which didn't run when the previous one took too long. They are now running in their own threads in parallel.
  • Image handling via the Image class is working again, improved thumbnail generation

Migrating

  • Replace $this->user in your controllers with C::Guard()->getUser()
  • Replace $this->user->id in your controllers with C::Guard()->getUserId()
  • Replace $this->request in your controllers with C::Request()
  • Check method signatures of all event listeners, especially: public function fire(mixed $args = null): bool {...}
  • To be future-proof, update your console commands to extend the new class Charm\Bob\Command and adjust the methods
  • Check that your cron jobs return bool and are compatible with the new return types

[3.1] - 1 April 2023

Added

  • CommandHelper class with handy commands to easily style input / output of console commands

Changed

  • ViewExtensions are now a lot easier to create and have a common base class

Fixed

  • Choice display in charm creator
  • Funding comment which made problems with packagist

[3.0] - 27 March 2023

Added

  • CharmCreator commands and handling
  • Way more documentation
  • Suiting, modern charm-wireframe
  • Support for global bob command

Changed

  • Structure of many modules have been changed

[2.0]

Added

  • Get all available cron jobs via C::Crown()->getAllCronJobs()
  • Summary of database migrations as console output
  • Console commands can now also be in subdirectories of app/Jobs/Console

Changed

  • Moved console jobs to according module
  • Moved database migration to own DatabaseMigrator class
  • Moved database code to own module outside the Kernel

Removed

  • Deprecated view Methods (ViewExtension)
    • buildUrl() (use getUrl() instead)
    • formatMoney() (use formatNumber() instead)
    • str_replace() (use twig's built-in |replace() filter instead)
  • Deprecated methods
    • C::Formatter()->formatMoney() (use C::Formatter()->formatNumber() instead)
    • C::Router()->buildUrl() (use C::Router()->getUrl() instead)
    • C::Database()->getRedisClient() (use C::Redis()->getClient() instead)
  • Deprecated PathFinder class
  • Dependency on DbDumper, we will create a native one via mysqldump soon
  • Deprecated in_string() function, use built-in str_contains() instead

[1.0]

Added

  • First public initial commit of base system