Download the PHP package hananils/kirby-tracker without Composer

On this page you can find all versions of the php package hananils/kirby-tracker. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of hananils/kirby-tracker

Informations about the package kirby-tracker

Tracker is a plugin for Kirby 3 to track content changes and create panel logs or front-end notifications in member areas.

On privacy

Before using this plugin, please think about the privacy implications. You will be processing personal data of your users: their name, the date of their change and meta information about their change. This requires you to follow the privacy laws in your jurisdiction. Please consult a lawyer in case of doubt.

This plugin was initially conceived to create a dashboard for a private members area where all users consented to share their changes with the other users.

Example

Installation

Download

Download and copy this repository to /site/plugins/tracker.

Git submodule

Composer

Tracked data

Tracker will create a SQLite datebase in site/logs/tracker.sqlite. It will create two tables:

tracks

Tracker will create a log of all change in this database:

notifications

Tracker will also create a list of all related pages, users and files that are affected by a change:

Usage

$site->tracks($limit)

Returns a TracksCollection of all changes of all users.

$limit: limit, defaults to 20 entries.

$site->notifications($limit)

Returns a TracksCollection of all notifications.

$limit: limit, defaults to 20 entries.

$page->tracks($limit)

Returns a TracksCollection of all changes on the given page.

$limit: limit, defaults to 20 entries.

$page->notifications($limit)

Returns a TracksCollection of all notifications for the given page.

$limit: limit, defaults to 20 entries.

$user->tracks($limit)

Returns a TracksCollection of all changes for the given user.

$limit: limit, defaults to 20 entries.

$user->notifications($limit)

Returns a TracksCollection of all notifications for the given user.

$limit: limit, defaults to 20 entries.

TracksCollection

The plugin provides a TracksCollection you can use to query, filter and output tracking information:

filterBy($column, $method, $value)

Applies a filter to the output.

$column: the table column. $method: filter method. $value: filter value.

limit($limit)

Limits the number of returned tracks.

$limit: limit, defaults to 20 entries.

offset($offset)

Applies and offset to the result.

$offset: entry offset.

sortBy()

Sorts the results.

validate()

Makes sure that only tracks for existing pages, users and files are returned, excluding those deleted in the meantime.

toArray()

Returns the result as an array

Track

Each item of the TrackCollection is a Track object:

isValid()

Returns true is the referenced Kirby object exists, otherwise false.

toUser()

Returns the Kirby user object.

toReference()

Returns the Kirby object of the given reference, either the changed page, user or file.

toDate($format)

Returns either the DateTime representation of the track or – if a format was provided – the formatted date.

$format: a PHP-readable date format.

toTrack()

Returns the related track for a notification.

toStatus()

Returns the status of a notified reference, either added, unchanged or removed.

value()

Returns the value of the track.

toArray()

Returns an array representation of the track.

To Do

License

This plugin is provided freely under the hana+nils · Büro für Gestaltung. We create visual designs for digital and analog media.

All versions of kirby-tracker with dependencies

PHP Build Version
Package Version
Requires getkirby/composer-installer Version ^1.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package hananils/kirby-tracker contains the following files

Loading the files please wait ....