* * 2.0.9: DISABLED the_post HOOK 2020-11-08T1839+0100 * 2.1.0: promoted the 'Continue reading' button from localization to customization 2020-11-08T2146+0100 * 2.1.1: combining identical footnotes: fixed dead links 2020-11-14T2233+0100 * * Last modified 2020-11-14T2233+0100 */ // If called directly, abort: defined( 'ABSPATH' ) or die; /** * Looks for Footnotes short codes and replaces them. Also displays the Reference Container. * * @author Stefan Herndler * @since 1.5.0 */ class MCI_Footnotes_Task { /** * Contains all footnotes found on current public page. * * @author Stefan Herndler * @since 1.5.0 * @var array */ public static $a_arr_Footnotes = array(); /** * Flag if the display of 'LOVE FOOTNOTES' is allowed on the current public page. * * @author Stefan Herndler * @since 1.5.0 * @var bool */ public static $a_bool_AllowLoveMe = true; /** * Prefix for the Footnote html element ID. * * @author Stefan Herndler * @since 1.5.8 * @var string */ public static $a_str_Prefix = ""; /** * Register WordPress Hooks to replace Footnotes in the content of a public page. * * @author Stefan Herndler * @since 1.5.0 * * Edited for v2.0.5 through v2.0.7 2020-11-02T0330+0100..2020-11-06T1344+0100 * * Explicitly setting all priority to (default) "10" instead of lowest "PHP_INT_MAX", * especially for the_content, makes the footnotes reference container display * beneath the content and above other features added by other plugins. * Requested by users: * Documentation: * * But this change is suspected to cause issues and needs to be assessed! * See */ public function registerHooks() { // append custom css to the header add_filter('wp_head', array($this, "wp_head"), PHP_INT_MAX); // append the love and share me slug to the footer add_filter('wp_footer', array($this, "wp_footer"), PHP_INT_MAX); if (MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_EXPERT_LOOKUP_THE_TITLE))) { add_filter('the_title', array($this, "the_title"), PHP_INT_MAX); } if (MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_EXPERT_LOOKUP_THE_CONTENT))) { add_filter('the_content', array($this, "the_content"), PHP_INT_MAX); } if (MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_EXPERT_LOOKUP_THE_EXCERPT))) { add_filter('the_excerpt', array($this, "the_excerpt"), PHP_INT_MAX); } if (MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_EXPERT_LOOKUP_WIDGET_TITLE))) { add_filter('widget_title', array($this, "widget_title"), PHP_INT_MAX); } if (MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_EXPERT_LOOKUP_WIDGET_TEXT))) { add_filter('widget_text', array($this, "widget_text"), PHP_INT_MAX); } // DISABLED the_post HOOK 2020-11-08T1839+0100 // // // reset stored footnotes when displaying the header self::$a_arr_Footnotes = array(); self::$a_bool_AllowLoveMe = true; } /** * Outputs the custom css to the header of the public page. * * @author Stefan Herndler * @since 1.5.0 */ public function wp_head() { $l_str_Color = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR); $l_str_Background = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND); $l_int_BorderWidth = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH); $l_str_BorderColor = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR); $l_int_BorderRadius = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS); $l_int_MaxWidth = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH); $l_str_BoxShadowColor = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR); ?> get(MCI_Footnotes_Settings::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE))) { echo '\r\n"; }; } /** * Displays the 'LOVE FOOTNOTES' slug if enabled. * * @author Stefan Herndler * @since 1.5.0 */ public function wp_footer() { if (MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_POSITION) == "footer") { echo $this->ReferenceContainer(); } // get setting for love and share this plugin $l_str_LoveMeIndex = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_LOVE); // check if the admin allows to add a link to the footer if (empty($l_str_LoveMeIndex) || strtolower($l_str_LoveMeIndex) == "no" || !self::$a_bool_AllowLoveMe) { return; } // set a hyperlink to the word "footnotes" in the Love slug $l_str_LinkedName = sprintf('%s',MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME); // get random love me text if (strtolower($l_str_LoveMeIndex) == "random") { $l_str_LoveMeIndex = "text-" . rand(1,3); } switch ($l_str_LoveMeIndex) { case "text-1": $l_str_LoveMeText = sprintf(__('I %s %s', MCI_Footnotes_Config::C_STR_PLUGIN_NAME), MCI_Footnotes_Config::C_STR_LOVE_SYMBOL, $l_str_LinkedName); break; case "text-2": $l_str_LoveMeText = sprintf(__('this site uses the awesome %s Plugin', MCI_Footnotes_Config::C_STR_PLUGIN_NAME), $l_str_LinkedName); break; case "text-3": default: $l_str_LoveMeText = sprintf(__('extra smooth %s', MCI_Footnotes_Config::C_STR_PLUGIN_NAME), $l_str_LinkedName); break; } echo sprintf('
%s
', $l_str_LoveMeText); } /** * Replaces footnotes in the post/page title. * * @author Stefan Herndler * @since 1.5.0 * @param string $p_str_Content Widget content. * @return string Content with replaced footnotes. */ public function the_title($p_str_Content) { // appends the reference container if set to "post_end" return $this->exec($p_str_Content, false); } /** * Replaces footnotes in the content of the current page/post. * * @author Stefan Herndler * @since 1.5.0 * @param string $p_str_Content Page/Post content. * @return string Content with replaced footnotes. */ public function the_content($p_str_Content) { // appends the reference container if set to "post_end" return $this->exec($p_str_Content, MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_POSITION) == "post_end" ? true : false); } /** * Replaces footnotes in the excerpt of the current page/post. * * @author Stefan Herndler * @since 1.5.0 * @param string $p_str_Content Page/Post content. * @return string Content with replaced footnotes. */ public function the_excerpt($p_str_Content) { return $this->exec($p_str_Content, false, !MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_FOOTNOTES_IN_EXCERPT))); } /** * Replaces footnotes in the widget title. * * @author Stefan Herndler * @since 1.5.0 * @param string $p_str_Content Widget content. * @return string Content with replaced footnotes. */ public function widget_title($p_str_Content) { // appends the reference container if set to "post_end" return $this->exec($p_str_Content, false); } /** * Replaces footnotes in the content of the current widget. * * @author Stefan Herndler * @since 1.5.0 * @param string $p_str_Content Widget content. * @return string Content with replaced footnotes. */ public function widget_text($p_str_Content) { // appends the reference container if set to "post_end" return $this->exec($p_str_Content, MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_POSITION) == "post_end" ? true : false); } /** * Replaces footnotes in each Content var of the current Post object. * * @author Stefan Herndler * @since 1.5.4 * @param array|WP_Post $p_mixed_Posts */ public function the_post(&$p_mixed_Posts) { // single WP_Post object received if (!is_array($p_mixed_Posts)) { $p_mixed_Posts = $this->replacePostObject($p_mixed_Posts); return; } // array of WP_Post objects received for($l_int_Index = 0; $l_int_Index < count($p_mixed_Posts); $l_int_Index++) { $p_mixed_Posts[$l_int_Index] = $this->replacePostObject($p_mixed_Posts[$l_int_Index]); } } /** * Replace all Footnotes in a WP_Post object. * * @author Stefan Herndler * @since 1.5.6 * @param WP_Post $p_obj_Post * @return WP_Post */ private function replacePostObject($p_obj_Post) { //MCI_Footnotes_Convert::debug($p_obj_Post); $p_obj_Post->post_content = $this->exec($p_obj_Post->post_content); $p_obj_Post->post_content_filtered = $this->exec($p_obj_Post->post_content_filtered); $p_obj_Post->post_excerpt = $this->exec($p_obj_Post->post_excerpt); return $p_obj_Post; } /** * Replaces all footnotes that occur in the given content. * * @author Stefan Herndler * @since 1.5.0 * @param string $p_str_Content Any string that may contain footnotes to be replaced. * @param bool $p_bool_OutputReferences Appends the Reference Container to the output if set to true, default true. * @param bool $p_bool_HideFootnotesText Hide footnotes found in the string. * @return string */ public function exec($p_str_Content, $p_bool_OutputReferences = false, $p_bool_HideFootnotesText = false) { // replace all footnotes in the content, settings are converted to html characters $p_str_Content = $this->search($p_str_Content, true, $p_bool_HideFootnotesText); // replace all footnotes in the content, settings are NOT converted to html characters $p_str_Content = $this->search($p_str_Content, false, $p_bool_HideFootnotesText); // append the reference container if ($p_bool_OutputReferences) { $p_str_Content = $p_str_Content . $this->ReferenceContainer(); } // take a look if the LOVE ME slug should NOT be displayed on this page/post, remove the short code if found if (strpos($p_str_Content, MCI_Footnotes_Config::C_STR_NO_LOVE_SLUG) !== false) { self::$a_bool_AllowLoveMe = false; $p_str_Content = str_replace(MCI_Footnotes_Config::C_STR_NO_LOVE_SLUG, "", $p_str_Content); } // return the content with replaced footnotes and optional reference container append return $p_str_Content; } /** * Replaces all footnotes in the given content and appends them to the static property. * * @author Stefan Herndler * @since 1.5.0 * @param string $p_str_Content Content to be searched for footnotes. * @param bool $p_bool_ConvertHtmlChars html encode settings, default true. * @param bool $p_bool_HideFootnotesText Hide footnotes found in the string. * @return string */ public function search($p_str_Content, $p_bool_ConvertHtmlChars, $p_bool_HideFootnotesText) { // post ID to make everything unique wrt infinite scroll and archive view global $l_int_PostId; $l_int_PostId = get_the_id(); // contains the index for the next footnote on this page $l_int_FootnoteIndex = count(self::$a_arr_Footnotes) + 1; // contains the starting position for the lookup of a footnote $l_int_PosStart = 0; // get start and end tag for the footnotes short code $l_str_StartingTag = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_START); $l_str_EndingTag = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_END); if ($l_str_StartingTag == "userdefined" || $l_str_EndingTag == "userdefined") { $l_str_StartingTag = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED); $l_str_EndingTag = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED); } // decode html special chars if ($p_bool_ConvertHtmlChars) { $l_str_StartingTag = htmlspecialchars($l_str_StartingTag); $l_str_EndingTag = htmlspecialchars($l_str_EndingTag); } // if footnotes short code is empty, return the content without changes if (empty($l_str_StartingTag) || empty($l_str_EndingTag)) { return $p_str_Content; } if (!$p_bool_HideFootnotesText) { // load template file if (MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE))) { $l_obj_Template = new MCI_Footnotes_Template(MCI_Footnotes_Template::C_STR_PUBLIC, "footnote-alternative"); } else { $l_obj_Template = new MCI_Footnotes_Template(MCI_Footnotes_Template::C_STR_PUBLIC, "footnote"); } $l_obj_TemplateTooltip = new MCI_Footnotes_Template(MCI_Footnotes_Template::C_STR_PUBLIC, "tooltip"); } else { $l_obj_Template = null; $l_obj_TemplateTooltip = null; } // search footnotes short codes in the content do { // get first occurrence of the footnote short code [start] $i_int_len_Content = strlen($p_str_Content); if ($l_int_PosStart > $i_int_len_Content) $l_int_PosStart = $i_int_len_Content; $l_int_PosStart = strpos($p_str_Content, $l_str_StartingTag, $l_int_PosStart); // no short code found, stop here if ($l_int_PosStart === false) { break; } // get first occurrence of a footnote short code [end] $l_int_PosEnd = strpos($p_str_Content, $l_str_EndingTag, $l_int_PosStart); // no short code found, stop here if ($l_int_PosEnd === false) { break; } // calculate the length of the footnote $l_int_Length = $l_int_PosEnd - $l_int_PosStart; // get footnote text $l_str_FootnoteText = substr($p_str_Content, $l_int_PosStart + strlen($l_str_StartingTag), $l_int_Length - strlen($l_str_StartingTag)); // Text to be displayed instead of the footnote $l_str_FootnoteReplaceText = ""; // display the footnote as mouse-over box if (!$p_bool_HideFootnotesText) { $l_int_Index = MCI_Footnotes_Convert::Index($l_int_FootnoteIndex, MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_COUNTER_STYLE)); // display only an excerpt of the footnotes text if enabled $l_str_ExcerptText = $l_str_FootnoteText; $l_bool_EnableExcerpt = MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED)); $l_int_MaxLength = intval(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH)); if ($l_bool_EnableExcerpt) { $l_str_DummyText = strip_tags($l_str_FootnoteText); if (is_int($l_int_MaxLength) && strlen($l_str_DummyText) > $l_int_MaxLength) { $l_str_ExcerptText = substr($l_str_DummyText, 0, $l_int_MaxLength); $l_str_ExcerptText = substr($l_str_ExcerptText, 0, strrpos($l_str_ExcerptText, ' ')); $l_str_ExcerptText .= ' … ' . '' . MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_TOOLTIP_READON_LABEL) . ''; } } // fill in 'templates/public/footnote.html': $l_obj_Template->replace( array( "post_id" => $l_int_PostId, "id" => $l_int_Index, "before" => MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_STYLING_BEFORE), "index" => $l_int_Index, "after" => MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_STYLING_AFTER), "text" => MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED)) ? $l_str_ExcerptText : "", ) ); $l_str_FootnoteReplaceText = $l_obj_Template->getContent(); // reset the template $l_obj_Template->reload(); if (MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED))) { $l_int_OffsetY = intval(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y)); $l_int_OffsetX = intval(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X)); // fill in 'templates/public/tooltip.html': $l_obj_TemplateTooltip->replace( array( "post_id" => $l_int_PostId, "id" => $l_int_Index, "position" => MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION), "offset-y" => !empty($l_int_OffsetY) ? $l_int_OffsetY : 0, "offset-x" => !empty($l_int_OffsetX) ? $l_int_OffsetX : 0, ) ); if (!MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE))) { $l_str_FootnoteReplaceText .= $l_obj_TemplateTooltip->getContent(); } $l_obj_TemplateTooltip->reload(); } } // replace the footnote with the template $p_str_Content = substr_replace($p_str_Content, $l_str_FootnoteReplaceText, $l_int_PosStart, $l_int_Length + strlen($l_str_EndingTag)); // add footnote only if not empty if (!empty($l_str_FootnoteText)) { // set footnote to the output box at the end self::$a_arr_Footnotes[] = $l_str_FootnoteText; // increase footnote index $l_int_FootnoteIndex++; } // add offset to the new starting position $l_int_PosStart += $l_int_Length + strlen($l_str_EndingTag); $l_int_PosStart = $l_int_Length + strlen($l_str_FootnoteReplaceText); } while (true); // return content return $p_str_Content; } /** * Generates the reference container. * * @author Stefan Herndler * @since 1.5.0 * @return string * * Edited for 2.0.6: fixed line breaking behavior in footnote # clusters * Edited for 2.1.1: fixed fragment IDs and backlinks with combine identical turned on 2020-11-14T1808+0100 */ public function ReferenceContainer() { // post ID to make everything unique wrt infinite scroll and archive view: global $l_int_PostId; $l_int_PostId = get_the_id(); // no footnotes has been replaced on this page if (empty(self::$a_arr_Footnotes)) { return ""; } // FOOTNOTE INDEX BACKLINK SYMBOL // get html arrow $l_str_Arrow = MCI_Footnotes_Convert::getArrow(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_HYPERLINK_ARROW)); // set html arrow to the first one if invalid index defined if (is_array($l_str_Arrow)) { $l_str_Arrow = MCI_Footnotes_Convert::getArrow(0); } // get user defined arrow $l_str_ArrowUserDefined = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_HYPERLINK_ARROW_USER_DEFINED); if (!empty($l_str_ArrowUserDefined)) { $l_str_Arrow = $l_str_ArrowUserDefined; } // REFERENCE CONTAINER TABLE ROW TEMPLATE LOAD // line breaks for source readability: $l_str_Body = "\r\n\r\n"; // When combine identical is turned on, another template is needed: if (MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_COMBINE_IDENTICAL_FOOTNOTES))) { // In the combined template, identifiers only are clickable. $l_obj_Template = new MCI_Footnotes_Template(MCI_Footnotes_Template::C_STR_PUBLIC, "reference-container-body-combi"); } else { // In the standard template the whole cell is clickable. $l_obj_Template = new MCI_Footnotes_Template(MCI_Footnotes_Template::C_STR_PUBLIC, "reference-container-body"); } // FILL IN THE TEMPLATE // loop through all footnotes found in the page for ($l_int_Index = 0; $l_int_Index < count(self::$a_arr_Footnotes); $l_int_Index++) { // TEXT COLUMN // get footnote text $l_str_FootnoteText = self::$a_arr_Footnotes[$l_int_Index]; // if footnote is empty, get to the next one // With combine identical turned on, identicals will be deleted and are skipped: if (empty($l_str_FootnoteText)) { continue; } // INDEX COLUMN WITH ONE BACKLINK PER TABLE ROW // Standard behavior appropriate for combine identical TURNED OFF // generate content of footnote index cell $l_int_FirstFootnoteIndex = ($l_int_Index + 1); // wrap each index # in a white-space:nowrap span $l_str_FootnoteArrowIndex = ''; // wrap the arrow in a @media print { display:hidden } span (re-used below): $l_str_FootnoteArrow = ''; $l_str_FootnoteArrow .= $l_str_Arrow . ' '; // and add it: $l_str_FootnoteArrowIndex .= $l_str_FootnoteArrow; // get the footnote index string and // keep supporting legacy index placeholder: $l_str_FootnoteIndex = MCI_Footnotes_Convert::Index(($l_int_Index + 1), MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_COUNTER_STYLE)); // add the footnote index string to arrow-index string: // (span closing tag is added after the if statement) $l_str_FootnoteArrowIndex .= $l_str_FootnoteIndex; // SUPPORT FOR COMBINE IDENTICAL: COMPOSING ENUMERATED BACKLINKS // NOW FIRST START from zero again, because the above is useless for // enumerating backlinks. The dedicated template uses a new placeholder: $l_str_FootnoteId = $l_str_FootnoteIndex; $l_str_FootnoteBacklinks = '"; $l_str_FootnoteBacklinks .= $l_str_FootnoteArrow; $l_str_FootnoteBacklinks .= $l_str_FootnoteId . ''; // If this is the only footnote with that text, we’re done. // CHECK IF COMBINE IDENTICAL IS TURNED ON, and // check if it isn't the last footnote in the array: if ($l_int_FirstFootnoteIndex < count(self::$a_arr_Footnotes) && MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_COMBINE_IDENTICAL_FOOTNOTES))) { // get all footnotes that haven't passed yet: for ($l_int_CheckIndex = $l_int_FirstFootnoteIndex; $l_int_CheckIndex < count(self::$a_arr_Footnotes); $l_int_CheckIndex++) { // check if a further footnote is the same as the actual one: if ($l_str_FootnoteText == self::$a_arr_Footnotes[$l_int_CheckIndex]) { // if so, set the further footnote as empty so it won't be displayed later: self::$a_arr_Footnotes[$l_int_CheckIndex] = ""; // HERE GOES THE FRAGMENT IDENTIFIER AND THE BACKLINK TOO: // add the footnote index to the actual index: // update the footnote ID: $l_str_FootnoteId = MCI_Footnotes_Convert::Index(($l_int_CheckIndex + 1), MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_COUNTER_STYLE)); // keep on composing the backlinks enumeration: $l_str_FootnoteBacklinks .= ', "; $l_str_FootnoteBacklinks .= $l_str_FootnoteArrow; $l_str_FootnoteBacklinks .= $l_str_FootnoteId . ''; // below is not used: $l_str_FootnoteArrowIndex .= ', ' . MCI_Footnotes_Convert::Index(($l_int_CheckIndex + 1), MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_COUNTER_STYLE)); // this legacy neither: $l_str_FootnoteIndex .= ', ' . MCI_Footnotes_Convert::Index(($l_int_CheckIndex + 1), MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_COUNTER_STYLE)); } } } // close the outer span FOR WHEN COMBINE IDENTICAL IS TURNED OFF: $l_str_FootnoteArrowIndex .= ''; // replace all placeholders in 'templates/public/reference-container-body.html' // or in 'templates/public/reference-container-body-combi.html' // The individual arrow and index placeholders are for backcompat. $l_obj_Template->replace( array( // placeholder used in all templates: "text" => $l_str_FootnoteText, // used in standard layout W/O COMBINED FOOTNOTES: "post_id" => $l_int_PostId, "id" => MCI_Footnotes_Convert::Index($l_int_FirstFootnoteIndex, MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_COUNTER_STYLE)), "arrow-index" => $l_str_FootnoteArrowIndex, // used in standard layout WITH COMBINED IDENTICALS TURNED ON: "backlinks" => $l_str_FootnoteBacklinks, // Legacy placeholders for use in legacy layout templates: "arrow" => $l_str_Arrow, "index" => $l_str_FootnoteIndex, ) ); // extra line breaks for page source legibility: $l_str_Body .= $l_obj_Template->getContent(); $l_str_Body .= "\r\n\r\n"; $l_obj_Template->reload(); } // load 'templates/public/reference-container.html': $l_obj_TemplateContainer = new MCI_Footnotes_Template(MCI_Footnotes_Template::C_STR_PUBLIC, "reference-container"); $l_obj_TemplateContainer->replace( array( "post_id" => $l_int_PostId, "label" => MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_NAME), "button-style" => !MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_REFERENCE_CONTAINER_COLLAPSE)) ? 'display: none;' : '', "style" => MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_REFERENCE_CONTAINER_COLLAPSE)) ? 'display: none;' : '', "content" => $l_str_Body, ) ); // free all found footnotes if reference container will be displayed self::$a_arr_Footnotes = array(); return $l_obj_TemplateContainer->getContent(); } }