Skip to content

Latest commit

 

History

History
156 lines (123 loc) · 12.3 KB

CHANGELOG.md

File metadata and controls

156 lines (123 loc) · 12.3 KB
Raw

#Hydrogen ####PHP 5.3+ Performance and Compatibility Library ####HydrogenPHP.com

ChangeLog

v0.3.1

  • Hydrogen

    • The hardcoded namespace has been removed from the autoloader, so that Hydrogen's autoloader may be more easily adapted for use in other projects. See the new Hydrogen MVC Starter sample application on GitHub for the best example of how to set up a new Hydrogen MVC project with this loader.
    • Created a new constant, allowing the location of the hydrogen.autoconfig.php file to be defined by the programmer. This is especially useful for projects on Git that link to Hydrogen as a submodule. By setting "HYDROGEN_AUTOCONFIG_PATH" to the absolute path of the autoconfig file, that file can be pulled out the main hydrogen folder, allowing it to be checked in.

  • View

    • Fixed a 'Cannot pass by reference' bug that would be triggered in certain scenarios when accessing a variable from a template in the Hydrogen templating engine.
    • Fixed a bug causing view variables to not be set in the context if they were passed in using View::load without having called View::setVar at all beforehand.
    • Changed TraversalWrapper to accommodate a bug in PHP 5.3.0-5.3.2 that caused arrays to be cast as objects when accessed objectively. This is a fix for the "Line 148 in TraversalWrapper.php" error for people using a version of PHP in that range.
    • Added the '%' symbol to the legal URL characters for the 'urlize' filter.

v0.3.0

  • Hydrogen

    • The autoloader has been rewritten to be many, many times faster. Also, when you use a class in the \hydrogen namespace that doesn't actually exist, the error will come from the file that actually contains the nonexistant class name instead of from hydrogen.inc.php.
    • Important changes to the autoconfig file to support new Config library features. Current Hydrogen users will need to update their autoconfigs to use the new sample template. Many of these changes regard the addition of the View templating engines.
    • Completely rewrote the View library. See the "View" section below for all the details.

  • Common

    • Added the TypedValue class, a simple class to contain both a value and some open-ended "type" variable to identify it. Using an instance of TypedValue as a string will use the string representation of the stored value, and TypedValue also supports cloning.

  • Config

    • Config::getVal() now returns NULL instead of false when a value is not found. As PHP evaluates NULL to a false value, it's unlikely this will require any code changes unless the type-specific operator === is used.

  • SQLBeans

    • Added the 'isset' magic method to supplement 'get' and 'set'.

  • View

    • View has been completely rewritten from the ground up to use templating engines. Its API remains exactly the same, however, so no view-calling code should need to change.
    • The old-style pure PHP views still exist; simply specify the 'purephp' engine in the new autoconfig file. Absolutely no changes will be required in your existing views under the purephp engine.
    • The Hydrogen Templating Engine has been added. This is an extremely robust templating engine that's similar to other languages such as Django, Smarty, Twig, and others that you may be already used to. It compiles to a flat, objectless PHP file that executes just as quickly as if you'd have written it yourself. There's plenty of in-code documentation for this, but please consider reviewing the guides Hydrogen Templates for Front-End Developers and Hydrogen Templates for Back-End Developers.
    • Views now execute within a ViewSandbox object, exposing an API specific to executing templates. This API is the same as what the old PHP views have always used.
    • The concepts of a ContextStack and TraversalWrapper have been added to the view layer for managing variables and scope. Much of this is handled transparently in the background, but these classes have plenty of documentation in the PHP files for anyone interested in digging in deeper.
    • Loaders have been added, which are responsible for loading the contents of a template given their name. The only current loader is FileLoader, which loads templates from the filesystem. Others can be written to pull templates from a database, a remote storage location, or anywhere else a template could be stored.

v0.2.5

  • Hydrogen

    • Added 'common' library to store classes used across multiple Hydrogen libraries.
    • Important changes to the autoconfig file to support new Config library features. Current Hydrogen users will need to update their autoconfigs to use the new sample template.

  • Common

    • Created abstract class "MagicCacheable" making it easy to implement and hook Hydrogen's Magic Cache pattern across other classes. Detailed documentation included.
    • Added NoSuchMethodException for use with MagicCacheable.
    • Added InvalidPathException, used by both Config and Log.

  • Config

    • Changed ALL SAMPLE CONFIG FILES with completely new structure. Current Hydrogen users MUST update their config files to be compatible with the new formats.
    • Rewrote config loader to support the new config file templates, allowing the use of multiple config files, cacheing with file-based semaphores instead of config file-controlled semaphores, and support for caching multiple like-named config files.
    • New Config library API to support cache path/base path getters and setters, addConfig instead of loadConfig (now possible to load additional configurations without replacing what was already loaded), replaceConfig (for when you do want to replace), and addConfigArray (for adding raw, already-processed config values)
    • New format for cached config files. For people upgrading, Config will detect when an old cached config is present and update it with the new format automatically. No code changes necessary.
    • InvalidPathException is now in the 'common' namespace.

  • Controller

    • Rewritten to extend the new MagicCacheable class.
    • Controller now caches both the function output and its return value. This is helpful for controllers that call cached versions of other controllers.

  • Database

    • Verb and method arrays in Query have been moved to the protected scope
    • Bugfix: Changed reference to PDO::execute() to PDO::exec() in PDOEngine.
    • Bugfix: InvalidSQLException had a typo and would generate an error instead of properly throwing the exception (Issue #2). Resolved.

  • ErrorHandler

    • Bugfix: ErrorHandler was never updated to use the new getVal/getRequiredVal Config API changes, and as a result, would not log errors even when error logging was turned on. Resolved.

  • Log

    • Bugfix: InvalidPathException reference was invalid. Log now throws the InvalidPathException added to the new Common namespace.

  • Model

    • Rewritten to extend the new MagicCacheable class.

v0.2.0

  • Hydrogen

    • Drastically changed the autoconfig file. See comments for new instructions on this file.
    • Added a function in the hydrogen namespace to load specific PHP files outside of a class context.
    • Paths have changed significantly. The new basePath variable is the root from which all relative paths should be resolved -- including the cache folder path in the autoconfig.

  • Cache

    • Added MemcachedEngine, using the libmemcached-powered Memcached PHP extension.
      • Supports connection pooling. Setting the config value [cache]->pool_name enables this feature.
      • Note that, at the time of this writing, the Memcached extension has a bug preventing pooling to be used if libmemcached > 0.38 is installed. If this is the case, simply disable pooling.
    • Fixed errors in MemcacheEngine.
      • Some versions of the Memcache extension did not properly delete keys. The fixed engine resolves this issue.
      • set() now uses the actual set() function in the engine. This was an add/replace scheme in the past due to a Memcache extension bug that no longer poses an issue.

  • Config

    • Added a function to resolve relative paths in reference to the base path.
    • Added a function to detect whether or not a path is relative.
    • Split getVal into two functions:
      • getVal() will get the requested value and return false if it does not exist.
      • getRequiredVal() will get the requested value and throw an exception if it does not exist.
    • Added an argument to both getVal and getRequiredVal, allowing a subkey to be specified. Any given key may now be changed to an array or associative array, and the proper index can be retrieved with this subkey argument. See hydrogen/config/samples/config_multidb_sample.ini.php for illustration.

  • Controller

    • Added initial version of the new library.
    • Controller class added. See hydrogen/controller/Controller.php for documentation.
    • Dispatcher class added. See hydrogen/controller/Dispatcher.php for documentation.

  • Database

    • Significant changes to DatabaseEngineFactory to support multiple databases.
      • getCustomEngine() is now used to build a custom engine on the fly.
      • getEngine() is used to build an engine from values specified in Config.
      • getEngine() may be passed a variable to specify which database configuration to pull from Config.
    • DatabaseEngine now contains the table prefix setting, so each database connection, whether configured or made custom on-the-fly, may have an attached table prefix. A function has been added to return this prefix for a particular engine.
    • Multiple databases may now be defined with a subkey. See hydrogen/config/samples/config_multidb_sample.ini.php for illustration. If using a single database, no config change is necessary.

  • ErrorHandler

    • Added a function to send a specific error code header.

  • Log

    • TextFileEngine's path in the config file is now relative to the base path in Hydrogen's autoconfig file.

  • Model

    • Database dependency has been removed. This assists in the new multi-database support, as well as encourages better model design.
    • Fixed bug causing the default cache time of 300 not to be used if not explicitly specified.

  • SQLBeans

    • Fixed bug causing the update() method to not always use the appropriate database connection when multiple databases are in use.

  • View

    • New library added! See hydrogen/view/View.php for documentation. This can be used completely independently of the new Controller class, or a different view/template library can be used in place.

v0.1.2

  • Hydrogen

    • Hydrogen now has an official license file! See "LICENSE" for details. It's now fully legal and free to use in most projects, and much more legit. I retain the right to change this license in future releases.
    • The readme is now somewhat useful ;-).

  • Config

    • Added Config::getConfigPath() method to get the last config file path passed to Config::loadConfig().

  • Database

    • Fixed strict parsing error in try/catch blocks of PDOEngine.

  • ErrorHandler

    • Corrected spelling of ErrorHandler::detatch() and ErrorHandler::detatchAll() methods. They are not ErrorHandler::detach() and ErrorHandler::detachAll(), respectively.
    • Corrected logic error causing ErrorHandler::detach() not to detach properly when there was only one attached handler.

  • Log

    • TextFileEngine
      • Now compatible with Windows! Windows users can now make full use of Hydrogen's Log library.
      • When a relative path is given for the logfile in the Hydrogen config file, it is treated as relative from the location of the config file as long as an absolute path is given for the config file in hydrogen.autoload.php.
      • If a relative logfile path is used in the config file AND the config file path is relative in hydrogen.autoload.php, a hydrogen\log\exceptions\InvalidPathException will be thrown.
      • If the logfile can't be written to/isn't found/etc., the engine will throw an InvalidPathException instead of returning false.
      • This engine no longer sets a default timezone. If an upgrade triggers a timezone error in PHP, be sure to set your timezone in your php.ini file.

  • Semaphore

    • Fixed "NoEngine" so that it could be used without error.
    • Allowed "engine" config option to be left blank, defaulting to "No"

v0.1.0

  • Released in Alpha