Download the PHP package sayamaapps/kirby-kizami without Composer

On this page you can find all versions of the php package sayamaapps/kirby-kizami. 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 sayamaapps/kirby-kizami

Informations about the package kirby-kizami

Kizami

Cookieless, server-side visitor statistics for Kirby CMS.

Kizami counts page views, contact clicks and optional actions on a Kirby site and shows them in a dashboard linked from the Panel. It stores nothing on visitors' devices and needs no tracking script. It is built for small businesses where phone calls, e-mails and route requests matter.

Features

Requirements

Installation

Composer installs to site/plugins/kizami/. Add that path to .gitignore and deploy it like vendor/.

A stock Kirby has no storage root. Define it in public/index.php; storage/ sits beside public/, outside the web root:

Off by default. Minimal site/config/config.php (redirects work even while active is false):

Usage

Link clicks. Route links through a counted redirect. The fallback keeps the link working while the redirect is not configured:

The optional fourth argument is a position, recorded only if it is listed in positionNames. Safari sends no Sec-Fetch-User, so its clicks count only if the same IP address and user agent viewed a page that day.

Actions. Declare them in kizami.events (see Options), then count them from PHP:

A cached page never runs the call, so count in a route or exclude that page from the cache. In the browser, use data-kizami-event="download" on links or media, with ` in the`.

Dashboard. The Panel menu entry Statistics opens /k/dashboard. It is HTTPS only, and failed file logins are limited by Kirby's auth.trials and auth.timeout. Access: any logged-in Panel user, or the login in site/config/kizami.php (keep it out of git):

JSON report. Set 'kizami.report' => true and give the reading account the role kizami-report (see reportRoles):

kind=day (default: yesterday) or kind=week (Monday to Sunday), optional date=YYYY-MM-DD. HTTPS only.

Options

Keys are kizami.<name>, flat or nested. null means "not set".

Option Default Description
active false Master switch for counting, dashboard, report and snapshot.
redirects [] Counted redirects name => target (tel:, mailto:, https:// or a path; closures allowed). Route: /<name>.
targetNames [] Display names for redirect targets, name => label.
sourceNames [] Display names for referrer hosts and utm_source values.
pageNames [] Display names for paths (default: page title).
contactTargets [] Redirects that count as contacts for the contact rate.
tiles first two redirects Redirects shown as dashboard tiles.
tileNames [] Tile headings, name => label.
positionNames [] Allowed link positions (for example header) with labels; others are dropped.
images [] Image IDs for gallery-open counting (needs the site's own script).
dwellTime false Accept time-on-page beacons at /k/duration (needs the site's own script).
events [] Allowed actions key => ['label' => …, 'detail' => true]; detail allows a short detail.
retentionMonths 13 Months single events and actions are kept (1 to 600).
gaps [] Measurement gaps ['from' => 'Y-m-d H:i', 'to' => …, 'reason' => …], marked in dashboard and report.
ownHosts [] Further own domains whose referrers count as internal.
campaignParam null Second campaign parameter (for example cam), used as utm_campaign when that is missing.
language site language en or de for the dashboard and report text.
brand site title Name in the dashboard title and report (string or closure).
color #2f4f2a Dashboard accent colour (#rrggbb).
fonts null Dashboard fonts: ['serif' => ['name' => …, 'file' => …], 'sans' => …].
extraCss null Extra dashboard CSS file, relative to the project root.
previewAccess null Closure returning ['user' => …, 'hash' => …] while a build password protects the site; null once live.
report false Enable /k/report (needs active) and register the role kizami-report.
reportRoles ['kizami-report'] Roles allowed to read the report.
journal 'wal' SQLite journal mode, 'wal' or 'delete' (use 'delete' where WAL fails).
siteId site hostname Site identifier in the report; set it to survive a domain change.
reportWithoutHttps false Allow dashboard, report and snapshot over plain HTTP. Local testing only.
snapshot false Enable the backup download /k/snapshot (needs active); registers the role kizami-snapshot.
snapshotRoles ['kizami-snapshot'] Roles allowed to download the snapshot.

Privacy

See DATENSCHUTZ.md (German text for privacy policies). They are not legal advice.

Maintenance

Run compact daily if the site may go days without visits; it also removes the previous day's salt key. Add --retention-months=N after maintenance.php if kizami.retentionMonths is set. Back up with kizami-snapshot, not by copying kizami.sqlite while the site runs.

Tests: composer test. Issues and pull requests are welcome, without a support promise. Report security problems privately through GitHub's vulnerability reporting. Changes: CHANGELOG.md.

License

MIT, see LICENSE.

All versions of kirby-kizami with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
ext-sqlite3 Version *
getkirby/composer-installer Version ^1.2
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 sayamaapps/kirby-kizami contains the following files

Loading the files please wait ...