Skip to content
Capell CMS

Referers

Package docs status

Section titled “Package docs status”

This page is generated from package source documentation in the Capell packages repository and the checked-in manifest. Source documentation is not distribution status. Before running a Composer command, verify that the exact package and compatible 1.x release are available through public Packagist or the authenticated marketplace account.

FieldValue
Composer packagecapell-app/referer
Package slugreferer
Product groupCapell Marketing & Growth
Tierfree
Bundlemarketing-growth
Runtime contextsadmin, frontend, console
Capell version^1.0
Catalogue roleextension
Release channelBeta
Source repositorycapell-app/packages
Source pathpackages/referer
Docs sourcepackages/referer/docs
Manifestcapell.json

What This Plugin Adds

Section titled “What This Plugin Adds”

Referers is an Available, Schema-owning Capell package in the Capell Marketing & Growth product group. It ships as capell-app/referer and extends these surfaces: admin, frontend, console.

Referers adds privacy-preserving aggregate referral reporting to Capell. It keeps daily and lifetime counters for finite source keys without storing raw URLs or request identifiers.

Administrators review site-scoped referral counts in a cached Referrers report and a small dashboard widget, while origin frontend renders record successful HTML responses best-effort.

Status details:

  • Status: Available
  • Tier: free
  • Bundle: marketing-growth
  • Composer package: capell-app/referer
  • Namespace: Capell\Referer
  • Theme key: not applicable

Why It Matters

Section titled “Why It Matters”

For developers: Typed Actions, bounded validation, atomic upserts, and focused tests keep the privacy contract explicit at each boundary.

For teams: Site teams can see which configured external sources contribute successful page requests without receiving a browsing-event log.

Screens And Workflow

Section titled “Screens And Workflow”

Screenshot contract: docs/screenshots.json.

Site-scoped referral source report Site-scoped referral source report
  • Site-scoped referral source report (admin, required evidence).

Technical Shape

Section titled “Technical Shape”

Service providers

Section titled “Service providers”
  • Capell\Referer\Providers\RefererServiceProvider
  • Capell\Referer\Providers\ConsoleServiceProvider
  • Capell\Referer\Providers\AdminServiceProvider

Config files

Section titled “Config files”
  • packages/referer/config/capell-referer.php

Migrations

Section titled “Migrations”
  • packages/referer/database/migrations/2026_09_14_000001_create_referer_counts_tables.php

Models

Section titled “Models”
  • RefererDailyCount
  • RefererSourceTotal

Filament classes

Section titled “Filament classes”
  • RefererPage
  • TopRefererSourcesFilamentWidget

Actions

Section titled “Actions”
  • BuildRefererReportAction
  • PruneRefererCountsAction
  • RecordRefererCountAction
  • RefererHealthSignal
  • ResolveRefererWindowAction
  • ResolveReferralSourceAction
  • SeedRefererScreenshotFixtureAction

Data objects

Section titled “Data objects”
  • RefererReportData
  • RefererReportRowData
  • RefererWindowData
  • ReferralSourceData

Command signatures

Section titled “Command signatures”
  • capell:referer:prune
  • capell:referer:screenshot-fixture

Scheduled commands

Section titled “Scheduled commands”
  • capell:referer:prune (daily; package registered)

Console command classes

Section titled “Console command classes”
  • PruneRefererCountsCommand
  • SeedRefererScreenshotFixtureCommand

Manifest contributions

Section titled “Manifest contributions”
  • admin-page: Capell\Referer\Manifest\RefererAdminPageContribution
  • console-command: Capell\Referer\Manifest\RefererConsoleCommandsContribution
  • dashboard-widget: Capell\Referer\Manifest\RefererDashboardFilamentWidgetsContribution
  • health-check: Capell\Referer\Manifest\RefererHealthContribution
  • migration: Capell\Referer\Manifest\RefererMigrationsContribution
  • model: Capell\Referer\Manifest\RefererModelsContribution
  • permission: Capell\Referer\Manifest\RefererPermissionsContribution
  • scheduled-job: Capell\Referer\Manifest\RefererRetentionScheduleContribution

Health checks

Section titled “Health checks”
  • Capell\Referer\Health\RefererHealthCheck

Blade views

Section titled “Blade views”
  • packages/referer/resources/views/filament/pages/referer.blade.php

Cache tags

Section titled “Cache tags”
  • referer

Data Model

Section titled “Data Model”
  • Required tables: referer_daily_counts, referer_source_totals, referer_retention_state.
  • Models: RefererDailyCount, RefererSourceTotal.
  • Core record references in migrations: sites via site_id.
  • Migration files: 2026_09_14_000001_create_referer_counts_tables.php.
  • Migration impact: run host migrations through the package install flow before opening package surfaces.
  • Deletion/retention behaviour: migrations declare cascade-on-delete relationships; retention is scheduled through capell:referer:prune (daily; registered by the package provider).

Install Impact

Section titled “Install Impact”
  • Required packages: capell-app/admin, capell-app/core, capell-app/frontend.
  • Admin navigation: declares admin-page: RefererAdminPageContribution; each Filament page or resource controls its own navigation visibility.
  • Admin/editor extensions: dashboard-widget: RefererDashboardFilamentWidgetsContribution.
  • Permissions: View:RefererPage; Shield-generated page permissions for Capell\Referer\Filament\Pages\RefererPage (names and grants depend on host Shield configuration).
  • Public routes: none declared.
  • Database changes: package migrations are declared.
  • Config: config/capell-referer.php.
  • Settings: no package settings declared.
  • Queues or schedules: scheduled commands capell:referer:prune (daily; package registered).
  • Cache tags: referer.
  • Commands: capell:referer:prune, capell:referer:screenshot-fixture.

Common Pitfalls

Section titled “Common Pitfalls”
  • Keep required Capell packages on compatible v4 releases: capell-app/admin, capell-app/core, capell-app/frontend.
  • Run migrations before opening package resources or public routes.
  • Review package configuration before production-like verification: config/capell-referer.php.
  • Keep the host Laravel scheduler running so package-registered schedules can execute: capell:referer:prune (daily; package registered).
  • Keep public Blade and cached HTML free of authoring markers, model IDs, permissions, signed editor URLs, and lazy database queries.
  • Custom write integrations must preserve invalidation for referer cache tags.

Troubleshooting

Section titled “Troubleshooting”
SymptomLikely causeCheckFix
Package surface is missing after installProvider or manifest is not loadedConfirm capell.json, package composer.json, and provider registrationReinstall the package, refresh Composer autoload, and clear host caches
Admin screen or command fails on missing tablePackage migrations have not runCheck the tables listed in Data ModelRun host migrations and rerun the focused package test
Background work does not runQueue worker or declared schedule is not activeCheck the jobs and scheduled commands listed in Technical ShapeStart the queue worker or host scheduler, then run the focused command or package test
Public output leaks unexpected stateRender data, cache variation, or authoring boundary has regressedCheck public Blade, cache tags, and public-output safety testsMove data loading out of Blade and rerun the package public-output tests

Quick Start

Section titled “Quick Start”
  1. Install the package: composer require capell-app/referer.
  2. See it working: run php artisan capell:referer:screenshot-fixture.
  3. Open the package admin surface at /admin/referer and confirm Referers is available.

Next Steps

Section titled “Next Steps”