2021-03-03 18:58:03 +00:00
< ? php // phpcs:disable WordPress.Files.FileName.InvalidClassFileName
2021-03-02 03:09:34 +00:00
/**
* Includes the main Class of the Plugin .
*
* @ filesource
2021-03-03 18:58:03 +00:00
* @ package footnotes
* @ since 1.5 . 0
* @ date 12.09 . 14 10 : 56
2021-03-02 03:09:34 +00:00
*
* @ since 1.6 . 5 Bugfix : Improve widgets registration , thanks to @ felipelavinz code contribution .
* @ since 1.6 . 5 Update : Fix for deprecated PHP function create_function (), thanks to @ psykonevro @ daliasued bug reports , thanks to @ felipelavinz code contribution .
* @ since 2.0 . 0 Update : Tooltips : fix disabling bug by loading jQuery UI library , thanks to @ rajinderverma @ ericcorbett2 @ honlapdavid @ mmallett bug reports , thanks to @ vonpiernik code contribution .
*
* @ since 2.0 . 3 add versioning of public . css for cache busting 2020 - 10 - 29 T1413 + 0100
* @ since 2.0 . 4 add jQuery UI from WordPress 2020 - 11 - 01 T1902 + 0100
* @ since 2.1 . 4 automate passing version number for cache busting 2020 - 11 - 30 T0646 + 0100
* @ since 2.1 . 4 optionally enqueue an extra stylesheet 2020 - 12 - 04 T2231 + 0100
*
* @ since 2.5 . 5 Update : Stylesheets : increase speed and energy efficiency by tailoring stylesheets to the needs of the instance , thanks to @ docteurfitness design contribution .
* @ since 2.5 . 5 Bugfix : Stylesheets : minify to shrink the carbon footprint , increase speed and implement best practice , thanks to @ docteurfitness issue report .
* @ since 2.5 . 5 Bugfix : Libraries : optimize processes by loading external and internal scripts only if needed , thanks to @ docteurfitness issue report .
* @ since 2.5 . 6 Bugfix : Reference container : optional alternative expanding and collapsing without jQuery for use with hard links , thanks to @ hopper87it @ pkverma99 issue reports .
*/
/**
* Entry point of the Plugin . Loads the Dashboard and executes the Task .
*
* @ since 1.5 . 0
*/
class MCI_Footnotes {
/**
* Reference to the Plugin Task object .
*
* @ since 1.5 . 0
* @ var null | MCI_Footnotes_Task
*/
2021-03-03 18:58:03 +00:00
public $a_obj_task = null ;
2021-03-02 03:09:34 +00:00
/**
2021-03-03 18:58:03 +00:00
* Idenfifies whether tooltips are enabled . Actual value depends on settings .
2021-03-02 03:09:34 +00:00
*
2021-03-03 18:58:03 +00:00
* @ contributor Patrizia Lutz @ misfist
* @ var bool
2021-03-03 15:15:55 +00:00
*
2021-03-03 18:58:03 +00:00
* @ todo Refactor to have defines and assignments only in this class ,
* then re - use these properties also in class / task . php ( and elsewhere ) .
* Account for priority level issues . These properties must be assigned before
* the hooks—whose priority level may be configured to 0 —are called in class / task . php .
*/
public static $a_bool_tooltips_enabled = false ;
/**
* Idenfifies whether alternative tooltips are enabled . Actual value depends
* on settings .
2021-03-02 03:09:34 +00:00
*
2021-03-03 18:58:03 +00:00
* @ contributor Patrizia Lutz @ misfist
2021-03-02 03:09:34 +00:00
* @ var bool
*
2021-03-03 18:58:03 +00:00
* @ todo Refactor to have defines only here , and use assignments also in class / task . php .
2021-03-02 03:09:34 +00:00
*/
2021-03-03 18:58:03 +00:00
public static $a_bool_alternative_tooltips_enabled = false ;
2021-03-02 03:09:34 +00:00
/**
* Executes the Plugin .
*
* @ since 1.5 . 0
*
* - Bugfix : Improve widgets registration , thanks to @ felipelavinz code contribution .
*
* @ since 1.6 . 5
*
* @ contributor @ felipelavinz
2021-03-03 18:58:03 +00:00
* @ link https :// github . com / benleyjyc / footnotes / commit / 87173 d2980c7ff90e12ffee94ca7153e11163793
* @ date 2020 - 02 - 25
2021-03-02 03:09:34 +00:00
* @ link https :// github . com / media - competence - institute / footnotes / commit / 87173 d2980c7ff90e12ffee94ca7153e11163793
*
2021-03-03 18:58:03 +00:00
* @ see self :: initialize_widgets ()
2021-03-02 03:09:34 +00:00
*/
public function run () {
2021-03-03 18:58:03 +00:00
// Register language.
MCI_Footnotes_Language :: register_hooks ();
// Register Button hooks.
MCI_Footnotes_WYSIWYG :: register_hooks ();
// Register general hooks.
MCI_Footnotes_Hooks :: register_hooks ();
2021-03-02 03:09:34 +00:00
2021-03-03 18:58:03 +00:00
// Initialize the Plugin Dashboard.
$this -> initialize_dashboard ();
// Initialize the Plugin Task.
$this -> initialize_task ();
2021-03-02 03:09:34 +00:00
2021-03-03 18:58:03 +00:00
// Register all Public Stylesheets and Scripts.
add_action ( 'init' , array ( $this , 'register_public' ) );
// Enqueue all Public Stylesheets and Scripts.
add_action ( 'wp_enqueue_scripts' , array ( $this , 'register_public' ) );
// Register all Widgets of the Plugin..
add_action ( 'widgets_init' , array ( $this , 'initialize_widgets' ) );
2021-03-02 03:09:34 +00:00
}
/**
* Initializes all Widgets of the Plugin .
*
* @ since 1.5 . 0
*
* - Update : Fix for deprecated PHP function create_function (), thanks to @ psykonevro @ daliasued bug reports , thanks to @ felipelavinz code contribution
*
* @ since 1.6 . 5
*
* @ contributor @ felipelavinz
* @ link https :// github . com / media - competence - institute / footnotes / commit / 87173 d2980c7ff90e12ffee94ca7153e11163793
*
* @ reporter @ psykonevro
* @ link https :// wordpress . org / support / topic / bug - function - create_function - is - deprecated /
* @ link https :// wordpress . org / support / topic / deprecated - function - create_function - 14 /
*
* @ reporter @ daliasued
* @ link https :// wordpress . org / support / topic / deprecated - function - create_function - 14 / #post-13312853
*
* create_function () was deprecated in PHP 7.2 . 0 and removed in PHP 8.0 . 0.
* @ link https :// www . php . net / manual / en / function . create - function . php
*
* The fix is to move add_action () above into run (),
* and use the bare register_widget () here .
* @ see self :: run ()
*
2021-03-03 18:58:03 +00:00
* Also , the visibility of initialize_widgets () is not private any longer .
2021-03-02 03:09:34 +00:00
*/
2021-03-03 18:58:03 +00:00
public function initialize_widgets () {
register_widget ( 'MCI_Footnotes_Widget_Reference_container' );
2021-03-02 03:09:34 +00:00
}
/**
* Initializes the Dashboard of the Plugin and loads them .
*
* @ since 1.5 . 0
*/
2021-03-03 18:58:03 +00:00
private function initialize_dashboard () {
2021-03-02 03:09:34 +00:00
new MCI_Footnotes_Layout_Init ();
}
/**
* Initializes the Plugin Task and registers the Task hooks .
*
* @ since 1.5 . 0
*/
2021-03-03 18:58:03 +00:00
private function initialize_task () {
$this -> a_obj_task = new MCI_Footnotes_Task ();
$this -> a_obj_task -> register_hooks ();
2021-03-02 03:09:34 +00:00
}
/**
* Registers and enqueues scripts and stylesheets to the public pages .
*
* @ since 1.5 . 0
*
* @ since 2.0 . 0 Update : Tooltips : fix disabling bug by loading jQuery UI library , thanks to @ rajinderverma @ ericcorbett2 @ honlapdavid @ mmallett bug reports , thanks to @ vonpiernik code contribution .
* @ since 2.0 . 3 add versioning of public . css for cache busting 2020 - 10 - 29 T1413 + 0100
* @ since 2.0 . 4 add jQuery UI from WordPress 2020 - 11 - 01 T1902 + 0100
* @ since 2.1 . 4 automate passing version number for cache busting 2020 - 11 - 30 T0646 + 0100
* @ since 2.1 . 4 optionally enqueue an extra stylesheet 2020 - 12 - 04 T2231 + 0100
*/
2021-03-03 18:58:03 +00:00
public function register_public () {
2021-03-02 03:09:34 +00:00
/**
* Enqueues external scripts .
*
* - Bugfix : Libraries : optimize processes by loading external and internal scripts only if needed , thanks to @ docteurfitness issue report .
*
* @ since 2.5 . 5
* @ reporter @ docteurfitness
* @ link https :// wordpress . org / support / topic / simply - speed - optimisation /
*
* The condition about tooltips was missing , only the not - alternative - tooltips part was present .
*/
2021-03-03 18:58:03 +00:00
// Set conditions re-used for stylesheet enqueuing.
self :: $a_bool_tooltips_enabled = MCI_Footnotes_Convert :: to_bool ( MCI_Footnotes_Settings :: instance () -> get ( MCI_Footnotes_Settings :: C_STR_FOOTNOTES_MOUSE_OVER_BOX_ENABLED ) );
self :: $a_bool_alternative_tooltips_enabled = MCI_Footnotes_Convert :: to_bool ( MCI_Footnotes_Settings :: instance () -> get ( MCI_Footnotes_Settings :: C_STR_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE ) );
$l_str_script_mode = MCI_Footnotes_Settings :: instance () -> get ( MCI_Footnotes_Settings :: C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE );
2021-03-02 03:09:34 +00:00
/**
* Enqueues the jQuery library registered by WordPress .
*
* - Bugfix : Reference container : optional alternative expanding and collapsing without jQuery for use with hard links , thanks to @ hopper87it @ pkverma99 issue reports .
*
* @ since 2.5 . 6
*
* @ reporter @ hopper87it
* @ link https :// wordpress . org / support / topic / footnotes - wp - rocket /
2021-03-03 18:58:03 +00:00
*
2021-03-02 03:09:34 +00:00
* jQuery is also used for animated scrolling , so it was loaded by default .
* The function wp_enqueue_script () avoids loading the same library multiple times .
* After adding the alternative reference container , jQuery has become optional ,
* but still enabled by default .
*/
2021-03-03 18:58:03 +00:00
if ( 'jquery' === $l_str_script_mode || ( self :: $a_bool_tooltips_enabled && ! self :: $a_bool_alternative_tooltips_enabled ) ) {
2021-03-02 03:09:34 +00:00
wp_enqueue_script ( 'jquery' );
2021-03-03 18:58:03 +00:00
2021-03-02 03:09:34 +00:00
}
2021-03-03 18:58:03 +00:00
if ( self :: $a_bool_tooltips_enabled && ! self :: $a_bool_alternative_tooltips_enabled ) {
2021-03-02 03:09:34 +00:00
/**
* Enqueues the jQuery Tools library shipped with the plugin .
*
2021-03-03 18:58:03 +00:00
* Redacted jQuery . browser , completed minification ;
* see full header in js / jquery . tools . js .
*
* Add versioning .
*
* @ since 2.1 . 2
* @ date 2020 - 11 - 18 T2150 + 0100
*
* No '-js' in the handle , is appended automatically .
*
* Deferring to the footer breaks jQuery tooltip display .
* @ date 2021 - 02 - 23 T1105 + 0100
2021-03-02 03:09:34 +00:00
*/
wp_enqueue_script (
'mci-footnotes-jquery-tools' ,
2021-03-03 18:58:03 +00:00
plugins_url ( 'footnotes/js/jquery.tools.min.js' ),
2021-03-02 03:09:34 +00:00
array (),
2021-03-03 18:58:03 +00:00
'1.2.7.redacted.2' ,
false
2021-03-02 03:09:34 +00:00
);
/**
2021-03-03 18:58:03 +00:00
* Enqueues some jQuery UI libraries registered by WordPress .
2021-03-02 03:09:34 +00:00
*
* - Update : Tooltips : fix disabling bug by loading jQuery UI library , thanks to @ rajinderverma @ ericcorbett2 @ honlapdavid @ mmallett bug reports , thanks to @ vonpiernik code contribution .
*
* @ since 2.0 . 0
*
2021-03-03 18:58:03 +00:00
* @ reporter @ rajinderverma
* @ link https :// wordpress . org / support / topic / tooltip - hover - not - showing /
2021-03-02 03:09:34 +00:00
*
2021-03-03 18:58:03 +00:00
* @ reporter @ ericcorbett2
* @ link https :// wordpress . org / support / topic / tooltip - hover - not - showing / #post-13324142
2021-03-02 04:22:20 +00:00
*
2021-03-03 18:58:03 +00:00
* @ reporter @ honlapdavid
* @ link https :// wordpress . org / support / topic / tooltip - hover - not - showing / #post-13355421
2021-03-02 04:22:20 +00:00
*
2021-03-03 18:58:03 +00:00
* @ reporter @ mmallett
* @ link https :// wordpress . org / support / topic / tooltip - hover - not - showing / #post-13445437
*
* Fetch jQuery UI from cdnjs . cloudflare . com .
* @ since 2.0 . 0
* @ date 2020 - 10 - 26 T1907 + 0100
* @ contributor @ vonpiernik
* @ link https :// wordpress . org / support / topic / tooltip - hover - not - showing / #post-13456762
*
* jQueryUI re - enables the tooltip infobox disabled when WPv5 . 5 was released . * @ since 2.1 . 2
*
* - Update : Libraries : Load jQuery UI from WordPress , thanks to @ check2020de issue report .
*
* @ since 2.0 . 4
* @ date 2020 - 11 - 01 T1902 + 0100
* @ reporter @ check2020de
* @ link https :// wordpress . org / support / topic / gdpr - issue - with - jquery /
* @ link https :// wordpress . stackexchange . com / questions / 273986 / correct - way - to - enqueue - jquery - ui
2021-03-02 03:09:34 +00:00
*
* If alternative tooltips are enabled , these libraries are not needed .
*/
wp_enqueue_script ( 'jquery-ui-core' );
wp_enqueue_script ( 'jquery-ui-widget' );
wp_enqueue_script ( 'jquery-ui-position' );
wp_enqueue_script ( 'jquery-ui-tooltip' );
}
/**
* Enables enqueuing a new - scheme stylesheet .
*
* @ since 2.5 . 5
* @ date 2021 - 02 - 14 T1512 + 0100
*
* Enables enqueuing the formatted individual stylesheets if false .
* WARNING : This facility is designed for development and must NOT be used in production .
*
* The Boolean may be set at the bottom of the plugin’ main PHP file .
* @ see footnotes . php
*/
if ( C_BOOL_CSS_PRODUCTION_MODE === true ) {
/**
* Enqueues a minified united external stylesheet in production .
*
* - Update : Stylesheets : increase speed and energy efficiency by tailoring stylesheets to the needs of the instance , thanks to @ docteurfitness design contribution .
* - Bugfix : Stylesheets : minify to shrink the carbon footprint , increase speed and implement best practice , thanks to @ docteurfitness issue report .
*
* @ since 2.5 . 5
* @ date 2021 - 02 - 14 T1543 + 0100
*
* @ contributor @ docteurfitness
* @ link https :// wordpress . org / support / topic / simply - speed - optimisation /
*
* @ reporter @ docteurfitness
* @ link https :// wordpress . org / support / topic / simply - speed - optimisation /
*
* The dashboard stylesheet is minified as - is .
* @ see class / dashboard / layout . php
*
* @ since 2.0 . 3 add versioning of public . css for cache busting .
* @ date 2020 - 10 - 29 T1413 + 0100
* Plugin version number is needed for busting browser caches after each plugin update .
* @ since 2.1 . 4 automate passing version number for cache busting .
* @ date 2020 - 11 - 30 T0646 + 0100
* The constant C_STR_FOOTNOTES_VERSION is defined at start of footnotes . php .
*
* The media scope argument 'all' is the default .
* No need to use '-css' in the handle , as this is appended automatically .
*/
2021-03-03 18:58:03 +00:00
// Set tooltip mode for use in stylesheet name.
if ( self :: $a_bool_tooltips_enabled ) {
if ( self :: $a_bool_alternative_tooltips_enabled ) {
$l_str_tooltip_mode_short = 'al' ;
$l_str_tooltip_mode_rest = 'ternative-tooltips' ;
2021-03-02 03:09:34 +00:00
} else {
2021-03-03 18:58:03 +00:00
$l_str_tooltip_mode_short = 'jq' ;
$l_str_tooltip_mode_rest = 'uery-tooltips' ;
2021-03-02 03:09:34 +00:00
}
} else {
2021-03-03 18:58:03 +00:00
$l_str_tooltip_mode_short = 'no' ;
$l_str_tooltip_mode_rest = '-tooltips' ;
2021-03-02 03:09:34 +00:00
}
2021-03-03 18:58:03 +00:00
// Set basic responsive page layout mode for use in stylesheet name.
$l_str_page_layout_option = MCI_Footnotes_Settings :: instance () -> get ( MCI_Footnotes_Settings :: C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT );
switch ( $l_str_page_layout_option ) {
case 'reference-container' :
$l_str_layout_mode = '1' ;
break ;
case 'entry-content' :
$l_str_layout_mode = '2' ;
break ;
case 'main-content' :
$l_str_layout_mode = '3' ;
break ;
case 'none' :
default :
$l_str_layout_mode = '0' ;
break ;
2021-03-02 03:09:34 +00:00
}
2021-03-03 18:58:03 +00:00
// Enqueue the tailored united minified stylesheet.
2021-03-02 03:09:34 +00:00
wp_enqueue_style (
2021-03-03 18:58:03 +00:00
'mci-footnotes-' . $l_str_tooltip_mode_short . $l_str_tooltip_mode_rest . '-pagelayout-' . $l_str_page_layout_option ,
2021-03-02 03:09:34 +00:00
plugins_url (
2021-03-03 18:58:03 +00:00
MCI_Footnotes_Config :: C_STR_PLUGIN_NAME . '/css/footnotes-' . $l_str_tooltip_mode_short . 'ttbrpl' . $l_str_layout_mode . '.min.css'
2021-03-02 03:09:34 +00:00
),
array (),
C_STR_FOOTNOTES_VERSION ,
'all'
);
} else {
/**
* Enqueues external stylesheets , ONLY in development now .
*
* @ since 2.1 . 4 optionally enqueue an extra stylesheet .
* @ date 2020 - 12 - 04 T2231 + 0100
*
* This optional layout fix is useful by lack of layout support .
*/
wp_enqueue_style ( 'mci-footnotes-common' , plugins_url ( MCI_Footnotes_Config :: C_STR_PLUGIN_NAME . '/css/dev-common.css' ), array (), C_STR_FOOTNOTES_VERSION );
wp_enqueue_style ( 'mci-footnotes-tooltips' , plugins_url ( MCI_Footnotes_Config :: C_STR_PLUGIN_NAME . '/css/dev-tooltips.css' ), array (), C_STR_FOOTNOTES_VERSION );
wp_enqueue_style ( 'mci-footnotes-alternative' , plugins_url ( MCI_Footnotes_Config :: C_STR_PLUGIN_NAME . '/css/dev-tooltips-alternative.css' ), array (), C_STR_FOOTNOTES_VERSION );
2021-03-03 18:58:03 +00:00
$l_str_page_layout_option = MCI_Footnotes_Settings :: instance () -> get ( MCI_Footnotes_Settings :: C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT );
if ( 'none' !== $l_str_page_layout_option ) {
2021-03-02 03:09:34 +00:00
wp_enqueue_style (
2021-03-03 18:58:03 +00:00
'mci-footnotes-layout-' . $l_str_page_layout_option ,
2021-03-02 03:09:34 +00:00
plugins_url (
2021-03-03 18:58:03 +00:00
MCI_Footnotes_Config :: C_STR_PLUGIN_NAME . '/css/dev-layout-' . $l_str_page_layout_option . '.css'
2021-03-02 03:09:34 +00:00
),
array (),
C_STR_FOOTNOTES_VERSION ,
'all'
);
}
}
}
}
