Merge pull request #13 from lukeyouell/develop

Develop
jalendport · Feb 21, 2019 · 7e8e43e · 7e8e43e
2 parents 3ae4b36 + c4e1766
commit 7e8e43e
Show file tree

Hide file tree

Showing 4 changed files with 65 additions and 43 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,11 @@
 
 All notable changes to this project will be documented in this file.
 
+## 1.5.0 - 2019-02-21
+
+### Added
+- Matrix field support
+
 ## 1.4.0 - 2018-07-31
 
 ### Added

diff --git a/README.md b/README.md
@@ -62,22 +62,18 @@ Returns: 3 minutes
 
 ## Using the Function
 
-The `readTime()` function returns a [TimeModel](#timemodel) for the whole entry based on it's field layout.
+The `readTime()` function returns a [TimeModel](#timemodel) for matrix fields or the whole entry based on it's field layout.
 
 Seconds are included by default, but can be disabled by adding a second parameter of `false` - this only affects the human time format.
 
 #### Examples
 
 ```twig
-{{ readTime(entry) }}
-
-Returns: 9 minutes, 40 seconds
+{{ readTime(entry) }} or {{ readTime(entry.matrixField.all()) }}
 ```
 
 ```twig
-{{ readTime(entry, false) }}
-
-Returns: 10 minutes
+{{ readTime(entry, false) }} or {{ readTime(entry.matrixField.all(), false) }}
 ```
 
 ## TimeModel
@@ -92,6 +88,8 @@ Outputting a TimeModel object without attaching a property or method will return
 {{ string|readTime }}
 
 {{ readTime(entry) }}
+
+{{ readTime(entry.matrixField.all()) }}
 ```
 
 ### Properties

diff --git a/composer.json b/composer.json
@@ -2,7 +2,7 @@
     "name": "lukeyouell/craft-readtime",
     "description": "Calculate the estimated read time for content.",
     "type": "craft-plugin",
-    "version": "1.4.0",
+    "version": "1.5.0",
     "keywords": [
         "craft",
         "cms",

diff --git a/src/twigextensions/ReadTimeTwigExtension.php b/src/twigextensions/ReadTimeTwigExtension.php
@@ -48,48 +48,67 @@ public function readTimeFunction($element, $showSeconds = true)
         $totalSeconds = 0;
         $vals = '';
 
-        foreach ($element->getFieldLayout()->getFields() as $field) {
-            try {
-                // If field is a matrix then loop through fields in block
-                if ($field instanceof \craft\fields\Matrix) {
-                    foreach($element->getFieldValue($field->handle)->all() as $block) {
-                        $blockFields = $block->getFieldLayout()->getFields();
-
-                        foreach ($blockFields as $blockField) {
-                            $value = $block->getFieldValue($blockField->handle);
-                            $seconds = $this->valToSeconds($value);
-                            $totalSeconds = $totalSeconds + $seconds;
-                        }
-                    }
-                } elseif($field instanceof \verbb\supertable\fields\SuperTableField) {
-                    foreach($element->getFieldValue($field->handle)->all() as $block) {
-                        $blockFields = $block->getFieldLayout()->getFields();
-
-                        foreach ($blockFields as $blockField) {
-                            if ($blockField instanceof \craft\fields\Matrix) {
-                                foreach($block->getFieldValue($blockField->handle)->all() as $matrix) {
-                                    $matrixFields = $matrix->getFieldLayout()->getFields();
-
-                                    foreach ($matrixFields as $matrixField) {
-                                        $value = $matrix->getFieldValue($matrixField->handle);
-                                        $seconds = $this->valToSeconds($value);
-                                        $totalSeconds = $totalSeconds + $seconds;
-                                    }
-                                }
-                            } else {
+        if ($element instanceof \craft\elements\Entry) {
+            // Provided value is an entry
+
+            foreach ($element->getFieldLayout()->getFields() as $field) {
+                try {
+                    // If field is a matrix then loop through fields in block
+                    if ($field instanceof \craft\fields\Matrix) {
+                        foreach($element->getFieldValue($field->handle)->all() as $block) {
+                            $blockFields = $block->getFieldLayout()->getFields();
+
+                            foreach ($blockFields as $blockField) {
                                 $value = $block->getFieldValue($blockField->handle);
                                 $seconds = $this->valToSeconds($value);
                                 $totalSeconds = $totalSeconds + $seconds;
                             }
                         }
+                    } elseif($field instanceof \verbb\supertable\fields\SuperTableField) {
+                        foreach($element->getFieldValue($field->handle)->all() as $block) {
+                            $blockFields = $block->getFieldLayout()->getFields();
+
+                            foreach ($blockFields as $blockField) {
+                                if ($blockField instanceof \craft\fields\Matrix) {
+                                    foreach($block->getFieldValue($blockField->handle)->all() as $matrix) {
+                                        $matrixFields = $matrix->getFieldLayout()->getFields();
+
+                                        foreach ($matrixFields as $matrixField) {
+                                            $value = $matrix->getFieldValue($matrixField->handle);
+                                            $seconds = $this->valToSeconds($value);
+                                            $totalSeconds = $totalSeconds + $seconds;
+                                        }
+                                    }
+                                } else {
+                                    $value = $block->getFieldValue($blockField->handle);
+                                    $seconds = $this->valToSeconds($value);
+                                    $totalSeconds = $totalSeconds + $seconds;
+                                }
+                            }
+                        }
+                    } else {
+                        $value = $element->getFieldValue($field->handle);
+                        $seconds = $this->valToSeconds($value);
+                        $totalSeconds = $totalSeconds + $seconds;
+                    }
+                } catch (ErrorException $e) {
+                    continue;
+                }
+            }
+        } elseif(is_array($element)) {
+            // Provided value is a matrix field
+            Craft::info('matrix field provided', 'readtime');
+
+            foreach ($element as $block) {
+                if ($block instanceof \craft\elements\MatrixBlock) {
+                    $blockFields = $block->getFieldLayout()->getFields();
+
+                    foreach ($blockFields as $blockField) {
+                        $value = $block->getFieldValue($blockField->handle);
+                        $seconds = $this->valToSeconds($value);
+                        $totalSeconds = $totalSeconds + $seconds;
                     }
-                } else {
-                    $value = $element->getFieldValue($field->handle);
-                    $seconds = $this->valToSeconds($value);
-                    $totalSeconds = $totalSeconds + $seconds;
                 }
-            } catch (ErrorException $e) {
-                continue;
             }
         }