|
| 1 | +# Tracker |
| 2 | +Simple site visit/statistics tracker for Laravel 5. |
| 3 | + |
| 4 | +--- |
| 5 | + |
| 6 | +Tracker provides a simple way to track your site visits and their statistics. |
| 7 | + |
| 8 | +## Features |
| 9 | +- Compatible with Laravel 5 |
| 10 | +- Middleware for automatically recording the site view |
| 11 | +- Associate site views to Eloquent models to track their views |
| 12 | +- Persists unique views based on URL, method, and IP address |
| 13 | +- Helper method, Facade, and trait for easing access to services |
| 14 | +- Handy 'Cruncher' for number crunching needs |
| 15 | +- Flushing and selecting site views with given time spans |
| 16 | +- A [phpunit](http://www.phpunit.de) test suite for easy development |
| 17 | + |
| 18 | +## Installation |
| 19 | +Installing Tracker is simple. |
| 20 | + |
| 21 | +1. Pull this package in through [Composer](https://getcomposer.org). |
| 22 | + |
| 23 | + ```js |
| 24 | + { |
| 25 | + "require": { |
| 26 | + "arrtrust/tracker": "~1.6" |
| 27 | + } |
| 28 | + } |
| 29 | + ``` |
| 30 | + |
| 31 | +2. In order to register Tracker Service Provider add `'Arrtrust\Tracker\TrackerServiceProvider'` to the end of `providers` array in your `config/app.php` file. |
| 32 | + ```php |
| 33 | + 'providers' => array( |
| 34 | + |
| 35 | + 'Illuminate\Foundation\Providers\ArtisanServiceProvider', |
| 36 | + 'Illuminate\Auth\AuthServiceProvider', |
| 37 | + ... |
| 38 | + 'Arrtrust\Tracker\TrackerServiceProvider', |
| 39 | + |
| 40 | + ), |
| 41 | + ``` |
| 42 | + |
| 43 | +3. You may configure the default behaviour of Tracker by publishing and modifying the configuration file. To do so, use the following command. |
| 44 | + ```bash |
| 45 | + php artisan vendor:publish |
| 46 | + ``` |
| 47 | + Than, you will find the configuration file on the `config/tracker.php` path. Information about the options can be found in the comments of this file. All of the options in the config file are optional, and falls back to default if not specified; remove an option if you would like to use the default. |
| 48 | + |
| 49 | + This will also publish the migration file for the default `SiteView` model. Do not forget to migrate your database before using Tracker. |
| 50 | + |
| 51 | +4. In order to register the Facade add the following line to the end of `aliases` array in your `config/app.php` file. |
| 52 | + ```php |
| 53 | + 'aliases' => array( |
| 54 | + |
| 55 | + 'App' => 'Illuminate\Support\Facades\App', |
| 56 | + 'Artisan' => 'Illuminate\Support\Facades\Artisan', |
| 57 | + ... |
| 58 | + 'Tracker' => 'Arrtrust\Tracker\TrackerFacade' |
| 59 | + |
| 60 | + ), |
| 61 | + ``` |
| 62 | + |
| 63 | +5. You may now access Tracker either by the Facade or the helper function. |
| 64 | + ```php |
| 65 | + tracker()->getCurrent(); |
| 66 | + Tracker::saveCurrent(); |
| 67 | + |
| 68 | + tracker()->isViewUnique(); |
| 69 | + tracker()->isViewValid(); |
| 70 | + |
| 71 | + tracker()->addTrackable($post); |
| 72 | + |
| 73 | + Tracker::flushAll(); |
| 74 | + Tracker::flushOlderThan(Carbon::now()); |
| 75 | + Tracker::flushOlderThenOrBetween(Carbon::now(), Carbon::now()->subYear()); |
| 76 | + ``` |
| 77 | + |
| 78 | +6. It is important to record views by using the supplied middleware to record correct app runtime and memory information. To do so register the middleware in `app\Http\Kernel`. |
| 79 | + ```php |
| 80 | + protected $routeMiddleware = [ |
| 81 | + 'auth' => \App\Http\Middleware\Authenticate::class, |
| 82 | + 'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class, |
| 83 | + 'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class, |
| 84 | + 'guard' => \App\Http\Middleware\Guard::class, |
| 85 | + 'track' => \Arrtrust\Tracker\TrackerMiddleware::class |
| 86 | + ]; |
| 87 | + ``` |
| 88 | + It is better to register this middleware as a routeMiddleware instead of a global middleware and use it in routes or route groups definitions as it may not be necessary to persist all site view. This will persist and attach any Trackable that is added to stack to site views automatically when the request has been handled by Laravel. |
| 89 | + |
| 90 | +7. To attach views to any model or class, you should implement the `Arrtrust\Tracker\TrackableInterface` interface. Tracker provides `Arrtrust\Tracker\Trackable` trait to be used by Eloquent models. |
| 91 | + ```php |
| 92 | + |
| 93 | + use Illuminate\Database\Eloquent\Model as Eloquent; |
| 94 | + use Arrtrust\Tracker\Trackable; |
| 95 | + use Arrtrust\Tracker\TrackableInterface; |
| 96 | + |
| 97 | + class Node extends Eloquent implements TrackableInterface { |
| 98 | + |
| 99 | + use Trackable; |
| 100 | + |
| 101 | + } |
| 102 | + ``` |
| 103 | + |
| 104 | + The `Trackable` trait uses Eloquent's `belongsToMany` relationship which utilizes pivot tables. Here is a sample migration for the pivot table: |
| 105 | + ```php |
| 106 | + <?php |
| 107 | + |
| 108 | + use Illuminate\Database\Schema\Blueprint; |
| 109 | + use Illuminate\Database\Migrations\Migration; |
| 110 | + |
| 111 | + class CreateNodeSiteViewPivotTable extends Migration { |
| 112 | + |
| 113 | + /** |
| 114 | + * Run the migrations. |
| 115 | + * |
| 116 | + * @return void |
| 117 | + */ |
| 118 | + public function up() |
| 119 | + { |
| 120 | + Schema::create('node_site_view', function (Blueprint $table) |
| 121 | + { |
| 122 | + $table->integer('node_id')->unsigned(); |
| 123 | + $table->integer('site_view_id')->unsigned(); |
| 124 | + |
| 125 | + $table->foreign('node_id') |
| 126 | + ->references('id') |
| 127 | + ->on('nodes') |
| 128 | + ->onDelete('cascade'); |
| 129 | + |
| 130 | + $table->foreign('site_view_id') |
| 131 | + ->references('id') |
| 132 | + ->on('site_views') |
| 133 | + ->onDelete('cascade'); |
| 134 | + |
| 135 | + $table->primary(['node_id', 'site_view_id']); |
| 136 | + }); |
| 137 | + } |
| 138 | + |
| 139 | + /** |
| 140 | + * Reverse the migrations. |
| 141 | + * |
| 142 | + * @return void |
| 143 | + */ |
| 144 | + public function down() |
| 145 | + { |
| 146 | + Schema::drop('node_site_view'); |
| 147 | + } |
| 148 | + } |
| 149 | +
|
| 150 | + ``` |
| 151 | + |
| 152 | +8. Check the `Arrtrust\Tracker\Cruncher` class and test for statistics number crunching. It is equipped with a number of methods for different types of statistics (mostly counts) in different time spans. |
| 153 | +
|
| 154 | +Please check the tests and source code for further documentation, as the source code of Tracker is well tested and documented. |
| 155 | +
|
| 156 | +## License |
| 157 | +Tracker is released under [MIT License](https://github.com/arrtrust/Tracker/blob/master/LICENSE). |
0 commit comments