Jump to content

Recommended Posts

ProcessWire2.+ Minify 1.0.3

This module helps you combine Javascript and CSS files into one, minified file to save on unnecessary HTTP requests and to compress files anywhere up to 80% (including already minified .js files).

To use it, extract the attached zip file into your /site/modules/ directory and check for new modules in the ProcessWire Admin area, then install the module.

Once installed, go to configure the module and, instead of this configuring anything for you, you can use the drop-down lists to build stylesheet and script code to place in your templates, grabbing a list of any stylesheets and scripts it finds in the /site/template/styles/ and /site/templates/scripts/ directories respectively.

It's more of a helper than anything else, but it should take the guesswork out of configuring Minify for your site.

post-1-0-93678000-1342946056_thumb.png

Notes:

  • This module contains a third-party library - Minify - which is subject to its own license (a copy is included in the attached zip file). I've left the module in-tact including its unit test files so there are more files than are necessary, but this will make it easier for me to upgrade the module if/when they release updates to that code.
  • This module doesn't insert any code into your templates automatically - I think copying and pasting the code it currently outputs to the screen is more useful/configurable for more situations.
  • It's worth using even if you only have one CSS or JS file as it will compress CSS files by about 80% and JS files by quite a lot too, plus since it handles caching on the server-side and does its own checks of the files it is serving (plus it's a dynamic URL), you can always be sure that it will serve the latest version of a CSS file (no more CTRL+F5 to show the new styles if your browser decides to cache it.
  • You can change the /site/modules/Minify/min/config.php as you could if you were using Minify as a standalone script - tweak cache paths (default is your server's cache path) and other advanced settings here.

Updates:


  • v0.0.2 - now produces code that includes paths derived by ProcessWire at run-time so paths will be fine on localhost and live servers, removing potential issues when pushing a site live.
  • v1.0.0 - bumped this up to a major version number since there appear to be no issues with the initial versions to speak of. Also implemented yellowled's input field suggestion (looks much better and easier to select for copy and paste purposes) and turned off autoload at ryan's suggestion.
  • v1.0.1 - now recusrively searches for files inside subfolders under the scripts and styles directories using PHP 5's built-in iterator classes
  • v1.0.2 - pull request from teppo - https://github.com/Notanotherdotcom/Minify/pull/1
  • v1.0.3 - updated Minify code to v2.1.7 which fixes a significant security flaw: https://groups.google.com/forum/#!msg/minify/cpN-ncKPFZE/kwYVpLMkfDwJ

You can download the module here.

  • Like 17

Share this post


Link to post
Share on other sites

It's dead simple to use, nice job. How difficult would it be to have the options saved to the db and made available as a variable? Then perhaps an "auto" checkbox that could be used in the theme like:

<?php if($minify->auto) {
echo $minify->files;
else {
?>
<!--Normal css and js references -->
<?php } ?>

Also, for the snippet, would it make more sense to include the path variables in the snippet, you must be using them while generating the snippet, but there will be path issues when working locally and then moving to production.

<script type="text/javascript" src="<?php echo $config->urls->siteModules; ?>Minify/min/b=<?php echo $config->urls->templates?>scripts&f=jquery-1.4.2.min.js,main.js"></script>

(I think this is a good idea, but $config->urls->templates includes a preceding slash, and is not loading the resource properly

Share this post


Link to post
Share on other sites

Cheers

I was getting a headache last night trying to get the variables escaped well enough since they're inside a PHP variable inside a JS variable in the module code so didn't bother in my first version since they kept on messing each other up.

This is now fixed in version 0.0.2 (download from the original post above) where you can even view the horrible code that solved it ;)

It would be a lot of extra code to implement your first idea though and, unless you actually have a pre-configured head.inc file that you drop into each project, this doesn't actually save you any time. Even then it only saves about 10 seconds per project (or however quickly you can copy and paste) which probably doesn't add up to how long it takes a kettle to boil over the course of a year :)

I think I prefer the idea of people pasting the code for the following reason. If you upload a lightbox like Shadowbox, or other scripts where they have their own folder structure that you need to preserve you might find that you need to manually tweak the URLs.

Here's an example from one of my sites (before I built the module):

<link href="/site/libs/min/b=site/templates&f=styles/reset.css,styles/general.css,dark/css/dark.css,light/css/light.css,scripts/fancybox/jquery.fancybox.css,styles/forums.ipb.css" rel="stylesheet" type="text/css" />

Lots of scripts in different folders means that the way this module works - scanning two of PWs default directories for files - simply wouldn't work. I'd wager that if someone did something similar without understanding how it worked that they would either:

  1. use Minify for the scripts in /site/templates/scripts/ and a normal <script> tag for the rest (which sort of defeats the purpose of it), or:
  2. abandon using the module entirely when they perceive that it can't do what they need it to do.

My thinking is that by looking at the code they can do what I did and simply tweak the paths to suit. I think overall there are too many possible configurations to take all of the work away from the user.

  • Like 1

Share this post


Link to post
Share on other sites

I just gave this a quick spin on my local Apache, works like a charm. (Can't really test it anywhere "live" since I don't have any "unoptimized" PW installations flying around since I usually use the H5BP build script to concat/minify.)

Two small thoughts, both of them are completely a matter of taste:

  • It might be a nice idea to emit the generated URL which you paste into your template in an input field instead of as plain text since that's usually a bit easier to get for copy & paste.
  • As far as I know, Minify also has an option to emit a "clean" URL for the combined files, i.e. "style1.css" instead of "styles&f=reset.css,main.css" — which I'd prefer. I know it's silly and not an issue technically, but to me, it just looks wrong.

Other than that: Great module to have, Pete. I'm not sure non-expert users will love this as much since they's still have to modify template files, but it sure adds a nice way to make Minify integration a lot easier.

  • Like 1

Share this post


Link to post
Share on other sites

Thanks!

I'll look into the form field.

Not sure about the clean URL as that may require altering the config file for min, and I'm trying to keep it as simple as possible to upgrade. That said, it's not like the Minify library gets updated that often so I may look into that.

I still think that non-expert users will have to modify the default template anyway if only to change the theme, so I'm not too worried about that. If they can't at least copy and paste then managing a CMS is going to be a shock ;)

Share this post


Link to post
Share on other sites

I still think that non-expert users will have to modify the default template anyway if only to change the theme, so I'm not too worried about that. If they can't at least copy and paste then managing a CMS is going to be a shock ;)

Well, once and if PW attracts a greater user base, chances are someone™ will implement some kind of module or other mechanism to make building templates easier, maybe some kind of system like TemplaVoila or what's-it's-name for TYPO3. There might even grow a market for custom-made or at least pre-built templates, who knows?

I absolutely agree that anyone can be bothered to fire up a text editor and follow instructions to copy & paste some lines into a file. It's not that hard. Then again, I have some years of experience in user support in a similar forum for a blog system … trust me, people will complain that this is too hard or something "only you nerds understand" … ;)

But there's also the question whether non-expert users do actually care for something like performance optimization. My opinion would be if they don't, their loss. If they do, they're gonna have to roll up their sleeves and get their hands dirty, just like we used to do. Of course we'll advocate them and give pointers and instructions, but no one can expect to be pampered in a support forum where people help out in their free time.

  • Like 1

Share this post


Link to post
Share on other sites

Great and useful module Pete! One recommendation I have is that this module probably shouldn't be autoload. That's something reserved for modules that need to attach hooks and execute on every request. In this case (if I understand it correctly), the Minify module only needs to execute when you are configuring it. So this module will be more efficient if it is not loaded on every request. This 'autoload' is defined in your getModuleInfo() function and you can either remove the line or set it to false, to make this adjustment.

  • Like 1

Share this post


Link to post
Share on other sites

I've updated this to include yellowled's suggestion of making the code appear in a form field - easier to copy and paste plus it looks neater. Also turned off autoload at ryan's suggestion. Thanks guys!

Well, once and if PW attracts a greater user base, chances are someone™ will implement some kind of module or other mechanism to make building templates easier, maybe some kind of system like TemplaVoila or what's-it's-name for TYPO3. There might even grow a market for custom-made or at least pre-built templates, who knows?

I would love to see this, though I think it would only happen for something like the blog profile ryan is working on, since the basic layout is pretty much standardised (so the user has no need to move the layout around if they don't want to). In that case and in the case of other standardised site profiles, I'd be happy to modify the module to automatically insert code. I guess in that instance, what you would want it to do is scan the installed theme for any links and scripts and try to replace them automatically with a couple of minified strings, something that would have me tearing my hair out trying to work out the regexp for ;)

I think I'll cross that bridge when ryan builds it :D

  • Like 1

Share this post


Link to post
Share on other sites

One thing I just stumbled upon:

grabbing a list of any stylesheets and scripts it finds in the /site/template/styles/ and /site/templates/scripts/ directories

I actually prefer to have CSS in /site/templates/css/ and JS in /site/templates/js/, some users might even put both in /site/templates/. Would it be possible for the module to just scan /site/templates/ and directories below for CSS/JS files?

Share this post


Link to post
Share on other sites

Could do - I'd have to put in some recursive folder scanning and it would make the actual URL longer in the default cases (it would then have to add js/ and styles/ before each respective filename, not that that really adds any overhead of note.

Share this post


Link to post
Share on other sites

Actually Pete, I think that in long run, it would be for the best if you made this configurable.

I, for one, often use either /assets/[js|css] or /site/assets/[js|css] as my directories

Share this post


Link to post
Share on other sites

I could well make it so that you can set the path as an option and tick a box to check all subfolders, but you would have to click Save before the ASM select lists were updated unless anyone knows of a way to have those fields refresh via AJAX?

I guess I could just make the page save automatically somehow once either of the configurable path and checkbox fields lose focus and that would achieve the same, but it should probably at least pop up some sort of confirmation dialogue box so the user has some clue what's happening.

Share this post


Link to post
Share on other sites

I think that simple notice 'save before you set your files' should suffice here: after all, you do this only once, right?

Share this post


Link to post
Share on other sites

Yeah, good point ;)

Share this post


Link to post
Share on other sites

Okay, I updated this to 1.0.1 to search recursively for files under the /site/templates/js and /styles folders - this is available from the modules directory as v1.0.1.

I thought I'd work on v1.0.2 which lets you specify starting folders further up the tree whilst I'm at it but have hit a snag. It works fine, but when you change the path and hit save the drop-downs don't update their path unless you save the module a second time.

Anyone have any ideas why you'd need to save the module twice for the config page to be able to use an updated value?

  • Like 2

Share this post


Link to post
Share on other sites
Anyone have any ideas why you'd need to save the module twice for the config page to be able to use an updated value?

Would probably need to see the specific code block in question--feel free to send along to me and I'll take a look.

Share this post


Link to post
Share on other sites

Hi Pete,

Thanks for a great module. I have installed the blog profile (thanks ryan) on a testsite and am playing around.

The blog profile uses skeleton css and js and the whole skeleton directory is one up from styles and scripts

Any idea how to get those in?

thanks

Olllie

Share this post


Link to post
Share on other sites

Anyone got any ideas on what would cause this to return a "400 Bad Request" error? I gave it a go earlier and all I got was this error on the link that should have given the combined CSS. I checked the link provided in the error (to the Minify docs) and installed FirePHP as suggested, but it doesn't give any more information in the console. Running on a localhost setup if that could be related.

Share this post


Link to post
Share on other sites

can you post the code you are pasting in the template? if you are getting a 400 bad request, it's probably because you have a trailing slash on the base path, or the path is no good; you can edit the paths within the module;

I am using this on a new 2.3 site and i can confirm it works as expected, and i just needed to edit all of the paths in the module itself and the path in the code that you paste into the template, with the actual paths to where my assets are located;

@olliemackjames - same thing, you just need to edit the paths.

  • Like 1

Share this post


Link to post
Share on other sites

can you post the code you are pasting in the template? if you are getting a 400 bad request, it's probably because you have a trailing slash on the base path, or the path is no good; you can edit the paths within the module;

I am using this on a new 2.3 site and i can confirm it works as expected, and i just needed to edit all of the paths in the module itself and the path in the code that you paste into the template, with the actual paths to where my assets are located;

This is what it gives me and what I copied to the header. All the paths look fine though. The CSS files are in projectname/site/templates/styles and that is what it puts in the "b" argument.

<link href="<?php echo $config->urls->siteModules; ?>Minify/min/b=<?php echo trim($config->urls->templates, '/'); ?>/styles&f=reset.css,base.css,main.css,anim.css" rel="stylesheet" type="text/css" />

Share this post


Link to post
Share on other sites

@Fourjays,  can't see anything wrong with your code;

maybe it is a server issue - there are some settings in the minify config file that might help.

Share this post


Link to post
Share on other sites

Just wanted to post a problem i had with Minify and the fix, in case anyone else runs into this:

Problem:

If you have an already minified css file (like for example a boostrap.min.css) as one of the files you are including in your minify concatenation string, the files with the string 'min' somewhere in the filename won't get processed, and consequently the URLs within the CSS files will not be correct;

If this happens you'll see a recursive loop in your console, as the network requests for something like an image start to initiate a new minify process and this will create about 20-30 additional network requests that keep getting longer and longer.. sort of like this:

builder/

builder/builder/

builder/builder/builder

builder/builder/builder/builder/

builder/builder/builder/builder/builder/

and so on and so on...

the fix is to set the behavior to minify all files, (or to use an unminified version of the css which is easier and would survive updates to the module);
In case you don't want to or can't change the css files you are using, you can change this setting in the Minify/min/config.php file as follows:

/**
 * By default, Minify will not minify files with names containing .min or -min
 * before the extension. E.g. myFile.min.js will not be processed by JSMin
 * 
 * To minify all files, set this option to null. You could also specify your
 * own pattern that is matched against the filename.
 */
//$min_serveOptions['minApp']['noMinPattern'] = '@[-\\.]min\\.(?:js|css)$@i';
$min_serveOptions['minApp']['noMinPattern'] = ''; 

Share this post


Link to post
Share on other sites
To use it, extract the attached zip file into your /site/modules/ directory and check for new modules in the ProcessWire Admin area, then install the module.

ahem, please don't blame me for a stupid question, but which one of the directories in the zip are really relevant and must be transferred to the server? /min_extras/ contains a warning, not to use it on a production site ...

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By picarica
      so i am trying to put CustomHooksForVariations.module, a custom module, i am placing it into site/modules direcotry yet my modules page in admin panel gives me errors
      so this is the screen show when i refresh modules, i dont know why the shole hook is written on top of the page :||

      and this next image is when i try to install it, i saw that it is not defiuned modules.php but it shouldnt need to be ?, any ways i dont want to edit site's core just to make one moulde work there has to be a way

    • By David Karich
      ProcessWire InputfieldRepeaterMatrixDuplicate
      Thanks to the great ProModule "RepeaterMatrix" I have the possibility to create complex repeater items. With it I have created a quite powerful page builder. Many different content modules, with many more possible design options. The RepeaterMatrix module supports the cloning of items, but only within the same page. Now I often have the case that very design-intensive pages and items are created. If you want to use a content module on a different page (e.g. in the same design), you have to rebuild each item manually every time.
      This module extends the commercial ProModule "RepeaterMatrix" by the function to duplicate repeater items from one page to another page. The condition is that the target field is the same matrix field from which the item is duplicated. This module is currently understood as proof of concept. There are a few limitations that need to be considered. The intention of the module is that this functionality is integrated into the core of RepeaterMatrix and does not require an extra module.
      Check out the screencast
      What the module can do
      Duplicate multible repeater items from one page to another No matter how complex the item is Full support for file and image fields Multilingual support Support of Min and Max settings Live synchronization of clipboard between multiple browser tabs. Copy an item and simply switch the browser tab to the target page and you will immediately see the past button Support of multiple RepeaterMatrix fields on one page Configurable which roles and fields are excluded Configurable dialogs for copy and paste Duplicated items are automatically pasted to the end of the target field and set to hidden status so that changes are not directly published Automatic clipboard update when other items are picked Automatically removes old clipboard data if it is not pasted within 6 hours Delete clipboard itself by clicking the selected item again Benefit: unbelievably fast workflow and content replication What the module can't do
      Before an item can be duplicated in its current version, the source page must be saved. This means that if you make changes to an item and copy this, the old saved state will be duplicated Dynamic loading is currently not possible. Means no AJAX. When pasting, the target page is saved completely No support for nested repeater items. Currently only first level items can be duplicated. Means a repeater field in a repeater field cannot be duplicated. Workaround: simply duplicate the parent item Dynamic reloading and adding of repeater items cannot be registered. Several interfaces and events from the core are missing. The initialization occurs only once after the page load event Changelog
      2.0.0
      Feature: Copy multiple items at once! The fundament for copying multiple items was created by @Autofahrn - THX! Feature: Optionally you can disable the copy and/or paste dialog Bug fix: A fix suggestion when additional and normal repeater fields are present was contributed by @joshua - THX! 1.0.4
      Bug fix: Various bug fixes and improvements in live synchronization Bug fix: Items are no longer inserted when the normal save button is clicked. Only when the past button is explicitly clicked Feature: Support of multiple repeater fields in one page Feature: Support of repeater Min/Max settings Feature: Configurable roles and fields Enhancement: Improved clipboard management Enhancement: Documentation improvement Enhancement: Corrected few typos #1 1.0.3
      Feature: Live synchronization Enhancement: Load the module only in the backend Enhancement: Documentation improvement 1.0.2
      Bug fix: Various bug fixes and improvements in JS functions Enhancement: Documentation improvement Enhancement: Corrected few typos 1.0.1
      Bug fix: Various bug fixes and improvements in the duplication process 1.0.0
      Initial release Support this module
      If this module is useful for you, I am very thankful for your small donation: Donate 5,- Euro (via PayPal – or an amount of your choice. Thank you!)
      Download this module (Version 2.0.0)
      > Github: https://github.com/FlipZoomMedia/InputfieldRepeaterMatrixDuplicate
      > PW module directory: https://modules.processwire.com/modules/inputfield-repeater-matrix-duplicate/
      > Old stable version (1.0.4): https://github.com/FlipZoomMedia/InputfieldRepeaterMatrixDuplicate/releases/tag/1.0.4
    • By Robin S
      A new module that hasn't had a lot of testing yet. Please do your own testing before deploying on any production website.
      Custom Paths
      Allows any page to have a custom path/URL.
      Note: Custom Paths is incompatible with the core LanguageSupportPageNames module. I have no experience working with LanguageSupportPageNames or multi-language sites in general so I'm not in a position to work out if a fix is possible. If anyone with multi-language experience can contribute a fix it would be much appreciated!
      Screenshot

      Usage
      The module creates a field named custom_path on install. Add the custom_path field to the template of any page you want to set a custom path for. Whatever path is entered into this field determines the path and URL of the page ($page->path and $page->url). Page numbers and URL segments are supported if these are enabled for the template, and previous custom paths are managed by PagePathHistory if that module is installed.
      The custom_path field appears on the Settings tab in Page Edit by default but there is an option in the module configuration to disable this if you want to position the field among the other template fields.
      If the custom_path field is populated for a page it should be a path that is relative to the site root and that starts with a forward slash. The module prevents the same custom path being set for more than one page.
      The custom_path value takes precedence over any ProcessWire path. You can even override the Home page by setting a custom path of "/" for a page.
      It is highly recommended to set access controls on the custom_path field so that only privileged roles can edit it: superuser-only is recommended.
      It is up to the user to set and maintain suitable custom paths for any pages where the module is in use. Make sure your custom paths are compatible with ProcessWire's $config and .htaccess settings, and if you are basing the custom path on the names of parent pages you will probably want to have a strategy for updating custom paths if parent pages are renamed or moved.
      Example hooks to Pages::saveReady
      You might want to use a Pages::saveReady hook to automatically set the custom path for some pages. Below are a couple of examples.
      1. In this example the start of the custom path is fixed but the end of the path will update dynamically according to the name of the page:
      $pages->addHookAfter('saveReady', function(HookEvent $event) { $page = $event->arguments(0); if($page->template == 'my_template') { $page->custom_path = "/some-custom/path-segments/$page->name/"; } }); 2. The Custom Paths module adds a new Page::realPath method/property that can be used to get the "real" ProcessWire path to a page that might have a custom path set. In this example the custom path for news items is derived from the real ProcessWire path but a parent named "news-items" is removed:
      $pages->addHookAfter('saveReady', function(HookEvent $event) { $page = $event->arguments(0); if($page->template == 'news_item') { $page->custom_path = str_replace('/news-items/', '/', $page->realPath); } }); Caveats
      The custom paths will be used automatically for links created in CKEditor fields, but if you have the "link abstraction" option enabled for CKEditor fields (Details > Markup/HTML (Content Type) > HTML Options) then you will see notices from MarkupQA warning you that it is unable to resolve the links.
      Installation
      Install the Custom Paths module.
      Uninstallation
      The custom_path field is not automatically deleted when the module is uninstalled. You can delete it manually if the field is no longer needed.
       
      https://github.com/Toutouwai/CustomPaths
      https://modules.processwire.com/modules/custom-paths/
    • By teppo
      Hey folks!
      I'm happy to finally introduce a project I've been working on for quite a while now: it's called Wireframe, and it is an output framework for ProcessWire.
      Note that I'm posting this in the module development area, maily because this project is still in rather early stage. I've built a couple of sites with it myself, and parts of the codebase have been powering some pretty big and complex sites for many years now, but this should still be considered a soft launch 🙂
      --
      Long story short, Wireframe is a module that provides the "backbone" for building sites (and apps) with ProcessWire using an MVC (or perhaps MVVM... one of those three or four letter acronyms anyway) inspired methodology. You could say that it's an output strategy, but I prefer the term "output framework", since in my mind the word "strategy" means something less tangible. A way of doing things, rather than a tool that actually does things.
      Wireframe (the module) provides a basic implementation for some familiar MVC concepts, such as Controllers and a View layer – the latter of which consists of layouts, partials, and template-specific views. There's no "model" layer, since in this context ProcessWire is the model. As a module Wireframe is actually quite simple – not even nearly the biggest one I've built – but there's still quite a bit of stuff to "get", so I've put together a demo & documentation site for it at https://wireframe-framework.com/.
      In addition to the core module, I'm also working on a couple of site profiles based on it. My current idea is actually to keep the module very light-weight, and implement most of the "opinionated" stuff in site profiles and/or companion modules. For an example MarkupMenu (which I released a while ago) was developed as one of those "companion modules" when I needed a menu module to use on the site profiles.
      Currently there are two public site profiles based on Wireframe:
      site-wireframe-docs is the demo&docs site mentioned above, just with placeholder content replaced with placeholder content. It's not a particularly complex site, but I believe it's still a pretty nice way to dig into the Wireframe module. site-wireframe-boilerplate is a boilerplate (or starter) site profile based on the docs site. This is still very much a work in progress, but essentially I'm trying to build a flexible yet full-featured starter profile you can just grab and start building upon. There will be a proper build process for resources, it will include most of the basic features one tends to need from site to site, etc. --
      Requirements and getting started:
      Wireframe can be installed just like any ProcessWire module. Just clone or download it to your site/modules/ directory and install. It doesn't, though, do a whole lot of stuff on itself – please check out the documentation site for a step-by-step guide on setting up the directory structure, adding the "bootstrap file", etc. You may find it easier to install one of the site profiles mentioned above, but note that this process involves the use of Composer. In the case of the site profiles you can install ProcessWire as usual and download or clone the site profile directory into your setup, but after that you should run "composer install" to get all the dependencies – including the Wireframe module – in place. Hard requirements for Wireframe are ProcessWire 3.0.112 and PHP 7.1+. The codebase is authored with current PHP versions in mind, and while running it on 7.0 may be possible, anything below that definitely won't work. A feature I added just today to the Wireframe module is that in case ProcessWire has write access to your site/templates/ directory, you can use the module settings screen to create the expected directories automatically. Currently that's all, and the module won't – for an example – create Controllers or layouts for you, so you should check out the site profiles for examples on these. (I'm probably going to include some additional helper features in the near future.)
      --
      This project is loosely based on an earlier project called pw-mvc, i.e. the main concepts (such as Controllers and the View layer) are very similar. That being said, Wireframe is a major upgrade in terms of both functionality and architecture: namespaces and autoloader support are now baked in, the codebase requires PHP 7, Controllers are classes extending \Wireframe\Controller (instead of regular "flat" PHP files), implementation based on a module instead of a collection of drop-in files, etc.
      While Wireframe is indeed still in a relatively early stage (0.3.0 was launched today, in case version numbers matter) for the most part I'm happy with the way it works, and likely won't change it too drastically anytime soon – so feel free to give it a try, and if you do, please let me know how it went. I will continue building upon this project, and I am also constantly working on various side projects, such as the site profiles and a few unannounced helper modules.
      I should probably add that while Wireframe is not hard to use, it is more geared towards those interested in "software development" type methodology. With future updates to the module, the site profiles, and the docs I hope to lower the learning curve, but certain level of "developer focus" will remain. Although of course the optimal outcome would be if I could use this project to lure more folks towards that end of the spectrum... 🙂
      --
      Please let me know what you think – and thanks in advance!
    • By tcnet
      PageViewStatistic for ProcessWire is a module to log page visits of the CMS. The records including some basic information like IP-address, browser, operating system, requested page and originate page. Please note that this module doesn't claim to be the best or most accurate.
      Advantages
      One of the biggest advantage is that this module doesn't require any external service like Google Analytics or similar. You don't have to modify your templates either. There is also no JavaScript or image required.
      Disadvantages
      There is only one disadvantage. This module doesn't record visits if the browser loads the page from its browser cache. To prevent the browser from loading the page from its cache, add the following meta tags to the header of your page:
      <meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate" /> <meta http-equiv="Pragma" content="no-cache" /> <meta http-equiv="Expires" content="0" /> How to use
      The records can be accessed via the Setup-menu of the CMS backend. The first dropdown control changes the view mode. There are 4 different view modes.
      View mode "Day" shows all visits of the selected day individually with IP-address, browser, operating system, requested page and originate page. Click the update button to see new added records. View mode "Month" shows the total of all visitors per day from the first to the last day of the selected month. View mode "Year" shows the total of all visitors per month from the first to the last month of the selected year. View mode "Total" shows the total of all visitors per year for all recorded years. Please note that multiple visits from the same IP address within the selected period are counted as a single visitor.
      Settings
      You can access the module settings by clicking the Configuration button at the bottom of the records page. The settings page is also available in the menu: Modules->Configure->ProcessPageViewStat.
      IP2Location
      This module uses the IP2Location database from: http://www.ip2location.com. This database is required to obtain the country from the IP address. IP2Location updates this database at the begin of every month. The settings of ProcessPageViewStat offers the ability to automatically download the database monthly. Please note, that automatically download will not work if your webspace doesn't allow allow_url_fopen.
      Dragscroll
      This module uses DragScroll. A JavaScript available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability in view mode "Day" to drag the records horizontally with the mouse pointer.
      parseUserAgentStringClass
      This module uses the PHP class parseUserAgentStringClass available from: http://www.toms-world.org/blog/parseuseragentstring/. This class is required to filter out the browser type and operating system from the server request.
      Special Feature
      PageViewStatistic for ProcessWire can record the time a visitor viewed the page. This feature is deactivated by default. To activate open the module configuration page and activate "Record view time". If activated you will find a new column "S." in the records which means the time of view in seconds. With every page request, a Javascript code is inserted directly after the <body> tag. Every time the visitor switches to another tab or closes the tab, this script reports the number of seconds the tab was visible. The initial page request is recorded only as a hyphen (-).
       
×
×
  • Create New...