Skip to content
Lightweight traffic tracking for CodeIgniter 4
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
LICENSE
README.md
Visits.php.example
composer.json

README.md

Tatter\Visits

Lightweight traffic tracking for CodeIgniter 4

Quick Start

  1. Install with Composer: > composer require tatter/visits
  2. Update the database: > php spark migrate:latest -n Tatter
  3. Add to controller: service('visits')->record();

Features

Provides automated traffic tracking for CodeIgniter 4

Installation

Install easily via Composer to take advantage of CodeIgniter 4's autoloading capabilities and always be up-to-date:

  • > composer require tatter/visits

Or, install manually by downloading the source files and adding the directory to app/Config/Autoload.php.

Once the files are downloaded and included in the autoload, run any library migrations to ensure the database is setup correctly:

  • > php spark migrate:latest -n Tatter

Pro Tip: You can add the spark command to your composer.json to ensure your database is always current with the latest release:

{
	...
    "scripts": {
        "post-update-cmd": [
            "composer dump-autoload",
            "php spark migrate:latest -all"
        ]
    },
	...

Configuration (optional)

The library's default behavior can be altered by extending its config file. Copy Visits.php.example to app/Config/Visits.php and follow the instructions in the comments. If no config file is found in app/Config the library will use its own.

Usage

If installed correctly CodeIgniter 4 will detect and autoload the class, service, and config. Use the service to load the class and record the current visit:

  • service('visits')->record();

Recommended: Include this line in BaseController in the initController() method so traffic is recorded on every page load.

Accessing data

This library provides a VisitModel and a Visit entity for convenient access to recorded entries. Feel free to extend these classes for any additional functionality.

User tracking

It is not legal nor advisable to track user traffic in all cases. By default Visits will only include user IDs when they are loaded into the specific session variable visitsUserId. If this session variable is not set access will be anonymous. You can change the variable used to determine a logged in user by using the Config file and altering the value (see above).

You can’t perform that action at this time.