From dc225809baff9c2b9f33c032accca559fecdfdd3 Mon Sep 17 00:00:00 2001 From: pewgeuges Date: Tue, 13 Apr 2021 08:18:07 +0000 Subject: [PATCH 01/42] - Release urgent bugfix v2.6.6 - Delete temporary tag 2.5.13.1 = 2.6.6 = - Bugfix: Process: fix issue that caused some footnotes to not be processed, thanks to @docteurfitness @rkupadhya @offpeakdesign bug reports. git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2513893 b8457f37-d9ea-0310-8a92-e5e31aec5664 --- class/task.php | 44 ++++++++++++++++++++++++++++++++++---------- footnotes.php | 8 ++++---- js/wysiwyg-editor.js | 2 +- readme.txt | 11 +++++++---- 4 files changed, 46 insertions(+), 19 deletions(-) diff --git a/class/task.php b/class/task.php index 7a043c1..c9052aa 100644 --- a/class/task.php +++ b/class/task.php @@ -1190,18 +1190,18 @@ class MCI_Footnotes_Task { * @link https://wordpress.org/support/topic/problem-with-footnotes-in-excerpts-of-the-blog-page/ * * @since 2.6.3 - * + * * - Bugfix: Process: remove trailing comma after last argument in multiline function calls for PHP < 7.3, thanks to @scroom @copylefter @lagoon24 bug reports. - * + * * @reporter @scroom * @link https://wordpress.org/support/topic/update-crashed-my-website-3/ - * + * * @reporter @copylefter * @link https://wordpress.org/support/topic/update-crashed-my-website-3/#post-14259151 - * + * * @reporter @lagoon24 * @link https://wordpress.org/support/topic/update-crashed-my-website-3/#post-14259396 - * + * * @since 2.6.4 * @param string $p_str_content The post. * @return string $p_str_content An excerpt of the post. @@ -2154,12 +2154,11 @@ class MCI_Footnotes_Task { } /** - * Fixes a footnotes numbering bug (happening under de facto rare circumstances). + * Fixes a partial footnotes process outage happening when tooltips are truncated or disabled. + * Fixed a footnotes numbering bug happening under de facto rare circumstances. * * - Bugfix: Fixed occasional bug where footnote ordering could be out of sequence * - * @since 1.6.4 - * @date 2016-06-29T0054+0000 * @committer @dartiss * @link https://plugins.trac.wordpress.org/browser/footnotes/trunk/class/task.php?rev=1445718 @dartiss’ class/task.php * @link https://plugins.trac.wordpress.org/log/footnotes/trunk/class/task.php?rev=1445718 @dartiss re-added class/task.php @@ -2167,6 +2166,8 @@ class MCI_Footnotes_Task { * @link https://plugins.trac.wordpress.org/changeset/1445711/footnotes/trunk/class @dartiss deleted class/task.php * @link https://plugins.trac.wordpress.org/browser/footnotes/trunk/class/task.php?rev=1026210 @aricura’s latest class/task.php * + * @since 1.6.4 + * @date 2016-06-29T0054+0000 * * - Bugfix: Process: fix numbering bug impacting footnote #2 with footnote #1 close to start, thanks to @rumperuu bug report, thanks to @lolzim code contribution. * @@ -2182,10 +2183,33 @@ class MCI_Footnotes_Task { * footnote and the length of the last footnote replace text. * A bug disturbing the order of the footnotes depending on the text before the first * footnote, the length of the first footnote and the length of the templates for the - * footnote and the tooltip. Moreover, it was causing non-trivial process garbage. + * footnote and the tooltip. + * Deleting both lines instead, to resume the search at the position where it left off, + * would have prevented also the following bug. + * + * - Bugfix: Process: fix issue that caused some footnotes to not be processed, thanks to @docteurfitness @rkupadhya @offpeakdesign bug reports. + * + * @reporter @docteurfitness + * @link https://wordpress.org/support/topic/problem-since-footnotes-2-5-14/ + * + * @reporter @rkupadhya + * @link https://wordpress.org/support/topic/adjacent-footnotes-not-working-sometimes/ + * + * @reporter @offpeakdesign + * @link https://wordpress.org/support/topic/character-limit-bug/ + * + * @since 2.6.6 + * The origin of the bug was present since the beginning (v1.0.0). + * For v1.3.2 the wrong code was refactored but remained wrong, + * and was unaffected by the v1.5.0 refactoring. + * The reason why the numbering disorder reverted to a partial process outage + * since 2.5.14 is that with this version, the plugin stopped processing the + * content multiple times, and started unifying the shortcodes instead, to fix + * the numbering disorder affecting delimiter shortcodes with pointy brackets + * and mixed escapement schemas. */ // Add offset to the new starting position. - $l_int_pos_start += $l_int_length + strlen( self::$a_str_end_tag ); + $l_int_pos_start += strlen( $l_str_footnote_replace_text ); } while ( true ); diff --git a/footnotes.php b/footnotes.php index 31e01b4..b334902 100755 --- a/footnotes.php +++ b/footnotes.php @@ -4,8 +4,8 @@ * Plugin URI: https://wordpress.org/plugins/footnotes/ * Description: time to bring footnotes to your website! footnotes are known from offline publishing and everybody takes them for granted when reading a magazine. * Author: Mark Cheret - * Package V.: 2.6.5 - * Version: 2.6.5 + * Package V.: 2.6.6 + * Version: 2.6.6 * CAUTION: THIS V. FIELD IS PARSED FOR UPDATE CONFIGURATION. * Author URI: https://cheret.org/footnotes/ * Text Domain: footnotes @@ -21,9 +21,9 @@ * @since 2.1.4 * @since 2.5.3 (Hungarian) * @var str - * @lastmodified 2021-04-01T0721+0200 + * @lastmodified 2021-04-13T1011+0200 */ -define( 'C_STR_PACKAGE_VERSION', '2.6.5' ); +define( 'C_STR_PACKAGE_VERSION', '2.6.6' ); /** * Enables toggling the stylesheet enqueuing mode from production (true) to development (false). * @see Full docblock below next. diff --git a/js/wysiwyg-editor.js b/js/wysiwyg-editor.js index 64a2c60..9c55e2a 100644 --- a/js/wysiwyg-editor.js +++ b/js/wysiwyg-editor.js @@ -69,7 +69,7 @@ author : 'Mark Cheret', authorurl : 'https://cheret.org/footnotes/', infourl : 'https://wordpress.org/plugins/footnotes/', - version : '2.6.5' + version : '2.6.6' }; } }); diff --git a/readme.txt b/readme.txt index 6676f8e..14ca52d 100755 --- a/readme.txt +++ b/readme.txt @@ -3,10 +3,10 @@ Contributors: mark.cheret, lolzim, rumperuu, aricura, misfist, ericakfranz, mili Tags: footnote, footnotes, bibliography, formatting, notes, Post, posts, reference, referencing Requires at least: 3.9 Tested up to: 5.7 -Requires PHP: 5.6 -Package Version: 2.6.5 -Version: 2.6.5 -Stable Tag: 2.6.5 +Requires PHP: 7.0 +Package Version: 2.6.6 +Version: 2.6.6 +Stable Tag: 2.6.6 CAUTION: THE S. T. FIELD IS PARSED FOR RELEASE CONFIGURATION. License: GPLv3 or later License URI: https://www.gnu.org/licenses/gpl-3.0.html @@ -80,6 +80,9 @@ Visit this swift write-up from a **footnotes** user by the name of **Southwest** == Changelog == += 2.6.6 = +- Bugfix: Process: fix issue that caused some footnotes to not be processed, thanks to @docteurfitness @rkupadhya @offpeakdesign bug reports. + = 2.6.5 = - Bugfix: Editor buttons: debug button by reverting name change in PHP file while JS file and HTML template remained unsynced, thanks to @gova bug report. - Bugfix: Hooks: default-disable the_excerpt hook with respect to theme-specific excerpt handling, thanks to @mmallett bug reports. From a02cdacb7f6fe9ce3b0807051abeed197f1cc9fd Mon Sep 17 00:00:00 2001 From: pewgeuges Date: Wed, 14 Apr 2021 23:10:29 +0000 Subject: [PATCH 02/42] Release urgent feature 2.7.0 in response to request from user @grflukas. https://wordpress.org/support/topic/multiple-reference-containers-in-single-post/ Bundled with two bugfixes. https://github.com/markcheret/footnotes/issues/65 https://github.com/markcheret/footnotes/issues/71 Last release directly to SVN. = 2.7.0 = - Adding: Reference container: optionally per section by shortcode, thanks to @grflukas issue report. - Bugfix: Excerpts: make excerpt handling backward compatible, thanks to @mfessler bug report. - Bugfix: Dashboard: debug the 'Quick start guide' tab, thanks to @rumperuu bug report. git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2515217 b8457f37-d9ea-0310-8a92-e5e31aec5664 --- class/dashboard/layout.php | 4 +- class/dashboard/subpage-main.php | 88 ++++++++++++------- class/hooks.php | 3 +- class/init.php | 16 ++-- class/settings.php | 47 ++++++---- class/task.php | 81 ++++++++++++++--- footnotes.php | 12 +-- js/wysiwyg-editor.js | 2 +- readme.txt | 11 ++- .../settings-reference-container.html | 4 + templates/public/amp-footnote-expand.html | 2 +- templates/public/amp-footnote.html | 2 +- 12 files changed, 189 insertions(+), 83 deletions(-) diff --git a/class/dashboard/layout.php b/class/dashboard/layout.php index e4433ee..6221767 100644 --- a/class/dashboard/layout.php +++ b/class/dashboard/layout.php @@ -213,11 +213,11 @@ abstract class MCI_Footnotes_Layout_Engine { */ if ( true === C_BOOL_CSS_PRODUCTION_MODE ) { - wp_register_style( 'mci-footnotes-admin', plugins_url( 'footnotes/css/settings.min.css' ), array(), C_STR_PACKAGE_VERSION ); + wp_register_style( 'mci-footnotes-admin', plugins_url( 'footnotes/css/settings.min.css' ), array(), C_STR_FOOTNOTES_VERSION ); } else { - wp_register_style( 'mci-footnotes-admin', plugins_url( 'footnotes/css/settings.css' ), array(), C_STR_PACKAGE_VERSION ); + wp_register_style( 'mci-footnotes-admin', plugins_url( 'footnotes/css/settings.css' ), array(), C_STR_FOOTNOTES_VERSION ); } diff --git a/class/dashboard/subpage-main.php b/class/dashboard/subpage-main.php index ea93d1b..40808e5 100644 --- a/class/dashboard/subpage-main.php +++ b/class/dashboard/subpage-main.php @@ -160,7 +160,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { } $l_arr_meta_boxes[] = $this->add_meta_box( 'customcss', 'custom-css-new', __( 'Custom CSS', 'footnotes' ), 'custom_css_new' ); - $l_arr_meta_boxes[] = $this->add_meta_box( 'how-to', 'help', __( 'Brief introduction in how to use the plugin', 'footnotes' ), 'help' ); + $l_arr_meta_boxes[] = $this->add_meta_box( 'how-to', 'help', __( 'Brief introduction: How to use the plugin', 'footnotes' ), 'help' ); $l_arr_meta_boxes[] = $this->add_meta_box( 'how-to', 'donate', __( 'Help us to improve our Plugin', 'footnotes' ), 'donate' ); return $l_arr_meta_boxes; @@ -288,12 +288,16 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { 'label-position' => $this->add_label( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_POSITION, __( 'Default position:', 'footnotes' ) ), 'position' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_POSITION, $l_arr_positions ), // Translators: %s: at the end of the post. - 'notice-position' => sprintf( __( 'To use the position shortcode, please set the position to: %s', 'footnotes' ), '' . __( 'at the end of the post', 'footnotes' ) . '' ), + 'notice-position' => sprintf( __( 'To use the position or section shortcode, please set the position to: %s', 'footnotes' ), '' . __( 'at the end of the post', 'footnotes' ) . '' ), 'label-shortcode' => $this->add_label( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE, __( 'Position shortcode:', 'footnotes' ) ), 'shortcode' => $this->add_text_box( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE ), 'notice-shortcode' => __( 'If present in the content, any shortcode in this text box will be replaced with the reference container.', 'footnotes' ), + 'label-section' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTE_SECTION_SHORTCODE, __( 'Footnote section shortcode:', 'footnotes' ) ), + 'section' => $this->add_text_box( MCI_Footnotes_Settings::C_STR_FOOTNOTE_SECTION_SHORTCODE ), + 'notice-section' => __( 'If present in the content, any shortcode in this text box will delimit a section terminated by a reference container.', 'footnotes' ), + 'label-startpage' => $this->add_label( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_START_PAGE_ENABLE, __( 'Display on start page too:', 'footnotes' ) ), 'startpage' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_START_PAGE_ENABLE, $l_arr_enabled ), @@ -358,7 +362,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { 'label-link' => $this->add_label( MCI_Footnotes_Settings::C_STR_LINK_ELEMENT_ENABLED, __( 'Use the link element for referrers and backlinks:', 'footnotes' ) ), 'link' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_LINK_ELEMENT_ENABLED, $l_arr_enabled ), 'notice-link' => __( 'The link element is needed to apply the theme’s link color.', 'footnotes' ), - 'description-link' => __( 'If the link element is not desired for styling, a simple span is used instead when the above is set to No. The link addresses have been removed. Else footnote clicks are logged in the browsing history and make the back button unusable.', 'footnotes' ), + 'description-link' => __( 'If the link element is not desired for styling, a simple span is used instead when the above is set to No.', 'footnotes' ), ) ); // Display template with replaced placeholders. @@ -423,8 +427,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { // Replace all placeholders. $l_obj_template->replace( array( - // Translators: The 2 placeholders are the <ref></ref> and <fn></fn> shortcodes. - 'description-escapement' => sprintf( __( 'The problems with shortcodes with pointy brackets have been solved. We apologize for the longlasting bugs making the %s and %s shortcodes close to unusable.', 'footnotes' ), '<ref></ref>', '<fn></fn>' ), + 'description-escapement' => __( 'When delimiters with pointy brackets are used, the diverging escapement schemas will be unified before footnotes are processed.', 'footnotes' ), 'label-short-code-start' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_START, __( 'Footnote start tag short code:', 'footnotes' ) ), 'short-code-start' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_START, $l_arr_shortcode_start ), @@ -596,7 +599,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { // Enable backlink tooltips. 'label-backlink-tooltips' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE, __( 'Enable backlink tooltips:', 'footnotes' ) ), 'backlink-tooltips' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE, $l_arr_enable ), - 'notice-backlink-tooltips' => __( 'Hard backlinks get ordinary tooltips hinting to use the backbutton instead.', 'footnotes' ), + 'notice-backlink-tooltips' => __( 'Hard backlinks get ordinary tooltips hinting to use the backbutton instead to keep it usable.', 'footnotes' ), 'label-backlink-tooltip-text' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT, __( 'Backlink tooltip text:', 'footnotes' ) ), 'backlink-tooltip-text' => $this->add_text_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT ), @@ -661,7 +664,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { } /** - * Displays the excerpt setting. + * Displays the footnotes in excerpt setting. * * @since 1.5.0 * @@ -672,10 +675,11 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { * @since 2.2.0 dedicated to the excerpt setting and its notices 2020-12-12T1454+0100 */ public function excerpts() { - // Options for Yes/No select box. - $l_arr_enabled = array( - 'yes' => __( 'Yes', 'footnotes' ), - 'no' => __( 'No', 'footnotes' ), + // Options for options select box. + $l_arr_excerpt_mode = array( + 'yes' => __( 'Yes, generate excerpts from posts with effectively processed footnotes and other markup', 'footnotes' ), + 'no' => __( 'No, generate excerpts from posts but remove all footnotes and output plain text', 'footnotes' ), + 'manual' => __( 'Yes but run the process only to display tooltips in manual excerpts with footnote short codes', 'footnotes' ), ); // Load template file. @@ -683,12 +687,12 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { // Replace all placeholders. $l_obj_template->replace( array( - 'label-excerpts' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_IN_EXCERPT, __( 'Display footnotes in excerpts:', 'footnotes' ) ), - 'excerpts' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_IN_EXCERPT, $l_arr_enabled ), - 'notice-excerpts' => __( 'For this setting to be effective, the hook the_excerpt must be enabled under Scope and priority.', 'footnotes' ), + 'label-excerpts' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_IN_EXCERPT, __( 'Process footnotes in excerpts:', 'footnotes' ) ), + 'excerpts' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_IN_EXCERPT, $l_arr_excerpt_mode ), + 'notice-excerpts' => __( 'If the_excerpt is enabled.', 'footnotes' ), // Translators: %s: link text 'Advanced Excerpt' linked to the plugin’s WordPress.org front page. // Translators: %s: Footnotes plugin logo. - 'description-excerpts' => sprintf( __( 'Both to display footnotes and to not display footnotes in excerpts, the %s plugin generates excerpts on the basis of the posts to ensure that footnotes are handled and don’t impact the excerpt length.', 'footnotes' ), '' . MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME . '' ), + 'description-excerpts' => sprintf( __( 'To not display footnotes in excerpts, the %s plugin generates excerpts on the basis of the posts to be able to remove the footnotes. Else, footnotes may be processed in manual excerpts OR processed based on the posts. — For this setting to be effective, the hook the_excerpt must be enabled under Scope and priority.', 'footnotes' ), '' . MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME . '' ), ) ); // Display template with replaced placeholders. @@ -1304,9 +1308,12 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { } /** - * Displays a short introduction of the Plugin. + * Displays a short introduction to the Plugin. * * @since 1.5.0 + * + * @since 2.7.0 Sanitize Lorem Ipsum filler text. + * @link https://blog.prototypr.io/why-testing-with-real-content-is-better-than-lorem-ipsum-c7c79586ee72 */ public function Help() { global $g_obj_mci_footnotes; @@ -1320,19 +1327,19 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { $l_arr_footnote_ending_tag = $this->load_setting( MCI_Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED ); } $l_str_example = 'Hello' . $l_arr_footnote_starting_tag['value'] . - 'Lorem ipsum dolor sit amet, consetetur sadipscing ' . - 'elitr, sed diam nonumy eirmod tempor invidunt ut ' . - 'labore et dolore magna aliquyam erat, sed diam ' . - 'voluptua. At vero eos et accusam et justo duo dolores ' . - 'et ea rebum. Stet clita kasd gubergren, no sea ' . - 'takimata sanctus est Lorem ipsum dolor sit amet. ' . - 'Lorem ipsum dolor sit amet, consetetur sadipscing ' . - 'elitr, sed diam nonumy eirmod tempor invidunt ut ' . - 'labore et dolore magna aliquyam erat, sed diam ' . - 'voluptua. At vero eos et accusam et justo duo ' . - 'dolores et ea rebum. Stet clita kasd gubergren, no ' . - 'sea takimata sanctus est Lorem ipsum dolor sit amet.' . - $l_arr_footnote_ending_tag['value'] . ' World!'; + 'Sed ut perspiciatis, unde omnis iste natus error ' . + 'sit voluptatem accusantium doloremque laudantium, ' . + 'totam rem aperiam eaque ipsa, quae ab illo ' . + 'inventore veritatis et quasi architecto beatae ' . + 'vitae dicta sunt, explicabo. Nemo enim ipsam ' . + 'voluptatem, quia voluptas sit, aspernatur aut ' . + 'odit aut fugit, sed quia consequuntur magni ' . + 'dolores eos, qui ratione voluptatem sequi nesciunt, ' . + 'neque porro quisquam est, qui dolorem ipsum, quia ' . + 'dolor sit amet, consectetur, adipisci velit, sed ' . + 'quia non numquam eius modi tempora incidunt, ut ' . + 'labore et dolore magnam aliquam quaerat voluptatem.' . + $l_arr_footnote_ending_tag['value'] . ' World!'; // Load template file. $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'how-to-help' ); @@ -1346,12 +1353,27 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { 'example-code' => $l_str_example, 'example-string' => '
' . __( 'will be displayed as:', 'footnotes' ), 'example' => $g_obj_mci_footnotes->a_obj_task->exec( $l_str_example, true ), - // Translators: 1: ; 2: . - 'information' => sprintf( __( 'For further information please check out our %1$ssupport forum%2$s on WordPress.org.', 'footnotes' ), '', '' ), + // Translators: %1$s, %2$s: anchor element with hyperlink to the Support Forum. + 'information' => sprintf( __( 'For further information please check out our %1$sSupport Forum%2$s on WordPress.org.', 'footnotes' ), '', '' ), ) ); - // Call wp_head function to get the Styling of the mouse-over box. - $g_obj_mci_footnotes->a_obj_task->wp_head(); + + /** + * Call footnotes_output_head function to get the Styling of the mouse-over box. + * + * - Bugfix: Dashboard: debug the 'Quick start guide' tab, thanks to @rumperuu bug report. + * + * @reporter @rumperuu + * @link https://github.com/markcheret/footnotes/issues/71 + * + * @since 2.7.0 + * The name of the callback function ought to be distinct from + * the name of the filtered function. + * When this callback function was renamed, this call went unnoticed. + * @see class/task.php + */ + $g_obj_mci_footnotes->a_obj_task->footnotes_output_head(); + // Display template with replaced placeholders. // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped echo $l_obj_template->get_content(); diff --git a/class/hooks.php b/class/hooks.php index 8e44a82..375b5ce 100644 --- a/class/hooks.php +++ b/class/hooks.php @@ -6,8 +6,6 @@ * @package footnotes * @since 1.5.0 * @date 12.09.14 10:56 - * - * @since 2.2.0 (TBD) 2020-12-12T1223+0100 */ /** @@ -52,6 +50,7 @@ class MCI_Footnotes_Hooks { * @since 1.5.0 * * @since 2.2.0 this function is not called any longer when deleting the plugin. + * @date 2020-12-12T1223+0100 * Note: clear_all() didn’t actually work. * @see class/settings.php */ diff --git a/class/init.php b/class/init.php index 650c0dc..a67233e 100644 --- a/class/init.php +++ b/class/init.php @@ -87,7 +87,7 @@ class MCI_Footnotes { * @since 2.6.0 (release) * * @contributor @milindmore22 - * @link @link https://github.com/ampproject/amp-wp/issues/5913#issuecomment-785306933 + * @link https://github.com/ampproject/amp-wp/issues/5913#issuecomment-785306933 * * @contributor @westonruter * @link https://github.com/ampproject/amp-wp/issues/5913#issuecomment-785419655 @@ -366,7 +366,7 @@ class MCI_Footnotes { * 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-30T0646+0100 - * The constant C_STR_PACKAGE_VERSION is defined at start of footnotes.php. + * 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. @@ -419,7 +419,7 @@ class MCI_Footnotes { MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '/css/footnotes-' . $l_str_tooltip_mode_short . 'brpl' . $l_str_layout_mode . '.min.css' ), array(), - C_STR_PACKAGE_VERSION, + C_STR_FOOTNOTES_VERSION, 'all' ); @@ -433,15 +433,15 @@ class MCI_Footnotes { * * 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_PACKAGE_VERSION ); - wp_enqueue_style( 'mci-footnotes-tooltips', plugins_url( MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '/css/dev-tooltips.css' ), array(), C_STR_PACKAGE_VERSION ); + 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 ); if ( self::$a_bool_amp_enabled ) { - wp_enqueue_style( 'mci-footnotes-amp', plugins_url( MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '/css/dev-amp-tooltips.css' ), array(), C_STR_PACKAGE_VERSION ); + wp_enqueue_style( 'mci-footnotes-amp', plugins_url( MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '/css/dev-amp-tooltips.css' ), array(), C_STR_FOOTNOTES_VERSION ); } if ( self::$a_bool_alternative_tooltips_enabled ) { - wp_enqueue_style( 'mci-footnotes-alternative', plugins_url( MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '/css/dev-tooltips-alternative.css' ), array(), C_STR_PACKAGE_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 ); } $l_str_page_layout_option = MCI_Footnotes_Settings::instance()->get( MCI_Footnotes_Settings::C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT ); @@ -452,7 +452,7 @@ class MCI_Footnotes { MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '/css/dev-layout-' . $l_str_page_layout_option . '.css' ), array(), - C_STR_PACKAGE_VERSION, + C_STR_FOOTNOTES_VERSION, 'all' ); } diff --git a/class/settings.php b/class/settings.php index 1e81c24..9535027 100644 --- a/class/settings.php +++ b/class/settings.php @@ -122,16 +122,18 @@ class MCI_Footnotes_Settings { /** * Settings container key to look for footnotes in post excerpts. * - * - Bugfix: Hooks: disable the_excerpt hook by default to fix issues, thanks to @nikelaos bug report. - * - * @reporter @nikelaos - * @link https://wordpress.org/support/topic/doesnt-work-any-more-11/#post-13687068 - * * @since 1.5.0 * @since 2.6.2 Debug No option. * @since 2.6.3 Enable by default after debugging both Yes and No options. + * + * - Bugfix: Excerpts: make excerpt handling backward compatible, thanks to @mfessler bug report. + * + * @reporter @mfessler + * @link https://github.com/markcheret/footnotes/issues/65 + * + * @since 2.7.0 * @see C_STR_EXPERT_LOOKUP_THE_EXCERPT - * @var str + * @var str Default 'manual'. */ const C_STR_FOOTNOTES_IN_EXCERPT = 'footnote_inputfield_search_in_excerpt'; @@ -248,13 +250,13 @@ class MCI_Footnotes_Settings { * * @since 2.1.3 * @since 2.6.3 Enable by default after debugging the 'Footnotes in excerpts' setting. - * + * * - Bugfix: Hooks: default-disable the_excerpt hook with respect to theme-specific excerpt handling, thanks to @mmallett bug reports. - * + * * @reporter @mmallett * @link https://wordpress.org/support/topic/broken-662/ * @link https://wordpress.org/support/topic/update-crashed-my-website-3/#post-14260969 - * + * * @since 2.6.5 * @see C_STR_FOOTNOTES_IN_EXCERPT * @var str @@ -301,9 +303,9 @@ class MCI_Footnotes_Settings { * Settings container key for the mouse-over box to define the color. * * @since 1.5.6 - * + * * - Bugfix: Tooltips: Styling: Font color: set to black for maximum contrast with respect to white default background, thanks to 4msc bug report. - * + * * @reporter @4msc * @link https://wordpress.org/support/topic/tooltip-not-showing-on-dark-theme-with-white-text/ * @@ -1154,7 +1156,7 @@ class MCI_Footnotes_Settings { * - Adding: Reference container: get expanding and collapsing to work also in AMP compatibility mode, thanks to @westonruter code contribution. * * @contributor @milindmore22 - * @link @link https://github.com/ampproject/amp-wp/issues/5913#issuecomment-785306933 + * @link https://github.com/ampproject/amp-wp/issues/5913#issuecomment-785306933 * * @contributor @westonruter * @link https://github.com/ampproject/amp-wp/issues/5913#issuecomment-785419655 @@ -1224,10 +1226,24 @@ class MCI_Footnotes_Settings { * @link https://wordpress.org/support/topic/compatibility-issue-with-wpforms/#post-14214720 * * @since 2.5.12 + * @var str * Native smooth scrolling only works in recent browsers. */ const C_STR_FOOTNOTES_CSS_SMOOTH_SCROLLING = 'footnotes_inputfield_css_smooth_scrolling'; + /** + * Settings container key for the footnote section shortcode. + * + * - Adding: Reference container: optionally per section by shortcode, thanks to @grflukas issue report. + * + * @reporter @grflukas + * @link https://wordpress.org/support/topic/multiple-reference-containers-in-single-post/ + * + * @since 2.7.0 + * @var str + */ + const C_STR_FOOTNOTE_SECTION_SHORTCODE = 'footnotes_inputfield_section_shortcode'; + /** * SETTINGS STORAGE. @@ -1309,6 +1325,7 @@ class MCI_Footnotes_Settings { self::C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE => 'jquery', self::C_STR_REFERENCE_CONTAINER_POSITION => 'post_end', self::C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE => '[[references]]', + self::C_STR_FOOTNOTE_SECTION_SHORTCODE => '[[/footnotesection]]', self::C_STR_REFERENCE_CONTAINER_START_PAGE_ENABLE => 'yes', self::C_INT_REFERENCE_CONTAINER_TOP_MARGIN => 24, self::C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN => 0, @@ -1339,7 +1356,7 @@ class MCI_Footnotes_Settings { self::C_STR_LINK_ELEMENT_ENABLED => 'yes', // Footnotes in excerpts. - self::C_STR_FOOTNOTES_IN_EXCERPT => 'yes', + self::C_STR_FOOTNOTES_IN_EXCERPT => 'manual', // Footnotes love. self::C_STR_FOOTNOTES_LOVE => 'no', @@ -1523,10 +1540,10 @@ class MCI_Footnotes_Settings { * @since 1.5.0 * * - Bugfix: Removed the 'trim' function to allow leading and trailing whitespace in settings text boxes, thanks to @compasscare bug report. - * + * * @reporter @compasscare * @link https://wordpress.org/support/topic/leading-space-in-footnotes-tag/ - * + * * @since 1.5.2 * @param int $p_int_index Settings container array key index. * @return array Settings loaded from defaults if container is empty (first usage). diff --git a/class/task.php b/class/task.php index c9052aa..e4e0ffb 100644 --- a/class/task.php +++ b/class/task.php @@ -490,13 +490,22 @@ class MCI_Footnotes_Task { add_filter( 'pum_popup_content', array( $this, 'footnotes_in_content' ), $l_int_the_content_priority ); } + /** + * Adds a filter to the excerpt hook. + * + * @since 1.5.0 The hook 'get_the_excerpt' is filtered too. + * @since 1.5.5 The hook 'get_the_excerpt' is removed but not documented in changelog or docblock. + * @since 2.6.2 The hook 'get_the_excerpt' is readded when attempting to debug excerpt handling. + * @since 2.6.6 The hook 'get_the_excerpt' is removed again because it seems to cause issues in some themes. + */ if ( MCI_Footnotes_Convert::to_bool( MCI_Footnotes_Settings::instance()->get( MCI_Footnotes_Settings::C_STR_EXPERT_LOOKUP_THE_EXCERPT ) ) ) { - add_filter( 'the_excerpt', array( $this, 'footnotes_in_excerpt' ), $l_int_the_excerpt_priority ); - add_filter( 'get_the_excerpt', array( $this, 'footnotes_in_excerpt' ), $l_int_the_excerpt_priority ); + add_filter( 'the_excerpt', array( $this, 'footnotes_in_excerpt' ), $l_int_the_excerpt_priority ); } + if ( MCI_Footnotes_Convert::to_bool( MCI_Footnotes_Settings::instance()->get( MCI_Footnotes_Settings::C_STR_EXPERT_LOOKUP_WIDGET_TITLE ) ) ) { add_filter( 'widget_title', array( $this, 'footnotes_in_widget_title' ), $l_int_widget_title_priority ); } + if ( MCI_Footnotes_Convert::to_bool( MCI_Footnotes_Settings::instance()->get( MCI_Footnotes_Settings::C_STR_EXPERT_LOOKUP_WIDGET_TEXT ) ) ) { add_filter( 'widget_text', array( $this, 'footnotes_in_widget_text' ), $l_int_widget_text_priority ); } @@ -1095,32 +1104,82 @@ class MCI_Footnotes_Task { * Replaces footnotes in the content of the current page/post. * * @since 1.5.0 + * + * - Adding: Reference container: optionally per section by shortcode, thanks to @grflukas issue report. + * + * @reporter @grflukas + * @link https://wordpress.org/support/topic/multiple-reference-containers-in-single-post/ + * + * @since 2.7.0 * @param string $p_str_content Page/Post content. * @return string $p_str_content Content with replaced footnotes. */ public function footnotes_in_content( $p_str_content ) { - // phpcs:disable WordPress.PHP.YodaConditions.NotYoda - // Appends the reference container if set to "post_end". - return $this->exec( $p_str_content, 'post_end' === MCI_Footnotes_Settings::instance()->get( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_POSITION ) ); - // phpcs:enable WordPress.PHP.YodaConditions.NotYoda + $l_str_ref_container_position = MCI_Footnotes_Settings::instance()->get( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_POSITION ); + $l_str_footnote_section_shortcode = MCI_Footnotes_Settings::instance()->get( MCI_Footnotes_Settings::C_STR_FOOTNOTE_SECTION_SHORTCODE ); + $l_int_footnote_section_shortcode_length = strlen( $l_str_footnote_section_shortcode ); + + if ( strpos( $p_str_content, $l_str_footnote_section_shortcode ) === false ) { + + // phpcs:disable WordPress.PHP.YodaConditions.NotYoda + // Appends the reference container if set to "post_end". + return $this->exec( $p_str_content, 'post_end' === $l_str_ref_container_position ); + // phpcs:enable WordPress.PHP.YodaConditions.NotYoda + + } else { + + $l_str_rest_content = $p_str_content; + $l_arr_sections_raw = array(); + $l_arr_sections_processed = array(); + + do { + $l_int_section_end = strpos( $l_str_rest_content, $l_str_footnote_section_shortcode ); + $l_arr_sections_raw[] = substr( $l_str_rest_content, 0, $l_int_section_end ); + $l_str_rest_content = substr( $l_str_rest_content, $l_int_section_end + $l_int_footnote_section_shortcode_length ); + } while ( strpos( $l_str_rest_content, $l_str_footnote_section_shortcode ) !== false ); + $l_arr_sections_raw[] = $l_str_rest_content; + + foreach ( $l_arr_sections_raw as $l_str_section ) { + $l_arr_sections_processed[] = self::exec( $l_str_section, true ); + } + + $p_str_content = implode( $l_arr_sections_processed ); + return $p_str_content; + + } } /** - * Replaces existing excerpt with a new one generated on the basis of the post. + * Processes existing excerpt or replaces it with a new one generated on the basis of the post. * * @since 1.5.0 * @param string $p_str_excerpt Excerpt content. - * @return string $p_str_excerpt Excerpt as-is. - * The input was already the processed excerpt, no more footnotes to search. + * @return string $p_str_excerpt Processed or new excerpt. * @since 2.6.2 Debug No option. * @since 2.6.3 Debug Yes option, the setting becomes fully effective. + * + * - Bugfix: Excerpts: make excerpt handling backward compatible, thanks to @mfessler bug report. + * + * @reporter @mfessler + * @link https://github.com/markcheret/footnotes/issues/65 + * + * @since 2.7.0 + * The input was already the processed excerpt, no more footnotes to search. + * But issue #65 brought up that manual excerpts can include processable footnotes. + * Default 'manual' is fallback and is backward compatible with the initial setup. */ public function footnotes_in_excerpt( $p_str_excerpt ) { - if ( MCI_Footnotes_Convert::to_bool( MCI_Footnotes_Settings::instance()->get( MCI_Footnotes_Settings::C_STR_FOOTNOTES_IN_EXCERPT ) ) ) { + $l_str_excerpt_mode = MCI_Footnotes_Settings::instance()->get( MCI_Footnotes_Settings::C_STR_FOOTNOTES_IN_EXCERPT ); + + if ( 'yes' === $l_str_excerpt_mode ) { return $this->generate_excerpt_with_footnotes( $p_str_excerpt ); - } else { + + } elseif ( 'no' === $l_str_excerpt_mode ) { return $this->generate_excerpt( $p_str_excerpt ); + + } else { + return $this->exec( $p_str_excerpt ); } } diff --git a/footnotes.php b/footnotes.php index b334902..311b995 100755 --- a/footnotes.php +++ b/footnotes.php @@ -4,8 +4,8 @@ * Plugin URI: https://wordpress.org/plugins/footnotes/ * Description: time to bring footnotes to your website! footnotes are known from offline publishing and everybody takes them for granted when reading a magazine. * Author: Mark Cheret - * Package V.: 2.6.6 - * Version: 2.6.6 + * Package V.: 2.7.0 + * Version: 2.7.0 * CAUTION: THIS V. FIELD IS PARSED FOR UPDATE CONFIGURATION. * Author URI: https://cheret.org/footnotes/ * Text Domain: footnotes @@ -16,14 +16,14 @@ /** * Package Version number for stylesheet cache busting. * - * Please keep this string in sync with the PACKAGE Version ('Package V.'). - * Please mirror the 'Version' (NOT 'Package V.') in js/wysiwyg-editor.js. + * Please keep this string in sync with the 'Version' (not 'Package V.'). + * Please mirror the 'Version' also in js/wysiwyg-editor.js. * @since 2.1.4 * @since 2.5.3 (Hungarian) * @var str - * @lastmodified 2021-04-13T1011+0200 + * @lastmodified 2021-04-14T2351+0200 */ -define( 'C_STR_PACKAGE_VERSION', '2.6.6' ); +define( 'C_STR_FOOTNOTES_VERSION', '2.7.0' ); /** * Enables toggling the stylesheet enqueuing mode from production (true) to development (false). * @see Full docblock below next. diff --git a/js/wysiwyg-editor.js b/js/wysiwyg-editor.js index 9c55e2a..04aa7e7 100644 --- a/js/wysiwyg-editor.js +++ b/js/wysiwyg-editor.js @@ -69,7 +69,7 @@ author : 'Mark Cheret', authorurl : 'https://cheret.org/footnotes/', infourl : 'https://wordpress.org/plugins/footnotes/', - version : '2.6.6' + version : '2.7.0' }; } }); diff --git a/readme.txt b/readme.txt index 14ca52d..884dbca 100755 --- a/readme.txt +++ b/readme.txt @@ -4,9 +4,9 @@ Tags: footnote, footnotes, bibliography, formatting, notes, Post, posts, referen Requires at least: 3.9 Tested up to: 5.7 Requires PHP: 7.0 -Package Version: 2.6.6 -Version: 2.6.6 -Stable Tag: 2.6.6 +Package Version: 2.7.0 +Version: 2.7.0 +Stable Tag: 2.7.0 CAUTION: THE S. T. FIELD IS PARSED FOR RELEASE CONFIGURATION. License: GPLv3 or later License URI: https://www.gnu.org/licenses/gpl-3.0.html @@ -80,6 +80,11 @@ Visit this swift write-up from a **footnotes** user by the name of **Southwest** == Changelog == += 2.7.0 = +- Adding: Reference container: optionally per section by shortcode, thanks to @grflukas issue report. +- Bugfix: Excerpts: make excerpt handling backward compatible, thanks to @mfessler bug report. +- Bugfix: Dashboard: debug the 'Quick start guide' tab, thanks to @rumperuu bug report. + = 2.6.6 = - Bugfix: Process: fix issue that caused some footnotes to not be processed, thanks to @docteurfitness @rkupadhya @offpeakdesign bug reports. diff --git a/templates/dashboard/settings-reference-container.html b/templates/dashboard/settings-reference-container.html index 0de6a3b..684939b 100644 --- a/templates/dashboard/settings-reference-container.html +++ b/templates/dashboard/settings-reference-container.html @@ -28,6 +28,10 @@ [[label-shortcode]] [[shortcode]] [[notice-shortcode]] + + [[label-section]] + [[section]] [[notice-section]] + [[label-startpage]] [[startpage]] diff --git a/templates/public/amp-footnote-expand.html b/templates/public/amp-footnote-expand.html index c411e43..35adfa9 100644 --- a/templates/public/amp-footnote-expand.html +++ b/templates/public/amp-footnote-expand.html @@ -10,7 +10,7 @@ * @since 2.6.0 (release) * * @contributor @milindmore22 - * @link @link https://github.com/ampproject/amp-wp/issues/5913#issuecomment-785306933 + * @link https://github.com/ampproject/amp-wp/issues/5913#issuecomment-785306933 * * @contributor @westonruter * @link https://github.com/ampproject/amp-wp/issues/5913#issuecomment-785419655 diff --git a/templates/public/amp-footnote.html b/templates/public/amp-footnote.html index f96832b..c30d274 100644 --- a/templates/public/amp-footnote.html +++ b/templates/public/amp-footnote.html @@ -9,7 +9,7 @@ * @since 2.6.0 (release) * * @contributor @milindmore22 - * @link @link https://github.com/ampproject/amp-wp/issues/5913#issuecomment-785306933 + * @link https://github.com/ampproject/amp-wp/issues/5913#issuecomment-785306933 * * @contributor @westonruter * @link https://github.com/ampproject/amp-wp/issues/5913#issuecomment-785419655 From 2f36981b3a46169311c91ee172d1ca50e5967d77 Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Sat, 20 Feb 2021 18:47:11 +0000 Subject: [PATCH 03/42] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 38 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++ 2 files changed, 58 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..dd84ea7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. From 89d5d1a036c28e18d8f456aa282e45dd570ef814 Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Sat, 20 Feb 2021 20:55:46 +0000 Subject: [PATCH 04/42] Add getting started instructions to README --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index e24b6ac..f6a4ac9 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,21 @@ Featured on [wpmudev](http://premium.wpmudev.org/blog/12-surprisingly-useful-wor Unit tests are TODO. +## Getting Started + +1. Read the contributing guidelines +1. Clone this repository (`git clone git@github.com:Rumperuu/footnotes.git`) +1. Install [Composer](https://getcomposer.org/download/), if you don't have it already +1. Install dependencies (`composer install`) +1. Create a new branch from `main` (`git checkout -b `) +1. When you're finished, commit your changes to the remote version of your branch + and submit a [pull request](https://github.com/Rumperuu/footnotes/pulls). + +## Updating Documentation + +1. Install [phpDocumentor](https://phpdoc.org/) +1. Run it (`phpDocumentor -d . -t docs`) + ## Main Features - Fully customizable **footnotes** start and end shortcodes; From 5cd4d165b116183c28d0e5cd45ccddb3c2b0e3ab Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Sun, 21 Feb 2021 11:07:48 +0000 Subject: [PATCH 05/42] Add footnotes header image --- img/footnotes.png | Bin 0 -> 4964 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 img/footnotes.png diff --git a/img/footnotes.png b/img/footnotes.png new file mode 100644 index 0000000000000000000000000000000000000000..a4d82f6c4b6b704625dbf3ee328e81bd0cc2e38b GIT binary patch literal 4964 zcmbVPdpy(s_g{%ViAu~}pGA@DHq2!%xtH8;V`7<^8D`9ciRdETmdbK#Mm54*r^ux! zS+0pLNGfxgB9d!vzo}23-|vs_Nf1I87c|Fhdbd8)8Up|V zL3npBvX_HB977~%p*JyFF@$iwHUMCJI3^s83Bi&<{#YD7%tUdz?ujA@A7G;B33Grr zgj-^R@JA^mtQ*DA9YYDh7zQXFHU$~S!1)FUSTY(ELkJCvgvXdD{;~__^P6I@BIp-{ z9AcvQJ18#)XOJb4gayI0AetD69u%afs|D4C80s2ofV3e{2pFmjhUjZTA#j*J90CRX z^Hbz|BLxJ)U9D{X@x^~KQ4AuJ!{K0Xbab>4M z$7qH{D*drwg^k3J@Zn@UF$}b65$#WmBAY1kBmJEMA>6^?U&CRM{}hT}GH?t!91PWh zfC+@nyndl0$*$P{4dXweBi&=ev0zthBr%GF;qOPF(jR4h?f$!?O&~uSxDyG_-xPGH z6%i9fz=n}+txOd8D_Q~g0Jx30z6}(ruM5%FhUghUq2}7=*4FxZRyq)vjirvY^&cDm zNmtL%+(OsNT*nFq(}qH=bu9D^&CP9ebf6a2Py-z(?2oQ(SR@%8hQa>vi|70OM_2p5 z>cTBaSTvbPawif)|8#(J5Rpub3?hbuEZtyQP>=%}gAd!3Y;Mr+e66q~{7Gzp4T(qq z{i-k={~scNKnx)NJ@enX0so(>f%(CJH{0X?w96k6zXvzjf198G@bCCw!}v2p;t$8} zM;QKG?Y?1aW$qp`FiAHdac#tt<2VxP+;Dq>Jj<+w#8Ia5-cQiZP7CuJLfHzqr zDQ&l7I!eNmm}=w7PJXl7ej0pS$S6T3ZZlh*15CS}ue^2Z=t(X;wr=}rA_|52i|?Yl zLy&(Y004o4d~&<>eU;S5wdHohX~RJxdrfk(8cMvI_AzdV_h4ZJ^lj^>+msD3}kmpf}(^ z<|k1+CDSm zyVW{4CZ|;#XzVesvsZQ=o)=4Za;zG9*h!yllnJPJ z>YHumTC%S95?+_4Hy{tQfaMo*Wi;;y5PA7)2jV@+Y1;iF<8 z#I$t&$Q+eRRbSW0e!2boK$Iv$pyBnA#_#r4<7+u5$_6yV6F%fiMXQ0 zn4Vke+-t)RVm;bH-F7AC#~y4JPu_jrKCF*rUBbRtU@RC*0`E><|e4Cf##GJ+L3$nJe|i=Ag>LHF7|IQA_Ju zS1S(LDMF{NKW4^rsb>x86&j_lSjk;}rzB|sy`iy+HPKcQAjBJumlBCp?Y~@g`>Ro6@s}RpMf=^7{!X(uJzjA4Qmzy%*{^fM zkSe(sC0Z`zQ^V~IK#=?&c{q#V9E>Z~YE+S`i>hz+imDYR;C)ZX zwZ;4Adeks*A4av3f*rPCHnV!>2B)TKB49$o2bJYvRkr)D;Lp>0r6R_p9_M}+h^6NZFSj)}8qM;00oLRW}&x=;fQ^?$7 zJU5nujyP@B_4DHKTM%^~ld=`A0X(b*ZhWEY=m=EHs#ANGwaYF$-873i)c5T>prAw!|DEQ24_=HzWw_V7O zs}nyFIiosVnJ;}EeNmr~V;i^kwpX0dbeF!coFGPv zfzO`b`<;w66H0jitMzy9wu=``L~|<;EHP0k*`Wf1;FgM9((4S)auHqf`EI`_u|Qfn8aUYI<`hWNTZ>Azmzt;CRJ%3ngip;ca5@ z7TU_*r{dn^Mp+3(43t%w9RnY|}tyvMWF6jq=j`IprPwNhj{F3Mjlny6973BU7x}ed>*U-S?%8 zDv0pZmnFPgj_4~BCJLnu+8Nm<8_!p;pWT{bUsc8g%*Nx=UB1t$B1F&jMdzk}$t2%* z(=6JtGBS3YQ)Ta%@SeC)9$`Ij*-4&V^!Uu}IRk_y@RTQ9ohK;h0EB<6l#%KEdGrF) z3h$#o7}3w^*Qm;TcYG@#F~LuHxbcT{izE7nJ7oPJag1o$bwNY1W8#}1A0hVD5^SW5 zz-rE8Eh*FPuUwyGF}d}EwFPkYP~}A`kiPkPuKrr79FS2dBdAJ$cdj~w(h%Sk`%aL( z6)<-`ZuW=rL*#+B4m&Lwt^RVwBA$U1|Ha=uuhmqUANIl0_4qij=W~E4#%Dn~Pj#>4 z_(^Yq0(;B~-V>werp~{}cQ*LC|F)E-5N-#&@>#xW z#k?jWu_6x%wtP{1@-4YWC%Jx4KiQixaisvo4Q>1)4MG5NrDjeXk&DQiJ%rL%@ozTG z^ysPh0)3HELaf+&Mf57A;^yeVkvGQ*u)5)3RCe!IPR4z`;s;BygGmb7UH_nXg7?JW z$@6kRsqu@n@1?&)LaVBT0u(tn~5EcMqnT@Kg6fx-JNw%`PpbMR>D~Wm*W{*(<`)@W_ zY_8K$_Anyjv+j2ThI#Uql@@QFQT3yT@pKw+rm!`GBRpn!1zHRcJIa{QczW$qbP3stDpmOdySI6xOu`}@QO4pLWT=f;QRB4;Epz+ zqy5j_ds{4wtKBC*Mf}2M&G{>n<0J=~?`j=rgAD4j6?fOR>{lp#(*7ap#G$>{8-l{` z)l>96x@bYI=_x?J(3rbYnTP+LtIvHV6L~EyzG0vZTAW9s-^*l41!AKw`9?P=)3=** z9I@iAkLH(5pHo720L;J+Uk{$FRqt$1vgG(&1FD6%ycS9000T2v`hgGfiB8dUHSw-v z8WDqT%R3cTBtm3k{MF}r@=+EXK-CxMNfM=KClW5$<%RdemPzSwib*F1SyP`ctHTFv z5*m$gMF9|HvKKDCG?&CbSNXdrezEs_vv6HJ=FUmmsGB+k%B4rd(jV4!h|s?osm*d^ z84~hvi{Lot+Ow}TINN}l5&Yu>2^5;y$75m}&dpH_A&7?z;_a}2; zO`0Kf!Nh}2uJ-G_8Sx<;bvMgj?nhkN#C$|GyKcHVN934#7W2NTR;&tfX@hfcFEsG` zg{Nz_?pJmOuRntNUVF3ahM~f(ay|L!-s{tj=j3=6;Q0ycbNc&Z&2i7)n>_J!b+Okg z^X&Q>El;G45uYr&p2~rh$mv}NZaDTYZSC^SLWH`A)8$@dr>CbAQKuHi!Lb{rVzjr} zLdVBm6wVALRpmb;pmKQSUDL|Zsk4i638zKHG3glkcR<^UarOpSe{GFhw$U)-wiJ1w zs9OIXBhler z`&0l0?+v!2Mw^#SgANbxBIam6Du_^fw|f<7d-ms1t9QnB%T%QyExUx4vwfa4t=)|G zNIY6i?P&zn>hR?+`}g|_o%g!-iHs;$;V}zKyTZn0M+C;n*6^@dBMDiVA9|f)<5ZZx z(R`10>w6?K3kWa;u(xXZsr)F+7-V~0)|{?HPyf0u@ Date: Sat, 20 Feb 2021 19:55:52 +0000 Subject: [PATCH 06/42] Generate HTML documentation using phpDocumentor --- docs/classes/MCI-Footnotes-Config.html | 504 ++ docs/classes/MCI-Footnotes-Convert.html | 759 ++ docs/classes/MCI-Footnotes-Hooks.html | 526 ++ docs/classes/MCI-Footnotes-Language.html | 493 ++ .../MCI-Footnotes-Layout-Diagnostics.html | 2290 ++++++ docs/classes/MCI-Footnotes-Layout-Init.html | 759 ++ .../MCI-Footnotes-Layout-Settings.html | 3757 ++++++++++ docs/classes/MCI-Footnotes-LayoutEngine.html | 2222 ++++++ docs/classes/MCI-Footnotes-Settings.html | 6221 +++++++++++++++++ docs/classes/MCI-Footnotes-Task.html | 2902 ++++++++ docs/classes/MCI-Footnotes-Template.html | 1044 +++ docs/classes/MCI-Footnotes-WYSIWYG.html | 492 ++ ...I-Footnotes-Widget-ReferenceContainer.html | 688 ++ docs/classes/MCI-Footnotes-WidgetBase.html | 529 ++ docs/classes/MCI-Footnotes.html | 873 +++ docs/css/base.css | 1002 +++ docs/css/normalize.css | 427 ++ docs/css/template.css | 169 + docs/files/class-config.html | 121 + docs/files/class-convert.html | 121 + docs/files/class-dashboard-init.html | 121 + docs/files/class-dashboard-layout.html | 121 + .../class-dashboard-subpage-diagnostics.html | 121 + docs/files/class-dashboard-subpage-main.html | 121 + docs/files/class-hooks.html | 121 + docs/files/class-init.html | 121 + docs/files/class-language.html | 121 + docs/files/class-settings.html | 121 + docs/files/class-task.html | 121 + docs/files/class-template.html | 121 + docs/files/class-widgets-base.html | 121 + .../class-widgets-reference-container.html | 121 + docs/files/class-wysiwyg.html | 121 + docs/files/footnotes.html | 110 + docs/files/includes.html | 190 + docs/graphs/classes.html | 97 + docs/index.html | 223 + docs/indices/files.html | 142 + docs/js/search.js | 173 + docs/js/searchIndex.js | 1419 ++++ docs/namespaces/default.html | 227 + docs/packages/Default.html | 227 + docs/packages/default.html | 116 + docs/reports/deprecated.html | 106 + docs/reports/errors.html | 174 + docs/reports/markers.html | 128 + 46 files changed, 30804 insertions(+) create mode 100644 docs/classes/MCI-Footnotes-Config.html create mode 100644 docs/classes/MCI-Footnotes-Convert.html create mode 100644 docs/classes/MCI-Footnotes-Hooks.html create mode 100644 docs/classes/MCI-Footnotes-Language.html create mode 100644 docs/classes/MCI-Footnotes-Layout-Diagnostics.html create mode 100644 docs/classes/MCI-Footnotes-Layout-Init.html create mode 100644 docs/classes/MCI-Footnotes-Layout-Settings.html create mode 100644 docs/classes/MCI-Footnotes-LayoutEngine.html create mode 100644 docs/classes/MCI-Footnotes-Settings.html create mode 100644 docs/classes/MCI-Footnotes-Task.html create mode 100644 docs/classes/MCI-Footnotes-Template.html create mode 100644 docs/classes/MCI-Footnotes-WYSIWYG.html create mode 100644 docs/classes/MCI-Footnotes-Widget-ReferenceContainer.html create mode 100644 docs/classes/MCI-Footnotes-WidgetBase.html create mode 100644 docs/classes/MCI-Footnotes.html create mode 100644 docs/css/base.css create mode 100644 docs/css/normalize.css create mode 100644 docs/css/template.css create mode 100644 docs/files/class-config.html create mode 100644 docs/files/class-convert.html create mode 100644 docs/files/class-dashboard-init.html create mode 100644 docs/files/class-dashboard-layout.html create mode 100644 docs/files/class-dashboard-subpage-diagnostics.html create mode 100644 docs/files/class-dashboard-subpage-main.html create mode 100644 docs/files/class-hooks.html create mode 100644 docs/files/class-init.html create mode 100644 docs/files/class-language.html create mode 100644 docs/files/class-settings.html create mode 100644 docs/files/class-task.html create mode 100644 docs/files/class-template.html create mode 100644 docs/files/class-widgets-base.html create mode 100644 docs/files/class-widgets-reference-container.html create mode 100644 docs/files/class-wysiwyg.html create mode 100644 docs/files/footnotes.html create mode 100644 docs/files/includes.html create mode 100644 docs/graphs/classes.html create mode 100644 docs/index.html create mode 100644 docs/indices/files.html create mode 100644 docs/js/search.js create mode 100644 docs/js/searchIndex.js create mode 100644 docs/namespaces/default.html create mode 100644 docs/packages/Default.html create mode 100644 docs/packages/default.html create mode 100644 docs/reports/deprecated.html create mode 100644 docs/reports/errors.html create mode 100644 docs/reports/markers.html diff --git a/docs/classes/MCI-Footnotes-Config.html b/docs/classes/MCI-Footnotes-Config.html new file mode 100644 index 0000000..57b1506 --- /dev/null +++ b/docs/classes/MCI-Footnotes-Config.html @@ -0,0 +1,504 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
+

Documentation

+ + +
+ +
+ + +
+ +
+
+ + + + +
+ + +
+

+ MCI_Footnotes_Config + + + + +

+ + + +

Contains all Plugin Constants. Contains no Method or Property.

+ +
+ + +
+ Tags + +
+
+
+ author +
+
+ +

Stefan Herndler

+
+ +
+
+ since +
+
+ 1.5.0 + +
+ +
+
+ + + + + + +

+ Table of Contents + +

+ +
+
+ C_STR_LOVE_SYMBOL + +  = '<span style="color:#ff6d3b; font-weight:bold;">&hearts;</span>' +
+
Html tag for the LOVE symbol.
+ +
+ C_STR_LOVE_SYMBOL_HEADING + +  = '<span class="footnotes_heart_heading">&hearts;</span>' +
+
HTML code for the 'love' symbol used in dashboard heading
+ +
+ C_STR_NO_LOVE_SLUG + +  = '[[no footnotes: love]]' +
+
Short code to DON'T display the 'LOVE ME' slug on certain pages.
+ +
+ C_STR_PLUGIN_HEADING_NAME + +  = '<span class="footnotes_logo_heading footnotes_logo_part1_heading">foot</span><span class="footnotes_logo_heading footnotes_logo_part2_heading">notes</span>' +
+
Public Plugin name for dashboard heading
+ +
+ C_STR_PLUGIN_NAME + +  = "footnotes" +
+
Internal Plugin name.
+ +
+ C_STR_PLUGIN_PUBLIC_NAME + +  = '<span class="footnotes_logo footnotes_logo_part1">foot</span><span class="footnotes_logo footnotes_logo_part2">notes</span>' +
+
Public Plugin name.
+ +
+ + + + +
+

+ Constants + +

+
+

+ C_STR_LOVE_SYMBOL + +

+ + + +

Html tag for the LOVE symbol.

+ + + public + string + C_STR_LOVE_SYMBOL + = '<span style="color:#ff6d3b; font-weight:bold;">&hearts;</span>' + + + +
+ + +
+ Tags + +
+
+
+ author +
+
+ +

Stefan Herndler

+
+ +
+
+ since +
+
+ 1.5.0 + +
+ +
+
+ +
+
+

+ C_STR_LOVE_SYMBOL_HEADING + +

+ + + +

HTML code for the 'love' symbol used in dashboard heading

+ + + public + string + C_STR_LOVE_SYMBOL_HEADING + = '<span class="footnotes_heart_heading">&hearts;</span>' + + + +
+ + +
+ Tags + +
+
+
+ since +
+
+ 2.0.4 + +
+ +
+
+ +
+
+

+ C_STR_NO_LOVE_SLUG + +

+ + + +

Short code to DON'T display the 'LOVE ME' slug on certain pages.

+ + + public + string + C_STR_NO_LOVE_SLUG + = '[[no footnotes: love]]' + + + +
+ + +
+ Tags + +
+
+
+ author +
+
+ +

Stefan Herndler

+
+ +
+
+ since +
+
+ 1.5.0 + +
+ +
+
+ +
+
+

+ C_STR_PLUGIN_HEADING_NAME + +

+ + + +

Public Plugin name for dashboard heading

+ + + public + string + C_STR_PLUGIN_HEADING_NAME + = '<span class="footnotes_logo_heading footnotes_logo_part1_heading">foot</span><span class="footnotes_logo_heading footnotes_logo_part2_heading">notes</span>' + + + +

After properly displaying in dashboard headings until WPv5.4, the above started +in WPv5.5 being torn apart as if the headline was text-align:justify and not +the last line. That ugly display bug badly affected the plugin’s communication. +The only working solution found so far is using position:fixed in one heading +that isn’t translated, and dropping the logo in another, translatable heading.

+
+ + +
+ Tags + +
+
+
+ since +
+
+ 2.0.4 + +
+ +
+
+ +
+
+

+ C_STR_PLUGIN_NAME + +

+ + + +

Internal Plugin name.

+ + + public + string + C_STR_PLUGIN_NAME + = "footnotes" + + + +
+ + +
+ Tags + +
+
+
+ author +
+
+ +

Stefan Herndler

+
+ +
+
+ since +
+
+ 1.5.0 + +
+ +
+
+ +
+
+

+ C_STR_PLUGIN_PUBLIC_NAME + +

+ + + +

Public Plugin name.

+ + + public + string + C_STR_PLUGIN_PUBLIC_NAME + = '<span class="footnotes_logo footnotes_logo_part1">foot</span><span class="footnotes_logo footnotes_logo_part2">notes</span>' + + + +
+ + +
+ Tags + +
+
+
+ author +
+
+ +

Stefan Herndler

+
+ +
+
+ since +
+
+ 1.5.0 + +
+ +
+
+ +
+
+ + + + +
+
+
+
+

Search results

+ +
+
+
    +
    +
    +
    +
    +
    + + +
    + + + + diff --git a/docs/classes/MCI-Footnotes-Convert.html b/docs/classes/MCI-Footnotes-Convert.html new file mode 100644 index 0000000..ebb56d9 --- /dev/null +++ b/docs/classes/MCI-Footnotes-Convert.html @@ -0,0 +1,759 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
    +

    Documentation

    + + +
    + +
    + + +
    + +
    +
    + + + + +
    + + +
    +

    + MCI_Footnotes_Convert + + + + +

    + + + +

    Converts data types and Footnotes specific values.

    + +
    + + +
    + Tags + +
    +
    +
    + author +
    +
    + +

    Stefan Herndler

    +
    + +
    +
    + since +
    +
    + 1.5.0 + +
    + +
    +
    + + + + + + +

    + Table of Contents + +

    + +
    +
    + debug() + +  : mixed +
    +
    Displays a Variable.
    + +
    + getArrow() + +  : array<string|int, mixed>|string +
    +
    Get a html Array short code depending on Arrow-Array key index.
    + +
    + Index() + +  : string +
    +
    Converts a integer into the user-defined counter style for the footnotes.
    + +
    + toBool() + +  : bool +
    +
    Converts a string depending on its value to a boolean.
    + +
    + toArabicLeading() + +  : string +
    +
    Converts an integer to a leading-0 integer.
    + +
    + toLatin() + +  : string +
    +
    Converts an integer into latin ascii characters, either lower or upper-case.
    + +
    + toRomanic() + +  : string +
    +
    Converts an integer to a romanic letter.
    + +
    + + + + + + + +
    +

    + Methods + +

    +
    +

    + debug() + +

    + + +

    Displays a Variable.

    + + + public + static debug(mixed $p_mixed_Value) : mixed + +
    + +
    Parameters
    +
    +
    + $p_mixed_Value + : mixed +
    +
    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + author +
    +
    + +

    Stefan Herndler

    +
    + +
    +
    + since +
    +
    + 1.5.0 + +
    + +
    +
    + +
    Return values
    + mixed + — +
    + + +
    +
    +

    + getArrow() + +

    + + +

    Get a html Array short code depending on Arrow-Array key index.

    + + + public + static getArrow([int $p_int_Index = -1 ]) : array<string|int, mixed>|string + +
    + +
    Parameters
    +
    +
    + $p_int_Index + : int + = -1
    +
    +

    Index representing the Arrow. If empty all Arrows are specified.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + author +
    +
    + +

    Stefan Herndler

    +
    + +
    +
    + since +
    +
    + 1.3.2 + +
    + +
    +
    + +
    Return values
    + array<string|int, mixed>|string + — +

    Array of all Arrows if Index is empty otherwise html tag of a specific arrow.

    +
    + + +
    +
    +

    + Index() + +

    + + +

    Converts a integer into the user-defined counter style for the footnotes.

    + + + public + static Index(int $p_int_Index[, string $p_str_ConvertStyle = "arabic_plain" ]) : string + +
    + +
    Parameters
    +
    +
    + $p_int_Index + : int +
    +
    +

    Index to be converted.

    +
    + +
    +
    + $p_str_ConvertStyle + : string + = "arabic_plain"
    +
    +

    Style of the new/converted Index.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + author +
    +
    + +

    Stefan Herndler

    +
    + +
    +
    + since +
    +
    + 1.5.0 + +
    + +
    +
    + since +
    +
    + 2.2.0 + +

    lowercase Roman numerals supported

    +
    + +
    +
    + +
    Return values
    + string + — +

    Converted Index as string in the defined counter style.

    +

    Edited:

    +
    + + +
    +
    +

    + toBool() + +

    + + +

    Converts a string depending on its value to a boolean.

    + + + public + static toBool(string $p_str_Value) : bool + +
    + +
    Parameters
    +
    +
    + $p_str_Value + : string +
    +
    +

    String to be converted to boolean.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + author +
    +
    + +

    Stefan Herndler

    +
    + +
    +
    + since +
    +
    + 1.0-beta + +
    + +
    +
    + +
    Return values
    + bool + — +

    Boolean representing the string.

    +
    + + +
    +
    +

    + toArabicLeading() + +

    + + +

    Converts an integer to a leading-0 integer.

    + + + private + static toArabicLeading(int $p_int_Value) : string + +
    + +
    Parameters
    +
    +
    + $p_int_Value + : int +
    +
    +

    Value/Index to be converted.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + author +
    +
    + +

    Stefan Herndler

    +
    + +
    +
    + since +
    +
    + 1.0-gamma + +
    + +
    +
    + +
    Return values
    + string + — +

    Value with a leading zero.

    +
    + + +
    +
    +

    + toLatin() + +

    + + +

    Converts an integer into latin ascii characters, either lower or upper-case.

    + + + private + static toLatin(int $p_int_Value, bool $p_bool_UpperCase) : string + +

    Function available from A to ZZ ( means 676 footnotes at 1 page possible).

    +
    + +
    Parameters
    +
    +
    + $p_int_Value + : int +
    +
    +

    Value/Index to be converted.

    +
    + +
    +
    + $p_bool_UpperCase + : bool +
    +
    +

    True to convert the value to upper case letter, otherwise to lower case.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + author +
    +
    + +

    Stefan Herndler

    +
    + +
    +
    + since +
    +
    + 1.0-gamma + +
    + +
    +
    + +
    Return values
    + string + — +
    + + +
    +
    +

    + toRomanic() + +

    + + +

    Converts an integer to a romanic letter.

    + + + private + static toRomanic(int $p_int_Value, mixed $p_bool_UpperCase) : string + +
    + +
    Parameters
    +
    +
    + $p_int_Value + : int +
    +
    +

    Value/Index to be converted.

    +
    + +
    +
    + $p_bool_UpperCase + : mixed +
    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + author +
    +
    + +

    Stefan Herndler

    +
    + +
    +
    + since +
    +
    + 1.0-gamma + +
    + +
    +
    + since +
    +
    + 2.2.0 + +

    optionally lowercase (code from Latin) 2020-12-12T1538+0100

    +
    + +
    +
    + +
    Return values
    + string + — +

    Edited:

    +
    + + +
    +
    + +
    +
    +
    +
    +

    Search results

    + +
    +
    +
      +
      +
      +
      +
      +
      + + +
      + + + + diff --git a/docs/classes/MCI-Footnotes-Hooks.html b/docs/classes/MCI-Footnotes-Hooks.html new file mode 100644 index 0000000..eb710f1 --- /dev/null +++ b/docs/classes/MCI-Footnotes-Hooks.html @@ -0,0 +1,526 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
      +

      Documentation

      + + +
      + +
      + + +
      + +
      +
      + + + + +
      + + +
      +

      + MCI_Footnotes_Hooks + + + + +

      + + + +

      Registers all WordPress Hooks and executes them on demand.

      + +
      + + +
      + Tags + +
      +
      +
      + author +
      +
      + +

      Stefan Herndler

      +
      + +
      +
      + since +
      +
      + 1.5.0 + +
      + +
      +
      + + + + + + +

      + Table of Contents + +

      + +
      +
      + activatePlugin() + +  : mixed +
      +
      Executed when the Plugin gets activated.
      + +
      + deactivatePlugin() + +  : mixed +
      +
      Executed when the Plugin gets deactivated.
      + +
      + PluginLinks() + +  : array<string|int, mixed> +
      +
      Add Links to the Plugin in the "installed Plugins" page.
      + +
      + registerHooks() + +  : mixed +
      +
      Registers all WordPress hooks.
      + +
      + uninstallPlugin() + +  : mixed +
      +
      Executed when the Plugin gets uninstalled.
      + +
      + + + + + + + +
      +

      + Methods + +

      +
      +

      + activatePlugin() + +

      + + +

      Executed when the Plugin gets activated.

      + + + public + static activatePlugin() : mixed + +
      + + + +
      + Tags + +
      +
      +
      + author +
      +
      + +

      Stefan Herndler

      +
      + +
      +
      + since +
      +
      + 1.5.0 + +
      + +
      +
      + +
      Return values
      + mixed + — +
      + + +
      +
      +

      + deactivatePlugin() + +

      + + +

      Executed when the Plugin gets deactivated.

      + + + public + static deactivatePlugin() : mixed + +
      + + + +
      + Tags + +
      +
      +
      + author +
      +
      + +

      Stefan Herndler

      +
      + +
      +
      + since +
      +
      + 1.5.0 + +
      + +
      +
      + +
      Return values
      + mixed + — +
      + + +
      +
      +

      + PluginLinks() + +

      + + +

      Add Links to the Plugin in the "installed Plugins" page.

      + + + public + static PluginLinks(array<string|int, mixed> $p_arr_Links, string $p_str_PluginFileName) : array<string|int, mixed> + +
      + +
      Parameters
      +
      +
      + $p_arr_Links + : array<string|int, mixed> +
      +
      +

      Current Links.

      +
      + +
      +
      + $p_str_PluginFileName + : string +
      +
      +

      Plugins init file name.

      +
      + +
      +
      + + +
      + Tags + +
      +
      +
      + author +
      +
      + +

      Stefan Herndler

      +
      + +
      +
      + since +
      +
      + 1.5.0 + +
      + +
      +
      + +
      Return values
      + array<string|int, mixed> + — +
      + + +
      +
      +

      + registerHooks() + +

      + + +

      Registers all WordPress hooks.

      + + + public + static registerHooks() : mixed + +
      + + + +
      + Tags + +
      +
      +
      + author +
      +
      + +

      Stefan Herndler

      +
      + +
      +
      + since +
      +
      + 1.5.0 + +
      + +
      +
      + +
      Return values
      + mixed + — +
      + + +
      +
      +

      + uninstallPlugin() + +

      + + +

      Executed when the Plugin gets uninstalled.

      + + + public + static uninstallPlugin() : mixed + +
      + + + +
      + Tags + +
      +
      +
      + author +
      +
      + +

      Stefan Herndler

      +
      + +
      +
      + since +
      +
      + 1.5.0 + +

      Edit: ClearAll didn’t actually work.

      +
      + +
      +
      + since +
      +
      + 2.2.0 + +

      this function is not called any longer when deleting the plugin

      +
      + +
      +
      + +
      Return values
      + mixed + — +
      + + +
      +
      + +
      +
      +
      +
      +

      Search results

      + +
      +
      +
        +
        +
        +
        +
        +
        + + +
        + + + + diff --git a/docs/classes/MCI-Footnotes-Language.html b/docs/classes/MCI-Footnotes-Language.html new file mode 100644 index 0000000..ebf670f --- /dev/null +++ b/docs/classes/MCI-Footnotes-Language.html @@ -0,0 +1,493 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
        +

        Documentation

        + + +
        + +
        + + +
        + +
        +
        + + + + +
        + + +
        +

        + MCI_Footnotes_Language + + + + +

        + + + +

        Loads text domain of current or default language for localization.

        + +
        + + +
        + Tags + +
        +
        +
        + author +
        +
        + +

        Stefan Herndler

        +
        + +
        +
        + since +
        +
        + 1.5.0 + +
        + +
        +
        + + + + + + +

        + Table of Contents + +

        + +
        +
        + loadTextDomain() + +  : mixed +
        +
        Loads the text domain for current WordPress language if exists.
        + +
        + registerHooks() + +  : mixed +
        +
        Register WordPress Hook.
        + +
        + load() + +  : bool +
        +
        Loads a specific text domain.
        + +
        + + + + + + + +
        +

        + Methods + +

        +
        +

        + loadTextDomain() + +

        + + +

        Loads the text domain for current WordPress language if exists.

        + + + public + static loadTextDomain() : mixed + +

        Otherwise fallback "en_GB" will be loaded.

        +
        + + + +
        + Tags + +
        +
        +
        + author +
        +
        + +

        Stefan Herndler

        +
        + +
        +
        + since +
        +
        + 1.5.0 + +
          +
        • Bugfix: Correct function call apply_filters() with all required arguments after PHP 7.1 promoted warning to error, thanks to @matkus2 bug report and code contribution.
          • +
        +
        + +
        +
        + since +
        +
        + 2.0.0 + +
        + +
        +
        + date +
        +
        + +

        2020-10-26T1609+0100

        +
        + +
        +
        + contributor +
        +
        + +

        @matkus2

        +
        + +
        +
        + link +
        +
        +

        Add 3rd (empty) argument in apply_filters() to prevent PHP from throwing an error: +“Fatal error: Uncaught ArgumentCountError: Too few arguments to function apply_filters()”

        +

        Yet get_locale() is defined w/o parameters in wp-includes/l10n.php:30, and +apply_filters() is defined as apply_filters( $tag, $value ) in wp-includes/plugin.php:181.

        +         + +
        +
        + link +
        +
        +

        But apply_filters() is defined with a 3rd parameter (and w/o the first one) in +wp-includes/class-wp-hook.php:264, as public function apply_filters( $value, $args ).

        +

        Taking it all together, probably the full function definition would be: +public function apply_filters( $tag, $value, $args ). +In the case of get_locale(), $args is empty.

        +

        The bug was lurking in WP. PHP 7.1 promoted the warning to an error.

        +         + +
        +
        + link +
        +
        + https://www.php.net/manual/en/migration71.incompatible.php + +
        +
        + link +
        +
        + https://www.php.net/manual/en/migration71.incompatible.php#migration71.incompatible.too-few-arguments-exception + +
        +
        + +
        Return values
        + mixed + — +
        + + +
        +
        +

        + registerHooks() + +

        + + +

        Register WordPress Hook.

        + + + public + static registerHooks() : mixed + +
        + + + +
        + Tags + +
        +
        +
        + author +
        +
        + +

        Stefan Herndler

        +
        + +
        +
        + since +
        +
        + 1.5.0 + +
        + +
        +
        + +
        Return values
        + mixed + — +
        + + +
        +
        +

        + load() + +

        + + +

        Loads a specific text domain.

        + + + private + static load(string $p_str_LanguageCode) : bool + +
        + +
        Parameters
        +
        +
        + $p_str_LanguageCode + : string +
        +
        +

        Language Code to load a specific text domain.

        +
        + +
        +
        + + +
        + Tags + +
        +
        +
        + author +
        +
        + +

        Stefan Herndler

        +
        + +
        +
        + since +
        +
        + 1.5.1 + +
        + +
        +
        + since +
        +
        + 2.1.6 + +
        + +
        +
        + date +
        +
        + +

        2020-12-08T1931+0100

        +
        + +
        +
        + reporter +
        +
        + +

        @nikelaos

        +
        + +
        +
        + link +
        +
        +

        That is done by using load_plugin_textdomain(): +“The .mo file should be named based on the text domain with a dash, and then the locale exactly.”

        +         + +
        +
        + see +
        +
        + +

        wp-includes/l10n.php:857

        +
        + +
        +
        + +
        Return values
        + bool + — +
          +
        • Bugfix: Localization: conform to WordPress plugin language file name scheme, thanks to @nikelaos bug report.
          • +
        +
        + + +
        +
        + +
        +
        +
        +
        +

        Search results

        + +
        +
        +
          +
          +
          +
          +
          +
          + + +
          + + + + diff --git a/docs/classes/MCI-Footnotes-Layout-Diagnostics.html b/docs/classes/MCI-Footnotes-Layout-Diagnostics.html new file mode 100644 index 0000000..d00152d --- /dev/null +++ b/docs/classes/MCI-Footnotes-Layout-Diagnostics.html @@ -0,0 +1,2290 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
          +

          Documentation

          + + +
          + +
          + + +
          + +
          +
          + + + + +
          + + +
          +

          + MCI_Footnotes_Layout_Diagnostics + + + extends MCI_Footnotes_LayoutEngine + + + + +

          + + + +

          Displays Diagnostics of the web server, PHP and WordPress.

          + +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + + + + + + +

          + Table of Contents + +

          + +
          +
          + $a_arr_Sections + +  : array<string|int, mixed> +
          +
          Stores all Sections for the child sub page.
          + +
          + $a_str_SubPageHook + +  : null|string +
          +
          Stores the Hook connection string for the child sub page.
          + +
          + Description() + +  : mixed +
          +
          Output the Description of a section. May be overwritten in any section.
          + +
          + Diagnostics() + +  : mixed +
          +
          Displays a diagnostics about the web server, php and WordPress.
          + +
          + displayContent() + +  : mixed +
          +
          Displays the content of specific sub page.
          + +
          + getPriority() + +  : int +
          +
          Returns a Priority index. Lower numbers have a higher Priority.
          + +
          + registerSections() + +  : mixed +
          +
          Registers all sections for a sub page.
          + +
          + registerSubPage() + +  : mixed +
          +
          Registers a sub page.
          + +
          + addCheckbox() + +  : string +
          +
          Returns the html tag for an input [type = checkbox].
          + +
          + addColorSelection() + +  : string +
          +
          Returns the html tag for an input [type = text] with color selection class.
          + +
          + addLabel() + +  : string +
          +
          Returns the html tag for an input/select label.
          + +
          + addLineSpace() + +  : string +
          +
          Returns a line break to have a space between two lines.
          + +
          + addMetaBox() + +  : array<string|int, mixed> +
          +
          Returns an array describing a meta box.
          + +
          + addNewline() + +  : string +
          +
          Returns a line break to start a new line.
          + +
          + addNumBox() + +  : string +
          +
          Returns the html tag for an input [type = num].
          + +
          + addSection() + +  : array<string|int, mixed> +
          +
          Returns an array describing a sub page section.
          + +
          + addSelectBox() + +  : string +
          +
          Returns the html tag for a select box.
          + +
          + addText() + +  : string +
          +
          Returns a simple text inside html <span> text.
          + +
          + addTextArea() + +  : string +
          +
          Returns the html tag for a text area.
          + +
          + addTextBox() + +  : string +
          +
          Returns the html tag for an input [type = text].
          + +
          + getMetaBoxes() + +  : array<string|int, mixed> +
          +
          Returns an array of all registered meta boxes for each section of the sub page.
          + +
          + getSections() + +  : array<string|int, mixed> +
          +
          Returns an array of all registered sections for the sub page.
          + +
          + getSubPageSlug() + +  : string +
          +
          Returns the unique slug of the sub page.
          + +
          + getSubPageTitle() + +  : string +
          +
          Returns the title of the sub page.
          + +
          + LoadSetting() + +  : array<string|int, mixed> +
          +
          Loads specific setting and returns an array with the keys [id, name, value].
          + +
          + appendScripts() + +  : mixed +
          +
          Append javascript and css files for specific sub page.
          + +
          + registerMetaBoxes() + +  : mixed +
          +
          Registers all Meta boxes for a sub page.
          + +
          + saveSettings() + +  : bool +
          +
          Save all Plugin settings.
          + +
          + + + + + + +
          +

          + Properties + +

          +
          +

          + $a_arr_Sections + + + +

          + + +

          Stores all Sections for the child sub page.

          + + + protected + array<string|int, mixed> + $a_arr_Sections + = array() + +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          +
          +

          + $a_str_SubPageHook + + + +

          + + +

          Stores the Hook connection string for the child sub page.

          + + + protected + null|string + $a_str_SubPageHook + = +ull + +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          +
          + +
          +

          + Methods + +

          +
          +

          + Description() + +

          + + +

          Output the Description of a section. May be overwritten in any section.

          + + + public + Description() : mixed + +
          + + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + mixed + — +
          + + +
          +
          +

          + Diagnostics() + +

          + + +

          Displays a diagnostics about the web server, php and WordPress.

          + + + public + Diagnostics() : mixed + +
          + + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + mixed + — +
          + + +
          +
          +

          + displayContent() + +

          + + +

          Displays the content of specific sub page.

          + + + public + displayContent() : mixed + +
          + + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + mixed + — +
          + + +
          +
          +

          + getPriority() + +

          + + +

          Returns a Priority index. Lower numbers have a higher Priority.

          + + + public + getPriority() : int + +
          + + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + int + — +
          + + +
          +
          +

          + registerSections() + +

          + + +

          Registers all sections for a sub page.

          + + + public + registerSections() : mixed + +
          + + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + mixed + — +
          + + +
          +
          +

          + registerSubPage() + +

          + + +

          Registers a sub page.

          + + + public + registerSubPage() : mixed + +
          + + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + mixed + — +
          + + +
          +
          +

          + addCheckbox() + +

          + + +

          Returns the html tag for an input [type = checkbox].

          + + + protected + addCheckbox(string $p_str_SettingName) : string + +
          + +
          Parameters
          +
          +
          + $p_str_SettingName + : string +
          +
          +

          Name of the Settings key to pre load the input field.

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + string + — +
          + + +
          +
          +

          + addColorSelection() + +

          + + +

          Returns the html tag for an input [type = text] with color selection class.

          + + + protected + addColorSelection(string $p_str_SettingName) : string + +
          + +
          Parameters
          +
          +
          + $p_str_SettingName + : string +
          +
          +

          Name of the Settings key to pre load the input field.

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.6 + +
          + +
          +
          + +
          Return values
          + string + — +
          + + +
          +
          +

          + addLabel() + +

          + + +

          Returns the html tag for an input/select label.

          + + + protected + addLabel(string $p_str_SettingName, string $p_str_Caption) : string + +
          + +
          Parameters
          +
          +
          + $p_str_SettingName + : string +
          +
          +

          Name of the Settings key to connect the Label with the input/select field.

          +
          + +
          +
          + $p_str_Caption + : string +
          +
          +

          Label caption.

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + since +
          +
          + 2.1.6 + +

          no colon

          +
          + +
          +
          + +
          Return values
          + string + — +

          Edited 2020-12-01T0159+0100..

          +
          + + +
          +
          +

          + addLineSpace() + +

          + + +

          Returns a line break to have a space between two lines.

          + + + protected + addLineSpace() : string + +
          + + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + string + — +
          + + +
          +
          +

          + addMetaBox() + +

          + + +

          Returns an array describing a meta box.

          + + + protected + addMetaBox(string $p_str_SectionID, string $p_str_ID, string $p_str_Title, string $p_str_CallbackFunctionName) : array<string|int, mixed> + +
          + +
          Parameters
          +
          +
          + $p_str_SectionID + : string +
          +
          +

          Parent Section ID.

          +
          + +
          +
          + $p_str_ID + : string +
          +
          +

          Unique ID suffix.

          +
          + +
          +
          + $p_str_Title + : string +
          +
          +

          Title for the meta box.

          +
          + +
          +
          + $p_str_CallbackFunctionName + : string +
          +
          +

          Class method name for callback.

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + array<string|int, mixed> + — +

          meta box description to be able to append a meta box to the output.

          +
          + + +
          +
          +

          + addNewline() + +

          + + +

          Returns a line break to start a new line.

          + + + protected + addNewline() : string + +
          + + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + string + — +
          + + +
          +
          +

          + addNumBox() + +

          + + +

          Returns the html tag for an input [type = num].

          + + + protected + addNumBox(string $p_str_SettingName, int $p_in_Min, int $p_int_Max[, bool $p_bool_Deci = false ]) : string + +
          + +
          Parameters
          +
          +
          + $p_str_SettingName + : string +
          +
          +

          Name of the Settings key to pre load the input field.

          +
          + +
          +
          + $p_in_Min + : int +
          +
          +

          Minimum value.

          +
          + +
          +
          + $p_int_Max + : int +
          +
          +

          Maximum value.

          +
          + +
          +
          + $p_bool_Deci + : bool + = false
          +
          +

          true if 0.1 steps and floating to string, false if integer (default)

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + since +
          +
          + 2.1.4 + +

          step argument and number_format() to allow decimals 2020-12-03T0631+0100..2020-12-12T1110+0100

          +
          + +
          +
          + +
          Return values
          + string + — +

          Edited:

          +
          + + +
          +
          +

          + addSection() + +

          + + +

          Returns an array describing a sub page section.

          + + + protected + addSection(string $p_str_ID, string $p_str_Title, int $p_int_SettingsContainerIndex[, bool $p_bool_hasSubmitButton = true ]) : array<string|int, mixed> + +
          + +
          Parameters
          +
          +
          + $p_str_ID + : string +
          +
          +

          Unique ID suffix.

          +
          + +
          +
          + $p_str_Title + : string +
          +
          +

          Title of the section.

          +
          + +
          +
          + $p_int_SettingsContainerIndex + : int +
          +
          +

          Settings Container Index.

          +
          + +
          +
          + $p_bool_hasSubmitButton + : bool + = true
          +
          +

          Should a Submit Button be displayed for this section, default: true.

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + array<string|int, mixed> + — +

          Array describing the section.

          +
          + + +
          +
          +

          + addSelectBox() + +

          + + +

          Returns the html tag for a select box.

          + + + protected + addSelectBox(string $p_str_SettingName, array<string|int, mixed> $p_arr_Options) : string + +
          + +
          Parameters
          +
          +
          + $p_str_SettingName + : string +
          +
          +

          Name of the Settings key to pre select the current value.

          +
          + +
          +
          + $p_arr_Options + : array<string|int, mixed> +
          +
          +

          Possible options to be selected.

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + string + — +
          + + +
          +
          +

          + addText() + +

          + + +

          Returns a simple text inside html <span> text.

          + + + protected + addText(string $p_str_Text) : string + +
          + +
          Parameters
          +
          +
          + $p_str_Text + : string +
          +
          +

          Message to be surrounded with simple html tag (span).

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + string + — +
          + + +
          +
          +

          + addTextArea() + +

          + + +

          Returns the html tag for a text area.

          + + + protected + addTextArea(string $p_str_SettingName) : string + +
          + +
          Parameters
          +
          +
          + $p_str_SettingName + : string +
          +
          +

          Name of the Settings key to pre fill the text area.

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + string + — +
          + + +
          +
          +

          + addTextBox() + +

          + + +

          Returns the html tag for an input [type = text].

          + + + protected + addTextBox(string $p_str_SettingName[, int $p_str_MaxLength = 999 ][, bool $p_bool_Readonly = false ][, bool $p_bool_Hidden = false ]) : string + +
          + +
          Parameters
          +
          +
          + $p_str_SettingName + : string +
          +
          +

          Name of the Settings key to pre load the input field.

          +
          + +
          +
          + $p_str_MaxLength + : int + = 999
          +
          +

          Maximum length of the input, default 999 characters.

          +
          + +
          +
          + $p_bool_Readonly + : bool + = false
          +
          +

          Set the input to be read only, default false.

          +
          + +
          +
          + $p_bool_Hidden + : bool + = false
          +
          +

          Set the input to be hidden, default false.

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + string + — +
          + + +
          +
          +

          + getMetaBoxes() + +

          + + +

          Returns an array of all registered meta boxes for each section of the sub page.

          + + + protected + getMetaBoxes() : array<string|int, mixed> + +
          + + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + array<string|int, mixed> + — +
          + + +
          +
          +

          + getSections() + +

          + + +

          Returns an array of all registered sections for the sub page.

          + + + protected + getSections() : array<string|int, mixed> + +
          + + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + array<string|int, mixed> + — +
          + + +
          +
          +

          + getSubPageSlug() + +

          + + +

          Returns the unique slug of the sub page.

          + + + protected + getSubPageSlug() : string + +
          + + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + string + — +
          + + +
          +
          +

          + getSubPageTitle() + +

          + + +

          Returns the title of the sub page.

          + + + protected + getSubPageTitle() : string + +
          + + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + string + — +
          + + +
          +
          +

          + LoadSetting() + +

          + + +

          Loads specific setting and returns an array with the keys [id, name, value].

          + + + protected + LoadSetting(string $p_str_SettingKeyName) : array<string|int, mixed> + +
          + +
          Parameters
          +
          +
          + $p_str_SettingKeyName + : string +
          +
          +

          Settings Array key name.

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + array<string|int, mixed> + — +

          Contains Settings ID, Settings Name and Settings Value.

          +
          + + +
          +
          +

          + appendScripts() + +

          + + +

          Append javascript and css files for specific sub page.

          + + + private + appendScripts() : mixed + +
          + + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + mixed + — +
          + + +
          +
          +

          + registerMetaBoxes() + +

          + + +

          Registers all Meta boxes for a sub page.

          + + + private + registerMetaBoxes(string $p_str_ParentID) : mixed + +
          + +
          Parameters
          +
          +
          + $p_str_ParentID + : string +
          +
          +

          Parent section unique id.

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + mixed + — +
          + + +
          +
          +

          + saveSettings() + +

          + + +

          Save all Plugin settings.

          + + + private + saveSettings() : bool + +
          + + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + bool + — +
          + + +
          +
          + +
          +
          +
          +
          +

          Search results

          + +
          +
          +
            +
            +
            +
            +
            +
            + + +
            + + + + diff --git a/docs/classes/MCI-Footnotes-Layout-Init.html b/docs/classes/MCI-Footnotes-Layout-Init.html new file mode 100644 index 0000000..0ec0d29 --- /dev/null +++ b/docs/classes/MCI-Footnotes-Layout-Init.html @@ -0,0 +1,759 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
            +

            Documentation

            + + +
            + +
            + + +
            + +
            +
            + + + + +
            + + +
            +

            + MCI_Footnotes_Layout_Init + + + + +

            + + + +

            Handles the Settings interface of the Plugin.

            + +
            + + +
            + Tags + +
            +
            +
            + author +
            +
            + +

            Stefan Herndler

            +
            + +
            +
            + since +
            +
            + 1.5.0 + +
            + +
            +
            + + + + + + +

            + Table of Contents + +

            + +
            +
            + C_STR_MAIN_MENU_SLUG + +  = "mfmmf" +
            +
            Slug for the Plugin main menu.
            + +
            + C_STR_MAIN_MENU_TITLE + +  = "ManFisher" +
            +
            Plugin main menu name.
            + +
            + $a_arr_SubPageClasses + +  : array<string|int, mixed> +
            +
            + +
            + __construct() + +  : mixed +
            +
            Class Constructor. Initializes all WordPress hooks for the Plugin Settings.
            + +
            + displayOtherPlugins() + +  : mixed +
            +
            Displays other Plugins from the developers.
            + +
            + getPluginMetaInformation() + +  : mixed +
            +
            AJAX call. returns a JSON string containing meta information about a specific WordPress Plugin.
            + +
            + initializeSettings() + +  : mixed +
            +
            Initializes all sub pages and registers the settings.
            + +
            + registerMainMenu() + +  : mixed +
            +
            Registers the new main menu for the WordPress dashboard.
            + +
            + registerSubPages() + +  : mixed +
            +
            Registers all SubPages for this Plugin.
            + +
            + + + + +
            +

            + Constants + +

            +
            +

            + C_STR_MAIN_MENU_SLUG + +

            + + + +

            Slug for the Plugin main menu.

            + + + public + string + C_STR_MAIN_MENU_SLUG + = "mfmmf" + + + +
            + + +
            + Tags + +
            +
            +
            + author +
            +
            + +

            Stefan Herndler

            +
            + +
            +
            + since +
            +
            + 1.5.0 + +
            + +
            +
            + +
            +
            +

            + C_STR_MAIN_MENU_TITLE + +

            + + + +

            Plugin main menu name.

            + + + public + string + C_STR_MAIN_MENU_TITLE + = "ManFisher" + + + +
            + + +
            + Tags + +
            +
            +
            + author +
            +
            + +

            Stefan Herndler

            +
            + +
            +
            + since +
            +
            + 1.5.0 + +
            + +
            +
            + +
            +
            + + +
            +

            + Properties + +

            +
            +

            + $a_arr_SubPageClasses + + + +

            + + + + + private + array<string|int, mixed> + $a_arr_SubPageClasses + = array() + +
            + + +
            + Tags + +
            +
            +
            + author +
            +
            + +

            Stefan Herndler

            +
            + +
            +
            + since +
            +
            + 1.5.0 + +
            + +
            +
            + +
            +
            + +
            +

            + Methods + +

            +
            +

            + __construct() + +

            + + +

            Class Constructor. Initializes all WordPress hooks for the Plugin Settings.

            + + + public + __construct() : mixed + +
            + + + +
            + Tags + +
            +
            +
            + author +
            +
            + +

            Stefan Herndler

            +
            + +
            +
            + since +
            +
            + 1.5.0 + +
            + +
            +
            + +
            Return values
            + mixed + — +
            + + +
            +
            +

            + displayOtherPlugins() + +

            + + +

            Displays other Plugins from the developers.

            + + + public + displayOtherPlugins() : mixed + +
            + + + +
            + Tags + +
            +
            +
            + author +
            +
            + +

            Stefan Herndler

            +
            + +
            +
            + since +
            +
            + 1.5.0 + +
            + +
            +
            + +
            Return values
            + mixed + — +
            + + +
            +
            +

            + getPluginMetaInformation() + +

            + + +

            AJAX call. returns a JSON string containing meta information about a specific WordPress Plugin.

            + + + public + getPluginMetaInformation() : mixed + +
            + + + +
            + Tags + +
            +
            +
            + author +
            +
            + +

            Stefan Herndler

            +
            + +
            +
            + since +
            +
            + 1.5.0 + +
            + +
            +
            + +
            Return values
            + mixed + — +
            + + +
            +
            +

            + initializeSettings() + +

            + + +

            Initializes all sub pages and registers the settings.

            + + + public + initializeSettings() : mixed + +
            + + + +
            + Tags + +
            +
            +
            + author +
            +
            + +

            Stefan Herndler

            +
            + +
            +
            + since +
            +
            + 1.5.0 + +
            + +
            +
            + +
            Return values
            + mixed + — +
            + + +
            +
            +

            + registerMainMenu() + +

            + + +

            Registers the new main menu for the WordPress dashboard.

            + + + public + registerMainMenu() : mixed + +

            Registers all sub menu pages for the new main menu.

            +
            + + + +
            + Tags + +
            +
            +
            + author +
            +
            + +

            Stefan Herndler

            +
            + +
            +
            + since +
            +
            + 1.5.0 + +
            + +
            +
            + see +
            +
            + http://codex.wordpress.org/Function_Reference/add_menu_page + +
            + +
            +
            + +
            Return values
            + mixed + — +
            + + +
            +
            +

            + registerSubPages() + +

            + + +

            Registers all SubPages for this Plugin.

            + + + private + registerSubPages() : mixed + +
            + + + +
            + Tags + +
            +
            +
            + author +
            +
            + +

            Stefan Herndler

            +
            + +
            +
            + since +
            +
            + 1.5.0 + +
            + +
            +
            + +
            Return values
            + mixed + — +
            + + +
            +
            + +
            +
            +
            +
            +

            Search results

            + +
            +
            +
              +
              +
              +
              +
              +
              + + +
              + + + + diff --git a/docs/classes/MCI-Footnotes-Layout-Settings.html b/docs/classes/MCI-Footnotes-Layout-Settings.html new file mode 100644 index 0000000..5b4da79 --- /dev/null +++ b/docs/classes/MCI-Footnotes-Layout-Settings.html @@ -0,0 +1,3757 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
              +

              Documentation

              + + +
              + +
              + + +
              + +
              +
              + + + + +
              + + +
              +

              + MCI_Footnotes_Layout_Settings + + + extends MCI_Footnotes_LayoutEngine + + + + +

              + + + +

              Displays and handles all Settings of the Plugin.

              + +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + + + + + + +

              + Table of Contents + +

              + +
              +
              + $a_arr_Sections + +  : array<string|int, mixed> +
              +
              Stores all Sections for the child sub page.
              + +
              + $a_str_SubPageHook + +  : null|string +
              +
              Stores the Hook connection string for the child sub page.
              + +
              + CustomCSS() + +  : mixed +
              +
              Displays the custom css box.
              + +
              + CustomCSSMigration() + +  : mixed +
              +
              + +
              + CustomCSSNew() + +  : mixed +
              +
              + +
              + Description() + +  : mixed +
              +
              Output the Description of a section. May be overwritten in any section.
              + +
              + displayContent() + +  : mixed +
              +
              Displays the content of specific sub page.
              + +
              + Donate() + +  : mixed +
              +
              Displays all Donate button to support the developers.
              + +
              + Excerpts() + +  : mixed +
              +
              Displays the excerpt setting
              + +
              + getPriority() + +  : int +
              +
              Returns a Priority index. Lower numbers have a higher Priority.
              + +
              + Help() + +  : mixed +
              +
              Displays a short introduction of the Plugin.
              + +
              + HyperlinkArrow() + +  : mixed +
              +
              Displays all settings for the prepended symbol
              + +
              + LookupHooks() + +  : mixed +
              +
              Displays available Hooks to look for Footnote short codes.
              + +
              + Love() + +  : mixed +
              +
              Displays all settings for 'I love Footnotes'.
              + +
              + MouseOverBox() + +  : mixed +
              +
              Displays all settings for the footnotes mouse-over box.
              + +
              + MouseOverBoxAppearance() + +  : mixed +
              +
              + +
              + MouseOverBoxDimensions() + +  : mixed +
              +
              + +
              + MouseOverBoxPosition() + +  : mixed +
              +
              + +
              + MouseOverBoxText() + +  : mixed +
              +
              + +
              + MouseOverBoxTiming() + +  : mixed +
              +
              + +
              + MouseOverBoxTruncation() + +  : mixed +
              +
              + +
              + Numbering() + +  : mixed +
              +
              + +
              + ReferenceContainer() + +  : mixed +
              +
              Displays all settings for the reference container.
              + +
              + registerSections() + +  : mixed +
              +
              Registers all sections for a sub page.
              + +
              + registerSubPage() + +  : mixed +
              +
              Registers a sub page.
              + +
              + Scrolling() + +  : mixed +
              +
              + +
              + StartEnd() + +  : mixed +
              +
              Displays all options for the footnotes start and end tag short codes +Displays all options for the footnotes numbering +Displays all options for the scrolling behavior
              + +
              + Superscript() + +  : mixed +
              +
              Displays all settings for the footnote referrers
              + +
              + addCheckbox() + +  : string +
              +
              Returns the html tag for an input [type = checkbox].
              + +
              + addColorSelection() + +  : string +
              +
              Returns the html tag for an input [type = text] with color selection class.
              + +
              + addLabel() + +  : string +
              +
              Returns the html tag for an input/select label.
              + +
              + addLineSpace() + +  : string +
              +
              Returns a line break to have a space between two lines.
              + +
              + addMetaBox() + +  : array<string|int, mixed> +
              +
              Returns an array describing a meta box.
              + +
              + addNewline() + +  : string +
              +
              Returns a line break to start a new line.
              + +
              + addNumBox() + +  : string +
              +
              Returns the html tag for an input [type = num].
              + +
              + addSection() + +  : array<string|int, mixed> +
              +
              Returns an array describing a sub page section.
              + +
              + addSelectBox() + +  : string +
              +
              Returns the html tag for a select box.
              + +
              + addText() + +  : string +
              +
              Returns a simple text inside html <span> text.
              + +
              + addTextArea() + +  : string +
              +
              Returns the html tag for a text area.
              + +
              + addTextBox() + +  : string +
              +
              Returns the html tag for an input [type = text].
              + +
              + getMetaBoxes() + +  : array<string|int, mixed> +
              +
              Returns an array of all registered meta boxes for each section of the sub page.
              + +
              + getSections() + +  : array<string|int, mixed> +
              +
              Returns an array of all registered sections for the sub page.
              + +
              + getSubPageSlug() + +  : string +
              +
              Returns the unique slug of the sub page.
              + +
              + getSubPageTitle() + +  : string +
              +
              Returns the title of the sub page.
              + +
              + LoadSetting() + +  : array<string|int, mixed> +
              +
              Loads specific setting and returns an array with the keys [id, name, value].
              + +
              + appendScripts() + +  : mixed +
              +
              Append javascript and css files for specific sub page.
              + +
              + registerMetaBoxes() + +  : mixed +
              +
              Registers all Meta boxes for a sub page.
              + +
              + saveSettings() + +  : bool +
              +
              Save all Plugin settings.
              + +
              + + + + + + +
              +

              + Properties + +

              +
              +

              + $a_arr_Sections + + + +

              + + +

              Stores all Sections for the child sub page.

              + + + protected + array<string|int, mixed> + $a_arr_Sections + = array() + +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              +
              +

              + $a_str_SubPageHook + + + +

              + + +

              Stores the Hook connection string for the child sub page.

              + + + protected + null|string + $a_str_SubPageHook + = +ull + +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              +
              + +
              +

              + Methods + +

              +
              +

              + CustomCSS() + +

              + + +

              Displays the custom css box.

              + + + public + CustomCSS() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +

              Edited:

              +
              + +
              +
              + since +
              +
              + 2.1.6 + +

              drop localized notices for CSS classes as the number increased to 16 +list directly in the template, as CSS is in English anyway

              +
              + +
              +
              + since +
              +
              + 2.2.2 + +

              migrate Custom CSS to a dedicated tab 2020-12-15T0506+0100

              +
              + +
              +
              + since +
              +
              + 2.3.0 + +

              say 'copy-paste' instead of 'cut and paste' since cutting is not needed 2020-12-27T1257+0100

              +
              + +
              +
              + since +
              +
              + 2.5.1 + +

              mention validity while visible, thanks to @rkupadhya bug report

              +
              + +
              +
              + see +
              +
              + +

              templates/dashboard/customize-css.html +2020-12-09T1113+0100

              +
              + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + CustomCSSMigration() + +

              + + + + + public + CustomCSSMigration() : mixed + + + + + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + CustomCSSNew() + +

              + + + + + public + CustomCSSNew() : mixed + + + + + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + Description() + +

              + + +

              Output the Description of a section. May be overwritten in any section.

              + + + public + Description() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + displayContent() + +

              + + +

              Displays the content of specific sub page.

              + + + public + displayContent() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + Donate() + +

              + + +

              Displays all Donate button to support the developers.

              + + + public + Donate() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + Excerpts() + +

              + + +

              Displays the excerpt setting

              + + + public + Excerpts() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +

              Edited heading 2020-12-12T1453+0100

              +
              + +
              +
              + since +
              +
              + 2.1.1 + +

              more settings and notices, thanks to @nikelaos

              +
              + +
              +
              + since +
              +
              + 2.2.0 + +

              dedicated to the excerpt setting and its notices 2020-12-12T1454+0100

              +
              + +
              +
              + link +
              +
              + https://wordpress.org/support/topic/doesnt-work-any-more-11/#post-13687068 + +
              +
              + link +
              +
              + https://wordpress.org/support/topic/jquery-comes-up-in-feed-content/#post-13110879 + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + getPriority() + +

              + + +

              Returns a Priority index. Lower numbers have a higher Priority.

              + + + public + getPriority() : int + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + int + — +
              + + +
              +
              +

              + Help() + +

              + + +

              Displays a short introduction of the Plugin.

              + + + public + Help() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + HyperlinkArrow() + +

              + + +

              Displays all settings for the prepended symbol

              + + + public + HyperlinkArrow() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +

              Edited heading for v2.0.4

              +

              The former 'hyperlink arrow', incompatible with combined identical footnotes, +became 'prepended arrow' in v2.0.3 after a user complaint about missing backlinking semantics +of the footnote number.

              +
              + +
              +
              + since +
              +
              + 2.1.4 + +

              moved to Settings > Reference container > Display a backlink symbol

              +
              + +
              +
              + since +
              +
              + 2.2.1 + +

              and 2.2.4 back here

              +
              + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + LookupHooks() + +

              + + +

              Displays available Hooks to look for Footnote short codes.

              + + + public + LookupHooks() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.5 + +

              Edited:

              +
              + +
              +
              + since +
              +
              + 2.1.1 + +

              priority level setting for the_content 2020-11-16T2152+0100

              +
              + +
              +
              + since +
              +
              + 2.1.4 + +

              priority level settings for the other hooks 2020-11-19T1421+0100

              +

              priority level was initially hard-coded default +shows "9223372036854775807" in the numbox +empty should be interpreted as PHP_INT_MAX, +but a numbox cannot be set to empty: https://github.com/Modernizr/Modernizr/issues/171 +define -1 as PHP_INT_MAX instead

              +
              + +
              +
              + since +
              +
              + 2.2.9 + +

              removed the warning about the widget text hook 2020-12-25T0348+0100

              +
              + +
              +
              + since +
              +
              + 2.2.9 + +

              added guidance for the widget text hook 2020-12-25T0353+0100

              +
              + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + Love() + +

              + + +

              Displays all settings for 'I love Footnotes'.

              + + + public + Love() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +

              Edited:

              +
              + +
              +
              + since +
              +
              + 2.2.0 + +

              position-sensitive placeholders to support more locales 2020-12-11T0432+0100

              +
              + +
              +
              + since +
              +
              + 2.2.0 + +

              more options 2020-12-11T0432+0100

              +
              + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + MouseOverBox() + +

              + + +

              Displays all settings for the footnotes mouse-over box.

              + + + public + MouseOverBox() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.2 + +

              Edited:

              +
              + +
              +
              + since +
              +
              + 2.2.0 + +

              5 parts to address increased settings number

              +
              + +
              +
              + since +
              +
              + 2.2.5 + +

              position settings for alternative tooltips

              +
              + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + MouseOverBoxAppearance() + +

              + + + + + public + MouseOverBoxAppearance() : mixed + + + + + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + MouseOverBoxDimensions() + +

              + + + + + public + MouseOverBoxDimensions() : mixed + + + + + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + MouseOverBoxPosition() + +

              + + + + + public + MouseOverBoxPosition() : mixed + + + + + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + MouseOverBoxText() + +

              + + + + + public + MouseOverBoxText() : mixed + + + + + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + MouseOverBoxTiming() + +

              + + + + + public + MouseOverBoxTiming() : mixed + + + + + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + MouseOverBoxTruncation() + +

              + + + + + public + MouseOverBoxTruncation() : mixed + + + + + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + Numbering() + +

              + + + + + public + Numbering() : mixed + + + + + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + ReferenceContainer() + +

              + + +

              Displays all settings for the reference container.

              + + + public + ReferenceContainer() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +

              Completed:

              +
              + +
              +
              + since +
              +
              + 2.1.4: + +

              layout and typography options 2020-11-30T0548+0100

              +
              + +
              +
              + since +
              +
              + 2.2.5 + +

              options for label element and label bottom border, thanks to @markhillyer 2020-12-18T1447+0100

              +
              + +
              +
              + link +
              +
              + https://wordpress.org/support/topic/how-do-i-eliminate-the-horizontal-line-beneath-the-reference-container-heading/ + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + registerSections() + +

              + + +

              Registers all sections for a sub page.

              + + + public + registerSections() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + registerSubPage() + +

              + + +

              Registers a sub page.

              + + + public + registerSubPage() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + Scrolling() + +

              + + + + + public + Scrolling() : mixed + + + + + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + StartEnd() + +

              + + +

              Displays all options for the footnotes start and end tag short codes +Displays all options for the footnotes numbering +Displays all options for the scrolling behavior

              + + + public + StartEnd() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +

              Edited heading 2020-12-12T1412+0100

              +
              + +
              +
              + since +
              +
              + 2.2.0 + +

              start/end short codes: more predefined options 2020-12-12T1412+0100

              +
              + +
              +
              + since +
              +
              + 2.2.0 + +

              3 boxes for clarity 2020-12-12T1422+0100

              +
              + +
              +
              + since +
              +
              + 2.2.5 + +

              support for Ibid. notation thanks to @meglio 2020-12-17T2019+0100

              +
              + +
              +
              + since +
              +
              + 2.4.0 + +

              added warning about Block Editor escapement disruption 2021-01-02T2324+0100

              +
              + +
              +
              + since +
              +
              + 2.4.0 + +

              removed the HTML comment tag option 2021-01-02T2325+0100

              +
              + +
              +
              + since +
              +
              + 2.5.0 + +

              Shortcode syntax validation: add more information around the setting, thanks to @andreasra

              +
              + +
              +
              + link +
              +
              + https://wordpress.org/support/topic/doesnt-work-with-mailpoet/ + +
              +
              + link +
              +
              + https://wordpress.org/support/topic/add-support-for-ibid-notation/ + +
              +
              + link +
              +
              + https://wordpress.org/support/topic/warning-unbalanced-footnote-start-tag-short-code-before/ + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + Superscript() + +

              + + +

              Displays all settings for the footnote referrers

              + + + public + Superscript() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +

              Edited heading 2020-12-12T1513+0100

              +
              + +
              +
              + since +
              +
              + 2.1.1 + +

              option for superscript (optionally baseline referrers)

              +
              + +
              +
              + since +
              +
              + 2.2.0 + +

              option for link element moved here 2020-12-12T1514+0100

              +
              + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + addCheckbox() + +

              + + +

              Returns the html tag for an input [type = checkbox].

              + + + protected + addCheckbox(string $p_str_SettingName) : string + +
              + +
              Parameters
              +
              +
              + $p_str_SettingName + : string +
              +
              +

              Name of the Settings key to pre load the input field.

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + string + — +
              + + +
              +
              +

              + addColorSelection() + +

              + + +

              Returns the html tag for an input [type = text] with color selection class.

              + + + protected + addColorSelection(string $p_str_SettingName) : string + +
              + +
              Parameters
              +
              +
              + $p_str_SettingName + : string +
              +
              +

              Name of the Settings key to pre load the input field.

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.6 + +
              + +
              +
              + +
              Return values
              + string + — +
              + + +
              +
              +

              + addLabel() + +

              + + +

              Returns the html tag for an input/select label.

              + + + protected + addLabel(string $p_str_SettingName, string $p_str_Caption) : string + +
              + +
              Parameters
              +
              +
              + $p_str_SettingName + : string +
              +
              +

              Name of the Settings key to connect the Label with the input/select field.

              +
              + +
              +
              + $p_str_Caption + : string +
              +
              +

              Label caption.

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + since +
              +
              + 2.1.6 + +

              no colon

              +
              + +
              +
              + +
              Return values
              + string + — +

              Edited 2020-12-01T0159+0100..

              +
              + + +
              +
              +

              + addLineSpace() + +

              + + +

              Returns a line break to have a space between two lines.

              + + + protected + addLineSpace() : string + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + string + — +
              + + +
              +
              +

              + addMetaBox() + +

              + + +

              Returns an array describing a meta box.

              + + + protected + addMetaBox(string $p_str_SectionID, string $p_str_ID, string $p_str_Title, string $p_str_CallbackFunctionName) : array<string|int, mixed> + +
              + +
              Parameters
              +
              +
              + $p_str_SectionID + : string +
              +
              +

              Parent Section ID.

              +
              + +
              +
              + $p_str_ID + : string +
              +
              +

              Unique ID suffix.

              +
              + +
              +
              + $p_str_Title + : string +
              +
              +

              Title for the meta box.

              +
              + +
              +
              + $p_str_CallbackFunctionName + : string +
              +
              +

              Class method name for callback.

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + array<string|int, mixed> + — +

              meta box description to be able to append a meta box to the output.

              +
              + + +
              +
              +

              + addNewline() + +

              + + +

              Returns a line break to start a new line.

              + + + protected + addNewline() : string + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + string + — +
              + + +
              +
              +

              + addNumBox() + +

              + + +

              Returns the html tag for an input [type = num].

              + + + protected + addNumBox(string $p_str_SettingName, int $p_in_Min, int $p_int_Max[, bool $p_bool_Deci = false ]) : string + +
              + +
              Parameters
              +
              +
              + $p_str_SettingName + : string +
              +
              +

              Name of the Settings key to pre load the input field.

              +
              + +
              +
              + $p_in_Min + : int +
              +
              +

              Minimum value.

              +
              + +
              +
              + $p_int_Max + : int +
              +
              +

              Maximum value.

              +
              + +
              +
              + $p_bool_Deci + : bool + = false
              +
              +

              true if 0.1 steps and floating to string, false if integer (default)

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + since +
              +
              + 2.1.4 + +

              step argument and number_format() to allow decimals 2020-12-03T0631+0100..2020-12-12T1110+0100

              +
              + +
              +
              + +
              Return values
              + string + — +

              Edited:

              +
              + + +
              +
              +

              + addSection() + +

              + + +

              Returns an array describing a sub page section.

              + + + protected + addSection(string $p_str_ID, string $p_str_Title, int $p_int_SettingsContainerIndex[, bool $p_bool_hasSubmitButton = true ]) : array<string|int, mixed> + +
              + +
              Parameters
              +
              +
              + $p_str_ID + : string +
              +
              +

              Unique ID suffix.

              +
              + +
              +
              + $p_str_Title + : string +
              +
              +

              Title of the section.

              +
              + +
              +
              + $p_int_SettingsContainerIndex + : int +
              +
              +

              Settings Container Index.

              +
              + +
              +
              + $p_bool_hasSubmitButton + : bool + = true
              +
              +

              Should a Submit Button be displayed for this section, default: true.

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + array<string|int, mixed> + — +

              Array describing the section.

              +
              + + +
              +
              +

              + addSelectBox() + +

              + + +

              Returns the html tag for a select box.

              + + + protected + addSelectBox(string $p_str_SettingName, array<string|int, mixed> $p_arr_Options) : string + +
              + +
              Parameters
              +
              +
              + $p_str_SettingName + : string +
              +
              +

              Name of the Settings key to pre select the current value.

              +
              + +
              +
              + $p_arr_Options + : array<string|int, mixed> +
              +
              +

              Possible options to be selected.

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + string + — +
              + + +
              +
              +

              + addText() + +

              + + +

              Returns a simple text inside html <span> text.

              + + + protected + addText(string $p_str_Text) : string + +
              + +
              Parameters
              +
              +
              + $p_str_Text + : string +
              +
              +

              Message to be surrounded with simple html tag (span).

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + string + — +
              + + +
              +
              +

              + addTextArea() + +

              + + +

              Returns the html tag for a text area.

              + + + protected + addTextArea(string $p_str_SettingName) : string + +
              + +
              Parameters
              +
              +
              + $p_str_SettingName + : string +
              +
              +

              Name of the Settings key to pre fill the text area.

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + string + — +
              + + +
              +
              +

              + addTextBox() + +

              + + +

              Returns the html tag for an input [type = text].

              + + + protected + addTextBox(string $p_str_SettingName[, int $p_str_MaxLength = 999 ][, bool $p_bool_Readonly = false ][, bool $p_bool_Hidden = false ]) : string + +
              + +
              Parameters
              +
              +
              + $p_str_SettingName + : string +
              +
              +

              Name of the Settings key to pre load the input field.

              +
              + +
              +
              + $p_str_MaxLength + : int + = 999
              +
              +

              Maximum length of the input, default 999 characters.

              +
              + +
              +
              + $p_bool_Readonly + : bool + = false
              +
              +

              Set the input to be read only, default false.

              +
              + +
              +
              + $p_bool_Hidden + : bool + = false
              +
              +

              Set the input to be hidden, default false.

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + string + — +
              + + +
              +
              +

              + getMetaBoxes() + +

              + + +

              Returns an array of all registered meta boxes for each section of the sub page.

              + + + protected + getMetaBoxes() : array<string|int, mixed> + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + since +
              +
              + 2.0.0 + +

              discontinued

              +
              + +
              +
              + since +
              +
              + 2.0.4 + +

              restored to meet user demand for arrow symbol semantics

              +
              + +
              +
              + since +
              +
              + 2.1.4 + +

              discontinued, content moved to Settings > Reference container > Display a backlink symbol

              +
              + +
              +
              + since +
              +
              + 2.0.4 + +

              to reflect changes in meta box label display since WPv5.5 +spans need position:fixed and become unlocalizable +fix: logo is kept only in the label that doesn’t need to be translated: +Change string "%s styling" to "Footnotes styling" to fix layout in WPv5.5

              +
              + +
              +
              + since +
              +
              + 2.1.6 + +

              / 2.2.0 tabs reordered and renamed

              +
              + +
              +
              + see +
              +
              + details + +

              in class/config.php

              +
              + +
              +
              + +
              Return values
              + array<string|int, mixed> + — +

              Edited for 2.0.0 and later.

              +

              HyperlinkArrow meta box:

              +
              + + +
              +
              +

              + getSections() + +

              + + +

              Returns an array of all registered sections for the sub page.

              + + + protected + getSections() : array<string|int, mixed> + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + since +
              +
              + 2.1.6 + +

              tabs reordered and renamed

              +
              + +
              +
              + since +
              +
              + 2.1.6 + +

              removed if statement around expert tab

              +
              + +
              +
              + link +
              +
              + https://www.linkedin.com/pulse/20140610191154-4746170-configuration-vs-customization-when-and-why-would-i-implement-each + +
              +
              + +
              Return values
              + array<string|int, mixed> + — +

              Edited:

              +
              + + +
              +
              +

              + getSubPageSlug() + +

              + + +

              Returns the unique slug of the sub page.

              + + + protected + getSubPageSlug() : string + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + string + — +
              + + +
              +
              +

              + getSubPageTitle() + +

              + + +

              Returns the title of the sub page.

              + + + protected + getSubPageTitle() : string + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + string + — +
              + + +
              +
              +

              + LoadSetting() + +

              + + +

              Loads specific setting and returns an array with the keys [id, name, value].

              + + + protected + LoadSetting(string $p_str_SettingKeyName) : array<string|int, mixed> + +
              + +
              Parameters
              +
              +
              + $p_str_SettingKeyName + : string +
              +
              +

              Settings Array key name.

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + array<string|int, mixed> + — +

              Contains Settings ID, Settings Name and Settings Value.

              +
              + + +
              +
              +

              + appendScripts() + +

              + + +

              Append javascript and css files for specific sub page.

              + + + private + appendScripts() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + registerMetaBoxes() + +

              + + +

              Registers all Meta boxes for a sub page.

              + + + private + registerMetaBoxes(string $p_str_ParentID) : mixed + +
              + +
              Parameters
              +
              +
              + $p_str_ParentID + : string +
              +
              +

              Parent section unique id.

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + saveSettings() + +

              + + +

              Save all Plugin settings.

              + + + private + saveSettings() : bool + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + bool + — +
              + + +
              +
              + +
              +
              +
              +
              +

              Search results

              + +
              +
              +
                +
                +
                +
                +
                +
                + + +
                + + + + diff --git a/docs/classes/MCI-Footnotes-LayoutEngine.html b/docs/classes/MCI-Footnotes-LayoutEngine.html new file mode 100644 index 0000000..ff9e0f2 --- /dev/null +++ b/docs/classes/MCI-Footnotes-LayoutEngine.html @@ -0,0 +1,2222 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                +

                Documentation

                + + +
                + +
                + + +
                + +
                +
                + + + + +
                + + +
                +

                + MCI_Footnotes_LayoutEngine + + + + +

                + + + +

                Layout Engine for the administration dashboard.

                + +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + + + + + + +

                + Table of Contents + +

                + +
                +
                + $a_arr_Sections + +  : array<string|int, mixed> +
                +
                Stores all Sections for the child sub page.
                + +
                + $a_str_SubPageHook + +  : null|string +
                +
                Stores the Hook connection string for the child sub page.
                + +
                + Description() + +  : mixed +
                +
                Output the Description of a section. May be overwritten in any section.
                + +
                + displayContent() + +  : mixed +
                +
                Displays the content of specific sub page.
                + +
                + getPriority() + +  : int +
                +
                Returns a Priority index. Lower numbers have a higher Priority.
                + +
                + registerSections() + +  : mixed +
                +
                Registers all sections for a sub page.
                + +
                + registerSubPage() + +  : mixed +
                +
                Registers a sub page.
                + +
                + addCheckbox() + +  : string +
                +
                Returns the html tag for an input [type = checkbox].
                + +
                + addColorSelection() + +  : string +
                +
                Returns the html tag for an input [type = text] with color selection class.
                + +
                + addLabel() + +  : string +
                +
                Returns the html tag for an input/select label.
                + +
                + addLineSpace() + +  : string +
                +
                Returns a line break to have a space between two lines.
                + +
                + addMetaBox() + +  : array<string|int, mixed> +
                +
                Returns an array describing a meta box.
                + +
                + addNewline() + +  : string +
                +
                Returns a line break to start a new line.
                + +
                + addNumBox() + +  : string +
                +
                Returns the html tag for an input [type = num].
                + +
                + addSection() + +  : array<string|int, mixed> +
                +
                Returns an array describing a sub page section.
                + +
                + addSelectBox() + +  : string +
                +
                Returns the html tag for a select box.
                + +
                + addText() + +  : string +
                +
                Returns a simple text inside html <span> text.
                + +
                + addTextArea() + +  : string +
                +
                Returns the html tag for a text area.
                + +
                + addTextBox() + +  : string +
                +
                Returns the html tag for an input [type = text].
                + +
                + getMetaBoxes() + +  : array<string|int, mixed> +
                +
                Returns an array of all registered meta boxes.
                + +
                + getSections() + +  : array<string|int, mixed> +
                +
                Returns an array of all registered sections for a sub page.
                + +
                + getSubPageSlug() + +  : string +
                +
                Returns the unique slug of the child sub page.
                + +
                + getSubPageTitle() + +  : string +
                +
                Returns the title of the child sub page.
                + +
                + LoadSetting() + +  : array<string|int, mixed> +
                +
                Loads specific setting and returns an array with the keys [id, name, value].
                + +
                + appendScripts() + +  : mixed +
                +
                Append javascript and css files for specific sub page.
                + +
                + registerMetaBoxes() + +  : mixed +
                +
                Registers all Meta boxes for a sub page.
                + +
                + saveSettings() + +  : bool +
                +
                Save all Plugin settings.
                + +
                + + + + + + +
                +

                + Properties + +

                +
                +

                + $a_arr_Sections + + + +

                + + +

                Stores all Sections for the child sub page.

                + + + protected + array<string|int, mixed> + $a_arr_Sections + = array() + +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                +
                +

                + $a_str_SubPageHook + + + +

                + + +

                Stores the Hook connection string for the child sub page.

                + + + protected + null|string + $a_str_SubPageHook + = +ull + +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                +
                + +
                +

                + Methods + +

                +
                +

                + Description() + +

                + + +

                Output the Description of a section. May be overwritten in any section.

                + + + public + Description() : mixed + +
                + + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + mixed + — +
                + + +
                +
                +

                + displayContent() + +

                + + +

                Displays the content of specific sub page.

                + + + public + displayContent() : mixed + +
                + + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + mixed + — +
                + + +
                +
                +

                + getPriority() + +

                + + +

                Returns a Priority index. Lower numbers have a higher Priority.

                + + + public + abstract getPriority() : int + +
                + + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + int + — +
                + + +
                +
                +

                + registerSections() + +

                + + +

                Registers all sections for a sub page.

                + + + public + registerSections() : mixed + +
                + + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + mixed + — +
                + + +
                +
                +

                + registerSubPage() + +

                + + +

                Registers a sub page.

                + + + public + registerSubPage() : mixed + +
                + + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + mixed + — +
                + + +
                +
                +

                + addCheckbox() + +

                + + +

                Returns the html tag for an input [type = checkbox].

                + + + protected + addCheckbox(string $p_str_SettingName) : string + +
                + +
                Parameters
                +
                +
                + $p_str_SettingName + : string +
                +
                +

                Name of the Settings key to pre load the input field.

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + string + — +
                + + +
                +
                +

                + addColorSelection() + +

                + + +

                Returns the html tag for an input [type = text] with color selection class.

                + + + protected + addColorSelection(string $p_str_SettingName) : string + +
                + +
                Parameters
                +
                +
                + $p_str_SettingName + : string +
                +
                +

                Name of the Settings key to pre load the input field.

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.6 + +
                + +
                +
                + +
                Return values
                + string + — +
                + + +
                +
                +

                + addLabel() + +

                + + +

                Returns the html tag for an input/select label.

                + + + protected + addLabel(string $p_str_SettingName, string $p_str_Caption) : string + +
                + +
                Parameters
                +
                +
                + $p_str_SettingName + : string +
                +
                +

                Name of the Settings key to connect the Label with the input/select field.

                +
                + +
                +
                + $p_str_Caption + : string +
                +
                +

                Label caption.

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + since +
                +
                + 2.1.6 + +

                no colon

                +
                + +
                +
                + +
                Return values
                + string + — +

                Edited 2020-12-01T0159+0100..

                +
                + + +
                +
                +

                + addLineSpace() + +

                + + +

                Returns a line break to have a space between two lines.

                + + + protected + addLineSpace() : string + +
                + + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + string + — +
                + + +
                +
                +

                + addMetaBox() + +

                + + +

                Returns an array describing a meta box.

                + + + protected + addMetaBox(string $p_str_SectionID, string $p_str_ID, string $p_str_Title, string $p_str_CallbackFunctionName) : array<string|int, mixed> + +
                + +
                Parameters
                +
                +
                + $p_str_SectionID + : string +
                +
                +

                Parent Section ID.

                +
                + +
                +
                + $p_str_ID + : string +
                +
                +

                Unique ID suffix.

                +
                + +
                +
                + $p_str_Title + : string +
                +
                +

                Title for the meta box.

                +
                + +
                +
                + $p_str_CallbackFunctionName + : string +
                +
                +

                Class method name for callback.

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + array<string|int, mixed> + — +

                meta box description to be able to append a meta box to the output.

                +
                + + +
                +
                +

                + addNewline() + +

                + + +

                Returns a line break to start a new line.

                + + + protected + addNewline() : string + +
                + + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + string + — +
                + + +
                +
                +

                + addNumBox() + +

                + + +

                Returns the html tag for an input [type = num].

                + + + protected + addNumBox(string $p_str_SettingName, int $p_in_Min, int $p_int_Max[, bool $p_bool_Deci = false ]) : string + +
                + +
                Parameters
                +
                +
                + $p_str_SettingName + : string +
                +
                +

                Name of the Settings key to pre load the input field.

                +
                + +
                +
                + $p_in_Min + : int +
                +
                +

                Minimum value.

                +
                + +
                +
                + $p_int_Max + : int +
                +
                +

                Maximum value.

                +
                + +
                +
                + $p_bool_Deci + : bool + = false
                +
                +

                true if 0.1 steps and floating to string, false if integer (default)

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + since +
                +
                + 2.1.4 + +

                step argument and number_format() to allow decimals 2020-12-03T0631+0100..2020-12-12T1110+0100

                +
                + +
                +
                + +
                Return values
                + string + — +

                Edited:

                +
                + + +
                +
                +

                + addSection() + +

                + + +

                Returns an array describing a sub page section.

                + + + protected + addSection(string $p_str_ID, string $p_str_Title, int $p_int_SettingsContainerIndex[, bool $p_bool_hasSubmitButton = true ]) : array<string|int, mixed> + +
                + +
                Parameters
                +
                +
                + $p_str_ID + : string +
                +
                +

                Unique ID suffix.

                +
                + +
                +
                + $p_str_Title + : string +
                +
                +

                Title of the section.

                +
                + +
                +
                + $p_int_SettingsContainerIndex + : int +
                +
                +

                Settings Container Index.

                +
                + +
                +
                + $p_bool_hasSubmitButton + : bool + = true
                +
                +

                Should a Submit Button be displayed for this section, default: true.

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + array<string|int, mixed> + — +

                Array describing the section.

                +
                + + +
                +
                +

                + addSelectBox() + +

                + + +

                Returns the html tag for a select box.

                + + + protected + addSelectBox(string $p_str_SettingName, array<string|int, mixed> $p_arr_Options) : string + +
                + +
                Parameters
                +
                +
                + $p_str_SettingName + : string +
                +
                +

                Name of the Settings key to pre select the current value.

                +
                + +
                +
                + $p_arr_Options + : array<string|int, mixed> +
                +
                +

                Possible options to be selected.

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + string + — +
                + + +
                +
                +

                + addText() + +

                + + +

                Returns a simple text inside html <span> text.

                + + + protected + addText(string $p_str_Text) : string + +
                + +
                Parameters
                +
                +
                + $p_str_Text + : string +
                +
                +

                Message to be surrounded with simple html tag (span).

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + string + — +
                + + +
                +
                +

                + addTextArea() + +

                + + +

                Returns the html tag for a text area.

                + + + protected + addTextArea(string $p_str_SettingName) : string + +
                + +
                Parameters
                +
                +
                + $p_str_SettingName + : string +
                +
                +

                Name of the Settings key to pre fill the text area.

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + string + — +
                + + +
                +
                +

                + addTextBox() + +

                + + +

                Returns the html tag for an input [type = text].

                + + + protected + addTextBox(string $p_str_SettingName[, int $p_str_MaxLength = 999 ][, bool $p_bool_Readonly = false ][, bool $p_bool_Hidden = false ]) : string + +
                + +
                Parameters
                +
                +
                + $p_str_SettingName + : string +
                +
                +

                Name of the Settings key to pre load the input field.

                +
                + +
                +
                + $p_str_MaxLength + : int + = 999
                +
                +

                Maximum length of the input, default 999 characters.

                +
                + +
                +
                + $p_bool_Readonly + : bool + = false
                +
                +

                Set the input to be read only, default false.

                +
                + +
                +
                + $p_bool_Hidden + : bool + = false
                +
                +

                Set the input to be hidden, default false.

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + string + — +
                + + +
                +
                +

                + getMetaBoxes() + +

                + + +

                Returns an array of all registered meta boxes.

                + + + protected + abstract getMetaBoxes() : array<string|int, mixed> + +
                + + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + array<string|int, mixed> + — +
                + + +
                +
                +

                + getSections() + +

                + + +

                Returns an array of all registered sections for a sub page.

                + + + protected + abstract getSections() : array<string|int, mixed> + +
                + + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + array<string|int, mixed> + — +
                + + +
                +
                +

                + getSubPageSlug() + +

                + + +

                Returns the unique slug of the child sub page.

                + + + protected + abstract getSubPageSlug() : string + +
                + + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + string + — +
                + + +
                +
                +

                + getSubPageTitle() + +

                + + +

                Returns the title of the child sub page.

                + + + protected + abstract getSubPageTitle() : string + +
                + + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + string + — +
                + + +
                +
                +

                + LoadSetting() + +

                + + +

                Loads specific setting and returns an array with the keys [id, name, value].

                + + + protected + LoadSetting(string $p_str_SettingKeyName) : array<string|int, mixed> + +
                + +
                Parameters
                +
                +
                + $p_str_SettingKeyName + : string +
                +
                +

                Settings Array key name.

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + array<string|int, mixed> + — +

                Contains Settings ID, Settings Name and Settings Value.

                +
                + + +
                +
                +

                + appendScripts() + +

                + + +

                Append javascript and css files for specific sub page.

                + + + private + appendScripts() : mixed + +
                + + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + mixed + — +
                + + +
                +
                +

                + registerMetaBoxes() + +

                + + +

                Registers all Meta boxes for a sub page.

                + + + private + registerMetaBoxes(string $p_str_ParentID) : mixed + +
                + +
                Parameters
                +
                +
                + $p_str_ParentID + : string +
                +
                +

                Parent section unique id.

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + mixed + — +
                + + +
                +
                +

                + saveSettings() + +

                + + +

                Save all Plugin settings.

                + + + private + saveSettings() : bool + +
                + + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + bool + — +
                + + +
                +
                + +
                +
                +
                +
                +

                Search results

                + +
                +
                +
                  +
                  +
                  +
                  +
                  +
                  + + +
                  + + + + diff --git a/docs/classes/MCI-Footnotes-Settings.html b/docs/classes/MCI-Footnotes-Settings.html new file mode 100644 index 0000000..e436525 --- /dev/null +++ b/docs/classes/MCI-Footnotes-Settings.html @@ -0,0 +1,6221 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                  +

                  Documentation

                  + + +
                  + +
                  + + +
                  + +
                  +
                  + + + + +
                  + + +
                  +

                  + MCI_Footnotes_Settings + + + + +

                  + + + +

                  Loads the settings values, sets to default values if undefined.

                  + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + + + + + + +

                  + Table of Contents + +

                  + +
                  +
                  + C_BOOL_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED + +  = "footnotes_inputfield_backlinks_column_max_width_enabled" +
                  +
                  + +
                  + C_BOOL_BACKLINKS_COLUMN_WIDTH_ENABLED + +  = "footnotes_inputfield_backlinks_column_width_enabled" +
                  +
                  + +
                  + C_BOOL_BACKLINKS_LINE_BREAKS_ENABLED + +  = "footnotes_inputfield_backlinks_line_breaks_enabled" +
                  +
                  + +
                  + C_BOOL_BACKLINKS_SEPARATOR_ENABLED + +  = "footnotes_inputfield_backlinks_separator_enabled" +
                  +
                  + +
                  + C_BOOL_BACKLINKS_TERMINATOR_ENABLED + +  = "footnotes_inputfield_backlinks_terminator_enabled" +
                  +
                  + +
                  + C_BOOL_COMBINE_IDENTICAL_FOOTNOTES + +  = "footnote_inputfield_combine_identical" +
                  +
                  Settings Container Key for combining identical footnotes.
                  + +
                  + C_BOOL_CUSTOM_CSS_LEGACY_ENABLE + +  = "footnote_inputfield_custom_css_legacy_enable" +
                  +
                  Settings Container Key to enable display of legacy Custom CSS metaboxes.
                  + +
                  + C_BOOL_EXPERT_LOOKUP_THE_CONTENT + +  = "footnote_inputfield_expert_lookup_the_content" +
                  +
                  Settings Container Key to enable the 'the_content' hook.
                  + +
                  + C_BOOL_EXPERT_LOOKUP_THE_EXCERPT + +  = "footnote_inputfield_expert_lookup_the_excerpt" +
                  +
                  Settings Container Key to enable the 'the_excerpt' hook.
                  + +
                  + C_BOOL_EXPERT_LOOKUP_THE_TITLE + +  = "footnote_inputfield_expert_lookup_the_title" +
                  +
                  Settings Container Key to enable the 'the_title' hook.
                  + +
                  + C_BOOL_EXPERT_LOOKUP_WIDGET_TEXT + +  = "footnote_inputfield_expert_lookup_widget_text" +
                  +
                  Settings Container Key to enable the 'widget_text' hook.
                  + +
                  + C_BOOL_EXPERT_LOOKUP_WIDGET_TITLE + +  = "footnote_inputfield_expert_lookup_widget_title" +
                  +
                  Settings Container Key to enable the 'widget_title' hook.
                  + +
                  + C_BOOL_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE + +  = "footnotes_inputfield_shortcode_syntax_validation_enable" +
                  +
                  Settings container key for shortcode syntax validation.
                  + +
                  + C_BOOL_FOOTNOTE_URL_WRAP_ENABLED + +  = "footnote_inputfield_url_wrap_enabled" +
                  +
                  Settings Container Key for URL wrap option
                  + +
                  + C_BOOL_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE + +  = "footnotes_inputfield_backlink_tooltip_enable" +
                  +
                  Settings container key to enable backlink tooltips.
                  + +
                  + C_BOOL_FOOTNOTES_EXPERT_MODE + +  = "footnote_inputfield_enable_expert_mode" +
                  +
                  Settings Container Key for the Expert mode.
                  + +
                  + C_BOOL_FOOTNOTES_HARD_LINKS_ENABLE + +  = "footnotes_inputfield_hard_links_enable" +
                  +
                  + +
                  + C_BOOL_FOOTNOTES_IN_EXCERPT + +  = "footnote_inputfield_search_in_excerpt" +
                  +
                  Settings Container Key to look for footnotes in post excerpts.
                  + +
                  + C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE + +  = "footnote_inputfield_custom_mouse_over_box_alternative" +
                  +
                  Settings Container Key to enable the alternative tooltips.
                  + +
                  + C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED + +  = "footnote_inputfield_custom_mouse_over_box_enabled" +
                  +
                  Settings Container Key to enable the mouse-over box.
                  + +
                  + C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED + +  = "footnote_inputfield_custom_mouse_over_box_excerpt_enabled" +
                  +
                  Settings Container Key to enable tooltip truncation.
                  + +
                  + C_BOOL_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS + +  = "footnotes_inputfield_referrer_superscript_tags" +
                  +
                  Settings Container Key for the referrer element.
                  + +
                  + C_BOOL_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE + +  = "footnotes_inputfield_tooltip_excerpt_mirror_enable" +
                  +
                  Settings container key to enable mirroring the tooltip excerpt in the reference container.
                  + +
                  + C_BOOL_LINK_ELEMENT_ENABLED + +  = "footnote_inputfield_link_element_enabled" +
                  +
                  Settings Container Keys for the link element option +Settings Container Keys for backlink typography and layout +Settings Container Keys for tooltip font size +Settings Container Keys for page layout support +Settings Container Keys for scroll offset and duration +Settings Container Keys for tooltip display durations
                  + +
                  + C_BOOL_MOUSE_OVER_BOX_FONT_SIZE_ENABLED + +  = "footnotes_inputfield_mouse_over_box_font_size_enabled" +
                  +
                  + +
                  + C_BOOL_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE + +  = "footnotes_inputfield_reference_container_3column_layout_enable" +
                  +
                  Settings Container Key to enable the legacy layout of the reference container.
                  + +
                  + C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE + +  = "footnotes_inputfield_reference_container_backlink_symbol_enable" +
                  +
                  Settings Container Key to enable the display of a backlink symbol.
                  + +
                  + C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH + +  = "footnotes_inputfield_reference_container_backlink_symbol_switch" +
                  +
                  Settings Container Key to get the backlink symbol switch side.
                  + +
                  + C_BOOL_REFERENCE_CONTAINER_COLLAPSE + +  = "footnote_inputfield_collapse_references" +
                  +
                  Settings Container Key to collapse the reference container by default.
                  + +
                  + C_BOOL_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER + +  = "footnotes_inputfield_reference_container_label_bottom_border" +
                  +
                  + +
                  + C_BOOL_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE + +  = "footnotes_inputfield_reference_container_row_borders_enable" +
                  +
                  Settings Container Key for table cell borders, thanks to @noobishh
                  + +
                  + C_BOOL_REFERENCE_CONTAINER_START_PAGE_ENABLE + +  = "footnotes_inputfield_reference_container_start_page_enable" +
                  +
                  Settings Container Key to not display the reference container on the homepage.
                  + +
                  + C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR + +  = "footnotes_inputfield_mouse_over_box_font_size_scalar" +
                  +
                  + +
                  + C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR + +  = "footnotes_inputfield_backlinks_column_max_width_scalar" +
                  +
                  + +
                  + C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR + +  = "footnotes_inputfield_backlinks_column_width_scalar" +
                  +
                  + +
                  + C_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL + +  = "footnote_inputfield_expert_lookup_the_content_priority_level" +
                  +
                  Settings Container Key for 'the_content' hook priority level.
                  + +
                  + C_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL + +  = "footnote_inputfield_expert_lookup_the_excerpt_priority_level" +
                  +
                  + +
                  + C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL + +  = "footnote_inputfield_expert_lookup_the_title_priority_level" +
                  +
                  Settings Container Key for '' hook priority level
                  + +
                  + C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL + +  = "footnote_inputfield_expert_lookup_widget_text_priority_level" +
                  +
                  + +
                  + C_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL + +  = "footnote_inputfield_expert_lookup_widget_title_priority_level" +
                  +
                  + +
                  + C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X + +  = "footnotes_inputfield_alternative_mouse_over_box_offset_x" +
                  +
                  + +
                  + C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y + +  = "footnotes_inputfield_alternative_mouse_over_box_offset_y" +
                  +
                  + +
                  + C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH + +  = "footnotes_inputfield_alternative_mouse_over_box_width" +
                  +
                  + +
                  + C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS + +  = "footnote_inputfield_custom_mouse_over_box_border_radius" +
                  +
                  Settings Container Key for the mouse-over box to define the border radius.
                  + +
                  + C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH + +  = "footnote_inputfield_custom_mouse_over_box_border_width" +
                  +
                  Settings Container Key for the mouse-over box to define the border width.
                  + +
                  + C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH + +  = "footnote_inputfield_custom_mouse_over_box_excerpt_length" +
                  +
                  Settings Container Key for the mouse-over box to define the max. length of the enabled excerpt.
                  + +
                  + C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH + +  = "footnote_inputfield_custom_mouse_over_box_max_width" +
                  +
                  Settings Container Key for the mouse-over box to define the max. width.
                  + +
                  + C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X + +  = "footnote_inputfield_custom_mouse_over_box_offset_x" +
                  +
                  Settings Container Key for the mouse-over box to define the offset (x).
                  + +
                  + C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y + +  = "footnote_inputfield_custom_mouse_over_box_offset_y" +
                  +
                  Settings Container Key for the mouse-over box to define the offset (y).
                  + +
                  + C_INT_FOOTNOTES_SCROLL_DURATION + +  = "footnotes_inputfield_scroll_duration" +
                  +
                  + +
                  + C_INT_FOOTNOTES_SCROLL_OFFSET + +  = "footnotes_inputfield_scroll_offset" +
                  +
                  Scroll offset and duration
                  + +
                  + C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY + +  = "footnotes_inputfield_mouse_over_box_fade_in_delay" +
                  +
                  + +
                  + C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION + +  = "footnotes_inputfield_mouse_over_box_fade_in_duration" +
                  +
                  + +
                  + C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY + +  = "footnotes_inputfield_mouse_over_box_fade_out_delay" +
                  +
                  + +
                  + C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION + +  = "footnotes_inputfield_mouse_over_box_fade_out_duration" +
                  +
                  + +
                  + C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN + +  = "footnotes_inputfield_reference_container_bottom_margin" +
                  +
                  + +
                  + C_INT_REFERENCE_CONTAINER_TOP_MARGIN + +  = "footnotes_inputfield_reference_container_top_margin" +
                  +
                  Settings container keys for reference container top and bottom margins +Settings container keys for hard link enabling +Settings container keys for hard link anchors in referrers and footnotes
                  + +
                  + C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT + +  = "footnotes_inputfield_backlinks_column_max_width_unit" +
                  +
                  + +
                  + C_STR_BACKLINKS_COLUMN_WIDTH_UNIT + +  = "footnotes_inputfield_backlinks_column_width_unit" +
                  +
                  + +
                  + C_STR_BACKLINKS_SEPARATOR_CUSTOM + +  = "footnotes_inputfield_backlinks_separator_custom" +
                  +
                  + +
                  + C_STR_BACKLINKS_SEPARATOR_OPTION + +  = "footnotes_inputfield_backlinks_separator_option" +
                  +
                  + +
                  + C_STR_BACKLINKS_TERMINATOR_CUSTOM + +  = "footnotes_inputfield_backlinks_terminator_custom" +
                  +
                  + +
                  + C_STR_BACKLINKS_TERMINATOR_OPTION + +  = "footnotes_inputfield_backlinks_terminator_option" +
                  +
                  + +
                  + C_STR_CUSTOM_CSS + +  = "footnote_inputfield_custom_css" +
                  +
                  Settings Container Key for the Custom CSS.
                  + +
                  + C_STR_CUSTOM_CSS_NEW + +  = "footnote_inputfield_custom_css_new" +
                  +
                  Settings Container Key for the Custom CSS migrated to a dedicated tab.
                  + +
                  + C_STR_FOOTNOTE_FRAGMENT_ID_SLUG + +  = "footnotes_inputfield_footnote_fragment_id_slug" +
                  +
                  + +
                  + C_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT + +  = "footnotes_inputfield_referrers_normal_superscript" +
                  +
                  Settings container key to enable superscript style normalization.
                  + +
                  + C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION + +  = "footnotes_inputfield_alternative_mouse_over_box_position" +
                  +
                  Settings Container Keys for alternative tooltip position +Settings Container Keys for reference container label element, thanks to @markhillyer
                  + +
                  + C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT + +  = "footnotes_inputfield_backlink_tooltip_text" +
                  +
                  Settings container key to configure the backlink tooltip.
                  + +
                  + C_STR_FOOTNOTES_COUNTER_STYLE + +  = "footnote_inputfield_counter_style" +
                  +
                  Settings Container Key for the counter style of the footnotes.
                  + +
                  + C_STR_FOOTNOTES_LOVE + +  = "footnote_inputfield_love" +
                  +
                  Settings Container Key for the 'I love footnotes' text.
                  + +
                  + C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND + +  = "footnote_inputfield_custom_mouse_over_box_background" +
                  +
                  Settings Container Key for the mouse-over box to define the background color.
                  + +
                  + C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR + +  = "footnote_inputfield_custom_mouse_over_box_border_color" +
                  +
                  Settings Container Key for the mouse-over box to define the border color.
                  + +
                  + C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR + +  = "footnote_inputfield_custom_mouse_over_box_color" +
                  +
                  Settings Container Key for the mouse-over box to define the color.
                  + +
                  + C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION + +  = "footnote_inputfield_custom_mouse_over_box_position" +
                  +
                  Settings Container Key for the mouse-over box to define the position.
                  + +
                  + C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR + +  = "footnote_inputfield_custom_mouse_over_box_shadow_color" +
                  +
                  Settings Container Key for the mouse-over box to define the box-shadow color.
                  + +
                  + C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT + +  = "footnotes_inputfield_page_layout_support" +
                  +
                  + +
                  + C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE + +  = "footnotes_inputfield_reference_container_script_mode" +
                  +
                  Settings container key to select the script mode for the reference container.
                  + +
                  + C_STR_FOOTNOTES_SHORT_CODE_END + +  = "footnote_inputfield_placeholder_end" +
                  +
                  Settings Container Key for the short code of the footnote’s end.
                  + +
                  + C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED + +  = "footnote_inputfield_placeholder_end_user_defined" +
                  +
                  Settings Container Key for the user-defined short code of the footnotes end.
                  + +
                  + C_STR_FOOTNOTES_SHORT_CODE_START + +  = "footnote_inputfield_placeholder_start" +
                  +
                  Settings Container Key for the short code of the footnote’s start.
                  + +
                  + C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED + +  = "footnote_inputfield_placeholder_start_user_defined" +
                  +
                  Settings Container Key for the user-defined short code of the footnotes start.
                  + +
                  + C_STR_FOOTNOTES_STYLING_AFTER + +  = "footnote_inputfield_custom_styling_after" +
                  +
                  Settings Container Key for the string after the footnote referrer.
                  + +
                  + C_STR_FOOTNOTES_STYLING_BEFORE + +  = "footnote_inputfield_custom_styling_before" +
                  +
                  Settings Container Key for the string before the footnote referrer.
                  + +
                  + C_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER + +  = "footnotes_inputfield_tooltip_excerpt_delimiter" +
                  +
                  Settings container key to configure the tooltip excerpt delimiter.
                  + +
                  + C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR + +  = "footnotes_inputfield_tooltip_excerpt_mirror_separator" +
                  +
                  Settings container key to configure the tooltip excerpt separator in the reference container.
                  + +
                  + C_STR_FOOTNOTES_TOOLTIP_READON_LABEL + +  = "footnote_inputfield_readon_label" +
                  +
                  Settings Container Key for the label of the Read-on button in truncated tooltips.
                  + +
                  + C_STR_HARD_LINK_IDS_SEPARATOR + +  = "footnotes_inputfield_hard_link_ids_separator" +
                  +
                  + +
                  + C_STR_HYPERLINK_ARROW + +  = "footnote_inputfield_custom_hyperlink_symbol" +
                  +
                  Settings Container Key for the backlink symbol selection.
                  + +
                  + C_STR_HYPERLINK_ARROW_USER_DEFINED + +  = "footnote_inputfield_custom_hyperlink_symbol_user" +
                  +
                  Settings Container Key for the user-defined backlink symbol.
                  + +
                  + C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT + +  = "footnotes_inputfield_mouse_over_box_font_size_unit" +
                  +
                  + +
                  + C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT + +  = "footnotes_inputfield_reference_container_label_element" +
                  +
                  + +
                  + C_STR_REFERENCE_CONTAINER_NAME + +  = "footnote_inputfield_references_label" +
                  +
                  Settings Container Key for the label of the reference container.
                  + +
                  + C_STR_REFERENCE_CONTAINER_POSITION + +  = "footnote_inputfield_reference_container_place" +
                  +
                  Settings Container Key for the position of the reference container.
                  + +
                  + C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE + +  = "footnote_inputfield_reference_container_position_shortcode" +
                  +
                  Settings Container Key for reference container position shortcode
                  + +
                  + C_STR_REFERRER_FRAGMENT_ID_SLUG + +  = "footnotes_inputfield_referrer_fragment_id_slug" +
                  +
                  + +
                  + $a_arr_Container + +  : array<string|int, mixed> +
                  +
                  Contains all Settings Container names.
                  + +
                  + $a_arr_Default + +  : array<string|int, mixed> +
                  +
                  Contains all Default Settings for each Settings Container.
                  + +
                  + $a_arr_Settings + +  : array<string|int, mixed> +
                  +
                  Contains all Settings from each Settings container as soon as this class is initialized.
                  + +
                  + $a_obj_Instance + +  : MCI_Footnotes_Settings +
                  +
                  Stores a singleton reference of this class.
                  + +
                  + ClearAll() + +  : mixed +
                  +
                  Deletes each Settings Container and loads the default values for each Settings Container.
                  + +
                  + get() + +  : mixed +
                  +
                  Returns the value of specified Settings name.
                  + +
                  + getContainer() + +  : str +
                  +
                  Returns the name of a specified Settings Container.
                  + +
                  + getDefaults() + +  : array<string|int, mixed> +
                  +
                  Returns the default values of a specific Settings Container.
                  + +
                  + instance() + +  : MCI_Footnotes_Settings +
                  +
                  Returns a singleton of this class.
                  + +
                  + RegisterSettings() + +  : mixed +
                  +
                  Register all Settings Container for the Plugin Settings Page in the Dashboard.
                  + +
                  + saveOptions() + +  : bool +
                  +
                  Updates a whole Settings container.
                  + +
                  + __construct() + +  : mixed +
                  +
                  Class Constructor. Loads all Settings from each WordPress Settings container.
                  + +
                  + Load() + +  : array<string|int, mixed> +
                  +
                  Loads all Settings from specified Settings Container.
                  + +
                  + loadAll() + +  : mixed +
                  +
                  Loads all Settings from each Settings container.
                  + +
                  + + + + +
                  +

                  + Constants + +

                  +
                  +

                  + C_BOOL_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED + +

                  + + + + + + public + mixed + C_BOOL_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED + = "footnotes_inputfield_backlinks_column_max_width_enabled" + + + + + + +
                  +
                  +

                  + C_BOOL_BACKLINKS_COLUMN_WIDTH_ENABLED + +

                  + + + + + + public + mixed + C_BOOL_BACKLINKS_COLUMN_WIDTH_ENABLED + = "footnotes_inputfield_backlinks_column_width_enabled" + + + + + + +
                  +
                  +

                  + C_BOOL_BACKLINKS_LINE_BREAKS_ENABLED + +

                  + + + + + + public + mixed + C_BOOL_BACKLINKS_LINE_BREAKS_ENABLED + = "footnotes_inputfield_backlinks_line_breaks_enabled" + + + + + + +
                  +
                  +

                  + C_BOOL_BACKLINKS_SEPARATOR_ENABLED + +

                  + + + + + + public + mixed + C_BOOL_BACKLINKS_SEPARATOR_ENABLED + = "footnotes_inputfield_backlinks_separator_enabled" + + + + + + +
                  +
                  +

                  + C_BOOL_BACKLINKS_TERMINATOR_ENABLED + +

                  + + + + + + public + mixed + C_BOOL_BACKLINKS_TERMINATOR_ENABLED + = "footnotes_inputfield_backlinks_terminator_enabled" + + + + + + +
                  +
                  +

                  + C_BOOL_COMBINE_IDENTICAL_FOOTNOTES + +

                  + + + +

                  Settings Container Key for combining identical footnotes.

                  + + + public + str + C_BOOL_COMBINE_IDENTICAL_FOOTNOTES + = "footnote_inputfield_combine_identical" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_CUSTOM_CSS_LEGACY_ENABLE + +

                  + + + +

                  Settings Container Key to enable display of legacy Custom CSS metaboxes.

                  + + + public + str + C_BOOL_CUSTOM_CSS_LEGACY_ENABLE + = "footnote_inputfield_custom_css_legacy_enable" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.2.2 + +
                  + +
                  +
                  + since +
                  +
                  + 2.3.0 + +

                  swap Boolean from 'migration complete' to 'show legacy'

                  +
                  + +
                  +
                  + date +
                  +
                  + +

                  2020-12-15T0520+0100

                  +
                  + +
                  +
                  + date +
                  +
                  + +

                  2020-12-27T1233+0100

                  +

                  The Boolean must be false if its setting is contained in the container to be hidden, +because when saving, all missing constants are emptied, and toBool() converts empty to false.

                  +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_EXPERT_LOOKUP_THE_CONTENT + +

                  + + + +

                  Settings Container Key to enable the 'the_content' hook.

                  + + + public + str + C_BOOL_EXPERT_LOOKUP_THE_CONTENT + = "footnote_inputfield_expert_lookup_the_content" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.5 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_EXPERT_LOOKUP_THE_EXCERPT + +

                  + + + +

                  Settings Container Key to enable the 'the_excerpt' hook.

                  + + + public + str + C_BOOL_EXPERT_LOOKUP_THE_EXCERPT + = "footnote_inputfield_expert_lookup_the_excerpt" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.5 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_EXPERT_LOOKUP_THE_TITLE + +

                  + + + +

                  Settings Container Key to enable the 'the_title' hook.

                  + + + public + str + C_BOOL_EXPERT_LOOKUP_THE_TITLE + = "footnote_inputfield_expert_lookup_the_title" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.5 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_EXPERT_LOOKUP_WIDGET_TEXT + +

                  + + + +

                  Settings Container Key to enable the 'widget_text' hook.

                  + + + public + str + C_BOOL_EXPERT_LOOKUP_WIDGET_TEXT + = "footnote_inputfield_expert_lookup_widget_text" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.5 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_EXPERT_LOOKUP_WIDGET_TITLE + +

                  + + + +

                  Settings Container Key to enable the 'widget_title' hook.

                  + + + public + str + C_BOOL_EXPERT_LOOKUP_WIDGET_TITLE + = "footnote_inputfield_expert_lookup_widget_title" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.5 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE + +

                  + + + +

                  Settings container key for shortcode syntax validation.

                  + + + public + str + C_BOOL_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE + = "footnotes_inputfield_shortcode_syntax_validation_enable" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.4.0 + +
                  + +
                  +
                  + date +
                  +
                  + +

                  2021-01-01T0616+0100

                  +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_FOOTNOTE_URL_WRAP_ENABLED + +

                  + + + +

                  Settings Container Key for URL wrap option

                  + + + public + str + C_BOOL_FOOTNOTE_URL_WRAP_ENABLED + = "footnote_inputfield_url_wrap_enabled" + + + +

                  This is made optional because it causes weird line breaks. +Unicode-compliant browsers break URLs at slashes.

                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.1.6 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE + +

                  + + + +

                  Settings container key to enable backlink tooltips.

                  + + + public + str + C_BOOL_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE + = "footnotes_inputfield_backlink_tooltip_enable" + + + +
                    +
                  • Update: Reference container: Hard backlinks (optional): optional configurable tooltip hinting to use the backbutton instead, thanks to @theroninjedi47 bug report.
                    • +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.5.4 + +
                  + +
                  +
                  + reporter +
                  +
                  + +

                  @theroninjedi47

                  +
                  + +
                  +
                  + link +
                  +
                  +

                  When hard links are enabled, clicks on the backlinks are logged in the browsing history, +along with clicks on the referrers. +This tooltip hints to use the backbutton instead, so the history gets streamlined again.

                  +                   + +
                  +
                  + link +
                  +
                  + https://wordpress.org/support/topic/making-it-amp-compatible/#post-13837359 + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_FOOTNOTES_EXPERT_MODE + +

                  + + + +

                  Settings Container Key for the Expert mode.

                  + + + public + str + C_BOOL_FOOTNOTES_EXPERT_MODE + = "footnote_inputfield_enable_expert_mode" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.5 + +
                  + +
                  +
                  + since +
                  +
                  + 2.1.6 + +

                  This setting removed as irrelevant since priority level settings need permanent visibility.

                  +
                  + +
                  +
                  + date +
                  +
                  + +

                  2020-12-09T2107+0100

                  +

                  Since the removal of the the_post hook, the tab is no danger zone any longer. +All users, not experts only, need to be able to control relative positioning.

                  +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_FOOTNOTES_HARD_LINKS_ENABLE + +

                  + + + + + + public + mixed + C_BOOL_FOOTNOTES_HARD_LINKS_ENABLE + = "footnotes_inputfield_hard_links_enable" + + + + + + +
                  +
                  +

                  + C_BOOL_FOOTNOTES_IN_EXCERPT + +

                  + + + +

                  Settings Container Key to look for footnotes in post excerpts.

                  + + + public + str + C_BOOL_FOOTNOTES_IN_EXCERPT + = "footnote_inputfield_search_in_excerpt" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE + +

                  + + + +

                  Settings Container Key to enable the alternative tooltips.

                  + + + public + str + C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE + = "footnote_inputfield_custom_mouse_over_box_alternative" + + + +
                    +
                  • Bugfix: Tooltips: optional alternative JS implementation with CSS transitions to fix configuration-related outage, thanks to @andreasra feedback.
                    • +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.1.1 + +
                  + +
                  +
                  + date +
                  +
                  + +

                  2020-11-11T1817+0100

                  +
                  + +
                  +
                  + reporter +
                  +
                  + +

                  @andreasra

                  +
                  + +
                  +
                  + link +
                  +
                  + https://wordpress.org/support/topic/footnotes-appearing-in-header/page/2/#post-13632566 + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED + +

                  + + + +

                  Settings Container Key to enable the mouse-over box.

                  + + + public + str + C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED + = "footnote_inputfield_custom_mouse_over_box_enabled" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.2 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED + +

                  + + + +

                  Settings Container Key to enable tooltip truncation.

                  + + + public + str + C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED + = "footnote_inputfield_custom_mouse_over_box_excerpt_enabled" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.4 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS + +

                  + + + +

                  Settings Container Key for the referrer element.

                  + + + public + str + C_BOOL_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS + = "footnotes_inputfield_referrer_superscript_tags" + + + +
                    +
                  • Bugfix: Referrers: new setting for vertical align: superscript (default) or baseline (optional), thanks to @cwbayer bug report.
                    • +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.1.1 + +
                  + +
                  +
                  + date +
                  +
                  + +

                  2020-11-16T0859+0100

                  +
                  + +
                  +
                  + reporter +
                  +
                  + +

                  @cwbayer

                  +
                  + +
                  +
                  + link +
                  +
                  + https://wordpress.org/support/topic/footnote-number-in-text-superscript-disrupts-leading/ + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE + +

                  + + + +

                  Settings container key to enable mirroring the tooltip excerpt in the reference container.

                  + + + public + str + C_BOOL_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE + = "footnotes_inputfield_tooltip_excerpt_mirror_enable" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.5.4 + +
                  + +
                  +
                  + link +
                  +
                  +

                  But this must not be the default behavior.

                  +                   + +
                  +
                  + link +
                  +
                  + https://wordpress.org/support/topic/change-tooltip-text/#post-13935488 + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_LINK_ELEMENT_ENABLED + +

                  + + + +

                  Settings Container Keys for the link element option +Settings Container Keys for backlink typography and layout +Settings Container Keys for tooltip font size +Settings Container Keys for page layout support +Settings Container Keys for scroll offset and duration +Settings Container Keys for tooltip display durations

                  + + + public + str|bool|int|flo + C_BOOL_LINK_ELEMENT_ENABLED + = "footnote_inputfield_link_element_enabled" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.1.4 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_MOUSE_OVER_BOX_FONT_SIZE_ENABLED + +

                  + + + + + + public + mixed + C_BOOL_MOUSE_OVER_BOX_FONT_SIZE_ENABLED + = "footnotes_inputfield_mouse_over_box_font_size_enabled" + + + + + + +
                  +
                  +

                  + C_BOOL_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE + +

                  + + + +

                  Settings Container Key to enable the legacy layout of the reference container.

                  + + + public + str + C_BOOL_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE + = "footnotes_inputfield_reference_container_3column_layout_enable" + + + +
                    +
                  • Bugfix: Reference container: option to restore pre-2.0.0 layout with the backlink symbol in an extra column.
                    • +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.1.1 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE + +

                  + + + +

                  Settings Container Key to enable the display of a backlink symbol.

                  + + + public + str + C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE + = "footnotes_inputfield_reference_container_backlink_symbol_enable" + + + +
                    +
                  • Bugfix: Reference container: Backlink symbol: make optional, not suggest configuring it to invisible, thanks to @spaceling feedback.
                    • +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.1.1 + +
                  + +
                  +
                  + reporter +
                  +
                  + +

                  @spaceling

                  +
                  + +
                  +
                  + link +
                  +
                  + https://wordpress.org/support/topic/change-the-position-5/page/2/#post-13671138 + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH + +

                  + + + +

                  Settings Container Key to get the backlink symbol switch side.

                  + + + public + str + C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH + = "footnotes_inputfield_reference_container_backlink_symbol_switch" + + + +
                    +
                  • Bugfix: Reference container: option to append symbol (prepended by default), thanks to @spaceling code contribution.
                    • +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.1.1 + +
                  + +
                  +
                  + date +
                  +
                  + +

                  2020-11-16T2024+0100

                  +
                  + +
                  +
                  + contributor +
                  +
                  + +

                  @spaceling

                  +
                  + +
                  +
                  + link +
                  +
                  + https://wordpress.org/support/topic/change-the-position-5/#post-13615994 + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_REFERENCE_CONTAINER_COLLAPSE + +

                  + + + +

                  Settings Container Key to collapse the reference container by default.

                  + + + public + str + C_BOOL_REFERENCE_CONTAINER_COLLAPSE + = "footnote_inputfield_collapse_references" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + see +
                  +
                  + MCI_Footnotes_Convert::toBool() + +

                  The type in the variable name is useful to show the intention.

                  +
                  + +
                  +
                  + todo +
                  +
                  + +

                  Eventually change misleading variable names C_BOOL_… to C_STR_… (that’s how Hungarian screws things up).

                  +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER + +

                  + + + + + + public + mixed + C_BOOL_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER + = "footnotes_inputfield_reference_container_label_bottom_border" + + + + + + +
                  +
                  +

                  + C_BOOL_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE + +

                  + + + +

                  Settings Container Key for table cell borders, thanks to @noobishh

                  + + + public + str + C_BOOL_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE + = "footnotes_inputfield_reference_container_row_borders_enable" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + link +
                  +
                  + https://wordpress.org/support/topic/borders-25/ + +
                  +
                  + since +
                  +
                  + 2.2.10 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_REFERENCE_CONTAINER_START_PAGE_ENABLE + +

                  + + + +

                  Settings Container Key to not display the reference container on the homepage.

                  + + + public + str + C_BOOL_REFERENCE_CONTAINER_START_PAGE_ENABLE + = "footnotes_inputfield_reference_container_start_page_enable" + + + +
                    +
                  • Bugfix: Reference container: fix start pages by making its display optional, thanks to @dragon013 bug report.
                    • +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.1.1 + +
                  + +
                  +
                  + reporter +
                  +
                  + +

                  @dragon013

                  +
                  + +
                  +
                  + link +
                  +
                  + https://wordpress.org/support/topic/possible-to-hide-it-from-start-page/ + +
                  +
                  + +
                  +
                  +

                  + C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR + +

                  + + + + + + public + mixed + C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR + = "footnotes_inputfield_mouse_over_box_font_size_scalar" + + + + + + +
                  +
                  +

                  + C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR + +

                  + + + + + + public + mixed + C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR + = "footnotes_inputfield_backlinks_column_max_width_scalar" + + + + + + +
                  +
                  +

                  + C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR + +

                  + + + + + + public + mixed + C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR + = "footnotes_inputfield_backlinks_column_width_scalar" + + + + + + +
                  +
                  +

                  + C_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL + +

                  + + + +

                  Settings Container Key for 'the_content' hook priority level.

                  + + + public + str + C_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL + = "footnote_inputfield_expert_lookup_the_content_priority_level" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.1.1 + +
                  + +
                  +
                  + date +
                  +
                  + +

                  2020-11-16T0859+0100

                  +
                  + +
                  +
                  + +
                  +
                  +

                  + C_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL + +

                  + + + + + + public + mixed + C_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL + = "footnote_inputfield_expert_lookup_the_excerpt_priority_level" + + + + + + +
                  +
                  +

                  + C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL + +

                  + + + +

                  Settings Container Key for '' hook priority level

                  + + + public + str + C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL + = "footnote_inputfield_expert_lookup_the_title_priority_level" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.1.2 + +
                  + +
                  +
                  + date +
                  +
                  + +

                  2020-11-20T0620+0100

                  +
                  + +
                  +
                  + +
                  +
                  +

                  + C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL + +

                  + + + + + + public + mixed + C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL + = "footnote_inputfield_expert_lookup_widget_text_priority_level" + + + + + + +
                  +
                  +

                  + C_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL + +

                  + + + + + + public + mixed + C_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL + = "footnote_inputfield_expert_lookup_widget_title_priority_level" + + + + + + +
                  +
                  +

                  + C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X + +

                  + + + + + + public + mixed + C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X + = "footnotes_inputfield_alternative_mouse_over_box_offset_x" + + + + + + +
                  +
                  +

                  + C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y + +

                  + + + + + + public + mixed + C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y + = "footnotes_inputfield_alternative_mouse_over_box_offset_y" + + + + + + +
                  +
                  +

                  + C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH + +

                  + + + + + + public + mixed + C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH + = "footnotes_inputfield_alternative_mouse_over_box_width" + + + + + + +
                  +
                  +

                  + C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS + +

                  + + + +

                  Settings Container Key for the mouse-over box to define the border radius.

                  + + + public + str + C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS + = "footnote_inputfield_custom_mouse_over_box_border_radius" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.6 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH + +

                  + + + +

                  Settings Container Key for the mouse-over box to define the border width.

                  + + + public + str + C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH + = "footnote_inputfield_custom_mouse_over_box_border_width" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.6 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH + +

                  + + + +

                  Settings Container Key for the mouse-over box to define the max. length of the enabled excerpt.

                  + + + public + str + C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH + = "footnote_inputfield_custom_mouse_over_box_excerpt_length" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.4 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH + +

                  + + + +

                  Settings Container Key for the mouse-over box to define the max. width.

                  + + + public + str + C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH + = "footnote_inputfield_custom_mouse_over_box_max_width" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.6 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X + +

                  + + + +

                  Settings Container Key for the mouse-over box to define the offset (x).

                  + + + public + str + C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X + = "footnote_inputfield_custom_mouse_over_box_offset_x" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.7 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y + +

                  + + + +

                  Settings Container Key for the mouse-over box to define the offset (y).

                  + + + public + str + C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y + = "footnote_inputfield_custom_mouse_over_box_offset_y" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.7 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_INT_FOOTNOTES_SCROLL_DURATION + +

                  + + + + + + public + mixed + C_INT_FOOTNOTES_SCROLL_DURATION + = "footnotes_inputfield_scroll_duration" + + + + + + +
                  +
                  +

                  + C_INT_FOOTNOTES_SCROLL_OFFSET + +

                  + + + +

                  Scroll offset and duration

                  + + + public + mixed + C_INT_FOOTNOTES_SCROLL_OFFSET + = "footnotes_inputfield_scroll_offset" + + + +
                    +
                  • Bugfix: Scroll offset: make configurable to fix site-dependent issues related to fixed headers.
                    • +
                  • Bugfix: Scroll duration: make configurable to conform to website content and style requirements.
                    • +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.1.4 + +
                  + +
                  +
                  + date +
                  +
                  + +

                  2020-12-05T0538+0100

                  +
                  + +
                  +
                  + +
                  +
                  +

                  + C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY + +

                  + + + + + + public + mixed + C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY + = "footnotes_inputfield_mouse_over_box_fade_in_delay" + + + + + + +
                  +
                  +

                  + C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION + +

                  + + + + + + public + mixed + C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION + = "footnotes_inputfield_mouse_over_box_fade_in_duration" + + + + + + +
                  +
                  +

                  + C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY + +

                  + + + + + + public + mixed + C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY + = "footnotes_inputfield_mouse_over_box_fade_out_delay" + + + + + + +
                  +
                  +

                  + C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION + +

                  + + + + + + public + mixed + C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION + = "footnotes_inputfield_mouse_over_box_fade_out_duration" + + + + + + +
                  +
                  +

                  + C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN + +

                  + + + + + + public + mixed + C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN + = "footnotes_inputfield_reference_container_bottom_margin" + + + + + + +
                  +
                  +

                  + C_INT_REFERENCE_CONTAINER_TOP_MARGIN + +

                  + + + +

                  Settings container keys for reference container top and bottom margins +Settings container keys for hard link enabling +Settings container keys for hard link anchors in referrers and footnotes

                  + + + public + int|bool|str + C_INT_REFERENCE_CONTAINER_TOP_MARGIN + = "footnotes_inputfield_reference_container_top_margin" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.3.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT + +

                  + + + + + + public + mixed + C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT + = "footnotes_inputfield_backlinks_column_max_width_unit" + + + + + + +
                  +
                  +

                  + C_STR_BACKLINKS_COLUMN_WIDTH_UNIT + +

                  + + + + + + public + mixed + C_STR_BACKLINKS_COLUMN_WIDTH_UNIT + = "footnotes_inputfield_backlinks_column_width_unit" + + + + + + +
                  +
                  +

                  + C_STR_BACKLINKS_SEPARATOR_CUSTOM + +

                  + + + + + + public + mixed + C_STR_BACKLINKS_SEPARATOR_CUSTOM + = "footnotes_inputfield_backlinks_separator_custom" + + + + + + +
                  +
                  +

                  + C_STR_BACKLINKS_SEPARATOR_OPTION + +

                  + + + + + + public + mixed + C_STR_BACKLINKS_SEPARATOR_OPTION + = "footnotes_inputfield_backlinks_separator_option" + + + + + + +
                  +
                  +

                  + C_STR_BACKLINKS_TERMINATOR_CUSTOM + +

                  + + + + + + public + mixed + C_STR_BACKLINKS_TERMINATOR_CUSTOM + = "footnotes_inputfield_backlinks_terminator_custom" + + + + + + +
                  +
                  +

                  + C_STR_BACKLINKS_TERMINATOR_OPTION + +

                  + + + + + + public + mixed + C_STR_BACKLINKS_TERMINATOR_OPTION + = "footnotes_inputfield_backlinks_terminator_option" + + + + + + +
                  +
                  +

                  + C_STR_CUSTOM_CSS + +

                  + + + +

                  Settings Container Key for the Custom CSS.

                  + + + public + str + C_STR_CUSTOM_CSS + = "footnote_inputfield_custom_css" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + since +
                  +
                  + 1.3.0 + +

                  Adding: new settings tab for custom CSS settings.

                  +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_CUSTOM_CSS_NEW + +

                  + + + +

                  Settings Container Key for the Custom CSS migrated to a dedicated tab.

                  + + + public + str + C_STR_CUSTOM_CSS_NEW + = "footnote_inputfield_custom_css_new" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.2.2 + +

                  Bugfix: Dashboard: Custom CSS: unearth text area and migrate to dedicated tab as designed.

                  +
                  + +
                  +
                  + date +
                  +
                  + +

                  2020-12-15T0520+0100

                  +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTE_FRAGMENT_ID_SLUG + +

                  + + + + + + public + mixed + C_STR_FOOTNOTE_FRAGMENT_ID_SLUG + = "footnotes_inputfield_footnote_fragment_id_slug" + + + + + + +
                  +
                  +

                  + C_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT + +

                  + + + +

                  Settings container key to enable superscript style normalization.

                  + + + public + str + C_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT + = "footnotes_inputfield_referrers_normal_superscript" + + + +

                  -Bugfix: Referrers: optional fixes to vertical alignment, font size and position (static) for in-theme consistency and cross-theme stability, thanks to @tomturowski bug report.

                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.5.4 + +
                  + +
                  +
                  + reporter +
                  +
                  + +

                  @tomturowski

                  +
                  + +
                  +
                  + link +
                  +
                  + https://wordpress.org/support/topic/in-line-superscript-ref-rides-to-high/ + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION + +

                  + + + +

                  Settings Container Keys for alternative tooltip position +Settings Container Keys for reference container label element, thanks to @markhillyer

                  + + + public + int + C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION + = "footnotes_inputfield_alternative_mouse_over_box_position" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + link +
                  +
                  + https://wordpress.org/support/topic/how-do-i-eliminate-the-horizontal-line-beneath-the-reference-container-heading/ + +
                  +
                  + since +
                  +
                  + 2.2.5 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT + +

                  + + + +

                  Settings container key to configure the backlink tooltip.

                  + + + public + str + C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT + = "footnotes_inputfield_backlink_tooltip_text" + + + +
                    +
                  • Update: Reference container: Hard backlinks (optional): optional configurable tooltip hinting to use the backbutton instead, thanks to @theroninjedi47 bug report.
                    • +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.5.4 + +
                  + +
                  +
                  + reporter +
                  +
                  + +

                  @theroninjedi47

                  +
                  + +
                  +
                  + link +
                  +
                  + https://wordpress.org/support/topic/hyperlinked-footnotes-creating-excessive-back-history/ + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_COUNTER_STYLE + +

                  + + + +

                  Settings Container Key for the counter style of the footnotes.

                  + + + public + str + C_STR_FOOTNOTES_COUNTER_STYLE + = "footnote_inputfield_counter_style" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_LOVE + +

                  + + + +

                  Settings Container Key for the 'I love footnotes' text.

                  + + + public + str + C_STR_FOOTNOTES_LOVE + = "footnote_inputfield_love" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND + +

                  + + + +

                  Settings Container Key for the mouse-over box to define the background color.

                  + + + public + str + C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND + = "footnote_inputfield_custom_mouse_over_box_background" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.6 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR + +

                  + + + +

                  Settings Container Key for the mouse-over box to define the border color.

                  + + + public + str + C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR + = "footnote_inputfield_custom_mouse_over_box_border_color" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.6 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR + +

                  + + + +

                  Settings Container Key for the mouse-over box to define the color.

                  + + + public + str + C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR + = "footnote_inputfield_custom_mouse_over_box_color" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.6 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION + +

                  + + + +

                  Settings Container Key for the mouse-over box to define the position.

                  + + + public + str + C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION + = "footnote_inputfield_custom_mouse_over_box_position" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.7 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR + +

                  + + + +

                  Settings Container Key for the mouse-over box to define the box-shadow color.

                  + + + public + str + C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR + = "footnote_inputfield_custom_mouse_over_box_shadow_color" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.8 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT + +

                  + + + + + + public + mixed + C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT + = "footnotes_inputfield_page_layout_support" + + + + + + +
                  +
                  +

                  + C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE + +

                  + + + +

                  Settings container key to select the script mode for the reference container.

                  + + + public + str + C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE + = "footnotes_inputfield_reference_container_script_mode" + + + +
                    +
                  • Bugfix: Reference container: optional alternative expanding and collapsing without jQuery for use with hard links, thanks to @hopper87it @pkverma99 issue reports.
                    • +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.5.6 + +
                  + +
                  +
                  + reporter +
                  +
                  + +

                  @hopper87it

                  +
                  + +
                  +
                  + link +
                  +
                  + https://wordpress.org/support/topic/footnotes-wp-rocket/ + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_SHORT_CODE_END + +

                  + + + +

                  Settings Container Key for the short code of the footnote’s end.

                  + + + public + str + C_STR_FOOTNOTES_SHORT_CODE_END + = "footnote_inputfield_placeholder_end" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED + +

                  + + + +

                  Settings Container Key for the user-defined short code of the footnotes end.

                  + + + public + str + C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED + = "footnote_inputfield_placeholder_end_user_defined" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_SHORT_CODE_START + +

                  + + + +

                  Settings Container Key for the short code of the footnote’s start.

                  + + + public + str + C_STR_FOOTNOTES_SHORT_CODE_START + = "footnote_inputfield_placeholder_start" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED + +

                  + + + +

                  Settings Container Key for the user-defined short code of the footnotes start.

                  + + + public + str + C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED + = "footnote_inputfield_placeholder_start_user_defined" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_STYLING_AFTER + +

                  + + + +

                  Settings Container Key for the string after the footnote referrer.

                  + + + public + str + C_STR_FOOTNOTES_STYLING_AFTER + = "footnote_inputfield_custom_styling_after" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_STYLING_BEFORE + +

                  + + + +

                  Settings Container Key for the string before the footnote referrer.

                  + + + public + str + C_STR_FOOTNOTES_STYLING_BEFORE + = "footnote_inputfield_custom_styling_before" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER + +

                  + + + +

                  Settings container key to configure the tooltip excerpt delimiter.

                  + + + public + str + C_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER + = "footnotes_inputfield_tooltip_excerpt_delimiter" + + + +
                    +
                  • Update: Tooltips: ability to display dedicated content before [[/tooltip]], thanks to @jbj2199 issue report.
                    • +
                  +

                  The first implementation used a fixed shortcode provided in the changelog. +But Footnotes’ UI design policy is to make shortcodes freely configurable.

                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.5.4 + +
                  + +
                  +
                  + reporter +
                  +
                  + +

                  @jbj2199

                  +
                  + +
                  +
                  + link +
                  +
                  +

                  Tooltips can display another content than the footnote entry +in the reference container. The trigger is a shortcode in +the footnote text separating the tooltip text from the note. +That is consistent with what WordPress does for excerpts.

                  +                   + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR + +

                  + + + +

                  Settings container key to configure the tooltip excerpt separator in the reference container.

                  + + + public + str + C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR + = "footnotes_inputfield_tooltip_excerpt_mirror_separator" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.5.4 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_TOOLTIP_READON_LABEL + +

                  + + + +

                  Settings Container Key for the label of the Read-on button in truncated tooltips.

                  + + + public + str + C_STR_FOOTNOTES_TOOLTIP_READON_LABEL + = "footnote_inputfield_readon_label" + + + +
                    +
                  • Adding: Tooltips: Read-on button: Label: configurable instead of localizable, thanks to @rovanov example provision.
                    • +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.1.0 + +
                  + +
                  +
                  + date +
                  +
                  + +

                  2020-11-08T2106+0100

                  +
                  + +
                  +
                  + reporter +
                  +
                  + +

                  @rovanov

                  +
                  + +
                  +
                  + link +
                  +
                  + https://wordpress.org/support/topic/offset-x-axis-and-offset-y-axis-does-not-working/ + +
                  +
                  + +
                  +
                  +

                  + C_STR_HARD_LINK_IDS_SEPARATOR + +

                  + + + + + + public + mixed + C_STR_HARD_LINK_IDS_SEPARATOR + = "footnotes_inputfield_hard_link_ids_separator" + + + + + + +
                  +
                  +

                  + C_STR_HYPERLINK_ARROW + +

                  + + + +

                  Settings Container Key for the backlink symbol selection.

                  + + + public + str + C_STR_HYPERLINK_ARROW + = "footnote_inputfield_custom_hyperlink_symbol" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_HYPERLINK_ARROW_USER_DEFINED + +

                  + + + +

                  Settings Container Key for the user-defined backlink symbol.

                  + + + public + str + C_STR_HYPERLINK_ARROW_USER_DEFINED + = "footnote_inputfield_custom_hyperlink_symbol_user" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT + +

                  + + + + + + public + mixed + C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT + = "footnotes_inputfield_mouse_over_box_font_size_unit" + + + + + + +
                  +
                  +

                  + C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT + +

                  + + + + + + public + mixed + C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT + = "footnotes_inputfield_reference_container_label_element" + + + + + + +
                  +
                  +

                  + C_STR_REFERENCE_CONTAINER_NAME + +

                  + + + +

                  Settings Container Key for the label of the reference container.

                  + + + public + str + C_STR_REFERENCE_CONTAINER_NAME + = "footnote_inputfield_references_label" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_REFERENCE_CONTAINER_POSITION + +

                  + + + +

                  Settings Container Key for the position of the reference container.

                  + + + public + str + C_STR_REFERENCE_CONTAINER_POSITION + = "footnote_inputfield_reference_container_place" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE + +

                  + + + +

                  Settings Container Key for reference container position shortcode

                  + + + public + str + C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE + = "footnote_inputfield_reference_container_position_shortcode" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.2.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_REFERRER_FRAGMENT_ID_SLUG + +

                  + + + + + + public + mixed + C_STR_REFERRER_FRAGMENT_ID_SLUG + = "footnotes_inputfield_referrer_fragment_id_slug" + + + + + + +
                  +
                  + + +
                  +

                  + Properties + +

                  +
                  +

                  + $a_arr_Container + + + +

                  + + +

                  Contains all Settings Container names.

                  + + + private + array<string|int, mixed> + $a_arr_Container + = array("footnotes_storage", "footnotes_storage_custom", "footnotes_storage_expert", "footnotes_storage_custom_css") + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + $a_arr_Default + + + +

                  + + +

                  Contains all Default Settings for each Settings Container.

                  + + + private + array<string|int, mixed> + $a_arr_Default + = array("footnotes_storage" => array( + self::C_STR_FOOTNOTES_SHORT_CODE_START => '((', + self::C_STR_FOOTNOTES_SHORT_CODE_END => '))', + self::C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED => '', + self::C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED => '', + self::C_BOOL_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE => 'yes', + self::C_STR_FOOTNOTES_COUNTER_STYLE => 'arabic_plain', + self::C_BOOL_COMBINE_IDENTICAL_FOOTNOTES => 'yes', + self::C_BOOL_FOOTNOTES_HARD_LINKS_ENABLE => 'no', + self::C_STR_REFERRER_FRAGMENT_ID_SLUG => 'r', + self::C_STR_FOOTNOTE_FRAGMENT_ID_SLUG => 'f', + self::C_STR_HARD_LINK_IDS_SEPARATOR => '+', + self::C_INT_FOOTNOTES_SCROLL_OFFSET => 20, + self::C_INT_FOOTNOTES_SCROLL_DURATION => 380, + // 2.5.4 fast-tracked: + self::C_BOOL_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE => 'yes', + self::C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT => 'Alt+ ←', + self::C_STR_REFERENCE_CONTAINER_NAME => 'References', + self::C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT => 'p', + self::C_BOOL_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER => 'yes', + self::C_BOOL_REFERENCE_CONTAINER_COLLAPSE => 'no', + self::C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE => 'jquery', + self::C_STR_REFERENCE_CONTAINER_POSITION => 'post_end', + self::C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE => '[[references]]', + self::C_BOOL_REFERENCE_CONTAINER_START_PAGE_ENABLE => 'yes', + // whether to enqueue additional stylesheet: + self::C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT => 'none', + // top and bottom margins: + self::C_INT_REFERENCE_CONTAINER_TOP_MARGIN => 24, + self::C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN => 0, + // table cell borders: + self::C_BOOL_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE => 'no', + // backlink symbol: + self::C_BOOL_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE => 'no', + self::C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE => 'yes', + self::C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH => 'no', + // backlink separators and terminators are often not preferred. + // but a choice must be provided along with the ability to customize: + self::C_BOOL_BACKLINKS_SEPARATOR_ENABLED => 'yes', + self::C_STR_BACKLINKS_SEPARATOR_OPTION => 'comma', + self::C_STR_BACKLINKS_SEPARATOR_CUSTOM => '', + self::C_BOOL_BACKLINKS_TERMINATOR_ENABLED => 'no', + self::C_STR_BACKLINKS_TERMINATOR_OPTION => 'full_stop', + self::C_STR_BACKLINKS_TERMINATOR_CUSTOM => '', + // set backlinks column width: + self::C_BOOL_BACKLINKS_COLUMN_WIDTH_ENABLED => 'no', + self::C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR => '50', + self::C_STR_BACKLINKS_COLUMN_WIDTH_UNIT => 'px', + // set backlinks column max. width: + self::C_BOOL_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED => 'no', + self::C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR => '140', + self::C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT => 'px', + // whether a <br /> tag is inserted: + self::C_BOOL_BACKLINKS_LINE_BREAKS_ENABLED => 'no', + // whether to enable URL line wrapping: + self::C_BOOL_FOOTNOTE_URL_WRAP_ENABLED => 'yes', + // whether to use link elements: + self::C_BOOL_LINK_ELEMENT_ENABLED => 'yes', + // excerpt should be disabled: + self::C_BOOL_FOOTNOTES_IN_EXCERPT => 'no', + self::C_BOOL_FOOTNOTES_EXPERT_MODE => 'yes', + self::C_STR_FOOTNOTES_LOVE => 'no', +), "footnotes_storage_custom" => array( + self::C_STR_HYPERLINK_ARROW => '&#8593;', + self::C_STR_HYPERLINK_ARROW_USER_DEFINED => '', + self::C_STR_FOOTNOTES_TOOLTIP_READON_LABEL => 'Continue reading', + self::C_BOOL_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS => 'yes', + self::C_STR_FOOTNOTES_STYLING_BEFORE => '[', + self::C_STR_FOOTNOTES_STYLING_AFTER => ']', + self::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED => 'yes', + self::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE => 'no', + // The mouse over content truncation should be enabled by default + // to raise awareness of the functionality and to prevent the screen + // from being filled at mouse-over, and to allow the Continue reading: + self::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED => 'yes', + // The truncation length is raised from 150 to 200 chars: + self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH => 200, + // 2.5.4 fast-tracked: + self::C_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER => '[[/tooltip]]', + self::C_BOOL_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE => 'no', + self::C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR => ' — ', + self::C_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT => 'no', + // The default position should not be lateral because of the risk + // the box gets squeezed between note anchor at line end and window edge, + // and top because reading at the bottom of the window is more likely: + self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION => 'top center', + self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X => 0, + // The vertical offset must be negative for the box not to cover + // the current line of text (web coordinates origin is top left): + self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y => -7, + // The width should be limited to start with, for the box to have shape: + self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH => 450, + // fixed width is for alternative tooltips, cannot reuse max-width nor offsets: + self::C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION => 'top right', + self::C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X => -50, + self::C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y => 24, + self::C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH => 400, + // tooltip display durations: + // called mouse over box not tooltip for consistency + self::C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY => 0, + self::C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION => 200, + self::C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY => 400, + self::C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION => 200, + // tooltip font size reset to legacy by default since 2.1.4; + // was set to inherit since 2.1.1 as it overrode custom CSS, + // is moved to settings since 2.1.4 2020-12-04T1023+0100 + self::C_BOOL_MOUSE_OVER_BOX_FONT_SIZE_ENABLED => 'yes', + self::C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR => 13, + self::C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT => 'px', + self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR => '', + // The mouse over box shouldn’t feature a colored background + // by default, due to diverging user preferences. White is neutral: + self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND => '#ffffff', + self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH => 1, + self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR => '#cccc99', + // The mouse over box corners mustn’t be rounded as that is outdated: + self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS => 0, + self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR => '#666666', + // Custom CSS migrates to a dedicated tab: + self::C_STR_CUSTOM_CSS => '', +), "footnotes_storage_expert" => array( + // These are checkboxes; keyword 'checked' is converted to Boolean true, + // empty string to false (default): + // Titles should all be enabled by default to prevent users from + // thinking at first that the feature is broken in post titles. + // See <https://wordpress.org/support/topic/more-feature-ideas/> + // Yet in titles, footnotes are still buggy, because WordPress + // uses the title string in menus and in the title element. + self::C_BOOL_EXPERT_LOOKUP_THE_TITLE => '', + self::C_BOOL_EXPERT_LOOKUP_THE_CONTENT => 'checked', + // And the_excerpt is disabled by default following @nikelaos in + // <https://wordpress.org/support/topic/jquery-comes-up-in-feed-content/#post-13110879> + // <https://wordpress.org/support/topic/doesnt-work-any-more-11/#post-13687068> + self::C_BOOL_EXPERT_LOOKUP_THE_EXCERPT => '', + self::C_BOOL_EXPERT_LOOKUP_WIDGET_TITLE => '', + // The widget_text hook must be disabled by default, because it causes + // multiple reference containers to appear in Elementor accordions, but + // it must be enabled if multiple reference containers are desired, as + // in Elementor toggles. + self::C_BOOL_EXPERT_LOOKUP_WIDGET_TEXT => '', + // initially hard-coded default + // shows "9223372036854780000" instead of 9223372036854775807 in the numbox + // empty should be interpreted as PHP_INT_MAX, but a numbox cannot be set to empty: + // <https://github.com/Modernizr/Modernizr/issues/171> + // interpret -1 as PHP_INT_MAX instead + self::C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL => PHP_INT_MAX, + // Priority level of the_content and of widget_text as the only relevant + // hooks must be less than 99 because social buttons may yield scripts + // that contain the strings '((' and '))', i.e. the default footnote + // start and end short codes, causing issues with fake footnotes. + self::C_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL => 98, + self::C_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL => PHP_INT_MAX, + self::C_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL => PHP_INT_MAX, + self::C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL => 98, +), "footnotes_storage_custom_css" => array(self::C_BOOL_CUSTOM_CSS_LEGACY_ENABLE => 'yes', self::C_STR_CUSTOM_CSS_NEW => '')) + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + since +
                  +
                  + 2.1.3 + +

                  excerpt hook: disable by default, thanks to @nikelaos

                  +
                  + +
                  +
                  + link +
                  +
                  + https://wordpress.org/support/topic/doesnt-work-any-more-11/#post-13687068 + +
                  +
                  + +
                  +
                  +

                  + $a_arr_Settings + + + +

                  + + +

                  Contains all Settings from each Settings container as soon as this class is initialized.

                  + + + private + array<string|int, mixed> + $a_arr_Settings + = array() + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + $a_obj_Instance + + + +

                  + + +

                  Stores a singleton reference of this class.

                  + + + private + static MCI_Footnotes_Settings + $a_obj_Instance + = +ull + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  + +
                  +

                  + Methods + +

                  +
                  +

                  + ClearAll() + +

                  + + +

                  Deletes each Settings Container and loads the default values for each Settings Container.

                  + + + public + ClearAll() : mixed + +
                  + + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +

                  Edit: This didn’t actually work.

                  +
                  + +
                  +
                  + since +
                  +
                  + 2.2.0 + +

                  this function is not called any longer when deleting the plugin, +to protect user data against loss, since manually updating a plugin is safer +done by deleting and reinstalling (see the warning about database backup). +2020-12-13T1353+0100

                  +
                  + +
                  +
                  + +
                  Return values
                  + mixed + — +
                  + + +
                  +
                  +

                  + get() + +

                  + + +

                  Returns the value of specified Settings name.

                  + + + public + get(string $p_str_Key) : mixed + +
                  + +
                  Parameters
                  +
                  +
                  + $p_str_Key + : string +
                  +
                  +

                  Settings Array Key name.

                  +
                  + +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  Return values
                  + mixed + — +

                  Value of the Setting on Success or Null in Settings name is invalid.

                  +
                  + + +
                  +
                  +

                  + getContainer() + +

                  + + +

                  Returns the name of a specified Settings Container.

                  + + + public + getContainer(int $p_int_Index) : str + +
                  + +
                  Parameters
                  +
                  +
                  + $p_int_Index + : int +
                  +
                  +

                  Settings Container Array Key Index.

                  +
                  + +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  Return values
                  + str + — +

                  Settings Container name.

                  +
                  + + +
                  +
                  +

                  + getDefaults() + +

                  + + +

                  Returns the default values of a specific Settings Container.

                  + + + public + getDefaults(int $p_int_Index) : array<string|int, mixed> + +
                  + +
                  Parameters
                  +
                  +
                  + $p_int_Index + : int +
                  +
                  +

                  Settings Container Aray Key Index.

                  +
                  + +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.6 + +
                  + +
                  +
                  + +
                  Return values
                  + array<string|int, mixed> + — +
                  + + +
                  +
                  +

                  + instance() + +

                  + + +

                  Returns a singleton of this class.

                  + + + public + static instance() : MCI_Footnotes_Settings + +
                  + + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  Return values
                  + MCI_Footnotes_Settings + — +
                  + + +
                  +
                  +

                  + RegisterSettings() + +

                  + + +

                  Register all Settings Container for the Plugin Settings Page in the Dashboard.

                  + + + public + RegisterSettings() : mixed + +

                  Settings Container Label will be the same as the Settings Container Name.

                  +
                  + + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  Return values
                  + mixed + — +
                  + + +
                  +
                  +

                  + saveOptions() + +

                  + + +

                  Updates a whole Settings container.

                  + + + public + saveOptions(int $p_int_Index, array<string|int, mixed> $p_arr_newValues) : bool + +
                  + +
                  Parameters
                  +
                  +
                  + $p_int_Index + : int +
                  +
                  +

                  Index of the Settings container.

                  +
                  + +
                  +
                  + $p_arr_newValues + : array<string|int, mixed> +
                  +
                  +

                  new Settings.

                  +
                  + +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  Return values
                  + bool + — +
                  + + +
                  +
                  +

                  + __construct() + +

                  + + +

                  Class Constructor. Loads all Settings from each WordPress Settings container.

                  + + + private + __construct() : mixed + +
                  + + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  Return values
                  + mixed + — +
                  + + +
                  +
                  +

                  + Load() + +

                  + + +

                  Loads all Settings from specified Settings Container.

                  + + + private + Load(int $p_int_Index) : array<string|int, mixed> + +
                  + +
                  Parameters
                  +
                  +
                  + $p_int_Index + : int +
                  +
                  +

                  Settings Container Array Key Index.

                  +
                  + +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + since +
                  +
                  + +

                  ditched trimming whitespace from text box content in response to user request.

                  +
                  + +
                  +
                  + link +
                  +
                  + https://wordpress.org/support/topic/leading-space-in-footnotes-tag/#post-5347966 + +
                  +
                  + +
                  Return values
                  + array<string|int, mixed> + — +

                  Settings loaded from Container of Default Settings if Settings Container is empty (first usage).

                  +
                  + + +
                  +
                  +

                  + loadAll() + +

                  + + +

                  Loads all Settings from each Settings container.

                  + + + private + loadAll() : mixed + +
                  + + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  Return values
                  + mixed + — +
                  + + +
                  +
                  + +
                  +
                  +
                  +
                  +

                  Search results

                  + +
                  +
                  +
                    +
                    +
                    +
                    +
                    +
                    + + +
                    + + + + diff --git a/docs/classes/MCI-Footnotes-Task.html b/docs/classes/MCI-Footnotes-Task.html new file mode 100644 index 0000000..b8cddb3 --- /dev/null +++ b/docs/classes/MCI-Footnotes-Task.html @@ -0,0 +1,2902 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                    +

                    Documentation

                    + + +
                    + +
                    + + +
                    + +
                    +
                    + + + + +
                    + + +
                    +

                    + MCI_Footnotes_Task + + + + +

                    + + + +

                    Searches and replaces the footnotes.

                    + +

                    Generates the reference container.

                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.0 + +
                    + +
                    +
                    + + + + + + +

                    + Table of Contents + +

                    + +
                    +
                    + $a_arr_Footnotes + +  : array<string|int, mixed> +
                    +
                    Contains all footnotes found on current public page.
                    + +
                    + $a_bool_AllowLoveMe + +  : bool +
                    +
                    Flag if the display of 'LOVE FOOTNOTES' is allowed on the current public page.
                    + +
                    + $a_bool_AlternativeTooltipsEnabled + +  : mixed +
                    +
                    + +
                    + $a_bool_HardLinksEnable + +  : bool|str|int +
                    +
                    Hard links for AMP compatibility
                    + +
                    + $a_bool_MirrorTooltipText + +  : mixed +
                    +
                    Dedicated tooltip text
                    + +
                    + $a_bool_SyntaxErrorFlag + +  : bool +
                    +
                    Footnote delimiter syntax validation
                    + +
                    + $a_bool_TooltipsEnabled + +  : bool +
                    +
                    Template process optimization
                    + +
                    + $a_int_PostId + +  : int +
                    +
                    Infinite scroll / autoload or archive view
                    + +
                    + $a_int_ReferenceContainerId + +  : int +
                    +
                    Multiple reference containers in content and widgets
                    + +
                    + $a_int_ScrollOffset + +  : int +
                    +
                    Scroll offset
                    + +
                    + $a_int_TooltipShortcodeLength + +  : mixed +
                    +
                    + +
                    + $a_str_FootnoteLinkSlug + +  : mixed +
                    +
                    + +
                    + $a_str_LinkCloseTag + +  : mixed +
                    +
                    + +
                    + $a_str_LinkIdsSeparator + +  : mixed +
                    +
                    + +
                    + $a_str_LinkOpenTag + +  : mixed +
                    +
                    + +
                    + $a_str_LinkSpan + +  : mixed +
                    +
                    Optional link element for footnote referrers and backlinks
                    + +
                    + $a_str_PostContainerIdCompound + +  : mixed +
                    +
                    + +
                    + $a_str_Prefix + +  : string +
                    +
                    Prefix for the Footnote html element ID.
                    + +
                    + $a_str_ReferrerLinkSlug + +  : mixed +
                    +
                    + +
                    + $a_str_TooltipShortcode + +  : mixed +
                    +
                    + +
                    + exec() + +  : string +
                    +
                    Replaces all footnotes that occur in the given content.
                    + +
                    + ReferenceContainer() + +  : string +
                    +
                    Generates the reference container.
                    + +
                    + registerHooks() + +  : mixed +
                    +
                    Register WordPress Hooks to replace Footnotes in the content of a public page.
                    + +
                    + search() + +  : string +
                    +
                    Replaces all footnotes in the given content and appends them to the static property.
                    + +
                    + the_content() + +  : string +
                    +
                    Replaces footnotes in the content of the current page/post.
                    + +
                    + the_excerpt() + +  : string +
                    +
                    Replaces footnotes in the excerpt of the current page/post.
                    + +
                    + the_post() + +  : mixed +
                    +
                    Replaces footnotes in each Content var of the current Post object.
                    + +
                    + the_title() + +  : string +
                    +
                    Replaces footnotes in the post/page title.
                    + +
                    + widget_text() + +  : string +
                    +
                    Replaces footnotes in the content of the current widget.
                    + +
                    + widget_title() + +  : string +
                    +
                    Replaces footnotes in the widget title.
                    + +
                    + wp_footer() + +  : mixed +
                    +
                    Displays the 'LOVE FOOTNOTES' slug if enabled.
                    + +
                    + wp_head() + +  : mixed +
                    +
                    Outputs the custom css to the header of the public page.
                    + +
                    + replacePostObject() + +  : WP_Post +
                    +
                    Replace all Footnotes in a WP_Post object.
                    + +
                    + + + + + + +
                    +

                    + Properties + +

                    +
                    +

                    + $a_arr_Footnotes + + + +

                    + + +

                    Contains all footnotes found on current public page.

                    + + + public + static array<string|int, mixed> + $a_arr_Footnotes + = array() + +
                    + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.0 + +
                    + +
                    +
                    + +
                    +
                    +

                    + $a_bool_AllowLoveMe + + + +

                    + + +

                    Flag if the display of 'LOVE FOOTNOTES' is allowed on the current public page.

                    + + + public + static bool + $a_bool_AllowLoveMe + = rue + +
                    + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.0 + +
                    + +
                    +
                    + +
                    +
                    +

                    + $a_bool_AlternativeTooltipsEnabled + + + +

                    + + + + + public + static mixed + $a_bool_AlternativeTooltipsEnabled + = alse + + + + +
                    +
                    +

                    + $a_bool_HardLinksEnable + + + +

                    + + +

                    Hard links for AMP compatibility

                    + + + public + static bool|str|int + $a_bool_HardLinksEnable + = alse + +
                    + + +
                    + Tags + +
                    +
                    +
                    + since +
                    +
                    + 2.0.0 + +

                    Bugfix: footnote links script independent.

                    +
                      +
                    • Bugfix: Referrers and backlinks: remove hard links to streamline browsing history, thanks to @theroninjedi47 bug report.
                      • +
                    +
                    + +
                    +
                    + since +
                    +
                    + 2.0.4 + +
                    + +
                    +
                    + since +
                    +
                    + 2.3.0 + +
                    + +
                    +
                    + reporter +
                    +
                    + +

                    @theroninjedi47

                    +
                    + +
                    +
                    + reporter +
                    +
                    + +

                    @psykonevro

                    +
                    + +
                    +
                    + link +
                    +
                    +
                      +
                    • Adding: Referrers and backlinks: optional hard links for AMP compatibility, thanks to @psykonevro bug report, thanks to @martinneumannat code contribution.
                      • +
                    +                     + +
                    +
                    + link +
                    +
                    + https://wordpress.org/support/topic/making-it-amp-compatible/ + +
                    +
                    + link +
                    +
                    +

                    The official AMP plugin strips off JavaScript, breaking Footnotes’ +animated scrolling. +When the alternative reference container is enabled, hard links are too.

                    +                     + +
                    +
                    + contributor +
                    +
                    + +

                    @martinneumannat

                    +
                    + +
                    +
                    + +
                    +
                    +

                    + $a_bool_MirrorTooltipText + + + +

                    + + +

                    Dedicated tooltip text

                    + + + public + static mixed + $a_bool_MirrorTooltipText + = alse + +
                      +
                    • Update: Tooltips: ability to display dedicated content before [[/tooltip]], thanks to @jbj2199 issue report.
                      • +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + since +
                    +
                    + 2.5.2 + +
                    + +
                    +
                    + date +
                    +
                    + +

                    2021-01-19T2223+0100

                    +
                    + +
                    +
                    + reporter +
                    +
                    + +

                    @jbj2199

                    +
                    + +
                    +
                    + link +
                    +
                    +

                    Tooltips can display another content than the footnote entry +in the reference container. The trigger is a shortcode in +the footnote text separating the tooltip text from the note. +That is consistent with what WordPress does for excerpts.

                    +                     + +
                    +
                    + +
                    +
                    +

                    + $a_bool_SyntaxErrorFlag + + + +

                    + + +

                    Footnote delimiter syntax validation

                    + + + public + static bool + $a_bool_SyntaxErrorFlag + = rue + +
                      +
                    • Adding: Footnote delimiters: syntax validation for balanced footnote start and end tag short codes.
                      • +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + since +
                    +
                    + 2.4.0 + +
                    + +
                    +
                    + date +
                    +
                    + +

                    2021-01-01T0227+0100

                    +
                    + +
                    +
                    + +
                    +
                    +

                    + $a_bool_TooltipsEnabled + + + +

                    + + +

                    Template process optimization

                    + + + public + static bool + $a_bool_TooltipsEnabled + = alse + +
                      +
                    • Bugfix: Templates: optimize template load and processing based on settings, thanks to @misfist code contribution.
                      • +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + since +
                    +
                    + 2.4.0 + +
                    + +
                    +
                    + date +
                    +
                    + +

                    2021-01-04T1355+0100

                    +
                    + +
                    +
                    + author +
                    +
                    + +

                    Patrizia Lutz @misfist

                    +
                    + +
                    +
                    + link +
                    +
                    + https://wordpress.org/support/topic/template-override-filter/#post-13864301 + +
                    +
                    + link +
                    +
                    +

                    repository

                    +                     + +
                    +
                    + link +
                    +
                    +

                    diff

                    +                     + +
                    +
                    + +
                    +
                    +

                    + $a_int_PostId + + + +

                    + + +

                    Infinite scroll / autoload or archive view

                    + + + public + static int + $a_int_PostId + = 0 + +
                      +
                    • Bugfix: Infinite scroll: debug autoload by adding post ID, thanks to @docteurfitness code contribution
                      • +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + since +
                    +
                    + 2.0.6 + +
                    + +
                    +
                    + contributor +
                    +
                    + +

                    @docteurfitness

                    +
                    + +
                    +
                    + link +
                    +
                    + https://wordpress.org/support/topic/auto-load-post-compatibility-update/#post-13618833 + +
                    +
                    + link +
                    +
                    +

                    As multiple posts are appended to each other, functions and fragment IDs must be disambiguated. +post ID to make everything unique wrt infinite scroll and archive view:

                    +                     + +
                    +
                    + reporter +
                    +
                    + +

                    @docteurfitness

                    +
                    + +
                    +
                    + +
                    +
                    +

                    + $a_int_ReferenceContainerId + + + +

                    + + +

                    Multiple reference containers in content and widgets

                    + + + public + static int + $a_int_ReferenceContainerId + = 1 + +
                      +
                    • Bugfix: Reference container, widget_text hook: support for multiple containers in a page, thanks to @justbecuz bug report.
                      • +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + since +
                    +
                    + 2.2.9 + +
                    + +
                    +
                    + date +
                    +
                    + +

                    2020-12-25T0338+0100

                    +
                    + +
                    +
                    + reporter +
                    +
                    + +

                    @justbecuz

                    +
                    + +
                    +
                    + link +
                    +
                    + https://wordpress.org/support/topic/reset-footnotes-to-1/ + +
                    +
                    + link +
                    +
                    + https://wordpress.org/support/topic/reset-footnotes-to-1/#post-13662830 + +
                    +
                    + +
                    +
                    +

                    + $a_int_ScrollOffset + + + +

                    + + +

                    Scroll offset

                    + + + public + static int + $a_int_ScrollOffset + = 34 + +
                      +
                    • Bugfix: Scroll offset: make configurable to fix site-dependent issues related to fixed headers.
                      • +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + since +
                    +
                    + 2.1.4 + +
                    + +
                    +
                    + since +
                    +
                    + 2.4.0 + +
                    + +
                    +
                    + date +
                    +
                    + +

                    2020-12-05T0538+0100

                    +
                      +
                    • Bugfix: Scroll offset: initialize to safer one third window height for more robustness, thanks to @lukashuggenberg bug report.
                      • +
                    +
                    + +
                    +
                    + date +
                    +
                    + +

                    2021-01-03T2055+0100

                    +
                    + +
                    +
                    + date +
                    +
                    + +

                    2021-01-04T0504+0100

                    +
                    + +
                    +
                    + reporter +
                    +
                    + +

                    @lukashuggenberg

                    +
                    + +
                    +
                    + link +
                    +
                    + https://wordpress.org/support/topic/2-2-6-breaks-all-footnotes/#post-13857922 + +
                    +
                    + +
                    +
                    +

                    + $a_int_TooltipShortcodeLength + + + +

                    + + + + + public + static mixed + $a_int_TooltipShortcodeLength + = 12 + + + + +
                    +
                    +

                    + $a_str_FootnoteLinkSlug + + + +

                    + + + + + public + static mixed + $a_str_FootnoteLinkSlug + = 'f' + + + + +
                    +
                    +

                    + $a_str_LinkCloseTag + + + +

                    + + + + + public + static mixed + $a_str_LinkCloseTag + = '' + + + + +
                    +
                    +

                    + $a_str_LinkIdsSeparator + + + +

                    + + + + + public + static mixed + $a_str_LinkIdsSeparator + = '+' + + + + +
                    +
                    +

                    + $a_str_LinkOpenTag + + + +

                    + + + + + public + static mixed + $a_str_LinkOpenTag + = '' + + + + +
                    +
                    +

                    + $a_str_LinkSpan + + + +

                    + + +

                    Optional link element for footnote referrers and backlinks

                    + + + public + static mixed + $a_str_LinkSpan + = 'span' + +
                    + + +
                    + Tags + +
                    +
                    +
                    + since +
                    +
                    + 2.0.0 + +

                    add link elements along with hard links.

                    +
                      +
                    • Bugfix: Referrers and backlinks: Styling: make link elements optional to fix issues, thanks to @docteurfitness issue report and code contribution.
                      • +
                    +
                    + +
                    +
                    + since +
                    +
                    + 2.1.4 + +
                    + +
                    +
                    + since +
                    +
                    + 2.3.0 + +
                    + +
                    +
                    + date +
                    +
                    + +

                    2020-11-25T1306+0100

                    +
                    + +
                    +
                    + date +
                    +
                    + +

                    2020-11-26T1051+0100

                    +
                    + +
                    +
                    + date +
                    +
                    + +

                    2020-12-30T2313+0100

                    +
                    + +
                    +
                    + contributor +
                    +
                    + +

                    @docteurfitness

                    +
                    + +
                    +
                    + contributor +
                    +
                    + +

                    @martinneumannat

                    +
                    + +
                    +
                    + link +
                    +
                    + https://wordpress.org/support/topic/update-2-1-3/#post-13704194 + +
                    +
                    + link +
                    +
                    +
                      +
                    • Adding: Referrers and backlinks: optional hard links for AMP compatibility, thanks to @psykonevro bug report, thanks to @martinneumannat code contribution.
                      • +
                    +                     + +
                    +
                    + link +
                    +
                    + https://wordpress.org/support/topic/making-it-amp-compatible/ + +
                    +
                    + link +
                    +
                    +

                    Although widely used for that purpose, hyperlinks are disliked for footnote linking. +Browsers may need to be prevented from logging these clicks in the browsing history, +as logging compromises the usability of the 'return to previous' button in browsers. +For that purpose, and for scroll animation, this linking is performed by JavaScript.

                    +

                    Link elements raise concerns, so that mitigating their proliferation may be desired.

                    +

                    By contrast, due to an insufficiency in the CSS standard, coloring elements with the +theme’s link color requires real link elements and cannot be done with named colors, +as CSS does not support 'color: link|hover|active|visited', after the pseudo-classes +of the link element.

                    +

                    Yet styling these elements with the link color is not universally preferred, so that +the very presence of these link elements may need to be avoided.

                    +                     + +
                    +
                    + reporter +
                    +
                    + +

                    @docteurfitness

                    +
                    + +
                    +
                    + reporter +
                    +
                    + +

                    @psykonevro

                    +
                    + +
                    +
                    + see +
                    +
                    + self::$a_bool_HardLinksEnable + +
                    + +
                    +
                    + +
                    +
                    +

                    + $a_str_PostContainerIdCompound + + + +

                    + + + + + public + static mixed + $a_str_PostContainerIdCompound + = '' + + + + +
                    +
                    +

                    + $a_str_Prefix + + + +

                    + + +

                    Prefix for the Footnote html element ID.

                    + + + public + static string + $a_str_Prefix + = "" + +
                    + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.8 + +
                    + +
                    +
                    + +
                    +
                    +

                    + $a_str_ReferrerLinkSlug + + + +

                    + + + + + public + static mixed + $a_str_ReferrerLinkSlug + = 'r' + + + + +
                    +
                    +

                    + $a_str_TooltipShortcode + + + +

                    + + + + + public + static mixed + $a_str_TooltipShortcode + = '[[/tooltip]]' + + + + +
                    +
                    + +
                    +

                    + Methods + +

                    +
                    +

                    + exec() + +

                    + + +

                    Replaces all footnotes that occur in the given content.

                    + + + public + exec(string $p_str_Content[, bool $p_bool_OutputReferences = false ][, bool $p_bool_HideFootnotesText = false ]) : string + +
                    + +
                    Parameters
                    +
                    +
                    + $p_str_Content + : string +
                    +
                    +

                    Any string that may contain footnotes to be replaced.

                    +
                    + +
                    +
                    + $p_bool_OutputReferences + : bool + = false
                    +
                    +

                    Appends the Reference Container to the output if set to true, default true.

                    +
                    + +
                    +
                    + $p_bool_HideFootnotesText + : bool + = false
                    +
                    +

                    Hide footnotes found in the string.

                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.0 + +
                    + +
                    +
                    + since +
                    +
                    + 2.2.0 + +

                    Adding: Reference container: support for custom position shortcode, thanks to @hamshe issue report.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.2.5 + +

                    Bugfix: Reference container: delete position shortcode if unused because position may be widget or footer, thanks to @hamshe bug report.

                    +
                    + +
                    +
                    + +
                    Return values
                    + string + — +
                    + + +
                    +
                    +

                    + ReferenceContainer() + +

                    + + +

                    Generates the reference container.

                    + + + public + ReferenceContainer() : string + +
                    + + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.0 + +
                    + +
                    +
                    + since +
                    +
                    + 2.0.0 + +

                    Update: remove backlink symbol along with column 2 of the reference container

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.0.3 + +

                    Bugfix: prepend an arrow on user request

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.0.6 + +

                    Bugfix: Reference container: fix line breaking behavior in footnote number clusters.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.0.4 + +

                    Bugfix: restore the arrow select and backlink symbol input settings

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.1.1 + +

                    Bugfix: Referrers, reference container: Combining identical footnotes: fix dead links and ensure referrer-backlink bijectivity, thanks to @happyches bug report.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.1.1 + +

                    Bugfix: Reference container: Backlink symbol: make optional, not suggest configuring it to invisible, thanks to @spaceling feedback.

                    +
                    + +
                    +
                    + +
                    Return values
                    + string + — +
                    + + +
                    +
                    +

                    + registerHooks() + +

                    + + +

                    Register WordPress Hooks to replace Footnotes in the content of a public page.

                    + + + public + registerHooks() : mixed + +
                    + + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.0 + +
                    + +
                    +
                    + since +
                    +
                    + 1.5.4 + +

                    Adding: Hooks: support 'the_post' in response to user request for custom post types.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.0.5 + +

                    Bugfix: Reference container: fix relative position through priority level, thanks to @june01 @imeson @spaceling bug reports, thanks to @spaceling code contribution.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.0.5 + +

                    Update: Hooks: Default-enable all hooks to prevent footnotes from seeming broken in some parts.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.0.6 + +

                    Bugfix: Priority level back to PHP_INT_MAX (ref container positioning not this plugin’s responsibility).

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.0.7 + +

                    BUGFIX: Hooks: Default-disable 'the_post', thanks to @spaceling @markcheret @nyamachi @whichgodsaves @spiralofhope2 @mmallett @andreasra @widecast @ymorin007 @tashi1es bug reports.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.0.7 + +

                    Bugfix: Set priority level back to 10 assuming it is unproblematic 2020-11-06T1344+0100.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.0.8 + +

                    Bugfix: Priority level back to PHP_INT_MAX (need to get in touch with other plugins).

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.1.0 + +

                    UPDATE: Hooks: remove 'the_post', the plugin stops supporting this hook.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.1.1 + +

                    Bugfix: Dashboard: priority level setting for the_content hook, thanks to @imeson bug report.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.1.2 + +

                    Bugfix: Dashboard: priority level settings for all other hooks, thanks to @nikelaos bug report.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.5.0 + +

                    Bugfix: Hooks: support footnotes on category pages, thanks to @vitaefit bug report, thanks to @misfist code contribution.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.5.1 + +

                    Bugfix: Hooks: support footnotes in Popup Maker popups, thanks to @squatcher bug report.

                    +
                    + +
                    +
                    + +
                    Return values
                    + mixed + — +
                    + + +
                    +
                    +

                    + search() + +

                    + + +

                    Replaces all footnotes in the given content and appends them to the static property.

                    + + + public + search(string $p_str_Content, bool $p_bool_ConvertHtmlChars, bool $p_bool_HideFootnotesText) : string + +
                    + +
                    Parameters
                    +
                    +
                    + $p_str_Content + : string +
                    +
                    +

                    Content to be searched for footnotes.

                    +
                    + +
                    +
                    + $p_bool_ConvertHtmlChars + : bool +
                    +
                    +

                    html encode settings, default true.

                    +
                    + +
                    +
                    + $p_bool_HideFootnotesText + : bool +
                    +
                    +

                    Hide footnotes found in the string.

                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.0 + +
                    + +
                    +
                    + since +
                    +
                    + 2.0.0 + +

                    various.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.4.0 + +

                    Adding: Footnote delimiters: syntax validation for balanced footnote start and end tag short codes.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.5.0 + +

                    Bugfix: Footnote delimiters: Syntax validation: exclude certain cases involving scripts, thanks to @andreasra bug report.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.5.0 + +

                    Bugfix: Footnote delimiters: Syntax validation: complete message with hint about setting, thanks to @andreasra bug report.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.5.0 + +

                    Bugfix: Footnote delimiters: Syntax validation: limit length of quoted string to 300 characters, thanks to @andreasra bug report.

                    +
                    + +
                    +
                    + +
                    Return values
                    + string + — +
                    + + +
                    +
                    +

                    + the_content() + +

                    + + +

                    Replaces footnotes in the content of the current page/post.

                    + + + public + the_content(string $p_str_Content) : string + +
                    + +
                    Parameters
                    +
                    +
                    + $p_str_Content + : string +
                    +
                    +

                    Page/Post content.

                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.0 + +
                    + +
                    +
                    + +
                    Return values
                    + string + — +

                    Content with replaced footnotes.

                    +
                    + + +
                    +
                    +

                    + the_excerpt() + +

                    + + +

                    Replaces footnotes in the excerpt of the current page/post.

                    + + + public + the_excerpt(string $p_str_Content) : string + +
                    + +
                    Parameters
                    +
                    +
                    + $p_str_Content + : string +
                    +
                    +

                    Page/Post content.

                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.0 + +
                    + +
                    +
                    + +
                    Return values
                    + string + — +

                    Content with replaced footnotes.

                    +
                    + + +
                    +
                    +

                    + the_post() + +

                    + + +

                    Replaces footnotes in each Content var of the current Post object.

                    + + + public + the_post(array<string|int, mixed>|WP_Post &$p_mixed_Posts) : mixed + +
                    + +
                    Parameters
                    +
                    +
                    + $p_mixed_Posts + : array<string|int, mixed>|WP_Post +
                    +
                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.4 + +
                    + +
                    +
                    + +
                    Return values
                    + mixed + — +
                    + + +
                    +
                    +

                    + the_title() + +

                    + + +

                    Replaces footnotes in the post/page title.

                    + + + public + the_title(string $p_str_Content) : string + +
                    + +
                    Parameters
                    +
                    +
                    + $p_str_Content + : string +
                    +
                    +

                    Widget content.

                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.0 + +
                    + +
                    +
                    + +
                    Return values
                    + string + — +

                    Content with replaced footnotes.

                    +
                    + + +
                    +
                    +

                    + widget_text() + +

                    + + +

                    Replaces footnotes in the content of the current widget.

                    + + + public + widget_text(string $p_str_Content) : string + +
                    + +
                    Parameters
                    +
                    +
                    + $p_str_Content + : string +
                    +
                    +

                    Widget content.

                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.0 + +
                    + +
                    +
                    + +
                    Return values
                    + string + — +

                    Content with replaced footnotes.

                    +
                    + + +
                    +
                    +

                    + widget_title() + +

                    + + +

                    Replaces footnotes in the widget title.

                    + + + public + widget_title(string $p_str_Content) : string + +
                    + +
                    Parameters
                    +
                    +
                    + $p_str_Content + : string +
                    +
                    +

                    Widget content.

                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.0 + +
                    + +
                    +
                    + +
                    Return values
                    + string + — +

                    Content with replaced footnotes.

                    +
                    + + +
                    +
                    +

                    + wp_footer() + +

                    + + +

                    Displays the 'LOVE FOOTNOTES' slug if enabled.

                    + + + public + wp_footer() : mixed + +
                    + + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.0 + +
                    + +
                    +
                    + since +
                    +
                    + 2.2.0 + +

                    more options 2020-12-11T0506+0100

                    +
                    + +
                    +
                    + +
                    Return values
                    + mixed + — +
                    + + +
                    +
                    +

                    + wp_head() + +

                    + + +

                    Outputs the custom css to the header of the public page.

                    + + + public + wp_head() : mixed + +
                    + + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.0 + +
                    + +
                    +
                    + since +
                    +
                    + 2.1.1 + +

                    Bugfix: Reference container: fix start pages by making its display optional, thanks to @dragon013 bug report.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.1.1 + +

                    Bugfix: Tooltips: optional alternative JS implementation with CSS transitions to fix configuration-related outage, thanks to @andreasra feedback.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.1.3 + +

                    raise settings priority to override theme stylesheets

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.1.4 + +

                    Bugfix: Tooltips: Styling: fix font size issue by adding font size to settings with legacy as default.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.1.4 + +

                    Bugfix: Reference container: fix layout issues by moving backlink column width to settings.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.2.5 + +

                    Bugfix: Reference container: Label: make bottom border an option, thanks to @markhillyer issue report.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.2.5 + +

                    Bugfix: Reference container: Label: option to select paragraph or heading element, thanks to @markhillyer issue report.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.3.0 + +

                    Bugfix: Reference container: convert top padding to margin and make it a setting, thanks to @hamshe bug report.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.5.4 + +

                    Bugfix: Referrers: optional fixes to vertical alignment, font size and position (static) for in-theme consistency and cross-theme stability, thanks to @tomturowski bug report.

                    +
                    + +
                    +
                    + +
                    Return values
                    + mixed + — +
                    + + +
                    +
                    +

                    + replacePostObject() + +

                    + + +

                    Replace all Footnotes in a WP_Post object.

                    + + + private + replacePostObject(WP_Post $p_obj_Post) : WP_Post + +
                    + +
                    Parameters
                    +
                    +
                    + $p_obj_Post + : WP_Post +
                    +
                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.6 + +
                    + +
                    +
                    + +
                    Return values
                    + WP_Post + — +
                    + + +
                    +
                    + +
                    +
                    +
                    +
                    +

                    Search results

                    + +
                    +
                    +
                      +
                      +
                      +
                      +
                      +
                      + + +
                      + + + + diff --git a/docs/classes/MCI-Footnotes-Template.html b/docs/classes/MCI-Footnotes-Template.html new file mode 100644 index 0000000..98bc1ed --- /dev/null +++ b/docs/classes/MCI-Footnotes-Template.html @@ -0,0 +1,1044 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                      +

                      Documentation

                      + + +
                      + +
                      + + +
                      + +
                      +
                      + + + + +
                      + + +
                      +

                      + MCI_Footnotes_Template + + + + +

                      + + + +

                      Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).

                      + +

                      Loads a template file, replaces all Placeholders and returns the replaced file content.

                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + author +
                      +
                      + +

                      Stefan Herndler

                      +
                      + +
                      +
                      + since +
                      +
                      + 1.5.0 + +
                      + +
                      +
                      + + + + + + +

                      + Table of Contents + +

                      + +
                      +
                      + C_STR_DASHBOARD + +  = "dashboard" +
                      +
                      Directory name for dashboard templates.
                      + +
                      + C_STR_PUBLIC + +  = "public" +
                      +
                      Directory name for public templates.
                      + +
                      + $plugin_directory + +  : string +
                      +
                      Plugin Directory
                      + +
                      + $a_str_OriginalContent + +  : string +
                      +
                      Contains the content of the template after initialize.
                      + +
                      + $a_str_ReplacedContent + +  : string +
                      +
                      Contains the content of the template after initialize with replaced place holders.
                      + +
                      + __construct() + +  : mixed +
                      +
                      Class Constructor. Reads and loads the template file without replace any placeholder.
                      + +
                      + get_template() + +  : mixed +
                      +
                      Get the template
                      + +
                      + getContent() + +  : string +
                      +
                      Returns the content of the template file with replaced placeholders.
                      + +
                      + process_template() + +  : void +
                      +
                      Process template file
                      + +
                      + reload() + +  : mixed +
                      +
                      Reloads the original content of the template file.
                      + +
                      + replace() + +  : bool +
                      +
                      Replace all placeholders specified in array.
                      + +
                      + + + + +
                      +

                      + Constants + +

                      +
                      +

                      + C_STR_DASHBOARD + +

                      + + + +

                      Directory name for dashboard templates.

                      + + + public + string + C_STR_DASHBOARD + = "dashboard" + + + +
                      + + +
                      + Tags + +
                      +
                      +
                      + author +
                      +
                      + +

                      Stefan Herndler

                      +
                      + +
                      +
                      + since +
                      +
                      + 1.5.0 + +
                      + +
                      +
                      + +
                      +
                      +

                      + C_STR_PUBLIC + +

                      + + + +

                      Directory name for public templates.

                      + + + public + string + C_STR_PUBLIC + = "public" + + + +
                      + + +
                      + Tags + +
                      +
                      +
                      + author +
                      +
                      + +

                      Stefan Herndler

                      +
                      + +
                      +
                      + since +
                      +
                      + 1.5.0 + +
                      + +
                      +
                      + +
                      +
                      + + +
                      +

                      + Properties + +

                      +
                      +

                      + $plugin_directory + + + +

                      + + +

                      Plugin Directory

                      + + + public + string + $plugin_directory + + +
                      + + +
                      + Tags + +
                      +
                      +
                      + author +
                      +
                      + +

                      Patrizia Lutz @misfist

                      +
                      + +
                      +
                      + since +
                      +
                      + 2.4.0d3 + +
                      + +
                      +
                      + +
                      +
                      +

                      + $a_str_OriginalContent + + + +

                      + + +

                      Contains the content of the template after initialize.

                      + + + private + string + $a_str_OriginalContent + = "" + +
                      + + +
                      + Tags + +
                      +
                      +
                      + author +
                      +
                      + +

                      Stefan Herndler

                      +
                      + +
                      +
                      + since +
                      +
                      + 1.5.0 + +
                      + +
                      +
                      + +
                      +
                      +

                      + $a_str_ReplacedContent + + + +

                      + + +

                      Contains the content of the template after initialize with replaced place holders.

                      + + + private + string + $a_str_ReplacedContent + = "" + +
                      + + +
                      + Tags + +
                      +
                      +
                      + author +
                      +
                      + +

                      Stefan Herndler

                      +
                      + +
                      +
                      + since +
                      +
                      + 1.5.0 + +
                      + +
                      +
                      + +
                      +
                      + +
                      +

                      + Methods + +

                      +
                      +

                      + __construct() + +

                      + + +

                      Class Constructor. Reads and loads the template file without replace any placeholder.

                      + + + public + __construct(string $p_str_FileType, string $p_str_FileName[, string $p_str_Extension = "html" ]) : mixed + +
                      + +
                      Parameters
                      +
                      +
                      + $p_str_FileType + : string +
                      +
                      +

                      Template file type (take a look on the Class constants).

                      +
                      + +
                      +
                      + $p_str_FileName + : string +
                      +
                      +

                      Template file name inside the Template directory without the file extension.

                      +
                      + +
                      +
                      + $p_str_Extension + : string + = "html"
                      +
                      +

                      Optional Template file extension (default: html)

                      +
                      + +
                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + author +
                      +
                      + +

                      Stefan Herndler

                      +
                      + +
                      +
                      + since +
                      +
                      + 1.5.0 + +
                      + +
                      +
                      + since +
                      +
                      + 2.2.6 + +

                      support for custom templates 2020-12-19T0606+0100

                      +
                      + +
                      +
                      + since +
                      +
                      + 2.4.0 + +

                      look for custom template in the active theme first, thanks to @misfist

                      +
                      + +
                      +
                      + link +
                      +
                      + https://wordpress.org/support/topic/template-override-filter/ + +
                      +
                      + link +
                      +
                      + https://wordpress.org/support/topic/template-override-filter/#post-13846598 + +
                      +
                      + +
                      Return values
                      + mixed + — +
                      + + +
                      +
                      +

                      + get_template() + +

                      + + +

                      Get the template

                      + + + public + get_template(string $p_str_FileType, string $p_str_FileName[, string $p_str_Extension = "html" ]) : mixed + +
                      + +
                      Parameters
                      +
                      +
                      + $p_str_FileType + : string +
                      +
                      +
                      + +
                      +
                      + $p_str_FileName + : string +
                      +
                      +
                      + +
                      +
                      + $p_str_Extension + : string + = "html"
                      +
                      +
                      + +
                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + author +
                      +
                      + +

                      Patrizia Lutz @misfist

                      +
                      + +
                      +
                      + since +
                      +
                      + 2.4.0d3 + +
                      + +
                      +
                      + +
                      Return values
                      + mixed + — +

                      false | template path

                      +
                      + + +
                      +
                      +

                      + getContent() + +

                      + + +

                      Returns the content of the template file with replaced placeholders.

                      + + + public + getContent() : string + +
                      + + + +
                      + Tags + +
                      +
                      +
                      + author +
                      +
                      + +

                      Stefan Herndler

                      +
                      + +
                      +
                      + since +
                      +
                      + 1.5.0 + +
                      + +
                      +
                      + +
                      Return values
                      + string + — +

                      Template content with replaced placeholders.

                      +
                      + + +
                      +
                      +

                      + process_template() + +

                      + + +

                      Process template file

                      + + + public + process_template(string $template) : void + +
                      + +
                      Parameters
                      +
                      +
                      + $template + : string +
                      +
                      +
                      + +
                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + author +
                      +
                      + +

                      Patrizia Lutz @misfist

                      +
                      + +
                      +
                      + since +
                      +
                      + 2.4.0d3 + +
                      + +
                      +
                      + since +
                      +
                      + 2.0.3 + +

                      replace tab with a space

                      +
                      + +
                      +
                      + since +
                      +
                      + 2.0.3 + +

                      replace 2 spaces with 1

                      +
                      + +
                      +
                      + since +
                      +
                      + 2.0.4 + +

                      collapse multiple spaces

                      +
                      + +
                      +
                      + since +
                      +
                      + 2.2.6 + +

                      delete a space before a closing pointy bracket

                      +
                      + +
                      +
                      + since +
                      +
                      + 2.5.4 + +

                      collapse HTML comments and PHP/JS docblocks (only)

                      +
                      + +
                      +
                      + +
                      Return values
                      + void + — +
                      + + +
                      +
                      +

                      + reload() + +

                      + + +

                      Reloads the original content of the template file.

                      + + + public + reload() : mixed + +
                      + + + +
                      + Tags + +
                      +
                      +
                      + author +
                      +
                      + +

                      Stefan Herndler

                      +
                      + +
                      +
                      + since +
                      +
                      + 1.5.0 + +
                      + +
                      +
                      + +
                      Return values
                      + mixed + — +
                      + + +
                      +
                      +

                      + replace() + +

                      + + +

                      Replace all placeholders specified in array.

                      + + + public + replace(array<string|int, mixed> $p_arr_Placeholders) : bool + +
                      + +
                      Parameters
                      +
                      +
                      + $p_arr_Placeholders + : array<string|int, mixed> +
                      +
                      +

                      Placeholders (key = placeholder, value = value).

                      +
                      + +
                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + author +
                      +
                      + +

                      Stefan Herndler

                      +
                      + +
                      +
                      + since +
                      +
                      + 1.5.0 + +
                      + +
                      +
                      + +
                      Return values
                      + bool + — +

                      True on Success, False if Placeholders invalid.

                      +
                      + + +
                      +
                      + +
                      +
                      +
                      +
                      +

                      Search results

                      + +
                      +
                      +
                        +
                        +
                        +
                        +
                        +
                        + + +
                        + + + + diff --git a/docs/classes/MCI-Footnotes-WYSIWYG.html b/docs/classes/MCI-Footnotes-WYSIWYG.html new file mode 100644 index 0000000..08eae4a --- /dev/null +++ b/docs/classes/MCI-Footnotes-WYSIWYG.html @@ -0,0 +1,492 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                        +

                        Documentation

                        + + +
                        + +
                        + + +
                        + +
                        +
                        + + + + +
                        + + +
                        +

                        + MCI_Footnotes_WYSIWYG + + + + +

                        + + + + +
                        + + +
                        + Tags + +
                        +
                        +
                        + author +
                        +
                        + +

                        Stefan Herndler

                        +
                        + +
                        +
                        + since +
                        +
                        + 1.5.0 + +
                        + +
                        +
                        + + + + + + +

                        + Table of Contents + +

                        + +
                        +
                        + ajaxCallback() + +  : mixed +
                        +
                        AJAX Callback function when the Footnotes Button is clicked. Either in the Plain text or Visual editor.
                        + +
                        + includeScripts() + +  : array<string|int, mixed> +
                        +
                        Includes the Plugins WYSIWYG editor script.
                        + +
                        + newPlainTextEditorButton() + +  : mixed +
                        +
                        Add a new button to the plain text editor.
                        + +
                        + newVisualEditorButton() + +  : array<string|int, mixed> +
                        +
                        Append a new Button to the WYSIWYG editor of Posts and Pages.
                        + +
                        + registerHooks() + +  : mixed +
                        +
                        + +
                        + + + + + + + +
                        +

                        + Methods + +

                        +
                        +

                        + ajaxCallback() + +

                        + + +

                        AJAX Callback function when the Footnotes Button is clicked. Either in the Plain text or Visual editor.

                        + + + public + static ajaxCallback() : mixed + +

                        Returns an JSON encoded array with the Footnotes start and end short code.

                        +
                        + + + +
                        + Tags + +
                        +
                        +
                        + author +
                        +
                        + +

                        Stefan Herndler

                        +
                        + +
                        +
                        + since +
                        +
                        + 1.5.0 + +
                        + +
                        +
                        + +
                        Return values
                        + mixed + — +
                        + + +
                        +
                        +

                        + includeScripts() + +

                        + + +

                        Includes the Plugins WYSIWYG editor script.

                        + + + public + static includeScripts(array<string|int, mixed> $p_arr_Plugins) : array<string|int, mixed> + +
                        + +
                        Parameters
                        +
                        +
                        + $p_arr_Plugins + : array<string|int, mixed> +
                        +
                        +

                        Scripts to be included to the editor.

                        +
                        + +
                        +
                        + + +
                        + Tags + +
                        +
                        +
                        + author +
                        +
                        + +

                        Stefan Herndler

                        +
                        + +
                        +
                        + since +
                        +
                        + 1.5.0 + +
                        + +
                        +
                        + +
                        Return values
                        + array<string|int, mixed> + — +
                        + + +
                        +
                        +

                        + newPlainTextEditorButton() + +

                        + + +

                        Add a new button to the plain text editor.

                        + + + public + static newPlainTextEditorButton() : mixed + +
                        + + + +
                        + Tags + +
                        +
                        +
                        + author +
                        +
                        + +

                        Stefan Herndler

                        +
                        + +
                        +
                        + since +
                        +
                        + 1.5.0 + +
                        + +
                        +
                        + +
                        Return values
                        + mixed + — +
                        + + +
                        +
                        +

                        + newVisualEditorButton() + +

                        + + +

                        Append a new Button to the WYSIWYG editor of Posts and Pages.

                        + + + public + static newVisualEditorButton(array<string|int, mixed> $p_arr_Buttons) : array<string|int, mixed> + +
                        + +
                        Parameters
                        +
                        +
                        + $p_arr_Buttons + : array<string|int, mixed> +
                        +
                        +

                        pre defined Buttons from WordPress.

                        +
                        + +
                        +
                        + + +
                        + Tags + +
                        +
                        +
                        + author +
                        +
                        + +

                        Stefan Herndler

                        +
                        + +
                        +
                        + since +
                        +
                        + 1.5.0 + +
                        + +
                        +
                        + +
                        Return values
                        + array<string|int, mixed> + — +
                        + + +
                        +
                        +

                        + registerHooks() + +

                        + + + + + public + static registerHooks() : mixed + + + + + +
                        Return values
                        + mixed + — +
                        + + +
                        +
                        + +
                        +
                        +
                        +
                        +

                        Search results

                        + +
                        +
                        +
                          +
                          +
                          +
                          +
                          +
                          + + +
                          + + + + diff --git a/docs/classes/MCI-Footnotes-Widget-ReferenceContainer.html b/docs/classes/MCI-Footnotes-Widget-ReferenceContainer.html new file mode 100644 index 0000000..8ef7d35 --- /dev/null +++ b/docs/classes/MCI-Footnotes-Widget-ReferenceContainer.html @@ -0,0 +1,688 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                          +

                          Documentation

                          + + +
                          + +
                          + + +
                          + +
                          +
                          + + + + +
                          + + +
                          +

                          + MCI_Footnotes_Widget_ReferenceContainer + + + extends MCI_Footnotes_WidgetBase + + + + +

                          + + + +

                          Registers a Widget to put the Reference Container to the widget area.

                          + +
                          + + +
                          + Tags + +
                          +
                          +
                          + author +
                          +
                          + +

                          Stefan Herndler

                          +
                          + +
                          +
                          + since +
                          +
                          + 1.5.0 + +
                          + +
                          +
                          + + + + + + +

                          + Table of Contents + +

                          + +
                          +
                          + __construct() + +  : mixed +
                          +
                          Class Constructor. Registers the child Widget to WordPress.
                          + +
                          + form() + +  : void +
                          +
                          Outputs the Settings of the Widget.
                          + +
                          + widget() + +  : mixed +
                          +
                          Outputs the Content of the Widget.
                          + +
                          + getDescription() + +  : string +
                          +
                          Returns the Description of the child widget.
                          + +
                          + getID() + +  : string +
                          +
                          Returns an unique ID as string used for the Widget Base ID.
                          + +
                          + getName() + +  : string +
                          +
                          Returns the Public name of the Widget to be displayed in the Configuration page.
                          + +
                          + getWidgetWidth() + +  : int +
                          +
                          Returns the width of the Widget. Default width is 250 pixel.
                          + +
                          + + + + + + + +
                          +

                          + Methods + +

                          +
                          +

                          + __construct() + +

                          + + +

                          Class Constructor. Registers the child Widget to WordPress.

                          + + + public + __construct() : mixed + +
                          + + + +
                          + Tags + +
                          +
                          +
                          + author +
                          +
                          + +

                          Stefan Herndler

                          +
                          + +
                          +
                          + since +
                          +
                          + 1.5.0 + +
                            +
                          • Update: replace deprecated function WP_Widget() with recommended __construct(), thanks to @dartiss code contribution.
                            • +
                          +
                          + +
                          +
                          + since +
                          +
                          + 1.6.4 + +
                          + +
                          +
                          + contributor +
                          +
                          + +

                          @dartiss

                          +
                          + +
                          +
                          + link +
                          +
                          +

                          “The called constructor method for WP_Widget in MCI_Footnotes_Widget_ReferenceContainer is deprecated since version 4.3.0! Use __construct() instead.”

                          +                           + +
                          +
                          + +
                          Return values
                          + mixed + — +
                          + + +
                          +
                          +

                          + form() + +

                          + + +

                          Outputs the Settings of the Widget.

                          + + + public + form(mixed $instance) : void + +
                          + +
                          Parameters
                          +
                          +
                          + $instance + : mixed +
                          +
                          +
                          + +
                          +
                          + + +
                          + Tags + +
                          +
                          +
                          + author +
                          +
                          + +

                          Stefan Herndler

                          +
                          + +
                          +
                          + since +
                          +
                          + 1.5.0 + +
                          + +
                          +
                          + +
                          Return values
                          + void + — +

                          Edit: curly quotes 2.2.0 2020-12-12T2130+0100

                          +
                          + + +
                          +
                          +

                          + widget() + +

                          + + +

                          Outputs the Content of the Widget.

                          + + + public + widget(mixed $args, mixed $instance) : mixed + +
                          + +
                          Parameters
                          +
                          +
                          + $args + : mixed +
                          +
                          +
                          + +
                          +
                          + $instance + : mixed +
                          +
                          +
                          + +
                          +
                          + + +
                          + Tags + +
                          +
                          +
                          + author +
                          +
                          + +

                          Stefan Herndler

                          +
                          + +
                          +
                          + since +
                          +
                          + 1.5.0 + +
                          + +
                          +
                          + +
                          Return values
                          + mixed + — +
                          + + +
                          +
                          +

                          + getDescription() + +

                          + + +

                          Returns the Description of the child widget.

                          + + + protected + getDescription() : string + +
                          + + + +
                          + Tags + +
                          +
                          +
                          + author +
                          +
                          + +

                          Stefan Herndler

                          +
                          + +
                          +
                          + since +
                          +
                          + 1.5.0 + +
                          + +
                          +
                          + +
                          Return values
                          + string + — +

                          Edit: curly quotes 2.2.0 2020-12-12T2130+0100

                          +
                          + + +
                          +
                          +

                          + getID() + +

                          + + +

                          Returns an unique ID as string used for the Widget Base ID.

                          + + + protected + getID() : string + +
                          + + + +
                          + Tags + +
                          +
                          +
                          + author +
                          +
                          + +

                          Stefan Herndler

                          +
                          + +
                          +
                          + since +
                          +
                          + 1.5.0 + +
                          + +
                          +
                          + +
                          Return values
                          + string + — +
                          + + +
                          +
                          +

                          + getName() + +

                          + + +

                          Returns the Public name of the Widget to be displayed in the Configuration page.

                          + + + protected + getName() : string + +
                          + + + +
                          + Tags + +
                          +
                          +
                          + author +
                          +
                          + +

                          Stefan Herndler

                          +
                          + +
                          +
                          + since +
                          +
                          + 1.5.0 + +
                          + +
                          +
                          + +
                          Return values
                          + string + — +
                          + + +
                          +
                          +

                          + getWidgetWidth() + +

                          + + +

                          Returns the width of the Widget. Default width is 250 pixel.

                          + + + protected + getWidgetWidth() : int + +
                          + + + +
                          + Tags + +
                          +
                          +
                          + author +
                          +
                          + +

                          Stefan Herndler

                          +
                          + +
                          +
                          + since +
                          +
                          + 1.5.0 + +
                          + +
                          +
                          + +
                          Return values
                          + int + — +
                          + + +
                          +
                          + +
                          +
                          +
                          +
                          +

                          Search results

                          + +
                          +
                          +
                            +
                            +
                            +
                            +
                            +
                            + + +
                            + + + + diff --git a/docs/classes/MCI-Footnotes-WidgetBase.html b/docs/classes/MCI-Footnotes-WidgetBase.html new file mode 100644 index 0000000..31cc342 --- /dev/null +++ b/docs/classes/MCI-Footnotes-WidgetBase.html @@ -0,0 +1,529 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                            +

                            Documentation

                            + + +
                            + +
                            + + +
                            + +
                            +
                            + + + + +
                            + + +
                            +

                            + MCI_Footnotes_WidgetBase + + + extends WP_Widget + + + + +

                            + + + +

                            Base Class for all Plugin Widgets. Registers each Widget to WordPress.

                            + +

                            The following Methods MUST be overwritten in each sub class: +public function widget($args, $instance) -> echo the Widget Content +public function form($instance) -> echo the Settings of the Widget

                            +
                            + + +
                            + Tags + +
                            +
                            +
                            + author +
                            +
                            + +

                            Stefan Herndler

                            +
                            + +
                            +
                            + since +
                            +
                            + 1.5.0 + +
                            + +
                            +
                            + + + + + + +

                            + Table of Contents + +

                            + +
                            +
                            + __construct() + +  : mixed +
                            +
                            Class Constructor. Registers the child Widget to WordPress.
                            + +
                            + getDescription() + +  : string +
                            +
                            Returns the Description of the child widget.
                            + +
                            + getID() + +  : string +
                            +
                            Returns an unique ID as string used for the Widget Base ID.
                            + +
                            + getName() + +  : string +
                            +
                            Returns the Public name of child Widget to be displayed in the Configuration page.
                            + +
                            + getWidgetWidth() + +  : int +
                            +
                            Returns the width of the Widget. Default width is 250 pixel.
                            + +
                            + + + + + + + +
                            +

                            + Methods + +

                            +
                            +

                            + __construct() + +

                            + + +

                            Class Constructor. Registers the child Widget to WordPress.

                            + + + public + __construct() : mixed + +
                            + + + +
                            + Tags + +
                            +
                            +
                            + author +
                            +
                            + +

                            Stefan Herndler

                            +
                            + +
                            +
                            + since +
                            +
                            + 1.5.0 + +
                              +
                            • Update: replace deprecated function WP_Widget() with recommended __construct(), thanks to @dartiss code contribution.
                              • +
                            +
                            + +
                            +
                            + since +
                            +
                            + 1.6.4 + +
                            + +
                            +
                            + contributor +
                            +
                            + +

                            @dartiss

                            +
                            + +
                            +
                            + link +
                            +
                            +

                            “The called constructor method for WP_Widget in MCI_Footnotes_Widget_ReferenceContainer is deprecated since version 4.3.0! Use __construct() instead.”

                            +                             + +
                            +
                            + +
                            Return values
                            + mixed + — +
                            + + +
                            +
                            +

                            + getDescription() + +

                            + + +

                            Returns the Description of the child widget.

                            + + + protected + abstract getDescription() : string + +
                            + + + +
                            + Tags + +
                            +
                            +
                            + author +
                            +
                            + +

                            Stefan Herndler

                            +
                            + +
                            +
                            + since +
                            +
                            + 1.5.0 + +
                            + +
                            +
                            + +
                            Return values
                            + string + — +
                            + + +
                            +
                            +

                            + getID() + +

                            + + +

                            Returns an unique ID as string used for the Widget Base ID.

                            + + + protected + abstract getID() : string + +
                            + + + +
                            + Tags + +
                            +
                            +
                            + author +
                            +
                            + +

                            Stefan Herndler

                            +
                            + +
                            +
                            + since +
                            +
                            + 1.5.0 + +
                            + +
                            +
                            + +
                            Return values
                            + string + — +
                            + + +
                            +
                            +

                            + getName() + +

                            + + +

                            Returns the Public name of child Widget to be displayed in the Configuration page.

                            + + + protected + abstract getName() : string + +
                            + + + +
                            + Tags + +
                            +
                            +
                            + author +
                            +
                            + +

                            Stefan Herndler

                            +
                            + +
                            +
                            + since +
                            +
                            + 1.5.0 + +
                            + +
                            +
                            + +
                            Return values
                            + string + — +
                            + + +
                            +
                            +

                            + getWidgetWidth() + +

                            + + +

                            Returns the width of the Widget. Default width is 250 pixel.

                            + + + protected + getWidgetWidth() : int + +
                            + + + +
                            + Tags + +
                            +
                            +
                            + author +
                            +
                            + +

                            Stefan Herndler

                            +
                            + +
                            +
                            + since +
                            +
                            + 1.5.0 + +
                            + +
                            +
                            + +
                            Return values
                            + int + — +
                            + + +
                            +
                            + +
                            +
                            +
                            +
                            +

                            Search results

                            + +
                            +
                            +
                              +
                              +
                              +
                              +
                              +
                              + + +
                              + + + + diff --git a/docs/classes/MCI-Footnotes.html b/docs/classes/MCI-Footnotes.html new file mode 100644 index 0000000..d09558a --- /dev/null +++ b/docs/classes/MCI-Footnotes.html @@ -0,0 +1,873 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                              +

                              Documentation

                              + + +
                              + +
                              + + +
                              + +
                              +
                              + + + + +
                              + + +
                              +

                              + MCI_Footnotes + + + + +

                              + + + +

                              Entry point of the Plugin. Loads the Dashboard and executes the Task.

                              + +
                              + + +
                              + Tags + +
                              +
                              +
                              + author +
                              +
                              + +

                              Stefan Herndler

                              +
                              + +
                              +
                              + since +
                              +
                              + 1.5.0 + +
                              + +
                              +
                              + + + + + + +

                              + Table of Contents + +

                              + +
                              +
                              + $a_bool_AlternativeTooltipsEnabled + +  : mixed +
                              +
                              + +
                              + $a_bool_TooltipsEnabled + +  : bool +
                              +
                              Template process and script / stylesheet load optimization.
                              + +
                              + $a_obj_Task + +  : null|MCI_Footnotes_Task +
                              +
                              Reference to the Plugin Task object.
                              + +
                              + initializeWidgets() + +  : mixed +
                              +
                              Initializes all Widgets of the Plugin.
                              + +
                              + registerPublic() + +  : mixed +
                              +
                              Registers and enqueues scripts and stylesheets to the public pages.
                              + +
                              + run() + +  : mixed +
                              +
                              Executes the Plugin.
                              + +
                              + initializeDashboard() + +  : mixed +
                              +
                              Initializes the Dashboard of the Plugin and loads them.
                              + +
                              + initializeTask() + +  : mixed +
                              +
                              Initializes the Plugin Task and registers the Task hooks.
                              + +
                              + + + + + + +
                              +

                              + Properties + +

                              +
                              +

                              + $a_bool_AlternativeTooltipsEnabled + + + +

                              + + + + + public + static mixed + $a_bool_AlternativeTooltipsEnabled + = alse + + + + +
                              +
                              +

                              + $a_bool_TooltipsEnabled + + + +

                              + + +

                              Template process and script / stylesheet load optimization.

                              + + + public + static bool + $a_bool_TooltipsEnabled + = alse + +
                                +
                              • Bugfix: Templates: optimize template load and processing based on settings, thanks to @misfist code contribution.
                                • +
                              +
                              + + +
                              + Tags + +
                              +
                              +
                              + since +
                              +
                              + 2.4.0 + +
                              + +
                              +
                              + date +
                              +
                              + +

                              2021-01-04T1355+0100

                              +
                              + +
                              +
                              + author +
                              +
                              + +

                              Patrizia Lutz @misfist

                              +
                              + +
                              +
                              + link +
                              +
                              + https://wordpress.org/support/topic/template-override-filter/#post-13864301 + +
                              +
                              + link +
                              +
                              +

                              repository

                              +                               + +
                              +
                              + link +
                              +
                              +

                              diff

                              +                               + +
                              +
                              + +
                              +
                              +

                              + $a_obj_Task + + + +

                              + + +

                              Reference to the Plugin Task object.

                              + + + public + null|MCI_Footnotes_Task + $a_obj_Task + = +ull + +
                              + + +
                              + Tags + +
                              +
                              +
                              + author +
                              +
                              + +

                              Stefan Herndler

                              +
                              + +
                              +
                              + since +
                              +
                              + 1.5.0 + +
                              + +
                              +
                              + +
                              +
                              + +
                              +

                              + Methods + +

                              +
                              +

                              + initializeWidgets() + +

                              + + +

                              Initializes all Widgets of the Plugin.

                              + + + public + initializeWidgets() : mixed + +
                              + + + +
                              + Tags + +
                              +
                              +
                              + author +
                              +
                              + +

                              Stefan Herndler

                              +
                              + +
                              +
                              + 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/87173d2980c7ff90e12ffee94ca7153e11163793 + +
                              +
                              + link +
                              +
                              + https://wordpress.org/support/topic/bug-function-create_function-is-deprecated/ + +
                              +
                              + link +
                              +
                              + https://wordpress.org/support/topic/deprecated-function-create_function-14/ + +
                              +
                              + link +
                              +
                              +

                              create_function() was deprecated in PHP 7.2.0 and removed in PHP 8.0.0.

                              +                               + +
                              +
                              + link +
                              +
                              +

                              The fix is to move add_action() above into run(), +and use the bare register_widget() here.

                              +                               + +
                              +
                              + reporter +
                              +
                              + +

                              @psykonevro

                              +
                              + +
                              +
                              + reporter +
                              +
                              + +

                              @daliasued

                              +
                              + +
                              +
                              + see +
                              +
                              + self::run() + +

                              Also, the visibility of initializeWidgets() is not private any longer.

                              +
                              + +
                              +
                              + +
                              Return values
                              + mixed + — +
                              + + +
                              +
                              +

                              + registerPublic() + +

                              + + +

                              Registers and enqueues scripts and stylesheets to the public pages.

                              + + + public + registerPublic() : mixed + +
                              + + + +
                              + Tags + +
                              +
                              +
                              + author +
                              +
                              + +

                              Stefan Herndler

                              +
                              + +
                              +
                              + 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-29T1413+0100

                              +
                              + +
                              +
                              + since +
                              +
                              + 2.0.4 + +

                              add jQuery UI from WordPress 2020-11-01T1902+0100

                              +
                              + +
                              +
                              + since +
                              +
                              + 2.1.4 + +

                              automate passing version number for cache busting 2020-11-30T0646+0100

                              +
                              + +
                              +
                              + since +
                              +
                              + 2.1.4 + +

                              optionally enqueue an extra stylesheet 2020-12-04T2231+0100

                              +
                              + +
                              +
                              + +
                              Return values
                              + mixed + — +
                              + + +
                              +
                              +

                              + run() + +

                              + + +

                              Executes the Plugin.

                              + + + public + run() : mixed + +
                              + + + +
                              + Tags + +
                              +
                              +
                              + author +
                              +
                              + +

                              Stefan Herndler

                              +
                              + +
                              +
                              + since +
                              +
                              + 1.5.0 + +
                                +
                              • Bugfix: Improve widgets registration, thanks to @felipelavinz code contribution.
                                • +
                              +
                              + +
                              +
                              + since +
                              +
                              + 1.6.5 + +
                              + +
                              +
                              + contributor +
                              +
                              + +

                              @felipelavinz

                              +
                              + +
                              +
                              + link +
                              +
                              + https://github.com/media-competence-institute/footnotes/commit/87173d2980c7ff90e12ffee94ca7153e11163793 + +
                              +
                              + see +
                              +
                              + self::initializeWidgets() + +
                              + +
                              +
                              + +
                              Return values
                              + mixed + — +
                              + + +
                              +
                              +

                              + initializeDashboard() + +

                              + + +

                              Initializes the Dashboard of the Plugin and loads them.

                              + + + private + initializeDashboard() : mixed + +
                              + + + +
                              + Tags + +
                              +
                              +
                              + author +
                              +
                              + +

                              Stefan Herndler

                              +
                              + +
                              +
                              + since +
                              +
                              + 1.5.0 + +
                              + +
                              +
                              + +
                              Return values
                              + mixed + — +
                              + + +
                              +
                              +

                              + initializeTask() + +

                              + + +

                              Initializes the Plugin Task and registers the Task hooks.

                              + + + private + initializeTask() : mixed + +
                              + + + +
                              + Tags + +
                              +
                              +
                              + author +
                              +
                              + +

                              Stefan Herndler

                              +
                              + +
                              +
                              + since +
                              +
                              + 1.5.0 + +
                              + +
                              +
                              + +
                              Return values
                              + mixed + — +
                              + + +
                              +
                              + +
                              +
                              +
                              +
                              +

                              Search results

                              + +
                              +
                              +
                                +
                                +
                                +
                                +
                                +
                                + + +
                                + + + + diff --git a/docs/css/base.css b/docs/css/base.css new file mode 100644 index 0000000..3fa8f23 --- /dev/null +++ b/docs/css/base.css @@ -0,0 +1,1002 @@ + +:root { + /* Typography */ + --font-primary: 'Source Sans Pro', Helvetica, Arial, sans-serif; + --font-secondary: 'Source Sans Pro', Helvetica, Arial, sans-serif; + --line-height--primary: 1.6; + --letter-spacing--primary: .05rem; + --text-base-size: 1em; + --text-scale-ratio: 1.2; + + --text-xxs: calc(var(--text-base-size) / var(--text-scale-ratio) / var(--text-scale-ratio) / var(--text-scale-ratio)); + --text-xs: calc(var(--text-base-size) / var(--text-scale-ratio) / var(--text-scale-ratio)); + --text-sm: calc(var(--text-base-size) / var(--text-scale-ratio)); + --text-md: var(--text-base-size); + --text-lg: calc(var(--text-base-size) * var(--text-scale-ratio)); + --text-xl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxxxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + + /* Colors */ + --primary-color: hsl(96, 57%, 60%); + --primary-color-darken: hsl(96, 57%, 40%); + --primary-color-darker: hsl(96, 57%, 20%); + --primary-color-lighten: hsl(96, 57%, 80%); + --primary-color-lighter: hsl(96, 57%, 97%); + --dark-gray: #d1d1d1; + --light-gray: #f0f0f0; + + --text-color: #4b3b40; + + --header-height: var(--spacing-xxxxl); + --header-bg-color: var(--primary-color); + --code-background-color: #f7faf5; + --code-border-color: #d6e7cb; + --button-border-color: var(--primary-color-darken); + --button-color: transparent; + --button-color-primary: var(--primary-color); + --button-text-color: #555; + --button-text-color-primary: white; + --popover-background-color: rgba(255, 255, 255, 0.75); + --link-color-primary: var(--primary-color-darken); + --link-hover-color-primary: var(--primary-color-darker); + --form-field-border-color: var(--dark-gray); + --form-field-color: #fff; + --admonition-success-color: var(--primary-color); + --admonition-border-color: silver; + --table-separator-color: var(--primary-color-lighten); + --title-text-color: var(--primary-color); + + --sidebar-border-color: var(--primary-color-lighten); + + /* Grid */ + --container-width: 1400px; + + /* Spacing */ + --spacing-base-size: 1rem; + --spacing-scale-ratio: 1.5; + + --spacing-xxxs: calc(var(--spacing-base-size) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio)); + --spacing-xxs: calc(var(--spacing-base-size) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio)); + --spacing-xs: calc(var(--spacing-base-size) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio)); + --spacing-sm: calc(var(--spacing-base-size) / var(--spacing-scale-ratio)); + --spacing-md: var(--spacing-base-size); + --spacing-lg: calc(var(--spacing-base-size) * var(--spacing-scale-ratio)); + --spacing-xl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + --spacing-xxl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + --spacing-xxxl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + --spacing-xxxxl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + + --border-radius-base-size: 3px; +} + +/* Base Styles +-------------------------------------------------- */ +body { + color: var(--text-color); + font-family: var(--font-primary); + font-size: var(--text-md); + letter-spacing: var(--letter-spacing--primary); + line-height: var(--line-height--primary); +} + +.phpdocumentor h1, +.phpdocumentor h2, +.phpdocumentor h3, +.phpdocumentor h4, +.phpdocumentor h5, +.phpdocumentor h6 { + margin-bottom: var(--spacing-lg); + margin-top: var(--spacing-lg); + font-weight: 600; +} + +.phpdocumentor h1 { + font-size: var(--text-xxxxl); + letter-spacing: var(--letter-spacing--primary); + line-height: 1.2; + margin-top: 0; +} + +.phpdocumentor h2 { + font-size: var(--text-xxxl); + letter-spacing: var(--letter-spacing--primary); + line-height: 1.25; + margin-top: 0; +} + +.phpdocumentor h3 { + font-size: var(--text-xxl); + letter-spacing: var(--letter-spacing--primary); + line-height: 1.3; +} + +.phpdocumentor h4 { + font-size: var(--text-xl); + letter-spacing: calc(var(--letter-spacing--primary) / 2); + line-height: 1.35; + margin-bottom: var(--spacing-md); +} + +.phpdocumentor h5 { + font-size: var(--text-lg); + letter-spacing: calc(var(--letter-spacing--primary) / 4); + line-height: 1.5; + margin-bottom: var(--spacing-md); + margin-top: var(--spacing-md); +} + +.phpdocumentor h6 { + font-size: var(--text-md); + letter-spacing: 0; + line-height: var(--line-height--primary); + margin-bottom: var(--spacing-md); + margin-top: var(--spacing-md); +} + +.phpdocumentor h1 .headerlink, +.phpdocumentor h2 .headerlink, +.phpdocumentor h3 .headerlink, +.phpdocumentor h4 .headerlink, +.phpdocumentor h5 .headerlink, +.phpdocumentor h6 .headerlink +{ + transition: all .3s ease-in-out; + opacity: 0; + text-decoration: none; + color: silver; + font-size: 80%; +} + +.phpdocumentor h1:hover .headerlink, +.phpdocumentor h2:hover .headerlink, +.phpdocumentor h3:hover .headerlink, +.phpdocumentor h4:hover .headerlink, +.phpdocumentor h5:hover .headerlink, +.phpdocumentor h6:hover .headerlink +{ + opacity: 1; +} +.phpdocumentor p { + margin-top: 0; + margin-bottom: var(--spacing-md); +} +.phpdocumentor figure { + margin-bottom: var(--spacing-md); +} +.phpdocumentor-line { + border-top: 1px solid #E1E1E1; + border-width: 0; + margin-bottom: var(--spacing-xxl); + margin-top: var(--spacing-xxl); +} +.phpdocumentor-section { + box-sizing: border-box; + margin: 0 auto; + max-width: var(--container-width); + padding: 0 var(--spacing-lg); + position: relative; + width: 100%; +} + +@media (min-width: 1200px) { + .phpdocumentor-section { + padding: 0; + width: 95%; + } +} +.phpdocumentor-column { + box-sizing: border-box; + float: left; + width: 100%; +} + +@media (min-width: 550px) { + .phpdocumentor-column { + margin-left: 4%; + } + + .phpdocumentor-column:first-child { + margin-left: 0; + } + + .-one.phpdocumentor-column { + width: 4.66666666667%; + } + + .-two.phpdocumentor-column { + width: 13.3333333333%; + } + + .-three.phpdocumentor-column { + width: 22%; + } + + .-four.phpdocumentor-column { + width: 30.6666666667%; + } + + .-five.phpdocumentor-column { + width: 39.3333333333%; + } + + .-six.phpdocumentor-column { + width: 48%; + } + + .-seven.phpdocumentor-column { + width: 56.6666666667%; + } + + .-eight.phpdocumentor-column { + width: 65.3333333333%; + } + + .-nine.phpdocumentor-column { + width: 74.0%; + } + + .-ten.phpdocumentor-column { + width: 82.6666666667%; + } + + .-eleven.phpdocumentor-column { + width: 91.3333333333%; + } + + .-twelve.phpdocumentor-column { + margin-left: 0; + width: 100%; + } + + .-one-third.phpdocumentor-column { + width: 30.6666666667%; + } + + .-two-thirds.phpdocumentor-column { + width: 65.3333333333%; + } + + .-one-half.phpdocumentor-column { + width: 48%; + } + + /* Offsets */ + .-offset-by-one.phpdocumentor-column { + margin-left: 8.66666666667%; + } + + .-offset-by-two.phpdocumentor-column { + margin-left: 17.3333333333%; + } + + .-offset-by-three.phpdocumentor-column { + margin-left: 26%; + } + + .-offset-by-four.phpdocumentor-column { + margin-left: 34.6666666667%; + } + + .-offset-by-five.phpdocumentor-column { + margin-left: 43.3333333333%; + } + + .-offset-by-six.phpdocumentor-column { + margin-left: 52%; + } + + .-offset-by-seven.phpdocumentor-column { + margin-left: 60.6666666667%; + } + + .-offset-by-eight.phpdocumentor-column { + margin-left: 69.3333333333%; + } + + .-offset-by-nine.phpdocumentor-column { + margin-left: 78.0%; + } + + .-offset-by-ten.phpdocumentor-column { + margin-left: 86.6666666667%; + } + + .-offset-by-eleven.phpdocumentor-column { + margin-left: 95.3333333333%; + } + + .-offset-by-one-third.phpdocumentor-column { + margin-left: 34.6666666667%; + } + + .-offset-by-two-thirds.phpdocumentor-column { + margin-left: 69.3333333333%; + } + + .-offset-by-one-half.phpdocumentor-column { + margin-left: 52%; + } +} +.phpdocumentor a { + color: var(--link-color-primary); +} + +.phpdocumentor a:hover { + color: var(--link-hover-color-primary); +} +.phpdocumentor-button { + background-color: var(--button-color); + border: 1px solid var(--button-border-color); + border-radius: var(--border-radius-base-size); + box-sizing: border-box; + color: var(--button-text-color); + cursor: pointer; + display: inline-block; + font-size: var(--text-sm); + font-weight: 600; + height: 38px; + letter-spacing: .1rem; + line-height: 38px; + padding: 0 var(--spacing-xxl); + text-align: center; + text-decoration: none; + text-transform: uppercase; + white-space: nowrap; + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-button .-wide { + width: 100%; +} + +.phpdocumentor-button:hover, +.phpdocumentor-button:focus { + border-color: #888; + color: #333; + outline: 0; +} + +.phpdocumentor-button.-primary { + background-color: var(--button-color-primary); + border-color: var(--button-color-primary); + color: var(--button-text-color-primary); +} + +.phpdocumentor-button.-primary:hover, +.phpdocumentor-button.-primary:focus { + background-color: var(--link-color-primary); + border-color: var(--link-color-primary); + color: var(--button-text-color-primary); +} +.phpdocumentor form { + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-field { + background-color: var(--form-field-color); + border: 1px solid var(--form-field-border-color); + border-radius: var(--border-radius-base-size); + box-shadow: none; + box-sizing: border-box; + height: 38px; + padding: var(--spacing-xxxs) var(--spacing-xxs); /* The 6px vertically centers text on FF, ignored by Webkit */ + margin-bottom: var(--spacing-md); +} + +/* Removes awkward default styles on some inputs for iOS */ +input[type="email"], +input[type="number"], +input[type="search"], +input[type="text"], +input[type="tel"], +input[type="url"], +input[type="password"], +textarea { + -moz-appearance: none; + -webkit-appearance: none; + appearance: none; +} + +.phpdocumentor-textarea { + min-height: 65px; + padding-bottom: var(--spacing-xxxs); + padding-top: var(--spacing-xxxs); +} + +.phpdocumentor-field:focus { + border: 1px solid var(--button-color-primary); + outline: 0; +} + +.phpdocumentor-label { + display: block; + margin-bottom: var(--spacing-xs); +} + +.phpdocumentor-fieldset { + border-width: 0; + padding: 0; +} + +input[type="checkbox"].phpdocumentor-field, +input[type="radio"].phpdocumentor-field { + display: inline; +} +div.phpdocumentor-list > ul, +ul.phpdocumentor-list { + list-style: circle inside; +} + +ol.phpdocumentor-list { + list-style: decimal inside; +} + +div.phpdocumentor-list > ul, +ol.phpdocumentor-list, +ul.phpdocumentor-list { + margin-top: 0; + padding-left: 0; + margin-bottom: var(--spacing-md); +} + +dl { + margin-bottom: var(--spacing-md); +} + +div.phpdocumentor-list > ul ul, +ul.phpdocumentor-list ul.phpdocumentor-list, +ul.phpdocumentor-list ol.phpdocumentor-list, +ol.phpdocumentor-list ol.phpdocumentor-list, +ol.phpdocumentor-list ul.phpdocumentor-list { + font-size: var(--text-sm); + margin: var(--spacing-xs) 0 var(--spacing-xs) calc(var(--spacing-xs) * 2); +} + +li.phpdocumentor-list { + margin-bottom: var(--spacing-md); +} +.phpdocumentor pre { + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-code { + background: var(--code-background-color); + border: 1px solid var(--code-border-color); + border-radius: var(--border-radius-base-size); + font-size: var(--text-sm); + padding: var(--spacing-sm) var(--spacing-md); + width: 100%; + box-sizing: border-box; +} + +pre > .phpdocumentor-code { + display: block; + white-space: pre; +} +.phpdocumentor blockquote { + border-left: 4px solid var(--primary-color); + margin: var(--spacing-md) 0; + padding: var(--spacing-xs) var(--spacing-sm); + color: var(--primary-color-darker); + font-style: italic; + font-size: var(--text-sm); +} +.phpdocumentor table { + margin-bottom: var(--spacing-md); +} + +th.phpdocumentor-heading, +td.phpdocumentor-cell { + border-bottom: 1px solid var(--table-separator-color); + padding: var(--spacing-sm) var(--spacing-md); + text-align: left; +} + +th.phpdocumentor-heading:first-child, +td.phpdocumentor-cell:first-child { + padding-left: 0; +} + +th.phpdocumentor-heading:last-child, +td.phpdocumentor-cell:last-child { + padding-right: 0; +} + +.phpdocumentor-header { + display: flex; + flex-direction: row; + align-items: stretch; + flex-wrap: wrap; + justify-content: space-between; + height: auto; + padding: var(--spacing-md) var(--spacing-md); +} + +.phpdocumentor-header__menu-button { + position: absolute; + top: -100%; + left: -100%; +} + +.phpdocumentor-header__menu-icon { + font-size: 2rem; + color: var(--primary-color); +} + +.phpdocumentor-header__menu-button:checked ~ .phpdocumentor-topnav { + max-height: 250px; + padding-top: var(--spacing-md); +} + +@media (min-width: 1000px) { + .phpdocumentor-header { + flex-direction: row; + padding: var(--spacing-lg) var(--spacing-lg); + min-height: var(--header-height); + } + + .phpdocumentor-header__menu-icon { + display: none; + } +} + +@media (min-width: 1000px) { + .phpdocumentor-header { + padding-top: 0; + padding-bottom: 0; + } +} +@media (min-width: 1200px) { + .phpdocumentor-header { + padding: 0; + } +} +.phpdocumentor-title { + box-sizing: border-box; + color: var(--title-text-color); + font-size: var(--text-xxl); + letter-spacing: .05rem; + font-weight: normal; + width: auto; + margin: 0; + display: flex; + align-items: center; +} + +.phpdocumentor-title.-without-divider { + border: none; +} + +.phpdocumentor-title__link { + transition: all .3s ease-out; + display: flex; + color: var(--title-text-color); + text-decoration: none; + font-weight: normal; + white-space: nowrap; + transform: scale(.75); + transform-origin: left; +} + +.phpdocumentor-title__link:hover { + transform: perspective(15rem) translateX(.5rem); + font-weight: 600; +} + +@media (min-width: 1000px) { + .phpdocumentor-title { + width: 30.6666666667%; + border-right: var(--sidebar-border-color) solid 1px; + } + + .phpdocumentor-title__link { + transform-origin: left; + } +} + +@media (min-width: 1000px) { + .phpdocumentor-title__link { + transform: scale(.85); + } +} + +@media (min-width: 1200px) { + .phpdocumentor-title__link { + transform: scale(1); + } +} +.phpdocumentor-topnav { + display: flex; + align-items: center; + margin: 0; + max-height: 0; + overflow: hidden; + transition: max-height 0.2s ease-out; + flex-basis: 100%; +} + +.phpdocumentor-topnav__menu { + text-align: right; + list-style: none; + margin: 0; + padding: 0; + flex: 1; + display: flex; + flex-flow: row wrap; + justify-content: center; +} + +.phpdocumentor-topnav__menu-item { + margin: 0; + width: 100%; + display: inline-block; + text-align: center; + padding: var(--spacing-sm) 0 +} + +.phpdocumentor-topnav__menu-item.-social { + width: auto; + padding: var(--spacing-sm) +} + +.phpdocumentor-topnav__menu-item a { + display: inline-block; + color: var(--text-color); + text-decoration: none; + font-size: var(--text-lg); + transition: all .3s ease-out; + border-bottom: 1px dotted transparent; + line-height: 1; +} + +.phpdocumentor-topnav__menu-item a:hover { + transform: perspective(15rem) translateY(.1rem); + border-bottom: 1px dotted var(--text-color); +} + +@media (min-width: 1000px) { + .phpdocumentor-topnav { + max-height: none; + overflow: visible; + flex-basis: auto; + } + + .phpdocumentor-topnav__menu { + display: flex; + flex-flow: row wrap; + justify-content: flex-end; + } + + .phpdocumentor-topnav__menu-item, + .phpdocumentor-topnav__menu-item.-social { + width: auto; + display: inline; + text-align: right; + padding: 0 0 0 var(--spacing-md) + } +} +.phpdocumentor-sidebar { + margin: 0; + overflow: hidden; + max-height: 0; +} + +.phpdocumentor .phpdocumentor-sidebar .phpdocumentor-list { + padding-top: var(--spacing-xs); + padding-left: var(--spacing-md); + list-style: none; +} + +.phpdocumentor .phpdocumentor-sidebar li { + white-space: nowrap; + text-overflow: ellipsis; + overflow: hidden; + padding: 0 0 var(--spacing-xxxs) var(--spacing-md); +} + +.phpdocumentor .phpdocumentor-sidebar abbr, +.phpdocumentor .phpdocumentor-sidebar a { + text-decoration: none; + border-bottom: none; + color: var(--text-color); + font-size: var(--text-md); + padding-left: 0; + transition: padding-left .4s ease-out; +} + +.phpdocumentor .phpdocumentor-sidebar a:hover { + padding-left: 5px; + font-weight: 600; +} + +.phpdocumentor .phpdocumentor-sidebar__category > * { + border-left: 1px solid var(--primary-color-lighten); +} + +.phpdocumentor .phpdocumentor-sidebar__category { + margin-bottom: var(--spacing-lg); +} + +.phpdocumentor .phpdocumentor-sidebar__category-header { + font-size: var(--text-md); + margin-bottom: var(--spacing-xs); + color: var(--link-color-primary); + font-weight: 600; + border-left: 0; +} + +.phpdocumentor .phpdocumentor-sidebar__root-package, +.phpdocumentor .phpdocumentor-sidebar__root-namespace { + font-size: var(--text-md); + margin: 0; + padding-top: var(--spacing-xs); + padding-left: var(--spacing-md); + color: var(--text-color); + font-weight: normal; +} + +@media (min-width: 550px) { + .phpdocumentor-sidebar { + border-right: var(--sidebar-border-color) solid 1px; + } +} + +.phpdocumentor-sidebar__menu-button { + position: absolute; + top: -100%; + left: -100%; +} + +.phpdocumentor-sidebar__menu-icon { + font-size: var(--text-md); + font-weight: 600; + background: var(--primary-color); + color: white; + margin: 0 0 var(--spacing-lg); + display: block; + padding: var(--spacing-sm); + text-align: center; + border-radius: 3px; + text-transform: uppercase; + letter-spacing: .15rem; +} + +.phpdocumentor-sidebar__menu-button:checked ~ .phpdocumentor-sidebar { + max-height: 100%; + padding-top: var(--spacing-md); +} + +@media (min-width: 550px) { + .phpdocumentor-sidebar { + overflow: visible; + max-height: 100%; + } + + .phpdocumentor-sidebar__menu-icon { + display: none; + } +} +.phpdocumentor-admonition { + border: 1px solid var(--admonition-border-color); + border-radius: var(--border-radius-base-size); + border-color: var(--primary-color-lighten); + background-color: var(--primary-color-lighter); + font-size: 85%; + padding: .5rem; + margin: 2rem 0; + display: flex; + flex-direction: row; +} + +.phpdocumentor-admonition--success { + border-color: var(--admonition-success-color); +} + +.phpdocumentor-admonition__icon { + font-size: 2rem; + margin: .75rem 0.75rem 1.25rem 0.5rem; + color: var(--primary-color); +} +.phpdocumentor ul.phpdocumentor-breadcrumbs { + font-size: var(--text-md); + list-style: none; + margin: 0; + padding: 0; +} + +.phpdocumentor ul.phpdocumentor-breadcrumbs a { + color: var(--text-color); + text-decoration: none; +} + +.phpdocumentor ul.phpdocumentor-breadcrumbs > li { + display: inline-block; + margin: 0; +} + +.phpdocumentor ul.phpdocumentor-breadcrumbs > li + li:before { + color: var(--dark-gray); + content: "\\\A0"; + padding: 0; +} +.phpdocumentor .phpdocumentor-back-to-top { + position: fixed; + bottom: 2rem; + font-size: 2.5rem; + opacity: .25; + transition: all .3s ease-in-out; + right: 2rem; +} + +.phpdocumentor .phpdocumentor-back-to-top:hover { + color: var(--link-color-primary); + opacity: 1; +} +.phpdocumentor-search { + position: relative; + display: none; /** disable by default for non-js flow */ + opacity: .3; /** white-out default for loading indication */ + transition: opacity .3s, background .3s; + margin: var(--spacing-sm) 0; + flex: 1; + min-width: 100%; +} + +.phpdocumentor-search label { + display: flex; + align-items: center; + flex: 1; +} + +.phpdocumentor-search__icon { + color: var(--primary-color); + margin-right: var(--spacing-sm); + width: 1rem; + height: 1rem; +} + +.phpdocumentor-search--enabled { + display: flex; +} + +.phpdocumentor-search--active { + opacity: 1; +} + +.phpdocumentor-search input:disabled { + background-color: lightgray; +} + +.phpdocumentor-search__field:focus, +.phpdocumentor-search__field { + margin-bottom: 0; + border: 0; + border-bottom: 2px solid var(--primary-color); + padding: 0; + border-radius: 0; + flex: 1; +} + +@media (min-width: 1000px) { + .phpdocumentor-search { + min-width: auto; + max-width: 20rem; + margin: 0 0 0 auto; + } +} +.phpdocumentor-content { + position: relative; +} + +.phpdocumentor-search-results { + backdrop-filter: blur(5px); + background: var(--popover-background-color); + position: fixed; + top: 0; + left: 0; + right: 0; + bottom: 0; + padding: 0; + opacity: 1; + pointer-events: all; + + transition: opacity .3s, background .3s; +} + +.phpdocumentor-search-results--hidden { + background: transparent; + backdrop-filter: blur(0); + opacity: 0; + pointer-events: none; +} + +.phpdocumentor-search-results__dialog { + width: 100%; + background: white; + max-height: 100%; + display: flex; + flex-direction: column; +} + +.phpdocumentor-search-results__body { + overflow: auto; +} + +.phpdocumentor-search-results__header { + padding: var(--spacing-lg); + display: flex; + justify-content: space-between; + background: var(--primary-color-darken); + color: white; + align-items: center; +} + +.phpdocumentor-search-results__close { + font-size: var(--text-xl); + background: none; + border: none; + padding: 0; + margin: 0; +} + +.phpdocumentor .phpdocumentor-search-results__title { + font-size: var(--text-xl); + margin-bottom: 0; +} + +.phpdocumentor-search-results__entries { + list-style: none; + padding: 0 var(--spacing-lg); + margin: 0; +} + +.phpdocumentor-search-results__entry { + border-bottom: 1px solid var(--table-separator-color); + padding: var(--spacing-sm) 0; + text-align: left; +} + +.phpdocumentor-search-results__entry a { + display: block; +} + +.phpdocumentor-search-results__entry small { + margin-top: var(--spacing-xs); + margin-bottom: var(--spacing-md); + color: var(--primary-color-darker); + display: block; + word-break: break-word; +} + +.phpdocumentor-search-results__entry h3 { + font-size: var(--text-lg); + margin: 0; +} + +@media (min-width: 550px) { + .phpdocumentor-search-results { + padding: 0 var(--spacing-lg); + } + + .phpdocumentor-search-results__entry h3 { + font-size: var(--text-xxl); + } + + .phpdocumentor-search-results__dialog { + margin: var(--spacing-xl) auto; + max-width: 40rem; + background: white; + border: 1px solid silver; + box-shadow: 0 2px 5px silver; + max-height: 40rem; + border-radius: 3px; + } +} + +/* Used for screen readers and such */ +.visually-hidden { + display: none; +} diff --git a/docs/css/normalize.css b/docs/css/normalize.css new file mode 100644 index 0000000..46f646a --- /dev/null +++ b/docs/css/normalize.css @@ -0,0 +1,427 @@ +/*! normalize.css v3.0.2 | MIT License | git.io/normalize */ + +/** + * 1. Set default font family to sans-serif. + * 2. Prevent iOS text size adjust after orientation change, without disabling + * user zoom. + */ + +html { + font-family: sans-serif; /* 1 */ + -ms-text-size-adjust: 100%; /* 2 */ + -webkit-text-size-adjust: 100%; /* 2 */ +} + +/** + * Remove default margin. + */ + +body { + margin: 0; +} + +/* HTML5 display definitions + ========================================================================== */ + +/** + * Correct `block` display not defined for any HTML5 element in IE 8/9. + * Correct `block` display not defined for `details` or `summary` in IE 10/11 + * and Firefox. + * Correct `block` display not defined for `main` in IE 11. + */ + +article, +aside, +details, +figcaption, +figure, +footer, +header, +hgroup, +main, +menu, +nav, +section, +summary { + display: block; +} + +/** + * 1. Correct `inline-block` display not defined in IE 8/9. + * 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera. + */ + +audio, +canvas, +progress, +video { + display: inline-block; /* 1 */ + vertical-align: baseline; /* 2 */ +} + +/** + * Prevent modern browsers from displaying `audio` without controls. + * Remove excess height in iOS 5 devices. + */ + +audio:not([controls]) { + display: none; + height: 0; +} + +/** + * Address `[hidden]` styling not present in IE 8/9/10. + * Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22. + */ + +[hidden], +template { + display: none; +} + +/* Links + ========================================================================== */ + +/** + * Remove the gray background color from active links in IE 10. + */ + +a { + background-color: transparent; +} + +/** + * Improve readability when focused and also mouse hovered in all browsers. + */ + +a:active, +a:hover { + outline: 0; +} + +/* Text-level semantics + ========================================================================== */ + +/** + * Address styling not present in IE 8/9/10/11, Safari, and Chrome. + */ + +abbr[title] { + border-bottom: 1px dotted; +} + +/** + * Address style set to `bolder` in Firefox 4+, Safari, and Chrome. + */ + +b, +strong { + font-weight: bold; +} + +/** + * Address styling not present in Safari and Chrome. + */ + +dfn { + font-style: italic; +} + +/** + * Address variable `h1` font-size and margin within `section` and `article` + * contexts in Firefox 4+, Safari, and Chrome. + */ + +h1 { + font-size: 2em; + margin: 0.67em 0; +} + +/** + * Address styling not present in IE 8/9. + */ + +mark { + background: #ff0; + color: #000; +} + +/** + * Address inconsistent and variable font size in all browsers. + */ + +small { + font-size: 80%; +} + +/** + * Prevent `sub` and `sup` affecting `line-height` in all browsers. + */ + +sub, +sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; +} + +sup { + top: -0.5em; +} + +sub { + bottom: -0.25em; +} + +/* Embedded content + ========================================================================== */ + +/** + * Remove border when inside `a` element in IE 8/9/10. + */ + +img { + border: 0; +} + +/** + * Correct overflow not hidden in IE 9/10/11. + */ + +svg:not(:root) { + overflow: hidden; +} + +/* Grouping content + ========================================================================== */ + +/** + * Address margin not present in IE 8/9 and Safari. + */ + +figure { + margin: 1em 40px; +} + +/** + * Address differences between Firefox and other browsers. + */ + +hr { + -moz-box-sizing: content-box; + box-sizing: content-box; + height: 0; +} + +/** + * Contain overflow in all browsers. + */ + +pre { + overflow: auto; +} + +/** + * Address odd `em`-unit font size rendering in all browsers. + */ + +code, +kbd, +pre, +samp { + font-family: monospace, monospace; + font-size: 1em; +} + +/* Forms + ========================================================================== */ + +/** + * Known limitation: by default, Chrome and Safari on OS X allow very limited + * styling of `select`, unless a `border` property is set. + */ + +/** + * 1. Correct color not being inherited. + * Known issue: affects color of disabled elements. + * 2. Correct font properties not being inherited. + * 3. Address margins set differently in Firefox 4+, Safari, and Chrome. + */ + +button, +input, +optgroup, +select, +textarea { + color: inherit; /* 1 */ + font: inherit; /* 2 */ + margin: 0; /* 3 */ +} + +/** + * Address `overflow` set to `hidden` in IE 8/9/10/11. + */ + +button { + overflow: visible; +} + +/** + * Address inconsistent `text-transform` inheritance for `button` and `select`. + * All other form control elements do not inherit `text-transform` values. + * Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera. + * Correct `select` style inheritance in Firefox. + */ + +button, +select { + text-transform: none; +} + +/** + * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` + * and `video` controls. + * 2. Correct inability to style clickable `input` types in iOS. + * 3. Improve usability and consistency of cursor style between image-type + * `input` and others. + */ + +button, +html input[type="button"], /* 1 */ +input[type="reset"], +input[type="submit"] { + -webkit-appearance: button; /* 2 */ + cursor: pointer; /* 3 */ +} + +/** + * Re-set default cursor for disabled elements. + */ + +button[disabled], +html input[disabled] { + cursor: default; +} + +/** + * Remove inner padding and border in Firefox 4+. + */ + +button::-moz-focus-inner, +input::-moz-focus-inner { + border: 0; + padding: 0; +} + +/** + * Address Firefox 4+ setting `line-height` on `input` using `!important` in + * the UA stylesheet. + */ + +input { + line-height: normal; +} + +/** + * It's recommended that you don't attempt to style these elements. + * Firefox's implementation doesn't respect box-sizing, padding, or width. + * + * 1. Address box sizing set to `content-box` in IE 8/9/10. + * 2. Remove excess padding in IE 8/9/10. + */ + +input[type="checkbox"], +input[type="radio"] { + box-sizing: border-box; /* 1 */ + padding: 0; /* 2 */ +} + +/** + * Fix the cursor style for Chrome's increment/decrement buttons. For certain + * `font-size` values of the `input`, it causes the cursor style of the + * decrement button to change from `default` to `text`. + */ + +input[type="number"]::-webkit-inner-spin-button, +input[type="number"]::-webkit-outer-spin-button { + height: auto; +} + +/** + * 1. Address `appearance` set to `searchfield` in Safari and Chrome. + * 2. Address `box-sizing` set to `border-box` in Safari and Chrome + * (include `-moz` to future-proof). + */ + +input[type="search"] { + -webkit-appearance: textfield; /* 1 */ + -moz-box-sizing: content-box; + -webkit-box-sizing: content-box; /* 2 */ + box-sizing: content-box; +} + +/** + * Remove inner padding and search cancel button in Safari and Chrome on OS X. + * Safari (but not Chrome) clips the cancel button when the search input has + * padding (and `textfield` appearance). + */ + +input[type="search"]::-webkit-search-cancel-button, +input[type="search"]::-webkit-search-decoration { + -webkit-appearance: none; +} + +/** + * Define consistent border, margin, and padding. + */ + +fieldset { + border: 1px solid #c0c0c0; + margin: 0 2px; + padding: 0.35em 0.625em 0.75em; +} + +/** + * 1. Correct `color` not being inherited in IE 8/9/10/11. + * 2. Remove padding so people aren't caught out if they zero out fieldsets. + */ + +legend { + border: 0; /* 1 */ + padding: 0; /* 2 */ +} + +/** + * Remove default vertical scrollbar in IE 8/9/10/11. + */ + +textarea { + overflow: auto; +} + +/** + * Don't inherit the `font-weight` (applied by a rule above). + * NOTE: the default cannot safely be changed in Chrome and Safari on OS X. + */ + +optgroup { + font-weight: bold; +} + +/* Tables + ========================================================================== */ + +/** + * Remove most spacing between table cells. + */ + +table { + border-collapse: collapse; + border-spacing: 0; +} + +td, +th { + padding: 0; +} diff --git a/docs/css/template.css b/docs/css/template.css new file mode 100644 index 0000000..fb905f3 --- /dev/null +++ b/docs/css/template.css @@ -0,0 +1,169 @@ +.phpdocumentor-summary { + font-style: italic; +} +.phpdocumentor-description { + margin-bottom: var(--spacing-md); +} +.phpdocumentor-element { + position: relative; +} + +.phpdocumentor .phpdocumentor-element__name { + line-height: 1; +} + +.phpdocumentor-element__package, +.phpdocumentor-element__extends, +.phpdocumentor-element__implements { + display: block; + font-size: var(--text-xxs); + font-weight: normal; + opacity: .7; +} + +.phpdocumentor-element__package .phpdocumentor-breadcrumbs { + display: inline; +} + +.phpdocumentor-element:not(:last-child) { + border-bottom: 1px solid var(--primary-color-lighten); + padding-bottom: var(--spacing-lg); +} + +.phpdocumentor-element.-deprecated .phpdocumentor-element__name { + text-decoration: line-through; +} + +.phpdocumentor-element__modifier { + font-size: var(--text-xxs); + padding: calc(var(--spacing-base-size) / 4) calc(var(--spacing-base-size) / 2); + color: var(--text-color); + background-color: var(--light-gray); + border-radius: 3px; + text-transform: uppercase; +} +.phpdocumentor-signature { + display: inline-block; + font-size: var(--text-sm); + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-signature.-deprecated .phpdocumentor-signature__name { + text-decoration: line-through; +} +.phpdocumentor-table-of-contents { +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry { + padding-top: var(--spacing-xs); + margin-left: 2rem; + display: flex; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > a { + flex: 0 1 auto; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > span { + flex: 1; + white-space: nowrap; + text-overflow: ellipsis; + overflow: hidden; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry:after { + content: ''; + height: 12px; + width: 12px; + left: 16px; + position: absolute; +} +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-private:after { + background: url('data:image/svg+xml;utf8,') no-repeat; +} +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-protected:after { + left: 13px; + background: url('data:image/svg+xml;utf8,') no-repeat; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry:before { + width: 1.25rem; + height: 1.25rem; + line-height: 1.25rem; + background: transparent url('data:image/svg+xml;utf8,') no-repeat center center; + content: ''; + position: absolute; + left: 0; + border-radius: 50%; + font-weight: 600; + color: white; + text-align: center; + font-size: .75rem; + margin-top: .2rem; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-method:before { + content: 'M'; + background-image: url('data:image/svg+xml;utf8,'); +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-function:before { + content: 'M'; + background-image: url('data:image/svg+xml;utf8,'); +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-property:before { + content: 'P' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-constant:before { + content: 'C'; + background-color: transparent; + background-image: url('data:image/svg+xml;utf8,'); +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-class:before { + content: 'C' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-interface:before { + content: 'I' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-trait:before { + content: 'T' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-namespace:before { + content: 'N' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-package:before { + content: 'P' +} + +.phpdocumentor-table-of-contents dd { + font-style: italic; + margin-left: 2rem; +} +.phpdocumentor-element-found-in { + position: absolute; + top: 0; + right: 0; + font-size: var(--text-sm); + color: gray; +} +.phpdocumentor-class-graph { + width: 100%; height: 600px; border:1px solid black; overflow: hidden +} + +.phpdocumentor-class-graph__graph { + width: 100%; +} +.phpdocumentor-tag-list__definition { + display: flex; +} + +.phpdocumentor-tag-link { + margin-right: var(--spacing-sm); +} diff --git a/docs/files/class-config.html b/docs/files/class-config.html new file mode 100644 index 0000000..27fa852 --- /dev/null +++ b/docs/files/class-config.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                +

                                Documentation

                                + + +
                                + +
                                + + +
                                + +
                                +
                                + + + + +
                                + + +
                                +

                                config.php

                                + + + +

                                + Interfaces, Classes and Traits + +

                                + +
                                + +
                                MCI_Footnotes_Config
                                +
                                Contains all Plugin Constants. Contains no Method or Property.
                                + +
                                + + + + + + + +
                                +
                                +
                                +
                                +

                                Search results

                                + +
                                +
                                +
                                  +
                                  +
                                  +
                                  +
                                  +
                                  + + +
                                  + + + + diff --git a/docs/files/class-convert.html b/docs/files/class-convert.html new file mode 100644 index 0000000..332a478 --- /dev/null +++ b/docs/files/class-convert.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                  +

                                  Documentation

                                  + + +
                                  + +
                                  + + +
                                  + +
                                  +
                                  + + + + +
                                  + + +
                                  +

                                  convert.php

                                  + + + +

                                  + Interfaces, Classes and Traits + +

                                  + +
                                  + +
                                  MCI_Footnotes_Convert
                                  +
                                  Converts data types and Footnotes specific values.
                                  + +
                                  + + + + + + + +
                                  +
                                  +
                                  +
                                  +

                                  Search results

                                  + +
                                  +
                                  +
                                    +
                                    +
                                    +
                                    +
                                    +
                                    + + +
                                    + + + + diff --git a/docs/files/class-dashboard-init.html b/docs/files/class-dashboard-init.html new file mode 100644 index 0000000..b64a13d --- /dev/null +++ b/docs/files/class-dashboard-init.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                    +

                                    Documentation

                                    + + +
                                    + +
                                    + + +
                                    + +
                                    +
                                    + + + + +
                                    + + +
                                    +

                                    init.php

                                    + + + +

                                    + Interfaces, Classes and Traits + +

                                    + +
                                    + +
                                    MCI_Footnotes_Layout_Init
                                    +
                                    Handles the Settings interface of the Plugin.
                                    + +
                                    + + + + + + + +
                                    +
                                    +
                                    +
                                    +

                                    Search results

                                    + +
                                    +
                                    +
                                      +
                                      +
                                      +
                                      +
                                      +
                                      + + +
                                      + + + + diff --git a/docs/files/class-dashboard-layout.html b/docs/files/class-dashboard-layout.html new file mode 100644 index 0000000..18778f8 --- /dev/null +++ b/docs/files/class-dashboard-layout.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                      +

                                      Documentation

                                      + + +
                                      + +
                                      + + +
                                      + +
                                      +
                                      + + + + +
                                      + + +
                                      +

                                      layout.php

                                      + + + +

                                      + Interfaces, Classes and Traits + +

                                      + +
                                      + +
                                      MCI_Footnotes_LayoutEngine
                                      +
                                      Layout Engine for the administration dashboard.
                                      + +
                                      + + + + + + + +
                                      +
                                      +
                                      +
                                      +

                                      Search results

                                      + +
                                      +
                                      +
                                        +
                                        +
                                        +
                                        +
                                        +
                                        + + +
                                        + + + + diff --git a/docs/files/class-dashboard-subpage-diagnostics.html b/docs/files/class-dashboard-subpage-diagnostics.html new file mode 100644 index 0000000..e6ed92b --- /dev/null +++ b/docs/files/class-dashboard-subpage-diagnostics.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                        +

                                        Documentation

                                        + + +
                                        + +
                                        + + +
                                        + +
                                        +
                                        + + + + +
                                        + + +
                                        +

                                        subpage-diagnostics.php

                                        + + + +

                                        + Interfaces, Classes and Traits + +

                                        + +
                                        + +
                                        MCI_Footnotes_Layout_Diagnostics
                                        +
                                        Displays Diagnostics of the web server, PHP and WordPress.
                                        + +
                                        + + + + + + + +
                                        +
                                        +
                                        +
                                        +

                                        Search results

                                        + +
                                        +
                                        +
                                          +
                                          +
                                          +
                                          +
                                          +
                                          + + +
                                          + + + + diff --git a/docs/files/class-dashboard-subpage-main.html b/docs/files/class-dashboard-subpage-main.html new file mode 100644 index 0000000..62a90fc --- /dev/null +++ b/docs/files/class-dashboard-subpage-main.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                          +

                                          Documentation

                                          + + +
                                          + +
                                          + + +
                                          + +
                                          +
                                          + + + + +
                                          + + +
                                          +

                                          subpage-main.php

                                          + + + +

                                          + Interfaces, Classes and Traits + +

                                          + +
                                          + +
                                          MCI_Footnotes_Layout_Settings
                                          +
                                          Displays and handles all Settings of the Plugin.
                                          + +
                                          + + + + + + + +
                                          +
                                          +
                                          +
                                          +

                                          Search results

                                          + +
                                          +
                                          +
                                            +
                                            +
                                            +
                                            +
                                            +
                                            + + +
                                            + + + + diff --git a/docs/files/class-hooks.html b/docs/files/class-hooks.html new file mode 100644 index 0000000..b57ef84 --- /dev/null +++ b/docs/files/class-hooks.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                            +

                                            Documentation

                                            + + +
                                            + +
                                            + + +
                                            + +
                                            +
                                            + + + + +
                                            + + +
                                            +

                                            hooks.php

                                            + + + +

                                            + Interfaces, Classes and Traits + +

                                            + +
                                            + +
                                            MCI_Footnotes_Hooks
                                            +
                                            Registers all WordPress Hooks and executes them on demand.
                                            + +
                                            + + + + + + + +
                                            +
                                            +
                                            +
                                            +

                                            Search results

                                            + +
                                            +
                                            +
                                              +
                                              +
                                              +
                                              +
                                              +
                                              + + +
                                              + + + + diff --git a/docs/files/class-init.html b/docs/files/class-init.html new file mode 100644 index 0000000..27020fe --- /dev/null +++ b/docs/files/class-init.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                              +

                                              Documentation

                                              + + +
                                              + +
                                              + + +
                                              + +
                                              +
                                              + + + + +
                                              + + +
                                              +

                                              init.php

                                              + + + +

                                              + Interfaces, Classes and Traits + +

                                              + +
                                              + +
                                              MCI_Footnotes
                                              +
                                              Entry point of the Plugin. Loads the Dashboard and executes the Task.
                                              + +
                                              + + + + + + + +
                                              +
                                              +
                                              +
                                              +

                                              Search results

                                              + +
                                              +
                                              +
                                                +
                                                +
                                                +
                                                +
                                                +
                                                + + +
                                                + + + + diff --git a/docs/files/class-language.html b/docs/files/class-language.html new file mode 100644 index 0000000..db941a6 --- /dev/null +++ b/docs/files/class-language.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                +

                                                Documentation

                                                + + +
                                                + +
                                                + + +
                                                + +
                                                +
                                                + + + + +
                                                + + +
                                                +

                                                language.php

                                                + + + +

                                                + Interfaces, Classes and Traits + +

                                                + +
                                                + +
                                                MCI_Footnotes_Language
                                                +
                                                Loads text domain of current or default language for localization.
                                                + +
                                                + + + + + + + +
                                                +
                                                +
                                                +
                                                +

                                                Search results

                                                + +
                                                +
                                                +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  + + +
                                                  + + + + diff --git a/docs/files/class-settings.html b/docs/files/class-settings.html new file mode 100644 index 0000000..910ad5e --- /dev/null +++ b/docs/files/class-settings.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                  +

                                                  Documentation

                                                  + + +
                                                  + +
                                                  + + +
                                                  + +
                                                  +
                                                  + + + + +
                                                  + + +
                                                  +

                                                  settings.php

                                                  + + + +

                                                  + Interfaces, Classes and Traits + +

                                                  + +
                                                  + +
                                                  MCI_Footnotes_Settings
                                                  +
                                                  Loads the settings values, sets to default values if undefined.
                                                  + +
                                                  + + + + + + + +
                                                  +
                                                  +
                                                  +
                                                  +

                                                  Search results

                                                  + +
                                                  +
                                                  +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    + + +
                                                    + + + + diff --git a/docs/files/class-task.html b/docs/files/class-task.html new file mode 100644 index 0000000..d4b6618 --- /dev/null +++ b/docs/files/class-task.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                    +

                                                    Documentation

                                                    + + +
                                                    + +
                                                    + + +
                                                    + +
                                                    +
                                                    + + + + +
                                                    + + +
                                                    +

                                                    task.php

                                                    + + + +

                                                    + Interfaces, Classes and Traits + +

                                                    + +
                                                    + +
                                                    MCI_Footnotes_Task
                                                    +
                                                    Searches and replaces the footnotes.
                                                    + +
                                                    + + + + + + + +
                                                    +
                                                    +
                                                    +
                                                    +

                                                    Search results

                                                    + +
                                                    +
                                                    +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      + + +
                                                      + + + + diff --git a/docs/files/class-template.html b/docs/files/class-template.html new file mode 100644 index 0000000..09b8714 --- /dev/null +++ b/docs/files/class-template.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                      +

                                                      Documentation

                                                      + + +
                                                      + +
                                                      + + +
                                                      + +
                                                      +
                                                      + + + + +
                                                      + + +
                                                      +

                                                      template.php

                                                      + + + +

                                                      + Interfaces, Classes and Traits + +

                                                      + +
                                                      + +
                                                      MCI_Footnotes_Template
                                                      +
                                                      Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).
                                                      + +
                                                      + + + + + + + +
                                                      +
                                                      +
                                                      +
                                                      +

                                                      Search results

                                                      + +
                                                      +
                                                      +
                                                        +
                                                        +
                                                        +
                                                        +
                                                        +
                                                        + + +
                                                        + + + + diff --git a/docs/files/class-widgets-base.html b/docs/files/class-widgets-base.html new file mode 100644 index 0000000..edfbc18 --- /dev/null +++ b/docs/files/class-widgets-base.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                        +

                                                        Documentation

                                                        + + +
                                                        + +
                                                        + + +
                                                        + +
                                                        +
                                                        + + + + +
                                                        + + +
                                                        +

                                                        base.php

                                                        + + + +

                                                        + Interfaces, Classes and Traits + +

                                                        + +
                                                        + +
                                                        MCI_Footnotes_WidgetBase
                                                        +
                                                        Base Class for all Plugin Widgets. Registers each Widget to WordPress.
                                                        + +
                                                        + + + + + + + +
                                                        +
                                                        +
                                                        +
                                                        +

                                                        Search results

                                                        + +
                                                        +
                                                        +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          + + +
                                                          + + + + diff --git a/docs/files/class-widgets-reference-container.html b/docs/files/class-widgets-reference-container.html new file mode 100644 index 0000000..9553b8a --- /dev/null +++ b/docs/files/class-widgets-reference-container.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                          +

                                                          Documentation

                                                          + + +
                                                          + +
                                                          + + +
                                                          + +
                                                          +
                                                          + + + + +
                                                          + + +
                                                          +

                                                          reference-container.php

                                                          + + + +

                                                          + Interfaces, Classes and Traits + +

                                                          + +
                                                          + +
                                                          MCI_Footnotes_Widget_ReferenceContainer
                                                          +
                                                          Registers a Widget to put the Reference Container to the widget area.
                                                          + +
                                                          + + + + + + + +
                                                          +
                                                          +
                                                          +
                                                          +

                                                          Search results

                                                          + +
                                                          +
                                                          +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            + + +
                                                            + + + + diff --git a/docs/files/class-wysiwyg.html b/docs/files/class-wysiwyg.html new file mode 100644 index 0000000..59d1315 --- /dev/null +++ b/docs/files/class-wysiwyg.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                            +

                                                            Documentation

                                                            + + +
                                                            + +
                                                            + + +
                                                            + +
                                                            +
                                                            + + + + +
                                                            + + +
                                                            +

                                                            wysiwyg.php

                                                            + + + +

                                                            + Interfaces, Classes and Traits + +

                                                            + +
                                                            + +
                                                            MCI_Footnotes_WYSIWYG
                                                            +
                                                            + +
                                                            + + + + + + + +
                                                            +
                                                            +
                                                            +
                                                            +

                                                            Search results

                                                            + +
                                                            +
                                                            +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              + + +
                                                              + + + + diff --git a/docs/files/footnotes.html b/docs/files/footnotes.html new file mode 100644 index 0000000..132a72c --- /dev/null +++ b/docs/files/footnotes.html @@ -0,0 +1,110 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                              +

                                                              Documentation

                                                              + + +
                                                              + +
                                                              + + +
                                                              + +
                                                              +
                                                              + + + + +
                                                              + + +
                                                              +

                                                              footnotes.php

                                                              + + + + + + + + + + +
                                                              +
                                                              +
                                                              +
                                                              +

                                                              Search results

                                                              + +
                                                              +
                                                              +
                                                                +
                                                                +
                                                                +
                                                                +
                                                                +
                                                                + + +
                                                                + + + + diff --git a/docs/files/includes.html b/docs/files/includes.html new file mode 100644 index 0000000..de8700d --- /dev/null +++ b/docs/files/includes.html @@ -0,0 +1,190 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                                +

                                                                Documentation

                                                                + + +
                                                                + +
                                                                + + +
                                                                + +
                                                                +
                                                                + + + + +
                                                                + + +
                                                                +

                                                                includes.php

                                                                + + + + + +

                                                                + Table of Contents + +

                                                                + +
                                                                +
                                                                + MCI_Footnotes_requirePhpFiles() + +  : mixed +
                                                                +
                                                                Requires (require_once) all *.php files inside a specific Directory.
                                                                + +
                                                                + + + + +
                                                                +

                                                                + Functions + +

                                                                +
                                                                +

                                                                + MCI_Footnotes_requirePhpFiles() + +

                                                                + + +

                                                                Requires (require_once) all *.php files inside a specific Directory.

                                                                + + + + MCI_Footnotes_requirePhpFiles(string $p_str_Directory) : mixed + +
                                                                + +
                                                                Parameters
                                                                +
                                                                +
                                                                + $p_str_Directory + : string +
                                                                +
                                                                +

                                                                Absolute Directory path to lookup for *.php files

                                                                +
                                                                + +
                                                                +
                                                                + + +
                                                                + Tags + +
                                                                +
                                                                +
                                                                + author +
                                                                +
                                                                + +

                                                                Stefan Herndler

                                                                +
                                                                + +
                                                                +
                                                                + since +
                                                                +
                                                                + 1.5.0 + +
                                                                + +
                                                                +
                                                                + + +
                                                                +
                                                                + +
                                                                +
                                                                +
                                                                +
                                                                +

                                                                Search results

                                                                + +
                                                                +
                                                                +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + + +
                                                                  + + + + diff --git a/docs/graphs/classes.html b/docs/graphs/classes.html new file mode 100644 index 0000000..f77584f --- /dev/null +++ b/docs/graphs/classes.html @@ -0,0 +1,97 @@ + + + + + Documentation + + + + + + + + +
                                                                  +

                                                                  Documentation

                                                                  + + +
                                                                  + +
                                                                  + + +
                                                                  + +
                                                                  +
                                                                  + + + + +
                                                                  +
                                                                  + +
                                                                  + +
                                                                  +
                                                                  +
                                                                  +

                                                                  Search results

                                                                  + +
                                                                  +
                                                                  +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    + + +
                                                                    + + + + diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..003b277 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,223 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                                    +

                                                                    Documentation

                                                                    + + +
                                                                    + +
                                                                    + + +
                                                                    + +
                                                                    +
                                                                    + + + + +
                                                                    +

                                                                    Documentation

                                                                    + + + + +

                                                                    + Interfaces, Classes and Traits + +

                                                                    + +
                                                                    + +
                                                                    MCI_Footnotes_Config
                                                                    +
                                                                    Contains all Plugin Constants. Contains no Method or Property.
                                                                    +
                                                                    MCI_Footnotes_Convert
                                                                    +
                                                                    Converts data types and Footnotes specific values.
                                                                    +
                                                                    MCI_Footnotes_Layout_Init
                                                                    +
                                                                    Handles the Settings interface of the Plugin.
                                                                    +
                                                                    MCI_Footnotes_LayoutEngine
                                                                    +
                                                                    Layout Engine for the administration dashboard.
                                                                    +
                                                                    MCI_Footnotes_Layout_Diagnostics
                                                                    +
                                                                    Displays Diagnostics of the web server, PHP and WordPress.
                                                                    +
                                                                    MCI_Footnotes_Layout_Settings
                                                                    +
                                                                    Displays and handles all Settings of the Plugin.
                                                                    +
                                                                    MCI_Footnotes_Hooks
                                                                    +
                                                                    Registers all WordPress Hooks and executes them on demand.
                                                                    +
                                                                    MCI_Footnotes
                                                                    +
                                                                    Entry point of the Plugin. Loads the Dashboard and executes the Task.
                                                                    +
                                                                    MCI_Footnotes_Language
                                                                    +
                                                                    Loads text domain of current or default language for localization.
                                                                    +
                                                                    MCI_Footnotes_Settings
                                                                    +
                                                                    Loads the settings values, sets to default values if undefined.
                                                                    +
                                                                    MCI_Footnotes_Task
                                                                    +
                                                                    Searches and replaces the footnotes.
                                                                    +
                                                                    MCI_Footnotes_Template
                                                                    +
                                                                    Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).
                                                                    +
                                                                    MCI_Footnotes_WidgetBase
                                                                    +
                                                                    Base Class for all Plugin Widgets. Registers each Widget to WordPress.
                                                                    +
                                                                    MCI_Footnotes_Widget_ReferenceContainer
                                                                    +
                                                                    Registers a Widget to put the Reference Container to the widget area.
                                                                    +
                                                                    MCI_Footnotes_WYSIWYG
                                                                    +
                                                                    + +
                                                                    + + +

                                                                    + Table of Contents + +

                                                                    + +
                                                                    +
                                                                    + MCI_Footnotes_requirePhpFiles() + +  : mixed +
                                                                    +
                                                                    Requires (require_once) all *.php files inside a specific Directory.
                                                                    + +
                                                                    + + + +
                                                                    +

                                                                    + Functions + +

                                                                    +
                                                                    +

                                                                    + MCI_Footnotes_requirePhpFiles() + +

                                                                    + + +

                                                                    Requires (require_once) all *.php files inside a specific Directory.

                                                                    + + + + MCI_Footnotes_requirePhpFiles(string $p_str_Directory) : mixed + +
                                                                    + +
                                                                    Parameters
                                                                    +
                                                                    +
                                                                    + $p_str_Directory + : string +
                                                                    +
                                                                    +

                                                                    Absolute Directory path to lookup for *.php files

                                                                    +
                                                                    + +
                                                                    +
                                                                    + + +
                                                                    + Tags + +
                                                                    +
                                                                    +
                                                                    + author +
                                                                    +
                                                                    + +

                                                                    Stefan Herndler

                                                                    +
                                                                    + +
                                                                    +
                                                                    + since +
                                                                    +
                                                                    + 1.5.0 + +
                                                                    + +
                                                                    +
                                                                    + + +
                                                                    +
                                                                    + +
                                                                    +
                                                                    +
                                                                    +

                                                                    Search results

                                                                    + +
                                                                    +
                                                                    +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      + + +
                                                                      + + + + diff --git a/docs/indices/files.html b/docs/indices/files.html new file mode 100644 index 0000000..7ac73fe --- /dev/null +++ b/docs/indices/files.html @@ -0,0 +1,142 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                                      +

                                                                      Documentation

                                                                      + + +
                                                                      + +
                                                                      + + +
                                                                      + +
                                                                      +
                                                                      + + + + +
                                                                      + +

                                                                      Files

                                                                      +

                                                                      B

                                                                      + +

                                                                      C

                                                                      + +

                                                                      F

                                                                      + +

                                                                      H

                                                                      + +

                                                                      I

                                                                      + +

                                                                      L

                                                                      + +

                                                                      R

                                                                      + +

                                                                      S

                                                                      + +

                                                                      T

                                                                      + +

                                                                      W

                                                                      + +
                                                                      +
                                                                      +
                                                                      +

                                                                      Search results

                                                                      + +
                                                                      +
                                                                      +
                                                                        +
                                                                        +
                                                                        +
                                                                        +
                                                                        +
                                                                        + + +
                                                                        + + + + diff --git a/docs/js/search.js b/docs/js/search.js new file mode 100644 index 0000000..a7e3595 --- /dev/null +++ b/docs/js/search.js @@ -0,0 +1,173 @@ +// Search module for phpDocumentor +// +// This module is a wrapper around fuse.js that will use a given index and attach itself to a +// search form and to a search results pane identified by the following data attributes: +// +// 1. data-search-form +// 2. data-search-results +// +// The data-search-form is expected to have a single input element of type 'search' that will trigger searching for +// a series of results, were the data-search-results pane is expected to have a direct UL child that will be populated +// with rendered results. +// +// The search has various stages, upon loading this stage the data-search-form receives the CSS class +// 'phpdocumentor-search--enabled'; this indicates that JS is allowed and indices are being loaded. It is recommended +// to hide the form by default and show it when it receives this class to achieve progressive enhancement for this +// feature. +// +// After loading this module, it is expected to load a search index asynchronously, for example: +// +// +// +// In this script the generated index should attach itself to the search module using the `appendIndex` function. By +// doing it like this the page will continue loading, unhindered by the loading of the search. +// +// After the page has fully loaded, and all these deferred indexes loaded, the initialization of the search module will +// be called and the form will receive the class 'phpdocumentor-search--active', indicating search is ready. At this +// point, the input field will also have it's 'disabled' attribute removed. +var Search = (function () { + var fuse; + var index = []; + var options = { + shouldSort: true, + threshold: 0.6, + location: 0, + distance: 100, + maxPatternLength: 32, + minMatchCharLength: 1, + keys: [ + "fqsen", + "name", + "summary", + "url" + ] + }; + + // Credit David Walsh (https://davidwalsh.name/javascript-debounce-function) + // Returns a function, that, as long as it continues to be invoked, will not + // be triggered. The function will be called after it stops being called for + // N milliseconds. If `immediate` is passed, trigger the function on the + // leading edge, instead of the trailing. + function debounce(func, wait, immediate) { + var timeout; + + return function executedFunction() { + var context = this; + var args = arguments; + + var later = function () { + timeout = null; + if (!immediate) func.apply(context, args); + }; + + var callNow = immediate && !timeout; + clearTimeout(timeout); + timeout = setTimeout(later, wait); + if (callNow) func.apply(context, args); + }; + } + + function close() { + // Start scroll prevention: https://css-tricks.com/prevent-page-scrolling-when-a-modal-is-open/ + const scrollY = document.body.style.top; + document.body.style.position = ''; + document.body.style.top = ''; + window.scrollTo(0, parseInt(scrollY || '0') * -1); + // End scroll prevention + + var form = document.querySelector('[data-search-form]'); + var searchResults = document.querySelector('[data-search-results]'); + + form.classList.toggle('phpdocumentor-search--has-results', false); + searchResults.classList.add('phpdocumentor-search-results--hidden'); + var searchField = document.querySelector('[data-search-form] input[type="search"]'); + searchField.blur(); + } + + function search(event) { + // Start scroll prevention: https://css-tricks.com/prevent-page-scrolling-when-a-modal-is-open/ + document.body.style.position = 'fixed'; + document.body.style.top = `-${window.scrollY}px`; + // End scroll prevention + + // prevent enter's from autosubmitting + event.stopPropagation(); + + var form = document.querySelector('[data-search-form]'); + var searchResults = document.querySelector('[data-search-results]'); + var searchResultEntries = document.querySelector('[data-search-results] .phpdocumentor-search-results__entries'); + + searchResultEntries.innerHTML = ''; + + if (!event.target.value) { + close(); + return; + } + + form.classList.toggle('phpdocumentor-search--has-results', true); + searchResults.classList.remove('phpdocumentor-search-results--hidden'); + var results = fuse.search(event.target.value, {limit: 25}); + + results.forEach(function (result) { + var entry = document.createElement("li"); + entry.classList.add("phpdocumentor-search-results__entry"); + entry.innerHTML += '

                                                                        ' + result.name + "

                                                                        \n"; + entry.innerHTML += '' + result.fqsen + "\n"; + entry.innerHTML += '
                                                                        ' + result.summary + '
                                                                        '; + searchResultEntries.appendChild(entry) + }); + } + + function appendIndex(added) { + index = index.concat(added); + + // re-initialize search engine when appending an index after initialisation + if (typeof fuse !== 'undefined') { + fuse = new Fuse(index, options); + } + } + + function init() { + fuse = new Fuse(index, options); + + var form = document.querySelector('[data-search-form]'); + var searchField = document.querySelector('[data-search-form] input[type="search"]'); + + var closeButton = document.querySelector('.phpdocumentor-search-results__close'); + closeButton.addEventListener('click', function() { close() }.bind(this)); + + var searchResults = document.querySelector('[data-search-results]'); + searchResults.addEventListener('click', function() { close() }.bind(this)); + + form.classList.add('phpdocumentor-search--active'); + + searchField.setAttribute('placeholder', 'Search (Press "/" to focus)'); + searchField.removeAttribute('disabled'); + searchField.addEventListener('keyup', debounce(search, 300)); + + window.addEventListener('keyup', function (event) { + if (event.key === '/') { + searchField.focus(); + } + if (event.code === 'Escape') { + close(); + } + }.bind(this)); + } + + return { + appendIndex, + init + } +})(); + +window.addEventListener('DOMContentLoaded', function () { + var form = document.querySelector('[data-search-form]'); + + // When JS is supported; show search box. Must be before including the search for it to take effect immediately + form.classList.add('phpdocumentor-search--enabled'); +}); + +window.addEventListener('load', function () { + Search.init(); +}); diff --git a/docs/js/searchIndex.js b/docs/js/searchIndex.js new file mode 100644 index 0000000..ca8f2cc --- /dev/null +++ b/docs/js/searchIndex.js @@ -0,0 +1,1419 @@ +Search.appendIndex( + [ + { + "fqsen": "\\MCI_Footnotes_Config", + "name": "MCI_Footnotes_Config", + "summary": "Contains\u0020all\u0020Plugin\u0020Constants.\u0020Contains\u0020no\u0020Method\u0020or\u0020Property.", + "url": "classes/MCI-Footnotes-Config.html" + }, { + "fqsen": "\\MCI_Footnotes_Config\u003A\u003AC_STR_PLUGIN_NAME", + "name": "C_STR_PLUGIN_NAME", + "summary": "Internal\u0020Plugin\u0020name.", + "url": "classes/MCI-Footnotes-Config.html#constant_C_STR_PLUGIN_NAME" + }, { + "fqsen": "\\MCI_Footnotes_Config\u003A\u003AC_STR_PLUGIN_PUBLIC_NAME", + "name": "C_STR_PLUGIN_PUBLIC_NAME", + "summary": "Public\u0020Plugin\u0020name.", + "url": "classes/MCI-Footnotes-Config.html#constant_C_STR_PLUGIN_PUBLIC_NAME" + }, { + "fqsen": "\\MCI_Footnotes_Config\u003A\u003AC_STR_PLUGIN_HEADING_NAME", + "name": "C_STR_PLUGIN_HEADING_NAME", + "summary": "Public\u0020Plugin\u0020name\u0020for\u0020dashboard\u0020heading", + "url": "classes/MCI-Footnotes-Config.html#constant_C_STR_PLUGIN_HEADING_NAME" + }, { + "fqsen": "\\MCI_Footnotes_Config\u003A\u003AC_STR_LOVE_SYMBOL", + "name": "C_STR_LOVE_SYMBOL", + "summary": "Html\u0020tag\u0020for\u0020the\u0020LOVE\u0020symbol.", + "url": "classes/MCI-Footnotes-Config.html#constant_C_STR_LOVE_SYMBOL" + }, { + "fqsen": "\\MCI_Footnotes_Config\u003A\u003AC_STR_LOVE_SYMBOL_HEADING", + "name": "C_STR_LOVE_SYMBOL_HEADING", + "summary": "HTML\u0020code\u0020for\u0020the\u0020\u0027love\u0027\u0020symbol\u0020used\u0020in\u0020dashboard\u0020heading", + "url": "classes/MCI-Footnotes-Config.html#constant_C_STR_LOVE_SYMBOL_HEADING" + }, { + "fqsen": "\\MCI_Footnotes_Config\u003A\u003AC_STR_NO_LOVE_SLUG", + "name": "C_STR_NO_LOVE_SLUG", + "summary": "Short\u0020code\u0020to\u0020DON\u0027T\u0020display\u0020the\u0020\u0027LOVE\u0020ME\u0027\u0020slug\u0020on\u0020certain\u0020pages.", + "url": "classes/MCI-Footnotes-Config.html#constant_C_STR_NO_LOVE_SLUG" + }, { + "fqsen": "\\MCI_Footnotes_Convert", + "name": "MCI_Footnotes_Convert", + "summary": "Converts\u0020data\u0020types\u0020and\u0020Footnotes\u0020specific\u0020values.", + "url": "classes/MCI-Footnotes-Convert.html" + }, { + "fqsen": "\\MCI_Footnotes_Convert\u003A\u003AIndex\u0028\u0029", + "name": "Index", + "summary": "Converts\u0020a\u0020integer\u0020into\u0020the\u0020user\u002Ddefined\u0020counter\u0020style\u0020for\u0020the\u0020footnotes.", + "url": "classes/MCI-Footnotes-Convert.html#method_Index" + }, { + "fqsen": "\\MCI_Footnotes_Convert\u003A\u003AtoLatin\u0028\u0029", + "name": "toLatin", + "summary": "Converts\u0020an\u0020integer\u0020into\u0020latin\u0020ascii\u0020characters,\u0020either\u0020lower\u0020or\u0020upper\u002Dcase.", + "url": "classes/MCI-Footnotes-Convert.html#method_toLatin" + }, { + "fqsen": "\\MCI_Footnotes_Convert\u003A\u003AtoArabicLeading\u0028\u0029", + "name": "toArabicLeading", + "summary": "Converts\u0020an\u0020integer\u0020to\u0020a\u0020leading\u002D0\u0020integer.", + "url": "classes/MCI-Footnotes-Convert.html#method_toArabicLeading" + }, { + "fqsen": "\\MCI_Footnotes_Convert\u003A\u003AtoRomanic\u0028\u0029", + "name": "toRomanic", + "summary": "Converts\u0020an\u0020integer\u0020to\u0020a\u0020romanic\u0020letter.", + "url": "classes/MCI-Footnotes-Convert.html#method_toRomanic" + }, { + "fqsen": "\\MCI_Footnotes_Convert\u003A\u003AtoBool\u0028\u0029", + "name": "toBool", + "summary": "Converts\u0020a\u0020string\u0020depending\u0020on\u0020its\u0020value\u0020to\u0020a\u0020boolean.", + "url": "classes/MCI-Footnotes-Convert.html#method_toBool" + }, { + "fqsen": "\\MCI_Footnotes_Convert\u003A\u003AgetArrow\u0028\u0029", + "name": "getArrow", + "summary": "Get\u0020a\u0020html\u0020Array\u0020short\u0020code\u0020depending\u0020on\u0020Arrow\u002DArray\u0020key\u0020index.", + "url": "classes/MCI-Footnotes-Convert.html#method_getArrow" + }, { + "fqsen": "\\MCI_Footnotes_Convert\u003A\u003Adebug\u0028\u0029", + "name": "debug", + "summary": "Displays\u0020a\u0020Variable.", + "url": "classes/MCI-Footnotes-Convert.html#method_debug" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Init", + "name": "MCI_Footnotes_Layout_Init", + "summary": "Handles\u0020the\u0020Settings\u0020interface\u0020of\u0020the\u0020Plugin.", + "url": "classes/MCI-Footnotes-Layout-Init.html" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Class\u0020Constructor.\u0020Initializes\u0020all\u0020WordPress\u0020hooks\u0020for\u0020the\u0020Plugin\u0020Settings.", + "url": "classes/MCI-Footnotes-Layout-Init.html#method___construct" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003AinitializeSettings\u0028\u0029", + "name": "initializeSettings", + "summary": "Initializes\u0020all\u0020sub\u0020pages\u0020and\u0020registers\u0020the\u0020settings.", + "url": "classes/MCI-Footnotes-Layout-Init.html#method_initializeSettings" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003AregisterMainMenu\u0028\u0029", + "name": "registerMainMenu", + "summary": "Registers\u0020the\u0020new\u0020main\u0020menu\u0020for\u0020the\u0020WordPress\u0020dashboard.", + "url": "classes/MCI-Footnotes-Layout-Init.html#method_registerMainMenu" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003AregisterSubPages\u0028\u0029", + "name": "registerSubPages", + "summary": "Registers\u0020all\u0020SubPages\u0020for\u0020this\u0020Plugin.", + "url": "classes/MCI-Footnotes-Layout-Init.html#method_registerSubPages" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003AdisplayOtherPlugins\u0028\u0029", + "name": "displayOtherPlugins", + "summary": "Displays\u0020other\u0020Plugins\u0020from\u0020the\u0020developers.", + "url": "classes/MCI-Footnotes-Layout-Init.html#method_displayOtherPlugins" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003AgetPluginMetaInformation\u0028\u0029", + "name": "getPluginMetaInformation", + "summary": "AJAX\u0020call.\u0020returns\u0020a\u0020JSON\u0020string\u0020containing\u0020meta\u0020information\u0020about\u0020a\u0020specific\u0020WordPress\u0020Plugin.", + "url": "classes/MCI-Footnotes-Layout-Init.html#method_getPluginMetaInformation" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003AC_STR_MAIN_MENU_SLUG", + "name": "C_STR_MAIN_MENU_SLUG", + "summary": "Slug\u0020for\u0020the\u0020Plugin\u0020main\u0020menu.", + "url": "classes/MCI-Footnotes-Layout-Init.html#constant_C_STR_MAIN_MENU_SLUG" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003AC_STR_MAIN_MENU_TITLE", + "name": "C_STR_MAIN_MENU_TITLE", + "summary": "Plugin\u0020main\u0020menu\u0020name.", + "url": "classes/MCI-Footnotes-Layout-Init.html#constant_C_STR_MAIN_MENU_TITLE" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003A\u0024a_arr_SubPageClasses", + "name": "a_arr_SubPageClasses", + "summary": "", + "url": "classes/MCI-Footnotes-Layout-Init.html#property_a_arr_SubPageClasses" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine", + "name": "MCI_Footnotes_LayoutEngine", + "summary": "Layout\u0020Engine\u0020for\u0020the\u0020administration\u0020dashboard.", + "url": "classes/MCI-Footnotes-LayoutEngine.html" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AgetPriority\u0028\u0029", + "name": "getPriority", + "summary": "Returns\u0020a\u0020Priority\u0020index.\u0020Lower\u0020numbers\u0020have\u0020a\u0020higher\u0020Priority.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_getPriority" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AgetSubPageSlug\u0028\u0029", + "name": "getSubPageSlug", + "summary": "Returns\u0020the\u0020unique\u0020slug\u0020of\u0020the\u0020child\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_getSubPageSlug" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AgetSubPageTitle\u0028\u0029", + "name": "getSubPageTitle", + "summary": "Returns\u0020the\u0020title\u0020of\u0020the\u0020child\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_getSubPageTitle" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AgetSections\u0028\u0029", + "name": "getSections", + "summary": "Returns\u0020an\u0020array\u0020of\u0020all\u0020registered\u0020sections\u0020for\u0020a\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_getSections" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AgetMetaBoxes\u0028\u0029", + "name": "getMetaBoxes", + "summary": "Returns\u0020an\u0020array\u0020of\u0020all\u0020registered\u0020meta\u0020boxes.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_getMetaBoxes" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddSection\u0028\u0029", + "name": "addSection", + "summary": "Returns\u0020an\u0020array\u0020describing\u0020a\u0020sub\u0020page\u0020section.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addSection" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddMetaBox\u0028\u0029", + "name": "addMetaBox", + "summary": "Returns\u0020an\u0020array\u0020describing\u0020a\u0020meta\u0020box.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addMetaBox" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AregisterSubPage\u0028\u0029", + "name": "registerSubPage", + "summary": "Registers\u0020a\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_registerSubPage" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AregisterSections\u0028\u0029", + "name": "registerSections", + "summary": "Registers\u0020all\u0020sections\u0020for\u0020a\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_registerSections" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AregisterMetaBoxes\u0028\u0029", + "name": "registerMetaBoxes", + "summary": "Registers\u0020all\u0020Meta\u0020boxes\u0020for\u0020a\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_registerMetaBoxes" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AappendScripts\u0028\u0029", + "name": "appendScripts", + "summary": "Append\u0020javascript\u0020and\u0020css\u0020files\u0020for\u0020specific\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_appendScripts" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AdisplayContent\u0028\u0029", + "name": "displayContent", + "summary": "Displays\u0020the\u0020content\u0020of\u0020specific\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_displayContent" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AsaveSettings\u0028\u0029", + "name": "saveSettings", + "summary": "Save\u0020all\u0020Plugin\u0020settings.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_saveSettings" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003ADescription\u0028\u0029", + "name": "Description", + "summary": "Output\u0020the\u0020Description\u0020of\u0020a\u0020section.\u0020May\u0020be\u0020overwritten\u0020in\u0020any\u0020section.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_Description" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003ALoadSetting\u0028\u0029", + "name": "LoadSetting", + "summary": "Loads\u0020specific\u0020setting\u0020and\u0020returns\u0020an\u0020array\u0020with\u0020the\u0020keys\u0020\u005Bid,\u0020name,\u0020value\u005D.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_LoadSetting" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddNewline\u0028\u0029", + "name": "addNewline", + "summary": "Returns\u0020a\u0020line\u0020break\u0020to\u0020start\u0020a\u0020new\u0020line.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addNewline" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddLineSpace\u0028\u0029", + "name": "addLineSpace", + "summary": "Returns\u0020a\u0020line\u0020break\u0020to\u0020have\u0020a\u0020space\u0020between\u0020two\u0020lines.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addLineSpace" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddText\u0028\u0029", + "name": "addText", + "summary": "Returns\u0020a\u0020simple\u0020text\u0020inside\u0020html\u0020\u003Cspan\u003E\u0020text.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addText" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddLabel\u0028\u0029", + "name": "addLabel", + "summary": "Returns\u0020the\u0020html\u0020tag\u0020for\u0020an\u0020input\/select\u0020label.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addLabel" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddTextBox\u0028\u0029", + "name": "addTextBox", + "summary": "Returns\u0020the\u0020html\u0020tag\u0020for\u0020an\u0020input\u0020\u005Btype\u0020\u003D\u0020text\u005D.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addTextBox" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddCheckbox\u0028\u0029", + "name": "addCheckbox", + "summary": "Returns\u0020the\u0020html\u0020tag\u0020for\u0020an\u0020input\u0020\u005Btype\u0020\u003D\u0020checkbox\u005D.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addCheckbox" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddSelectBox\u0028\u0029", + "name": "addSelectBox", + "summary": "Returns\u0020the\u0020html\u0020tag\u0020for\u0020a\u0020select\u0020box.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addSelectBox" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddTextArea\u0028\u0029", + "name": "addTextArea", + "summary": "Returns\u0020the\u0020html\u0020tag\u0020for\u0020a\u0020text\u0020area.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addTextArea" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddColorSelection\u0028\u0029", + "name": "addColorSelection", + "summary": "Returns\u0020the\u0020html\u0020tag\u0020for\u0020an\u0020input\u0020\u005Btype\u0020\u003D\u0020text\u005D\u0020with\u0020color\u0020selection\u0020class.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addColorSelection" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddNumBox\u0028\u0029", + "name": "addNumBox", + "summary": "Returns\u0020the\u0020html\u0020tag\u0020for\u0020an\u0020input\u0020\u005Btype\u0020\u003D\u0020num\u005D.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addNumBox" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003A\u0024a_str_SubPageHook", + "name": "a_str_SubPageHook", + "summary": "Stores\u0020the\u0020Hook\u0020connection\u0020string\u0020for\u0020the\u0020child\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#property_a_str_SubPageHook" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003A\u0024a_arr_Sections", + "name": "a_arr_Sections", + "summary": "Stores\u0020all\u0020Sections\u0020for\u0020the\u0020child\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#property_a_arr_Sections" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Diagnostics", + "name": "MCI_Footnotes_Layout_Diagnostics", + "summary": "Displays\u0020Diagnostics\u0020of\u0020the\u0020web\u0020server,\u0020PHP\u0020and\u0020WordPress.", + "url": "classes/MCI-Footnotes-Layout-Diagnostics.html" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Diagnostics\u003A\u003AgetPriority\u0028\u0029", + "name": "getPriority", + "summary": "Returns\u0020a\u0020Priority\u0020index.\u0020Lower\u0020numbers\u0020have\u0020a\u0020higher\u0020Priority.", + "url": "classes/MCI-Footnotes-Layout-Diagnostics.html#method_getPriority" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Diagnostics\u003A\u003AgetSubPageSlug\u0028\u0029", + "name": "getSubPageSlug", + "summary": "Returns\u0020the\u0020unique\u0020slug\u0020of\u0020the\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-Layout-Diagnostics.html#method_getSubPageSlug" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Diagnostics\u003A\u003AgetSubPageTitle\u0028\u0029", + "name": "getSubPageTitle", + "summary": "Returns\u0020the\u0020title\u0020of\u0020the\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-Layout-Diagnostics.html#method_getSubPageTitle" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Diagnostics\u003A\u003AgetSections\u0028\u0029", + "name": "getSections", + "summary": "Returns\u0020an\u0020array\u0020of\u0020all\u0020registered\u0020sections\u0020for\u0020the\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-Layout-Diagnostics.html#method_getSections" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Diagnostics\u003A\u003AgetMetaBoxes\u0028\u0029", + "name": "getMetaBoxes", + "summary": "Returns\u0020an\u0020array\u0020of\u0020all\u0020registered\u0020meta\u0020boxes\u0020for\u0020each\u0020section\u0020of\u0020the\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-Layout-Diagnostics.html#method_getMetaBoxes" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Diagnostics\u003A\u003ADiagnostics\u0028\u0029", + "name": "Diagnostics", + "summary": "Displays\u0020a\u0020diagnostics\u0020about\u0020the\u0020web\u0020server,\u0020php\u0020and\u0020WordPress.", + "url": "classes/MCI-Footnotes-Layout-Diagnostics.html#method_Diagnostics" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings", + "name": "MCI_Footnotes_Layout_Settings", + "summary": "Displays\u0020and\u0020handles\u0020all\u0020Settings\u0020of\u0020the\u0020Plugin.", + "url": "classes/MCI-Footnotes-Layout-Settings.html" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AgetPriority\u0028\u0029", + "name": "getPriority", + "summary": "Returns\u0020a\u0020Priority\u0020index.\u0020Lower\u0020numbers\u0020have\u0020a\u0020higher\u0020Priority.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_getPriority" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AgetSubPageSlug\u0028\u0029", + "name": "getSubPageSlug", + "summary": "Returns\u0020the\u0020unique\u0020slug\u0020of\u0020the\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_getSubPageSlug" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AgetSubPageTitle\u0028\u0029", + "name": "getSubPageTitle", + "summary": "Returns\u0020the\u0020title\u0020of\u0020the\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_getSubPageTitle" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AgetSections\u0028\u0029", + "name": "getSections", + "summary": "Returns\u0020an\u0020array\u0020of\u0020all\u0020registered\u0020sections\u0020for\u0020the\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_getSections" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AgetMetaBoxes\u0028\u0029", + "name": "getMetaBoxes", + "summary": "Returns\u0020an\u0020array\u0020of\u0020all\u0020registered\u0020meta\u0020boxes\u0020for\u0020each\u0020section\u0020of\u0020the\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_getMetaBoxes" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AReferenceContainer\u0028\u0029", + "name": "ReferenceContainer", + "summary": "Displays\u0020all\u0020settings\u0020for\u0020the\u0020reference\u0020container.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_ReferenceContainer" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AStartEnd\u0028\u0029", + "name": "StartEnd", + "summary": "Displays\u0020all\u0020options\u0020for\u0020the\u0020footnotes\u0020start\u0020and\u0020end\u0020tag\u0020short\u0020codes\nDisplays\u0020all\u0020options\u0020for\u0020the\u0020footnotes\u0020numbering\nDisplays\u0020all\u0020options\u0020for\u0020the\u0020scrolling\u0020behavior", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_StartEnd" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003ANumbering\u0028\u0029", + "name": "Numbering", + "summary": "", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_Numbering" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AScrolling\u0028\u0029", + "name": "Scrolling", + "summary": "", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_Scrolling" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003ALove\u0028\u0029", + "name": "Love", + "summary": "Displays\u0020all\u0020settings\u0020for\u0020\u0027I\u0020love\u0020Footnotes\u0027.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_Love" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AExcerpts\u0028\u0029", + "name": "Excerpts", + "summary": "Displays\u0020the\u0020excerpt\u0020setting", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_Excerpts" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003ASuperscript\u0028\u0029", + "name": "Superscript", + "summary": "Displays\u0020all\u0020settings\u0020for\u0020the\u0020footnote\u0020referrers", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_Superscript" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AMouseOverBox\u0028\u0029", + "name": "MouseOverBox", + "summary": "Displays\u0020all\u0020settings\u0020for\u0020the\u0020footnotes\u0020mouse\u002Dover\u0020box.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_MouseOverBox" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AMouseOverBoxPosition\u0028\u0029", + "name": "MouseOverBoxPosition", + "summary": "", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_MouseOverBoxPosition" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AMouseOverBoxDimensions\u0028\u0029", + "name": "MouseOverBoxDimensions", + "summary": "", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_MouseOverBoxDimensions" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AMouseOverBoxTiming\u0028\u0029", + "name": "MouseOverBoxTiming", + "summary": "", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_MouseOverBoxTiming" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AMouseOverBoxTruncation\u0028\u0029", + "name": "MouseOverBoxTruncation", + "summary": "", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_MouseOverBoxTruncation" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AMouseOverBoxText\u0028\u0029", + "name": "MouseOverBoxText", + "summary": "", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_MouseOverBoxText" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AMouseOverBoxAppearance\u0028\u0029", + "name": "MouseOverBoxAppearance", + "summary": "", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_MouseOverBoxAppearance" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AHyperlinkArrow\u0028\u0029", + "name": "HyperlinkArrow", + "summary": "Displays\u0020all\u0020settings\u0020for\u0020the\u0020prepended\u0020symbol", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_HyperlinkArrow" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003ACustomCSS\u0028\u0029", + "name": "CustomCSS", + "summary": "Displays\u0020the\u0020custom\u0020css\u0020box.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_CustomCSS" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003ACustomCSSMigration\u0028\u0029", + "name": "CustomCSSMigration", + "summary": "", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_CustomCSSMigration" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003ACustomCSSNew\u0028\u0029", + "name": "CustomCSSNew", + "summary": "", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_CustomCSSNew" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003ALookupHooks\u0028\u0029", + "name": "LookupHooks", + "summary": "Displays\u0020available\u0020Hooks\u0020to\u0020look\u0020for\u0020Footnote\u0020short\u0020codes.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_LookupHooks" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AHelp\u0028\u0029", + "name": "Help", + "summary": "Displays\u0020a\u0020short\u0020introduction\u0020of\u0020the\u0020Plugin.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_Help" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003ADonate\u0028\u0029", + "name": "Donate", + "summary": "Displays\u0020all\u0020Donate\u0020button\u0020to\u0020support\u0020the\u0020developers.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_Donate" + }, { + "fqsen": "\\MCI_Footnotes_Hooks", + "name": "MCI_Footnotes_Hooks", + "summary": "Registers\u0020all\u0020WordPress\u0020Hooks\u0020and\u0020executes\u0020them\u0020on\u0020demand.", + "url": "classes/MCI-Footnotes-Hooks.html" + }, { + "fqsen": "\\MCI_Footnotes_Hooks\u003A\u003AregisterHooks\u0028\u0029", + "name": "registerHooks", + "summary": "Registers\u0020all\u0020WordPress\u0020hooks.", + "url": "classes/MCI-Footnotes-Hooks.html#method_registerHooks" + }, { + "fqsen": "\\MCI_Footnotes_Hooks\u003A\u003AactivatePlugin\u0028\u0029", + "name": "activatePlugin", + "summary": "Executed\u0020when\u0020the\u0020Plugin\u0020gets\u0020activated.", + "url": "classes/MCI-Footnotes-Hooks.html#method_activatePlugin" + }, { + "fqsen": "\\MCI_Footnotes_Hooks\u003A\u003AdeactivatePlugin\u0028\u0029", + "name": "deactivatePlugin", + "summary": "Executed\u0020when\u0020the\u0020Plugin\u0020gets\u0020deactivated.", + "url": "classes/MCI-Footnotes-Hooks.html#method_deactivatePlugin" + }, { + "fqsen": "\\MCI_Footnotes_Hooks\u003A\u003AuninstallPlugin\u0028\u0029", + "name": "uninstallPlugin", + "summary": "Executed\u0020when\u0020the\u0020Plugin\u0020gets\u0020uninstalled.", + "url": "classes/MCI-Footnotes-Hooks.html#method_uninstallPlugin" + }, { + "fqsen": "\\MCI_Footnotes_Hooks\u003A\u003APluginLinks\u0028\u0029", + "name": "PluginLinks", + "summary": "Add\u0020Links\u0020to\u0020the\u0020Plugin\u0020in\u0020the\u0020\u0022installed\u0020Plugins\u0022\u0020page.", + "url": "classes/MCI-Footnotes-Hooks.html#method_PluginLinks" + }, { + "fqsen": "\\MCI_Footnotes", + "name": "MCI_Footnotes", + "summary": "Entry\u0020point\u0020of\u0020the\u0020Plugin.\u0020Loads\u0020the\u0020Dashboard\u0020and\u0020executes\u0020the\u0020Task.", + "url": "classes/MCI-Footnotes.html" + }, { + "fqsen": "\\MCI_Footnotes\u003A\u003Arun\u0028\u0029", + "name": "run", + "summary": "Executes\u0020the\u0020Plugin.", + "url": "classes/MCI-Footnotes.html#method_run" + }, { + "fqsen": "\\MCI_Footnotes\u003A\u003AinitializeWidgets\u0028\u0029", + "name": "initializeWidgets", + "summary": "Initializes\u0020all\u0020Widgets\u0020of\u0020the\u0020Plugin.", + "url": "classes/MCI-Footnotes.html#method_initializeWidgets" + }, { + "fqsen": "\\MCI_Footnotes\u003A\u003AinitializeDashboard\u0028\u0029", + "name": "initializeDashboard", + "summary": "Initializes\u0020the\u0020Dashboard\u0020of\u0020the\u0020Plugin\u0020and\u0020loads\u0020them.", + "url": "classes/MCI-Footnotes.html#method_initializeDashboard" + }, { + "fqsen": "\\MCI_Footnotes\u003A\u003AinitializeTask\u0028\u0029", + "name": "initializeTask", + "summary": "Initializes\u0020the\u0020Plugin\u0020Task\u0020and\u0020registers\u0020the\u0020Task\u0020hooks.", + "url": "classes/MCI-Footnotes.html#method_initializeTask" + }, { + "fqsen": "\\MCI_Footnotes\u003A\u003AregisterPublic\u0028\u0029", + "name": "registerPublic", + "summary": "Registers\u0020and\u0020enqueues\u0020scripts\u0020and\u0020stylesheets\u0020to\u0020the\u0020public\u0020pages.", + "url": "classes/MCI-Footnotes.html#method_registerPublic" + }, { + "fqsen": "\\MCI_Footnotes\u003A\u003A\u0024a_obj_Task", + "name": "a_obj_Task", + "summary": "Reference\u0020to\u0020the\u0020Plugin\u0020Task\u0020object.", + "url": "classes/MCI-Footnotes.html#property_a_obj_Task" + }, { + "fqsen": "\\MCI_Footnotes\u003A\u003A\u0024a_bool_TooltipsEnabled", + "name": "a_bool_TooltipsEnabled", + "summary": "Template\u0020process\u0020and\u0020script\u0020\/\u0020stylesheet\u0020load\u0020optimization.", + "url": "classes/MCI-Footnotes.html#property_a_bool_TooltipsEnabled" + }, { + "fqsen": "\\MCI_Footnotes\u003A\u003A\u0024a_bool_AlternativeTooltipsEnabled", + "name": "a_bool_AlternativeTooltipsEnabled", + "summary": "", + "url": "classes/MCI-Footnotes.html#property_a_bool_AlternativeTooltipsEnabled" + }, { + "fqsen": "\\MCI_Footnotes_Language", + "name": "MCI_Footnotes_Language", + "summary": "Loads\u0020text\u0020domain\u0020of\u0020current\u0020or\u0020default\u0020language\u0020for\u0020localization.", + "url": "classes/MCI-Footnotes-Language.html" + }, { + "fqsen": "\\MCI_Footnotes_Language\u003A\u003AregisterHooks\u0028\u0029", + "name": "registerHooks", + "summary": "Register\u0020WordPress\u0020Hook.", + "url": "classes/MCI-Footnotes-Language.html#method_registerHooks" + }, { + "fqsen": "\\MCI_Footnotes_Language\u003A\u003AloadTextDomain\u0028\u0029", + "name": "loadTextDomain", + "summary": "Loads\u0020the\u0020text\u0020domain\u0020for\u0020current\u0020WordPress\u0020language\u0020if\u0020exists.", + "url": "classes/MCI-Footnotes-Language.html#method_loadTextDomain" + }, { + "fqsen": "\\MCI_Footnotes_Language\u003A\u003Aload\u0028\u0029", + "name": "load", + "summary": "Loads\u0020a\u0020specific\u0020text\u0020domain.", + "url": "classes/MCI-Footnotes-Language.html#method_load" + }, { + "fqsen": "\\MCI_Footnotes_Settings", + "name": "MCI_Footnotes_Settings", + "summary": "Loads\u0020the\u0020settings\u0020values,\u0020sets\u0020to\u0020default\u0020values\u0020if\u0020undefined.", + "url": "classes/MCI-Footnotes-Settings.html" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Class\u0020Constructor.\u0020Loads\u0020all\u0020Settings\u0020from\u0020each\u0020WordPress\u0020Settings\u0020container.", + "url": "classes/MCI-Footnotes-Settings.html#method___construct" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003Ainstance\u0028\u0029", + "name": "instance", + "summary": "Returns\u0020a\u0020singleton\u0020of\u0020this\u0020class.", + "url": "classes/MCI-Footnotes-Settings.html#method_instance" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AgetContainer\u0028\u0029", + "name": "getContainer", + "summary": "Returns\u0020the\u0020name\u0020of\u0020a\u0020specified\u0020Settings\u0020Container.", + "url": "classes/MCI-Footnotes-Settings.html#method_getContainer" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AgetDefaults\u0028\u0029", + "name": "getDefaults", + "summary": "Returns\u0020the\u0020default\u0020values\u0020of\u0020a\u0020specific\u0020Settings\u0020Container.", + "url": "classes/MCI-Footnotes-Settings.html#method_getDefaults" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AloadAll\u0028\u0029", + "name": "loadAll", + "summary": "Loads\u0020all\u0020Settings\u0020from\u0020each\u0020Settings\u0020container.", + "url": "classes/MCI-Footnotes-Settings.html#method_loadAll" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003ALoad\u0028\u0029", + "name": "Load", + "summary": "Loads\u0020all\u0020Settings\u0020from\u0020specified\u0020Settings\u0020Container.", + "url": "classes/MCI-Footnotes-Settings.html#method_Load" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AsaveOptions\u0028\u0029", + "name": "saveOptions", + "summary": "Updates\u0020a\u0020whole\u0020Settings\u0020container.", + "url": "classes/MCI-Footnotes-Settings.html#method_saveOptions" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003Aget\u0028\u0029", + "name": "get", + "summary": "Returns\u0020the\u0020value\u0020of\u0020specified\u0020Settings\u0020name.", + "url": "classes/MCI-Footnotes-Settings.html#method_get" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AClearAll\u0028\u0029", + "name": "ClearAll", + "summary": "Deletes\u0020each\u0020Settings\u0020Container\u0020and\u0020loads\u0020the\u0020default\u0020values\u0020for\u0020each\u0020Settings\u0020Container.", + "url": "classes/MCI-Footnotes-Settings.html#method_ClearAll" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003ARegisterSettings\u0028\u0029", + "name": "RegisterSettings", + "summary": "Register\u0020all\u0020Settings\u0020Container\u0020for\u0020the\u0020Plugin\u0020Settings\u0020Page\u0020in\u0020the\u0020Dashboard.", + "url": "classes/MCI-Footnotes-Settings.html#method_RegisterSettings" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_REFERENCE_CONTAINER_NAME", + "name": "C_STR_REFERENCE_CONTAINER_NAME", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020label\u0020of\u0020the\u0020reference\u0020container.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_REFERENCE_CONTAINER_NAME" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_REFERENCE_CONTAINER_COLLAPSE", + "name": "C_BOOL_REFERENCE_CONTAINER_COLLAPSE", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020collapse\u0020the\u0020reference\u0020container\u0020by\u0020default.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_REFERENCE_CONTAINER_COLLAPSE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_REFERENCE_CONTAINER_POSITION", + "name": "C_STR_REFERENCE_CONTAINER_POSITION", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020position\u0020of\u0020the\u0020reference\u0020container.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_REFERENCE_CONTAINER_POSITION" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_COMBINE_IDENTICAL_FOOTNOTES", + "name": "C_BOOL_COMBINE_IDENTICAL_FOOTNOTES", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020combining\u0020identical\u0020footnotes.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_COMBINE_IDENTICAL_FOOTNOTES" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_SHORT_CODE_START", + "name": "C_STR_FOOTNOTES_SHORT_CODE_START", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020short\u0020code\u0020of\u0020the\u0020footnote\u2019s\u0020start.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_SHORT_CODE_START" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_SHORT_CODE_END", + "name": "C_STR_FOOTNOTES_SHORT_CODE_END", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020short\u0020code\u0020of\u0020the\u0020footnote\u2019s\u0020end.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_SHORT_CODE_END" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED", + "name": "C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020user\u002Ddefined\u0020short\u0020code\u0020of\u0020the\u0020footnotes\u0020start.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED", + "name": "C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020user\u002Ddefined\u0020short\u0020code\u0020of\u0020the\u0020footnotes\u0020end.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_COUNTER_STYLE", + "name": "C_STR_FOOTNOTES_COUNTER_STYLE", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020counter\u0020style\u0020of\u0020the\u0020footnotes.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_COUNTER_STYLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_LOVE", + "name": "C_STR_FOOTNOTES_LOVE", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020\u0027I\u0020love\u0020footnotes\u0027\u0020text.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_LOVE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_IN_EXCERPT", + "name": "C_BOOL_FOOTNOTES_IN_EXCERPT", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020look\u0020for\u0020footnotes\u0020in\u0020post\u0020excerpts.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_IN_EXCERPT" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_EXPERT_MODE", + "name": "C_BOOL_FOOTNOTES_EXPERT_MODE", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020Expert\u0020mode.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_EXPERT_MODE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_STYLING_BEFORE", + "name": "C_STR_FOOTNOTES_STYLING_BEFORE", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020string\u0020before\u0020the\u0020footnote\u0020referrer.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_STYLING_BEFORE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_STYLING_AFTER", + "name": "C_STR_FOOTNOTES_STYLING_AFTER", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020string\u0020after\u0020the\u0020footnote\u0020referrer.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_STYLING_AFTER" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED", + "name": "C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020mouse\u002Dover\u0020box.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE", + "name": "C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020alternative\u0020tooltips.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED", + "name": "C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020tooltip\u0020truncation.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH", + "name": "C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020max.\u0020length\u0020of\u0020the\u0020enabled\u0020excerpt.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION", + "name": "C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020position.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X", + "name": "C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020offset\u0020\u0028x\u0029.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y", + "name": "C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020offset\u0020\u0028y\u0029.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR", + "name": "C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020color.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND", + "name": "C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020background\u0020color.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH", + "name": "C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020border\u0020width.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR", + "name": "C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020border\u0020color.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS", + "name": "C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020border\u0020radius.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH", + "name": "C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020max.\u0020width.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR", + "name": "C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020box\u002Dshadow\u0020color.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_HYPERLINK_ARROW", + "name": "C_STR_HYPERLINK_ARROW", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020backlink\u0020symbol\u0020selection.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_HYPERLINK_ARROW" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_HYPERLINK_ARROW_USER_DEFINED", + "name": "C_STR_HYPERLINK_ARROW_USER_DEFINED", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020user\u002Ddefined\u0020backlink\u0020symbol.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_HYPERLINK_ARROW_USER_DEFINED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_CUSTOM_CSS", + "name": "C_STR_CUSTOM_CSS", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020Custom\u0020CSS.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_CUSTOM_CSS" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_CUSTOM_CSS_NEW", + "name": "C_STR_CUSTOM_CSS_NEW", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020Custom\u0020CSS\u0020migrated\u0020to\u0020a\u0020dedicated\u0020tab.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_CUSTOM_CSS_NEW" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_CUSTOM_CSS_LEGACY_ENABLE", + "name": "C_BOOL_CUSTOM_CSS_LEGACY_ENABLE", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020display\u0020of\u0020legacy\u0020Custom\u0020CSS\u0020metaboxes.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_CUSTOM_CSS_LEGACY_ENABLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_EXPERT_LOOKUP_THE_TITLE", + "name": "C_BOOL_EXPERT_LOOKUP_THE_TITLE", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020\u0027the_title\u0027\u0020hook.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_EXPERT_LOOKUP_THE_TITLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_EXPERT_LOOKUP_THE_CONTENT", + "name": "C_BOOL_EXPERT_LOOKUP_THE_CONTENT", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020\u0027the_content\u0027\u0020hook.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_EXPERT_LOOKUP_THE_CONTENT" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_EXPERT_LOOKUP_THE_EXCERPT", + "name": "C_BOOL_EXPERT_LOOKUP_THE_EXCERPT", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020\u0027the_excerpt\u0027\u0020hook.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_EXPERT_LOOKUP_THE_EXCERPT" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_EXPERT_LOOKUP_WIDGET_TITLE", + "name": "C_BOOL_EXPERT_LOOKUP_WIDGET_TITLE", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020\u0027widget_title\u0027\u0020hook.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_EXPERT_LOOKUP_WIDGET_TITLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_EXPERT_LOOKUP_WIDGET_TEXT", + "name": "C_BOOL_EXPERT_LOOKUP_WIDGET_TEXT", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020\u0027widget_text\u0027\u0020hook.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_EXPERT_LOOKUP_WIDGET_TEXT" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_TOOLTIP_READON_LABEL", + "name": "C_STR_FOOTNOTES_TOOLTIP_READON_LABEL", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020label\u0020of\u0020the\u0020Read\u002Don\u0020button\u0020in\u0020truncated\u0020tooltips.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_TOOLTIP_READON_LABEL" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS", + "name": "C_BOOL_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020referrer\u0020element.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE", + "name": "C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020display\u0020of\u0020a\u0020backlink\u0020symbol.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_REFERENCE_CONTAINER_START_PAGE_ENABLE", + "name": "C_BOOL_REFERENCE_CONTAINER_START_PAGE_ENABLE", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020not\u0020display\u0020the\u0020reference\u0020container\u0020on\u0020the\u0020homepage.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_REFERENCE_CONTAINER_START_PAGE_ENABLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE", + "name": "C_BOOL_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020legacy\u0020layout\u0020of\u0020the\u0020reference\u0020container.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH", + "name": "C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020get\u0020the\u0020backlink\u0020symbol\u0020switch\u0020side.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL", + "name": "C_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020\u0027the_content\u0027\u0020hook\u0020priority\u0020level.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL", + "name": "C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020\u0027\u0027\u0020hook\u0020priority\u0020level", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL", + "name": "C_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL", + "name": "C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL", + "name": "C_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_LINK_ELEMENT_ENABLED", + "name": "C_BOOL_LINK_ELEMENT_ENABLED", + "summary": "Settings\u0020Container\u0020Keys\u0020for\u0020the\u0020link\u0020element\u0020option\nSettings\u0020Container\u0020Keys\u0020for\u0020backlink\u0020typography\u0020and\u0020layout\nSettings\u0020Container\u0020Keys\u0020for\u0020tooltip\u0020font\u0020size\nSettings\u0020Container\u0020Keys\u0020for\u0020page\u0020layout\u0020support\nSettings\u0020Container\u0020Keys\u0020for\u0020scroll\u0020offset\u0020and\u0020duration\nSettings\u0020Container\u0020Keys\u0020for\u0020tooltip\u0020display\u0020durations", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_LINK_ELEMENT_ENABLED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_BACKLINKS_SEPARATOR_ENABLED", + "name": "C_BOOL_BACKLINKS_SEPARATOR_ENABLED", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_BACKLINKS_SEPARATOR_ENABLED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_BACKLINKS_SEPARATOR_OPTION", + "name": "C_STR_BACKLINKS_SEPARATOR_OPTION", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_BACKLINKS_SEPARATOR_OPTION" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_BACKLINKS_SEPARATOR_CUSTOM", + "name": "C_STR_BACKLINKS_SEPARATOR_CUSTOM", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_BACKLINKS_SEPARATOR_CUSTOM" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_BACKLINKS_TERMINATOR_ENABLED", + "name": "C_BOOL_BACKLINKS_TERMINATOR_ENABLED", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_BACKLINKS_TERMINATOR_ENABLED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_BACKLINKS_TERMINATOR_OPTION", + "name": "C_STR_BACKLINKS_TERMINATOR_OPTION", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_BACKLINKS_TERMINATOR_OPTION" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_BACKLINKS_TERMINATOR_CUSTOM", + "name": "C_STR_BACKLINKS_TERMINATOR_CUSTOM", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_BACKLINKS_TERMINATOR_CUSTOM" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_BACKLINKS_COLUMN_WIDTH_ENABLED", + "name": "C_BOOL_BACKLINKS_COLUMN_WIDTH_ENABLED", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_BACKLINKS_COLUMN_WIDTH_ENABLED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_BACKLINKS_COLUMN_WIDTH_SCALAR", + "name": "C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_BACKLINKS_COLUMN_WIDTH_UNIT", + "name": "C_STR_BACKLINKS_COLUMN_WIDTH_UNIT", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_BACKLINKS_COLUMN_WIDTH_UNIT" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED", + "name": "C_BOOL_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR", + "name": "C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT", + "name": "C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_BACKLINKS_LINE_BREAKS_ENABLED", + "name": "C_BOOL_BACKLINKS_LINE_BREAKS_ENABLED", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_BACKLINKS_LINE_BREAKS_ENABLED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_MOUSE_OVER_BOX_FONT_SIZE_ENABLED", + "name": "C_BOOL_MOUSE_OVER_BOX_FONT_SIZE_ENABLED", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_MOUSE_OVER_BOX_FONT_SIZE_ENABLED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR", + "name": "C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT", + "name": "C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT", + "name": "C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_SCROLL_OFFSET", + "name": "C_INT_FOOTNOTES_SCROLL_OFFSET", + "summary": "Scroll\u0020offset\u0020and\u0020duration", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_SCROLL_OFFSET" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_SCROLL_DURATION", + "name": "C_INT_FOOTNOTES_SCROLL_DURATION", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_SCROLL_DURATION" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_MOUSE_OVER_BOX_FADE_IN_DELAY", + "name": "C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_MOUSE_OVER_BOX_FADE_IN_DURATION", + "name": "C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY", + "name": "C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION", + "name": "C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTE_URL_WRAP_ENABLED", + "name": "C_BOOL_FOOTNOTE_URL_WRAP_ENABLED", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020URL\u0020wrap\u0020option", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTE_URL_WRAP_ENABLED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE", + "name": "C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020reference\u0020container\u0020position\u0020shortcode", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION", + "name": "C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION", + "summary": "Settings\u0020Container\u0020Keys\u0020for\u0020alternative\u0020tooltip\u0020position\nSettings\u0020Container\u0020Keys\u0020for\u0020reference\u0020container\u0020label\u0020element,\u0020thanks\u0020to\u0020\u0040markhillyer", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X", + "name": "C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y", + "name": "C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH", + "name": "C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_REFERENCE_CONTAINER_LABEL_ELEMENT", + "name": "C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER", + "name": "C_BOOL_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE", + "name": "C_BOOL_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020table\u0020cell\u0020borders,\u0020thanks\u0020to\u0020\u0040noobishh", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_REFERENCE_CONTAINER_TOP_MARGIN", + "name": "C_INT_REFERENCE_CONTAINER_TOP_MARGIN", + "summary": "Settings\u0020container\u0020keys\u0020for\u0020reference\u0020container\u0020top\u0020and\u0020bottom\u0020margins\nSettings\u0020container\u0020keys\u0020for\u0020hard\u0020link\u0020enabling\nSettings\u0020container\u0020keys\u0020for\u0020hard\u0020link\u0020anchors\u0020in\u0020referrers\u0020and\u0020footnotes", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_REFERENCE_CONTAINER_TOP_MARGIN" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN", + "name": "C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_HARD_LINKS_ENABLE", + "name": "C_BOOL_FOOTNOTES_HARD_LINKS_ENABLE", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_HARD_LINKS_ENABLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_REFERRER_FRAGMENT_ID_SLUG", + "name": "C_STR_REFERRER_FRAGMENT_ID_SLUG", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_REFERRER_FRAGMENT_ID_SLUG" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTE_FRAGMENT_ID_SLUG", + "name": "C_STR_FOOTNOTE_FRAGMENT_ID_SLUG", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTE_FRAGMENT_ID_SLUG" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_HARD_LINK_IDS_SEPARATOR", + "name": "C_STR_HARD_LINK_IDS_SEPARATOR", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_HARD_LINK_IDS_SEPARATOR" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE", + "name": "C_BOOL_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE", + "summary": "Settings\u0020container\u0020key\u0020for\u0020shortcode\u0020syntax\u0020validation.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE", + "name": "C_BOOL_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020backlink\u0020tooltips.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT", + "name": "C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT", + "summary": "Settings\u0020container\u0020key\u0020to\u0020configure\u0020the\u0020backlink\u0020tooltip.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER", + "name": "C_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER", + "summary": "Settings\u0020container\u0020key\u0020to\u0020configure\u0020the\u0020tooltip\u0020excerpt\u0020delimiter.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE", + "name": "C_BOOL_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020mirroring\u0020the\u0020tooltip\u0020excerpt\u0020in\u0020the\u0020reference\u0020container.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR", + "name": "C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR", + "summary": "Settings\u0020container\u0020key\u0020to\u0020configure\u0020the\u0020tooltip\u0020excerpt\u0020separator\u0020in\u0020the\u0020reference\u0020container.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT", + "name": "C_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020superscript\u0020style\u0020normalization.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE", + "name": "C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE", + "summary": "Settings\u0020container\u0020key\u0020to\u0020select\u0020the\u0020script\u0020mode\u0020for\u0020the\u0020reference\u0020container.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003A\u0024a_obj_Instance", + "name": "a_obj_Instance", + "summary": "Stores\u0020a\u0020singleton\u0020reference\u0020of\u0020this\u0020class.", + "url": "classes/MCI-Footnotes-Settings.html#property_a_obj_Instance" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003A\u0024a_arr_Container", + "name": "a_arr_Container", + "summary": "Contains\u0020all\u0020Settings\u0020Container\u0020names.", + "url": "classes/MCI-Footnotes-Settings.html#property_a_arr_Container" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003A\u0024a_arr_Default", + "name": "a_arr_Default", + "summary": "Contains\u0020all\u0020Default\u0020Settings\u0020for\u0020each\u0020Settings\u0020Container.", + "url": "classes/MCI-Footnotes-Settings.html#property_a_arr_Default" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003A\u0024a_arr_Settings", + "name": "a_arr_Settings", + "summary": "Contains\u0020all\u0020Settings\u0020from\u0020each\u0020Settings\u0020container\u0020as\u0020soon\u0020as\u0020this\u0020class\u0020is\u0020initialized.", + "url": "classes/MCI-Footnotes-Settings.html#property_a_arr_Settings" + }, { + "fqsen": "\\MCI_Footnotes_Task", + "name": "MCI_Footnotes_Task", + "summary": "Searches\u0020and\u0020replaces\u0020the\u0020footnotes.", + "url": "classes/MCI-Footnotes-Task.html" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003AregisterHooks\u0028\u0029", + "name": "registerHooks", + "summary": "Register\u0020WordPress\u0020Hooks\u0020to\u0020replace\u0020Footnotes\u0020in\u0020the\u0020content\u0020of\u0020a\u0020public\u0020page.", + "url": "classes/MCI-Footnotes-Task.html#method_registerHooks" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Awp_head\u0028\u0029", + "name": "wp_head", + "summary": "Outputs\u0020the\u0020custom\u0020css\u0020to\u0020the\u0020header\u0020of\u0020the\u0020public\u0020page.", + "url": "classes/MCI-Footnotes-Task.html#method_wp_head" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Awp_footer\u0028\u0029", + "name": "wp_footer", + "summary": "Displays\u0020the\u0020\u0027LOVE\u0020FOOTNOTES\u0027\u0020slug\u0020if\u0020enabled.", + "url": "classes/MCI-Footnotes-Task.html#method_wp_footer" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Athe_title\u0028\u0029", + "name": "the_title", + "summary": "Replaces\u0020footnotes\u0020in\u0020the\u0020post\/page\u0020title.", + "url": "classes/MCI-Footnotes-Task.html#method_the_title" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Athe_content\u0028\u0029", + "name": "the_content", + "summary": "Replaces\u0020footnotes\u0020in\u0020the\u0020content\u0020of\u0020the\u0020current\u0020page\/post.", + "url": "classes/MCI-Footnotes-Task.html#method_the_content" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Athe_excerpt\u0028\u0029", + "name": "the_excerpt", + "summary": "Replaces\u0020footnotes\u0020in\u0020the\u0020excerpt\u0020of\u0020the\u0020current\u0020page\/post.", + "url": "classes/MCI-Footnotes-Task.html#method_the_excerpt" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Awidget_title\u0028\u0029", + "name": "widget_title", + "summary": "Replaces\u0020footnotes\u0020in\u0020the\u0020widget\u0020title.", + "url": "classes/MCI-Footnotes-Task.html#method_widget_title" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Awidget_text\u0028\u0029", + "name": "widget_text", + "summary": "Replaces\u0020footnotes\u0020in\u0020the\u0020content\u0020of\u0020the\u0020current\u0020widget.", + "url": "classes/MCI-Footnotes-Task.html#method_widget_text" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Athe_post\u0028\u0029", + "name": "the_post", + "summary": "Replaces\u0020footnotes\u0020in\u0020each\u0020Content\u0020var\u0020of\u0020the\u0020current\u0020Post\u0020object.", + "url": "classes/MCI-Footnotes-Task.html#method_the_post" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003AreplacePostObject\u0028\u0029", + "name": "replacePostObject", + "summary": "Replace\u0020all\u0020Footnotes\u0020in\u0020a\u0020WP_Post\u0020object.", + "url": "classes/MCI-Footnotes-Task.html#method_replacePostObject" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Aexec\u0028\u0029", + "name": "exec", + "summary": "Replaces\u0020all\u0020footnotes\u0020that\u0020occur\u0020in\u0020the\u0020given\u0020content.", + "url": "classes/MCI-Footnotes-Task.html#method_exec" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Asearch\u0028\u0029", + "name": "search", + "summary": "Replaces\u0020all\u0020footnotes\u0020in\u0020the\u0020given\u0020content\u0020and\u0020appends\u0020them\u0020to\u0020the\u0020static\u0020property.", + "url": "classes/MCI-Footnotes-Task.html#method_search" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003AReferenceContainer\u0028\u0029", + "name": "ReferenceContainer", + "summary": "Generates\u0020the\u0020reference\u0020container.", + "url": "classes/MCI-Footnotes-Task.html#method_ReferenceContainer" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_arr_Footnotes", + "name": "a_arr_Footnotes", + "summary": "Contains\u0020all\u0020footnotes\u0020found\u0020on\u0020current\u0020public\u0020page.", + "url": "classes/MCI-Footnotes-Task.html#property_a_arr_Footnotes" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_bool_AllowLoveMe", + "name": "a_bool_AllowLoveMe", + "summary": "Flag\u0020if\u0020the\u0020display\u0020of\u0020\u0027LOVE\u0020FOOTNOTES\u0027\u0020is\u0020allowed\u0020on\u0020the\u0020current\u0020public\u0020page.", + "url": "classes/MCI-Footnotes-Task.html#property_a_bool_AllowLoveMe" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_Prefix", + "name": "a_str_Prefix", + "summary": "Prefix\u0020for\u0020the\u0020Footnote\u0020html\u0020element\u0020ID.", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_Prefix" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_int_PostId", + "name": "a_int_PostId", + "summary": "Infinite\u0020scroll\u0020\/\u0020autoload\u0020or\u0020archive\u0020view", + "url": "classes/MCI-Footnotes-Task.html#property_a_int_PostId" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_int_ReferenceContainerId", + "name": "a_int_ReferenceContainerId", + "summary": "Multiple\u0020reference\u0020containers\u0020in\u0020content\u0020and\u0020widgets", + "url": "classes/MCI-Footnotes-Task.html#property_a_int_ReferenceContainerId" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_bool_TooltipsEnabled", + "name": "a_bool_TooltipsEnabled", + "summary": "Template\u0020process\u0020optimization", + "url": "classes/MCI-Footnotes-Task.html#property_a_bool_TooltipsEnabled" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_bool_AlternativeTooltipsEnabled", + "name": "a_bool_AlternativeTooltipsEnabled", + "summary": "", + "url": "classes/MCI-Footnotes-Task.html#property_a_bool_AlternativeTooltipsEnabled" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_bool_HardLinksEnable", + "name": "a_bool_HardLinksEnable", + "summary": "Hard\u0020links\u0020for\u0020AMP\u0020compatibility", + "url": "classes/MCI-Footnotes-Task.html#property_a_bool_HardLinksEnable" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_ReferrerLinkSlug", + "name": "a_str_ReferrerLinkSlug", + "summary": "", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_ReferrerLinkSlug" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_FootnoteLinkSlug", + "name": "a_str_FootnoteLinkSlug", + "summary": "", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_FootnoteLinkSlug" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_LinkIdsSeparator", + "name": "a_str_LinkIdsSeparator", + "summary": "", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_LinkIdsSeparator" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_PostContainerIdCompound", + "name": "a_str_PostContainerIdCompound", + "summary": "", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_PostContainerIdCompound" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_int_ScrollOffset", + "name": "a_int_ScrollOffset", + "summary": "Scroll\u0020offset", + "url": "classes/MCI-Footnotes-Task.html#property_a_int_ScrollOffset" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_LinkSpan", + "name": "a_str_LinkSpan", + "summary": "Optional\u0020link\u0020element\u0020for\u0020footnote\u0020referrers\u0020and\u0020backlinks", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_LinkSpan" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_LinkOpenTag", + "name": "a_str_LinkOpenTag", + "summary": "", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_LinkOpenTag" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_LinkCloseTag", + "name": "a_str_LinkCloseTag", + "summary": "", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_LinkCloseTag" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_bool_MirrorTooltipText", + "name": "a_bool_MirrorTooltipText", + "summary": "Dedicated\u0020tooltip\u0020text", + "url": "classes/MCI-Footnotes-Task.html#property_a_bool_MirrorTooltipText" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_TooltipShortcode", + "name": "a_str_TooltipShortcode", + "summary": "", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_TooltipShortcode" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_int_TooltipShortcodeLength", + "name": "a_int_TooltipShortcodeLength", + "summary": "", + "url": "classes/MCI-Footnotes-Task.html#property_a_int_TooltipShortcodeLength" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_bool_SyntaxErrorFlag", + "name": "a_bool_SyntaxErrorFlag", + "summary": "Footnote\u0020delimiter\u0020syntax\u0020validation", + "url": "classes/MCI-Footnotes-Task.html#property_a_bool_SyntaxErrorFlag" + }, { + "fqsen": "\\MCI_Footnotes_Template", + "name": "MCI_Footnotes_Template", + "summary": "Handles\u0020each\u0020Template\u0020file\u0020for\u0020the\u0020Plugin\u0020Frontend\u0020\u0028e.g.\u0020Settings\u0020Dashboard,\u0020Public\u0020pages,\u0020...\u0029.", + "url": "classes/MCI-Footnotes-Template.html" + }, { + "fqsen": "\\MCI_Footnotes_Template\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Class\u0020Constructor.\u0020Reads\u0020and\u0020loads\u0020the\u0020template\u0020file\u0020without\u0020replace\u0020any\u0020placeholder.", + "url": "classes/MCI-Footnotes-Template.html#method___construct" + }, { + "fqsen": "\\MCI_Footnotes_Template\u003A\u003Areplace\u0028\u0029", + "name": "replace", + "summary": "Replace\u0020all\u0020placeholders\u0020specified\u0020in\u0020array.", + "url": "classes/MCI-Footnotes-Template.html#method_replace" + }, { + "fqsen": "\\MCI_Footnotes_Template\u003A\u003Areload\u0028\u0029", + "name": "reload", + "summary": "Reloads\u0020the\u0020original\u0020content\u0020of\u0020the\u0020template\u0020file.", + "url": "classes/MCI-Footnotes-Template.html#method_reload" + }, { + "fqsen": "\\MCI_Footnotes_Template\u003A\u003AgetContent\u0028\u0029", + "name": "getContent", + "summary": "Returns\u0020the\u0020content\u0020of\u0020the\u0020template\u0020file\u0020with\u0020replaced\u0020placeholders.", + "url": "classes/MCI-Footnotes-Template.html#method_getContent" + }, { + "fqsen": "\\MCI_Footnotes_Template\u003A\u003Aprocess_template\u0028\u0029", + "name": "process_template", + "summary": "Process\u0020template\u0020file", + "url": "classes/MCI-Footnotes-Template.html#method_process_template" + }, { + "fqsen": "\\MCI_Footnotes_Template\u003A\u003Aget_template\u0028\u0029", + "name": "get_template", + "summary": "Get\u0020the\u0020template", + "url": "classes/MCI-Footnotes-Template.html#method_get_template" + }, { + "fqsen": "\\MCI_Footnotes_Template\u003A\u003AC_STR_DASHBOARD", + "name": "C_STR_DASHBOARD", + "summary": "Directory\u0020name\u0020for\u0020dashboard\u0020templates.", + "url": "classes/MCI-Footnotes-Template.html#constant_C_STR_DASHBOARD" + }, { + "fqsen": "\\MCI_Footnotes_Template\u003A\u003AC_STR_PUBLIC", + "name": "C_STR_PUBLIC", + "summary": "Directory\u0020name\u0020for\u0020public\u0020templates.", + "url": "classes/MCI-Footnotes-Template.html#constant_C_STR_PUBLIC" + }, { + "fqsen": "\\MCI_Footnotes_Template\u003A\u003A\u0024a_str_OriginalContent", + "name": "a_str_OriginalContent", + "summary": "Contains\u0020the\u0020content\u0020of\u0020the\u0020template\u0020after\u0020initialize.", + "url": "classes/MCI-Footnotes-Template.html#property_a_str_OriginalContent" + }, { + "fqsen": "\\MCI_Footnotes_Template\u003A\u003A\u0024a_str_ReplacedContent", + "name": "a_str_ReplacedContent", + "summary": "Contains\u0020the\u0020content\u0020of\u0020the\u0020template\u0020after\u0020initialize\u0020with\u0020replaced\u0020place\u0020holders.", + "url": "classes/MCI-Footnotes-Template.html#property_a_str_ReplacedContent" + }, { + "fqsen": "\\MCI_Footnotes_Template\u003A\u003A\u0024plugin_directory", + "name": "plugin_directory", + "summary": "Plugin\u0020Directory", + "url": "classes/MCI-Footnotes-Template.html#property_plugin_directory" + }, { + "fqsen": "\\MCI_Footnotes_WidgetBase", + "name": "MCI_Footnotes_WidgetBase", + "summary": "Base\u0020Class\u0020for\u0020all\u0020Plugin\u0020Widgets.\u0020Registers\u0020each\u0020Widget\u0020to\u0020WordPress.", + "url": "classes/MCI-Footnotes-WidgetBase.html" + }, { + "fqsen": "\\MCI_Footnotes_WidgetBase\u003A\u003AgetID\u0028\u0029", + "name": "getID", + "summary": "Returns\u0020an\u0020unique\u0020ID\u0020as\u0020string\u0020used\u0020for\u0020the\u0020Widget\u0020Base\u0020ID.", + "url": "classes/MCI-Footnotes-WidgetBase.html#method_getID" + }, { + "fqsen": "\\MCI_Footnotes_WidgetBase\u003A\u003AgetName\u0028\u0029", + "name": "getName", + "summary": "Returns\u0020the\u0020Public\u0020name\u0020of\u0020child\u0020Widget\u0020to\u0020be\u0020displayed\u0020in\u0020the\u0020Configuration\u0020page.", + "url": "classes/MCI-Footnotes-WidgetBase.html#method_getName" + }, { + "fqsen": "\\MCI_Footnotes_WidgetBase\u003A\u003AgetDescription\u0028\u0029", + "name": "getDescription", + "summary": "Returns\u0020the\u0020Description\u0020of\u0020the\u0020child\u0020widget.", + "url": "classes/MCI-Footnotes-WidgetBase.html#method_getDescription" + }, { + "fqsen": "\\MCI_Footnotes_WidgetBase\u003A\u003AgetWidgetWidth\u0028\u0029", + "name": "getWidgetWidth", + "summary": "Returns\u0020the\u0020width\u0020of\u0020the\u0020Widget.\u0020Default\u0020width\u0020is\u0020250\u0020pixel.", + "url": "classes/MCI-Footnotes-WidgetBase.html#method_getWidgetWidth" + }, { + "fqsen": "\\MCI_Footnotes_WidgetBase\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Class\u0020Constructor.\u0020Registers\u0020the\u0020child\u0020Widget\u0020to\u0020WordPress.", + "url": "classes/MCI-Footnotes-WidgetBase.html#method___construct" + }, { + "fqsen": "\\MCI_Footnotes_Widget_ReferenceContainer", + "name": "MCI_Footnotes_Widget_ReferenceContainer", + "summary": "Registers\u0020a\u0020Widget\u0020to\u0020put\u0020the\u0020Reference\u0020Container\u0020to\u0020the\u0020widget\u0020area.", + "url": "classes/MCI-Footnotes-Widget-ReferenceContainer.html" + }, { + "fqsen": "\\MCI_Footnotes_Widget_ReferenceContainer\u003A\u003AgetID\u0028\u0029", + "name": "getID", + "summary": "Returns\u0020an\u0020unique\u0020ID\u0020as\u0020string\u0020used\u0020for\u0020the\u0020Widget\u0020Base\u0020ID.", + "url": "classes/MCI-Footnotes-Widget-ReferenceContainer.html#method_getID" + }, { + "fqsen": "\\MCI_Footnotes_Widget_ReferenceContainer\u003A\u003AgetName\u0028\u0029", + "name": "getName", + "summary": "Returns\u0020the\u0020Public\u0020name\u0020of\u0020the\u0020Widget\u0020to\u0020be\u0020displayed\u0020in\u0020the\u0020Configuration\u0020page.", + "url": "classes/MCI-Footnotes-Widget-ReferenceContainer.html#method_getName" + }, { + "fqsen": "\\MCI_Footnotes_Widget_ReferenceContainer\u003A\u003AgetDescription\u0028\u0029", + "name": "getDescription", + "summary": "Returns\u0020the\u0020Description\u0020of\u0020the\u0020child\u0020widget.", + "url": "classes/MCI-Footnotes-Widget-ReferenceContainer.html#method_getDescription" + }, { + "fqsen": "\\MCI_Footnotes_Widget_ReferenceContainer\u003A\u003Aform\u0028\u0029", + "name": "form", + "summary": "Outputs\u0020the\u0020Settings\u0020of\u0020the\u0020Widget.", + "url": "classes/MCI-Footnotes-Widget-ReferenceContainer.html#method_form" + }, { + "fqsen": "\\MCI_Footnotes_Widget_ReferenceContainer\u003A\u003Awidget\u0028\u0029", + "name": "widget", + "summary": "Outputs\u0020the\u0020Content\u0020of\u0020the\u0020Widget.", + "url": "classes/MCI-Footnotes-Widget-ReferenceContainer.html#method_widget" + }, { + "fqsen": "\\MCI_Footnotes_WYSIWYG", + "name": "MCI_Footnotes_WYSIWYG", + "summary": "", + "url": "classes/MCI-Footnotes-WYSIWYG.html" + }, { + "fqsen": "\\MCI_Footnotes_WYSIWYG\u003A\u003AregisterHooks\u0028\u0029", + "name": "registerHooks", + "summary": "", + "url": "classes/MCI-Footnotes-WYSIWYG.html#method_registerHooks" + }, { + "fqsen": "\\MCI_Footnotes_WYSIWYG\u003A\u003AnewVisualEditorButton\u0028\u0029", + "name": "newVisualEditorButton", + "summary": "Append\u0020a\u0020new\u0020Button\u0020to\u0020the\u0020WYSIWYG\u0020editor\u0020of\u0020Posts\u0020and\u0020Pages.", + "url": "classes/MCI-Footnotes-WYSIWYG.html#method_newVisualEditorButton" + }, { + "fqsen": "\\MCI_Footnotes_WYSIWYG\u003A\u003AnewPlainTextEditorButton\u0028\u0029", + "name": "newPlainTextEditorButton", + "summary": "Add\u0020a\u0020new\u0020button\u0020to\u0020the\u0020plain\u0020text\u0020editor.", + "url": "classes/MCI-Footnotes-WYSIWYG.html#method_newPlainTextEditorButton" + }, { + "fqsen": "\\MCI_Footnotes_WYSIWYG\u003A\u003AincludeScripts\u0028\u0029", + "name": "includeScripts", + "summary": "Includes\u0020the\u0020Plugins\u0020WYSIWYG\u0020editor\u0020script.", + "url": "classes/MCI-Footnotes-WYSIWYG.html#method_includeScripts" + }, { + "fqsen": "\\MCI_Footnotes_WYSIWYG\u003A\u003AajaxCallback\u0028\u0029", + "name": "ajaxCallback", + "summary": "AJAX\u0020Callback\u0020function\u0020when\u0020the\u0020Footnotes\u0020Button\u0020is\u0020clicked.\u0020Either\u0020in\u0020the\u0020Plain\u0020text\u0020or\u0020Visual\u0020editor.", + "url": "classes/MCI-Footnotes-WYSIWYG.html#method_ajaxCallback" + }, { + "fqsen": "\\MCI_Footnotes_requirePhpFiles\u0028\u0029", + "name": "MCI_Footnotes_requirePhpFiles", + "summary": "Requires\u0020\u0028require_once\u0029\u0020all\u0020\u002A.php\u0020files\u0020inside\u0020a\u0020specific\u0020Directory.", + "url": "namespaces/default.html#function_MCI_Footnotes_requirePhpFiles" + }, { + "fqsen": "\\", + "name": "\\", + "summary": "", + "url": "namespaces/default.html" + } ] +); diff --git a/docs/namespaces/default.html b/docs/namespaces/default.html new file mode 100644 index 0000000..c9f9b75 --- /dev/null +++ b/docs/namespaces/default.html @@ -0,0 +1,227 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                                        +

                                                                        Documentation

                                                                        + + +
                                                                        + +
                                                                        + + +
                                                                        + +
                                                                        +
                                                                        + + + + +
                                                                        +
                                                                          +
                                                                        + +
                                                                        +

                                                                        API Documentation

                                                                        + + + +

                                                                        + Interfaces, Classes and Traits + +

                                                                        + +
                                                                        + +
                                                                        MCI_Footnotes_Config
                                                                        +
                                                                        Contains all Plugin Constants. Contains no Method or Property.
                                                                        +
                                                                        MCI_Footnotes_Convert
                                                                        +
                                                                        Converts data types and Footnotes specific values.
                                                                        +
                                                                        MCI_Footnotes_Layout_Init
                                                                        +
                                                                        Handles the Settings interface of the Plugin.
                                                                        +
                                                                        MCI_Footnotes_LayoutEngine
                                                                        +
                                                                        Layout Engine for the administration dashboard.
                                                                        +
                                                                        MCI_Footnotes_Layout_Diagnostics
                                                                        +
                                                                        Displays Diagnostics of the web server, PHP and WordPress.
                                                                        +
                                                                        MCI_Footnotes_Layout_Settings
                                                                        +
                                                                        Displays and handles all Settings of the Plugin.
                                                                        +
                                                                        MCI_Footnotes_Hooks
                                                                        +
                                                                        Registers all WordPress Hooks and executes them on demand.
                                                                        +
                                                                        MCI_Footnotes
                                                                        +
                                                                        Entry point of the Plugin. Loads the Dashboard and executes the Task.
                                                                        +
                                                                        MCI_Footnotes_Language
                                                                        +
                                                                        Loads text domain of current or default language for localization.
                                                                        +
                                                                        MCI_Footnotes_Settings
                                                                        +
                                                                        Loads the settings values, sets to default values if undefined.
                                                                        +
                                                                        MCI_Footnotes_Task
                                                                        +
                                                                        Searches and replaces the footnotes.
                                                                        +
                                                                        MCI_Footnotes_Template
                                                                        +
                                                                        Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).
                                                                        +
                                                                        MCI_Footnotes_WidgetBase
                                                                        +
                                                                        Base Class for all Plugin Widgets. Registers each Widget to WordPress.
                                                                        +
                                                                        MCI_Footnotes_Widget_ReferenceContainer
                                                                        +
                                                                        Registers a Widget to put the Reference Container to the widget area.
                                                                        +
                                                                        MCI_Footnotes_WYSIWYG
                                                                        +
                                                                        + +
                                                                        + + +

                                                                        + Table of Contents + +

                                                                        + +
                                                                        +
                                                                        + MCI_Footnotes_requirePhpFiles() + +  : mixed +
                                                                        +
                                                                        Requires (require_once) all *.php files inside a specific Directory.
                                                                        + +
                                                                        + + + +
                                                                        +

                                                                        + Functions + +

                                                                        +
                                                                        +

                                                                        + MCI_Footnotes_requirePhpFiles() + +

                                                                        + + +

                                                                        Requires (require_once) all *.php files inside a specific Directory.

                                                                        + + + + MCI_Footnotes_requirePhpFiles(string $p_str_Directory) : mixed + +
                                                                        + +
                                                                        Parameters
                                                                        +
                                                                        +
                                                                        + $p_str_Directory + : string +
                                                                        +
                                                                        +

                                                                        Absolute Directory path to lookup for *.php files

                                                                        +
                                                                        + +
                                                                        +
                                                                        + + +
                                                                        + Tags + +
                                                                        +
                                                                        +
                                                                        + author +
                                                                        +
                                                                        + +

                                                                        Stefan Herndler

                                                                        +
                                                                        + +
                                                                        +
                                                                        + since +
                                                                        +
                                                                        + 1.5.0 + +
                                                                        + +
                                                                        +
                                                                        + + +
                                                                        +
                                                                        + +
                                                                        +
                                                                        +
                                                                        +
                                                                        +

                                                                        Search results

                                                                        + +
                                                                        +
                                                                        +
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          + + +
                                                                          + + + + diff --git a/docs/packages/Default.html b/docs/packages/Default.html new file mode 100644 index 0000000..d4680ea --- /dev/null +++ b/docs/packages/Default.html @@ -0,0 +1,227 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                                          +

                                                                          Documentation

                                                                          + + +
                                                                          + +
                                                                          + + +
                                                                          + +
                                                                          +
                                                                          + + + + +
                                                                          +
                                                                            +
                                                                          + +
                                                                          +

                                                                          Default

                                                                          + + + +

                                                                          + Interfaces, Classes and Traits + +

                                                                          + +
                                                                          + +
                                                                          MCI_Footnotes_Config
                                                                          +
                                                                          Contains all Plugin Constants. Contains no Method or Property.
                                                                          +
                                                                          MCI_Footnotes_Convert
                                                                          +
                                                                          Converts data types and Footnotes specific values.
                                                                          +
                                                                          MCI_Footnotes_Layout_Init
                                                                          +
                                                                          Handles the Settings interface of the Plugin.
                                                                          +
                                                                          MCI_Footnotes_LayoutEngine
                                                                          +
                                                                          Layout Engine for the administration dashboard.
                                                                          +
                                                                          MCI_Footnotes_Layout_Diagnostics
                                                                          +
                                                                          Displays Diagnostics of the web server, PHP and WordPress.
                                                                          +
                                                                          MCI_Footnotes_Layout_Settings
                                                                          +
                                                                          Displays and handles all Settings of the Plugin.
                                                                          +
                                                                          MCI_Footnotes_Hooks
                                                                          +
                                                                          Registers all WordPress Hooks and executes them on demand.
                                                                          +
                                                                          MCI_Footnotes
                                                                          +
                                                                          Entry point of the Plugin. Loads the Dashboard and executes the Task.
                                                                          +
                                                                          MCI_Footnotes_Language
                                                                          +
                                                                          Loads text domain of current or default language for localization.
                                                                          +
                                                                          MCI_Footnotes_Settings
                                                                          +
                                                                          Loads the settings values, sets to default values if undefined.
                                                                          +
                                                                          MCI_Footnotes_Task
                                                                          +
                                                                          Searches and replaces the footnotes.
                                                                          +
                                                                          MCI_Footnotes_Template
                                                                          +
                                                                          Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).
                                                                          +
                                                                          MCI_Footnotes_WidgetBase
                                                                          +
                                                                          Base Class for all Plugin Widgets. Registers each Widget to WordPress.
                                                                          +
                                                                          MCI_Footnotes_Widget_ReferenceContainer
                                                                          +
                                                                          Registers a Widget to put the Reference Container to the widget area.
                                                                          +
                                                                          MCI_Footnotes_WYSIWYG
                                                                          +
                                                                          + +
                                                                          + + +

                                                                          + Table of Contents + +

                                                                          + +
                                                                          +
                                                                          + MCI_Footnotes_requirePhpFiles() + +  : mixed +
                                                                          +
                                                                          Requires (require_once) all *.php files inside a specific Directory.
                                                                          + +
                                                                          + + + +
                                                                          +

                                                                          + Functions + +

                                                                          +
                                                                          +

                                                                          + MCI_Footnotes_requirePhpFiles() + +

                                                                          + + +

                                                                          Requires (require_once) all *.php files inside a specific Directory.

                                                                          + + + + MCI_Footnotes_requirePhpFiles(string $p_str_Directory) : mixed + +
                                                                          + +
                                                                          Parameters
                                                                          +
                                                                          +
                                                                          + $p_str_Directory + : string +
                                                                          +
                                                                          +

                                                                          Absolute Directory path to lookup for *.php files

                                                                          +
                                                                          + +
                                                                          +
                                                                          + + +
                                                                          + Tags + +
                                                                          +
                                                                          +
                                                                          + author +
                                                                          +
                                                                          + +

                                                                          Stefan Herndler

                                                                          +
                                                                          + +
                                                                          +
                                                                          + since +
                                                                          +
                                                                          + 1.5.0 + +
                                                                          + +
                                                                          +
                                                                          + + +
                                                                          +
                                                                          + +
                                                                          +
                                                                          +
                                                                          +
                                                                          +

                                                                          Search results

                                                                          + +
                                                                          +
                                                                          +
                                                                            +
                                                                            +
                                                                            +
                                                                            +
                                                                            +
                                                                            + + +
                                                                            + + + + diff --git a/docs/packages/default.html b/docs/packages/default.html new file mode 100644 index 0000000..3d3e60c --- /dev/null +++ b/docs/packages/default.html @@ -0,0 +1,116 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                                            +

                                                                            Documentation

                                                                            + + +
                                                                            + +
                                                                            + + +
                                                                            + +
                                                                            +
                                                                            + + + + +
                                                                            +
                                                                              +
                                                                            + +
                                                                            +

                                                                            API Documentation

                                                                            + +

                                                                            + Packages + +

                                                                            + +
                                                                            +
                                                                            Default
                                                                            +
                                                                            + + + + + + + + +
                                                                            +
                                                                            +
                                                                            +
                                                                            +

                                                                            Search results

                                                                            + +
                                                                            +
                                                                            +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              + + +
                                                                              + + + + diff --git a/docs/reports/deprecated.html b/docs/reports/deprecated.html new file mode 100644 index 0000000..31e5420 --- /dev/null +++ b/docs/reports/deprecated.html @@ -0,0 +1,106 @@ + + + + + Documentation » Deprecated elements + + + + + + + + + + + + + + + + +
                                                                              +

                                                                              Documentation

                                                                              + + +
                                                                              + +
                                                                              + + +
                                                                              + +
                                                                              +
                                                                              + + + + +
                                                                              + + +
                                                                              +

                                                                              Deprecated

                                                                              + + +
                                                                              + No deprecated elements have been found in this project. +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              +

                                                                              Search results

                                                                              + +
                                                                              +
                                                                              +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                + + +
                                                                                + + + + diff --git a/docs/reports/errors.html b/docs/reports/errors.html new file mode 100644 index 0000000..340516e --- /dev/null +++ b/docs/reports/errors.html @@ -0,0 +1,174 @@ + + + + + Documentation » Compilation errors + + + + + + + + + + + + + + + + +
                                                                                +

                                                                                Documentation

                                                                                + + +
                                                                                + +
                                                                                + + +
                                                                                + +
                                                                                +
                                                                                + + + + +
                                                                                + + +
                                                                                +

                                                                                Errors

                                                                                + +

                                                                                Table of Contents

                                                                                + + + + + + + + + + + + + +
                                                                                class/dashboard/subpage-main.php1
                                                                                class/language.php1
                                                                                class/settings.php1
                                                                                + + + +

                                                                                subpage-main.php

                                                                                + + + + + + + + + + + + + + + +
                                                                                TypeLineDescription
                                                                                ERROR0Tag "see" with body "@see templates/dashboard/customize-css.html + 2020-12-09T1113+0100" has error "\templates/dashboard/customize-css.html" is not a valid Fqsen.
                                                                                + +

                                                                                language.php

                                                                                + + + + + + + + + + + + + + + +
                                                                                TypeLineDescription
                                                                                ERROR0Tag "see" with body "@see wp-includes/l10n.php:857" has error "\wp-includes/l10n.php:857" is not a valid Fqsen.
                                                                                + +

                                                                                settings.php

                                                                                + + + + + + + + + + + + + + + +
                                                                                TypeLineDescription
                                                                                ERROR0Tag "since" with body "@since ditched trimming whitespace from text box content in response to user request." has error
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                +

                                                                                Search results

                                                                                + +
                                                                                +
                                                                                +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  + + +
                                                                                  + + + + diff --git a/docs/reports/markers.html b/docs/reports/markers.html new file mode 100644 index 0000000..67e0a4e --- /dev/null +++ b/docs/reports/markers.html @@ -0,0 +1,128 @@ + + + + + Documentation » Markers + + + + + + + + + + + + + + + + +
                                                                                  +

                                                                                  Documentation

                                                                                  + + +
                                                                                  + +
                                                                                  + + +
                                                                                  + +
                                                                                  +
                                                                                  + + + + +
                                                                                  + + +
                                                                                  +

                                                                                  Markers

                                                                                  + +

                                                                                  Table of Contents

                                                                                  + + + + + +
                                                                                  class/settings.php1
                                                                                  + + +

                                                                                  settings.php

                                                                                  + + + + + + + + + + + + + + + +
                                                                                  TypeLineDescription
                                                                                  TODO89Eventually change misleading variable names C_BOOL_… to C_STR_… (that’s how Hungarian screws things up).
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +

                                                                                  Search results

                                                                                  + +
                                                                                  +
                                                                                  +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    + + +
                                                                                    + + + + From 92de67fc8f9fafa4cba0ec071cb1f61deec1e908 Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Sat, 20 Feb 2021 19:56:10 +0000 Subject: [PATCH 07/42] Add .phpdoc/ to gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7fdc234 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.phpdoc/ From 0f4bbeb55a4ba8d0bc6f25275de00033d4dbf883 Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Sun, 21 Feb 2021 07:52:09 +0000 Subject: [PATCH 08/42] Create LICENSE --- LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 674 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. From 63a388ba290943fd98322d85151f662fe24dd07c Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Tue, 23 Feb 2021 16:45:57 +0000 Subject: [PATCH 09/42] Rename dashboard files --- class/dashboard/{layout.php => abstract-engine.php} | 0 class/dashboard/{subpage-diagnostics.php => diagnostics.php} | 0 class/dashboard/{subpage-main.php => settings.php} | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename class/dashboard/{layout.php => abstract-engine.php} (100%) rename class/dashboard/{subpage-diagnostics.php => diagnostics.php} (100%) rename class/dashboard/{subpage-main.php => settings.php} (100%) diff --git a/class/dashboard/layout.php b/class/dashboard/abstract-engine.php similarity index 100% rename from class/dashboard/layout.php rename to class/dashboard/abstract-engine.php diff --git a/class/dashboard/subpage-diagnostics.php b/class/dashboard/diagnostics.php similarity index 100% rename from class/dashboard/subpage-diagnostics.php rename to class/dashboard/diagnostics.php diff --git a/class/dashboard/subpage-main.php b/class/dashboard/settings.php similarity index 100% rename from class/dashboard/subpage-main.php rename to class/dashboard/settings.php From 98d1255f571ef214730c6764b264662212dee58a Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Tue, 23 Feb 2021 16:47:39 +0000 Subject: [PATCH 10/42] Add temp file --- class/layout/foo | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 class/layout/foo diff --git a/class/layout/foo b/class/layout/foo new file mode 100644 index 0000000..e69de29 From 3a547af222daaa1f907e905873f898dabc8d51d5 Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Tue, 23 Feb 2021 16:48:21 +0000 Subject: [PATCH 11/42] Rename `dashboard/` to `layout/`. --- class/{dashboard => layout}/abstract-engine.php | 0 class/{dashboard => layout}/diagnostics.php | 0 class/layout/foo | 0 class/{dashboard => layout}/init.php | 0 class/{dashboard => layout}/settings.php | 0 5 files changed, 0 insertions(+), 0 deletions(-) rename class/{dashboard => layout}/abstract-engine.php (100%) rename class/{dashboard => layout}/diagnostics.php (100%) delete mode 100644 class/layout/foo rename class/{dashboard => layout}/init.php (100%) rename class/{dashboard => layout}/settings.php (100%) diff --git a/class/dashboard/abstract-engine.php b/class/layout/abstract-engine.php similarity index 100% rename from class/dashboard/abstract-engine.php rename to class/layout/abstract-engine.php diff --git a/class/dashboard/diagnostics.php b/class/layout/diagnostics.php similarity index 100% rename from class/dashboard/diagnostics.php rename to class/layout/diagnostics.php diff --git a/class/layout/foo b/class/layout/foo deleted file mode 100644 index e69de29..0000000 diff --git a/class/dashboard/init.php b/class/layout/init.php similarity index 100% rename from class/dashboard/init.php rename to class/layout/init.php diff --git a/class/dashboard/settings.php b/class/layout/settings.php similarity index 100% rename from class/dashboard/settings.php rename to class/layout/settings.php From 7a3a4127d16a3f1b783b5300f10caddf58a94ab8 Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Tue, 23 Feb 2021 17:16:15 +0000 Subject: [PATCH 12/42] Commit composer lockfile --- composer.lock | 196 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 196 insertions(+) create mode 100644 composer.lock diff --git a/composer.lock b/composer.lock new file mode 100644 index 0000000..9e0ee7c --- /dev/null +++ b/composer.lock @@ -0,0 +1,196 @@ +{ + "_readme": [ + "This file locks the dependencies of your project to a known state", + "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", + "This file is @generated automatically" + ], + "content-hash": "3a147d50695956de52f7cbf827b47830", + "packages": [], + "packages-dev": [ + { + "name": "dealerdirect/phpcodesniffer-composer-installer", + "version": "v0.7.1", + "source": { + "type": "git", + "url": "https://github.com/Dealerdirect/phpcodesniffer-composer-installer.git", + "reference": "fe390591e0241955f22eb9ba327d137e501c771c" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/Dealerdirect/phpcodesniffer-composer-installer/zipball/fe390591e0241955f22eb9ba327d137e501c771c", + "reference": "fe390591e0241955f22eb9ba327d137e501c771c", + "shasum": "" + }, + "require": { + "composer-plugin-api": "^1.0 || ^2.0", + "php": ">=5.3", + "squizlabs/php_codesniffer": "^2.0 || ^3.0 || ^4.0" + }, + "require-dev": { + "composer/composer": "*", + "phpcompatibility/php-compatibility": "^9.0", + "sensiolabs/security-checker": "^4.1.0" + }, + "type": "composer-plugin", + "extra": { + "class": "Dealerdirect\\Composer\\Plugin\\Installers\\PHPCodeSniffer\\Plugin" + }, + "autoload": { + "psr-4": { + "Dealerdirect\\Composer\\Plugin\\Installers\\PHPCodeSniffer\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Franck Nijhof", + "email": "franck.nijhof@dealerdirect.com", + "homepage": "http://www.frenck.nl", + "role": "Developer / IT Manager" + } + ], + "description": "PHP_CodeSniffer Standards Composer Installer Plugin", + "homepage": "http://www.dealerdirect.com", + "keywords": [ + "PHPCodeSniffer", + "PHP_CodeSniffer", + "code quality", + "codesniffer", + "composer", + "installer", + "phpcs", + "plugin", + "qa", + "quality", + "standard", + "standards", + "style guide", + "stylecheck", + "tests" + ], + "support": { + "issues": "https://github.com/dealerdirect/phpcodesniffer-composer-installer/issues", + "source": "https://github.com/dealerdirect/phpcodesniffer-composer-installer" + }, + "time": "2020-12-07T18:04:37+00:00" + }, + { + "name": "squizlabs/php_codesniffer", + "version": "3.5.8", + "source": { + "type": "git", + "url": "https://github.com/squizlabs/PHP_CodeSniffer.git", + "reference": "9d583721a7157ee997f235f327de038e7ea6dac4" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/squizlabs/PHP_CodeSniffer/zipball/9d583721a7157ee997f235f327de038e7ea6dac4", + "reference": "9d583721a7157ee997f235f327de038e7ea6dac4", + "shasum": "" + }, + "require": { + "ext-simplexml": "*", + "ext-tokenizer": "*", + "ext-xmlwriter": "*", + "php": ">=5.4.0" + }, + "require-dev": { + "phpunit/phpunit": "^4.0 || ^5.0 || ^6.0 || ^7.0" + }, + "bin": [ + "bin/phpcs", + "bin/phpcbf" + ], + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "3.x-dev" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Greg Sherwood", + "role": "lead" + } + ], + "description": "PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.", + "homepage": "https://github.com/squizlabs/PHP_CodeSniffer", + "keywords": [ + "phpcs", + "standards" + ], + "support": { + "issues": "https://github.com/squizlabs/PHP_CodeSniffer/issues", + "source": "https://github.com/squizlabs/PHP_CodeSniffer", + "wiki": "https://github.com/squizlabs/PHP_CodeSniffer/wiki" + }, + "time": "2020-10-23T02:01:07+00:00" + }, + { + "name": "wp-coding-standards/wpcs", + "version": "2.3.0", + "source": { + "type": "git", + "url": "https://github.com/WordPress/WordPress-Coding-Standards.git", + "reference": "7da1894633f168fe244afc6de00d141f27517b62" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/WordPress/WordPress-Coding-Standards/zipball/7da1894633f168fe244afc6de00d141f27517b62", + "reference": "7da1894633f168fe244afc6de00d141f27517b62", + "shasum": "" + }, + "require": { + "php": ">=5.4", + "squizlabs/php_codesniffer": "^3.3.1" + }, + "require-dev": { + "dealerdirect/phpcodesniffer-composer-installer": "^0.5 || ^0.6", + "phpcompatibility/php-compatibility": "^9.0", + "phpcsstandards/phpcsdevtools": "^1.0", + "phpunit/phpunit": "^4.0 || ^5.0 || ^6.0 || ^7.0" + }, + "suggest": { + "dealerdirect/phpcodesniffer-composer-installer": "^0.6 || This Composer plugin will sort out the PHPCS 'installed_paths' automatically." + }, + "type": "phpcodesniffer-standard", + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Contributors", + "homepage": "https://github.com/WordPress/WordPress-Coding-Standards/graphs/contributors" + } + ], + "description": "PHP_CodeSniffer rules (sniffs) to enforce WordPress coding conventions", + "keywords": [ + "phpcs", + "standards", + "wordpress" + ], + "support": { + "issues": "https://github.com/WordPress/WordPress-Coding-Standards/issues", + "source": "https://github.com/WordPress/WordPress-Coding-Standards", + "wiki": "https://github.com/WordPress/WordPress-Coding-Standards/wiki" + }, + "time": "2020-05-13T23:57:56+00:00" + } + ], + "aliases": [], + "minimum-stability": "stable", + "stability-flags": [], + "prefer-stable": false, + "prefer-lowest": false, + "platform": [], + "platform-dev": [], + "plugin-api-version": "2.0.0" +} From 024871873306fd18aec7a8555820bb64e896f646 Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Sat, 20 Feb 2021 20:55:46 +0000 Subject: [PATCH 13/42] Add getting started instructions to README --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index f6a4ac9..a6ce5b3 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,21 @@ Unit tests are TODO. 1. Install [phpDocumentor](https://phpdoc.org/) 1. Run it (`phpDocumentor -d . -t docs`) +## Getting Started + +1. Read the contributing guidelines +1. Clone this repository (`git clone git@github.com:Rumperuu/footnotes.git`) +1. Install [Composer](https://getcomposer.org/download/), if you don't have it already +1. Install dependencies (`composer install`) +1. Create a new branch from `main` (`git checkout -b `) +1. When you're finished, commit your changes to the remote version of your branch + and submit a [pull request](https://github.com/Rumperuu/footnotes/pulls). + +## Updating Documentation + +1. Install [phpDocumentor](https://phpdoc.org/) +1. Run it (`phpDocumentor -d . -t docs`) + ## Main Features - Fully customizable **footnotes** start and end shortcodes; From d9b7442f012de189852668eb19cfa333bea4e7f2 Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Sat, 27 Feb 2021 08:14:09 +0000 Subject: [PATCH 14/42] Add authorsfile to gitignore --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.gitignore b/.gitignore index 7fdc234..bff37e1 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,3 @@ .phpdoc/ + +authors.txt From 1d42d12c238cb4b1dc8fd1e6389ab8af862ff765 Mon Sep 17 00:00:00 2001 From: Mark Cheret Date: Sun, 4 Apr 2021 22:18:48 +0200 Subject: [PATCH 15/42] Create symfonycorp.yml --- .github/workflows/symfonycorp.yml | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 .github/workflows/symfonycorp.yml diff --git a/.github/workflows/symfonycorp.yml b/.github/workflows/symfonycorp.yml new file mode 100644 index 0000000..cd08568 --- /dev/null +++ b/.github/workflows/symfonycorp.yml @@ -0,0 +1,2 @@ +- name: The PHP Security Checker + uses: symfonycorp/security-checker-action@v2 From f6b79665640a561ebd709d33362d8b5feff561ea Mon Sep 17 00:00:00 2001 From: Mark Cheret Date: Sun, 4 Apr 2021 22:12:18 +0200 Subject: [PATCH 16/42] Create ossar-analysis.yml --- .github/workflows/ossar-analysis.yml | 44 ++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 .github/workflows/ossar-analysis.yml diff --git a/.github/workflows/ossar-analysis.yml b/.github/workflows/ossar-analysis.yml new file mode 100644 index 0000000..f89b0d6 --- /dev/null +++ b/.github/workflows/ossar-analysis.yml @@ -0,0 +1,44 @@ +# This workflow integrates a collection of open source static analysis tools +# with GitHub code scanning. For documentation, or to provide feedback, visit +# https://github.com/github/ossar-action +name: OSSAR + +on: + push: + branches: [ main ] + pull_request: + # The branches below must be a subset of the branches above + branches: [ main ] + schedule: + - cron: '39 23 * * 4' + +jobs: + OSSAR-Scan: + # OSSAR runs on windows-latest. + # ubuntu-latest and macos-latest support coming soon + runs-on: windows-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + # Ensure a compatible version of dotnet is installed. + # The [Microsoft Security Code Analysis CLI](https://aka.ms/mscadocs) is built with dotnet v3.1.201. + # A version greater than or equal to v3.1.201 of dotnet must be installed on the agent in order to run this action. + # GitHub hosted runners already have a compatible version of dotnet installed and this step may be skipped. + # For self-hosted runners, ensure dotnet version 3.1.201 or later is installed by including this action: + # - name: Install .NET + # uses: actions/setup-dotnet@v1 + # with: + # dotnet-version: '3.1.x' + + # Run open source static analysis tools + - name: Run OSSAR + uses: github/ossar-action@v1 + id: ossar + + # Upload results to the Security tab + - name: Upload OSSAR results + uses: github/codeql-action/upload-sarif@v1 + with: + sarif_file: ${{ steps.ossar.outputs.sarifFile }} From 3bc252bdd8ceb0ac08a1e182c90ed3d0b39a2c63 Mon Sep 17 00:00:00 2001 From: Mark Cheret Date: Sun, 4 Apr 2021 22:21:02 +0200 Subject: [PATCH 17/42] Update symfonycorp.yml --- .github/workflows/symfonycorp.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/symfonycorp.yml b/.github/workflows/symfonycorp.yml index cd08568..8e8b6af 100644 --- a/.github/workflows/symfonycorp.yml +++ b/.github/workflows/symfonycorp.yml @@ -1,2 +1,2 @@ -- name: The PHP Security Checker - uses: symfonycorp/security-checker-action@v2 +name: The PHP Security Checker +uses: symfonycorp/security-checker-action@v2 From f3793c58f6c947c0142fcf1ba243aef76f5e2415 Mon Sep 17 00:00:00 2001 From: Mark Cheret Date: Sun, 4 Apr 2021 22:21:48 +0200 Subject: [PATCH 18/42] Update symfonycorp.yml --- .github/workflows/symfonycorp.yml | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/.github/workflows/symfonycorp.yml b/.github/workflows/symfonycorp.yml index 8e8b6af..bd0a0a7 100644 --- a/.github/workflows/symfonycorp.yml +++ b/.github/workflows/symfonycorp.yml @@ -1,2 +1,25 @@ -name: The PHP Security Checker -uses: symfonycorp/security-checker-action@v2 +name: 'The PHP Security Checker' +description: 'Checks composer.json for known vulnerabilities in your package dependencies' +branding: + icon: 'umbrella' + color: 'gray-dark' +inputs: + lock: + description: 'The path to composer.lock is stored (root directory by default)' + required: false + default: './composer.lock' + disable-exit-code: + description: 'Whether to fail when issues are detected (false by default)' + required: false + default: 0 +outputs: + vulns: + description: 'The detected vulnerabilities as JSON' +runs: + using: 'docker' + image: 'docker://symfonycorp/cli:latest' + args: + - check:security + - "--dir" + - ${{ inputs.lock }} + - "--disable-exit-code=${{ inputs.disable-exit-code }}" From af9d814426a03ee5305535255e6074079a2e3907 Mon Sep 17 00:00:00 2001 From: Mark Cheret Date: Sun, 4 Apr 2021 22:23:35 +0200 Subject: [PATCH 19/42] Delete symfonycorp.yml --- .github/workflows/symfonycorp.yml | 25 ------------------------- 1 file changed, 25 deletions(-) delete mode 100644 .github/workflows/symfonycorp.yml diff --git a/.github/workflows/symfonycorp.yml b/.github/workflows/symfonycorp.yml deleted file mode 100644 index bd0a0a7..0000000 --- a/.github/workflows/symfonycorp.yml +++ /dev/null @@ -1,25 +0,0 @@ -name: 'The PHP Security Checker' -description: 'Checks composer.json for known vulnerabilities in your package dependencies' -branding: - icon: 'umbrella' - color: 'gray-dark' -inputs: - lock: - description: 'The path to composer.lock is stored (root directory by default)' - required: false - default: './composer.lock' - disable-exit-code: - description: 'Whether to fail when issues are detected (false by default)' - required: false - default: 0 -outputs: - vulns: - description: 'The detected vulnerabilities as JSON' -runs: - using: 'docker' - image: 'docker://symfonycorp/cli:latest' - args: - - check:security - - "--dir" - - ${{ inputs.lock }} - - "--disable-exit-code=${{ inputs.disable-exit-code }}" From 5a99056d21b3cac02e113f6e72e6f2659caaf990 Mon Sep 17 00:00:00 2001 From: Mark Cheret Date: Sun, 4 Apr 2021 22:29:01 +0200 Subject: [PATCH 20/42] Create php.yml --- .github/workflows/php.yml | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 .github/workflows/php.yml diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml new file mode 100644 index 0000000..6dcf060 --- /dev/null +++ b/.github/workflows/php.yml @@ -0,0 +1,36 @@ +name: PHP Composer + +on: + push: + branches: [ main ] + pull_request: + branches: [ main ] + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Validate composer.json and composer.lock + run: composer validate --strict + + - name: Cache Composer packages + id: composer-cache + uses: actions/cache@v2 + with: + path: vendor + key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }} + restore-keys: | + ${{ runner.os }}-php- + + - name: Install dependencies + run: composer install --prefer-dist --no-progress + + # Add a test script to composer.json, for instance: "test": "vendor/bin/phpunit" + # Docs: https://getcomposer.org/doc/articles/scripts.md + + # - name: Run test suite + # run: composer run-script test From dadce06df00fba6eed253e06c312b74daffe112b Mon Sep 17 00:00:00 2001 From: Mark Cheret Date: Sun, 4 Apr 2021 22:05:58 +0200 Subject: [PATCH 21/42] Create dependabot.yml --- .github/dependabot.yml | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 .github/dependabot.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..a51bb0b --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,11 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for all configuration options: +# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: + - package-ecosystem: "composer" # See documentation for possible values + directory: "/" # Location of package manifests + schedule: + interval: "daily" From 5f687a5f44ca13cbc3d63276594fac000fdc82dd Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Sat, 20 Feb 2021 20:55:46 +0000 Subject: [PATCH 22/42] Add getting started instructions to README --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index a6ce5b3..76f808e 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,21 @@ Unit tests are TODO. 1. Install [phpDocumentor](https://phpdoc.org/) 1. Run it (`phpDocumentor -d . -t docs`) +## Getting Started + +1. Read the contributing guidelines +1. Clone this repository (`git clone git@github.com:Rumperuu/footnotes.git`) +1. Install [Composer](https://getcomposer.org/download/), if you don't have it already +1. Install dependencies (`composer install`) +1. Create a new branch from `main` (`git checkout -b `) +1. When you're finished, commit your changes to the remote version of your branch + and submit a [pull request](https://github.com/Rumperuu/footnotes/pulls). + +## Updating Documentation + +1. Install [phpDocumentor](https://phpdoc.org/) +1. Run it (`phpDocumentor -d . -t docs`) + ## Main Features - Fully customizable **footnotes** start and end shortcodes; From ebb76dd1de4da086dee248031c1dea5edd68bb30 Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Tue, 23 Feb 2021 16:47:39 +0000 Subject: [PATCH 23/42] Add temp file --- class/layout/foo | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 class/layout/foo diff --git a/class/layout/foo b/class/layout/foo new file mode 100644 index 0000000..e69de29 From 2bdb18bb0133f0ad2c4b9a892ead5b9362c63fe2 Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Sat, 20 Feb 2021 20:55:46 +0000 Subject: [PATCH 24/42] Add getting started instructions to README --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 76f808e..3110070 100644 --- a/README.md +++ b/README.md @@ -96,6 +96,21 @@ Unit tests are TODO. 1. Install [phpDocumentor](https://phpdoc.org/) 1. Run it (`phpDocumentor -d . -t docs`) +## Getting Started + +1. Read the contributing guidelines +1. Clone this repository (`git clone git@github.com:Rumperuu/footnotes.git`) +1. Install [Composer](https://getcomposer.org/download/), if you don't have it already +1. Install dependencies (`composer install`) +1. Create a new branch from `main` (`git checkout -b `) +1. When you're finished, commit your changes to the remote version of your branch + and submit a [pull request](https://github.com/Rumperuu/footnotes/pulls). + +## Updating Documentation + +1. Install [phpDocumentor](https://phpdoc.org/) +1. Run it (`phpDocumentor -d . -t docs`) + ## Main Features - Fully customizable **footnotes** start and end shortcodes; From 69f5513df8b85b1cddf5a51f67416596584ae336 Mon Sep 17 00:00:00 2001 From: Mark Cheret Date: Sun, 4 Apr 2021 22:18:48 +0200 Subject: [PATCH 25/42] Create symfonycorp.yml --- .github/workflows/symfonycorp.yml | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 .github/workflows/symfonycorp.yml diff --git a/.github/workflows/symfonycorp.yml b/.github/workflows/symfonycorp.yml new file mode 100644 index 0000000..cd08568 --- /dev/null +++ b/.github/workflows/symfonycorp.yml @@ -0,0 +1,2 @@ +- name: The PHP Security Checker + uses: symfonycorp/security-checker-action@v2 From 43d61e08c966661ab20c5cf7ebf80b13d2ea5b36 Mon Sep 17 00:00:00 2001 From: Mark Cheret Date: Sun, 4 Apr 2021 22:21:02 +0200 Subject: [PATCH 26/42] Update symfonycorp.yml --- .github/workflows/symfonycorp.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/symfonycorp.yml b/.github/workflows/symfonycorp.yml index cd08568..8e8b6af 100644 --- a/.github/workflows/symfonycorp.yml +++ b/.github/workflows/symfonycorp.yml @@ -1,2 +1,2 @@ -- name: The PHP Security Checker - uses: symfonycorp/security-checker-action@v2 +name: The PHP Security Checker +uses: symfonycorp/security-checker-action@v2 From c47952f42c34ff29cc954bc614f5393134548954 Mon Sep 17 00:00:00 2001 From: Mark Cheret Date: Sun, 4 Apr 2021 22:21:48 +0200 Subject: [PATCH 27/42] Update symfonycorp.yml --- .github/workflows/symfonycorp.yml | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/.github/workflows/symfonycorp.yml b/.github/workflows/symfonycorp.yml index 8e8b6af..bd0a0a7 100644 --- a/.github/workflows/symfonycorp.yml +++ b/.github/workflows/symfonycorp.yml @@ -1,2 +1,25 @@ -name: The PHP Security Checker -uses: symfonycorp/security-checker-action@v2 +name: 'The PHP Security Checker' +description: 'Checks composer.json for known vulnerabilities in your package dependencies' +branding: + icon: 'umbrella' + color: 'gray-dark' +inputs: + lock: + description: 'The path to composer.lock is stored (root directory by default)' + required: false + default: './composer.lock' + disable-exit-code: + description: 'Whether to fail when issues are detected (false by default)' + required: false + default: 0 +outputs: + vulns: + description: 'The detected vulnerabilities as JSON' +runs: + using: 'docker' + image: 'docker://symfonycorp/cli:latest' + args: + - check:security + - "--dir" + - ${{ inputs.lock }} + - "--disable-exit-code=${{ inputs.disable-exit-code }}" From d831585fd9b2b2b95dabbc02c4ac169cbdbc4762 Mon Sep 17 00:00:00 2001 From: Mark Cheret Date: Sun, 4 Apr 2021 22:23:35 +0200 Subject: [PATCH 28/42] Delete symfonycorp.yml --- .github/workflows/symfonycorp.yml | 25 ------------------------- 1 file changed, 25 deletions(-) delete mode 100644 .github/workflows/symfonycorp.yml diff --git a/.github/workflows/symfonycorp.yml b/.github/workflows/symfonycorp.yml deleted file mode 100644 index bd0a0a7..0000000 --- a/.github/workflows/symfonycorp.yml +++ /dev/null @@ -1,25 +0,0 @@ -name: 'The PHP Security Checker' -description: 'Checks composer.json for known vulnerabilities in your package dependencies' -branding: - icon: 'umbrella' - color: 'gray-dark' -inputs: - lock: - description: 'The path to composer.lock is stored (root directory by default)' - required: false - default: './composer.lock' - disable-exit-code: - description: 'Whether to fail when issues are detected (false by default)' - required: false - default: 0 -outputs: - vulns: - description: 'The detected vulnerabilities as JSON' -runs: - using: 'docker' - image: 'docker://symfonycorp/cli:latest' - args: - - check:security - - "--dir" - - ${{ inputs.lock }} - - "--disable-exit-code=${{ inputs.disable-exit-code }}" From 13a9c7aa8ec74c2b22bebc91564c4b0c989f860d Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Sat, 10 Apr 2021 21:00:39 +0100 Subject: [PATCH 29/42] update composer lockfile --- composer.lock | 4931 ++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 4923 insertions(+), 8 deletions(-) diff --git a/composer.lock b/composer.lock index 9e0ee7c..b1a01a4 100644 --- a/composer.lock +++ b/composer.lock @@ -4,9 +4,82 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "3a147d50695956de52f7cbf827b47830", + "content-hash": "96b80176526406b01227fcaef2a4c2fc", "packages": [], "packages-dev": [ + { + "name": "composer/package-versions-deprecated", + "version": "1.11.99.1", + "source": { + "type": "git", + "url": "https://github.com/composer/package-versions-deprecated.git", + "reference": "7413f0b55a051e89485c5cb9f765fe24bb02a7b6" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/composer/package-versions-deprecated/zipball/7413f0b55a051e89485c5cb9f765fe24bb02a7b6", + "reference": "7413f0b55a051e89485c5cb9f765fe24bb02a7b6", + "shasum": "" + }, + "require": { + "composer-plugin-api": "^1.1.0 || ^2.0", + "php": "^7 || ^8" + }, + "replace": { + "ocramius/package-versions": "1.11.99" + }, + "require-dev": { + "composer/composer": "^1.9.3 || ^2.0@dev", + "ext-zip": "^1.13", + "phpunit/phpunit": "^6.5 || ^7" + }, + "type": "composer-plugin", + "extra": { + "class": "PackageVersions\\Installer", + "branch-alias": { + "dev-master": "1.x-dev" + } + }, + "autoload": { + "psr-4": { + "PackageVersions\\": "src/PackageVersions" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Marco Pivetta", + "email": "ocramius@gmail.com" + }, + { + "name": "Jordi Boggiano", + "email": "j.boggiano@seld.be" + } + ], + "description": "Composer plugin that provides efficient querying for installed package versions (no runtime IO)", + "support": { + "issues": "https://github.com/composer/package-versions-deprecated/issues", + "source": "https://github.com/composer/package-versions-deprecated/tree/1.11.99.1" + }, + "funding": [ + { + "url": "https://packagist.com", + "type": "custom" + }, + { + "url": "https://github.com/composer", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/composer/composer", + "type": "tidelift" + } + ], + "time": "2020-11-11T10:22:58+00:00" + }, { "name": "dealerdirect/phpcodesniffer-composer-installer", "version": "v0.7.1", @@ -78,17 +151,2130 @@ "time": "2020-12-07T18:04:37+00:00" }, { - "name": "squizlabs/php_codesniffer", - "version": "3.5.8", + "name": "doctrine/event-manager", + "version": "1.1.1", "source": { "type": "git", - "url": "https://github.com/squizlabs/PHP_CodeSniffer.git", - "reference": "9d583721a7157ee997f235f327de038e7ea6dac4" + "url": "https://github.com/doctrine/event-manager.git", + "reference": "41370af6a30faa9dc0368c4a6814d596e81aba7f" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/squizlabs/PHP_CodeSniffer/zipball/9d583721a7157ee997f235f327de038e7ea6dac4", - "reference": "9d583721a7157ee997f235f327de038e7ea6dac4", + "url": "https://api.github.com/repos/doctrine/event-manager/zipball/41370af6a30faa9dc0368c4a6814d596e81aba7f", + "reference": "41370af6a30faa9dc0368c4a6814d596e81aba7f", + "shasum": "" + }, + "require": { + "php": "^7.1 || ^8.0" + }, + "conflict": { + "doctrine/common": "<2.9@dev" + }, + "require-dev": { + "doctrine/coding-standard": "^6.0", + "phpunit/phpunit": "^7.0" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.0.x-dev" + } + }, + "autoload": { + "psr-4": { + "Doctrine\\Common\\": "lib/Doctrine/Common" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Guilherme Blanco", + "email": "guilhermeblanco@gmail.com" + }, + { + "name": "Roman Borschel", + "email": "roman@code-factory.org" + }, + { + "name": "Benjamin Eberlei", + "email": "kontakt@beberlei.de" + }, + { + "name": "Jonathan Wage", + "email": "jonwage@gmail.com" + }, + { + "name": "Johannes Schmitt", + "email": "schmittjoh@gmail.com" + }, + { + "name": "Marco Pivetta", + "email": "ocramius@gmail.com" + } + ], + "description": "The Doctrine Event Manager is a simple PHP event system that was built to be used with the various Doctrine projects.", + "homepage": "https://www.doctrine-project.org/projects/event-manager.html", + "keywords": [ + "event", + "event dispatcher", + "event manager", + "event system", + "events" + ], + "support": { + "issues": "https://github.com/doctrine/event-manager/issues", + "source": "https://github.com/doctrine/event-manager/tree/1.1.x" + }, + "funding": [ + { + "url": "https://www.doctrine-project.org/sponsorship.html", + "type": "custom" + }, + { + "url": "https://www.patreon.com/phpdoctrine", + "type": "patreon" + }, + { + "url": "https://tidelift.com/funding/github/packagist/doctrine%2Fevent-manager", + "type": "tidelift" + } + ], + "time": "2020-05-29T18:28:51+00:00" + }, + { + "name": "friendsofphp/proxy-manager-lts", + "version": "v1.0.3", + "source": { + "type": "git", + "url": "https://github.com/FriendsOfPHP/proxy-manager-lts.git", + "reference": "121af47c9aee9c03031bdeca3fac0540f59aa5c3" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/FriendsOfPHP/proxy-manager-lts/zipball/121af47c9aee9c03031bdeca3fac0540f59aa5c3", + "reference": "121af47c9aee9c03031bdeca3fac0540f59aa5c3", + "shasum": "" + }, + "require": { + "laminas/laminas-code": "~3.4.1|^4.0", + "php": ">=7.1", + "symfony/filesystem": "^4.4.17|^5.0" + }, + "conflict": { + "laminas/laminas-stdlib": "<3.2.1", + "zendframework/zend-stdlib": "<3.2.1" + }, + "replace": { + "ocramius/proxy-manager": "^2.1" + }, + "require-dev": { + "ext-phar": "*", + "symfony/phpunit-bridge": "^5.2" + }, + "type": "library", + "extra": { + "thanks": { + "name": "ocramius/proxy-manager", + "url": "https://github.com/Ocramius/ProxyManager" + } + }, + "autoload": { + "psr-4": { + "ProxyManager\\": "src/ProxyManager" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Marco Pivetta", + "email": "ocramius@gmail.com", + "homepage": "http://ocramius.github.io/" + }, + { + "name": "Nicolas Grekas", + "email": "p@tchwork.com" + } + ], + "description": "Adding support for a wider range of PHP versions to ocramius/proxy-manager", + "homepage": "https://github.com/FriendsOfPHP/proxy-manager-lts", + "keywords": [ + "aop", + "lazy loading", + "proxy", + "proxy pattern", + "service proxies" + ], + "support": { + "issues": "https://github.com/FriendsOfPHP/proxy-manager-lts/issues", + "source": "https://github.com/FriendsOfPHP/proxy-manager-lts/tree/v1.0.3" + }, + "funding": [ + { + "url": "https://github.com/Ocramius", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/ocramius/proxy-manager", + "type": "tidelift" + } + ], + "time": "2021-01-14T21:52:44+00:00" + }, + { + "name": "jawira/plantuml", + "version": "v1.54.0", + "source": { + "type": "git", + "url": "https://github.com/jawira/plantuml.git", + "reference": "d313d5373618fef6a6c09eeae9676538c38da6a9" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/jawira/plantuml/zipball/d313d5373618fef6a6c09eeae9676538c38da6a9", + "reference": "d313d5373618fef6a6c09eeae9676538c38da6a9", + "shasum": "" + }, + "suggest": { + "pds/skeleton": "Standard PHP package skeleton", + "phing/phing": "PHP Build Tool" + }, + "bin": [ + "bin/plantuml" + ], + "type": "library", + "notification-url": "https://packagist.org/downloads/", + "license": [ + "GPL-3.0-or-later" + ], + "authors": [ + { + "name": "Jawira Portugal" + } + ], + "description": "Provides PlantUML integration: plantuml executable and plantuml.jar", + "keywords": [ + "diagram", + "plantuml", + "plantuml.jar", + "uml" + ], + "support": { + "issues": "https://github.com/jawira/plantuml/issues", + "source": "https://github.com/jawira/plantuml/tree/v1.54.0" + }, + "time": "2021-04-09T13:05:56+00:00" + }, + { + "name": "jean85/pretty-package-versions", + "version": "1.6.0", + "source": { + "type": "git", + "url": "https://github.com/Jean85/pretty-package-versions.git", + "reference": "1e0104b46f045868f11942aea058cd7186d6c303" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/Jean85/pretty-package-versions/zipball/1e0104b46f045868f11942aea058cd7186d6c303", + "reference": "1e0104b46f045868f11942aea058cd7186d6c303", + "shasum": "" + }, + "require": { + "composer/package-versions-deprecated": "^1.8.0", + "php": "^7.0|^8.0" + }, + "require-dev": { + "phpunit/phpunit": "^6.0|^8.5|^9.2" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.x-dev" + } + }, + "autoload": { + "psr-4": { + "Jean85\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Alessandro Lai", + "email": "alessandro.lai85@gmail.com" + } + ], + "description": "A wrapper for ocramius/package-versions to get pretty versions strings", + "keywords": [ + "composer", + "package", + "release", + "versions" + ], + "support": { + "issues": "https://github.com/Jean85/pretty-package-versions/issues", + "source": "https://github.com/Jean85/pretty-package-versions/tree/1.6.0" + }, + "time": "2021-02-04T16:20:16+00:00" + }, + { + "name": "laminas/laminas-code", + "version": "4.1.0", + "source": { + "type": "git", + "url": "https://github.com/laminas/laminas-code.git", + "reference": "5b553c274b94af3f880cbaaf8fbab047f279a31c" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/laminas/laminas-code/zipball/5b553c274b94af3f880cbaaf8fbab047f279a31c", + "reference": "5b553c274b94af3f880cbaaf8fbab047f279a31c", + "shasum": "" + }, + "require": { + "laminas/laminas-eventmanager": "^3.3", + "php": "^7.4 || ~8.0.0" + }, + "conflict": { + "phpspec/prophecy": "<1.9.0" + }, + "replace": { + "zendframework/zend-code": "self.version" + }, + "require-dev": { + "doctrine/annotations": "^1.10.4", + "ext-phar": "*", + "laminas/laminas-coding-standard": "^2.1.4", + "laminas/laminas-stdlib": "^3.3.0", + "phpunit/phpunit": "^9.4.2", + "psalm/plugin-phpunit": "^0.14.0", + "vimeo/psalm": "^4.3.1" + }, + "suggest": { + "doctrine/annotations": "Doctrine\\Common\\Annotations >=1.0 for annotation features", + "laminas/laminas-stdlib": "Laminas\\Stdlib component", + "laminas/laminas-zendframework-bridge": "A bridge with Zend Framework" + }, + "type": "library", + "autoload": { + "psr-4": { + "Laminas\\Code\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "description": "Extensions to the PHP Reflection API, static code scanning, and code generation", + "homepage": "https://laminas.dev", + "keywords": [ + "code", + "laminas", + "laminasframework" + ], + "support": { + "chat": "https://laminas.dev/chat", + "docs": "https://docs.laminas.dev/laminas-code/", + "forum": "https://discourse.laminas.dev", + "issues": "https://github.com/laminas/laminas-code/issues", + "rss": "https://github.com/laminas/laminas-code/releases.atom", + "source": "https://github.com/laminas/laminas-code" + }, + "funding": [ + { + "url": "https://funding.communitybridge.org/projects/laminas-project", + "type": "community_bridge" + } + ], + "time": "2021-03-27T13:55:31+00:00" + }, + { + "name": "laminas/laminas-eventmanager", + "version": "3.3.1", + "source": { + "type": "git", + "url": "https://github.com/laminas/laminas-eventmanager.git", + "reference": "966c859b67867b179fde1eff0cd38df51472ce4a" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/laminas/laminas-eventmanager/zipball/966c859b67867b179fde1eff0cd38df51472ce4a", + "reference": "966c859b67867b179fde1eff0cd38df51472ce4a", + "shasum": "" + }, + "require": { + "laminas/laminas-zendframework-bridge": "^1.0", + "php": "^7.3 || ^8.0" + }, + "replace": { + "zendframework/zend-eventmanager": "^3.2.1" + }, + "require-dev": { + "container-interop/container-interop": "^1.1", + "laminas/laminas-coding-standard": "~1.0.0", + "laminas/laminas-stdlib": "^2.7.3 || ^3.0", + "phpbench/phpbench": "^0.17.1", + "phpunit/phpunit": "^8.5.8" + }, + "suggest": { + "container-interop/container-interop": "^1.1, to use the lazy listeners feature", + "laminas/laminas-stdlib": "^2.7.3 || ^3.0, to use the FilterChain feature" + }, + "type": "library", + "autoload": { + "psr-4": { + "Laminas\\EventManager\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "description": "Trigger and listen to events within a PHP application", + "homepage": "https://laminas.dev", + "keywords": [ + "event", + "eventmanager", + "events", + "laminas" + ], + "support": { + "chat": "https://laminas.dev/chat", + "docs": "https://docs.laminas.dev/laminas-eventmanager/", + "forum": "https://discourse.laminas.dev", + "issues": "https://github.com/laminas/laminas-eventmanager/issues", + "rss": "https://github.com/laminas/laminas-eventmanager/releases.atom", + "source": "https://github.com/laminas/laminas-eventmanager" + }, + "funding": [ + { + "url": "https://funding.communitybridge.org/projects/laminas-project", + "type": "community_bridge" + } + ], + "time": "2021-03-08T15:24:29+00:00" + }, + { + "name": "laminas/laminas-zendframework-bridge", + "version": "1.2.0", + "source": { + "type": "git", + "url": "https://github.com/laminas/laminas-zendframework-bridge.git", + "reference": "6cccbddfcfc742eb02158d6137ca5687d92cee32" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/laminas/laminas-zendframework-bridge/zipball/6cccbddfcfc742eb02158d6137ca5687d92cee32", + "reference": "6cccbddfcfc742eb02158d6137ca5687d92cee32", + "shasum": "" + }, + "require": { + "php": "^7.3 || ^8.0" + }, + "require-dev": { + "phpunit/phpunit": "^5.7 || ^6.5 || ^7.5 || ^8.1 || ^9.3", + "psalm/plugin-phpunit": "^0.15.1", + "squizlabs/php_codesniffer": "^3.5", + "vimeo/psalm": "^4.6" + }, + "type": "library", + "extra": { + "laminas": { + "module": "Laminas\\ZendFrameworkBridge" + } + }, + "autoload": { + "files": [ + "src/autoload.php" + ], + "psr-4": { + "Laminas\\ZendFrameworkBridge\\": "src//" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "description": "Alias legacy ZF class names to Laminas Project equivalents.", + "keywords": [ + "ZendFramework", + "autoloading", + "laminas", + "zf" + ], + "support": { + "forum": "https://discourse.laminas.dev/", + "issues": "https://github.com/laminas/laminas-zendframework-bridge/issues", + "rss": "https://github.com/laminas/laminas-zendframework-bridge/releases.atom", + "source": "https://github.com/laminas/laminas-zendframework-bridge" + }, + "funding": [ + { + "url": "https://funding.communitybridge.org/projects/laminas-project", + "type": "community_bridge" + } + ], + "time": "2021-02-25T21:54:58+00:00" + }, + { + "name": "league/commonmark", + "version": "1.5.8", + "source": { + "type": "git", + "url": "https://github.com/thephpleague/commonmark.git", + "reference": "08fa59b8e4e34ea8a773d55139ae9ac0e0aecbaf" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/thephpleague/commonmark/zipball/08fa59b8e4e34ea8a773d55139ae9ac0e0aecbaf", + "reference": "08fa59b8e4e34ea8a773d55139ae9ac0e0aecbaf", + "shasum": "" + }, + "require": { + "ext-mbstring": "*", + "php": "^7.1 || ^8.0" + }, + "conflict": { + "scrutinizer/ocular": "1.7.*" + }, + "require-dev": { + "cebe/markdown": "~1.0", + "commonmark/commonmark.js": "0.29.2", + "erusev/parsedown": "~1.0", + "ext-json": "*", + "github/gfm": "0.29.0", + "michelf/php-markdown": "~1.4", + "mikehaertl/php-shellcommand": "^1.4", + "phpstan/phpstan": "^0.12", + "phpunit/phpunit": "^7.5 || ^8.5 || ^9.2", + "scrutinizer/ocular": "^1.5", + "symfony/finder": "^4.2" + }, + "bin": [ + "bin/commonmark" + ], + "type": "library", + "autoload": { + "psr-4": { + "League\\CommonMark\\": "src" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Colin O'Dell", + "email": "colinodell@gmail.com", + "homepage": "https://www.colinodell.com", + "role": "Lead Developer" + } + ], + "description": "Highly-extensible PHP Markdown parser which fully supports the CommonMark spec and Github-Flavored Markdown (GFM)", + "homepage": "https://commonmark.thephpleague.com", + "keywords": [ + "commonmark", + "flavored", + "gfm", + "github", + "github-flavored", + "markdown", + "md", + "parser" + ], + "support": { + "docs": "https://commonmark.thephpleague.com/", + "issues": "https://github.com/thephpleague/commonmark/issues", + "rss": "https://github.com/thephpleague/commonmark/releases.atom", + "source": "https://github.com/thephpleague/commonmark" + }, + "funding": [ + { + "url": "https://enjoy.gitstore.app/repositories/thephpleague/commonmark", + "type": "custom" + }, + { + "url": "https://www.colinodell.com/sponsor", + "type": "custom" + }, + { + "url": "https://www.paypal.me/colinpodell/10.00", + "type": "custom" + }, + { + "url": "https://github.com/colinodell", + "type": "github" + }, + { + "url": "https://www.patreon.com/colinodell", + "type": "patreon" + }, + { + "url": "https://tidelift.com/funding/github/packagist/league/commonmark", + "type": "tidelift" + } + ], + "time": "2021-03-28T18:51:39+00:00" + }, + { + "name": "league/flysystem", + "version": "1.1.3", + "source": { + "type": "git", + "url": "https://github.com/thephpleague/flysystem.git", + "reference": "9be3b16c877d477357c015cec057548cf9b2a14a" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/thephpleague/flysystem/zipball/9be3b16c877d477357c015cec057548cf9b2a14a", + "reference": "9be3b16c877d477357c015cec057548cf9b2a14a", + "shasum": "" + }, + "require": { + "ext-fileinfo": "*", + "league/mime-type-detection": "^1.3", + "php": "^7.2.5 || ^8.0" + }, + "conflict": { + "league/flysystem-sftp": "<1.0.6" + }, + "require-dev": { + "phpspec/prophecy": "^1.11.1", + "phpunit/phpunit": "^8.5.8" + }, + "suggest": { + "ext-fileinfo": "Required for MimeType", + "ext-ftp": "Allows you to use FTP server storage", + "ext-openssl": "Allows you to use FTPS server storage", + "league/flysystem-aws-s3-v2": "Allows you to use S3 storage with AWS SDK v2", + "league/flysystem-aws-s3-v3": "Allows you to use S3 storage with AWS SDK v3", + "league/flysystem-azure": "Allows you to use Windows Azure Blob storage", + "league/flysystem-cached-adapter": "Flysystem adapter decorator for metadata caching", + "league/flysystem-eventable-filesystem": "Allows you to use EventableFilesystem", + "league/flysystem-rackspace": "Allows you to use Rackspace Cloud Files", + "league/flysystem-sftp": "Allows you to use SFTP server storage via phpseclib", + "league/flysystem-webdav": "Allows you to use WebDAV storage", + "league/flysystem-ziparchive": "Allows you to use ZipArchive adapter", + "spatie/flysystem-dropbox": "Allows you to use Dropbox storage", + "srmklive/flysystem-dropbox-v2": "Allows you to use Dropbox storage for PHP 5 applications" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.1-dev" + } + }, + "autoload": { + "psr-4": { + "League\\Flysystem\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Frank de Jonge", + "email": "info@frenky.net" + } + ], + "description": "Filesystem abstraction: Many filesystems, one API.", + "keywords": [ + "Cloud Files", + "WebDAV", + "abstraction", + "aws", + "cloud", + "copy.com", + "dropbox", + "file systems", + "files", + "filesystem", + "filesystems", + "ftp", + "rackspace", + "remote", + "s3", + "sftp", + "storage" + ], + "support": { + "issues": "https://github.com/thephpleague/flysystem/issues", + "source": "https://github.com/thephpleague/flysystem/tree/1.x" + }, + "funding": [ + { + "url": "https://offset.earth/frankdejonge", + "type": "other" + } + ], + "time": "2020-08-23T07:39:11+00:00" + }, + { + "name": "league/mime-type-detection", + "version": "1.7.0", + "source": { + "type": "git", + "url": "https://github.com/thephpleague/mime-type-detection.git", + "reference": "3b9dff8aaf7323590c1d2e443db701eb1f9aa0d3" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/thephpleague/mime-type-detection/zipball/3b9dff8aaf7323590c1d2e443db701eb1f9aa0d3", + "reference": "3b9dff8aaf7323590c1d2e443db701eb1f9aa0d3", + "shasum": "" + }, + "require": { + "ext-fileinfo": "*", + "php": "^7.2 || ^8.0" + }, + "require-dev": { + "friendsofphp/php-cs-fixer": "^2.18", + "phpstan/phpstan": "^0.12.68", + "phpunit/phpunit": "^8.5.8 || ^9.3" + }, + "type": "library", + "autoload": { + "psr-4": { + "League\\MimeTypeDetection\\": "src" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Frank de Jonge", + "email": "info@frankdejonge.nl" + } + ], + "description": "Mime-type detection for Flysystem", + "support": { + "issues": "https://github.com/thephpleague/mime-type-detection/issues", + "source": "https://github.com/thephpleague/mime-type-detection/tree/1.7.0" + }, + "funding": [ + { + "url": "https://github.com/frankdejonge", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/league/flysystem", + "type": "tidelift" + } + ], + "time": "2021-01-18T20:58:21+00:00" + }, + { + "name": "league/pipeline", + "version": "1.0.0", + "source": { + "type": "git", + "url": "https://github.com/thephpleague/pipeline.git", + "reference": "aa14b0e3133121f8be39e9a3b6ddd011fc5bb9a8" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/thephpleague/pipeline/zipball/aa14b0e3133121f8be39e9a3b6ddd011fc5bb9a8", + "reference": "aa14b0e3133121f8be39e9a3b6ddd011fc5bb9a8", + "shasum": "" + }, + "require": { + "php": ">=7.1" + }, + "require-dev": { + "leanphp/phpspec-code-coverage": "^4.2", + "phpspec/phpspec": "^4.3" + }, + "type": "library", + "autoload": { + "psr-4": { + "League\\Pipeline\\": "src" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Frank de Jonge", + "email": "info@frenky.net", + "role": "Author" + }, + { + "name": "Woody Gilk", + "email": "woody.gilk@gmail.com", + "role": "Maintainer" + } + ], + "description": "A plug and play pipeline implementation.", + "keywords": [ + "composition", + "design pattern", + "pattern", + "pipeline", + "sequential" + ], + "support": { + "issues": "https://github.com/thephpleague/pipeline/issues", + "source": "https://github.com/thephpleague/pipeline/tree/master" + }, + "time": "2018-06-05T21:06:51+00:00" + }, + { + "name": "league/tactician", + "version": "v1.1.0", + "source": { + "type": "git", + "url": "https://github.com/thephpleague/tactician.git", + "reference": "e79f763170f3d5922ec29e85cffca0bac5cd8975" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/thephpleague/tactician/zipball/e79f763170f3d5922ec29e85cffca0bac5cd8975", + "reference": "e79f763170f3d5922ec29e85cffca0bac5cd8975", + "shasum": "" + }, + "require": { + "php": ">=7.1" + }, + "require-dev": { + "mockery/mockery": "^1.3", + "phpunit/phpunit": "^7.5.20 || ^9.3.8", + "squizlabs/php_codesniffer": "^3.5.8" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "2.0-dev" + } + }, + "autoload": { + "psr-4": { + "League\\Tactician\\": "src" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Ross Tuck", + "homepage": "http://tactician.thephpleague.com" + } + ], + "description": "A small, flexible command bus. Handy for building service layers.", + "keywords": [ + "command", + "command bus", + "service layer" + ], + "support": { + "issues": "https://github.com/thephpleague/tactician/issues", + "source": "https://github.com/thephpleague/tactician/tree/v1.1.0" + }, + "time": "2021-02-14T15:29:04+00:00" + }, + { + "name": "league/tactician-bundle", + "version": "v1.3.0", + "source": { + "type": "git", + "url": "https://github.com/thephpleague/tactician-bundle.git", + "reference": "89c51277423ac485b62580c38322426c3ec6ad47" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/thephpleague/tactician-bundle/zipball/89c51277423ac485b62580c38322426c3ec6ad47", + "reference": "89c51277423ac485b62580c38322426c3ec6ad47", + "shasum": "" + }, + "require": { + "league/tactician": "^1.0", + "league/tactician-container": "^2.0", + "league/tactician-logger": "^0.10.0", + "php": ">=7.2", + "symfony/config": "^3.4|^4.4|^5.0", + "symfony/dependency-injection": "^3.4|^4.4|^5.0", + "symfony/http-kernel": "^3.4|^4.4|^5.0", + "symfony/yaml": "^3.4|^4.4|^5.0" + }, + "require-dev": { + "matthiasnoback/symfony-config-test": "^4.2.1", + "matthiasnoback/symfony-dependency-injection-test": "^4.2.1", + "mockery/mockery": "~1.0", + "phpunit/phpunit": "~8.5", + "symfony/console": "^3.4|^4.4|^5.0", + "symfony/framework-bundle": "^3.4.31|^4.4|^5.0", + "symfony/security-bundle": "^3.4|^4.4|^5.0", + "symfony/security-core": "^3.4|^4.4|^5.0", + "symfony/validator": "^3.4|^4.4|^5.0" + }, + "suggest": { + "league/tactician-doctrine": "For doctrine transaction middleware", + "symfony/console": "For debugging command-to-handler routing using the tactician:debug console command", + "symfony/security": "For command security middleware", + "symfony/validator": "For command validator middleware" + }, + "type": "symfony-bundle", + "extra": { + "branch-alias": { + "dev-master": "1.0-dev" + } + }, + "autoload": { + "psr-4": { + "League\\Tactician\\Bundle\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Rafael Dohms", + "homepage": "http://doh.ms" + }, + { + "name": "Richard Tuin", + "homepage": "http://www.rtuin.nl/" + }, + { + "name": "Xander Smalbil", + "email": "xander@videofunk.nl" + }, + { + "name": "Ross Tuck", + "email": "me@rosstuck.com" + } + ], + "description": "Bundle to integrate Tactician with Symfony projects", + "keywords": [ + "bundle", + "symfony", + "tactician" + ], + "support": { + "issues": "https://github.com/thephpleague/tactician-bundle/issues", + "source": "https://github.com/thephpleague/tactician-bundle/tree/v1.3.0" + }, + "time": "2021-01-31T17:06:29+00:00" + }, + { + "name": "league/tactician-container", + "version": "2.0.0", + "source": { + "type": "git", + "url": "https://github.com/thephpleague/tactician-container.git", + "reference": "d1a5d884e072b8cafbff802d07766076eb2ffcb0" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/thephpleague/tactician-container/zipball/d1a5d884e072b8cafbff802d07766076eb2ffcb0", + "reference": "d1a5d884e072b8cafbff802d07766076eb2ffcb0", + "shasum": "" + }, + "require": { + "league/tactician": "^1.0", + "php": ">=5.5", + "psr/container": "^1.0" + }, + "require-dev": { + "league/container": "~2.3", + "phpunit/phpunit": "~4.3", + "squizlabs/php_codesniffer": "~2.0" + }, + "type": "library", + "autoload": { + "psr-4": { + "League\\Tactician\\Container\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Nigel Greenway", + "homepage": "http://futurepixels.co.uk" + } + ], + "description": "Tactician integration for any container implementing PSR-11", + "keywords": [ + "container", + "container-interop", + "di", + "interoperable", + "league", + "tactician" + ], + "support": { + "issues": "https://github.com/thephpleague/tactician-container/issues", + "source": "https://github.com/thephpleague/tactician-container/tree/master" + }, + "time": "2017-04-13T06:27:12+00:00" + }, + { + "name": "league/tactician-logger", + "version": "v0.10.0", + "source": { + "type": "git", + "url": "https://github.com/thephpleague/tactician-logger.git", + "reference": "3ff9ee04e4cbec100af827f829ed4c7ff7c08442" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/thephpleague/tactician-logger/zipball/3ff9ee04e4cbec100af827f829ed4c7ff7c08442", + "reference": "3ff9ee04e4cbec100af827f829ed4c7ff7c08442", + "shasum": "" + }, + "require": { + "league/tactician": "^1.0", + "php": ">=5.5.0", + "psr/log": "~1.0" + }, + "require-dev": { + "mockery/mockery": "^0.9", + "phpunit/phpunit": "4.*", + "squizlabs/php_codesniffer": "~2.3" + }, + "type": "library", + "autoload": { + "psr-4": { + "League\\Tactician\\Logger\\": "src" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Ross Tuck" + } + ], + "description": "Adds PSR-3 logging support to the Tactician command bus", + "homepage": "https://github.com/thephpleague/tactician-logger", + "keywords": [ + "log", + "logging", + "tactician" + ], + "support": { + "issues": "https://github.com/thephpleague/tactician-logger/issues", + "source": "https://github.com/thephpleague/tactician-logger/tree/master" + }, + "time": "2016-08-23T05:50:38+00:00" + }, + { + "name": "league/uri", + "version": "6.4.0", + "source": { + "type": "git", + "url": "https://github.com/thephpleague/uri.git", + "reference": "09da64118eaf4c5d52f9923a1e6a5be1da52fd9a" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/thephpleague/uri/zipball/09da64118eaf4c5d52f9923a1e6a5be1da52fd9a", + "reference": "09da64118eaf4c5d52f9923a1e6a5be1da52fd9a", + "shasum": "" + }, + "require": { + "ext-json": "*", + "league/uri-interfaces": "^2.1", + "php": ">=7.2", + "psr/http-message": "^1.0" + }, + "conflict": { + "league/uri-schemes": "^1.0" + }, + "require-dev": { + "friendsofphp/php-cs-fixer": "^2.16", + "phpstan/phpstan": "^0.12", + "phpstan/phpstan-phpunit": "^0.12", + "phpstan/phpstan-strict-rules": "^0.12", + "phpunit/phpunit": "^8.0 || ^9.0", + "psr/http-factory": "^1.0" + }, + "suggest": { + "ext-fileinfo": "Needed to create Data URI from a filepath", + "ext-intl": "Needed to improve host validation", + "league/uri-components": "Needed to easily manipulate URI objects", + "psr/http-factory": "Needed to use the URI factory" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "6.x-dev" + } + }, + "autoload": { + "psr-4": { + "League\\Uri\\": "src" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Ignace Nyamagana Butera", + "email": "nyamsprod@gmail.com", + "homepage": "https://nyamsprod.com" + } + ], + "description": "URI manipulation library", + "homepage": "http://uri.thephpleague.com", + "keywords": [ + "data-uri", + "file-uri", + "ftp", + "hostname", + "http", + "https", + "middleware", + "parse_str", + "parse_url", + "psr-7", + "query-string", + "querystring", + "rfc3986", + "rfc3987", + "rfc6570", + "uri", + "uri-template", + "url", + "ws" + ], + "support": { + "docs": "https://uri.thephpleague.com", + "forum": "https://thephpleague.slack.com", + "issues": "https://github.com/thephpleague/uri/issues", + "source": "https://github.com/thephpleague/uri/tree/6.4.0" + }, + "funding": [ + { + "url": "https://github.com/sponsors/nyamsprod", + "type": "github" + } + ], + "time": "2020-11-22T14:29:11+00:00" + }, + { + "name": "league/uri-interfaces", + "version": "2.2.0", + "source": { + "type": "git", + "url": "https://github.com/thephpleague/uri-interfaces.git", + "reference": "667f150e589d65d79c89ffe662e426704f84224f" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/thephpleague/uri-interfaces/zipball/667f150e589d65d79c89ffe662e426704f84224f", + "reference": "667f150e589d65d79c89ffe662e426704f84224f", + "shasum": "" + }, + "require": { + "ext-json": "*", + "php": "^7.1 || ^8.0" + }, + "require-dev": { + "friendsofphp/php-cs-fixer": "^2.0", + "phpstan/phpstan": "^0.12", + "phpstan/phpstan-phpunit": "^0.12", + "phpstan/phpstan-strict-rules": "^0.12" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "2.x-dev" + } + }, + "autoload": { + "psr-4": { + "League\\Uri\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Ignace Nyamagana Butera", + "email": "nyamsprod@gmail.com", + "homepage": "https://nyamsprod.com" + } + ], + "description": "Common interface for URI representation", + "homepage": "http://github.com/thephpleague/uri-interfaces", + "keywords": [ + "rfc3986", + "rfc3987", + "uri", + "url" + ], + "support": { + "issues": "https://github.com/thephpleague/uri-interfaces/issues", + "source": "https://github.com/thephpleague/uri-interfaces/tree/2.2.0" + }, + "funding": [ + { + "url": "https://github.com/sponsors/nyamsprod", + "type": "github" + } + ], + "time": "2020-10-31T13:45:51+00:00" + }, + { + "name": "monolog/monolog", + "version": "2.2.0", + "source": { + "type": "git", + "url": "https://github.com/Seldaek/monolog.git", + "reference": "1cb1cde8e8dd0f70cc0fe51354a59acad9302084" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/Seldaek/monolog/zipball/1cb1cde8e8dd0f70cc0fe51354a59acad9302084", + "reference": "1cb1cde8e8dd0f70cc0fe51354a59acad9302084", + "shasum": "" + }, + "require": { + "php": ">=7.2", + "psr/log": "^1.0.1" + }, + "provide": { + "psr/log-implementation": "1.0.0" + }, + "require-dev": { + "aws/aws-sdk-php": "^2.4.9 || ^3.0", + "doctrine/couchdb": "~1.0@dev", + "elasticsearch/elasticsearch": "^7", + "graylog2/gelf-php": "^1.4.2", + "mongodb/mongodb": "^1.8", + "php-amqplib/php-amqplib": "~2.4", + "php-console/php-console": "^3.1.3", + "phpspec/prophecy": "^1.6.1", + "phpstan/phpstan": "^0.12.59", + "phpunit/phpunit": "^8.5", + "predis/predis": "^1.1", + "rollbar/rollbar": "^1.3", + "ruflin/elastica": ">=0.90 <7.0.1", + "swiftmailer/swiftmailer": "^5.3|^6.0" + }, + "suggest": { + "aws/aws-sdk-php": "Allow sending log messages to AWS services like DynamoDB", + "doctrine/couchdb": "Allow sending log messages to a CouchDB server", + "elasticsearch/elasticsearch": "Allow sending log messages to an Elasticsearch server via official client", + "ext-amqp": "Allow sending log messages to an AMQP server (1.0+ required)", + "ext-mbstring": "Allow to work properly with unicode symbols", + "ext-mongodb": "Allow sending log messages to a MongoDB server (via driver)", + "graylog2/gelf-php": "Allow sending log messages to a GrayLog2 server", + "mongodb/mongodb": "Allow sending log messages to a MongoDB server (via library)", + "php-amqplib/php-amqplib": "Allow sending log messages to an AMQP server using php-amqplib", + "php-console/php-console": "Allow sending log messages to Google Chrome", + "rollbar/rollbar": "Allow sending log messages to Rollbar", + "ruflin/elastica": "Allow sending log messages to an Elastic Search server" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-main": "2.x-dev" + } + }, + "autoload": { + "psr-4": { + "Monolog\\": "src/Monolog" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Jordi Boggiano", + "email": "j.boggiano@seld.be", + "homepage": "https://seld.be" + } + ], + "description": "Sends your logs to files, sockets, inboxes, databases and various web services", + "homepage": "https://github.com/Seldaek/monolog", + "keywords": [ + "log", + "logging", + "psr-3" + ], + "support": { + "issues": "https://github.com/Seldaek/monolog/issues", + "source": "https://github.com/Seldaek/monolog/tree/2.2.0" + }, + "funding": [ + { + "url": "https://github.com/Seldaek", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/monolog/monolog", + "type": "tidelift" + } + ], + "time": "2020-12-14T13:15:25+00:00" + }, + { + "name": "nikic/php-parser", + "version": "v4.10.4", + "source": { + "type": "git", + "url": "https://github.com/nikic/PHP-Parser.git", + "reference": "c6d052fc58cb876152f89f532b95a8d7907e7f0e" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/nikic/PHP-Parser/zipball/c6d052fc58cb876152f89f532b95a8d7907e7f0e", + "reference": "c6d052fc58cb876152f89f532b95a8d7907e7f0e", + "shasum": "" + }, + "require": { + "ext-tokenizer": "*", + "php": ">=7.0" + }, + "require-dev": { + "ircmaxell/php-yacc": "^0.0.7", + "phpunit/phpunit": "^6.5 || ^7.0 || ^8.0 || ^9.0" + }, + "bin": [ + "bin/php-parse" + ], + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "4.9-dev" + } + }, + "autoload": { + "psr-4": { + "PhpParser\\": "lib/PhpParser" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Nikita Popov" + } + ], + "description": "A PHP parser written in PHP", + "keywords": [ + "parser", + "php" + ], + "support": { + "issues": "https://github.com/nikic/PHP-Parser/issues", + "source": "https://github.com/nikic/PHP-Parser/tree/v4.10.4" + }, + "time": "2020-12-20T10:01:03+00:00" + }, + { + "name": "phpdocumentor/flyfinder", + "version": "1.0.0", + "source": { + "type": "git", + "url": "https://github.com/phpDocumentor/FlyFinder.git", + "reference": "0443e747872cc4a4d8f4b830d16a0357c14df7a6" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/phpDocumentor/FlyFinder/zipball/0443e747872cc4a4d8f4b830d16a0357c14df7a6", + "reference": "0443e747872cc4a4d8f4b830d16a0357c14df7a6", + "shasum": "" + }, + "require": { + "league/flysystem": "^1.0", + "php": "^7.2" + }, + "require-dev": { + "league/flysystem-memory": "~1", + "mockery/mockery": "^1.3" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.x-dev" + } + }, + "autoload": { + "psr-4": { + "Flyfinder\\": [ + "src/" + ] + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "description": "Flysystem plugin to add file finding capabilities to the Filesystem entity", + "homepage": "http://www.phpdoc.org", + "keywords": [ + "Flysystem", + "phpdoc" + ], + "support": { + "issues": "https://github.com/phpDocumentor/FlyFinder/issues", + "source": "https://github.com/phpDocumentor/FlyFinder/tree/1.0.0" + }, + "time": "2020-03-13T14:02:28+00:00" + }, + { + "name": "phpdocumentor/graphviz", + "version": "2.0.0", + "source": { + "type": "git", + "url": "https://github.com/phpDocumentor/GraphViz.git", + "reference": "929e97b4ab6765fc4eb2f944b091a4a02807ee5d" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/phpDocumentor/GraphViz/zipball/929e97b4ab6765fc4eb2f944b091a4a02807ee5d", + "reference": "929e97b4ab6765fc4eb2f944b091a4a02807ee5d", + "shasum": "" + }, + "require": { + "php": "^7.2 || 8.0.*" + }, + "require-dev": { + "ext-simplexml": "*", + "mockery/mockery": "^1.2", + "phpstan/phpstan": "^0.12", + "phpunit/phpunit": "^8.2 || ^9.2" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "2.x-dev" + } + }, + "autoload": { + "psr-4": { + "phpDocumentor\\GraphViz\\": "src/phpDocumentor/GraphViz", + "phpDocumentor\\GraphViz\\PHPStan\\": "./src/phpDocumentor/PHPStan" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Mike van Riel", + "email": "mike.vanriel@naenius.com" + } + ], + "description": "Wrapper for Graphviz", + "support": { + "issues": "https://github.com/phpDocumentor/GraphViz/issues", + "source": "https://github.com/phpDocumentor/GraphViz/tree/2.0.0" + }, + "time": "2021-02-02T20:48:43+00:00" + }, + { + "name": "phpdocumentor/phpdocumentor", + "version": "v3.0.0", + "source": { + "type": "git", + "url": "https://github.com/phpDocumentor/phpDocumentor.git", + "reference": "405da431bdc7ca02512cb6aa15f4ed43ffca8175" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/phpDocumentor/phpDocumentor/zipball/405da431bdc7ca02512cb6aa15f4ed43ffca8175", + "reference": "405da431bdc7ca02512cb6aa15f4ed43ffca8175", + "shasum": "" + }, + "require": { + "doctrine/event-manager": "^1.1", + "ext-ctype": "*", + "ext-hash": "*", + "ext-iconv": "*", + "ext-json": "*", + "ext-mbstring": "*", + "ext-simplexml": "*", + "ext-xml": "*", + "jawira/plantuml": "^1.27", + "jean85/pretty-package-versions": "^1.2", + "league/commonmark": "^1.5", + "league/flysystem": "^1.0", + "league/pipeline": "^1.0", + "league/tactician": "^1.0", + "league/tactician-bundle": "^1.2", + "league/uri": "^6.0", + "league/uri-interfaces": "^2.0", + "php": ">=7.2.5", + "phpdocumentor/flyfinder": "^1.0", + "phpdocumentor/graphviz": "^2.0@dev", + "phpdocumentor/reflection": "^4.0", + "phpdocumentor/reflection-common": "^2.0", + "phpdocumentor/reflection-docblock": "^5.0", + "phpdocumentor/type-resolver": "^1.0", + "psr/cache": "^1.0", + "psr/log": "^1.1", + "scrivo/highlight.php": "^9.17", + "symfony/cache": "^5.0", + "symfony/config": "^5.0", + "symfony/console": "^5.0", + "symfony/contracts": "^2.0", + "symfony/dependency-injection": "^5.0", + "symfony/dom-crawler": "5.1.*", + "symfony/dotenv": "^5.0", + "symfony/event-dispatcher": "^5.0", + "symfony/expression-language": "^5.0", + "symfony/filesystem": "^5.0", + "symfony/finder": "5.1.*", + "symfony/flex": "^1.3.1", + "symfony/framework-bundle": "^5.0", + "symfony/http-foundation": "^5.0.7", + "symfony/http-kernel": "^5.0.8", + "symfony/monolog-bundle": "^3.0", + "symfony/process": "5.1.*", + "symfony/proxy-manager-bridge": "^5.0", + "symfony/routing": "^5.0", + "symfony/stopwatch": "^5.0", + "symfony/string": "5.1.*", + "symfony/yaml": "^5.0", + "twig/twig": "~2.0", + "webmozart/assert": "^1.3" + }, + "conflict": { + "symfony/symfony": "*" + }, + "replace": { + "paragonie/random_compat": "2.*", + "symfony/polyfill-iconv": "*", + "symfony/polyfill-php56": "*", + "symfony/polyfill-php70": "*", + "symfony/polyfill-php71": "*", + "symfony/polyfill-php72": "*" + }, + "require-dev": { + "fzaninotto/faker": "^1.9", + "mikey179/vfsstream": "^1.2", + "mockery/mockery": "^1.0" + }, + "bin": [ + "bin/phpdoc.php", + "bin/phpdoc" + ], + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "3.0-dev" + }, + "symfony": { + "id": "01C32VS9393M1CP9R8TEJMH62G", + "allow-contrib": false, + "require": "^5.0" + } + }, + "autoload": { + "psr-4": { + "phpDocumentor\\Guides\\": "src/Guides/", + "phpDocumentor\\": [ + "src/phpDocumentor/" + ] + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "description": "Documentation Generator for PHP", + "homepage": "https://www.phpdoc.org", + "keywords": [ + "api", + "application", + "dga", + "documentation", + "phpdoc" + ], + "support": { + "issues": "https://github.com/phpDocumentor/phpDocumentor/issues", + "source": "https://github.com/phpDocumentor/phpDocumentor/tree/v3.0.0" + }, + "time": "2020-10-27T20:24:27+00:00" + }, + { + "name": "phpdocumentor/reflection", + "version": "4.0.1", + "source": { + "type": "git", + "url": "https://github.com/phpDocumentor/Reflection.git", + "reference": "447928a45710d6313e68774cf12b5f730b909baa" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/phpDocumentor/Reflection/zipball/447928a45710d6313e68774cf12b5f730b909baa", + "reference": "447928a45710d6313e68774cf12b5f730b909baa", + "shasum": "" + }, + "require": { + "nikic/php-parser": "^4.0", + "php": ">=7.2", + "phpdocumentor/reflection-common": "^2.0", + "phpdocumentor/reflection-docblock": "^5", + "phpdocumentor/type-resolver": "^1.0", + "psr/log": "~1.0", + "webmozart/assert": "^1.0" + }, + "require-dev": { + "mikey179/vfsstream": "~1.2", + "mockery/mockery": "~1.0" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-4.x": "4.1.x-dev" + } + }, + "autoload": { + "psr-4": { + "phpDocumentor\\": "src/phpDocumentor" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "description": "Reflection library to do Static Analysis for PHP Projects", + "homepage": "http://www.phpdoc.org", + "keywords": [ + "phpDocumentor", + "phpdoc", + "reflection", + "static analysis" + ], + "support": { + "issues": "https://github.com/phpDocumentor/Reflection/issues", + "source": "https://github.com/phpDocumentor/Reflection/tree/4.x" + }, + "time": "2020-06-19T18:26:14+00:00" + }, + { + "name": "phpdocumentor/reflection-common", + "version": "2.2.0", + "source": { + "type": "git", + "url": "https://github.com/phpDocumentor/ReflectionCommon.git", + "reference": "1d01c49d4ed62f25aa84a747ad35d5a16924662b" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/phpDocumentor/ReflectionCommon/zipball/1d01c49d4ed62f25aa84a747ad35d5a16924662b", + "reference": "1d01c49d4ed62f25aa84a747ad35d5a16924662b", + "shasum": "" + }, + "require": { + "php": "^7.2 || ^8.0" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-2.x": "2.x-dev" + } + }, + "autoload": { + "psr-4": { + "phpDocumentor\\Reflection\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Jaap van Otterdijk", + "email": "opensource@ijaap.nl" + } + ], + "description": "Common reflection classes used by phpdocumentor to reflect the code structure", + "homepage": "http://www.phpdoc.org", + "keywords": [ + "FQSEN", + "phpDocumentor", + "phpdoc", + "reflection", + "static analysis" + ], + "support": { + "issues": "https://github.com/phpDocumentor/ReflectionCommon/issues", + "source": "https://github.com/phpDocumentor/ReflectionCommon/tree/2.x" + }, + "time": "2020-06-27T09:03:43+00:00" + }, + { + "name": "phpdocumentor/reflection-docblock", + "version": "5.2.2", + "source": { + "type": "git", + "url": "https://github.com/phpDocumentor/ReflectionDocBlock.git", + "reference": "069a785b2141f5bcf49f3e353548dc1cce6df556" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/phpDocumentor/ReflectionDocBlock/zipball/069a785b2141f5bcf49f3e353548dc1cce6df556", + "reference": "069a785b2141f5bcf49f3e353548dc1cce6df556", + "shasum": "" + }, + "require": { + "ext-filter": "*", + "php": "^7.2 || ^8.0", + "phpdocumentor/reflection-common": "^2.2", + "phpdocumentor/type-resolver": "^1.3", + "webmozart/assert": "^1.9.1" + }, + "require-dev": { + "mockery/mockery": "~1.3.2" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "5.x-dev" + } + }, + "autoload": { + "psr-4": { + "phpDocumentor\\Reflection\\": "src" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Mike van Riel", + "email": "me@mikevanriel.com" + }, + { + "name": "Jaap van Otterdijk", + "email": "account@ijaap.nl" + } + ], + "description": "With this component, a library can provide support for annotations via DocBlocks or otherwise retrieve information that is embedded in a DocBlock.", + "support": { + "issues": "https://github.com/phpDocumentor/ReflectionDocBlock/issues", + "source": "https://github.com/phpDocumentor/ReflectionDocBlock/tree/master" + }, + "time": "2020-09-03T19:13:55+00:00" + }, + { + "name": "phpdocumentor/type-resolver", + "version": "1.4.0", + "source": { + "type": "git", + "url": "https://github.com/phpDocumentor/TypeResolver.git", + "reference": "6a467b8989322d92aa1c8bf2bebcc6e5c2ba55c0" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/phpDocumentor/TypeResolver/zipball/6a467b8989322d92aa1c8bf2bebcc6e5c2ba55c0", + "reference": "6a467b8989322d92aa1c8bf2bebcc6e5c2ba55c0", + "shasum": "" + }, + "require": { + "php": "^7.2 || ^8.0", + "phpdocumentor/reflection-common": "^2.0" + }, + "require-dev": { + "ext-tokenizer": "*" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-1.x": "1.x-dev" + } + }, + "autoload": { + "psr-4": { + "phpDocumentor\\Reflection\\": "src" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Mike van Riel", + "email": "me@mikevanriel.com" + } + ], + "description": "A PSR-5 based resolver of Class names, Types and Structural Element Names", + "support": { + "issues": "https://github.com/phpDocumentor/TypeResolver/issues", + "source": "https://github.com/phpDocumentor/TypeResolver/tree/1.4.0" + }, + "time": "2020-09-17T18:55:26+00:00" + }, + { + "name": "psr/cache", + "version": "1.0.1", + "source": { + "type": "git", + "url": "https://github.com/php-fig/cache.git", + "reference": "d11b50ad223250cf17b86e38383413f5a6764bf8" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/php-fig/cache/zipball/d11b50ad223250cf17b86e38383413f5a6764bf8", + "reference": "d11b50ad223250cf17b86e38383413f5a6764bf8", + "shasum": "" + }, + "require": { + "php": ">=5.3.0" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.0.x-dev" + } + }, + "autoload": { + "psr-4": { + "Psr\\Cache\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "PHP-FIG", + "homepage": "http://www.php-fig.org/" + } + ], + "description": "Common interface for caching libraries", + "keywords": [ + "cache", + "psr", + "psr-6" + ], + "support": { + "source": "https://github.com/php-fig/cache/tree/master" + }, + "time": "2016-08-06T20:24:11+00:00" + }, + { + "name": "psr/container", + "version": "1.1.1", + "source": { + "type": "git", + "url": "https://github.com/php-fig/container.git", + "reference": "8622567409010282b7aeebe4bb841fe98b58dcaf" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/php-fig/container/zipball/8622567409010282b7aeebe4bb841fe98b58dcaf", + "reference": "8622567409010282b7aeebe4bb841fe98b58dcaf", + "shasum": "" + }, + "require": { + "php": ">=7.2.0" + }, + "type": "library", + "autoload": { + "psr-4": { + "Psr\\Container\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "PHP-FIG", + "homepage": "https://www.php-fig.org/" + } + ], + "description": "Common Container Interface (PHP FIG PSR-11)", + "homepage": "https://github.com/php-fig/container", + "keywords": [ + "PSR-11", + "container", + "container-interface", + "container-interop", + "psr" + ], + "support": { + "issues": "https://github.com/php-fig/container/issues", + "source": "https://github.com/php-fig/container/tree/1.1.1" + }, + "time": "2021-03-05T17:36:06+00:00" + }, + { + "name": "psr/event-dispatcher", + "version": "1.0.0", + "source": { + "type": "git", + "url": "https://github.com/php-fig/event-dispatcher.git", + "reference": "dbefd12671e8a14ec7f180cab83036ed26714bb0" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/php-fig/event-dispatcher/zipball/dbefd12671e8a14ec7f180cab83036ed26714bb0", + "reference": "dbefd12671e8a14ec7f180cab83036ed26714bb0", + "shasum": "" + }, + "require": { + "php": ">=7.2.0" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.0.x-dev" + } + }, + "autoload": { + "psr-4": { + "Psr\\EventDispatcher\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "PHP-FIG", + "homepage": "http://www.php-fig.org/" + } + ], + "description": "Standard interfaces for event handling.", + "keywords": [ + "events", + "psr", + "psr-14" + ], + "support": { + "issues": "https://github.com/php-fig/event-dispatcher/issues", + "source": "https://github.com/php-fig/event-dispatcher/tree/1.0.0" + }, + "time": "2019-01-08T18:20:26+00:00" + }, + { + "name": "psr/http-message", + "version": "1.0.1", + "source": { + "type": "git", + "url": "https://github.com/php-fig/http-message.git", + "reference": "f6561bf28d520154e4b0ec72be95418abe6d9363" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/php-fig/http-message/zipball/f6561bf28d520154e4b0ec72be95418abe6d9363", + "reference": "f6561bf28d520154e4b0ec72be95418abe6d9363", + "shasum": "" + }, + "require": { + "php": ">=5.3.0" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.0.x-dev" + } + }, + "autoload": { + "psr-4": { + "Psr\\Http\\Message\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "PHP-FIG", + "homepage": "http://www.php-fig.org/" + } + ], + "description": "Common interface for HTTP messages", + "homepage": "https://github.com/php-fig/http-message", + "keywords": [ + "http", + "http-message", + "psr", + "psr-7", + "request", + "response" + ], + "support": { + "source": "https://github.com/php-fig/http-message/tree/master" + }, + "time": "2016-08-06T14:39:51+00:00" + }, + { + "name": "psr/log", + "version": "1.1.3", + "source": { + "type": "git", + "url": "https://github.com/php-fig/log.git", + "reference": "0f73288fd15629204f9d42b7055f72dacbe811fc" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/php-fig/log/zipball/0f73288fd15629204f9d42b7055f72dacbe811fc", + "reference": "0f73288fd15629204f9d42b7055f72dacbe811fc", + "shasum": "" + }, + "require": { + "php": ">=5.3.0" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.1.x-dev" + } + }, + "autoload": { + "psr-4": { + "Psr\\Log\\": "Psr/Log/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "PHP-FIG", + "homepage": "http://www.php-fig.org/" + } + ], + "description": "Common interface for logging libraries", + "homepage": "https://github.com/php-fig/log", + "keywords": [ + "log", + "psr", + "psr-3" + ], + "support": { + "source": "https://github.com/php-fig/log/tree/1.1.3" + }, + "time": "2020-03-23T09:12:05+00:00" + }, + { + "name": "scrivo/highlight.php", + "version": "v9.18.1.6", + "source": { + "type": "git", + "url": "https://github.com/scrivo/highlight.php.git", + "reference": "44a3d4136edb5ad8551590bf90f437db80b2d466" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/scrivo/highlight.php/zipball/44a3d4136edb5ad8551590bf90f437db80b2d466", + "reference": "44a3d4136edb5ad8551590bf90f437db80b2d466", + "shasum": "" + }, + "require": { + "ext-json": "*", + "ext-mbstring": "*", + "php": ">=5.4" + }, + "require-dev": { + "phpunit/phpunit": "^4.8|^5.7", + "sabberworm/php-css-parser": "^8.3", + "symfony/finder": "^2.8|^3.4", + "symfony/var-dumper": "^2.8|^3.4" + }, + "type": "library", + "autoload": { + "psr-0": { + "Highlight\\": "", + "HighlightUtilities\\": "" + }, + "files": [ + "HighlightUtilities/functions.php" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Geert Bergman", + "homepage": "http://www.scrivo.org/", + "role": "Project Author" + }, + { + "name": "Vladimir Jimenez", + "homepage": "https://allejo.io", + "role": "Maintainer" + }, + { + "name": "Martin Folkers", + "homepage": "https://twobrain.io", + "role": "Contributor" + } + ], + "description": "Server side syntax highlighter that supports 185 languages. It's a PHP port of highlight.js", + "keywords": [ + "code", + "highlight", + "highlight.js", + "highlight.php", + "syntax" + ], + "support": { + "issues": "https://github.com/scrivo/highlight.php/issues", + "source": "https://github.com/scrivo/highlight.php" + }, + "funding": [ + { + "url": "https://github.com/allejo", + "type": "github" + } + ], + "time": "2020-12-22T19:20:29+00:00" + }, + { + "name": "squizlabs/php_codesniffer", + "version": "3.6.0", + "source": { + "type": "git", + "url": "https://github.com/squizlabs/PHP_CodeSniffer.git", + "reference": "ffced0d2c8fa8e6cdc4d695a743271fab6c38625" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/squizlabs/PHP_CodeSniffer/zipball/ffced0d2c8fa8e6cdc4d695a743271fab6c38625", + "reference": "ffced0d2c8fa8e6cdc4d695a743271fab6c38625", "shasum": "" }, "require": { @@ -131,7 +2317,2736 @@ "source": "https://github.com/squizlabs/PHP_CodeSniffer", "wiki": "https://github.com/squizlabs/PHP_CodeSniffer/wiki" }, - "time": "2020-10-23T02:01:07+00:00" + "time": "2021-04-09T00:54:41+00:00" + }, + { + "name": "symfony/cache", + "version": "v5.2.6", + "source": { + "type": "git", + "url": "https://github.com/symfony/cache.git", + "reference": "093d69bb10c959553c8beb828b8d4ea250a247dd" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/cache/zipball/093d69bb10c959553c8beb828b8d4ea250a247dd", + "reference": "093d69bb10c959553c8beb828b8d4ea250a247dd", + "shasum": "" + }, + "require": { + "php": ">=7.2.5", + "psr/cache": "^1.0|^2.0", + "psr/log": "^1.1", + "symfony/cache-contracts": "^1.1.7|^2", + "symfony/polyfill-php80": "^1.15", + "symfony/service-contracts": "^1.1|^2", + "symfony/var-exporter": "^4.4|^5.0" + }, + "conflict": { + "doctrine/dbal": "<2.10", + "symfony/dependency-injection": "<4.4", + "symfony/http-kernel": "<4.4", + "symfony/var-dumper": "<4.4" + }, + "provide": { + "psr/cache-implementation": "1.0|2.0", + "psr/simple-cache-implementation": "1.0", + "symfony/cache-implementation": "1.0|2.0" + }, + "require-dev": { + "cache/integration-tests": "dev-master", + "doctrine/cache": "^1.6", + "doctrine/dbal": "^2.10|^3.0", + "predis/predis": "^1.1", + "psr/simple-cache": "^1.0", + "symfony/config": "^4.4|^5.0", + "symfony/dependency-injection": "^4.4|^5.0", + "symfony/filesystem": "^4.4|^5.0", + "symfony/http-kernel": "^4.4|^5.0", + "symfony/messenger": "^4.4|^5.0", + "symfony/var-dumper": "^4.4|^5.0" + }, + "type": "library", + "autoload": { + "psr-4": { + "Symfony\\Component\\Cache\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Nicolas Grekas", + "email": "p@tchwork.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Provides an extended PSR-6, PSR-16 (and tags) implementation", + "homepage": "https://symfony.com", + "keywords": [ + "caching", + "psr6" + ], + "support": { + "source": "https://github.com/symfony/cache/tree/v5.2.6" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-03-16T09:10:13+00:00" + }, + { + "name": "symfony/config", + "version": "v5.2.4", + "source": { + "type": "git", + "url": "https://github.com/symfony/config.git", + "reference": "212d54675bf203ff8aef7d8cee8eecfb72f4a263" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/config/zipball/212d54675bf203ff8aef7d8cee8eecfb72f4a263", + "reference": "212d54675bf203ff8aef7d8cee8eecfb72f4a263", + "shasum": "" + }, + "require": { + "php": ">=7.2.5", + "symfony/deprecation-contracts": "^2.1", + "symfony/filesystem": "^4.4|^5.0", + "symfony/polyfill-ctype": "~1.8", + "symfony/polyfill-php80": "^1.15" + }, + "conflict": { + "symfony/finder": "<4.4" + }, + "require-dev": { + "symfony/event-dispatcher": "^4.4|^5.0", + "symfony/finder": "^4.4|^5.0", + "symfony/messenger": "^4.4|^5.0", + "symfony/service-contracts": "^1.1|^2", + "symfony/yaml": "^4.4|^5.0" + }, + "suggest": { + "symfony/yaml": "To use the yaml reference dumper" + }, + "type": "library", + "autoload": { + "psr-4": { + "Symfony\\Component\\Config\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Helps you find, load, combine, autofill and validate configuration values of any kind", + "homepage": "https://symfony.com", + "support": { + "source": "https://github.com/symfony/config/tree/v5.2.4" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-02-23T23:58:19+00:00" + }, + { + "name": "symfony/console", + "version": "v5.2.6", + "source": { + "type": "git", + "url": "https://github.com/symfony/console.git", + "reference": "35f039df40a3b335ebf310f244cb242b3a83ac8d" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/console/zipball/35f039df40a3b335ebf310f244cb242b3a83ac8d", + "reference": "35f039df40a3b335ebf310f244cb242b3a83ac8d", + "shasum": "" + }, + "require": { + "php": ">=7.2.5", + "symfony/polyfill-mbstring": "~1.0", + "symfony/polyfill-php73": "^1.8", + "symfony/polyfill-php80": "^1.15", + "symfony/service-contracts": "^1.1|^2", + "symfony/string": "^5.1" + }, + "conflict": { + "symfony/dependency-injection": "<4.4", + "symfony/dotenv": "<5.1", + "symfony/event-dispatcher": "<4.4", + "symfony/lock": "<4.4", + "symfony/process": "<4.4" + }, + "provide": { + "psr/log-implementation": "1.0" + }, + "require-dev": { + "psr/log": "~1.0", + "symfony/config": "^4.4|^5.0", + "symfony/dependency-injection": "^4.4|^5.0", + "symfony/event-dispatcher": "^4.4|^5.0", + "symfony/lock": "^4.4|^5.0", + "symfony/process": "^4.4|^5.0", + "symfony/var-dumper": "^4.4|^5.0" + }, + "suggest": { + "psr/log": "For using the console logger", + "symfony/event-dispatcher": "", + "symfony/lock": "", + "symfony/process": "" + }, + "type": "library", + "autoload": { + "psr-4": { + "Symfony\\Component\\Console\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Eases the creation of beautiful and testable command line interfaces", + "homepage": "https://symfony.com", + "keywords": [ + "cli", + "command line", + "console", + "terminal" + ], + "support": { + "source": "https://github.com/symfony/console/tree/v5.2.6" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-03-28T09:42:18+00:00" + }, + { + "name": "symfony/contracts", + "version": "v2.3.1", + "source": { + "type": "git", + "url": "https://github.com/symfony/contracts.git", + "reference": "f7783bdec14b06c323d30a5f74ba70a17ec0ce81" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/contracts/zipball/f7783bdec14b06c323d30a5f74ba70a17ec0ce81", + "reference": "f7783bdec14b06c323d30a5f74ba70a17ec0ce81", + "shasum": "" + }, + "require": { + "php": ">=7.2.5", + "psr/cache": "^1.0", + "psr/container": "^1.0", + "psr/event-dispatcher": "^1.0" + }, + "replace": { + "symfony/cache-contracts": "self.version", + "symfony/deprecation-contracts": "self.version", + "symfony/event-dispatcher-contracts": "self.version", + "symfony/http-client-contracts": "self.version", + "symfony/service-contracts": "self.version", + "symfony/translation-contracts": "self.version" + }, + "require-dev": { + "symfony/polyfill-intl-idn": "^1.10" + }, + "suggest": { + "symfony/cache-implementation": "", + "symfony/event-dispatcher-implementation": "", + "symfony/http-client-implementation": "", + "symfony/service-implementation": "", + "symfony/translation-implementation": "" + }, + "type": "library", + "extra": { + "branch-version": "2.3", + "branch-alias": { + "dev-main": "2.3-dev" + } + }, + "autoload": { + "psr-4": { + "Symfony\\Contracts\\": "" + }, + "files": [ + "Deprecation/function.php" + ], + "exclude-from-classmap": [ + "**/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Nicolas Grekas", + "email": "p@tchwork.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "A set of abstractions extracted out of the Symfony components", + "homepage": "https://symfony.com", + "keywords": [ + "abstractions", + "contracts", + "decoupling", + "interfaces", + "interoperability", + "standards" + ], + "support": { + "source": "https://github.com/symfony/contracts/tree/v2.3.1" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2020-10-14T17:08:19+00:00" + }, + { + "name": "symfony/dependency-injection", + "version": "v5.2.6", + "source": { + "type": "git", + "url": "https://github.com/symfony/dependency-injection.git", + "reference": "1e66194bed2a69fa395d26bf1067e5e34483afac" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/dependency-injection/zipball/1e66194bed2a69fa395d26bf1067e5e34483afac", + "reference": "1e66194bed2a69fa395d26bf1067e5e34483afac", + "shasum": "" + }, + "require": { + "php": ">=7.2.5", + "psr/container": "^1.0", + "symfony/deprecation-contracts": "^2.1", + "symfony/polyfill-php80": "^1.15", + "symfony/service-contracts": "^1.1.6|^2" + }, + "conflict": { + "symfony/config": "<5.1", + "symfony/finder": "<4.4", + "symfony/proxy-manager-bridge": "<4.4", + "symfony/yaml": "<4.4" + }, + "provide": { + "psr/container-implementation": "1.0", + "symfony/service-implementation": "1.0|2.0" + }, + "require-dev": { + "symfony/config": "^5.1", + "symfony/expression-language": "^4.4|^5.0", + "symfony/yaml": "^4.4|^5.0" + }, + "suggest": { + "symfony/config": "", + "symfony/expression-language": "For using expressions in service container configuration", + "symfony/finder": "For using double-star glob patterns or when GLOB_BRACE portability is required", + "symfony/proxy-manager-bridge": "Generate service proxies to lazy load them", + "symfony/yaml": "" + }, + "type": "library", + "autoload": { + "psr-4": { + "Symfony\\Component\\DependencyInjection\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Allows you to standardize and centralize the way objects are constructed in your application", + "homepage": "https://symfony.com", + "support": { + "source": "https://github.com/symfony/dependency-injection/tree/v5.2.6" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-03-22T11:10:24+00:00" + }, + { + "name": "symfony/dom-crawler", + "version": "v5.1.11", + "source": { + "type": "git", + "url": "https://github.com/symfony/dom-crawler.git", + "reference": "5d89ceb53ec65e1973a555072fac8ed5ecad3384" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/dom-crawler/zipball/5d89ceb53ec65e1973a555072fac8ed5ecad3384", + "reference": "5d89ceb53ec65e1973a555072fac8ed5ecad3384", + "shasum": "" + }, + "require": { + "php": ">=7.2.5", + "symfony/polyfill-ctype": "~1.8", + "symfony/polyfill-mbstring": "~1.0", + "symfony/polyfill-php80": "^1.15" + }, + "conflict": { + "masterminds/html5": "<2.6" + }, + "require-dev": { + "masterminds/html5": "^2.6", + "symfony/css-selector": "^4.4|^5.0" + }, + "suggest": { + "symfony/css-selector": "" + }, + "type": "library", + "autoload": { + "psr-4": { + "Symfony\\Component\\DomCrawler\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Eases DOM navigation for HTML and XML documents", + "homepage": "https://symfony.com", + "support": { + "source": "https://github.com/symfony/dom-crawler/tree/v5.1.11" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-01-27T10:01:46+00:00" + }, + { + "name": "symfony/dotenv", + "version": "v5.2.4", + "source": { + "type": "git", + "url": "https://github.com/symfony/dotenv.git", + "reference": "783f12027c6b40ab0e93d6136d9f642d1d67cd6b" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/dotenv/zipball/783f12027c6b40ab0e93d6136d9f642d1d67cd6b", + "reference": "783f12027c6b40ab0e93d6136d9f642d1d67cd6b", + "shasum": "" + }, + "require": { + "php": ">=7.2.5", + "symfony/deprecation-contracts": "^2.1" + }, + "require-dev": { + "symfony/process": "^4.4|^5.0" + }, + "type": "library", + "autoload": { + "psr-4": { + "Symfony\\Component\\Dotenv\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Registers environment variables from a .env file", + "homepage": "https://symfony.com", + "keywords": [ + "dotenv", + "env", + "environment" + ], + "support": { + "source": "https://github.com/symfony/dotenv/tree/v5.2.4" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-01-27T10:01:46+00:00" + }, + { + "name": "symfony/error-handler", + "version": "v5.2.6", + "source": { + "type": "git", + "url": "https://github.com/symfony/error-handler.git", + "reference": "bdb7fb4188da7f4211e4b88350ba0dfdad002b03" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/error-handler/zipball/bdb7fb4188da7f4211e4b88350ba0dfdad002b03", + "reference": "bdb7fb4188da7f4211e4b88350ba0dfdad002b03", + "shasum": "" + }, + "require": { + "php": ">=7.2.5", + "psr/log": "^1.0", + "symfony/polyfill-php80": "^1.15", + "symfony/var-dumper": "^4.4|^5.0" + }, + "require-dev": { + "symfony/deprecation-contracts": "^2.1", + "symfony/http-kernel": "^4.4|^5.0", + "symfony/serializer": "^4.4|^5.0" + }, + "type": "library", + "autoload": { + "psr-4": { + "Symfony\\Component\\ErrorHandler\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Provides tools to manage errors and ease debugging PHP code", + "homepage": "https://symfony.com", + "support": { + "source": "https://github.com/symfony/error-handler/tree/v5.2.6" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-03-16T09:07:47+00:00" + }, + { + "name": "symfony/event-dispatcher", + "version": "v5.2.4", + "source": { + "type": "git", + "url": "https://github.com/symfony/event-dispatcher.git", + "reference": "d08d6ec121a425897951900ab692b612a61d6240" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/event-dispatcher/zipball/d08d6ec121a425897951900ab692b612a61d6240", + "reference": "d08d6ec121a425897951900ab692b612a61d6240", + "shasum": "" + }, + "require": { + "php": ">=7.2.5", + "symfony/deprecation-contracts": "^2.1", + "symfony/event-dispatcher-contracts": "^2", + "symfony/polyfill-php80": "^1.15" + }, + "conflict": { + "symfony/dependency-injection": "<4.4" + }, + "provide": { + "psr/event-dispatcher-implementation": "1.0", + "symfony/event-dispatcher-implementation": "2.0" + }, + "require-dev": { + "psr/log": "~1.0", + "symfony/config": "^4.4|^5.0", + "symfony/dependency-injection": "^4.4|^5.0", + "symfony/error-handler": "^4.4|^5.0", + "symfony/expression-language": "^4.4|^5.0", + "symfony/http-foundation": "^4.4|^5.0", + "symfony/service-contracts": "^1.1|^2", + "symfony/stopwatch": "^4.4|^5.0" + }, + "suggest": { + "symfony/dependency-injection": "", + "symfony/http-kernel": "" + }, + "type": "library", + "autoload": { + "psr-4": { + "Symfony\\Component\\EventDispatcher\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Provides tools that allow your application components to communicate with each other by dispatching events and listening to them", + "homepage": "https://symfony.com", + "support": { + "source": "https://github.com/symfony/event-dispatcher/tree/v5.2.4" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-02-18T17:12:37+00:00" + }, + { + "name": "symfony/expression-language", + "version": "v5.2.4", + "source": { + "type": "git", + "url": "https://github.com/symfony/expression-language.git", + "reference": "3fc560e62bc5121751b792b11505db03a12cf83c" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/expression-language/zipball/3fc560e62bc5121751b792b11505db03a12cf83c", + "reference": "3fc560e62bc5121751b792b11505db03a12cf83c", + "shasum": "" + }, + "require": { + "php": ">=7.2.5", + "symfony/cache": "^4.4|^5.0", + "symfony/polyfill-php80": "^1.15", + "symfony/service-contracts": "^1.1|^2" + }, + "type": "library", + "autoload": { + "psr-4": { + "Symfony\\Component\\ExpressionLanguage\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Provides an engine that can compile and evaluate expressions", + "homepage": "https://symfony.com", + "support": { + "source": "https://github.com/symfony/expression-language/tree/v5.2.4" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-02-12T10:38:38+00:00" + }, + { + "name": "symfony/filesystem", + "version": "v5.2.6", + "source": { + "type": "git", + "url": "https://github.com/symfony/filesystem.git", + "reference": "8c86a82f51658188119e62cff0a050a12d09836f" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/filesystem/zipball/8c86a82f51658188119e62cff0a050a12d09836f", + "reference": "8c86a82f51658188119e62cff0a050a12d09836f", + "shasum": "" + }, + "require": { + "php": ">=7.2.5", + "symfony/polyfill-ctype": "~1.8" + }, + "type": "library", + "autoload": { + "psr-4": { + "Symfony\\Component\\Filesystem\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Provides basic utilities for the filesystem", + "homepage": "https://symfony.com", + "support": { + "source": "https://github.com/symfony/filesystem/tree/v5.2.6" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-03-28T14:30:26+00:00" + }, + { + "name": "symfony/finder", + "version": "v5.1.11", + "source": { + "type": "git", + "url": "https://github.com/symfony/finder.git", + "reference": "196f45723b5e618bf0e23b97e96d11652696ea9e" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/finder/zipball/196f45723b5e618bf0e23b97e96d11652696ea9e", + "reference": "196f45723b5e618bf0e23b97e96d11652696ea9e", + "shasum": "" + }, + "require": { + "php": ">=7.2.5" + }, + "type": "library", + "autoload": { + "psr-4": { + "Symfony\\Component\\Finder\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Finds files and directories via an intuitive fluent interface", + "homepage": "https://symfony.com", + "support": { + "source": "https://github.com/symfony/finder/tree/v5.1.11" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-01-27T10:01:46+00:00" + }, + { + "name": "symfony/flex", + "version": "v1.12.2", + "source": { + "type": "git", + "url": "https://github.com/symfony/flex.git", + "reference": "e472606b4b3173564f0edbca8f5d32b52fc4f2c9" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/flex/zipball/e472606b4b3173564f0edbca8f5d32b52fc4f2c9", + "reference": "e472606b4b3173564f0edbca8f5d32b52fc4f2c9", + "shasum": "" + }, + "require": { + "composer-plugin-api": "^1.0|^2.0", + "php": ">=7.1" + }, + "require-dev": { + "composer/composer": "^1.0.2|^2.0", + "symfony/dotenv": "^4.4|^5.0", + "symfony/filesystem": "^4.4|^5.0", + "symfony/phpunit-bridge": "^4.4|^5.0", + "symfony/process": "^3.4|^4.4|^5.0" + }, + "type": "composer-plugin", + "extra": { + "branch-alias": { + "dev-main": "1.12-dev" + }, + "class": "Symfony\\Flex\\Flex" + }, + "autoload": { + "psr-4": { + "Symfony\\Flex\\": "src" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien.potencier@gmail.com" + } + ], + "description": "Composer plugin for Symfony", + "support": { + "issues": "https://github.com/symfony/flex/issues", + "source": "https://github.com/symfony/flex/tree/v1.12.2" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-02-16T14:05:05+00:00" + }, + { + "name": "symfony/framework-bundle", + "version": "v5.2.6", + "source": { + "type": "git", + "url": "https://github.com/symfony/framework-bundle.git", + "reference": "8889da18c6faa76c6149a90e6542be4afe723f2f" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/framework-bundle/zipball/8889da18c6faa76c6149a90e6542be4afe723f2f", + "reference": "8889da18c6faa76c6149a90e6542be4afe723f2f", + "shasum": "" + }, + "require": { + "ext-xml": "*", + "php": ">=7.2.5", + "symfony/cache": "^5.2", + "symfony/config": "^5.0", + "symfony/dependency-injection": "^5.2", + "symfony/deprecation-contracts": "^2.1", + "symfony/error-handler": "^4.4.1|^5.0.1", + "symfony/event-dispatcher": "^5.1", + "symfony/filesystem": "^4.4|^5.0", + "symfony/finder": "^4.4|^5.0", + "symfony/http-foundation": "^5.2.1", + "symfony/http-kernel": "^5.2.1", + "symfony/polyfill-mbstring": "~1.0", + "symfony/polyfill-php80": "^1.15", + "symfony/routing": "^5.2" + }, + "conflict": { + "doctrine/persistence": "<1.3", + "phpdocumentor/reflection-docblock": "<3.2.2", + "phpdocumentor/type-resolver": "<1.4.0", + "phpunit/phpunit": "<5.4.3", + "symfony/asset": "<5.1", + "symfony/browser-kit": "<4.4", + "symfony/console": "<5.2.5", + "symfony/dom-crawler": "<4.4", + "symfony/dotenv": "<5.1", + "symfony/form": "<5.2", + "symfony/http-client": "<4.4", + "symfony/lock": "<4.4", + "symfony/mailer": "<5.2", + "symfony/messenger": "<4.4", + "symfony/mime": "<4.4", + "symfony/property-access": "<5.2", + "symfony/property-info": "<4.4", + "symfony/serializer": "<5.2", + "symfony/stopwatch": "<4.4", + "symfony/translation": "<5.0", + "symfony/twig-bridge": "<4.4", + "symfony/twig-bundle": "<4.4", + "symfony/validator": "<5.2", + "symfony/web-profiler-bundle": "<4.4", + "symfony/workflow": "<5.2" + }, + "require-dev": { + "doctrine/annotations": "^1.10.4", + "doctrine/cache": "~1.0", + "doctrine/persistence": "^1.3|^2.0", + "paragonie/sodium_compat": "^1.8", + "phpdocumentor/reflection-docblock": "^3.0|^4.0|^5.0", + "symfony/asset": "^5.1", + "symfony/browser-kit": "^4.4|^5.0", + "symfony/console": "^5.2", + "symfony/css-selector": "^4.4|^5.0", + "symfony/dom-crawler": "^4.4|^5.0", + "symfony/dotenv": "^5.1", + "symfony/expression-language": "^4.4|^5.0", + "symfony/form": "^5.2", + "symfony/http-client": "^4.4|^5.0", + "symfony/lock": "^4.4|^5.0", + "symfony/mailer": "^5.2", + "symfony/messenger": "^5.2", + "symfony/mime": "^4.4|^5.0", + "symfony/polyfill-intl-icu": "~1.0", + "symfony/process": "^4.4|^5.0", + "symfony/property-info": "^4.4|^5.0", + "symfony/security-bundle": "^5.1", + "symfony/security-core": "^4.4|^5.2", + "symfony/security-csrf": "^4.4|^5.0", + "symfony/security-http": "^4.4|^5.0", + "symfony/serializer": "^5.2", + "symfony/stopwatch": "^4.4|^5.0", + "symfony/string": "^5.0", + "symfony/translation": "^5.0", + "symfony/twig-bundle": "^4.4|^5.0", + "symfony/validator": "^5.2", + "symfony/web-link": "^4.4|^5.0", + "symfony/workflow": "^5.2", + "symfony/yaml": "^4.4|^5.0", + "twig/twig": "^2.10|^3.0" + }, + "suggest": { + "ext-apcu": "For best performance of the system caches", + "symfony/console": "For using the console commands", + "symfony/form": "For using forms", + "symfony/property-info": "For using the property_info service", + "symfony/serializer": "For using the serializer service", + "symfony/validator": "For using validation", + "symfony/web-link": "For using web links, features such as preloading, prefetching or prerendering", + "symfony/yaml": "For using the debug:config and lint:yaml commands" + }, + "type": "symfony-bundle", + "autoload": { + "psr-4": { + "Symfony\\Bundle\\FrameworkBundle\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Provides a tight integration between Symfony components and the Symfony full-stack framework", + "homepage": "https://symfony.com", + "support": { + "source": "https://github.com/symfony/framework-bundle/tree/v5.2.6" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-03-22T14:43:01+00:00" + }, + { + "name": "symfony/http-foundation", + "version": "v5.2.4", + "source": { + "type": "git", + "url": "https://github.com/symfony/http-foundation.git", + "reference": "54499baea7f7418bce7b5ec92770fd0799e8e9bf" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/http-foundation/zipball/54499baea7f7418bce7b5ec92770fd0799e8e9bf", + "reference": "54499baea7f7418bce7b5ec92770fd0799e8e9bf", + "shasum": "" + }, + "require": { + "php": ">=7.2.5", + "symfony/deprecation-contracts": "^2.1", + "symfony/polyfill-mbstring": "~1.1", + "symfony/polyfill-php80": "^1.15" + }, + "require-dev": { + "predis/predis": "~1.0", + "symfony/cache": "^4.4|^5.0", + "symfony/expression-language": "^4.4|^5.0", + "symfony/mime": "^4.4|^5.0" + }, + "suggest": { + "symfony/mime": "To use the file extension guesser" + }, + "type": "library", + "autoload": { + "psr-4": { + "Symfony\\Component\\HttpFoundation\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Defines an object-oriented layer for the HTTP specification", + "homepage": "https://symfony.com", + "support": { + "source": "https://github.com/symfony/http-foundation/tree/v5.2.4" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-02-25T17:16:57+00:00" + }, + { + "name": "symfony/http-kernel", + "version": "v5.2.6", + "source": { + "type": "git", + "url": "https://github.com/symfony/http-kernel.git", + "reference": "f34de4c61ca46df73857f7f36b9a3805bdd7e3b2" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/http-kernel/zipball/f34de4c61ca46df73857f7f36b9a3805bdd7e3b2", + "reference": "f34de4c61ca46df73857f7f36b9a3805bdd7e3b2", + "shasum": "" + }, + "require": { + "php": ">=7.2.5", + "psr/log": "~1.0", + "symfony/deprecation-contracts": "^2.1", + "symfony/error-handler": "^4.4|^5.0", + "symfony/event-dispatcher": "^5.0", + "symfony/http-client-contracts": "^1.1|^2", + "symfony/http-foundation": "^4.4|^5.0", + "symfony/polyfill-ctype": "^1.8", + "symfony/polyfill-php73": "^1.9", + "symfony/polyfill-php80": "^1.15" + }, + "conflict": { + "symfony/browser-kit": "<4.4", + "symfony/cache": "<5.0", + "symfony/config": "<5.0", + "symfony/console": "<4.4", + "symfony/dependency-injection": "<5.1.8", + "symfony/doctrine-bridge": "<5.0", + "symfony/form": "<5.0", + "symfony/http-client": "<5.0", + "symfony/mailer": "<5.0", + "symfony/messenger": "<5.0", + "symfony/translation": "<5.0", + "symfony/twig-bridge": "<5.0", + "symfony/validator": "<5.0", + "twig/twig": "<2.13" + }, + "provide": { + "psr/log-implementation": "1.0" + }, + "require-dev": { + "psr/cache": "^1.0|^2.0|^3.0", + "symfony/browser-kit": "^4.4|^5.0", + "symfony/config": "^5.0", + "symfony/console": "^4.4|^5.0", + "symfony/css-selector": "^4.4|^5.0", + "symfony/dependency-injection": "^5.1.8", + "symfony/dom-crawler": "^4.4|^5.0", + "symfony/expression-language": "^4.4|^5.0", + "symfony/finder": "^4.4|^5.0", + "symfony/process": "^4.4|^5.0", + "symfony/routing": "^4.4|^5.0", + "symfony/stopwatch": "^4.4|^5.0", + "symfony/translation": "^4.4|^5.0", + "symfony/translation-contracts": "^1.1|^2", + "twig/twig": "^2.13|^3.0.4" + }, + "suggest": { + "symfony/browser-kit": "", + "symfony/config": "", + "symfony/console": "", + "symfony/dependency-injection": "" + }, + "type": "library", + "autoload": { + "psr-4": { + "Symfony\\Component\\HttpKernel\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Provides a structured process for converting a Request into a Response", + "homepage": "https://symfony.com", + "support": { + "source": "https://github.com/symfony/http-kernel/tree/v5.2.6" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-03-29T05:16:58+00:00" + }, + { + "name": "symfony/monolog-bridge", + "version": "v5.2.5", + "source": { + "type": "git", + "url": "https://github.com/symfony/monolog-bridge.git", + "reference": "8a330ab86c4bdf3983b26abf64bf85574edf0d52" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/monolog-bridge/zipball/8a330ab86c4bdf3983b26abf64bf85574edf0d52", + "reference": "8a330ab86c4bdf3983b26abf64bf85574edf0d52", + "shasum": "" + }, + "require": { + "monolog/monolog": "^1.25.1|^2", + "php": ">=7.2.5", + "symfony/deprecation-contracts": "^2.1", + "symfony/http-kernel": "^4.4|^5.0", + "symfony/service-contracts": "^1.1|^2" + }, + "conflict": { + "symfony/console": "<4.4", + "symfony/http-foundation": "<4.4" + }, + "require-dev": { + "symfony/console": "^4.4|^5.0", + "symfony/http-client": "^4.4|^5.0", + "symfony/mailer": "^4.4|^5.0", + "symfony/mime": "^4.4|^5.0", + "symfony/security-core": "^4.4|^5.0", + "symfony/var-dumper": "^4.4|^5.0" + }, + "suggest": { + "symfony/console": "For the possibility to show log messages in console commands depending on verbosity settings.", + "symfony/http-kernel": "For using the debugging handlers together with the response life cycle of the HTTP kernel.", + "symfony/var-dumper": "For using the debugging handlers like the console handler or the log server handler." + }, + "type": "symfony-bridge", + "autoload": { + "psr-4": { + "Symfony\\Bridge\\Monolog\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Provides integration for Monolog with various Symfony components", + "homepage": "https://symfony.com", + "support": { + "source": "https://github.com/symfony/monolog-bridge/tree/v5.2.5" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-03-06T07:59:01+00:00" + }, + { + "name": "symfony/monolog-bundle", + "version": "v3.7.0", + "source": { + "type": "git", + "url": "https://github.com/symfony/monolog-bundle.git", + "reference": "4054b2e940a25195ae15f0a49ab0c51718922eb4" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/monolog-bundle/zipball/4054b2e940a25195ae15f0a49ab0c51718922eb4", + "reference": "4054b2e940a25195ae15f0a49ab0c51718922eb4", + "shasum": "" + }, + "require": { + "monolog/monolog": "~1.22 || ~2.0", + "php": ">=7.1.3", + "symfony/config": "~4.4 || ^5.0", + "symfony/dependency-injection": "^4.4 || ^5.0", + "symfony/http-kernel": "~4.4 || ^5.0", + "symfony/monolog-bridge": "~4.4 || ^5.0" + }, + "require-dev": { + "symfony/console": "~4.4 || ^5.0", + "symfony/phpunit-bridge": "^5.1", + "symfony/yaml": "~4.4 || ^5.0" + }, + "type": "symfony-bundle", + "extra": { + "branch-alias": { + "dev-master": "3.x-dev" + } + }, + "autoload": { + "psr-4": { + "Symfony\\Bundle\\MonologBundle\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Symfony MonologBundle", + "homepage": "https://symfony.com", + "keywords": [ + "log", + "logging" + ], + "support": { + "issues": "https://github.com/symfony/monolog-bundle/issues", + "source": "https://github.com/symfony/monolog-bundle/tree/v3.7.0" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-03-31T07:20:47+00:00" + }, + { + "name": "symfony/polyfill-ctype", + "version": "v1.22.1", + "source": { + "type": "git", + "url": "https://github.com/symfony/polyfill-ctype.git", + "reference": "c6c942b1ac76c82448322025e084cadc56048b4e" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/polyfill-ctype/zipball/c6c942b1ac76c82448322025e084cadc56048b4e", + "reference": "c6c942b1ac76c82448322025e084cadc56048b4e", + "shasum": "" + }, + "require": { + "php": ">=7.1" + }, + "suggest": { + "ext-ctype": "For best performance" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-main": "1.22-dev" + }, + "thanks": { + "name": "symfony/polyfill", + "url": "https://github.com/symfony/polyfill" + } + }, + "autoload": { + "psr-4": { + "Symfony\\Polyfill\\Ctype\\": "" + }, + "files": [ + "bootstrap.php" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Gert de Pagter", + "email": "BackEndTea@gmail.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Symfony polyfill for ctype functions", + "homepage": "https://symfony.com", + "keywords": [ + "compatibility", + "ctype", + "polyfill", + "portable" + ], + "support": { + "source": "https://github.com/symfony/polyfill-ctype/tree/v1.22.1" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-01-07T16:49:33+00:00" + }, + { + "name": "symfony/polyfill-intl-grapheme", + "version": "v1.22.1", + "source": { + "type": "git", + "url": "https://github.com/symfony/polyfill-intl-grapheme.git", + "reference": "5601e09b69f26c1828b13b6bb87cb07cddba3170" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/polyfill-intl-grapheme/zipball/5601e09b69f26c1828b13b6bb87cb07cddba3170", + "reference": "5601e09b69f26c1828b13b6bb87cb07cddba3170", + "shasum": "" + }, + "require": { + "php": ">=7.1" + }, + "suggest": { + "ext-intl": "For best performance" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-main": "1.22-dev" + }, + "thanks": { + "name": "symfony/polyfill", + "url": "https://github.com/symfony/polyfill" + } + }, + "autoload": { + "psr-4": { + "Symfony\\Polyfill\\Intl\\Grapheme\\": "" + }, + "files": [ + "bootstrap.php" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Nicolas Grekas", + "email": "p@tchwork.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Symfony polyfill for intl's grapheme_* functions", + "homepage": "https://symfony.com", + "keywords": [ + "compatibility", + "grapheme", + "intl", + "polyfill", + "portable", + "shim" + ], + "support": { + "source": "https://github.com/symfony/polyfill-intl-grapheme/tree/v1.22.1" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-01-22T09:19:47+00:00" + }, + { + "name": "symfony/polyfill-intl-normalizer", + "version": "v1.22.1", + "source": { + "type": "git", + "url": "https://github.com/symfony/polyfill-intl-normalizer.git", + "reference": "43a0283138253ed1d48d352ab6d0bdb3f809f248" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/polyfill-intl-normalizer/zipball/43a0283138253ed1d48d352ab6d0bdb3f809f248", + "reference": "43a0283138253ed1d48d352ab6d0bdb3f809f248", + "shasum": "" + }, + "require": { + "php": ">=7.1" + }, + "suggest": { + "ext-intl": "For best performance" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-main": "1.22-dev" + }, + "thanks": { + "name": "symfony/polyfill", + "url": "https://github.com/symfony/polyfill" + } + }, + "autoload": { + "psr-4": { + "Symfony\\Polyfill\\Intl\\Normalizer\\": "" + }, + "files": [ + "bootstrap.php" + ], + "classmap": [ + "Resources/stubs" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Nicolas Grekas", + "email": "p@tchwork.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Symfony polyfill for intl's Normalizer class and related functions", + "homepage": "https://symfony.com", + "keywords": [ + "compatibility", + "intl", + "normalizer", + "polyfill", + "portable", + "shim" + ], + "support": { + "source": "https://github.com/symfony/polyfill-intl-normalizer/tree/v1.22.1" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-01-22T09:19:47+00:00" + }, + { + "name": "symfony/polyfill-mbstring", + "version": "v1.22.1", + "source": { + "type": "git", + "url": "https://github.com/symfony/polyfill-mbstring.git", + "reference": "5232de97ee3b75b0360528dae24e73db49566ab1" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/polyfill-mbstring/zipball/5232de97ee3b75b0360528dae24e73db49566ab1", + "reference": "5232de97ee3b75b0360528dae24e73db49566ab1", + "shasum": "" + }, + "require": { + "php": ">=7.1" + }, + "suggest": { + "ext-mbstring": "For best performance" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-main": "1.22-dev" + }, + "thanks": { + "name": "symfony/polyfill", + "url": "https://github.com/symfony/polyfill" + } + }, + "autoload": { + "psr-4": { + "Symfony\\Polyfill\\Mbstring\\": "" + }, + "files": [ + "bootstrap.php" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Nicolas Grekas", + "email": "p@tchwork.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Symfony polyfill for the Mbstring extension", + "homepage": "https://symfony.com", + "keywords": [ + "compatibility", + "mbstring", + "polyfill", + "portable", + "shim" + ], + "support": { + "source": "https://github.com/symfony/polyfill-mbstring/tree/v1.22.1" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-01-22T09:19:47+00:00" + }, + { + "name": "symfony/polyfill-php73", + "version": "v1.22.1", + "source": { + "type": "git", + "url": "https://github.com/symfony/polyfill-php73.git", + "reference": "a678b42e92f86eca04b7fa4c0f6f19d097fb69e2" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/polyfill-php73/zipball/a678b42e92f86eca04b7fa4c0f6f19d097fb69e2", + "reference": "a678b42e92f86eca04b7fa4c0f6f19d097fb69e2", + "shasum": "" + }, + "require": { + "php": ">=7.1" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-main": "1.22-dev" + }, + "thanks": { + "name": "symfony/polyfill", + "url": "https://github.com/symfony/polyfill" + } + }, + "autoload": { + "psr-4": { + "Symfony\\Polyfill\\Php73\\": "" + }, + "files": [ + "bootstrap.php" + ], + "classmap": [ + "Resources/stubs" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Nicolas Grekas", + "email": "p@tchwork.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Symfony polyfill backporting some PHP 7.3+ features to lower PHP versions", + "homepage": "https://symfony.com", + "keywords": [ + "compatibility", + "polyfill", + "portable", + "shim" + ], + "support": { + "source": "https://github.com/symfony/polyfill-php73/tree/v1.22.1" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-01-07T16:49:33+00:00" + }, + { + "name": "symfony/polyfill-php80", + "version": "v1.22.1", + "source": { + "type": "git", + "url": "https://github.com/symfony/polyfill-php80.git", + "reference": "dc3063ba22c2a1fd2f45ed856374d79114998f91" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/polyfill-php80/zipball/dc3063ba22c2a1fd2f45ed856374d79114998f91", + "reference": "dc3063ba22c2a1fd2f45ed856374d79114998f91", + "shasum": "" + }, + "require": { + "php": ">=7.1" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-main": "1.22-dev" + }, + "thanks": { + "name": "symfony/polyfill", + "url": "https://github.com/symfony/polyfill" + } + }, + "autoload": { + "psr-4": { + "Symfony\\Polyfill\\Php80\\": "" + }, + "files": [ + "bootstrap.php" + ], + "classmap": [ + "Resources/stubs" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Ion Bazan", + "email": "ion.bazan@gmail.com" + }, + { + "name": "Nicolas Grekas", + "email": "p@tchwork.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Symfony polyfill backporting some PHP 8.0+ features to lower PHP versions", + "homepage": "https://symfony.com", + "keywords": [ + "compatibility", + "polyfill", + "portable", + "shim" + ], + "support": { + "source": "https://github.com/symfony/polyfill-php80/tree/v1.22.1" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-01-07T16:49:33+00:00" + }, + { + "name": "symfony/process", + "version": "v5.1.11", + "source": { + "type": "git", + "url": "https://github.com/symfony/process.git", + "reference": "d279ae7f2d6e0e4e45f66de7d76006246ae00e4d" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/process/zipball/d279ae7f2d6e0e4e45f66de7d76006246ae00e4d", + "reference": "d279ae7f2d6e0e4e45f66de7d76006246ae00e4d", + "shasum": "" + }, + "require": { + "php": ">=7.2.5", + "symfony/polyfill-php80": "^1.15" + }, + "type": "library", + "autoload": { + "psr-4": { + "Symfony\\Component\\Process\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Executes commands in sub-processes", + "homepage": "https://symfony.com", + "support": { + "source": "https://github.com/symfony/process/tree/v5.1.11" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-01-27T10:01:46+00:00" + }, + { + "name": "symfony/proxy-manager-bridge", + "version": "v5.2.4", + "source": { + "type": "git", + "url": "https://github.com/symfony/proxy-manager-bridge.git", + "reference": "fd6bb40190b1719abbe831be09adf38e0744d5f5" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/proxy-manager-bridge/zipball/fd6bb40190b1719abbe831be09adf38e0744d5f5", + "reference": "fd6bb40190b1719abbe831be09adf38e0744d5f5", + "shasum": "" + }, + "require": { + "composer/package-versions-deprecated": "^1.8", + "friendsofphp/proxy-manager-lts": "^1.0.2", + "php": ">=7.2.5", + "symfony/dependency-injection": "^5.0" + }, + "require-dev": { + "symfony/config": "^4.4|^5.0" + }, + "type": "symfony-bridge", + "autoload": { + "psr-4": { + "Symfony\\Bridge\\ProxyManager\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Provides integration for ProxyManager with various Symfony components", + "homepage": "https://symfony.com", + "support": { + "source": "https://github.com/symfony/proxy-manager-bridge/tree/v5.2.4" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-01-27T10:01:46+00:00" + }, + { + "name": "symfony/routing", + "version": "v5.2.6", + "source": { + "type": "git", + "url": "https://github.com/symfony/routing.git", + "reference": "31fba555f178afd04d54fd26953501b2c3f0c6e6" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/routing/zipball/31fba555f178afd04d54fd26953501b2c3f0c6e6", + "reference": "31fba555f178afd04d54fd26953501b2c3f0c6e6", + "shasum": "" + }, + "require": { + "php": ">=7.2.5", + "symfony/deprecation-contracts": "^2.1", + "symfony/polyfill-php80": "^1.15" + }, + "conflict": { + "symfony/config": "<5.0", + "symfony/dependency-injection": "<4.4", + "symfony/yaml": "<4.4" + }, + "require-dev": { + "doctrine/annotations": "^1.10.4", + "psr/log": "~1.0", + "symfony/config": "^5.0", + "symfony/dependency-injection": "^4.4|^5.0", + "symfony/expression-language": "^4.4|^5.0", + "symfony/http-foundation": "^4.4|^5.0", + "symfony/yaml": "^4.4|^5.0" + }, + "suggest": { + "doctrine/annotations": "For using the annotation loader", + "symfony/config": "For using the all-in-one router or any loader", + "symfony/expression-language": "For using expression matching", + "symfony/http-foundation": "For using a Symfony Request object", + "symfony/yaml": "For using the YAML loader" + }, + "type": "library", + "autoload": { + "psr-4": { + "Symfony\\Component\\Routing\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Maps an HTTP request to a set of configuration variables", + "homepage": "https://symfony.com", + "keywords": [ + "router", + "routing", + "uri", + "url" + ], + "support": { + "source": "https://github.com/symfony/routing/tree/v5.2.6" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-03-14T13:53:33+00:00" + }, + { + "name": "symfony/stopwatch", + "version": "v5.2.4", + "source": { + "type": "git", + "url": "https://github.com/symfony/stopwatch.git", + "reference": "b12274acfab9d9850c52583d136a24398cdf1a0c" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/stopwatch/zipball/b12274acfab9d9850c52583d136a24398cdf1a0c", + "reference": "b12274acfab9d9850c52583d136a24398cdf1a0c", + "shasum": "" + }, + "require": { + "php": ">=7.2.5", + "symfony/service-contracts": "^1.0|^2" + }, + "type": "library", + "autoload": { + "psr-4": { + "Symfony\\Component\\Stopwatch\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Provides a way to profile code", + "homepage": "https://symfony.com", + "support": { + "source": "https://github.com/symfony/stopwatch/tree/v5.2.4" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-01-27T10:15:41+00:00" + }, + { + "name": "symfony/string", + "version": "v5.1.11", + "source": { + "type": "git", + "url": "https://github.com/symfony/string.git", + "reference": "83bbb92d34881744b8021452a76532b28283dbfb" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/string/zipball/83bbb92d34881744b8021452a76532b28283dbfb", + "reference": "83bbb92d34881744b8021452a76532b28283dbfb", + "shasum": "" + }, + "require": { + "php": ">=7.2.5", + "symfony/polyfill-ctype": "~1.8", + "symfony/polyfill-intl-grapheme": "~1.0", + "symfony/polyfill-intl-normalizer": "~1.0", + "symfony/polyfill-mbstring": "~1.0", + "symfony/polyfill-php80": "~1.15" + }, + "require-dev": { + "symfony/error-handler": "^4.4|^5.0", + "symfony/http-client": "^4.4|^5.0", + "symfony/translation-contracts": "^1.1|^2", + "symfony/var-exporter": "^4.4|^5.0" + }, + "type": "library", + "autoload": { + "psr-4": { + "Symfony\\Component\\String\\": "" + }, + "files": [ + "Resources/functions.php" + ], + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Nicolas Grekas", + "email": "p@tchwork.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Provides an object-oriented API to strings and deals with bytes, UTF-8 code points and grapheme clusters in a unified way", + "homepage": "https://symfony.com", + "keywords": [ + "grapheme", + "i18n", + "string", + "unicode", + "utf-8", + "utf8" + ], + "support": { + "source": "https://github.com/symfony/string/tree/v5.1.11" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-01-25T14:41:58+00:00" + }, + { + "name": "symfony/var-dumper", + "version": "v5.2.6", + "source": { + "type": "git", + "url": "https://github.com/symfony/var-dumper.git", + "reference": "89412a68ea2e675b4e44f260a5666729f77f668e" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/var-dumper/zipball/89412a68ea2e675b4e44f260a5666729f77f668e", + "reference": "89412a68ea2e675b4e44f260a5666729f77f668e", + "shasum": "" + }, + "require": { + "php": ">=7.2.5", + "symfony/polyfill-mbstring": "~1.0", + "symfony/polyfill-php80": "^1.15" + }, + "conflict": { + "phpunit/phpunit": "<5.4.3", + "symfony/console": "<4.4" + }, + "require-dev": { + "ext-iconv": "*", + "symfony/console": "^4.4|^5.0", + "symfony/process": "^4.4|^5.0", + "twig/twig": "^2.13|^3.0.4" + }, + "suggest": { + "ext-iconv": "To convert non-UTF-8 strings to UTF-8 (or symfony/polyfill-iconv in case ext-iconv cannot be used).", + "ext-intl": "To show region name in time zone dump", + "symfony/console": "To use the ServerDumpCommand and/or the bin/var-dump-server script" + }, + "bin": [ + "Resources/bin/var-dump-server" + ], + "type": "library", + "autoload": { + "files": [ + "Resources/functions/dump.php" + ], + "psr-4": { + "Symfony\\Component\\VarDumper\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Nicolas Grekas", + "email": "p@tchwork.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Provides mechanisms for walking through any arbitrary PHP variable", + "homepage": "https://symfony.com", + "keywords": [ + "debug", + "dump" + ], + "support": { + "source": "https://github.com/symfony/var-dumper/tree/v5.2.6" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-03-28T09:42:18+00:00" + }, + { + "name": "symfony/var-exporter", + "version": "v5.2.4", + "source": { + "type": "git", + "url": "https://github.com/symfony/var-exporter.git", + "reference": "5aed4875ab514c8cb9b6ff4772baa25fa4c10307" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/var-exporter/zipball/5aed4875ab514c8cb9b6ff4772baa25fa4c10307", + "reference": "5aed4875ab514c8cb9b6ff4772baa25fa4c10307", + "shasum": "" + }, + "require": { + "php": ">=7.2.5", + "symfony/polyfill-php80": "^1.15" + }, + "require-dev": { + "symfony/var-dumper": "^4.4.9|^5.0.9" + }, + "type": "library", + "autoload": { + "psr-4": { + "Symfony\\Component\\VarExporter\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Nicolas Grekas", + "email": "p@tchwork.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Allows exporting any serializable PHP data structure to plain PHP code", + "homepage": "https://symfony.com", + "keywords": [ + "clone", + "construct", + "export", + "hydrate", + "instantiate", + "serialize" + ], + "support": { + "source": "https://github.com/symfony/var-exporter/tree/v5.2.4" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-01-27T10:01:46+00:00" + }, + { + "name": "symfony/yaml", + "version": "v5.2.5", + "source": { + "type": "git", + "url": "https://github.com/symfony/yaml.git", + "reference": "298a08ddda623485208506fcee08817807a251dd" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/yaml/zipball/298a08ddda623485208506fcee08817807a251dd", + "reference": "298a08ddda623485208506fcee08817807a251dd", + "shasum": "" + }, + "require": { + "php": ">=7.2.5", + "symfony/deprecation-contracts": "^2.1", + "symfony/polyfill-ctype": "~1.8" + }, + "conflict": { + "symfony/console": "<4.4" + }, + "require-dev": { + "symfony/console": "^4.4|^5.0" + }, + "suggest": { + "symfony/console": "For validating YAML files using the lint command" + }, + "bin": [ + "Resources/bin/yaml-lint" + ], + "type": "library", + "autoload": { + "psr-4": { + "Symfony\\Component\\Yaml\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Loads and dumps YAML files", + "homepage": "https://symfony.com", + "support": { + "source": "https://github.com/symfony/yaml/tree/v5.2.5" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2021-03-06T07:59:01+00:00" + }, + { + "name": "twig/twig", + "version": "v2.14.4", + "source": { + "type": "git", + "url": "https://github.com/twigphp/Twig.git", + "reference": "0b4ba691fb99ec7952d25deb36c0a83061b93bbf" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/twigphp/Twig/zipball/0b4ba691fb99ec7952d25deb36c0a83061b93bbf", + "reference": "0b4ba691fb99ec7952d25deb36c0a83061b93bbf", + "shasum": "" + }, + "require": { + "php": ">=7.2.5", + "symfony/polyfill-ctype": "^1.8", + "symfony/polyfill-mbstring": "^1.3" + }, + "require-dev": { + "psr/container": "^1.0", + "symfony/phpunit-bridge": "^4.4.9|^5.0.9" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "2.14-dev" + } + }, + "autoload": { + "psr-0": { + "Twig_": "lib/" + }, + "psr-4": { + "Twig\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com", + "homepage": "http://fabien.potencier.org", + "role": "Lead Developer" + }, + { + "name": "Twig Team", + "role": "Contributors" + }, + { + "name": "Armin Ronacher", + "email": "armin.ronacher@active-4.com", + "role": "Project Founder" + } + ], + "description": "Twig, the flexible, fast, and secure template language for PHP", + "homepage": "https://twig.symfony.com", + "keywords": [ + "templating" + ], + "support": { + "issues": "https://github.com/twigphp/Twig/issues", + "source": "https://github.com/twigphp/Twig/tree/v2.14.4" + }, + "funding": [ + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/twig/twig", + "type": "tidelift" + } + ], + "time": "2021-03-10T10:05:55+00:00" + }, + { + "name": "webmozart/assert", + "version": "1.10.0", + "source": { + "type": "git", + "url": "https://github.com/webmozarts/assert.git", + "reference": "6964c76c7804814a842473e0c8fd15bab0f18e25" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/webmozarts/assert/zipball/6964c76c7804814a842473e0c8fd15bab0f18e25", + "reference": "6964c76c7804814a842473e0c8fd15bab0f18e25", + "shasum": "" + }, + "require": { + "php": "^7.2 || ^8.0", + "symfony/polyfill-ctype": "^1.8" + }, + "conflict": { + "phpstan/phpstan": "<0.12.20", + "vimeo/psalm": "<4.6.1 || 4.6.2" + }, + "require-dev": { + "phpunit/phpunit": "^8.5.13" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.10-dev" + } + }, + "autoload": { + "psr-4": { + "Webmozart\\Assert\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Bernhard Schussek", + "email": "bschussek@gmail.com" + } + ], + "description": "Assertions to validate method input/output with nice error messages.", + "keywords": [ + "assert", + "check", + "validate" + ], + "support": { + "issues": "https://github.com/webmozarts/assert/issues", + "source": "https://github.com/webmozarts/assert/tree/1.10.0" + }, + "time": "2021-03-09T10:59:23+00:00" }, { "name": "wp-coding-standards/wpcs", From 0de569d3d3b31c204b63452077726978dcf49a11 Mon Sep 17 00:00:00 2001 From: Mark Cheret Date: Wed, 14 Apr 2021 23:36:21 +0200 Subject: [PATCH 30/42] Update php.yml #73 #70 --- .github/workflows/php.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml index 6dcf060..f20ca38 100644 --- a/.github/workflows/php.yml +++ b/.github/workflows/php.yml @@ -13,6 +13,9 @@ jobs: steps: - uses: actions/checkout@v2 + + - name: Update composer.lock + run: composer update - name: Validate composer.json and composer.lock run: composer validate --strict From 81830618db6641ecc63794ff1f3a0bc6f065b3eb Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Wed, 14 Apr 2021 23:27:32 +0100 Subject: [PATCH 31/42] fix: add `--with-all-dependencies` flag --- .github/workflows/php.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml index f20ca38..c76b772 100644 --- a/.github/workflows/php.yml +++ b/.github/workflows/php.yml @@ -15,7 +15,7 @@ jobs: - uses: actions/checkout@v2 - name: Update composer.lock - run: composer update + run: composer update -W - name: Validate composer.json and composer.lock run: composer validate --strict From bb4ecf8ff2babe1586cfc18d7ca7e53a47fc6b7d Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Wed, 14 Apr 2021 23:34:20 +0100 Subject: [PATCH 32/42] chore: update lockfile --- composer.lock | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/composer.lock b/composer.lock index b1a01a4..495ddf0 100644 --- a/composer.lock +++ b/composer.lock @@ -427,16 +427,16 @@ }, { "name": "laminas/laminas-code", - "version": "4.1.0", + "version": "4.2.0", "source": { "type": "git", "url": "https://github.com/laminas/laminas-code.git", - "reference": "5b553c274b94af3f880cbaaf8fbab047f279a31c" + "reference": "e7e8f8a9c267520051d8026ff1da74823a3d8b97" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/laminas/laminas-code/zipball/5b553c274b94af3f880cbaaf8fbab047f279a31c", - "reference": "5b553c274b94af3f880cbaaf8fbab047f279a31c", + "url": "https://api.github.com/repos/laminas/laminas-code/zipball/e7e8f8a9c267520051d8026ff1da74823a3d8b97", + "reference": "e7e8f8a9c267520051d8026ff1da74823a3d8b97", "shasum": "" }, "require": { @@ -494,7 +494,7 @@ "type": "community_bridge" } ], - "time": "2021-03-27T13:55:31+00:00" + "time": "2021-04-14T22:05:06+00:00" }, { "name": "laminas/laminas-eventmanager", From 00536ec0367d7df8761ca2b9eac459a4ec4d15fa Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Wed, 14 Apr 2021 23:35:13 +0100 Subject: [PATCH 33/42] test: comment out caching --- .github/workflows/php.yml | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml index c76b772..2cd4755 100644 --- a/.github/workflows/php.yml +++ b/.github/workflows/php.yml @@ -13,21 +13,18 @@ jobs: steps: - uses: actions/checkout@v2 - - - name: Update composer.lock - run: composer update -W - name: Validate composer.json and composer.lock run: composer validate --strict - - name: Cache Composer packages - id: composer-cache - uses: actions/cache@v2 - with: - path: vendor - key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }} - restore-keys: | - ${{ runner.os }}-php- + # - name: Cache Composer packages + #id: composer-cache + #uses: actions/cache@v2 + #with: + # path: vendor + # key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }} + # restore-keys: | + # ${{ runner.os }}-php- - name: Install dependencies run: composer install --prefer-dist --no-progress From a6eb45ad7765a2783174b09d67de25491450e1c5 Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Wed, 14 Apr 2021 23:38:13 +0100 Subject: [PATCH 34/42] fix: ignore PHP version --- .github/workflows/php.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml index 2cd4755..f4ad093 100644 --- a/.github/workflows/php.yml +++ b/.github/workflows/php.yml @@ -27,7 +27,7 @@ jobs: # ${{ runner.os }}-php- - name: Install dependencies - run: composer install --prefer-dist --no-progress + run: composer install --prefer-dist --no-progress --ignore-platform-reqs # Add a test script to composer.json, for instance: "test": "vendor/bin/phpunit" # Docs: https://getcomposer.org/doc/articles/scripts.md From 3024bbde1657354acc91c5fc0a341d42c161f343 Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Wed, 14 Apr 2021 23:40:30 +0100 Subject: [PATCH 35/42] feat: re-add caching command, add linting command --- .github/workflows/php.yml | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml index f4ad093..619c495 100644 --- a/.github/workflows/php.yml +++ b/.github/workflows/php.yml @@ -17,20 +17,21 @@ jobs: - name: Validate composer.json and composer.lock run: composer validate --strict - # - name: Cache Composer packages - #id: composer-cache - #uses: actions/cache@v2 - #with: - # path: vendor - # key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }} - # restore-keys: | - # ${{ runner.os }}-php- + - name: Cache Composer packages + id: composer-cache + uses: actions/cache@v2 + with: + path: vendor + key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }} + restore-keys: | + ${{ runner.os }}-php- - name: Install dependencies run: composer install --prefer-dist --no-progress --ignore-platform-reqs - # Add a test script to composer.json, for instance: "test": "vendor/bin/phpunit" - # Docs: https://getcomposer.org/doc/articles/scripts.md + - name: Lint PHP code + run: composer run lint:php + # TODO: Add tests # - name: Run test suite # run: composer run-script test From 54dbc4e9f95ea6fd2c73cada61f19b64d4d66342 Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Thu, 15 Apr 2021 16:56:45 +0100 Subject: [PATCH 36/42] fix: checked out wrong versions --- README.md | 214 +++++++++++++++++++++++++------------------------- composer.lock | 131 +++++++++++++++++++++++++++++- 2 files changed, 237 insertions(+), 108 deletions(-) diff --git a/README.md b/README.md index 3110070..ce1ae13 100644 --- a/README.md +++ b/README.md @@ -2,139 +2,139 @@ # footnotes -## Description +Featured on [wpmudev][wpmudev] — cheers for the review, folks! -Featured on [wpmudev](http://premium.wpmudev.org/blog/12-surprisingly-useful-wordpress-plugins-you-dont-know-about/) --- cheers for the review, folks! +**footnotes** aims to be the all-in-one solution for displaying an +automatically-generated list of references on your Page or Post. The Plugin +ships with a set of defaults while also empowering you to control how your +footnotes will be displayed. -**footnotes** aims to be the all-in-one solution for displaying an automatically generated list of references on your Page or Post. The Plugin ships with a set of defaults while also empowering you to control how your footnotes are being displayed. +**footnotes** gives you the ability to display well-formatted footnotes on your +WordPress Pages and Posts — those footnotes we know from offline publishing. -**footnotes** gives you the ability to display well-formatted footnotes on your WordPress Pages and Posts — those footnotes we know from offline publishing. +## Table of Contents + +* [Features](#features) +* [Getting Started](#getting-started) +* [Deploying](#deploying) +* [Testing](#testing) +* [Code Formatting](#code-formatting) +* [Documentation](#documentation) +* [Acknowledgments](#acknowledgements) +* [License](#license) +* [Contact Information](#contact-information) + +## Features + +This Plugin provides: + +- fully customizable footnote start and end shortcodes; +- stylable tooltips supporting hyperlinks and dedicated text; +- a responsive 'reference container', with customisable positioning; +- a wide choice of different numbering styles; +- a freely-configurable and optional backlink symbol; +- footnote appearance customisation via dashboard settings and custom CSS style + rules; and +- editor buttons for easily adding shortcode tags. ## Getting Started -1. Read the contributing guidelines -1. Clone this repository (`git clone git@github.com:markcheret/footnotes.git`) - - We recommend that you use [VVV](https://varyingvagrantvagrants.org/) for your development environment -1. Install [Composer](https://getcomposer.org/download/), if you don't have it already -1. Install dependencies (`composer install`) -1. Create a new branch from `main` (`git checkout -b `) -1. When you're finished, commit your changes to the remote version of your branch - and submit a [pull request](https://github.com/markcheret/footnotes/pulls). +1. Read the [contributing guidelines][contributing]; +1. clone this repository (`git clone git@github.com:markcheret/footnotes.git`): + - we recommend that you use [VVV][vvv] for your local testing environment. +1. install [Composer][composer], if you don't have it already; and +1. install all dependencies (`composer install`): + - you will have to install `php-mbstring` manually if you do not already + have it. + +## Deploying -## Checking WP Coding Standard Compliance +Automated release deployments will be introduced soon. -1. Run PHP_CodeSniffer on the file(s) you want to check (`./vendor/bin/phpcs --standard="WordPress" --colors --encoding=utf-8 -n -p `) -1. (If applicable) run the PHP Code Beautifier and Formatter to attempt to automatically fix any errors (`./vendor/bin/phpcbf --standard="WordPress" --encoding=utf-8 -p `) - - Add the `-n` flag to ignore warnings (i.e., show only errors) - - Add the `-s` flag to show sniff codes (used for disabling errors in the code with `phpcs disable:` — MAKE SURE THAT YOU HAVE `phpcs enable` AT THE EARLIEST POINT POSSIBLE, and provide a justification for disabling the sniff code) - - You can run either across the entire project by adding the argument `--ignore=*/vendor/*` and targetting the file `./**/*.php` - - You may have to enable double-wildcards in your console first (`shopt -s globstar`) +### Building -## Building - -1. Run `_tools/build-stylesheets.sh -c` to concatenate stylesheets -1. Manually minify the output files in `css/tmp/`, saving them as `.min.css` files - - The intention is to replace this with automated minification, meaning that +1. Run `_tools/build-stylesheets.sh -c` to concatenate stylesheets; +1. manually minify the output files in `css/tmp/`, saving them as `.min.css` files: + - the intention is to replace this with automated minification, meaning that all of these steps can be rolled into a single `build` command. -1. Run `_tools/build-stylesheets.sh -d` to deploy the minified files to `dist/` - - **this will delete any existing `dist/` folder** -1. Run `composer run build` to move over the remaining files to `dist/` - - Currently, the files to include in a distribution are hard-coded in `_tools/build.sh` - - The intention is to replace this with a proper parsing of the `.distignore` file - -## Updating Documentation - -1. Install [phpDocumentor](https://phpdoc.org/) -1. Run it (`phpDocumentor -d . -t docs`) +1. run `_tools/build-stylesheets.sh -d` to deploy the minified files to `dist/`: + - **this will delete any existing `dist/` folder!** +1. run `composer run build` to move over the remaining files to `dist/`: + - currently, the files to include in a distribution are hard-coded in + `_tools/build.sh`; but + - the intention is to replace this with a proper parsing of the `.distignore` + file + +### Releasing +1. Ensure that you have configured your Git config. with SVN credentials; +1. run the above [build](#building) commands; and +1. run `composer run release` and follow the prompts. + ## Testing -Unit tests are TODO. +Automated testing will be introduced soon. -## Getting Started +## Code Formatting -1. Read the contributing guidelines -1. Clone this repository (`git clone git@github.com:Rumperuu/footnotes.git`) -1. Install [Composer](https://getcomposer.org/download/), if you don't have it already -1. Install dependencies (`composer install`) -1. Create a new branch from `main` (`git checkout -b `) -1. When you're finished, commit your changes to the remote version of your branch - and submit a [pull request](https://github.com/Rumperuu/footnotes/pulls). +This repo. uses pre-commit code formatting and linting on all staged files. +This ensures that only style-conformant code can be committed. -## Updating Documentation +The individual commands used by the pre-commit hook can also be called manually: -1. Install [phpDocumentor](https://phpdoc.org/) -1. Run it (`phpDocumentor -d . -t docs`) +### PHP Code -## Getting Started +PHP code must follow the [WordPress PHP Coding Standards][wpcs-php]. -1. Read the contributing guidelines -1. Clone this repository (`git clone git@github.com:Rumperuu/footnotes.git`) -1. Install [Composer](https://getcomposer.org/download/), if you don't have it already -1. Install dependencies (`composer install`) -1. Create a new branch from `main` (`git checkout -b `) -1. When you're finished, commit your changes to the remote version of your branch - and submit a [pull request](https://github.com/Rumperuu/footnotes/pulls). +1. Run `composer run lint:php` to lint all JS/TS files with [PHP CodeSniffer][phpcs] +1. Run `composer run lint:php:fix` to attempt to automatically fix warnings and + errors with the PHP Code Beautifier and Formatter. + +### JavaScript Code -## Updating Documentation +JavaScript code must follow the [WordPress JavaScript Coding Standards][wpcs-js]. -1. Install [phpDocumentor](https://phpdoc.org/) -1. Run it (`phpDocumentor -d . -t docs`) +Automated linting and formatting will be introduced soon. + +### CSS Stylesheets -## Getting Started +JavaScript code must follow the [WordPress CSS Coding Standards][wpcs-css]. -1. Read the contributing guidelines -1. Clone this repository (`git clone git@github.com:Rumperuu/footnotes.git`) -1. Install [Composer](https://getcomposer.org/download/), if you don't have it already -1. Install dependencies (`composer install`) -1. Create a new branch from `main` (`git checkout -b `) -1. When you're finished, commit your changes to the remote version of your branch - and submit a [pull request](https://github.com/Rumperuu/footnotes/pulls). +Automated linting and formatting will be introduced soon. -## Updating Documentation +## Documentation -1. Install [phpDocumentor](https://phpdoc.org/) -1. Run it (`phpDocumentor -d . -t docs`) +Run `composer run docs` to automatically generate HTML documentation with +[phpDocumentor][phpdocumentor]. -## Getting Started - -1. Read the contributing guidelines -1. Clone this repository (`git clone git@github.com:Rumperuu/footnotes.git`) -1. Install [Composer](https://getcomposer.org/download/), if you don't have it already -1. Install dependencies (`composer install`) -1. Create a new branch from `main` (`git checkout -b `) -1. When you're finished, commit your changes to the remote version of your branch - and submit a [pull request](https://github.com/Rumperuu/footnotes/pulls). - -## Updating Documentation - -1. Install [phpDocumentor](https://phpdoc.org/) -1. Run it (`phpDocumentor -d . -t docs`) - -## Main Features - -- Fully customizable **footnotes** start and end shortcodes; -- Styled tooltips supporting hyperlinks display **footnotes** or a dedicated text; -- Responsive *Reference Container* at the end or positioned by shortcode; -- Display the **footnotes** *Reference Container* inside a Widget; -- Wide choice of numbering styles; -- Freely configurable and optional backlink symbol; -- Configure the **footnotes'** appearance by dashboard settings and Custom CSS style rules; -- Button in both the Visual and the Text editor to add shortcodes around selection. - -## Example Usage - -These are a few examples of possible ways to delimit footnotes: - -1. Your awesome text((with an awesome footnote)) -2. Your awesome text[ref]with an awesome footnote[/ref] -3. Your awesome text``with an awesome footnote`` -4. Your awesome text`custom-shortcode`with an awesome footnote`custom-shortcode` - -## Where to get footnotes? - -The current version is available on the [WordPress.org Plugin Directory](https://wordpress.org/plugins/footnotes/). +View the current docs [here][footnotes-docs]. ## Acknowledgements -Huge thanks to every **footnotes user**, contributor, bug reporter, feature requester and fan! +Huge thanks to every **footnotes user**, contributor, bug reporter, feature +requester and fan! + +## License + +This project is licensed under the [GNU GPL v3][gpl-v3]. + +## Contact Information + +| Name | Link(s) | +|---------------|-----------------------| +|Mark Cheret | [Email][mcheret] | + +[wpmudev]: http://premium.wpmudev.org/blog/12-surprisingly-useful-wordpress-plugins-you-dont-know-about/ +[php]: https://www.php.net/ +[contributing]: https://github.com/markcheret/footnotes/blob/main/CONTRIBUTING.md +[vvv]: https://varyingvagrantvagrants.org/ +[composer]: https://getcomposer.org/download/ +[wpcs-php]: https://developer.wordpress.org/coding-standards/wordpress-coding-standards/php/ +[phpcs]: https://github.com/squizlabs/PHP_CodeSniffer +[wpcs-js]: https://developer.wordpress.org/coding-standards/wordpress-coding-standards/javascript/ +[wpcs-css]: https://developer.wordpress.org/coding-standards/wordpress-coding-standards/css/ +[phpdocumentor]: https://phpdoc.org/ +[footnotes-docs]: https://markcheret.github.io/footnotes/ +[gpl-v3]: https://www.gnu.org/licenses/gpl-3.0.en.html +[mcheret]: mailto:mark@cheret.de + diff --git a/composer.lock b/composer.lock index 495ddf0..fc795b3 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "96b80176526406b01227fcaef2a4c2fc", + "content-hash": "c15a58a62ba5d8b2d7f3273717a8381a", "packages": [], "packages-dev": [ { @@ -80,6 +80,61 @@ ], "time": "2020-11-11T10:22:58+00:00" }, + { + "name": "damianopetrungaro/php-commitizen", + "version": "v0.2.0", + "source": { + "type": "git", + "url": "https://github.com/conventional-commits/php-commitizen.git", + "reference": "985283538f013c37146b2ec83812eeef2ff9d73c" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/conventional-commits/php-commitizen/zipball/985283538f013c37146b2ec83812eeef2ff9d73c", + "reference": "985283538f013c37146b2ec83812eeef2ff9d73c", + "shasum": "" + }, + "require": { + "symfony/console": "^4 || ^5" + }, + "require-dev": { + "phpspec/prophecy-phpunit": "^2.0", + "phpunit/phpunit": "^9" + }, + "bin": [ + "php-commitizen" + ], + "type": "library", + "autoload": { + "psr-4": { + "Damianopetrungaro\\PHPCommitizen\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Damiano Petrungaro", + "email": "damianopetrungaro@gmail.com" + } + ], + "description": "Help writing Git commit following conventional commit specs", + "keywords": [ + "atomic", + "atomic commit", + "commit", + "conventional commit", + "conventionalcommit", + "git" + ], + "support": { + "issues": "https://github.com/conventional-commits/php-commitizen/issues", + "source": "https://github.com/conventional-commits/php-commitizen/tree/v0.2.0" + }, + "time": "2020-07-15T23:51:42+00:00" + }, { "name": "dealerdirect/phpcodesniffer-composer-installer", "version": "v0.7.1", @@ -1343,6 +1398,79 @@ ], "time": "2020-10-31T13:45:51+00:00" }, + { + "name": "marcocesarato/php-conventional-changelog", + "version": "v1.9.10", + "source": { + "type": "git", + "url": "https://github.com/marcocesarato/php-conventional-changelog.git", + "reference": "ecf53957bd84126f024f261c4b2fef4a889aafd2" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/marcocesarato/php-conventional-changelog/zipball/ecf53957bd84126f024f261c4b2fef4a889aafd2", + "reference": "ecf53957bd84126f024f261c4b2fef4a889aafd2", + "shasum": "" + }, + "require": { + "php": ">=7.1.3", + "symfony/console": "^4 || ^5" + }, + "require-dev": { + "brainmaestro/composer-git-hooks": "^2.8", + "friendsofphp/php-cs-fixer": "^2.18" + }, + "bin": [ + "conventional-changelog" + ], + "type": "library", + "extra": { + "hooks": { + "pre-commit": "composer fix-cs", + "pre-push": "composer check-cs", + "post-merge": "composer install" + } + }, + "autoload": { + "psr-4": { + "ConventionalChangelog\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "GPL-3.0-or-later" + ], + "authors": [ + { + "name": "Marco Cesarato", + "email": "cesarato.developer@gmail.com" + } + ], + "description": "Generate changelogs and release notes from a project's commit messages and metadata and automate versioning with semver.org and conventionalcommits.org", + "keywords": [ + "changelog", + "commit", + "commits", + "convention", + "conventional", + "conventional-changelog", + "conventional-changelog-preset", + "conventional-commit", + "conventional-commits", + "conventionalcommits", + "generation", + "git", + "history", + "php", + "readme", + "tag" + ], + "support": { + "issues": "https://github.com/marcocesarato/php-conventional-changelog/issues", + "source": "https://github.com/marcocesarato/php-conventional-changelog/tree/v1.9.10" + }, + "time": "2021-04-13T19:48:52+00:00" + }, { "name": "monolog/monolog", "version": "2.2.0", @@ -5109,3 +5237,4 @@ "platform-dev": [], "plugin-api-version": "2.0.0" } + From 749197efa6a99cab75993ad488dd36e35f43e36f Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Thu, 15 Apr 2021 17:02:09 +0100 Subject: [PATCH 37/42] style: remove trailing newlines --- composer.lock | 1 - 1 file changed, 1 deletion(-) diff --git a/composer.lock b/composer.lock index fc795b3..79b7024 100644 --- a/composer.lock +++ b/composer.lock @@ -5237,4 +5237,3 @@ "platform-dev": [], "plugin-api-version": "2.0.0" } - From e867ea69d13f3b235e8e6b4dec845a1925d39cbe Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Thu, 15 Apr 2021 17:03:46 +0100 Subject: [PATCH 38/42] re-add `/dashboard` dir --- README.md | 1 - class/dashboard/init.php | 207 ++++ class/dashboard/layout.php | 587 ++++++++++ class/dashboard/subpage-diagnostics.php | 147 +++ class/dashboard/subpage-main.php | 1402 +++++++++++++++++++++++ 5 files changed, 2343 insertions(+), 1 deletion(-) create mode 100644 class/dashboard/init.php create mode 100644 class/dashboard/layout.php create mode 100644 class/dashboard/subpage-diagnostics.php create mode 100644 class/dashboard/subpage-main.php diff --git a/README.md b/README.md index ce1ae13..fc87f7f 100644 --- a/README.md +++ b/README.md @@ -137,4 +137,3 @@ This project is licensed under the [GNU GPL v3][gpl-v3]. [footnotes-docs]: https://markcheret.github.io/footnotes/ [gpl-v3]: https://www.gnu.org/licenses/gpl-3.0.en.html [mcheret]: mailto:mark@cheret.de - diff --git a/class/dashboard/init.php b/class/dashboard/init.php new file mode 100644 index 0000000..c3f505e --- /dev/null +++ b/class/dashboard/init.php @@ -0,0 +1,207 @@ +a_arr_sub_page_classes[ $l_obj_class->get_priority() ] = $l_obj_class; + } + } + ksort( $this->a_arr_sub_page_classes ); + + // Register hooks/actions. + add_action( 'admin_init', array( $this, 'initialize_settings' ) ); + add_action( 'admin_menu', array( $this, 'register_main_menu' ) ); + // Register AJAX callbacks for Plugin information. + add_action( 'wp_ajax_nopriv_footnotes_get_plugin_info', array( $this, 'get_plugin_meta_information' ) ); + add_action( 'wp_ajax_footnotes_get_plugin_info', array( $this, 'get_plugin_meta_information' ) ); + } + + /** + * Initializes all sub pages and registers the settings. + * + * @since 1.5.0 + */ + public function initialize_settings() { + MCI_Footnotes_Settings::instance()->register_settings(); + // Iterate though each sub class of the layout engine and register their sections. + foreach ( $this->a_arr_sub_page_classes as $l_obj_layout_engine_sub_class ) { + $l_obj_layout_engine_sub_class->register_sections(); + } + } + + /** + * Registers the new main menu for the WordPress dashboard. + * Registers all sub menu pages for the new main menu. + * + * @since 1.5.0 + * @see http://codex.wordpress.org/Function_Reference/add_menu_page + */ + public function register_main_menu() { + global $menu; + // Iterate through each main menu. + foreach ( $menu as $l_arr_main_menu ) { + // 3terate through each main menu attribute. + foreach ( $l_arr_main_menu as $l_str_attribute ) { + // Main menu already added, append sub pages and stop. + if ( self::C_STR_MAIN_MENU_SLUG === $l_str_attribute ) { + $this->register_sub_pages(); + return; + } + } + } + + // Add a new main menu page to the WordPress dashboard. + add_menu_page( + self::C_STR_MAIN_MENU_TITLE, // Page title. + self::C_STR_MAIN_MENU_TITLE, // Menu title. + 'manage_options', // Capability. + self::C_STR_MAIN_MENU_SLUG, // Menu slug. + array( $this, 'display_other_plugins' ), // Function. + plugins_url( 'footnotes/img/main-menu.png' ), // Icon URL. + null // Position. + ); + $this->register_sub_pages(); + } + + /** + * Registers all SubPages for this Plugin. + * + * @since 1.5.0 + */ + private function register_sub_pages() { + // First registered sub menu page MUST NOT contain a unique slug suffix. + // Iterate though each sub class of the layout engine and register their sub page. + foreach ( $this->a_arr_sub_page_classes as $l_obj_layout_engine_sub_class ) { + $l_obj_layout_engine_sub_class->register_sub_page(); + } + } + + /** + * Displays other Plugins from the developers. + * + * @since 1.5.0 + */ + public function display_other_plugins() { + printf( '

                                                                                    ' ); + // Load template file. + $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'manfisher' ); + // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped + echo $l_obj_template->get_content(); + // phpcs:enable WordPress.Security.EscapeOutput.OutputNotEscaped + + printf( 'visit Mark Cheret' ); + printf( '

                                                                                    ' ); + + printf( '' ); + } + + // phpcs:disable WordPress.Security.NonceVerification.Missing + /** + * AJAX call. returns a JSON string containing meta information about a specific WordPress Plugin. + * + * @since 1.5.0 + */ + public function get_plugin_meta_information() { + // TODO: add nonce verification. + + // Get plugin internal name from POST data. + if ( isset( $_POST['plugin'] ) ) { + $l_str_plugin_name = wp_unslash( $_POST['plugin'] ); + } + + if ( empty( $l_str_plugin_name ) ) { + echo wp_json_encode( array( 'error' => 'Plugin name invalid.' ) ); + exit; + } + $l_str_url = 'https://api.wordpress.org/plugins/info/1.0/' . $l_str_plugin_name . '.json'; + // Call URL and collect data. + $l_arr_response = wp_remote_get( $l_str_url ); + // Check if response is valid. + if ( is_wp_error( $l_arr_response ) ) { + echo wp_json_encode( array( 'error' => 'Error receiving Plugin Information from WordPress.' ) ); + exit; + } + if ( ! array_key_exists( 'body', $l_arr_response ) ) { + echo wp_json_encode( array( 'error' => 'Error reading WordPress API response message.' ) ); + exit; + } + // Get the body of the response. + $l_str_response = $l_arr_response['body']; + // Get plugin object. + $l_arr_plugin = json_decode( $l_str_response, true ); + if ( empty( $l_arr_plugin ) ) { + echo wp_json_encode( array( 'error' => 'Error reading Plugin meta information.
                                                                                    URL: ' . $l_str_url . '
                                                                                    Response: ' . $l_str_response ) ); + exit; + } + + $l_int_num_ratings = array_key_exists( 'num_ratings', $l_arr_plugin ) ? intval( $l_arr_plugin['num_ratings'] ) : 0; + $l_int_rating = array_key_exists( 'rating', $l_arr_plugin ) ? floatval( $l_arr_plugin['rating'] ) : 0.0; + $l_int_stars = round( 5 * $l_int_rating / 100.0, 1 ); + + // Return Plugin information as JSON encoded string. + echo wp_json_encode( + array( + 'error' => '', + 'PluginDescription' => array_key_exists( 'short_description', $l_arr_plugin ) ? html_entity_decode( $l_arr_plugin['short_description'] ) : 'Error reading Plugin information', + 'PluginAuthor' => array_key_exists( 'author', $l_arr_plugin ) ? html_entity_decode( $l_arr_plugin['author'] ) : 'unknown', + 'PluginRatingText' => $l_int_stars . ' ' . __( 'rating based on', 'footnotes' ) . ' ' . $l_int_num_ratings . ' ' . __( 'ratings', 'footnotes' ), + 'PluginRating1' => $l_int_stars >= 0.5 ? 'star-full' : 'star-empty', + 'PluginRating2' => $l_int_stars >= 1.5 ? 'star-full' : 'star-empty', + 'PluginRating3' => $l_int_stars >= 2.5 ? 'star-full' : 'star-empty', + 'PluginRating4' => $l_int_stars >= 3.5 ? 'star-full' : 'star-empty', + 'PluginRating5' => $l_int_stars >= 4.5 ? 'star-full' : 'star-empty', + 'PluginRating' => $l_int_num_ratings, + 'PluginLastUpdated' => array_key_exists( 'last_updated', $l_arr_plugin ) ? $l_arr_plugin['last_updated'] : 'unknown', + 'PluginDownloads' => array_key_exists( 'downloaded', $l_arr_plugin ) ? $l_arr_plugin['downloaded'] : '---', + ) + ); + exit; + } + // phpcs:enable WordPress.Security.NonceVerification.Missing +} diff --git a/class/dashboard/layout.php b/class/dashboard/layout.php new file mode 100644 index 0000000..6a51e80 --- /dev/null +++ b/class/dashboard/layout.php @@ -0,0 +1,587 @@ + MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '-' . $p_str_id, + 'title' => $p_str_title, + 'submit' => $p_bool_has_submit_button, + 'container' => $p_int_settings_container_index, + ); + } + + /** + * Returns an array describing a meta box. + * + * @since 1.5.0 + * @param string $p_str_section_id Parent Section ID. + * @param string $p_str_id Unique ID suffix. + * @param string $p_str_title Title for the meta box. + * @param string $p_str_callback_function_name Class method name for callback. + * @return array meta box description to be able to append a meta box to the output. + */ + protected function add_meta_box( $p_str_section_id, $p_str_id, $p_str_title, $p_str_callback_function_name ) { + return array( + 'parent' => MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '-' . $p_str_section_id, + 'id' => $p_str_id, + 'title' => $p_str_title, + 'callback' => $p_str_callback_function_name, + ); + } + + /** + * Registers a sub page. + * + * @since 1.5.0 + */ + public function register_sub_page() { + global $submenu; + + if ( array_key_exists( plugin_basename( MCI_Footnotes_Layout_Init::C_STR_MAIN_MENU_SLUG ), $submenu ) ) { + foreach ( $submenu[ plugin_basename( MCI_Footnotes_Layout_Init::C_STR_MAIN_MENU_SLUG ) ] as $l_arr_sub_menu ) { + if ( plugin_basename( MCI_Footnotes_Layout_Init::C_STR_MAIN_MENU_SLUG . $this->get_sub_page_slug() ) === $l_arr_sub_menu[2] ) { + remove_submenu_page( MCI_Footnotes_Layout_Init::C_STR_MAIN_MENU_SLUG, MCI_Footnotes_Layout_Init::C_STR_MAIN_MENU_SLUG . $this->get_sub_page_slug() ); + } + } + } + + $this->a_str_sub_page_hook = add_submenu_page( + MCI_Footnotes_Layout_Init::C_STR_MAIN_MENU_SLUG, + $this->get_sub_page_title(), + $this->get_sub_page_title(), + 'manage_options', + MCI_Footnotes_Layout_Init::C_STR_MAIN_MENU_SLUG . $this->get_sub_page_slug(), + array( $this, 'display_content' ) + ); + } + + /** + * Registers all sections for a sub page. + * + * @since 1.5.0 + */ + public function register_sections() { + foreach ( $this->get_sections() as $l_arr_section ) { + // Append tab to the tab-array. + $this->a_arr_sections[ $l_arr_section['id'] ] = $l_arr_section; + add_settings_section( + $l_arr_section['id'], + '', + array( $this, 'Description' ), + $l_arr_section['id'] + ); + $this->register_meta_boxes( $l_arr_section['id'] ); + } + } + + /** + * Registers all Meta boxes for a sub page. + * + * @since 1.5.0 + * @param string $p_str_parent_id Parent section unique id. + */ + private function register_meta_boxes( $p_str_parent_id ) { + // Iterate through each meta box. + foreach ( $this->get_meta_boxes() as $l_arr_meta_box ) { + if ( $p_str_parent_id !== $l_arr_meta_box['parent'] ) { + continue; + } + add_meta_box( + $p_str_parent_id . '-' . $l_arr_meta_box['id'], + $l_arr_meta_box['title'], + array( $this, $l_arr_meta_box['callback'] ), + $p_str_parent_id, + 'main' + ); + } + } + + /** + * Append javascript and css files for specific sub page. + * + * @since 1.5.0 + */ + private function append_scripts() { + wp_enqueue_script( 'postbox' ); + wp_enqueue_style( 'wp-color-picker' ); + wp_enqueue_script( 'wp-color-picker' ); + + /** + * Registers and enqueues the dashboard stylesheet. + * + * - 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-14T1928+0100 + * + * @reporter @docteurfitness + * @link https://wordpress.org/support/topic/simply-speed-optimisation/ + * + * See the public stylesheet enqueuing: + * @see class/init.php + * + * added version # after changes started to settings.css from 2.1.2 on. + * automated update of version number for cache busting. + * No need to use '-styles' in the handle, as '-css' is appended automatically. + */ + if ( true === C_BOOL_CSS_PRODUCTION_MODE ) { + + wp_register_style( 'mci-footnotes-admin', plugins_url( 'footnotes/css/settings.min.css' ), array(), C_STR_FOOTNOTES_VERSION ); + + } else { + + wp_register_style( 'mci-footnotes-admin', plugins_url( 'footnotes/css/settings.css' ), array(), C_STR_FOOTNOTES_VERSION ); + + } + + wp_enqueue_style( 'mci-footnotes-admin' ); + } + + // phpcs:disable WordPress.Security.NonceVerification.Recommended, WordPress.Security.NonceVerification.Missing + /** + * Displays the content of specific sub page. + * + * @since 1.5.0 + */ + public function display_content() { + $this->append_scripts(); + + // TODO: add nonce verification. + + // Get the current section. + reset( $this->a_arr_sections ); + $l_str_active_section_id = isset( $_GET['t'] ) ? wp_unslash( $_GET['t'] ) : key( $this->a_arr_sections ); + $l_arr_active_section = $this->a_arr_sections[ $l_str_active_section_id ]; + + // Store settings. + $l_bool_settings_updated = false; + if ( array_key_exists( 'save-settings', $_POST ) ) { + if ( 'save' === $_POST['save-settings'] ) { + unset( $_POST['save-settings'] ); + unset( $_POST['submit'] ); + $l_bool_settings_updated = $this->save_settings(); + } + } + + // Display all sections and highlight the active section. + echo '
                                                                                    '; + echo '

                                                                                    '; + // Iterate through all register sections. + foreach ( $this->a_arr_sections as $l_str_id => $l_arr_description ) { + $l_str_tab_active = ( $l_str_id === $l_arr_active_section['id'] ) ? ' nav-tab-active' : ''; + echo sprintf( + '%s', + ( $l_str_id === $l_arr_active_section['id'] ) ? ' nav-tab-active' : '', + MCI_Footnotes_Layout_Init::C_STR_MAIN_MENU_SLUG . $this->get_sub_page_slug(), + $l_str_id, + $l_arr_description['title'] + ); + } + echo '


                                                                                    '; + + if ( $l_bool_settings_updated ) { + echo sprintf( '
                                                                                    %s
                                                                                    ', __( 'Settings saved', 'footnotes' ) ); + } + + // Form to submit the active section. + echo '
                                                                                    '; + echo ''; + // Outputs the settings field of the active section. + do_settings_sections( $l_arr_active_section['id'] ); + do_meta_boxes( $l_arr_active_section['id'], 'main', null ); + + // Add submit button to active section if defined. + if ( $l_arr_active_section['submit'] ) { + submit_button(); + } + echo '
                                                                                    '; + echo '
                                                                                    '; + + // Echo JavaScript for the expand/collapse function of the meta boxes. + echo ''; + } + // phpcs:enable WordPress.Security.NonceVerification.Recommended, WordPress.Security.NonceVerification.Missing + + // phpcs:disable WordPress.Security.NonceVerification.Recommended, WordPress.Security.NonceVerification.Missing + /** + * Save all Plugin settings. + * + * @since 1.5.0 + * @return bool + */ + private function save_settings() { + $l_arr_new_settings = array(); + + // TODO: add nonce verification. + + // Get current section. + reset( $this->a_arr_sections ); + $l_str_active_section_id = isset( $_GET['t'] ) ? wp_unslash( $_GET['t'] ) : key( $this->a_arr_sections ); + $l_arr_active_section = $this->a_arr_sections[ $l_str_active_section_id ]; + + foreach ( MCI_Footnotes_Settings::instance()->get_defaults( $l_arr_active_section['container'] ) as $l_str_key => $l_mixed_value ) { + if ( array_key_exists( $l_str_key, $_POST ) ) { + $l_arr_new_settings[ $l_str_key ] = wp_unslash( $_POST[ $l_str_key ] ); + } else { + // Setting is not defined in the POST array, define it to avoid the Default value. + $l_arr_new_settings[ $l_str_key ] = ''; + } + } + // Update settings. + return MCI_Footnotes_Settings::instance()->save_options( $l_arr_active_section['container'], $l_arr_new_settings ); + } + // phpcs:enable WordPress.Security.NonceVerification.Recommended, WordPress.Security.NonceVerification.Missing + + /** + * Output the Description of a section. May be overwritten in any section. + * + * @since 1.5.0 + */ + public function description() { + // Default no description will be displayed. + } + + /** + * Loads specific setting and returns an array with the keys [id, name, value]. + * + * @since 1.5.0 + * @param string $p_str_setting_key_name Settings Array key name. + * @return array Contains Settings ID, Settings Name and Settings Value. + * + * @since 2.5.11 Remove escapement function. + * When refactoring the codebase after 2.5.8, all and every output was escaped. + * After noticing that the plugin was broken, all escapement functions were removed. + * @link https://github.com/markcheret/footnotes/pull/50/commits/25c3f2f12eb5de1079e9215bf624ec4289b095a5 + * @link https://github.com/markcheret/footnotes/pull/50#issuecomment-787624123 + * In that process, this instance of esc_attr() was removed too, so the plugin was + * broken again. + * @link https://github.com/markcheret/footnotes/pull/50/commits/25c3f2f12eb5de1079e9215bf624ec4289b095a5#diff-a8ed6e859c32a18fc10bbbad3b4dd8ce7f43f2378d29471c7638e314ab30f1bdL349-L354 + * + * @since 2.5.15 To fix it, the data was escaped in add_select_box() instead. + * @since 2.6.1 Restore esc_attr() in load_setting(). + * @see add_select_box() + * This is the only instance of esc_|kses|sanitize in the pre-2.5.11 codebase. + * Removing this did not fix the quotation mark backslash escapement bug. + */ + protected function load_setting( $p_str_setting_key_name ) { + // Get current section. + reset( $this->a_arr_sections ); + $p_arr_return = array(); + $p_arr_return['id'] = sprintf( '%s', $p_str_setting_key_name ); + $p_arr_return['name'] = sprintf( '%s', $p_str_setting_key_name ); + $p_arr_return['value'] = esc_attr( MCI_Footnotes_Settings::instance()->get( $p_str_setting_key_name ) ); + return $p_arr_return; + } + + /** + * Returns a line break to start a new line. + * + * @since 1.5.0 + * @return string + */ + protected function add_newline() { + return '
                                                                                    '; + } + + /** + * Returns a line break to have a space between two lines. + * + * @since 1.5.0 + * @return string + */ + protected function add_line_space() { + return '

                                                                                    '; + } + + /** + * Returns a simple text inside html text. + * + * @since 1.5.0 + * @param string $p_str_text Message to be surrounded with simple html tag (span). + * @return string + */ + protected function add_text( $p_str_text ) { + return sprintf( '%s', $p_str_text ); + } + + /** + * Returns the html tag for an input/select label. + * + * @since 1.5.0 + * @param string $p_str_setting_name Name of the Settings key to connect the Label with the input/select field. + * @param string $p_str_caption Label caption. + * @return string + */ + protected function add_label( $p_str_setting_name, $p_str_caption ) { + if ( empty( $p_str_caption ) ) { + return ''; + } + + /* + * Remove the colon causing localization issues with French, and with + * languages not using punctuation at all, and with languages using other + * punctuation marks instead of colon, e.g. Greek using a raised dot. + * In French, colon is preceded by a space, forcibly non-breaking, and + * narrow per new school. + * Add colon to label strings for inclusion in localization. Colon after + * label is widely preferred best practice, mandatory per + * [style guides](https://softwareengineering.stackexchange.com/questions/234546/colons-in-internationalized-ui). + */ + return sprintf( '', $p_str_setting_name, $p_str_caption ); + } + + /** + * Returns the html tag for an input [type = text]. + * + * @since 1.5.0 + * @param string $p_str_setting_name Name of the Settings key to pre load the input field. + * @param int $p_str_max_length Maximum length of the input, default 999 characters. + * @param bool $p_bool_readonly Set the input to be read only, default false. + * @param bool $p_bool_hidden Set the input to be hidden, default false. + * @return string + */ + protected function add_text_box( $p_str_setting_name, $p_str_max_length = 999, $p_bool_readonly = false, $p_bool_hidden = false ) { + $l_str_style = ''; + // Collect data for given settings field. + $l_arr_data = $this->load_setting( $p_str_setting_name ); + if ( $p_bool_hidden ) { + $l_str_style .= 'display:none;'; + } + return sprintf( + '', + $l_arr_data['name'], + $l_arr_data['id'], + $p_str_max_length, + $l_str_style, + $l_arr_data['value'], + $p_bool_readonly ? 'readonly="readonly"' : '' + ); + } + + /** + * Returns the html tag for an input [type = checkbox]. + * + * @since 1.5.0 + * @param string $p_str_setting_name Name of the Settings key to pre load the input field. + * @return string + */ + protected function add_checkbox( $p_str_setting_name ) { + // Collect data for given settings field. + $l_arr_data = $this->load_setting( $p_str_setting_name ); + return sprintf( + '', + $l_arr_data['name'], + $l_arr_data['id'], + MCI_Footnotes_Convert::to_bool( $l_arr_data['value'] ) ? 'checked="checked"' : '' + ); + } + + /** + * Returns the html tag for a select box. + * + * @since 1.5.0 + * + * - Bugfix: Dashboard: Referrers and tooltips: Backlink symbol: debug select box by reverting identity check to equality check, thanks to @lolzim bug report. + * + * @reporter @lolzim + * + * @since 2.5.13 + * @param string $p_str_setting_name Name of the Settings key to pre select the current value. + * @param array $p_arr_options Possible options to be selected. + * @return string + * + * @since 2.5.15 Bugfix: Dashboard: General settings: Footnote start and end short codes: debug select box for shortcodes with pointy brackets. + * @since 2.6.1 Restore esc_attr() in load_setting(), remove htmlspecialchars() here. + */ + protected function add_select_box( $p_str_setting_name, $p_arr_options ) { + // Collect data for given settings field. + $l_arr_data = $this->load_setting( $p_str_setting_name ); + $l_str_options = ''; + + // Loop through all array keys. + foreach ( $p_arr_options as $l_str_value => $l_str_caption ) { + $l_str_options .= sprintf( + '', + $l_str_value, + // Only check for equality, not identity, WRT backlink symbol arrows. + $l_str_value == $l_arr_data['value'] ? 'selected' : '', + $l_str_caption + ); + } + return sprintf( + '', + $l_arr_data['name'], + $l_arr_data['id'], + $l_str_options + ); + } + + /** + * Returns the html tag for a text area. + * + * @since 1.5.0 + * @param string $p_str_setting_name Name of the Settings key to pre fill the text area. + * @return string + */ + protected function add_textarea( $p_str_setting_name ) { + // Collect data for given settings field. + $l_arr_data = $this->load_setting( $p_str_setting_name ); + return sprintf( + '', + $l_arr_data['name'], + $l_arr_data['id'], + $l_arr_data['value'] + ); + } + + /** + * Returns the html tag for an input [type = text] with color selection class. + * + * @since 1.5.6 + * @param string $p_str_setting_name Name of the Settings key to pre load the input field. + * @return string + */ + protected function add_color_selection( $p_str_setting_name ) { + // Collect data for given settings field. + $l_arr_data = $this->load_setting( $p_str_setting_name ); + return sprintf( + '', + $l_arr_data['name'], + $l_arr_data['id'], + $l_arr_data['value'] + ); + } + + /** + * Returns the html tag for an input [type = num]. + * + * @since 1.5.0 + * @param string $p_str_setting_name Name of the Settings key to pre load the input field. + * @param int $p_in_min Minimum value. + * @param int $p_int_max Maximum value. + * @param bool $p_bool_deci true if 0.1 steps and floating to string, false if integer (default). + * @return string + * + * Edited: + * @since 2.1.4 step argument and number_format() to allow decimals 2020-12-03T0631+0100..2020-12-12T1110+0100 + */ + protected function add_num_box( $p_str_setting_name, $p_in_min, $p_int_max, $p_bool_deci = false ) { + // Collect data for given settings field. + $l_arr_data = $this->load_setting( $p_str_setting_name ); + + if ( $p_bool_deci ) { + $l_str_value = number_format( floatval( $l_arr_data['value'] ), 1 ); + return sprintf( + '', + $l_arr_data['name'], + $l_arr_data['id'], + $l_str_value, + $p_in_min, + $p_int_max + ); + } else { + return sprintf( + '', + $l_arr_data['name'], + $l_arr_data['id'], + $l_arr_data['value'], + $p_in_min, + $p_int_max + ); + } + } + +} diff --git a/class/dashboard/subpage-diagnostics.php b/class/dashboard/subpage-diagnostics.php new file mode 100644 index 0000000..1a30015 --- /dev/null +++ b/class/dashboard/subpage-diagnostics.php @@ -0,0 +1,147 @@ +add_section( 'diagnostics', __( 'Diagnostics', 'footnotes' ), null, false ), + ); + } + + /** + * Returns an array of all registered meta boxes for each section of the sub page. + * + * @since 1.5.0 + * @return array + */ + protected function get_meta_boxes() { + return array( + $this->add_meta_box( 'diagnostics', 'diagnostics', __( 'Displays information about the web server, PHP and WordPress', 'footnotes' ), 'Diagnostics' ), + ); + } + + /** + * Displays a diagnostics about the web server, php and WordPress. + * + * @since 1.5.0 + */ + public function Diagnostics() { + global $wp_version; + $l_str_php_extensions = ''; + // Iterate through each PHP extension. + foreach ( get_loaded_extensions() as $l_int_index => $l_str_extension ) { + if ( $l_int_index > 0 ) { + $l_str_php_extensions .= ' | '; + } + $l_str_php_extensions .= $l_str_extension . ' ' . phpversion( $l_str_extension ); + } + + $l_obj_current_theme = wp_get_theme(); + + $l_str_wordpress_plugins = ''; + // Iterate through each installed WordPress Plugin. + foreach ( get_plugins() as $l_arr_plugin ) { + $l_str_wordpress_plugins .= ''; + $l_str_wordpress_plugins .= '' . $l_arr_plugin['Name'] . ''; + // phpcs:disable Generic.Strings.UnnecessaryStringConcat.Found + $l_str_wordpress_plugins .= '' . $l_arr_plugin['Version'] . ' [' . $l_arr_plugin['PluginURI'] . ']' . ''; + // phpcs:enable Generic.Strings.UnnecessaryStringConcat.Found + $l_str_wordpress_plugins .= ''; + } + // Load template file. + $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'diagnostics' ); + + if ( ! isset( $_SERVER['SERVER_NAME'] ) ) { + die; + } else { + $l_str_server_name = wp_unslash( $_SERVER['SERVER_NAME'] ); + } + if ( ! isset( $_SERVER['HTTP_USER_AGENT'] ) ) { + die; + } else { + $l_str_http_user_agent = wp_unslash( $_SERVER['HTTP_USER_AGENT'] ); + } + + // Replace all placeholders. + $l_obj_template->replace( + array( + 'label-server' => __( 'Server name', 'footnotes' ), + 'server' => $l_str_server_name, + + 'label-php' => __( 'PHP version', 'footnotes' ), + 'php' => phpversion(), + + 'label-user-agent' => __( 'User agent', 'footnotes' ), + 'user-agent' => $l_str_http_user_agent, + + 'label-max-execution-time' => __( 'Max execution time', 'footnotes' ), + 'max-execution-time' => ini_get( 'max_execution_time' ) . ' ' . __( 'seconds', 'footnotes' ), + + 'label-memory-limit' => __( 'Memory limit', 'footnotes' ), + 'memory-limit' => ini_get( 'memory_limit' ), + + 'label-php-extensions' => __( 'PHP extensions', 'footnotes' ), + 'php-extensions' => $l_str_php_extensions, + + 'label-wordpress' => __( 'WordPress version', 'footnotes' ), + 'wordpress' => $wp_version, + + 'label-theme' => __( 'Active Theme', 'footnotes' ), + 'theme' => $l_obj_current_theme->get( 'Name' ) . ' ' . $l_obj_current_theme->get( 'Version' ) . ', ' . $l_obj_current_theme->get( 'Author' ) . ' [' . $l_obj_current_theme->get( 'AuthorURI' ) . ']', + + 'plugins' => $l_str_wordpress_plugins, + ) + ); + // Display template with replaced placeholders. + echo $l_obj_template->get_content(); + } +} diff --git a/class/dashboard/subpage-main.php b/class/dashboard/subpage-main.php new file mode 100644 index 0000000..40808e5 --- /dev/null +++ b/class/dashboard/subpage-main.php @@ -0,0 +1,1402 @@ +add_section( 'settings', __( 'General settings', 'footnotes' ), 0, true ); + + // Sync tab name with mirror in public function custom_css_migration(). + $l_arr_tabs[] = $this->add_section( 'customize', __( 'Referrers and tooltips', 'footnotes' ), 1, true ); + + $l_arr_tabs[] = $this->add_section( 'expert', __( 'Scope and priority', 'footnotes' ), 2, true ); + $l_arr_tabs[] = $this->add_section( 'customcss', __( 'Custom CSS', 'footnotes' ), 3, true ); + $l_arr_tabs[] = $this->add_section( 'how-to', __( 'Quick start guide', 'footnotes' ), null, false ); + + return $l_arr_tabs; + } + + /** + * Returns an array of all registered meta boxes for each section of the sub page. + * + * @since 1.5.0 + * @return array + * + * Edited for 2.0.0 and later. + * + * hyperlink_arrow meta box: + * @since 2.0.0 discontinued + * @since 2.0.4 restored to meet user demand for arrow symbol semantics + * @since 2.1.4 discontinued, content moved to Settings > Reference container > Display a backlink symbol + * + * @since 2.0.4 to reflect changes in meta box label display since WPv5.5 + * spans need position:fixed and become unlocalizable + * fix: logo is kept only in the label that doesn’t need to be translated: + * Change string "%s styling" to "Footnotes styling" to fix layout in WPv5.5 + * @see details in class/config.php + * + * @since 2.1.6 / 2.2.0 tabs reordered and renamed + */ + protected function get_meta_boxes() { + $l_arr_meta_boxes = array(); + + $l_arr_meta_boxes[] = $this->add_meta_box( 'settings', 'amp-compat', __( 'AMP compatibility', 'footnotes' ), 'amp_compat' ); + $l_arr_meta_boxes[] = $this->add_meta_box( 'settings', 'start-end', __( 'Footnote start and end short codes', 'footnotes' ), 'start_end' ); + $l_arr_meta_boxes[] = $this->add_meta_box( 'settings', 'numbering', __( 'Footnotes numbering', 'footnotes' ), 'numbering' ); + $l_arr_meta_boxes[] = $this->add_meta_box( 'settings', 'scrolling', __( 'Scrolling behavior', 'footnotes' ), 'scrolling' ); + $l_arr_meta_boxes[] = $this->add_meta_box( 'settings', 'hard-links', __( 'URL fragment ID configuration', 'footnotes' ), 'hard_links' ); + $l_arr_meta_boxes[] = $this->add_meta_box( 'settings', 'reference-container', __( 'Reference container', 'footnotes' ), 'reference_container' ); + $l_arr_meta_boxes[] = $this->add_meta_box( 'settings', 'excerpts', __( 'Footnotes in excerpts', 'footnotes' ), 'excerpts' ); + $l_arr_meta_boxes[] = $this->add_meta_box( 'settings', 'love', MCI_Footnotes_Config::C_STR_PLUGIN_HEADING_NAME . ' ' . MCI_Footnotes_Config::C_STR_LOVE_SYMBOL_HEADING, 'love' ); + + $l_arr_meta_boxes[] = $this->add_meta_box( 'customize', 'hyperlink-arrow', __( 'Backlink symbol', 'footnotes' ), 'hyperlink_arrow' ); + $l_arr_meta_boxes[] = $this->add_meta_box( 'customize', 'superscript', __( 'Referrers', 'footnotes' ), 'superscript' ); + $l_arr_meta_boxes[] = $this->add_meta_box( 'customize', 'label-solution', __( 'Referrers in labels', 'footnotes' ), 'label_solution' ); + $l_arr_meta_boxes[] = $this->add_meta_box( 'customize', 'mouse-over-box', __( 'Tooltips', 'footnotes' ), 'mouseover_box' ); + $l_arr_meta_boxes[] = $this->add_meta_box( 'customize', 'mouse-over-box-position', __( 'Tooltip position', 'footnotes' ), 'mouseover_box_position' ); + $l_arr_meta_boxes[] = $this->add_meta_box( 'customize', 'mouse-over-box-dimensions', __( 'Tooltip dimensions', 'footnotes' ), 'mouseover_box_dimensions' ); + $l_arr_meta_boxes[] = $this->add_meta_box( 'customize', 'mouse-over-box-timing', __( 'Tooltip timing', 'footnotes' ), 'mouseover_box_timing' ); + $l_arr_meta_boxes[] = $this->add_meta_box( 'customize', 'mouse-over-box-truncation', __( 'Tooltip truncation', 'footnotes' ), 'mouseover_box_truncation' ); + $l_arr_meta_boxes[] = $this->add_meta_box( 'customize', 'mouse-over-box-text', __( 'Tooltip text', 'footnotes' ), 'mouseover_box_text' ); + $l_arr_meta_boxes[] = $this->add_meta_box( 'customize', 'mouse-over-box-appearance', __( 'Tooltip appearance', 'footnotes' ), 'mouseover_box_appearance' ); + if ( MCI_Footnotes_Convert::to_bool( MCI_Footnotes_Settings::instance()->get( MCI_Footnotes_Settings::C_STR_CUSTOM_CSS_LEGACY_ENABLE ) ) ) { + $l_arr_meta_boxes[] = $this->add_meta_box( 'customize', 'custom-css', __( 'Your existing Custom CSS code', 'footnotes' ), 'custom_css' ); + } + + $l_arr_meta_boxes[] = $this->add_meta_box( 'expert', 'lookup', __( 'WordPress hooks with priority level', 'footnotes' ), 'lookup_hooks' ); + + if ( MCI_Footnotes_Convert::to_bool( MCI_Footnotes_Settings::instance()->get( MCI_Footnotes_Settings::C_STR_CUSTOM_CSS_LEGACY_ENABLE ) ) ) { + $l_arr_meta_boxes[] = $this->add_meta_box( 'customcss', 'custom-css-migration', __( 'Your existing Custom CSS code', 'footnotes' ), 'custom_css_migration' ); + } + $l_arr_meta_boxes[] = $this->add_meta_box( 'customcss', 'custom-css-new', __( 'Custom CSS', 'footnotes' ), 'custom_css_new' ); + + $l_arr_meta_boxes[] = $this->add_meta_box( 'how-to', 'help', __( 'Brief introduction: How to use the plugin', 'footnotes' ), 'help' ); + $l_arr_meta_boxes[] = $this->add_meta_box( 'how-to', 'donate', __( 'Help us to improve our Plugin', 'footnotes' ), 'donate' ); + + return $l_arr_meta_boxes; + } + + /** + * Displays the AMP compatibility mode option. + * + * @since 2.5.11 (draft) + * @since 2.6.0 (release) + */ + public function amp_compat() { + + // Load template file. + $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'settings-amp' ); + // Replace all placeholders. + $l_obj_template->replace( + array( + // Translators: '%s' is the link text 'AMP-WP' linked to the plugin’s front page on WordPress.org. + 'description-1-amp' => sprintf( __( 'The official %s plugin is required when this option is enabled.', 'footnotes' ), 'AMP-WP' ), + 'label-amp' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_AMP_COMPATIBILITY_ENABLE, __( 'Enable AMP compatibility mode:', 'footnotes' ) ), + 'amp' => $this->add_checkbox( MCI_Footnotes_Settings::C_STR_FOOTNOTES_AMP_COMPATIBILITY_ENABLE ), + 'notice-amp' => __( 'This option enables hard links with configurable scroll offset in % viewport height.', 'footnotes' ), + // Translators: '%s' is the logogram of the 'Footnotes' plugin. + 'description-2-amp' => sprintf( __( '%s is becoming AMP compatible when this box is checked. Styled tooltips are displayed with fade-in/fade-out effect if enabled, and the reference container expands also on clicking a referrer if it’s collapsed by default.', 'footnotes' ), '' . MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME . '' ), + ) + ); + // Display template with replaced placeholders. + // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped + echo $l_obj_template->get_content(); + // phpcs:enable + } + + /** + * Displays all settings for the reference container. + * + * @since 1.5.0 + * + * Completed: + * @since 2.1.4: layout and typography options 2020-11-30T0548+0100 + * @since 2.2.5 options for label element and label bottom border, thanks to @markhillyer 2020-12-18T1447+0100 + * @link https://wordpress.org/support/topic/how-do-i-eliminate-the-horizontal-line-beneath-the-reference-container-heading/ + */ + public function reference_container() { + + // Options for the label element. + $l_arr_label_element = array( + 'p' => __( 'paragraph', 'footnotes' ), + 'h2' => __( 'heading 2', 'footnotes' ), + 'h3' => __( 'heading 3', 'footnotes' ), + 'h4' => __( 'heading 4', 'footnotes' ), + 'h5' => __( 'heading 5', 'footnotes' ), + 'h6' => __( 'heading 6', 'footnotes' ), + ); + // Options for the positioning of the reference container. + $l_arr_positions = array( + 'post_end' => __( 'at the end of the post', 'footnotes' ), + 'widget' => __( 'in the widget area', 'footnotes' ), + 'footer' => __( 'in the footer', 'footnotes' ), + ); + // Basic responsive page layout options. + $l_arr_page_layout_options = array( + 'none' => __( 'No', 'footnotes' ), + 'reference-container' => __( 'to the reference container exclusively', 'footnotes' ), + 'entry-content' => __( 'to the div element starting below the post title', 'footnotes' ), + 'main-content' => __( 'to the main element including the post title', 'footnotes' ), + ); + // Options for the separating punctuation between backlinks. + $l_arr_separators = array( + // Unicode character names are conventionally uppercase. + 'comma' => __( 'COMMA', 'footnotes' ), + 'semicolon' => __( 'SEMICOLON', 'footnotes' ), + 'en_dash' => __( 'EN DASH', 'footnotes' ), + ); + // Options for the terminating punctuation after backlinks. + // The Unicode name of RIGHT PARENTHESIS was originally more accurate because. + // This character is bidi-mirrored. Let’s use the Unicode 1.0 name. + // The wrong names were enforced in spite of Unicode, that subsequently scrambled to correct. + $l_arr_terminators = array( + 'period' => __( 'FULL STOP', 'footnotes' ), + // Unicode 1.0 name of RIGHT PARENTHESIS (represented as a left parenthesis in right-to-left scripts). + 'parenthesis' => __( 'CLOSING PARENTHESIS', 'footnotes' ), + 'colon' => __( 'COLON', 'footnotes' ), + ); + // Options for the first column width (per cent is a ratio, not a unit). + $l_arr_width_units = array( + '%' => __( 'per cent', 'footnotes' ), + 'px' => __( 'pixels', 'footnotes' ), + 'rem' => __( 'root em', 'footnotes' ), + 'em' => __( 'em', 'footnotes' ), + 'vw' => __( 'viewport width', 'footnotes' ), + ); + // Options for reference container script mode. + $l_arr_script_mode = array( + 'jquery' => __( 'jQuery', 'footnotes' ), + 'js' => __( 'plain JavaScript', 'footnotes' ), + ); + // Options for Yes/No select box. + $l_arr_enabled = array( + 'yes' => __( 'Yes', 'footnotes' ), + 'no' => __( 'No', 'footnotes' ), + ); + + // Load template file. + $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'settings-reference-container' ); + // Replace all placeholders. + $l_obj_template->replace( + array( + 'label-name' => $this->add_label( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_NAME, __( 'Heading:', 'footnotes' ) ), + 'name' => $this->add_text_box( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_NAME ), + + 'label-element' => $this->add_label( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT, __( 'Heading’s HTML element:', 'footnotes' ) ), + 'element' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT, $l_arr_label_element ), + + 'label-border' => $this->add_label( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER, __( 'Border under the heading:', 'footnotes' ) ), + 'border' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER, $l_arr_enabled ), + + 'label-collapse' => $this->add_label( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_COLLAPSE, __( 'Collapse by default:', 'footnotes' ) ), + 'collapse' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_COLLAPSE, $l_arr_enabled ), + + 'label-script' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE, __( 'Script mode:', 'footnotes' ) ), + 'script' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE, $l_arr_script_mode ), + 'notice-script' => __( 'The plain JavaScript mode will enable hard links with configurable scroll offset.', 'footnotes' ), + + 'label-position' => $this->add_label( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_POSITION, __( 'Default position:', 'footnotes' ) ), + 'position' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_POSITION, $l_arr_positions ), + // Translators: %s: at the end of the post. + 'notice-position' => sprintf( __( 'To use the position or section shortcode, please set the position to: %s', 'footnotes' ), '' . __( 'at the end of the post', 'footnotes' ) . '' ), + + 'label-shortcode' => $this->add_label( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE, __( 'Position shortcode:', 'footnotes' ) ), + 'shortcode' => $this->add_text_box( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE ), + 'notice-shortcode' => __( 'If present in the content, any shortcode in this text box will be replaced with the reference container.', 'footnotes' ), + + 'label-section' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTE_SECTION_SHORTCODE, __( 'Footnote section shortcode:', 'footnotes' ) ), + 'section' => $this->add_text_box( MCI_Footnotes_Settings::C_STR_FOOTNOTE_SECTION_SHORTCODE ), + 'notice-section' => __( 'If present in the content, any shortcode in this text box will delimit a section terminated by a reference container.', 'footnotes' ), + + 'label-startpage' => $this->add_label( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_START_PAGE_ENABLE, __( 'Display on start page too:', 'footnotes' ) ), + 'startpage' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_START_PAGE_ENABLE, $l_arr_enabled ), + + 'label-margin-top' => $this->add_label( MCI_Footnotes_Settings::C_INT_REFERENCE_CONTAINER_TOP_MARGIN, __( 'Top margin:', 'footnotes' ) ), + 'margin-top' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_REFERENCE_CONTAINER_TOP_MARGIN, -500, 500 ), + 'notice-margin-top' => __( 'pixels; may be negative', 'footnotes' ), + + 'label-margin-bottom' => $this->add_label( MCI_Footnotes_Settings::C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN, __( 'Bottom margin:', 'footnotes' ) ), + 'margin-bottom' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN, -500, 500 ), + 'notice-margin-bottom' => __( 'pixels; may be negative', 'footnotes' ), + + 'label-page-layout' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT, __( 'Apply basic responsive page layout:', 'footnotes' ) ), + 'page-layout' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT, $l_arr_page_layout_options ), + 'notice-page-layout' => __( 'Most themes don’t need this fix.', 'footnotes' ), + + 'label-url-wrap' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTE_URL_WRAP_ENABLED, __( 'Allow URLs to line-wrap anywhere:', 'footnotes' ) ), + 'url-wrap' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTE_URL_WRAP_ENABLED, $l_arr_enabled ), + 'notice-url-wrap' => __( 'Unicode-conformant browsers don’t need this fix.', 'footnotes' ), + + 'label-symbol' => $this->add_label( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE, __( 'Display a backlink symbol:', 'footnotes' ) ), + 'symbol-enable' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE, $l_arr_enabled ), + 'notice-symbol' => __( 'Please choose or input the symbol at the top of the next dashboard tab.', 'footnotes' ), + + 'label-switch' => $this->add_label( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH, __( 'Symbol appended, not prepended:', 'footnotes' ) ), + 'switch' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH, $l_arr_enabled ), + + 'label-3column' => $this->add_label( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE, __( 'Backlink symbol in an extra column:', 'footnotes' ) ), + '3column' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE, $l_arr_enabled ), + 'notice-3column' => __( 'This legacy layout is available if identical footnotes are not combined.', 'footnotes' ), + + 'label-row-borders' => $this->add_label( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE, __( 'Borders around the table rows:', 'footnotes' ) ), + 'row-borders' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE, $l_arr_enabled ), + + 'label-separator' => $this->add_label( MCI_Footnotes_Settings::C_STR_BACKLINKS_SEPARATOR_ENABLED, __( 'Add a separator when enumerating backlinks:', 'footnotes' ) ), + 'separator-enable' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_BACKLINKS_SEPARATOR_ENABLED, $l_arr_enabled ), + 'separator-options' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_BACKLINKS_SEPARATOR_OPTION, $l_arr_separators ), + 'separator-custom' => $this->add_text_box( MCI_Footnotes_Settings::C_STR_BACKLINKS_SEPARATOR_CUSTOM ), + 'notice-separator' => __( 'Your input overrides the selection.', 'footnotes' ), + + 'label-terminator' => $this->add_label( MCI_Footnotes_Settings::C_STR_BACKLINKS_TERMINATOR_ENABLED, __( 'Add a terminal punctuation to backlinks:', 'footnotes' ) ), + 'terminator-enable' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_BACKLINKS_TERMINATOR_ENABLED, $l_arr_enabled ), + 'terminator-options' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_BACKLINKS_TERMINATOR_OPTION, $l_arr_terminators ), + 'terminator-custom' => $this->add_text_box( MCI_Footnotes_Settings::C_STR_BACKLINKS_TERMINATOR_CUSTOM ), + 'notice-terminator' => __( 'Your input overrides the selection.', 'footnotes' ), + + 'label-width' => $this->add_label( MCI_Footnotes_Settings::C_STR_BACKLINKS_COLUMN_WIDTH_ENABLED, __( 'Set backlinks column width:', 'footnotes' ) ), + 'width-enable' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_BACKLINKS_COLUMN_WIDTH_ENABLED, $l_arr_enabled ), + 'width-scalar' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR, 0, 500, true ), + 'width-unit' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_BACKLINKS_COLUMN_WIDTH_UNIT, $l_arr_width_units ), + 'notice-width' => __( 'Absolute width in pixels doesn’t need to be accurate to the tenth, but relative width in rem or em may.', 'footnotes' ), + + 'label-max-width' => $this->add_label( MCI_Footnotes_Settings::C_STR_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED, __( 'Set backlinks column maximum width:', 'footnotes' ) ), + 'max-width-enable' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED, $l_arr_enabled ), + 'max-width-scalar' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR, 0, 500, true ), + 'max-width-unit' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT, $l_arr_width_units ), + 'notice-max-width' => __( 'Absolute width in pixels doesn’t need to be accurate to the tenth, but relative width in rem or em may.', 'footnotes' ), + + 'label-line-break' => $this->add_label( MCI_Footnotes_Settings::C_STR_BACKLINKS_LINE_BREAKS_ENABLED, __( 'Stack backlinks when enumerating:', 'footnotes' ) ), + 'line-break' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_BACKLINKS_LINE_BREAKS_ENABLED, $l_arr_enabled ), + 'notice-line-break' => __( 'This option adds a line break before each added backlink when identical footnotes are combined.', 'footnotes' ), + + 'label-link' => $this->add_label( MCI_Footnotes_Settings::C_STR_LINK_ELEMENT_ENABLED, __( 'Use the link element for referrers and backlinks:', 'footnotes' ) ), + 'link' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_LINK_ELEMENT_ENABLED, $l_arr_enabled ), + 'notice-link' => __( 'The link element is needed to apply the theme’s link color.', 'footnotes' ), + 'description-link' => __( 'If the link element is not desired for styling, a simple span is used instead when the above is set to No.', 'footnotes' ), + ) + ); + // Display template with replaced placeholders. + // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped + echo $l_obj_template->get_content(); + // phpcs:enable + } + + /** + * Displays all options for the footnotes start and end tag short codes. + * + * @since 1.5.0 + * + * Edited heading 2020-12-12T1412+0100 + * @since 2.2.0 start/end short codes: more predefined options 2020-12-12T1412+0100 + * @link https://wordpress.org/support/topic/doesnt-work-with-mailpoet/ + * @since 2.2.0 3 boxes for clarity 2020-12-12T1422+0100 + * @since 2.2.5 support for Ibid. notation thanks to @meglio 2020-12-17T2019+0100 + * @link https://wordpress.org/support/topic/add-support-for-ibid-notation/ + * @since 2.4.0 added warning about Block Editor escapement disruption 2021-01-02T2324+0100 + * @since 2.4.0 removed the HTML comment tag option 2021-01-02T2325+0100 + * @since 2.5.0 Shortcode syntax validation: add more information around the setting, thanks to @andreasra + * @link https://wordpress.org/support/topic/warning-unbalanced-footnote-start-tag-short-code-before/ + */ + public function start_end() { + // Footnotes start tag short code options. + $l_arr_shortcode_start = array( + '((' => '((', + '(((' => '(((', + '{{' => '{{', + '{{{' => '{{{', + '[n]' => '[n]', + '[fn]' => '[fn]', + htmlspecialchars( '' ) => htmlspecialchars( '' ), + '[ref]' => '[ref]', + htmlspecialchars( '' ) => htmlspecialchars( '' ), + // Custom (user-defined) start and end tags bracketing the footnote text inline. + 'userdefined' => __( 'custom short code', 'footnotes' ), + ); + // Footnotes end tag short code options. + $l_arr_shortcode_end = array( + '))' => '))', + ')))' => ')))', + '}}' => '}}', + '}}}' => '}}}', + '[/n]' => '[/n]', + '[/fn]' => '[/fn]', + htmlspecialchars( '' ) => htmlspecialchars( '' ), + '[/ref]' => '[/ref]', + htmlspecialchars( '' ) => htmlspecialchars( '' ), + // Custom (user-defined) start and end tags bracketing the footnote text inline. + 'userdefined' => __( 'custom short code', 'footnotes' ), + ); + // Options for the syntax validation. + $l_arr_enable = array( + 'yes' => __( 'Yes', 'footnotes' ), + 'no' => __( 'No', 'footnotes' ), + ); + + // Load template file. + $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'settings-start-end' ); + // Replace all placeholders. + $l_obj_template->replace( + array( + 'description-escapement' => __( 'When delimiters with pointy brackets are used, the diverging escapement schemas will be unified before footnotes are processed.', 'footnotes' ), + + 'label-short-code-start' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_START, __( 'Footnote start tag short code:', 'footnotes' ) ), + 'short-code-start' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_START, $l_arr_shortcode_start ), + 'short-code-start-user' => $this->add_text_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED ), + + 'label-short-code-end' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_END, __( 'Footnote end tag short code:', 'footnotes' ) ), + 'short-code-end' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_END, $l_arr_shortcode_end ), + 'short-code-end-user' => $this->add_text_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED ), + + // For script showing/hiding user defined text boxes. + 'short-code-start-id' => MCI_Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_START, + 'short-code-end-id' => MCI_Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_END, + 'short-code-start-user-id' => MCI_Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED, + 'short-code-end-user-id' => MCI_Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED, + + 'description-parentheses' => __( 'WARNING: Although widespread industry standard, the double parentheses are problematic because they may occur in scripts embedded in the content and be mistaken as a short code.', 'footnotes' ), + + // Option to enable syntax validation, label mirrored in task.php. + 'label-syntax' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE, __( 'Check for balanced shortcodes:', 'footnotes' ) ), + 'syntax' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE, $l_arr_enable ), + 'notice-syntax' => __( 'In the presence of a lone start tag shortcode, a warning displays below the post title.', 'footnotes' ), + + 'description-syntax' => __( 'If the start tag short code is ‘((’ or ‘(((’, it will not be reported as unbalanced if the following string contains braces hinting that it is a script.', 'footnotes' ), + ) + ); + // Display template with replaced placeholders. + // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped + echo $l_obj_template->get_content(); + // phpcs:enable + } + + /** + * Displays all options for the footnotes numbering. + * + * @since 2.2.0 + */ + public function numbering() { + // Define some space for the output. + $l_str_space = '     '; + // Options for the combination of identical footnotes. + $l_arr_enable = array( + 'yes' => __( 'Yes', 'footnotes' ), + 'no' => __( 'No', 'footnotes' ), + ); + // Options for the numbering style of the footnotes. + $l_arr_counter_style = array( + 'arabic_plain' => __( 'plain Arabic numbers', 'footnotes' ) . $l_str_space . '1, 2, 3, 4, 5, …', + 'arabic_leading' => __( 'zero-padded Arabic numbers', 'footnotes' ) . $l_str_space . '01, 02, 03, 04, 05, …', + 'latin_low' => __( 'lowercase Latin letters', 'footnotes' ) . $l_str_space . 'a, b, c, d, e, …', + 'latin_high' => __( 'uppercase Latin letters', 'footnotes' ) . $l_str_space . 'A, B, C, D, E, …', + 'romanic' => __( 'uppercase Roman numerals', 'footnotes' ) . $l_str_space . 'I, II, III, IV, V, …', + 'roman_low' => __( 'lowercase Roman numerals', 'footnotes' ) . $l_str_space . 'i, ii, iii, iv, v, …', + ); + + // Load template file. + $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'settings-numbering' ); + // Replace all placeholders. + $l_obj_template->replace( + array( + 'label-counter-style' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_COUNTER_STYLE, __( 'Numbering style:', 'footnotes' ) ), + 'counter-style' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_COUNTER_STYLE, $l_arr_counter_style ), + + // Algorithmically combine identicals. + 'label-identical' => $this->add_label( MCI_Footnotes_Settings::C_STR_COMBINE_IDENTICAL_FOOTNOTES, __( 'Combine identical footnotes:', 'footnotes' ) ), + 'identical' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_COMBINE_IDENTICAL_FOOTNOTES, $l_arr_enable ), + 'notice-identical' => __( 'This option may require copy-pasting footnotes in multiple instances.', 'footnotes' ), + // Support for Ibid. notation added thanks to @meglio in . + 'description-identical' => __( 'Even when footnotes are combined, footnote numbers keep incrementing. This avoids suboptimal referrer and backlink disambiguation using a secondary numbering system. The Ibid. notation and the op. cit. abbreviation followed by the current page number avoid repeating the footnote content. For changing sources, shortened citations may be used. Repeating full citations is also an opportunity to add details.', 'footnotes' ), + ) + ); + // Display template with replaced placeholders. + // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped + echo $l_obj_template->get_content(); + // phpcs:enable + } + + /** + * Displays all options for the scrolling behavior. + * + * @since 2.2.0 + */ + public function scrolling() { + + // Options for enabling scroll duration asymmetricity. + $l_arr_enable = array( + 'yes' => __( 'Yes', 'footnotes' ), + 'no' => __( 'No', 'footnotes' ), + ); + + // Load template file. + $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'settings-scrolling' ); + // Replace all placeholders. + $l_obj_template->replace( + array( + + 'label-scroll-css' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_CSS_SMOOTH_SCROLLING, __( 'CSS-based smooth scrolling:', 'footnotes' ) ), + 'scroll-css' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_CSS_SMOOTH_SCROLLING, $l_arr_enable ), + 'notice-scroll-css' => __( 'May slightly disturb jQuery scrolling and is therefore disabled by default. Works in recent browsers.', 'footnotes' ), + + 'label-scroll-offset' => $this->add_label( MCI_Footnotes_Settings::C_INT_FOOTNOTES_SCROLL_OFFSET, __( 'Scroll offset:', 'footnotes' ) ), + 'scroll-offset' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_FOOTNOTES_SCROLL_OFFSET, 0, 100 ), + 'notice-scroll-offset' => __( 'per cent viewport height from the upper edge', 'footnotes' ), + + 'label-scroll-duration' => $this->add_label( MCI_Footnotes_Settings::C_INT_FOOTNOTES_SCROLL_DURATION, __( 'Scroll duration:', 'footnotes' ) ), + 'scroll-duration' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_FOOTNOTES_SCROLL_DURATION, 0, 20000 ), + 'notice-scroll-duration' => __( 'milliseconds. If asymmetric scroll durations are enabled, this is the scroll-up duration.', 'footnotes' ), + + // Enable scroll duration asymmetricity. + 'label-scroll-asymmetricity' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_SCROLL_DURATION_ASYMMETRICITY, __( 'Enable asymmetric scroll durations:', 'footnotes' ) ), + 'scroll-asymmetricity' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_SCROLL_DURATION_ASYMMETRICITY, $l_arr_enable ), + 'notice-scroll-asymmetricity' => __( 'With this option enabled, scrolling up may take longer than down, or conversely.', 'footnotes' ), + + 'label-scroll-down-duration' => $this->add_label( MCI_Footnotes_Settings::C_INT_FOOTNOTES_SCROLL_DOWN_DURATION, __( 'Scroll-down duration:', 'footnotes' ) ), + 'scroll-down-duration' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_FOOTNOTES_SCROLL_DOWN_DURATION, 0, 20000 ), + 'notice-scroll-down-duration' => __( 'milliseconds', 'footnotes' ), + + 'label-scroll-down-delay' => $this->add_label( MCI_Footnotes_Settings::C_INT_FOOTNOTES_SCROLL_DOWN_DELAY, __( 'Scroll-down delay:', 'footnotes' ) ), + 'scroll-down-delay' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_FOOTNOTES_SCROLL_DOWN_DELAY, 0, 20000 ), + 'notice-scroll-down-delay' => __( 'milliseconds. Useful to see the effect on input elements when referrers without hard links are clicked in form labels.', 'footnotes' ), + + 'label-scroll-up-delay' => $this->add_label( MCI_Footnotes_Settings::C_INT_FOOTNOTES_SCROLL_UP_DELAY, __( 'Scroll-up delay:', 'footnotes' ) ), + 'scroll-up-delay' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_FOOTNOTES_SCROLL_UP_DELAY, 0, 20000 ), + 'notice-scroll-up-delay' => __( 'milliseconds. Less useful than the scroll-down delay.', 'footnotes' ), + + ) + ); + // Display template with replaced placeholders. + // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped + echo $l_obj_template->get_content(); + // phpcs:enable + } + + /** + * Displays all options for the fragment identifier configuration. + * + * @since 2.2.0 in scrolling(). + * @since 2.5.12 separate metabox. + */ + public function hard_links() { + + // Options for enabling hard links for AMP compat. + $l_arr_enable = array( + 'yes' => __( 'Yes', 'footnotes' ), + 'no' => __( 'No', 'footnotes' ), + ); + + // Load template file. + $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'settings-hard-links' ); + // Replace all placeholders. + $l_obj_template->replace( + array( + + 'label-hard-links' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_HARD_LINKS_ENABLE, __( 'Enable hard links:', 'footnotes' ) ), + 'hard-links' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_HARD_LINKS_ENABLE, $l_arr_enable ), + 'notice-hard-links' => __( 'Hard links disable jQuery delays but have the same scroll offset, and allow to share footnotes (accessed if the list is not collapsed by default).', 'footnotes' ), + + 'label-footnote' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTE_FRAGMENT_ID_SLUG, __( 'Fragment identifier slug for footnotes:', 'footnotes' ) ), + 'footnote' => $this->add_text_box( MCI_Footnotes_Settings::C_STR_FOOTNOTE_FRAGMENT_ID_SLUG ), + 'notice-footnote' => __( 'This will show up in the address bar after clicking on a hard-linked footnote referrer.', 'footnotes' ), + + 'label-referrer' => $this->add_label( MCI_Footnotes_Settings::C_STR_REFERRER_FRAGMENT_ID_SLUG, __( 'Fragment identifier slug for footnote referrers:', 'footnotes' ) ), + 'referrer' => $this->add_text_box( MCI_Footnotes_Settings::C_STR_REFERRER_FRAGMENT_ID_SLUG ), + 'notice-referrer' => __( 'This will show up in the address bar after clicking on a hard-linked backlink.', 'footnotes' ), + + 'label-separator' => $this->add_label( MCI_Footnotes_Settings::C_STR_HARD_LINK_IDS_SEPARATOR, __( 'ID separator:', 'footnotes' ) ), + 'separator' => $this->add_text_box( MCI_Footnotes_Settings::C_STR_HARD_LINK_IDS_SEPARATOR ), + 'notice-separator' => __( 'May be empty or any string, for example _, - or +, to distinguish post number, container number and footnote number.', 'footnotes' ), + + // Enable backlink tooltips. + 'label-backlink-tooltips' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE, __( 'Enable backlink tooltips:', 'footnotes' ) ), + 'backlink-tooltips' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE, $l_arr_enable ), + 'notice-backlink-tooltips' => __( 'Hard backlinks get ordinary tooltips hinting to use the backbutton instead to keep it usable.', 'footnotes' ), + + 'label-backlink-tooltip-text' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT, __( 'Backlink tooltip text:', 'footnotes' ) ), + 'backlink-tooltip-text' => $this->add_text_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT ), + 'notice-backlink-tooltip-text' => __( 'Default text is the keyboard shortcut; may be a localized descriptive hint.', 'footnotes' ), + + ) + ); + // Display template with replaced placeholders. + // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped + echo $l_obj_template->get_content(); + // phpcs:enable + } + + /** + * Displays all settings for 'I love Footnotes'. + * + * @since 1.5.0 + * + * Edited: + * @since 2.2.0 position-sensitive placeholders to support more locales 2020-12-11T0432+0100 + * @since 2.2.0 more options 2020-12-11T0432+0100 + */ + public function love() { + // Options for the acknowledgment display in the footer. + $l_arr_love = array( + // Logo only. + 'text-3' => sprintf( '%s', MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME ), + // Logo followed by heart symbol. + 'text-4' => sprintf( '%s %s', MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME, MCI_Footnotes_Config::C_STR_LOVE_SYMBOL ), + // Logo preceded by heart symbol. + 'text-5' => sprintf( '%s %s', MCI_Footnotes_Config::C_STR_LOVE_SYMBOL, MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME ), + // Translators: 2: heart symbol 1: footnotes logogram. + 'text-1' => sprintf( __( 'I %2$s %1$s', 'footnotes' ), MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME, MCI_Footnotes_Config::C_STR_LOVE_SYMBOL ), + // Translators: %s: Footnotes plugin logo. + 'text-6' => sprintf( __( 'This website uses %s.', 'footnotes' ), MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME ), + // Translators: %s: Footnotes plugin logo. + 'text-7' => sprintf( __( 'This website uses the %s plugin.', 'footnotes' ), MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME ), + // Translators: %s: Footnotes plugin logo. + 'text-2' => sprintf( __( 'This website uses the awesome %s plugin.', 'footnotes' ), MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME ), + 'random' => __( 'randomly determined display of either mention', 'footnotes' ), + // Translators: 1: Plugin logo.2: heart symbol. + 'no' => sprintf( __( 'no display of any “%1$s %2$s” mention in the footer', 'footnotes' ), MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME, MCI_Footnotes_Config::C_STR_LOVE_SYMBOL ), + ); + + // Load template file. + $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'settings-love' ); + // Replace all placeholders. + $l_obj_template->replace( + array( + // Translators: %s: Footnotes plugin logo. + 'label-love' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_LOVE, sprintf( __( 'Tell the world you’re using %s:', 'footnotes' ), MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME ) ), + 'love' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_LOVE, $l_arr_love ), + // Translators: %s: Footnotes plugin logo. + 'label-no-love' => $this->add_text( sprintf( __( 'Shortcode to inhibit the display of the %s mention on specific pages:', 'footnotes' ), MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME ) ), + 'no-love' => $this->add_text( MCI_Footnotes_Config::C_STR_NO_LOVE_SLUG ), + ) + ); + // Display template with replaced placeholders. + // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped + echo $l_obj_template->get_content(); + // phpcs:enable + } + + /** + * Displays the footnotes in excerpt setting. + * + * @since 1.5.0 + * + * Edited heading 2020-12-12T1453+0100 + * @since 2.1.1 more settings and notices, thanks to @nikelaos + * @link https://wordpress.org/support/topic/doesnt-work-any-more-11/#post-13687068 + * @link https://wordpress.org/support/topic/jquery-comes-up-in-feed-content/#post-13110879 + * @since 2.2.0 dedicated to the excerpt setting and its notices 2020-12-12T1454+0100 + */ + public function excerpts() { + // Options for options select box. + $l_arr_excerpt_mode = array( + 'yes' => __( 'Yes, generate excerpts from posts with effectively processed footnotes and other markup', 'footnotes' ), + 'no' => __( 'No, generate excerpts from posts but remove all footnotes and output plain text', 'footnotes' ), + 'manual' => __( 'Yes but run the process only to display tooltips in manual excerpts with footnote short codes', 'footnotes' ), + ); + + // Load template file. + $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'settings-excerpts' ); + // Replace all placeholders. + $l_obj_template->replace( + array( + 'label-excerpts' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_IN_EXCERPT, __( 'Process footnotes in excerpts:', 'footnotes' ) ), + 'excerpts' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_IN_EXCERPT, $l_arr_excerpt_mode ), + 'notice-excerpts' => __( 'If the_excerpt is enabled.', 'footnotes' ), + // Translators: %s: link text 'Advanced Excerpt' linked to the plugin’s WordPress.org front page. + // Translators: %s: Footnotes plugin logo. + 'description-excerpts' => sprintf( __( 'To not display footnotes in excerpts, the %s plugin generates excerpts on the basis of the posts to be able to remove the footnotes. Else, footnotes may be processed in manual excerpts OR processed based on the posts. — For this setting to be effective, the hook the_excerpt must be enabled under Scope and priority.', 'footnotes' ), '' . MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME . '' ), + ) + ); + // Display template with replaced placeholders. + // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped + echo $l_obj_template->get_content(); + // phpcs:enable + } + + /** + * Displays all settings for the footnote referrers. + * + * @since 1.5.0 + * + * Edited heading 2020-12-12T1513+0100 + * @since 2.1.1 option for superscript (optionally baseline referrers) + * @since 2.2.0 option for link element moved here 2020-12-12T1514+0100 + */ + public function superscript() { + // Options for Yes/No select box. + $l_arr_enabled = array( + 'yes' => __( 'Yes', 'footnotes' ), + 'no' => __( 'No', 'footnotes' ), + ); + // Options for superscript normalize scope. + $l_arr_normalize_superscript = array( + 'no' => __( 'No', 'footnotes' ), + 'referrers' => __( 'Footnote referrers', 'footnotes' ), + 'all' => __( 'All superscript elements', 'footnotes' ), + ); + // Load template file. + $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'customize-superscript' ); + // Replace all placeholders. + $l_obj_template->replace( + array( + 'label-superscript' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS, __( 'Display footnote referrers in superscript:', 'footnotes' ) ), + 'superscript' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS, $l_arr_enabled ), + + 'label-normalize' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT, __( 'Normalize vertical alignment and font size:', 'footnotes' ) ), + 'normalize' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT, $l_arr_normalize_superscript ), + 'notice-normalize' => __( 'Most themes don’t need this fix.', 'footnotes' ), + + 'label-before' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_STYLING_BEFORE, __( 'At the start of the footnote referrers:', 'footnotes' ) ), + 'before' => $this->add_text_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_STYLING_BEFORE ), + + 'label-after' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_STYLING_AFTER, __( 'At the end of the footnote referrers:', 'footnotes' ) ), + 'after' => $this->add_text_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_STYLING_AFTER ), + + 'label-link' => $this->add_label( MCI_Footnotes_Settings::C_STR_LINK_ELEMENT_ENABLED, __( 'Use the link element for referrers and backlinks:', 'footnotes' ) ), + 'notice-link' => __( 'Please find this setting at the end of the reference container settings. The link element is needed to apply the theme’s link color.', 'footnotes' ), + ) + ); + // Display template with replaced placeholders. + // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped + echo $l_obj_template->get_content(); + // phpcs:enable + } + + /** + * Displays the setting for the input label issue solution. + * + * @since 2.5.12 + */ + public function label_solution() { + // Options for the input label issue solution. + $l_arr_issue_solutions = array( + 'none' => __( '0. No problem or solved otherwise', 'footnotes' ), + 'move' => __( 'A. Footnotes are moved out and appended after the label’s end (recommended)', 'footnotes' ), + 'disconnect' => __( 'B. Labels with footnotes are disconnected from input element (discouraged)', 'footnotes' ), + ); + // Load template file. + $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'configure-label-solution' ); + // Replace all placeholders. + $l_obj_template->replace( + array( + 'description-1-selection' => __( 'Clicking a footnote referrer in an input element label toggles the input except when hard links are enabled. In jQuery mode, the recommended solution is to move footnotes and append them after the label (option A).', 'footnotes' ), + 'label-selection' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_LABEL_ISSUE_SOLUTION, __( 'Solve input label issue:', 'footnotes' ) ), + 'selection' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_LABEL_ISSUE_SOLUTION, $l_arr_issue_solutions ), + 'description-2-selection' => __( 'Option B is discouraged because disconnecting a label from its input element may compromise accessibility. This option is a last resort in case footnotes must absolutely stay inside the label. (Using jQuery ‘event.stopPropagation’ failed.)', 'footnotes' ), + ) + ); + // Display template with replaced placeholders. + // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped + echo $l_obj_template->get_content(); + // phpcs:enable + } + + /** + * Displays enabled status for the footnotes mouse-over box. + * + * @since 1.5.2 + * + * Edited: + * @since 2.2.0 5 parts to address increased settings number + * @since 2.2.5 position settings for alternative tooltips + */ + public function mouseover_box() { + // Options for Yes/No select box. + $l_arr_enabled = array( + 'yes' => __( 'Yes', 'footnotes' ), + 'no' => __( 'No', 'footnotes' ), + ); + + // Load template file. + $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'mouse-over-box-display' ); + // Replace all placeholders. + $l_obj_template->replace( + array( + + 'label-enable' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_ENABLED, __( 'Display tooltips:', 'footnotes' ) ), + 'enable' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_ENABLED, $l_arr_enabled ), + 'notice-enable' => __( 'Formatted text boxes allowing hyperlinks, displayed on mouse-over or tap and hold.', 'footnotes' ), + + 'label-alternative' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE, __( 'Display alternative tooltips:', 'footnotes' ) ), + 'alternative' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE, $l_arr_enabled ), + 'notice-alternative' => __( 'Intended to work around a configuration-related tooltip outage.', 'footnotes' ), + // Translators: %s: Footnotes plugin logo. + 'description-alternative' => sprintf( __( 'These alternative tooltips work around a website related jQuery UI outage. They are low-script but use the AMP incompatible onmouseover and onmouseout arguments, along with CSS transitions for fade-in/out. The very small script is inserted after Footnotes’ internal stylesheet. When this option is enabled, %s does not load jQuery UI nor jQuery Tools.', 'footnotes' ), '' . MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME . '' ), + + ) + ); + // Display template with replaced placeholders. + // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped + echo $l_obj_template->get_content(); + // phpcs:enable + } + + /** + * Displays position settings for the footnotes mouse-over box. + * + * @since 2.2.0 + */ + public function mouseover_box_position() { + + // Options for the Mouse-over box position. + $l_arr_position = array( + 'top left' => __( 'top left', 'footnotes' ), + 'top center' => __( 'top center', 'footnotes' ), + 'top right' => __( 'top right', 'footnotes' ), + 'center right' => __( 'center right', 'footnotes' ), + 'bottom right' => __( 'bottom right', 'footnotes' ), + 'bottom center' => __( 'bottom center', 'footnotes' ), + 'bottom left' => __( 'bottom left', 'footnotes' ), + 'center left' => __( 'center left', 'footnotes' ), + ); + // Options for the alternative Mouse-over box position. + $l_arr_alternative_position = array( + 'top left' => __( 'top left', 'footnotes' ), + 'top right' => __( 'top right', 'footnotes' ), + 'bottom right' => __( 'bottom right', 'footnotes' ), + 'bottom left' => __( 'bottom left', 'footnotes' ), + ); + + // Load template file. + $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'mouse-over-box-position' ); + // Replace all placeholders. + $l_obj_template->replace( + array( + + 'label-position' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION, __( 'Position:', 'footnotes' ) ), + 'position' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION, $l_arr_position ), + 'position-alternative' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION, $l_arr_alternative_position ), + 'notice-position' => __( 'The second column of settings boxes is for the alternative tooltips.', 'footnotes' ), + + 'label-offset-x' => $this->add_label( MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X, __( 'Horizontal offset:', 'footnotes' ) ), + 'offset-x' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X, -500, 500 ), + 'offset-x-alternative' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X, -500, 500 ), + 'notice-offset-x' => __( 'pixels; negative value for a leftwards offset; alternative tooltips: direction depends on position', 'footnotes' ), + + 'label-offset-y' => $this->add_label( MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y, __( 'Vertical offset:', 'footnotes' ) ), + 'offset-y' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y, -500, 500 ), + 'offset-y-alternative' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y, -500, 500 ), + 'notice-offset-y' => __( 'pixels; negative value for an upwards offset; alternative tooltips: direction depends on position', 'footnotes' ), + + ) + ); + // Display template with replaced placeholders. + // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped + echo $l_obj_template->get_content(); + // phpcs:enable + } + + /** + * Displays dimensions setting for the footnotes mouse-over box. + * + * @since 2.2.0 + */ + public function mouseover_box_dimensions() { + + // Load template file. + $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'mouse-over-box-dimensions' ); + // Replace all placeholders. + $l_obj_template->replace( + array( + + 'label-max-width' => $this->add_label( MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH, __( 'Maximum width:', 'footnotes' ) ), + 'max-width' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH, 0, 1280 ), + 'width' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH, 0, 1280 ), + 'notice-max-width' => __( 'pixels; set to 0 for jQuery tooltips without max width; alternative tooltips are given the value in the second box as fixed width.', 'footnotes' ), + + ) + ); + // Display template with replaced placeholders. + // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped + echo $l_obj_template->get_content(); + // phpcs:enable + } + + /** + * Displays timing settings for the footnotes mouse-over box. + * + * @since 2.2.0 + */ + public function mouseover_box_timing() { + + // Load template file. + $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'mouse-over-box-timing' ); + // Replace all placeholders. + $l_obj_template->replace( + array( + + 'label-fade-in-delay' => $this->add_label( MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY, __( 'Fade-in delay:', 'footnotes' ) ), + 'fade-in-delay' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY, 0, 20000 ), + 'notice-fade-in-delay' => __( 'milliseconds', 'footnotes' ), + + 'label-fade-in-duration' => $this->add_label( MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION, __( 'Fade-in duration:', 'footnotes' ) ), + 'fade-in-duration' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION, 0, 20000 ), + 'notice-fade-in-duration' => __( 'milliseconds', 'footnotes' ), + + 'label-fade-out-delay' => $this->add_label( MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY, __( 'Fade-out delay:', 'footnotes' ) ), + 'fade-out-delay' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY, 0, 20000 ), + 'notice-fade-out-delay' => __( 'milliseconds', 'footnotes' ), + + 'label-fade-out-duration' => $this->add_label( MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION, __( 'Fade-out duration:', 'footnotes' ) ), + 'fade-out-duration' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION, 0, 20000 ), + 'notice-fade-out-duration' => __( 'milliseconds', 'footnotes' ), + + ) + ); + // Display template with replaced placeholders. + // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped + echo $l_obj_template->get_content(); + // phpcs:enable + } + + /** + * Displays truncation settings for the footnotes mouse-over box. + * + * @since 2.2.0 + */ + public function mouseover_box_truncation() { + // Options for Yes/No select box. + $l_arr_enabled = array( + 'yes' => __( 'Yes', 'footnotes' ), + 'no' => __( 'No', 'footnotes' ), + ); + + // Load template file. + $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'mouse-over-box-truncation' ); + // Replace all placeholders. + $l_obj_template->replace( + array( + + 'label-truncation' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED, __( 'Truncate the note in the tooltip:', 'footnotes' ) ), + 'truncation' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED, $l_arr_enabled ), + + 'label-max-length' => $this->add_label( MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH, __( 'Maximum number of characters in the tooltip:', 'footnotes' ) ), + 'max-length' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH, 3, 10000 ), + // The feature trims back until the last full word. + 'notice-max-length' => __( 'No weird cuts.', 'footnotes' ), + + 'label-readon' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_TOOLTIP_READON_LABEL, __( '‘Read on’ button label:', 'footnotes' ) ), + 'readon' => $this->add_text_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_TOOLTIP_READON_LABEL ), + + ) + ); + // Display template with replaced placeholders. + // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped + echo $l_obj_template->get_content(); + // phpcs:enable + } + + /** + * Displays dedicated tooltip text settings for the footnotes mouse-over box. + * + * @since 2.2.0 + */ + public function mouseover_box_text() { + // Options for Yes/No select box. + $l_arr_enabled = array( + 'yes' => __( 'Yes', 'footnotes' ), + 'no' => __( 'No', 'footnotes' ), + ); + + // Load template file. + $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'mouse-over-box-text' ); + // Replace all placeholders. + $l_obj_template->replace( + array( + + 'description-delimiter' => __( 'Tooltips can display another content than the footnote entry in the reference container. The trigger is a shortcode in the footnote text separating the tooltip text from the note. That is consistent with what WordPress does for excerpts.', 'footnotes' ), + + 'label-delimiter' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER, __( 'Delimiter for dedicated tooltip text:', 'footnotes' ) ), + 'delimiter' => $this->add_text_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER ), + 'notice-delimiter' => __( 'If the delimiter shortcode is present, the tooltip text will be the part before it.', 'footnotes' ), + + 'label-mirror' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE, __( 'Mirror the tooltip in the reference container:', 'footnotes' ) ), + 'mirror' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE, $l_arr_enabled ), + 'notice-mirror' => __( 'Tooltips may be harder to use on mobiles. This option allows to read it in the reference container.', 'footnotes' ), + + 'label-separator' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR, __( 'Separator between tooltip text and footnote text:', 'footnotes' ) ), + 'separator' => $this->add_text_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR ), + 'notice-separator' => __( 'May be a simple space, or a line break <br />, or any string in your language.', 'footnotes' ), + + 'description-mirror' => __( 'Tooltips, even jQuery-driven, may be hard to consult on mobiles. This option allows to read the tooltip content in the reference container too.', 'footnotes' ), + + ) + ); + // Display template with replaced placeholders. + // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped + echo $l_obj_template->get_content(); + // phpcs:enable + } + + /** + * Displays style settings for the footnotes mouse-over box. + * + * @since 2.2.0 + */ + public function mouseover_box_appearance() { + // Options for Yes/No select box. + $l_arr_enabled = array( + 'yes' => __( 'Yes', 'footnotes' ), + 'no' => __( 'No', 'footnotes' ), + ); + // Options for the font size unit. + $l_arr_font_size_units = array( + 'em' => __( 'em', 'footnotes' ), + 'rem' => __( 'rem', 'footnotes' ), + 'px' => __( 'pixels', 'footnotes' ), + 'pt' => __( 'points', 'footnotes' ), + 'pc' => __( 'picas', 'footnotes' ), + 'mm' => __( 'millimeters', 'footnotes' ), + '%' => __( 'per cent', 'footnotes' ), + ); + + // Load template file. + $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'mouse-over-box-appearance' ); + // Replace all placeholders. + $l_obj_template->replace( + array( + + 'label-font-size' => $this->add_label( MCI_Footnotes_Settings::C_STR_MOUSE_OVER_BOX_FONT_SIZE_ENABLED, __( 'Set font size:', 'footnotes' ) ), + 'font-size-enable' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_MOUSE_OVER_BOX_FONT_SIZE_ENABLED, $l_arr_enabled ), + 'font-size-scalar' => $this->add_num_box( MCI_Footnotes_Settings::C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR, 0, 50, true ), + 'font-size-unit' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT, $l_arr_font_size_units ), + 'notice-font-size' => __( 'By default, the font size is set to equal the surrounding text.', 'footnotes' ), + + 'label-color' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR, __( 'Text color:', 'footnotes' ) ), + 'color' => $this->add_color_selection( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR ), + // Translators: %s: Clear or leave empty. + 'notice-color' => sprintf( __( 'To use the current theme’s default text color: %s', 'footnotes' ), __( 'Clear or leave empty.', 'footnotes' ) ), + + 'label-background' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND, __( 'Background color:', 'footnotes' ) ), + 'background' => $this->add_color_selection( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND ), + // Translators: %s: Clear or leave empty. + 'notice-background' => sprintf( __( 'To use the current theme’s default background color: %s', 'footnotes' ), __( 'Clear or leave empty.', 'footnotes' ) ), + + 'label-border-width' => $this->add_label( MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH, __( 'Border width:', 'footnotes' ) ), + 'border-width' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH, 0, 4, true ), + 'notice-border-width' => __( 'pixels; 0 for borderless', 'footnotes' ), + + 'label-border-color' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR, __( 'Border color:', 'footnotes' ) ), + 'border-color' => $this->add_color_selection( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR ), + // Translators: %s: Clear or leave empty. + 'notice-border-color' => sprintf( __( 'To use the current theme’s default border color: %s', 'footnotes' ), __( 'Clear or leave empty.', 'footnotes' ) ), + + 'label-border-radius' => $this->add_label( MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS, __( 'Rounded corner radius:', 'footnotes' ) ), + 'border-radius' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS, 0, 500 ), + 'notice-border-radius' => __( 'pixels; 0 for sharp corners', 'footnotes' ), + + 'label-box-shadow-color' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR, __( 'Box shadow color:', 'footnotes' ) ), + 'box-shadow-color' => $this->add_color_selection( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR ), + // Translators: %s: Clear or leave empty. + 'notice-box-shadow-color' => sprintf( __( 'To use the current theme’s default box shadow color: %s', 'footnotes' ), __( 'Clear or leave empty.', 'footnotes' ) ), + + ) + ); + // Display template with replaced placeholders. + // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped + echo $l_obj_template->get_content(); + // phpcs:enable + } + + /** + * Displays all settings for the backlink symbol. + * + * @since 1.5.0 + * + * - Update: **symbol for backlinks** removed; hyperlink moved to the reference number. + * + * @since 2.0.0 + * The former 'hyperlink arrow' is incompatible with combined identical footnotes. + * + * - Update: Reference container: clarify backlink semantics by prepended transitional up arrow, thanks to @mmallett issue report. + * + * @since 2.0.3 + * + * - Update: Restore arrow settings to customize or disable the now prepended arrow symbol, thanks to @mmallett issue report. + * + * @since 2.0.4 + * @date 2020-11-02T2115+0100 + * + * @reporter @mmallett + * @link https://wordpress.org/support/topic/mouse-over-broken/#post-13593037 + * + * @since 2.1.4 moved to Settings > Reference container > Display a backlink symbol + * @since 2.2.1 and 2.2.4 back here + */ + public function hyperlink_arrow() { + // Load template file. + $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'customize-hyperlink-arrow' ); + // Replace all placeholders. + $l_obj_template->replace( + array( + 'label-symbol' => $this->add_label( MCI_Footnotes_Settings::C_STR_HYPERLINK_ARROW, __( 'Select or input the backlink symbol:', 'footnotes' ) ), + 'symbol-options' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_HYPERLINK_ARROW, MCI_Footnotes_Convert::get_arrow() ), + 'symbol-custom' => $this->add_text_box( MCI_Footnotes_Settings::C_STR_HYPERLINK_ARROW_USER_DEFINED ), + 'notice-symbol' => __( 'Your input overrides the selection.', 'footnotes' ), + 'description-symbol' => __( 'This symbol is used in the reference container. But this setting pre-existed under this tab and cannot be moved to another one.', 'footnotes' ), + ) + ); + // Display template with replaced placeholders. + // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped + echo $l_obj_template->get_content(); + // phpcs:enable + } + + /** + * Displays the Custom CSS box. + * + * @since 1.5.0 + * + * Edited: + * @since 2.1.6 drop localized notices for CSS classes as the number increased to 16 + * list directly in the template, as CSS is in English anyway + * @see templates/dashboard/customize-css.html + * 2020-12-09T1113+0100 + * + * @since 2.2.2 migrate Custom CSS to a dedicated tab 2020-12-15T0506+0100 + * @since 2.3.0 say 'copy-paste' instead of 'cut and paste' since cutting is not needed 2020-12-27T1257+0100 + * @since 2.5.1 mention validity while visible, thanks to @rkupadhya bug report + */ + public function custom_css() { + // Load template file. + $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'customize-css' ); + // Replace all placeholders. + $l_obj_template->replace( + array( + 'label-css' => $this->add_label( MCI_Footnotes_Settings::C_STR_CUSTOM_CSS, __( 'Your existing Custom CSS code:', 'footnotes' ) ), + 'css' => $this->add_textarea( MCI_Footnotes_Settings::C_STR_CUSTOM_CSS ), + 'description-css' => __( 'Custom CSS migrates to a dedicated tab. This text area is intended to keep your data safe, and the code remains valid while visible. Please copy-paste the content into the new text area under the new tab.', 'footnotes' ), + + // phpcs:disable Squiz.PHP.CommentedOutCode.Found + // CSS classes are listed in the template. + // Localized notices are dropped to ease translators’ task. + + // "label-class-1" => ".footnote_plugin_tooltip_text",. + // "class-1" => $this->add_text(__("superscript, Footnotes index", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)),. + + // "label-class-2" => ".footnote_tooltip",. + // "class-2" => $this->add_text(__("mouse-over box, tooltip for each superscript", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)),. + + // "label-class-3" => ".footnote_plugin_index",. + // "class-3" => $this->add_text(__("1st column of the Reference Container, Footnotes index", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)),. + + // "label-class-4" => ".footnote_plugin_text",. + // "class-4" => $this->add_text(__("2nd column of the Reference Container, Footnote text", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)). + // phpcs:enable + ) + ); + // Display template with replaced placeholders. + // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped + echo $l_obj_template->get_content(); + // phpcs:enable + } + + /** + * Displays transitional legacy Custom CSS box. + * + * @since 2.2.2 + */ + public function custom_css_migration() { + + // Options for Yes/No select box. + $l_arr_enabled = array( + 'yes' => __( 'Yes', 'footnotes' ), + 'no' => __( 'No', 'footnotes' ), + ); + + // Load template file. + $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'customize-css-migration' ); + // Replace all placeholders. + $l_obj_template->replace( + array( + 'label-css' => $this->add_label( MCI_Footnotes_Settings::C_STR_CUSTOM_CSS, __( 'Your existing Custom CSS code:', 'footnotes' ) ), + 'css' => $this->add_textarea( MCI_Footnotes_Settings::C_STR_CUSTOM_CSS ), + 'description-css' => __( 'Custom CSS migrates to a dedicated tab. This text area is intended to keep your data safe, and the code remains valid while visible. Please copy-paste the content into the new text area below. Set Show legacy to No. Save twice.', 'footnotes' ), + + 'label-show-legacy' => $this->add_label( MCI_Footnotes_Settings::C_STR_CUSTOM_CSS_LEGACY_ENABLE, 'Show legacy Custom CSS settings containers:' ), + 'show-legacy' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_CUSTOM_CSS_LEGACY_ENABLE, $l_arr_enabled ), + 'notice-show-legacy' => __( 'Please set to No when you are done migrating, for the legacy Custom CSS containers to disappear.', 'footnotes' ), + // Translators: %s: Referres and tooltips. + 'description-show-legacy' => sprintf( __( 'The legacy Custom CSS under the %s tab and its mirror here are emptied, and the select box saved as No, when the settings tab is saved while the settings container is not displayed.', 'footnotes' ), __( 'Referrers and tooltips', 'footnotes' ) ), + + ) + ); + // Display template with replaced placeholders. + // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped + echo $l_obj_template->get_content(); + // phpcs:enable + } + + /** + * Displays the new Custom CSS box. + * + * @since 2.2.2 + */ + public function custom_css_new() { + // Load template file. + $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'customize-css-new' ); + // Replace all placeholders. + $l_obj_template->replace( + array( + 'css' => $this->add_textarea( MCI_Footnotes_Settings::C_STR_CUSTOM_CSS_NEW ), + + 'headline' => $this->add_text( __( 'Recommended CSS classes:', 'footnotes' ) ), + + ) + ); + // Display template with replaced placeholders. + // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped + echo $l_obj_template->get_content(); + // phpcs:enable + } + + /** + * Displays available Hooks to look for Footnote short codes. + * + * @since 1.5.5 + * + * Edited: + * @since 2.1.1 priority level setting for the_content 2020-11-16T2152+0100 + * @since 2.1.4 priority level settings for the other hooks 2020-11-19T1421+0100 + * + * priority level was initially hard-coded default + * shows "9223372036854775807" in the numbox + * empty should be interpreted as PHP_INT_MAX, + * but a numbox cannot be set to empty: + * define -1 as PHP_INT_MAX instead + * + * @since 2.2.9 removed the warning about the widget text hook 2020-12-25T0348+0100 + * @since 2.2.9 added guidance for the widget text hook 2020-12-25T0353+0100 + */ + public function lookup_hooks() { + // Load template file. + $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'expert-lookup' ); + + // Replace all placeholders. + $l_obj_template->replace( + array( + 'description-1' => __( 'The priority level determines whether Footnotes is executed timely before other plugins, and how the reference container is positioned relative to other features.', 'footnotes' ), + // Translators: 1: 99; 2: 1200. + 'description-2' => sprintf( __( 'For the_content, this figure must be lower than %1$d so that certain strings added by a plugin running at %1$d may not be mistaken as a footnote. This makes also sure that the reference container displays above a feature inserted by a plugin running at %2$d.', 'footnotes' ), 99, 1200 ), + // Translators: 1: PHP_INT_MAX; 2: 0; 3: -1; 4: 'PHP_INT_MAX'. + 'description-3' => sprintf( __( '%1$d is lowest priority, %2$d is highest. To set priority level to lowest, set it to %3$d, interpreted as %1$d, the constant %4$s.', 'footnotes' ), PHP_INT_MAX, 0, -1, 'PHP_INT_MAX' ), + 'description-4' => __( 'The widget_text hook must be enabled either when footnotes are present in theme text widgets, or when Elementor accordions or toggles shall have a reference container per section. If they should not, this hook must be disabled.', 'footnotes' ), + + 'head-hook' => __( 'WordPress hook function name', 'footnotes' ), + 'head-checkbox' => __( 'Activate', 'footnotes' ), + 'head-numbox' => __( 'Priority level', 'footnotes' ), + 'head-url' => __( 'WordPress documentation', 'footnotes' ), + + 'label-the-title' => $this->add_label( MCI_Footnotes_Settings::C_STR_EXPERT_LOOKUP_THE_TITLE, 'the_title' ), + 'the-title' => $this->add_checkbox( MCI_Footnotes_Settings::C_STR_EXPERT_LOOKUP_THE_TITLE ), + 'priority-the-title' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL, -1, PHP_INT_MAX ), + 'url-the-title' => 'https://developer.wordpress.org/reference/hooks/the_title/', + + 'label-the-content' => $this->add_label( MCI_Footnotes_Settings::C_STR_EXPERT_LOOKUP_THE_CONTENT, 'the_content' ), + 'the-content' => $this->add_checkbox( MCI_Footnotes_Settings::C_STR_EXPERT_LOOKUP_THE_CONTENT ), + 'priority-the-content' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL, -1, PHP_INT_MAX ), + 'url-the-content' => 'https://developer.wordpress.org/reference/hooks/the_content/', + + 'label-the-excerpt' => $this->add_label( MCI_Footnotes_Settings::C_STR_EXPERT_LOOKUP_THE_EXCERPT, 'the_excerpt' ), + 'the-excerpt' => $this->add_checkbox( MCI_Footnotes_Settings::C_STR_EXPERT_LOOKUP_THE_EXCERPT ), + 'priority-the-excerpt' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL, -1, PHP_INT_MAX ), + 'url-the-excerpt' => 'https://developer.wordpress.org/reference/functions/the_excerpt/', + + 'label-widget-title' => $this->add_label( MCI_Footnotes_Settings::C_STR_EXPERT_LOOKUP_WIDGET_TITLE, 'widget_title' ), + 'widget-title' => $this->add_checkbox( MCI_Footnotes_Settings::C_STR_EXPERT_LOOKUP_WIDGET_TITLE ), + 'priority-widget-title' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL, -1, PHP_INT_MAX ), + 'url-widget-title' => 'https://codex.wordpress.org/Plugin_API/Filter_Reference/widget_title', + + 'label-widget-text' => $this->add_label( MCI_Footnotes_Settings::C_STR_EXPERT_LOOKUP_WIDGET_TEXT, 'widget_text' ), + 'widget-text' => $this->add_checkbox( MCI_Footnotes_Settings::C_STR_EXPERT_LOOKUP_WIDGET_TEXT ), + 'priority-widget-text' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL, -1, PHP_INT_MAX ), + 'url-widget-text' => 'https://codex.wordpress.org/Plugin_API/Filter_Reference/widget_text', + ) + ); + // Display template with replaced placeholders. + // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped + echo $l_obj_template->get_content(); + // phpcs:enable + } + + /** + * Displays a short introduction to the Plugin. + * + * @since 1.5.0 + * + * @since 2.7.0 Sanitize Lorem Ipsum filler text. + * @link https://blog.prototypr.io/why-testing-with-real-content-is-better-than-lorem-ipsum-c7c79586ee72 + */ + public function Help() { + global $g_obj_mci_footnotes; + // Load footnotes starting and end tag. + $l_arr_footnote_starting_tag = $this->load_setting( MCI_Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_START ); + $l_arr_footnote_ending_tag = $this->load_setting( MCI_Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_END ); + + if ( 'userdefined' === $l_arr_footnote_starting_tag['value'] || 'userdefined' === $l_arr_footnote_ending_tag['value'] ) { + // Load user defined starting and end tag. + $l_arr_footnote_starting_tag = $this->load_setting( MCI_Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED ); + $l_arr_footnote_ending_tag = $this->load_setting( MCI_Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED ); + } + $l_str_example = 'Hello' . $l_arr_footnote_starting_tag['value'] . + 'Sed ut perspiciatis, unde omnis iste natus error ' . + 'sit voluptatem accusantium doloremque laudantium, ' . + 'totam rem aperiam eaque ipsa, quae ab illo ' . + 'inventore veritatis et quasi architecto beatae ' . + 'vitae dicta sunt, explicabo. Nemo enim ipsam ' . + 'voluptatem, quia voluptas sit, aspernatur aut ' . + 'odit aut fugit, sed quia consequuntur magni ' . + 'dolores eos, qui ratione voluptatem sequi nesciunt, ' . + 'neque porro quisquam est, qui dolorem ipsum, quia ' . + 'dolor sit amet, consectetur, adipisci velit, sed ' . + 'quia non numquam eius modi tempora incidunt, ut ' . + 'labore et dolore magnam aliquam quaerat voluptatem.' . + $l_arr_footnote_ending_tag['value'] . ' World!'; + + // Load template file. + $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'how-to-help' ); + // Replace all placeholders. + $l_obj_template->replace( + array( + 'label-start' => __( 'Start your footnote with the following short code:', 'footnotes' ), + 'start' => $l_arr_footnote_starting_tag['value'], + 'label-end' => __( '…and end your footnote with this short code:', 'footnotes' ), + 'end' => $l_arr_footnote_ending_tag['value'], + 'example-code' => $l_str_example, + 'example-string' => '
                                                                                    ' . __( 'will be displayed as:', 'footnotes' ), + 'example' => $g_obj_mci_footnotes->a_obj_task->exec( $l_str_example, true ), + // Translators: %1$s, %2$s: anchor element with hyperlink to the Support Forum. + 'information' => sprintf( __( 'For further information please check out our %1$sSupport Forum%2$s on WordPress.org.', 'footnotes' ), '', '' ), + ) + ); + + /** + * Call footnotes_output_head function to get the Styling of the mouse-over box. + * + * - Bugfix: Dashboard: debug the 'Quick start guide' tab, thanks to @rumperuu bug report. + * + * @reporter @rumperuu + * @link https://github.com/markcheret/footnotes/issues/71 + * + * @since 2.7.0 + * The name of the callback function ought to be distinct from + * the name of the filtered function. + * When this callback function was renamed, this call went unnoticed. + * @see class/task.php + */ + $g_obj_mci_footnotes->a_obj_task->footnotes_output_head(); + + // Display template with replaced placeholders. + // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped + echo $l_obj_template->get_content(); + // phpcs:enable + } + + /** + * Displays all Donate button to support the developers. + * + * @since 1.5.0 + */ + public function donate() { + // Load template file. + $l_obj_template = new MCI_Footnotes_Template( MCI_Footnotes_Template::C_STR_DASHBOARD, 'how-to-donate' ); + // Replace all placeholders. + $l_obj_template->replace( + array( + 'caption' => __( 'Donate now', 'footnotes' ), + ) + ); + // Display template with replaced placeholders. + // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped + echo $l_obj_template->get_content(); + // phpcs:enable + } +} From d201d7e7056450df3c9fcdf9b7d1331fefd37de6 Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Thu, 15 Apr 2021 17:07:04 +0100 Subject: [PATCH 39/42] docs: remove timestamps --- class/dashboard/init.php | 1 - class/dashboard/layout.php | 12 ++-- class/dashboard/subpage-diagnostics.php | 1 - class/dashboard/subpage-main.php | 81 ++++++++++++------------- 4 files changed, 44 insertions(+), 51 deletions(-) diff --git a/class/dashboard/init.php b/class/dashboard/init.php index c3f505e..39318c9 100644 --- a/class/dashboard/init.php +++ b/class/dashboard/init.php @@ -5,7 +5,6 @@ * @filesource * @package footnotes * @since 1.5.0 - * @date 12.09.14 10:26 */ /** diff --git a/class/dashboard/layout.php b/class/dashboard/layout.php index 6a51e80..db37dad 100644 --- a/class/dashboard/layout.php +++ b/class/dashboard/layout.php @@ -5,12 +5,11 @@ * @filesource * @package footnotes * @since 1.5.0 - * @date 12.09.14 10:56 * - * @since 2.1.2 add versioning of settings.css for cache busting 2020-11-19T1456+0100 - * @since 2.1.4 automate passing version number for cache busting 2020-11-30T0648+0100 - * @since 2.1.4 optional step argument and support for floating in numbox 2020-12-05T0540+0100 - * @since 2.1.6 fix punctuation-related localization issue in dashboard labels 2020-12-08T1547+0100 + * @since 2.1.2 add versioning of settings.css for cache busting + * @since 2.1.4 automate passing version number for cache busting + * @since 2.1.4 optional step argument and support for floating in numbox + * @since 2.1.6 fix punctuation-related localization issue in dashboard labels * * @since 2.5.5 Bugfix: Stylesheets: minify to shrink the carbon footprint, increase speed and implement best practice, thanks to @docteurfitness issue report. */ @@ -199,7 +198,6 @@ abstract class MCI_Footnotes_Layout_Engine { * - 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-14T1928+0100 * * @reporter @docteurfitness * @link https://wordpress.org/support/topic/simply-speed-optimisation/ @@ -556,7 +554,7 @@ abstract class MCI_Footnotes_Layout_Engine { * @return string * * Edited: - * @since 2.1.4 step argument and number_format() to allow decimals 2020-12-03T0631+0100..2020-12-12T1110+0100 + * @since 2.1.4 step argument and number_format() to allow decimals .. */ protected function add_num_box( $p_str_setting_name, $p_in_min, $p_int_max, $p_bool_deci = false ) { // Collect data for given settings field. diff --git a/class/dashboard/subpage-diagnostics.php b/class/dashboard/subpage-diagnostics.php index 1a30015..0889af6 100644 --- a/class/dashboard/subpage-diagnostics.php +++ b/class/dashboard/subpage-diagnostics.php @@ -5,7 +5,6 @@ * @filesource * @package footnotes * @since 1.5.0 - * @date 14.09.14 14:47 */ /** diff --git a/class/dashboard/subpage-main.php b/class/dashboard/subpage-main.php index 40808e5..84caaf6 100644 --- a/class/dashboard/subpage-main.php +++ b/class/dashboard/subpage-main.php @@ -4,39 +4,38 @@ * * @filesource * @since 1.5.0 - * @date 14.09.14 14:47 * - * @since 2.0.4 restore arrow settings 2020-11-01T0509+0100 - * @since 2.1.0 read-on button label 2020-11-08T2148+0100 - * @since 2.1.1 options for ref container and alternative tooltips 2020-11-16T2152+0100 + * @since 2.0.4 restore arrow settings + * @since 2.1.0 read-on button label + * @since 2.1.1 options for ref container and alternative tooltips * @since 2.1.1 Referrers: superscript becomes optional, thanks to @cwbayer bug report * @since 2.1.2 priority level settings for all other hooks, thanks to @nikelaos * @link https://wordpress.org/support/topic/doesnt-work-any-more-11/#post-13676705 - * @since 2.1.4 settings for ref container, tooltips and scrolling 2020-12-03T0950+0100 - * @since 2.1.6 slight UI reordering 2020-12-09T1114+0100 - * @since 2.1.6 option to disable URL line wrapping 2020-12-09T1604+0100 - * @since 2.1.6 remove expert mode setting as outdated 2020-12-09T2105+0100 + * @since 2.1.4 settings for ref container, tooltips and scrolling + * @since 2.1.6 slight UI reordering + * @since 2.1.6 option to disable URL line wrapping + * @since 2.1.6 remove expert mode setting as outdated * @since 2.2.0 start/end short codes: more predefined options, thanks to @nikelaos * @link https://wordpress.org/support/topic/doesnt-work-with-mailpoet/ - * @since 2.2.0 add options, redistribute, update strings 2020-12-12T2135+0100 - * @since 2.2.0 shortcode for reference container custom position 2020-12-13T2055+0100 - * @since 2.2.2 Custom CSS settings container migration 2020-12-15T0709+0100 - * @since 2.2.4 move backlink symbol selection under previous tab 2020-12-16T1244+0100 - * @since 2.2.5 support for Ibid. notation thanks to @meglio 2020-12-17T2021+0100 + * @since 2.2.0 add options, redistribute, update strings + * @since 2.2.0 shortcode for reference container custom position + * @since 2.2.2 Custom CSS settings container migration + * @since 2.2.4 move backlink symbol selection under previous tab + * @since 2.2.5 support for Ibid. notation thanks to @meglio * @link https://wordpress.org/support/topic/add-support-for-ibid-notation/ - * @since 2.2.5 options for label element and label bottom border, thanks to @markhillyer 2020-12-18T1447+0100 + * @since 2.2.5 options for label element and label bottom border, thanks to @markhillyer * @link https://wordpress.org/support/topic/how-do-i-eliminate-the-horizontal-line-beneath-the-reference-container-heading/ - * @since 2.2.10 reference container row border option, thanks to @noobishh 2020-12-25T2316+0100 + * @since 2.2.10 reference container row border option, thanks to @noobishh * @link https://wordpress.org/support/topic/borders-25/ * @since 2.3.0 Reference container: convert top padding to margin and make it a setting, thanks to @hamshe * @link https://wordpress.org/support/topic/reference-container-in-elementor/#post-13786635 - * @since 2.3.0 rename Priority level tab as Scope and priority 2020-12-26T2222+0100 - * @since 2.3.0 swap Custom CSS migration Boolean from 'migration complete' to 'show legacy' 2020-12-27T1243+0100 - * @since 2.3.0 mention op. cit. abbreviation 2020-12-28T2342+0100 - * @since 2.3.0 add settings for hard links, thanks to @psykonevro and @martinneumannat 2020-12-29T1322+0100 + * @since 2.3.0 rename Priority level tab as Scope and priority + * @since 2.3.0 swap Custom CSS migration Boolean from 'migration complete' to 'show legacy' + * @since 2.3.0 mention op. cit. abbreviation + * @since 2.3.0 add settings for hard links, thanks to @psykonevro and @martinneumannat * @link https://wordpress.org/support/topic/making-it-amp-compatible/ * @link https://wordpress.org/support/topic/footnotes-is-not-amp-compatible/ - * @since 2.4.0 footnote shortcode syntax validation 2021-01-01T0624+0100 + * @since 2.4.0 footnote shortcode syntax validation * @since 2.5.0 Shortcode syntax validation: add more information around the setting, thanks to @andreasra * @link https://wordpress.org/support/topic/warning-unbalanced-footnote-start-tag-short-code-before/ */ @@ -200,8 +199,8 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { * @since 1.5.0 * * Completed: - * @since 2.1.4: layout and typography options 2020-11-30T0548+0100 - * @since 2.2.5 options for label element and label bottom border, thanks to @markhillyer 2020-12-18T1447+0100 + * @since 2.1.4: layout and typography options + * @since 2.2.5 options for label element and label bottom border, thanks to @markhillyer * @link https://wordpress.org/support/topic/how-do-i-eliminate-the-horizontal-line-beneath-the-reference-container-heading/ */ public function reference_container() { @@ -376,14 +375,14 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { * * @since 1.5.0 * - * Edited heading 2020-12-12T1412+0100 - * @since 2.2.0 start/end short codes: more predefined options 2020-12-12T1412+0100 + * Edited heading + * @since 2.2.0 start/end short codes: more predefined options * @link https://wordpress.org/support/topic/doesnt-work-with-mailpoet/ - * @since 2.2.0 3 boxes for clarity 2020-12-12T1422+0100 - * @since 2.2.5 support for Ibid. notation thanks to @meglio 2020-12-17T2019+0100 + * @since 2.2.0 3 boxes for clarity + * @since 2.2.5 support for Ibid. notation thanks to @meglio * @link https://wordpress.org/support/topic/add-support-for-ibid-notation/ - * @since 2.4.0 added warning about Block Editor escapement disruption 2021-01-02T2324+0100 - * @since 2.4.0 removed the HTML comment tag option 2021-01-02T2325+0100 + * @since 2.4.0 added warning about Block Editor escapement disruption + * @since 2.4.0 removed the HTML comment tag option * @since 2.5.0 Shortcode syntax validation: add more information around the setting, thanks to @andreasra * @link https://wordpress.org/support/topic/warning-unbalanced-footnote-start-tag-short-code-before/ */ @@ -619,8 +618,8 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { * @since 1.5.0 * * Edited: - * @since 2.2.0 position-sensitive placeholders to support more locales 2020-12-11T0432+0100 - * @since 2.2.0 more options 2020-12-11T0432+0100 + * @since 2.2.0 position-sensitive placeholders to support more locales + * @since 2.2.0 more options */ public function love() { // Options for the acknowledgment display in the footer. @@ -668,11 +667,11 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { * * @since 1.5.0 * - * Edited heading 2020-12-12T1453+0100 + * Edited heading * @since 2.1.1 more settings and notices, thanks to @nikelaos * @link https://wordpress.org/support/topic/doesnt-work-any-more-11/#post-13687068 * @link https://wordpress.org/support/topic/jquery-comes-up-in-feed-content/#post-13110879 - * @since 2.2.0 dedicated to the excerpt setting and its notices 2020-12-12T1454+0100 + * @since 2.2.0 dedicated to the excerpt setting and its notices */ public function excerpts() { // Options for options select box. @@ -706,9 +705,9 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { * * @since 1.5.0 * - * Edited heading 2020-12-12T1513+0100 + * Edited heading * @since 2.1.1 option for superscript (optionally baseline referrers) - * @since 2.2.0 option for link element moved here 2020-12-12T1514+0100 + * @since 2.2.0 option for link element moved here */ public function superscript() { // Options for Yes/No select box. @@ -1103,7 +1102,6 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { * - Update: Restore arrow settings to customize or disable the now prepended arrow symbol, thanks to @mmallett issue report. * * @since 2.0.4 - * @date 2020-11-02T2115+0100 * * @reporter @mmallett * @link https://wordpress.org/support/topic/mouse-over-broken/#post-13593037 @@ -1139,10 +1137,9 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { * @since 2.1.6 drop localized notices for CSS classes as the number increased to 16 * list directly in the template, as CSS is in English anyway * @see templates/dashboard/customize-css.html - * 2020-12-09T1113+0100 * - * @since 2.2.2 migrate Custom CSS to a dedicated tab 2020-12-15T0506+0100 - * @since 2.3.0 say 'copy-paste' instead of 'cut and paste' since cutting is not needed 2020-12-27T1257+0100 + * @since 2.2.2 migrate Custom CSS to a dedicated tab + * @since 2.3.0 say 'copy-paste' instead of 'cut and paste' since cutting is not needed * @since 2.5.1 mention validity while visible, thanks to @rkupadhya bug report */ public function custom_css() { @@ -1244,8 +1241,8 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { * @since 1.5.5 * * Edited: - * @since 2.1.1 priority level setting for the_content 2020-11-16T2152+0100 - * @since 2.1.4 priority level settings for the other hooks 2020-11-19T1421+0100 + * @since 2.1.1 priority level setting for the_content + * @since 2.1.4 priority level settings for the other hooks * * priority level was initially hard-coded default * shows "9223372036854775807" in the numbox @@ -1253,8 +1250,8 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { * but a numbox cannot be set to empty: * define -1 as PHP_INT_MAX instead * - * @since 2.2.9 removed the warning about the widget text hook 2020-12-25T0348+0100 - * @since 2.2.9 added guidance for the widget text hook 2020-12-25T0353+0100 + * @since 2.2.9 removed the warning about the widget text hook + * @since 2.2.9 added guidance for the widget text hook */ public function lookup_hooks() { // Load template file. From 11c2af6f9c3e866b6f232a03d381e19a207643cb Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Thu, 15 Apr 2021 17:07:55 +0100 Subject: [PATCH 40/42] fix: correct constant name --- class/dashboard/layout.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/class/dashboard/layout.php b/class/dashboard/layout.php index db37dad..b3d24e0 100644 --- a/class/dashboard/layout.php +++ b/class/dashboard/layout.php @@ -209,7 +209,7 @@ abstract class MCI_Footnotes_Layout_Engine { * automated update of version number for cache busting. * No need to use '-styles' in the handle, as '-css' is appended automatically. */ - if ( true === C_BOOL_CSS_PRODUCTION_MODE ) { + if ( true === PRODUCTION_ENV ) { wp_register_style( 'mci-footnotes-admin', plugins_url( 'footnotes/css/settings.min.css' ), array(), C_STR_FOOTNOTES_VERSION ); From b565a56a05655f293eb55f956ed0aaa965350efe Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Thu, 15 Apr 2021 17:11:37 +0100 Subject: [PATCH 41/42] fix: replace apostrophes 1/2 --- class/dashboard/subpage-main.php | 48 ++++++++++++++++---------------- 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/class/dashboard/subpage-main.php b/class/dashboard/subpage-main.php index 84caaf6..d9dbd82 100644 --- a/class/dashboard/subpage-main.php +++ b/class/dashboard/subpage-main.php @@ -120,7 +120,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { * * @since 2.0.4 to reflect changes in meta box label display since WPv5.5 * spans need position:fixed and become unlocalizable - * fix: logo is kept only in the label that doesn’t need to be translated: + * fix: logo is kept only in the label that doesn\'t need to be translated: * Change string "%s styling" to "Footnotes styling" to fix layout in WPv5.5 * @see details in class/config.php * @@ -178,13 +178,13 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { // Replace all placeholders. $l_obj_template->replace( array( - // Translators: '%s' is the link text 'AMP-WP' linked to the plugin’s front page on WordPress.org. + // Translators: '%s' is the link text 'AMP-WP' linked to the plugin\'s front page on WordPress.org. 'description-1-amp' => sprintf( __( 'The official %s plugin is required when this option is enabled.', 'footnotes' ), 'AMP-WP' ), 'label-amp' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_AMP_COMPATIBILITY_ENABLE, __( 'Enable AMP compatibility mode:', 'footnotes' ) ), 'amp' => $this->add_checkbox( MCI_Footnotes_Settings::C_STR_FOOTNOTES_AMP_COMPATIBILITY_ENABLE ), 'notice-amp' => __( 'This option enables hard links with configurable scroll offset in % viewport height.', 'footnotes' ), // Translators: '%s' is the logogram of the 'Footnotes' plugin. - 'description-2-amp' => sprintf( __( '%s is becoming AMP compatible when this box is checked. Styled tooltips are displayed with fade-in/fade-out effect if enabled, and the reference container expands also on clicking a referrer if it’s collapsed by default.', 'footnotes' ), '' . MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME . '' ), + 'description-2-amp' => sprintf( __( '%s is becoming AMP compatible when this box is checked. Styled tooltips are displayed with fade-in/fade-out effect if enabled, and the reference container expands also on clicking a referrer if it\'s collapsed by default.', 'footnotes' ), '' . MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME . '' ), ) ); // Display template with replaced placeholders. @@ -236,7 +236,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { ); // Options for the terminating punctuation after backlinks. // The Unicode name of RIGHT PARENTHESIS was originally more accurate because. - // This character is bidi-mirrored. Let’s use the Unicode 1.0 name. + // This character is bidi-mirrored. Let\'s use the Unicode 1.0 name. // The wrong names were enforced in spite of Unicode, that subsequently scrambled to correct. $l_arr_terminators = array( 'period' => __( 'FULL STOP', 'footnotes' ), @@ -271,7 +271,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { 'label-name' => $this->add_label( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_NAME, __( 'Heading:', 'footnotes' ) ), 'name' => $this->add_text_box( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_NAME ), - 'label-element' => $this->add_label( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT, __( 'Heading’s HTML element:', 'footnotes' ) ), + 'label-element' => $this->add_label( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT, __( 'Heading\'s HTML element:', 'footnotes' ) ), 'element' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT, $l_arr_label_element ), 'label-border' => $this->add_label( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER, __( 'Border under the heading:', 'footnotes' ) ), @@ -310,11 +310,11 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { 'label-page-layout' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT, __( 'Apply basic responsive page layout:', 'footnotes' ) ), 'page-layout' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT, $l_arr_page_layout_options ), - 'notice-page-layout' => __( 'Most themes don’t need this fix.', 'footnotes' ), + 'notice-page-layout' => __( 'Most themes don\'t need this fix.', 'footnotes' ), 'label-url-wrap' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTE_URL_WRAP_ENABLED, __( 'Allow URLs to line-wrap anywhere:', 'footnotes' ) ), 'url-wrap' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTE_URL_WRAP_ENABLED, $l_arr_enabled ), - 'notice-url-wrap' => __( 'Unicode-conformant browsers don’t need this fix.', 'footnotes' ), + 'notice-url-wrap' => __( 'Unicode-conformant browsers don\'t need this fix.', 'footnotes' ), 'label-symbol' => $this->add_label( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE, __( 'Display a backlink symbol:', 'footnotes' ) ), 'symbol-enable' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE, $l_arr_enabled ), @@ -346,13 +346,13 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { 'width-enable' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_BACKLINKS_COLUMN_WIDTH_ENABLED, $l_arr_enabled ), 'width-scalar' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR, 0, 500, true ), 'width-unit' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_BACKLINKS_COLUMN_WIDTH_UNIT, $l_arr_width_units ), - 'notice-width' => __( 'Absolute width in pixels doesn’t need to be accurate to the tenth, but relative width in rem or em may.', 'footnotes' ), + 'notice-width' => __( 'Absolute width in pixels doesn\'t need to be accurate to the tenth, but relative width in rem or em may.', 'footnotes' ), 'label-max-width' => $this->add_label( MCI_Footnotes_Settings::C_STR_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED, __( 'Set backlinks column maximum width:', 'footnotes' ) ), 'max-width-enable' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED, $l_arr_enabled ), 'max-width-scalar' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR, 0, 500, true ), 'max-width-unit' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT, $l_arr_width_units ), - 'notice-max-width' => __( 'Absolute width in pixels doesn’t need to be accurate to the tenth, but relative width in rem or em may.', 'footnotes' ), + 'notice-max-width' => __( 'Absolute width in pixels doesn\'t need to be accurate to the tenth, but relative width in rem or em may.', 'footnotes' ), 'label-line-break' => $this->add_label( MCI_Footnotes_Settings::C_STR_BACKLINKS_LINE_BREAKS_ENABLED, __( 'Stack backlinks when enumerating:', 'footnotes' ) ), 'line-break' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_BACKLINKS_LINE_BREAKS_ENABLED, $l_arr_enabled ), @@ -360,7 +360,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { 'label-link' => $this->add_label( MCI_Footnotes_Settings::C_STR_LINK_ELEMENT_ENABLED, __( 'Use the link element for referrers and backlinks:', 'footnotes' ) ), 'link' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_LINK_ELEMENT_ENABLED, $l_arr_enabled ), - 'notice-link' => __( 'The link element is needed to apply the theme’s link color.', 'footnotes' ), + 'notice-link' => __( 'The link element is needed to apply the theme\'s link color.', 'footnotes' ), 'description-link' => __( 'If the link element is not desired for styling, a simple span is used instead when the above is set to No.', 'footnotes' ), ) ); @@ -449,7 +449,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { 'syntax' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE, $l_arr_enable ), 'notice-syntax' => __( 'In the presence of a lone start tag shortcode, a warning displays below the post title.', 'footnotes' ), - 'description-syntax' => __( 'If the start tag short code is ‘((’ or ‘(((’, it will not be reported as unbalanced if the following string contains braces hinting that it is a script.', 'footnotes' ), + 'description-syntax' => __( 'If the start tag short code is ‘((\' or ‘(((\', it will not be reported as unbalanced if the following string contains braces hinting that it is a script.', 'footnotes' ), ) ); // Display template with replaced placeholders. @@ -649,7 +649,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { $l_obj_template->replace( array( // Translators: %s: Footnotes plugin logo. - 'label-love' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_LOVE, sprintf( __( 'Tell the world you’re using %s:', 'footnotes' ), MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME ) ), + 'label-love' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_LOVE, sprintf( __( 'Tell the world you\'re using %s:', 'footnotes' ), MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME ) ), 'love' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_LOVE, $l_arr_love ), // Translators: %s: Footnotes plugin logo. 'label-no-love' => $this->add_text( sprintf( __( 'Shortcode to inhibit the display of the %s mention on specific pages:', 'footnotes' ), MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME ) ), @@ -689,7 +689,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { 'label-excerpts' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_IN_EXCERPT, __( 'Process footnotes in excerpts:', 'footnotes' ) ), 'excerpts' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_IN_EXCERPT, $l_arr_excerpt_mode ), 'notice-excerpts' => __( 'If the_excerpt is enabled.', 'footnotes' ), - // Translators: %s: link text 'Advanced Excerpt' linked to the plugin’s WordPress.org front page. + // Translators: %s: link text 'Advanced Excerpt' linked to the plugin\'s WordPress.org front page. // Translators: %s: Footnotes plugin logo. 'description-excerpts' => sprintf( __( 'To not display footnotes in excerpts, the %s plugin generates excerpts on the basis of the posts to be able to remove the footnotes. Else, footnotes may be processed in manual excerpts OR processed based on the posts. — For this setting to be effective, the hook the_excerpt must be enabled under Scope and priority.', 'footnotes' ), '' . MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME . '' ), ) @@ -731,7 +731,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { 'label-normalize' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT, __( 'Normalize vertical alignment and font size:', 'footnotes' ) ), 'normalize' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT, $l_arr_normalize_superscript ), - 'notice-normalize' => __( 'Most themes don’t need this fix.', 'footnotes' ), + 'notice-normalize' => __( 'Most themes don\'t need this fix.', 'footnotes' ), 'label-before' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_STYLING_BEFORE, __( 'At the start of the footnote referrers:', 'footnotes' ) ), 'before' => $this->add_text_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_STYLING_BEFORE ), @@ -740,7 +740,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { 'after' => $this->add_text_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_STYLING_AFTER ), 'label-link' => $this->add_label( MCI_Footnotes_Settings::C_STR_LINK_ELEMENT_ENABLED, __( 'Use the link element for referrers and backlinks:', 'footnotes' ) ), - 'notice-link' => __( 'Please find this setting at the end of the reference container settings. The link element is needed to apply the theme’s link color.', 'footnotes' ), + 'notice-link' => __( 'Please find this setting at the end of the reference container settings. The link element is needed to apply the theme\'s link color.', 'footnotes' ), ) ); // Display template with replaced placeholders. @@ -758,7 +758,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { // Options for the input label issue solution. $l_arr_issue_solutions = array( 'none' => __( '0. No problem or solved otherwise', 'footnotes' ), - 'move' => __( 'A. Footnotes are moved out and appended after the label’s end (recommended)', 'footnotes' ), + 'move' => __( 'A. Footnotes are moved out and appended after the label\'s end (recommended)', 'footnotes' ), 'disconnect' => __( 'B. Labels with footnotes are disconnected from input element (discouraged)', 'footnotes' ), ); // Load template file. @@ -769,7 +769,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { 'description-1-selection' => __( 'Clicking a footnote referrer in an input element label toggles the input except when hard links are enabled. In jQuery mode, the recommended solution is to move footnotes and append them after the label (option A).', 'footnotes' ), 'label-selection' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_LABEL_ISSUE_SOLUTION, __( 'Solve input label issue:', 'footnotes' ) ), 'selection' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_LABEL_ISSUE_SOLUTION, $l_arr_issue_solutions ), - 'description-2-selection' => __( 'Option B is discouraged because disconnecting a label from its input element may compromise accessibility. This option is a last resort in case footnotes must absolutely stay inside the label. (Using jQuery ‘event.stopPropagation’ failed.)', 'footnotes' ), + 'description-2-selection' => __( 'Option B is discouraged because disconnecting a label from its input element may compromise accessibility. This option is a last resort in case footnotes must absolutely stay inside the label. (Using jQuery ‘event.stopPropagation\' failed.)', 'footnotes' ), ) ); // Display template with replaced placeholders. @@ -808,7 +808,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { 'alternative' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE, $l_arr_enabled ), 'notice-alternative' => __( 'Intended to work around a configuration-related tooltip outage.', 'footnotes' ), // Translators: %s: Footnotes plugin logo. - 'description-alternative' => sprintf( __( 'These alternative tooltips work around a website related jQuery UI outage. They are low-script but use the AMP incompatible onmouseover and onmouseout arguments, along with CSS transitions for fade-in/out. The very small script is inserted after Footnotes’ internal stylesheet. When this option is enabled, %s does not load jQuery UI nor jQuery Tools.', 'footnotes' ), '' . MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME . '' ), + 'description-alternative' => sprintf( __( 'These alternative tooltips work around a website related jQuery UI outage. They are low-script but use the AMP incompatible onmouseover and onmouseout arguments, along with CSS transitions for fade-in/out. The very small script is inserted after Footnotes\' internal stylesheet. When this option is enabled, %s does not load jQuery UI nor jQuery Tools.', 'footnotes' ), '' . MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME . '' ), ) ); @@ -962,7 +962,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { // The feature trims back until the last full word. 'notice-max-length' => __( 'No weird cuts.', 'footnotes' ), - 'label-readon' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_TOOLTIP_READON_LABEL, __( '‘Read on’ button label:', 'footnotes' ) ), + 'label-readon' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_TOOLTIP_READON_LABEL, __( '‘Read on\' button label:', 'footnotes' ) ), 'readon' => $this->add_text_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_TOOLTIP_READON_LABEL ), ) @@ -1052,12 +1052,12 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { 'label-color' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR, __( 'Text color:', 'footnotes' ) ), 'color' => $this->add_color_selection( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR ), // Translators: %s: Clear or leave empty. - 'notice-color' => sprintf( __( 'To use the current theme’s default text color: %s', 'footnotes' ), __( 'Clear or leave empty.', 'footnotes' ) ), + 'notice-color' => sprintf( __( 'To use the current theme\'s default text color: %s', 'footnotes' ), __( 'Clear or leave empty.', 'footnotes' ) ), 'label-background' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND, __( 'Background color:', 'footnotes' ) ), 'background' => $this->add_color_selection( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND ), // Translators: %s: Clear or leave empty. - 'notice-background' => sprintf( __( 'To use the current theme’s default background color: %s', 'footnotes' ), __( 'Clear or leave empty.', 'footnotes' ) ), + 'notice-background' => sprintf( __( 'To use the current theme\'s default background color: %s', 'footnotes' ), __( 'Clear or leave empty.', 'footnotes' ) ), 'label-border-width' => $this->add_label( MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH, __( 'Border width:', 'footnotes' ) ), 'border-width' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH, 0, 4, true ), @@ -1066,7 +1066,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { 'label-border-color' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR, __( 'Border color:', 'footnotes' ) ), 'border-color' => $this->add_color_selection( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR ), // Translators: %s: Clear or leave empty. - 'notice-border-color' => sprintf( __( 'To use the current theme’s default border color: %s', 'footnotes' ), __( 'Clear or leave empty.', 'footnotes' ) ), + 'notice-border-color' => sprintf( __( 'To use the current theme\'s default border color: %s', 'footnotes' ), __( 'Clear or leave empty.', 'footnotes' ) ), 'label-border-radius' => $this->add_label( MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS, __( 'Rounded corner radius:', 'footnotes' ) ), 'border-radius' => $this->add_num_box( MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS, 0, 500 ), @@ -1075,7 +1075,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { 'label-box-shadow-color' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR, __( 'Box shadow color:', 'footnotes' ) ), 'box-shadow-color' => $this->add_color_selection( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR ), // Translators: %s: Clear or leave empty. - 'notice-box-shadow-color' => sprintf( __( 'To use the current theme’s default box shadow color: %s', 'footnotes' ), __( 'Clear or leave empty.', 'footnotes' ) ), + 'notice-box-shadow-color' => sprintf( __( 'To use the current theme\'s default box shadow color: %s', 'footnotes' ), __( 'Clear or leave empty.', 'footnotes' ) ), ) ); @@ -1154,7 +1154,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { // phpcs:disable Squiz.PHP.CommentedOutCode.Found // CSS classes are listed in the template. - // Localized notices are dropped to ease translators’ task. + // Localized notices are dropped to ease translators\' task. // "label-class-1" => ".footnote_plugin_tooltip_text",. // "class-1" => $this->add_text(__("superscript, Footnotes index", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)),. From a5356d8052fb93a88fc095fb9f3394a87aa4a1d4 Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Thu, 15 Apr 2021 17:17:27 +0100 Subject: [PATCH 42/42] fix: other assorted fixes --- class/dashboard/subpage-main.php | 32 ++++++++++++++++---------------- class/hooks.php | 3 +-- class/layout/abstract-engine.php | 2 +- class/layout/foo | 0 4 files changed, 18 insertions(+), 19 deletions(-) delete mode 100644 class/layout/foo diff --git a/class/dashboard/subpage-main.php b/class/dashboard/subpage-main.php index d9dbd82..419e1c8 100644 --- a/class/dashboard/subpage-main.php +++ b/class/dashboard/subpage-main.php @@ -120,7 +120,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { * * @since 2.0.4 to reflect changes in meta box label display since WPv5.5 * spans need position:fixed and become unlocalizable - * fix: logo is kept only in the label that doesn\'t need to be translated: + * fix: logo is kept only in the label that doesn't need to be translated: * Change string "%s styling" to "Footnotes styling" to fix layout in WPv5.5 * @see details in class/config.php * @@ -178,7 +178,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { // Replace all placeholders. $l_obj_template->replace( array( - // Translators: '%s' is the link text 'AMP-WP' linked to the plugin\'s front page on WordPress.org. + // Translators: '%s' is the link text 'AMP-WP' linked to the plugin's front page on WordPress.org. 'description-1-amp' => sprintf( __( 'The official %s plugin is required when this option is enabled.', 'footnotes' ), 'AMP-WP' ), 'label-amp' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_AMP_COMPATIBILITY_ENABLE, __( 'Enable AMP compatibility mode:', 'footnotes' ) ), 'amp' => $this->add_checkbox( MCI_Footnotes_Settings::C_STR_FOOTNOTES_AMP_COMPATIBILITY_ENABLE ), @@ -236,7 +236,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { ); // Options for the terminating punctuation after backlinks. // The Unicode name of RIGHT PARENTHESIS was originally more accurate because. - // This character is bidi-mirrored. Let\'s use the Unicode 1.0 name. + // This character is bidi-mirrored. Let's use the Unicode 1.0 name. // The wrong names were enforced in spite of Unicode, that subsequently scrambled to correct. $l_arr_terminators = array( 'period' => __( 'FULL STOP', 'footnotes' ), @@ -449,7 +449,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { 'syntax' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE, $l_arr_enable ), 'notice-syntax' => __( 'In the presence of a lone start tag shortcode, a warning displays below the post title.', 'footnotes' ), - 'description-syntax' => __( 'If the start tag short code is ‘((\' or ‘(((\', it will not be reported as unbalanced if the following string contains braces hinting that it is a script.', 'footnotes' ), + 'description-syntax' => __( 'If the start tag short code is \'((\' or \'(((\', it will not be reported as unbalanced if the following string contains braces hinting that it is a script.', 'footnotes' ), ) ); // Display template with replaced placeholders. @@ -473,12 +473,12 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { ); // Options for the numbering style of the footnotes. $l_arr_counter_style = array( - 'arabic_plain' => __( 'plain Arabic numbers', 'footnotes' ) . $l_str_space . '1, 2, 3, 4, 5, …', - 'arabic_leading' => __( 'zero-padded Arabic numbers', 'footnotes' ) . $l_str_space . '01, 02, 03, 04, 05, …', - 'latin_low' => __( 'lowercase Latin letters', 'footnotes' ) . $l_str_space . 'a, b, c, d, e, …', - 'latin_high' => __( 'uppercase Latin letters', 'footnotes' ) . $l_str_space . 'A, B, C, D, E, …', - 'romanic' => __( 'uppercase Roman numerals', 'footnotes' ) . $l_str_space . 'I, II, III, IV, V, …', - 'roman_low' => __( 'lowercase Roman numerals', 'footnotes' ) . $l_str_space . 'i, ii, iii, iv, v, …', + 'arabic_plain' => __( 'plain Arabic numbers', 'footnotes' ) . $l_str_space . '1, 2, 3, 4, 5, …', + 'arabic_leading' => __( 'zero-padded Arabic numbers', 'footnotes' ) . $l_str_space . '01, 02, 03, 04, 05, …', + 'latin_low' => __( 'lowercase Latin letters', 'footnotes' ) . $l_str_space . 'a, b, c, d, e, …', + 'latin_high' => __( 'uppercase Latin letters', 'footnotes' ) . $l_str_space . 'A, B, C, D, E, …', + 'romanic' => __( 'uppercase Roman numerals', 'footnotes' ) . $l_str_space . 'I, II, III, IV, V, …', + 'roman_low' => __( 'lowercase Roman numerals', 'footnotes' ) . $l_str_space . 'i, ii, iii, iv, v, …', ); // Load template file. @@ -640,7 +640,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { 'text-2' => sprintf( __( 'This website uses the awesome %s plugin.', 'footnotes' ), MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME ), 'random' => __( 'randomly determined display of either mention', 'footnotes' ), // Translators: 1: Plugin logo.2: heart symbol. - 'no' => sprintf( __( 'no display of any “%1$s %2$s” mention in the footer', 'footnotes' ), MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME, MCI_Footnotes_Config::C_STR_LOVE_SYMBOL ), + 'no' => sprintf( __( 'no display of any "%1$s %2$s" mention in the footer', 'footnotes' ), MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME, MCI_Footnotes_Config::C_STR_LOVE_SYMBOL ), ); // Load template file. @@ -766,10 +766,10 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { // Replace all placeholders. $l_obj_template->replace( array( - 'description-1-selection' => __( 'Clicking a footnote referrer in an input element label toggles the input except when hard links are enabled. In jQuery mode, the recommended solution is to move footnotes and append them after the label (option A).', 'footnotes' ), + 'description-1-selection' => __( 'Clicking a footnote referrer in an input element label toggles the input except when hard links are enabled. In jQuery mode, the recommended solution is to move footnotes and append them after the label (option A).', 'footnotes' ), 'label-selection' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_LABEL_ISSUE_SOLUTION, __( 'Solve input label issue:', 'footnotes' ) ), 'selection' => $this->add_select_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_LABEL_ISSUE_SOLUTION, $l_arr_issue_solutions ), - 'description-2-selection' => __( 'Option B is discouraged because disconnecting a label from its input element may compromise accessibility. This option is a last resort in case footnotes must absolutely stay inside the label. (Using jQuery ‘event.stopPropagation\' failed.)', 'footnotes' ), + 'description-2-selection' => __( 'Option B is discouraged because disconnecting a label from its input element may compromise accessibility. This option is a last resort in case footnotes must absolutely stay inside the label. (Using jQuery \'event.stopPropagation\' failed.)', 'footnotes' ), ) ); // Display template with replaced placeholders. @@ -962,7 +962,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { // The feature trims back until the last full word. 'notice-max-length' => __( 'No weird cuts.', 'footnotes' ), - 'label-readon' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_TOOLTIP_READON_LABEL, __( '‘Read on\' button label:', 'footnotes' ) ), + 'label-readon' => $this->add_label( MCI_Footnotes_Settings::C_STR_FOOTNOTES_TOOLTIP_READON_LABEL, __( '\'Read on\' button label:', 'footnotes' ) ), 'readon' => $this->add_text_box( MCI_Footnotes_Settings::C_STR_FOOTNOTES_TOOLTIP_READON_LABEL ), ) @@ -1154,7 +1154,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { // phpcs:disable Squiz.PHP.CommentedOutCode.Found // CSS classes are listed in the template. - // Localized notices are dropped to ease translators\' task. + // Localized notices are dropped to ease translators' task. // "label-class-1" => ".footnote_plugin_tooltip_text",. // "class-1" => $this->add_text(__("superscript, Footnotes index", MCI_Footnotes_Config::C_STR_PLUGIN_NAME)),. @@ -1345,7 +1345,7 @@ class MCI_Footnotes_Layout_Settings extends MCI_Footnotes_Layout_Engine { array( 'label-start' => __( 'Start your footnote with the following short code:', 'footnotes' ), 'start' => $l_arr_footnote_starting_tag['value'], - 'label-end' => __( '…and end your footnote with this short code:', 'footnotes' ), + 'label-end' => __( '…and end your footnote with this short code:', 'footnotes' ), 'end' => $l_arr_footnote_ending_tag['value'], 'example-code' => $l_str_example, 'example-string' => '
                                                                                    ' . __( 'will be displayed as:', 'footnotes' ), diff --git a/class/hooks.php b/class/hooks.php index 11c76c3..eb1ba00 100644 --- a/class/hooks.php +++ b/class/hooks.php @@ -49,8 +49,7 @@ class MCI_Footnotes_Hooks { * @since 1.5.0 * * @since 2.2.0 this function is not called any longer when deleting the plugin. - * @date 2020-12-12T1223+0100 - * Note: clear_all() didn’t actually work. + * Note: clear_all() didn't actually work. * @see class/settings.php */ public static function uninstall_plugin() { diff --git a/class/layout/abstract-engine.php b/class/layout/abstract-engine.php index 6540ae5..c8c6aa5 100644 --- a/class/layout/abstract-engine.php +++ b/class/layout/abstract-engine.php @@ -496,7 +496,7 @@ abstract class MCI_Footnotes_Layout_Engine { '', $l_str_value, // Only check for equality, not identity, WRT backlink symbol arrows. - $l_str_value === $l_arr_data['value'] ? 'selected' : '', + $l_str_value == $l_arr_data['value'] ? 'selected' : '', $l_str_caption ); } diff --git a/class/layout/foo b/class/layout/foo deleted file mode 100644 index e69de29..0000000