New: Improvements to 'essential_edit_button' for child themes.

gjb2048 · Sep 29, 2016 · dca223d · dca223d
1 parent 7f50aed
commit dca223d
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 6 deletions.
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -15,6 +15,7 @@ New in 3.1.0.9
 - FIX: Issue #765: Link font family is wrong.
 - FIX: Breadcrumb style two fixes.
 - NEW: Issue #738: Fixes #736 add extra urlcolor for stripes.
+- NEW: Improvements to 'essential_edit_button' for child themes.
 
 New in 3.1.0.8
 ==============

diff --git a/classes/output/core_renderer.php b/classes/output/core_renderer.php
@@ -2024,23 +2024,61 @@ public function essential_marketing_button($spot) {
             $url .= \theme_essential\toolbox::get_setting('marketing'.$spot.'buttontext', true);
             $url .= '</a>';
         }
-        $edit = $this->essential_edit_button('theme_essential_frontpage');
+        $edit = $this->essential_edit_button('frontpage');
         if ((!empty($url)) || (!empty($edit))) {
             $o = '<div class="marketing-buttons">'.$url.$edit.'</div>';
         }
 
         return $o;
     }
 
-    public function essential_edit_button($section) {
+    /**
+     * Generates the edit button markup.
+     *
+     * Ensure that the 'essential_edit_button_settingspage' method has the 'keys' and values for the sections
+     * in the settings.php file of the theme that the layout and tile files call this method for.
+     *
+     * @param string $sectionkey settings section key.
+     * @return string or null of not needed.
+     */
+    public function essential_edit_button($sectionkey) {
         global $CFG;
         if ($this->page->user_is_editing() && is_siteadmin()) {
+            $themesectionkey = $this->essential_edit_button_settingspage($sectionkey);
             $url = preg_replace("(https?:)", "", $CFG->wwwroot . '/admin/settings.php?section=');
-            return '<a class="btn btn-success" href="'.$url.$section.'">'.get_string('edit').'</a>';
+            return '<a class="btn btn-success" href="'.$url.$themesectionkey.'">'.get_string('edit').'</a>';
         }
         return null;
     }
 
+
+    /**
+     * Finds the setting section for the given section key.
+     *
+     * This must match the ones in the settings.php file of the theme that the layout and tile files
+     * call the 'essential_edit_button' method for.
+     *
+     * @param string $sectionkey settings section key.
+     * @return string or false if not found.
+     */
+    protected function essential_edit_button_settingspage($sectionkey) {
+        $themesectionkey = false;
+
+        switch ($sectionkey) {
+            case 'frontpage':
+                $themesectionkey = 'theme_essential_frontpage';
+            break;
+            case 'footer':
+                $themesectionkey = 'theme_essential_footer';
+            break;
+            case 'slideshow':
+                $themesectionkey = 'theme_essential_slideshow';
+            break;
+        }
+
+        return $themesectionkey;
+    }
+
     public function get_title($location) {
         global $CFG, $SITE;
         $title = '';

diff --git a/layout/frontpage.php b/layout/frontpage.php
@@ -131,7 +131,7 @@
                 <div class="bor"></div>
                 <?php
                 echo \theme_essential\toolbox::get_setting('frontcontentarea', 'format_html');
-                echo $OUTPUT->essential_edit_button('theme_essential_frontpage');
+                echo $OUTPUT->essential_edit_button('frontpage');
                 ?>
                 <div class="bor"></div>
             </div>

diff --git a/layout/tiles/footer.php b/layout/tiles/footer.php
@@ -27,7 +27,7 @@
 if (empty($PAGE->layout_options['nofooter'])) { ?>
     <footer role="contentinfo" id="page-footer">
         <div class="container-fluid">
-            <?php echo $OUTPUT->essential_edit_button('theme_essential_footer'); ?>
+            <?php echo $OUTPUT->essential_edit_button('footer'); ?>
             <div class="row-fluid footerblocks">
                 <div class="footerblock span4">
                     <?php echo $OUTPUT->blocks('footer-left'); ?>

diff --git a/layout/tiles/slideshow.php b/layout/tiles/slideshow.php
@@ -58,7 +58,7 @@
     <div class="row-fluid">
         <div class="span12">
             <div id="essentialCarousel" class="carousel slide" data-interval="<?php echo $slideinterval;?>">
-                <?php echo $OUTPUT->essential_edit_button('theme_essential_slideshow');?>
+                <?php echo $OUTPUT->essential_edit_button('slideshow');?>
                 <ol class="carousel-indicators">
                     <?php echo \theme_essential\toolbox::render_indicators($numberofslides); ?>
                 </ol>