Jump to content
tcnet

PageViewStatistic for ProcessWire

Recommended Posts

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 (-).

 

  • Like 9

Share this post


Link to post
Share on other sites

Hi @tcnet,

welcome to the forum, great first post 😎💪 Do you have any screenshots to share how the statistics look like?

 

  • Like 1

Share this post


Link to post
Share on other sites
2 minutes ago, bernhard said:

Hi @tcnet,

welcome to the forum, great first post 😎💪 Do you have any screenshots to share how the statistics look like?

 

Hello and Thank You!

Of course I've some screenshots. I wasn't sure if these screenshots were appropriate to show here. I've made IP addresses unrecognizable.

view-mode-day.jpg

view-mode-month.jpg

view-mode-year.jpg

view-mode-total.jpg

time-of-view.jpg

  • Like 5

Share this post


Link to post
Share on other sites

Nice, thx 🙂 Is the module somewhere on github or on the modules directory?

Share this post


Link to post
Share on other sites
5 hours ago, tcnet said:

Here is the link:

Welcome to the forums @tcnet. Thanks for this module. 

Is there any reason you decided to host the module on your servers rather than on GitHub, GitLab or similar? 

Share this post


Link to post
Share on other sites
3 hours ago, kongondo said:

Welcome to the forums @tcnet. Thanks for this module. 

Is there any reason you decided to host the module on your servers rather than on GitHub, GitLab or similar? 

Usually I don't work with GitHub. But if you insist and as soon as I've enough time, I'll upload it to GitHub, GitLab or something similar.

  • Like 1

Share this post


Link to post
Share on other sites
27 minutes ago, tcnet said:

I'll upload it to GitHub, GitLab or something similar.

That will be great, thanks. It just makes it easier for people to fork, play around with, submit PRs, rollback to older versions, etc. 😄 

Share this post


Link to post
Share on other sites
2 minutes ago, Karinne Cyphers said:

Thank you for this module.  I'm seeing this error after install:

 

image.thumb.png.26b930a7935d26e2c23b881ac814c8a6.png

As far as I know, FieldtypeDatetime is installed by default in ProcessWire. Did you uninstalled FieldtypeDatetime or deleted the "datetime" field type?

Share this post


Link to post
Share on other sites
1 hour ago, kongondo said:

That will be great, thanks. It just makes it easier for people to fork, play around with, submit PRs, rollback to older versions, etc. 😄 

Sorry. I tried it. But cannot upload on GitHub.

Share this post


Link to post
Share on other sites
7 hours ago, tcnet said:

Sorry. I tried it. But cannot upload on GitHub.

Oh, I see. Do you have a GitHub account? Are you using some sort of version control, e.g. git? 

Hey, if it's too much of a bother, don't worry yourself. Thanks.

Share this post


Link to post
Share on other sites
3 minutes ago, kongondo said:

Oh, I see. Do you have a GitHub account? Are you using some sort of version control, e.g. git? 

Hey, if it's too much of a bother, don't worry yourself. Thanks.

I don't use any versions controlling. I just created an account on GitHub a few hours ago.
See: https://github.com/techcnet/ProcessPageViewStat

But file oploading with browser don't work in GitHub. It's not a problem with the browser. I tried Chrome and Firefox. It's a problem with the upload on GitHub.

I also tried GitLab. When I click the + to create a new project I get a white blank page. My browsers are ok. Seems to me they don't want any users.

Share this post


Link to post
Share on other sites
29 minutes ago, tcnet said:

I don't use any versions controlling.

I really recommend that you do. Sooner or later you will need older versions of something and it will be a pain to rebuild (and various other reasons why one should try and use some versioning system, invariably git). 

 

29 minutes ago, tcnet said:

But file oploading with browser don't work in GitHub.

What IDE do you use for you coding? VSCode? The easier way is to using cloning, then push your changes from your local repository. So:

  1. Assuming you use VSCode, open the editor and CLONE your repository (using this url https://github.com/techcnet/ProcessPageViewStat.git)
  2. It will want to clone to an empty directory. You can temporarily rename the directory where your module files are to ProcessPageViewStat2
  3. Let VSCode clone your empty repo to /site/modules/ProcessPageViewStat. It will copy the files from your project in GitHub and create a .git file. Your files will be ready for tracking.
  4. Once that's done, in your file explorer (e.g. windows explorer if on Windows), copy the local module files that you have in ProcessPageViewStat2 to the new ProcessPageViewStat
  5. VSCode will tell you that you have added new files. You can then PUSH the CHANGES to your repository. To do that, the first time, VSCode will guide you through authenticating yourself to GitHub as you are the only one with PUSH privileges.

Sorry, I am in a bit of a rush. I suggest you have a look at a tutorial about the basics of git or maybe just the basics of GitHub/git and VSCode.

Edited by kongondo
  • Like 2

Share this post


Link to post
Share on other sites
11 minutes ago, kongondo said:

I really recommend that you do. Sooner or later you will need older versions of something and it will be a pain to rebuild. 

 

What IDE do you use for you coding? VSCode? The easier way is to using cloning, the push your changes from your local repository. So:

  1. Assuming you use VSCode, open the editor and CLONE your repository (using this url https://github.com/techcnet/ProcessPageViewStat.git)
  2. It will want to clone to an empty directory. You can temporarily rename the directory where your module files are to ProcessPageViewStat2
  3. Let VSCode clone your empty repo to /site/modules/ProcessPageViewStat. It will copy the files from your project in GitHub and create a .git file. Your files will be ready for tracking.
  4. Once that's done, in your file explorer (e.g. windows explorer if on Windows), copy the local module files that you have in ProcessPageViewStat2 to the new ProcessPageViewStat
  5. VSCode will tell you that you have added new files. You can then PUSH the CHANGES to your repository. To do that, the first time, VSCode will guide you through authenticating yourself to GitHub as you are the only one with PUSH privileges.

Sorry, I am in a bit of a rush. I suggest you have a look at a tutorial about the basics of git or maybe just the basics of GitHub/git and VSCode.

For some reason, GitHub/git will never be an option for me. Don't laugh, but for PHP I only use a text editor with highlighting. I'll try VSCode next week. Thank you for your explanation.

Share this post


Link to post
Share on other sites
5 minutes ago, tcnet said:

For some reason, GitHub/git will never be an option for me

I wish I could convince you otherwise 😄 

6 minutes ago, tcnet said:

Don't laugh, but for PHP I only use a text editor with highlighting

I won't...been there, done that.

Share this post


Link to post
Share on other sites
2 minutes ago, kongondo said:

I wish I could convince you otherwise 😄 

I'll try it next week. Only for this module. Sure!

  • Like 1

Share this post


Link to post
Share on other sites
10 hours ago, tcnet said:

As far as I know, FieldtypeDatetime is installed by default in ProcessWire. Did you uninstalled FieldtypeDatetime or deleted the "datetime" field type?

 

10 hours ago, Karinne Cyphers said:

Thank you for this module.  I'm seeing this error after install:

 

image.thumb.png.26b930a7935d26e2c23b881ac814c8a6.png

WAIT!
$dt = new \ProcessWire\datetime(); This is NOT my code!!!
Line 532 is: $dt = new DateTime();

Share this post


Link to post
Share on other sites
34 minutes ago, tcnet said:

Only for this module. Sure!

I'm quite sure it will not be the last one 😉 IMHO version control is critical for building and maintaining good software. It helps you in a lot of ways! For example two days ago one of my modules that uses git webhooks to auto-deploy changes via a PHP script that bootstraps PW stopped working... I checked the script - it didn't do anything after the include('index.php') statement. I thought: Maybe because of the core update... checked a clean install: Works. Then checked diabling all modules via tracy debugger... still not working. Then I looked at the logs of the script... last logged event was at 15:09 --> I checked my git repo and quickly found the problem: I added a $session->redirect() in ready.php for non-logged in users that shows a coming soon page (which obviously also redirected the git webhook request and so the script never fired). That's just one example of how useful a git workflow can be. Others are reverting code because you break something, etc, etc...

VSCode has GIT support on board. It's really easy to use! 

 

(watch at 1,5x speed 😉 )

Share this post


Link to post
Share on other sites
25 minutes ago, bernhard said:

I'm quite sure it will not be the last one 😉

I'm pretty sure that I can live without GIT. I've been doing very well without GIT for 20 years now and I won't change that. I usually work with VC++, Java and Pascal. PHP for me is just a kind of hobby.

  • Like 1

Share this post


Link to post
Share on other sites

Well, all of our suggestions were just offers to help. If you don't like to go in that direction that's totally fine 🙂 I'm pretty sure that we can live without your modules being on GIT as well 😉 

Share this post


Link to post
Share on other sites
1 hour ago, tcnet said:

WAIT!
$dt = new \ProcessWire\datetime(); This is NOT my code!!!

Probably inserted by the FileCompiler if your module is not namespaced :-). 

  • Like 1

Share this post


Link to post
Share on other sites
14 hours ago, kongondo said:

Probably inserted by the FileCompiler if your module is not namespaced :-). 

Version 1.0.1 doesn't have namespace. I couldn't reproduce it without namespace. But I can reproduce it with namespace. I've made changes now.

  • Like 1

Share this post


Link to post
Share on other sites

Today I've tested VSCode. It's MBS! M stands for Mega. Anyway, project is on GitHub now. But it's probably the last time. For updates and new features check my blog. Thank you!

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 jploch
      Hey folks,
      for a module (a pagebuilder based on PageTable) I need to save some settings as JSON. The values are saved for each page table item (a pw page). It's working well, but I am looking for ways to improve the structure I have. As I'm not that experienced with JSON, maybe someone more experienced can take a look and tell me if my approach is good practice. 

      My goal is to make all the items accessible by page id, without looping over them (using objects instead of arrays):
      // access from template with pw page var $jsonObject->items->{$page}->cssClass; Her is an example of my JSON structure:
      { "items": { "3252": { "id": "3252", "cssClass": "pgrid-main", "breakpoints": { "base": { "css": { "grid-column-end": "auto", "grid-row-end": "auto", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "60px", "padding-right": "60px", "padding-top": "60px", "padding-bottom": "60px", "background-color": "rgb(255, 255, 255)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3686": { "id": "3686", "cssClass": "test_global", "breakpoints": { "base": { "css": { "grid-column-end": "-1", "grid-row-end": "span 1", "grid-column-start": "1", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3687": { "id": "3687", "cssClass": "block_editor-3687", "breakpoints": { "base": { "css": { "grid-column-end": "span 2", "grid-row-end": "span 1", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3696": { "id": "3696", "cssClass": "block_editor-3696", "breakpoints": { "base": { "css": { "grid-column-end": "span 2", "grid-row-end": "span 1", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } } }, "breakpointActive": "base", "breakpointActiveSize": "@media (min-width: 576px)" }  
    • By jploch
      Fieldtype Page Table Grid
      This is a sneak preview of a side project I've been working on for quite some time now. A lot of work and thought has gone into this, so I will most likely release this as a commercial module at some point in the near future. 

      As a designer (and developer) I get the appeal of a WYSIWYG editor. After playing around with some WYSIWYG page builder tools, I always felt something was wrong about them. So I decided to build my own PW version based on PageTable.

      Here is a small demo (using AdminThemeCanvas, but its working with other admin themes as well) :
      There is also a complete website that I built for a friend of mine using this module and some custom blocks.
      Concept
      This fieldtype shares a lot of features with PageTableExtended: it's also an extension of PageTable and renders the block templates in the backend and frontend (native PW templates and fields). You can also add your own css via module settings.
      The difference is, this fieldtype also gives you the ability to rearrange and resize elements in a visual way as well as enable inline editing for text, ckeditor and file fields. Similar (and promising) attempts have been made, but I wanted something based on native CSS grid instead of a CSS framework...so I built my own version. Most CSS frameworks are based on flexbox, which is great for layouting elements horizontally. With CSS grid, you can place elements horizontally and vertically, allowing for layouts that were not previously possible with CSS. Similar to webflow, this fieldtype uses javascript (in the backend) to let you manipulate CSS grid in a visual way to design fully responsive websites (or parts of them). It should still be possible to include a CSS framework if you like (just add the classes to your block markup and include the CSS via module settings).
      The CSS grid layout manipulations are saved in a single field as a JSON array and used to generate a dynamic stylesheet that you simply include in your main template (no inline styles). The styles are saved within the breakpoint you select and cascade down to smaller breakpoints. That means you can specify just the basic breakpoint and adjust other breakpoints if needed. The exception is the mobile breakpoint which will display everything in one column as a default (you can change the layout here too).
      The fieldtype also comes with an optional style panel to manipulate some additional CSS properties directly on the page. You can customize the panel or disable it completely from the module settings (and just use a CSS file that you include via module settings). The style panel is based on inputfields (nothing is saved to the database). This means that you just have to install the module and all fields are available to all blocks automatically (this can be customized). It also has the benefit that your installation is not flooded with fields; this module only installs one field.
      Don't want to give your customer all that power? Design features can be disabled for certain roles. The grid editor role can just edit the content and use the inline editing feature to edit content quickly. You can then also grant access individually to the style panel, resize or drag functionality.
      Features
      Blocks are just pages Blocks are defined by native PW templates and fields Manipulate CSS grid in a visual way to design fully responsive websites (or parts of them) Design features can be disabled for certain roles Inline editing of text, ckeditor and file fields The layout is 100% CSS grid (very small css file size) Simply drag and resize to manipulate grid items directly inside the backend Manipulate grid columns and rows directly on the page (use any number of columns you want) All style manipulations are saved as JSON and used to generate a dynamic stylesheet that you just include in your main template (no inline styles) Nested groups/grids (child pages of nested blocks are created under group parent) Global blocks work with page reference field (changes on one page, changes all blocks on all pages) Manual and auto placement of grid items Define custom icons for your blocks via native template settings (template -> advanced -> icon) Option to load lazysizes in the backend to enable lazy loading of assets with class lazyload Works with all default and ui-kit based admin themes If you have any questions or feedback, let me know.
    • By bernhard
      I built this module because I needed a versatile solution to replace tags and simple if-blocks in some E-Mails and PDF documents.
      If you only need to replace static tags (no if-conditions), then you can use default PW api and need no module:
      $str = "My favourite color is {color}."; $texttools = $sanitizer->getTextTools(); echo $texttools->populatePlaceholders($str, ['color' => 'red']); // output: My favourite color is red. Usage:
      See the two example Files in the folder /replacements

       
      Methods:
      replacementsTable()
      Renders an overview of all available replacements (see the example in the Module's config file:
       
      Create new Replacements:
      Simply copy the sample file and adopt to your needs.
       
      Download:
      https://gitlab.com/baumrock/RockReplacer
    • By bernhard
      DEPRECATED
      I'm using this module in several projects, but it will likely not see any updates in the future. I'm not happy with it and I'm looking for ways to develop better solutions. RockTabulator was my first try, but I'm also not 100% happy with that. The tabulator library is great, but my module implementation is not. I hope to get a good solution soon, but it will be a lot of work...
      ---
      Some of you might have followed the development of this module here: https://processwire.com/talk/topic/15524-previewdiscussion-rockdatatables/ . It is the successor of "RockDataTables" and requires RockFinder to get the data for the grid easily and efficiently. It uses the open source part of agGrid for grid rendering.
       
      WHY?
      ProcessWire is awesome for creating all kinds of custom backend applications, but where it is not so awesome in my opinion is when it comes to listing this data. Of course we have the built in page lister and we have ListerPro, but none of that solutions is capable of properly displaying large amounts of data, for example lists of revenues, aggregations, quick and easy sorts by the user, instant filter and those kind of features. RockGrid to the rescue 😉 
       
      Features/Highlights:
      100k+ rows Instant (client side) filter, search, sort (different sort based on data type, eg "lower/greater than" for numbers, "contains" for strings) extendable via plugins (available plugins at the moment: fullscreen, csv export, reload, batch-processing of data, column sum/statistics, row selection) all the agGrid features (cell renderers, cell styling, pagination, column grouping etc) vanilla javascript, backend and frontend support (though not all plugins are working on the frontend yet and I don't plan to support it as long as I don't need it myself)  
      Limitations:
      While there is an option to retrieve data via AJAX the actual processing of the grid (displaying, filtering, sorting) is done on the client side, meaning that you can get into troubles when handling really large datasets of several thousands of rows. agGrid should be one of the most performant grid options in the world (see the official example page with a 100k row example) and does a lot to prevent problems (such as virtual row rendering), but you should always have this limitation in mind as this is a major difference to the available lister options that do not have this limitation.
      Currently it only supports AdminThemeUikit and I don't plan to support any other admin theme.
       
      Download: https://gitlab.com/baumrock/FieldtypeRockGrid
      Installation: https://gitlab.com/baumrock/RockGrid/wikis/Installation
      Quikckstart: https://gitlab.com/baumrock/RockGrid/wikis/quickstart
      Further instructions: https://gitlab.com/baumrock/RockGrid/wikis/quickstart#further-instructions
      German Translation File: site--modules--fieldtyperockgrid--fieldtyperockgrid-module-php.json
      Changelog: https://gitlab.com/baumrock/FieldtypeRockGrid/raw/master/changelog.md
       
      Module status: alpha, License: MIT
      Note that every installation and uninstallation sends an anonymous google analytics event to my google analytics account. If you don't want that feel free to remove the appropriate lines of code before installation/uninstallation.
       
      Contribute:
      You can contribute to the development of this and other modules or just say thank you by
      testing, reporting issues and making PRs at gitlab liking this post buying me a drink: paypal.me/baumrock/5 liking my facebook page: facebook.com/baumrock hiring me for pw work: baumrock.com  
      Support: Please note that this module might not be as easy and plug&play as many other modules. It needs a good understanding of agGrid (and JavaScript in general) and it likely needs some looks into the code to get all the options. Please understand that I can not provide free support for every request here in the forum. I try to answer all questions that might also help others or that might improve the module but for individual requests I offer paid support (please contact me via PM).
       
      Use Cases / Examples:
      Colored grid cells, Icons, Links etc. The Grid also has a "batcher" feature built in that helps communicating with the server via AJAX and managing resource intensive tasks in batches:

      Filters, PW panel links and instant reload on panel close:

      You can combine the grid with a chart library like I did with the (outdated) RockDataTables module:

    • By Paul Greinke
      Hi there. I wrote a custom module for one of my projects. In fact I maybe want to use my module in other projects too. In order to be variable and customizable  I need to implement some custom hooks into my module. So I can afterwards hook into the my functions in order to modify them to match the needs of the new project.
      I tried simply defining functions with the '__' prefix. But that did not work. I'm imagining something like the following:
      <?php class MyClass { public function ___someFunction() { // Do something } } // ready.php $this->addHookBefore('MyClass::someFunction', function($event) { // some customization }); Is there a way to accomplish that? 
×
×
  • Create New...