-
Notifications
You must be signed in to change notification settings - Fork 0
2.0 Notes
This document outlines and explores the process of rewriting the A-Z Filters Extension that uses the new 2.x context, API, etc.
The first thing we usually encounter in an extension is the use of the GravityView_Plugin class. This class has been marked as deprecated and should not be used. The \GV\Plugin class (also accessible via a magic call to gravityview()->plugin) has taken its place.
GravityView_Plugin::include_widget_class has been deprectaed. All widgets are loaded in the GravityView core.
Supporting older 1.x methods should be outside of the scope of extensions. Developers should not try to be compatible with 3 older ways of doing things. 2.x+ will guarantee that the needed environment is loaded. This will ensure we can move forward fast, with clean, understandable and maintainable code, giving up back-compatibilty in the long run.
Commit 031f075 gets rid of all calls to GravityView_Plugin, removes the unnecessary include calls, removes the bundled libraries (these are part of core 2.x).
This class has been refactored and moved to \GV\Extension. The child class is moved to its own file, this prevents PHP 5.2 users from mucking up their sites with a WSOD or a fatal error. A syntactically compatible loader is put in place of the old file.
This class has also been moved to \GV\Widget. It has retained all its methods as is as far as the programming interface goes.
All deprecated methods and function calls moved to their newer counterparts as needed. Like \GravityView_Admin::is_admin_page() moved to gravityview()->request->is_admin().
The extension is namespaced under \GV so all calls to the old core have to prefixed with the global namespace \.
Logging has been moved to gravityview()->log, a PSR-3 interface.
It is very important to prevent adding hooks and filters on the same widgets several times. $this->is_registered() should be used. However, it also important to set the $widget_id value before attempting to use is_registered(). An error is logged if done otherwise. If you find yourself seeing double, triple widgets being output, this is where things went a big wrong.
The gravityview_fe_search_criteria supports 2 additional parameters that are hardly used throughout legacy core, extensions - the form_id and the args which contain the View settings the criteria are being filtered for.
It is now very important to not rely on a global context and use the third parameter to grab the \GV\View and use it as needed (if needed).
The A-Z Widget filter_entries method used the global $gravityview_view object. Bad. The View should be retrieved from the third parameter instead.
This method callback also often depends on this mythical global context. In 2.0 the context should be expected as part of the callback arguments instead. The third $context is the GV\Template_Context instance which contains access to the View, Request and all other objects related to the place this widget is being output. This context object is passed around all the utility methods (including render_alphabet_letters) making them independent of the global-state.