futjikato/readcounter

Package to provide a very simple mechanism to count page impressions and save them in a page property.

v1.0.1 2016-02-03 10:49 UTC

Requires

• typo3/flow: *

MIT

README

Package to provide a very simple mechanism to count page impressions and save them in a page property.

Installation

After downloading check in the neos backend if this package is enabled as application or plugin.

In your main Configuration/Routes.yaml add the following snippet to activate te package:

-
  name: 'Futjikato.ReadCounter'
  uriPattern: '<ReadCounterSubroutes>'
  subRoutes:
    'ReadCounterSubroutes':
      package: 'Futjikato.ReadCounter'

The route to call via ajax is /readcounter/tracking?node=<nodePath>.

Every page that should be countable must be extended by the Futjikato.ReadCounter:CounterMixin mixin:

'Futjikato.DemoSite:CountedPage':
  superTypes:
    'TYPO3.Neos.NodeTypes:Page': true
    'Futjikato.ReadCounter:CounterMixin': true
  ui:
    label: 'Counted Page'

The mixin extends the page with a readcounter property you can use as a sort property or render it somewhere on the page. In addtion the mixin also adds a child node to render the tracking code.

Here an exaple typescript page configuration:

prototype(Futjikato.DemoSite:CountedPage.Page) < prototype(Futjikato.DemoSite:Page) {
    body {
        templatePath = 'resource://Futjikato.DemoSite/Private/Templates/Page/CountedPage.html'
        parts {
            // used to render the current page read counter
            counter = ${q(documentNode).property('readcounter')}
        }
        content {
            // render a simple script tag that will track the page view
            trackingcode = Futjikato.ReadCounter:TrackingElement {
                nodePath = 'trackingcode'
            }
        }
    }
}