Added reading time to the blog post

magefan · Feb 19, 2024 · e212302 · e212302
1 parent 7a0706d
commit e212302
Show file tree

Hide file tree

Showing 10 changed files with 100 additions and 0 deletions.
diff --git a/Block/Post/Info.php b/Block/Post/Info.php
@@ -78,4 +78,16 @@ public function viewsCountEnabled()
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         );
     }
+
+    /**
+     * Retrieve 1 if display reading time is enabled
+     * @return int
+     */
+    public function readingTimeEnabled()
+    {
+        return (int) $this->_scopeConfig->getValue(
+            'mfblog/post_view/reading_time/enabled',
+            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
+        );
+    }
 }
diff --git a/Block/Post/View.php b/Block/Post/View.php
@@ -146,4 +146,16 @@ public function getTemplate()
         }
         return parent::getTemplate();
     }
+
+    /**
+     * Retrieve 1 if display reading time is enabled
+     * @return int
+     */
+    public function readingTimeEnabled()
+    {
+        return (int) $this->_scopeConfig->getValue(
+            'mfblog/post_view/reading_time/enabled',
+            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
+        );
+    }
 }
diff --git a/Model/Post.php b/Model/Post.php
@@ -1098,4 +1098,30 @@ public function getShortContentExtractor()
 
         return $this->shortContentExtractor;
     }
+
+    /**
+     * Retrieve reading time
+     * @return int
+     */
+    public function getReadingTime()
+    {
+        if (!$this->getData('reading_time')) {
+            $wpm = 250;
+            $contentHtml = $this->getFilteredContent();
+            $numberOfImages = substr_count( strtolower( $contentHtml ), '<img ' );
+            $additionalWordsForImages = (int)($numberOfImages * 12) / $wpm;
+            $wordCount = count(preg_split( '/\s+/', strip_tags($contentHtml)));
+
+            $readingTime = 1;
+
+            if (!$wordCount && !$additionalWordsForImages){
+                return $readingTime;
+            }
+            $readingTime = ceil(($wordCount + $additionalWordsForImages) / $wpm);
+
+            $this->setData('reading_time', $readingTime);
+        }
+
+        return (int)$this->getData('reading_time');
+    }
 }
diff --git a/Setup/UpgradeSchema.php b/Setup/UpgradeSchema.php
@@ -814,6 +814,19 @@ public function upgrade(SchemaSetupInterface $setup, ModuleContextInterface $con
                     'after' => 'meta_description'
                 ]
             );
+
+            /* Add reading time to posts table */
+            $connection->addColumn(
+                $setup->getTable('magefan_blog_post'),
+                'reading_time',
+                [
+                    'type' => \Magento\Framework\DB\Ddl\Table::TYPE_INTEGER,
+                    'length' => 20,
+                    'nullable' => true,
+                    'comment' => 'Post Reading Time',
+                    'after' => 'views_count'
+                ]
+            );
         }
 
         $setup->endSetup();

diff --git a/etc/adminhtml/system.xml b/etc/adminhtml/system.xml
@@ -220,6 +220,14 @@
                         <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
                     </field>
                 </group>
+
+                <group id="reading_time" translate="label" type="text" sortOrder="60" showInDefault="1" showInWebsite="1" showInStore="1">
+                    <label>Reading Time</label>
+                    <field id="enabled" translate="label comment" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
+                        <label>Display Reading Time</label>
+                        <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
+                    </field>
+                </group>
             </group>
 
             <group id="post_list" translate="label" type="text" sortOrder="40" showInDefault="1" showInWebsite="1" showInStore="1">

diff --git a/etc/config.xml b/etc/config.xml
@@ -63,6 +63,9 @@
                 <views_count>
                     <enabled>0</enabled>
                 </views_count>
+                <reading_time>
+                    <enabled>0</enabled>
+                </reading_time>
             </post_view>
             <post_list>
                 <template>list-modern</template>

diff --git a/view/adminhtml/ui_component/blog_post_form.xml b/view/adminhtml/ui_component/blog_post_form.xml
@@ -409,6 +409,18 @@
                 </item>
             </argument>
         </field>
+        <field name="reading_time">
+            <argument name="data" xsi:type="array">
+                <item name="config" xsi:type="array">
+                    <item name="dataType" xsi:type="string">integer</item>
+                    <item name="label" xsi:type="string" translate="true">Reading time (In minutes)</item>
+                    <item name="formElement" xsi:type="string">input</item>
+                    <item name="source" xsi:type="string">post</item>
+                    <item name="sortOrder" xsi:type="number">90</item>
+                    <item name="dataScope" xsi:type="string">reading_time</item>
+                </item>
+            </argument>
+        </field>
     </fieldset>
     <fieldset name="gallery">
         <argument name="data" xsi:type="array">

diff --git a/view/frontend/templates/post/info.phtml b/view/frontend/templates/post/info.phtml
@@ -100,6 +100,14 @@
         <?php } ?>
     <?php } ?>
 
+    <!-- reading time -->
+    <?php if ($block->readingTimeEnabled() && $_post->getReadingTime()) { ?>
+        <div class="item post-reading-time">
+            <i class="mf-blog-icon mfbi-reading-time"></i>
+            <span class="value"><?= $block->escapeHtml($_post->getReadingTime()) . ' ' . __('min read') ?></span>
+        </div>
+    <?php } ?>
+
     <?php if ($block->viewsCountEnabled()) { ?>
         <?php if ($viewsCount = $_post->getViewsCount()) { ?>
             <div class="item post-views">

diff --git a/view/frontend/templates/post/view-modern.phtml b/view/frontend/templates/post/view-modern.phtml
@@ -77,6 +77,11 @@
                     <span class="post-date"><?= $block->escapeHtml($_post->getPublishDate()) ?></span>
                 <?php } ?>
 
+                <!-- reading time -->
+                <?php if ($block->readingTimeEnabled() && $_post->getReadingTime()) { ?>
+                    <span class="reading-time"><?= ' - ' . $block->escapeHtml($_post->getReadingTime()) . ' ' . __('min read') ?></span>
+                <?php } ?>
+
                 <!-- post views -->
                 <?php if ($block->viewsCountEnabled()) { ?>
                     <?php if ($viewsCount = $_post->getViewsCount()) { ?>

diff --git a/view/frontend/web/css/blog-m.css b/view/frontend/web/css/blog-m.css
@@ -223,6 +223,7 @@
 .mf-blog-icon.mfbi-tags {background-image: url('../images/tags-icon.svg')}
 .mf-blog-icon.mfbi-user {background-image: url('../images/user-icon.svg')}
 .mf-blog-icon.mfbi-views {background-image: url('../images/views-icon.svg')}
+.mf-blog-icon.mfbi-reading-time {background-image: url('../images/views-icon.svg')}
 /* END Fix Related Products */