├── .gitignore
├── readtime
    ├── ReadTimePlugin.php
    ├── twigextensions
    │   └── ReadTimeTwigExtension.php
    └── LICENSE
└── README.md


/.gitignore:
--------------------------------------------------------------------------------
1 | **/.DS_Store


--------------------------------------------------------------------------------
/readtime/ReadTimePlugin.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Craft;
 3 | 
 4 | class ReadTimePlugin extends BasePlugin
 5 | {
 6 |     function getName()
 7 |     {
 8 |          return Craft::t('Read Time');
 9 |     }
10 | 
11 |     function getVersion()
12 |     {
13 |         return '1.0.1';
14 |     }
15 | 
16 |     function getDeveloper()
17 |     {
18 |         return 'eHouse Studio';
19 |     }
20 | 
21 |     function getDeveloperUrl()
22 |     {
23 |         return 'http://www.ehousestudio.com';
24 |     }
25 | 
26 |     public function addTwigExtension()
27 |     {
28 |         Craft::import('plugins.readtime.twigextensions.ReadTimeTwigExtension');
29 | 
30 |         return new ReadTimeTwigExtension();
31 |     }
32 | }


--------------------------------------------------------------------------------
/readtime/twigextensions/ReadTimeTwigExtension.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Craft;
 3 | 
 4 | use Twig_Extension;
 5 | use Twig_Filter_Method;
 6 | 
 7 | class ReadTimeTwigExtension extends Twig_Extension
 8 | {
 9 |     public function getName()
10 |     {
11 |         return 'ReadTime';
12 |     }
13 | 
14 |     public function getFilters()
15 |     {
16 |         return array(
17 |             'readtime' => new Twig_Filter_Method($this, 'readtimeFilter'),
18 |         );
19 |     }
20 | 
21 |     public function readtimeFilter($content)
22 |     {
23 |         $words = str_word_count(strip_tags($content));
24 |         $min = floor($words / 200);
25 | 		$return = ($min < 1 ? '1' : $min) . ' minute';
26 |         return $return;
27 |     }
28 | }


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Read Time
 2 | 
 3 | An estimated read time [Twig](http://twig.sensiolabs.org/) filter for [Craft CMS](http://buildwithcraft.com/). This can be added to any field (that's data is a string), but it was designed with the rich text (Redactor) field in mind
 4 | 
 5 | This plugin counts the words in a rich text field and returns the length of time it will take to read based on 200 words per minute.
 6 | 
 7 | ## Installation
 8 | 
 9 | 1. Move `readtime` directory to `craft/plugins` directory
10 | 2. Install `Read Time` under **Craft Admin &rsaquo; Settings &rsaquo; Plugins**
11 | 
12 | ## Usage
13 | 
14 | ```
15 | {{ entry.richTextField|readtime }}
16 | ```
17 | 
18 | ## To-Do
19 | -  Add support for [longform content](http://alistapart.com/blog/post/longform-content-with-craft-matrix) via Matrix field
20 | 
21 | ## Feedback?
22 | 
23 | Contact us on Twitter: [@ehousestudio](https://twitter.com/ehousestudio)
24 | 
25 | ## License
26 | 
27 | This work is licenced under the MIT license.
28 | 


--------------------------------------------------------------------------------
/readtime/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2014 eHouse Studio
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.


--------------------------------------------------------------------------------