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.
- New method Wireframe::createDirectories() for adding Wireframe directories in code.
- PHP 8.2 deprecation errors resulting from dynamic ViewData properties.
- PHP deprecation warning from passing null to basename().
- New PartialView class that extends TemplateFile core class.
- Fixed an issue where rendering page within page did not properly restore the $view API variable to the state it was in before rendering said page.
- Page::renderView() now accepts an array of options as second argument, behaving same as Page::render() when passed an array of options.
- Improve compatibility with RepeaterMatrix module by disabling unsupported render hook(s).
- Improve performance of some file operations by applying GLOB_NOSORT.
- Stash (and later restore) Wireframe class data array when a page is rendered within another page.
- Include Page object data array in cache key generated by Wireframe::render().
- Fixed an issue where Wireframe::page() wasn't handling "non-wired" Page objects properly, resulting in a notice.
- Use TracyDebugger::COLOR_NORMAL for Wireframe Tracy Debugger panel icon and help icon fill color.
- New method ComponentView::getComponent() for accessing the Component instance from within comnponent view.
- Fixed an issue where calling on() for component did not trigger emitted/queued events as intended.
- New method View::renderView() for rendering View with specific view file, without layout.
- New method Page::renderView() for rendering Page with specific view file, without layout.
- Malformed sprintf statement for exceptions thrown by View::setViewsPath().
- An issue where rendering pages with non-default view was unintentionally generating cached files if view had been set via Page::setView() or Page::view().
- Resources added to paths (in addition to urls) for convenience.
- New config setting global_config_paths for defining which Wireframe paths get automatically added to ProcessWire's $config->paths config object.
- Additional validation rule to prevent relative view namespace root paths.
- Support for view namespaces, initially implemented for partial files only. Namespaces are mapped via the view_namespaces config setting to directories within site path, after which files from said directories can be fetched with $partials->get('namespace::partial'), $partials->render('namespace::partial'), or Wireframe::partial('namespace::partial').
- Issue in Wireframe::partial() where dot was missing from before extension when using ProcessWire's native template extension.
- Second argument to Partials::get() wasn't applicable unless partial name had at least one slash; this has now been fixed.
- New method Partials::get('path/to/partial') for getting a partial with path. If an array is provided as second argument for this method, rendered markup is returned instead of a Partial object.
- New method Partials::render('path/to/partial', $args) for returning the rendered markup of a Partial object.
- Fixes and improvements to make it easier to use components (and other Wireframe features) outside the context of Wireframe rendered templates.
- Second fix for the issue with non-null falsy value handling in View. Fix introduced in 0.21.1 was not fully functional yet.
- Fixed an issue where non-null but falsy values passed as an arguments value to Wireframe::render() were replaced by null due to View::get() passing control over to View::getFromController().
- Hookable method MethodPropsTrait::getMethodPropCacheName(string $name, string $context). Note that when hooking into this method one should refer to the object that implements the trait, such as a specific Controller class.
- Include language ID in persistent cache name generated by MethodPropsTrait for cacheable methods.
- Fixed an issue where View arguments were accidentally overriding arguments provided for partials during rendering.
- Fixed an issue with Composer package, no code changes to the module.
- Support for short-circuiting Page rendering at Controller by returning a string from Controller::render().
- In case a Page was rendered more than once during a single request, there was a chance that it might've had a reference to a stashed Controller object.
- Fix an issue where rendering subsequent pages within a view placeholder wasn't working properly. This issue was caused by view placeholder optimizations introduced in 0.19.0.
- Various minor updates and additions to the Tracy Debugger panel GUI, Wireframe API, and Wireframe Hooks.
- New autoloaded (optional) companion module Wireframe Hooks.
- Wireframe API debugger for Tracy, currently only available for superusers.
- New method
Partial::getFilename(?string $ext = null, bool $with_ext = true). This is otherwise the same as type juggling a Partial object to string, but provides more customizability via params when called directly. - New methods
Partials::getPath()andPartials::getFilenames(string $ext = null, bool $with_ext = true).
- Wireframe API built-in endpoints now provide more verbose errors if debug mode is enabled or user is logged in as superuser.
- When rendering view placeholder, skip most of the Wireframe init process. This is an optimization, but also lets us access any values previously set for the View object etc.
- In some cases Wireframe API wasn't able to catch errors; this part should now work more consistently.
- Enabled endpoints setting in Wireframe API module config now works as expected.
- Fixed an issue where Wireframe Tracy panel displayed errors if opened on the Admin.
- PHP 8 requires __set() to either not declare a return type, or declare a void return type. This has been fixed.
- PHP 7.4 deprecated ReflectionType::__toString(), update MethodPropsTrait to use ReflectionNamedType::getName() instead. Also add support for PHP 8 ReflectionUnionType.
- Tracy panel for Wireframe.
- Fixed an issue where Config class path creation wasn't working properly due to missing Wireframe module instance.
- Controller objects have a new method called setPage(), used to set the page property of a specific Controller instance. Additionally this method accepts a boolean that (if set to true) propagates the change to the connected View object as well.
- Constructor of Controller class was simplified so that neither argument ($page or $view) is required. If one (or both) of these is left out (or provided with
nullvalue), corresponding property will fall back to API variable ($this->wire('page')or$this->wire('view')). - Controller base class "view" and "page" properties are now private. Accessing them directly behaves much like before, but is now routed via a setter method (
setPage()orsetView()). Setting the "page" property directly also updates the page property of the related View instance; this is a shortcut for$this->setPage($page, true). - If the page property of the View has been defined, it will override the $page API variable render-time. This behaviour is more consistent than before, where "global" $page was used in some situations, "local" (View) page property in others.
- Support for specifying view and view template at the same time with Page::setView('[view template name]/[view name]').
- Wireframe module now updates the internal settings hash more consistently. This hash is primarily used for runtime page render caching.
- Specify return type of Config::getPaths() as stdClass instead of object for PHP < 7.2.
- Fixed an issue where partial files were not rendered properly if a Renderer module was enabled.
- Internal stash for storing previous Page, View, and Controller instances in case a Page is rendered within another Page. This way earlier context can be restored once recursive rendering is done, and Wireframe can continue where it left off.
- New ComponentView class, as well as the ability for component views to access Component class public methods as properties, in the same way view files and layouts can access Controller class public methods.
- Hook related code moved from Wireframe module to separate Hooks class.
- Accessing public class methods as properties in view files was moved into a new trait called MethodPropsTrait. This trait is used internally by Controller and Component classes.
- Some minor improvements related to dependency injection within Wireframe objects (and ProcessWire objects instantiated by Wireframe.)
- An issue where null value passed to Component view or partial never reached the actual view file, resulting in undefined variable notices (and potentially other unexpected issues).
- Config class getPaths() method had wrong return type specified, rendering module config screen unusable.
- New hook makes View properties directly accessible in TemplateFiles (e.g. when rendering field templates)
- Wireframe::getController() is now a public method that can return current Controller instance, the Controller instance for provided page, or a Controller instance for provided Page and template name.
- Visibility of following methods was changed from public to protected: Wireframe::___checkRedirects(), Wireframe::___redirect(), Wireframe::___initView(), Wireframe::___initController(), \Wireframe\Config::getCreateDirectoriesField().
- Controller class implementation was streamlined: new objects are wired using the native wire() function, and thus Controller constructors no longer require the ProcessWire instance as an argument.
- Wireframe no longer caches partials unnecessarily, plus new Partial objects are automatically wired.
- Various minor optimizations, some code cleanup, and a few improvements to comments.
- Support for named arguments when using
Wireframe::component($component_name, $args). - JSON API. See comments in the WireframeAPI module file for more details.
- New Page methods Page::getController() and Page::setController().
- Module config screen provides support for creating directories corresponding to configured Wireframe URLs, assuming that they were provided as relative paths.
- Wireframe::setView() accepts optional view name as an argument.
- View::setController() accepts Controller name (string) in addition to Controller class instance or null.
- When Controller is instantiated, it no longer overrides the Controller property of the related View instance.
- Wireframe::partial() now works as expected for partial names with file ext included (partial_name.php etc.)
- Wireframe::partial() prevents 2 or more dots in partial name, just in case (directory traversal is not intended).
- Partials class now detects if a missing partial is being requested and throws an exception.
- When rendering a partial with arguments, prepare the arguments array properly before use.
- Autoload Factory class in cases where it's methods are called before Wireframe has been initiated.
- New class Partials. Container for Partial objects. Provides a gateway for rendering partials with arguments (
$partials->name(['arg' => 'val'])). - New class Partial. Singular Partial object. Provides the ability to render a partial and adds support for multiple (alternate) file extensions for each partial.
- New class Factory. This class encapsulates various static factory methods and is accessed through the Wireframe class.
- New static method Wireframe::partial($partial_name, $args). This method provides a shortcut for rendering partial files.
- New method Wireframe::setViewTemplate(). This allows overriding current view template via the Wireframe object, primarily intended to be used in the Wireframe bootstrap file.
- Shared renderer related features were moved to new trait RendererTrait. This is used internally by View, Component, and Partial classes.
- An issue where rendering a Page that didn't have an existing template file or altFilename via Wireframe::page() could result in ProcessWire error message.
- New EventListenerTrait. Currently used by Components only. Adds support for listening to and emitting events.
- Support for Renderer modules for adding templating engine support for view files, component view files, etc.
- New Page methods Page::viewTemplate(), Page::getViewTemplate(), and Page::setViewTemplate().
- New method Component::getData() for manually defining the data passed to the component view.
- Controller::init() and Controller::ready() are now hookable methods.
- Component::setView() and Component::getView() are now final methods, preventing accidental overrides.
- Layout file is no longer necessary; if it's missing, the page can be rendered using just a view file.
- Support for Components, along with a new static factory method Wireframe::component($component_name, $args).
- Support for rendering pages that have not been "routed" to Wireframe using the altFilename template setting.
- New static getter/factory/utility method Wireframe::page($source, $args).
- New static utility method Wireframe::isInitialized().
- Wireframe::$initialized is now a static property. This was a necessary change so that Wireframe::isInitialized() could be implemented effectively.
- Runtime caching support for Controller method return values. Values are cached unless the name of the method is found from Controller::$uncacheable_methods.
- Persistent caching support for Controller method return values. Values are cached only when found from the Controller::$cacheable_methods array.
- In the View class all internal requests for Controller properties are routed through View::getFromController().
- New Page methods Page::getLayout(), Page::setLayout(), Page::getView(), and Page::setView().
- New Controller::render() method, executed right before a page is actually rendered.
- New ViewData class for storing (internal) data required by the View class.
- New getter/setter methods for ViewData properties for the View class.
- New method Wireframe::getConfig() for getting current config settings.
- New method ViewPlaceholders::has() for checking if a placeholder has already been populated.
- Various View-related features moved from Wireframe module and ViewPlaceholders class to the View class.
- Removed access to local get* and set* methods via the PHP's magic setter method __set() and getter method __get() in the View class.
- Redirect feature no longer fails if provided with a WireArray data type; in these cases the first item is used as the redirect target.
- Improvements to PHPDoc comments.
- An issue with Config class where the "all directories exist" message was sometimes displayed unintentionally.
- An issue where View Placeholder values might've been overwritten because existence of earlier value was checked inproperly.
- An issue where empty / null view file would be automatically replaced with value "default".
- ViewPlaceholders is provided with a reference to the View object in order to keep template name in sync.
- ViewPlaceholders no longer tracks template name separately, and the constructor method no longer accepts template name as an optional param.
- Comments, property visibilities, and some parameter names in the ViewPlaceholders class updated to match the rest of the codebase.
- Fix an issue where the redirect feature wasn't working properly when using a Page Reference field.
- New internal features for caching and optimizing render times.
- Perform certain initialization tasks only once (attach hooks, configure autoloader, etc.)
- Fix an issue where another page couldn't be rendered with provided view/layout combination.
- Wireframe\Lib namespace was added to ProcessWire's class autoloader.
- New Wireframe Config class was added and Wireframe was made configurable.
- Support for automatically creating Wireframe directories via module config screen in case ProcessWire has necessary write access.
- Some refactoring, including changes to method names and return values, for better readability and more consistent API.
- In Wireframe::init() paths and ext are now set by separate methods, not directly in the init() method itself.
- Bumped required version of wireframe-framework/processwire-composer-installer to 1.0.
- Bulk of the documentation removed from the README file and moved to wireframe-framework.com.
- The "view" directory was removed and its contents were moved directly under the templates directory.
- The templates directory was added to the include path, and view directory removed.
- Renamed the module, along with its namespaces, from wireframe to Wireframe.
- Renamed "view scripts" to "views", while also using the term "view files" where appropriate.
- Corrected site profile URLs in the install instructions in the README file.
- Improvements and corrections to PHPDoc DocBlocks.
- Updated the required version of wireframe-framework/processwire-composer-installer.
- Added $config->urls->dist, by default pointing to /site/assets/dist/.
- Renamed default resources (assets) directory from "static" to "resources".
- Changed recommended image resources directory name from "img" to "images".
- Switched Composer installer from hari/pw-module to wireframe-framework/processwire-composer-installer.
- Added .htaccess to protect markdown files from direct access.
- Improvements to code comments and some minor refactoring.
- Fixed a minor issue in Controller base class where the _wire property wasn't being set properly.
- Added composer.json.
- Fixed invalid JSON syntax in module info file.
- Added CHANGELOG.md.