Filament Activity Log

https://github.com/pxlrbt/filament-activity-log
Admin
This package adds a page to the Filament Admin panel to view the activity log generated by...
Tokens:18,475
Snippets:161
Trust Score:9.6
License:MIT
Update:7 hours ago
Show doc for...
Tokens:
Raw
### Install via Composer

Source: https://github.com/pxlrbt/filament-activity-log/blob/main/readme.md

Run this command to install the package. Requires PHP 8.1, Filament 4.0 or 5.0, and spatie/laravel-activitylog 4.7 or 5.0.

```bash
composer require pxlrbt/filament-activity-log
```

--------------------------------

### Subclassing ListActivitiesBySubject for a custom page

Source: https://github.com/pxlrbt/filament-activity-log

Example of how application code subclasses the package's page. The provider itself is not instantiated directly; instead, pages like ListActivitiesBySubject are extended.

```php
namespace App\Filament\Resources\Orders\Pages;

use pxlrbt\FilamentActivityLog\Pages\ListActivitiesBySubject;

class ListOrderActivities extends ListActivitiesBySubject
{
    protected static string $resource = OrderResource::class;
}
```

--------------------------------

### getSubjectResource implementation

Source: https://github.com/pxlrbt/filament-activity-log

Resolves the model class from morph alias or uses the literal class, then gets the Filament resource.

```php
public function getSubjectResource(string $subjectType): ?string
{
    $modelClass = Relation::getMorphedModel($subjectType) ?? $subjectType;

    return Filament::getModelResource($modelClass);
}
```

--------------------------------

### Legacy usage of ListActivities (deprecated)

Source: https://github.com/pxlrbt/filament-activity-log

Example of subclassing the deprecated ListActivities class. Still functional but prefer ListActivitiesBySubject in new code.

```php
<?php

namespace App\Filament\Resources\Orders\Pages;

use pxlrbt\FilamentActivityLog\Pages\ListActivities;

class ListOrderActivities extends ListActivities
{
    protected static string $resource = OrderResource::class;
}
```

--------------------------------

### configurePackage method signature

Source: https://github.com/pxlrbt/filament-activity-log

The method signature for configurePackage(Package $package): void. It mutates the package builder and returns void.

```php
public function configurePackage(Package $package): void
```

--------------------------------

### Composer configuration for local development

Source: https://github.com/pxlrbt/filament-activity-log/blob/main/readme.md

Add the package as a path repository in your composer.json to test local changes. Use the 'dev-fix/error-message' branch as 'main-dev'.

```json
"require": {
    "pxlrbt/filament-activity-log": "dev-fix/error-message as main-dev",
},
"repositories": [
    {
        "type": "path",
        "url": "filament-activity-log"
    }
]
```

--------------------------------

### mount method signature

Source: https://github.com/pxlrbt/filament-activity-log

Livewire mount hook that resolves the record and initializes pagination. Takes the route-key/record identifier from Filament's page routing.

```php
public function mount($record)
```

--------------------------------

### Register the activities page in getPages()

Source: https://github.com/pxlrbt/filament-activity-log/blob/main/readme.md

Add the new page to your resource's getPages() method with a route like '/{record}/activities'.

```php
public static function getPages(): array
{
    return [
        'index' => Pages\ListUsers::route('/'),
        'create' => Pages\CreateUser::route('/create'),
        'activities' => Pages\ListUserActivities::route('/{record}/activities'),
        'edit' => Pages\EditUser::route('/{record}/edit'),
    ];
}
```

--------------------------------

### Create ListActivitiesBySubject page

Source: https://github.com/pxlrbt/filament-activity-log/blob/main/readme.md

Create a page class extending ListActivitiesBySubject inside your resource's Pages/ directory. Replace OrderResource with your actual resource class.

```php
<?php

namespace App\Filament\Resources\Orders\Pages;

use pxlrbt\FilamentActivityLog\Pages\ListActivitiesBySubject;

class ListOrderActivities extends ListActivitiesBySubject
{
    protected static string $resource = OrderResource::class;
}
```

--------------------------------

### Create ListUserActivities page extending ListActivitiesByCauser

Source: https://github.com/pxlrbt/filament-activity-log/blob/main/readme.md

Create a page class inside your UserResource's Pages directory that extends ListActivitiesByCauser. Set the $resource property to your UserResource class.

```php
<?php

namespace App\Filament\Resources\Users\Pages;

use pxlrbt\FilamentActivityLog\Pages\ListActivitiesByCauser;

class ListUserActivities extends ListActivitiesByCauser
{
    protected static string $resource = UserResource::class;
}
```

--------------------------------

### Register activities page in getPages()

Source: https://github.com/pxlrbt/filament-activity-log/blob/main/readme.md

Add the activities page to your resource's getPages() method. The route uses the {record} parameter to show activities for a specific record.

```php
public static function getPages(): array
{
    return [
        'index' => Pages\ListOrders::route('/'),
        'create' => Pages\CreateOrder::route('/create'),
        'activities' => Pages\ListOrderActivities::route('/{record}/activities'),
        'edit' => Pages\EditOrder::route('/{record}/edit'),
    ];
}
```

--------------------------------

### Register the page and route in getPages()

Source: https://github.com/pxlrbt/filament-activity-log

Add the activities page to the resource's getPages() array with a route like '/{record}/activities'. This is required to make the page accessible.

```php
public static function getPages(): array
{
    return [
        'index'      => Pages\ListOrders::route('/'),
        'create'     => Pages\CreateOrder::route('/create'),
        'activities' => Pages\ListOrderActivities::route('/{record}/activities'),
        'edit'       => Pages\EditOrder::route('/{record}/edit'),
    ];
}
```

--------------------------------

### Register the page and route in getPages()

Source: https://github.com/pxlrbt/filament-activity-log

Add the custom activities page to the resource's getPages() array with a route like '/{record}/activities'. This route must be defined for the page to be accessible.

```php
public static function getPages(): array
{
    return [
        'index'      => Pages\ListUsers::route('/'),
        'create'     => Pages\CreateUser::route('/create'),
        'activities' => Pages\ListUserActivities::route('/{record}/activities'),
        'edit'       => Pages\EditUser::route('/{record}/edit'),
    ];
}
```

--------------------------------

### createFieldLabelMap method signature

Source: https://github.com/pxlrbt/filament-activity-log

Builds a name => label map by instantiating the resource form, flattening the component tree, keeping Field and MorphToSelect components as leaves, and mapping each Field by getName() => getLabel().

```php
protected function createFieldLabelMap(): Collection
```

--------------------------------

### FilamentActivityLogServiceProvider class definition

Source: https://github.com/pxlrbt/filament-activity-log

The package's service provider extends Spatie\LaravelPackageTools\PackageServiceProvider and configures the package name, views, and translations via configurePackage(). It does not register routes, middleware, commands, policies, or config files.

```php
<?php

namespace pxlrbt\FilamentActivityLog;

use Spatie\LaravelPackageTools\Package;
use Spatie\LaravelPackageTools\PackageServiceProvider;

class FilamentActivityLogServiceProvider extends PackageServiceProvider
{
    public static string $name = 'filament-activity-log';

    public function configurePackage(Package $package): void
    {
        $package
            ->name(static::$name)
            ->hasViews()
            ->hasTranslations();
    }
}
```

--------------------------------

### Composer auto-discovery configuration for FilamentActivityLogServiceProvider

Source: https://github.com/pxlrbt/filament-activity-log

Declares the package's service provider in composer.json so Laravel auto-discovers it. No manual registration is needed when this block is present.

```json
"extra": {
    "laravel": {
        "providers": [
            "\\pxlrbt\\FilamentActivityLog\\FilamentActivityLogServiceProvider"
        ]
    }
}
```

--------------------------------

### Use LogsActivity trait on model

Source: https://github.com/pxlrbt/filament-activity-log/blob/main/readme.md

Apply the LogsActivity trait to your resource model to enable activity logging.

```php
<?php

use Spatie\Activitylog\Models\Concerns\LogsActivity;

class Order extends Model
{
    use LogsActivity;
}
```

--------------------------------

### Restore activity with authorization and notifications

Source: https://github.com/pxlrbt/filament-activity-log

Shows the authorization check and restore call. The UI Restore button triggers this via wire:click; if not authorized, a 403 is aborted. Success shows a success notification, failure shows a danger notification with message.

```php
// In-code invocation won't normally be used; the UI wire:click calls it.
// If the caller is not authorized a 403 is aborted:

if (! $this->canRestoreActivity()) {
    abort(403);
}

$this->restoreActivity($activityId); // success -> success notification,
                                      // failure  -> danger notification + message
```

--------------------------------

### Add plugin CSS import for Filament v4

Source: https://github.com/pxlrbt/filament-activity-log/blob/main/readme.md

Add this line to your custom theme's CSS file and recompile to include the plugin's styles.

```css
@import '../../../../vendor/pxlrbt/filament-activity-log/resources/css/styles.css';
```

--------------------------------

### CanPaginate trait definition (src/Pages/Concerns/CanPaginate.php)

Source: https://github.com/pxlrbt/filament-activity-log

Reusable Livewire trait for activity-log pages providing pagination state and session persistence. Supports Filament's default (LengthAware), simple, and cursor pagination modes via getPaginationMode(). Stores the selected per-page option in the session keyed by page class and resets the page on update. Default per-page options are [10, 25, 50]; 'all' uses the total count for pagination.

```php
<?php

namespace pxlrbt\FilamentActivityLog\Pages\Concerns;

use Filament\Tables\Enums\PaginationMode;
use Illuminate\Contracts\Pagination\CursorPaginator;
use Illuminate\Contracts\Pagination\Paginator;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Pagination\LengthAwarePaginator;

trait CanPaginate
{
    /**
     * @var int | string | null
     */
    public $recordsPerPage = null;

    protected int|string|null $defaultRecordsPerPageSelectOption = null;

    public function updatedRecordsPerPage(): void
    {
        session()->put([
            $this->getPerPageSessionKey() => $this->getRecordsPerPage(),
        ]);

        $this->resetPage();
    }

    protected function paginateQuery(Builder $query): Paginator|CursorPaginator
    {
        $perPage = $this->getRecordsPerPage();

        $mode = $this->getPaginationMode();

        if ($mode === PaginationMode::Simple) {
            return $query->simplePaginate(
                perPage: ($perPage === 'all') ? $query->toBase()->getCountForPagination() : $perPage,
                pageName: $this->getPaginationPageName(),
            );
        }

        if ($mode === PaginationMode::Cursor) {
            return $query->cursorPaginate(
                perPage: ($perPage === 'all') ? $query->toBase()->getCountForPagination() : $perPage,
                cursorName: $this->getPaginationPageName(),
            );
        }

        $total = $query->toBase()->getCountForPagination();

        /** @var LengthAwarePaginator $records */
        $records = $query->paginate(
            perPage: ($perPage === 'all') ? $total : $perPage,
            pageName: $this->getPaginationPageName(),
            total: $total,
        );

        return $records->onEachSide(0);
    }

    public function getRecordsPerPage(): int|string|null
    {
        return $this->recordsPerPage;
    }

    public function getTablePage(): int
    {
        return $this->getPage($this->getPaginationPageName());
    }

    public function getDefaultRecordsPerPageSelectOption(): int|string
    {
        $option = session()->get(
            $this->getPerPageSessionKey(),
            $this->defaultRecordsPerPageSelectOption,
        );

        $pageOptions = $this->getRecordsPerPageSelectOptions();

        if (in_array($option, $pageOptions)) {
            return $option;
        }

        session()->remove($this->getPerPageSessionKey());

        return $pageOptions[0];
    }

    public function getPaginationPageName(): string
    {
        return 'recordsPerPage';
    }

    public function getPerPageSessionKey(): string
    {
        $name = md5($this::class);

        return "pages.{$name}_per_page";
    }

    /**
     * @return array<int | string> | null
     */
    protected function getRecordsPerPageSelectOptions(): ?array
    {
        return [10, 25, 50];
    }
}

```

--------------------------------

### getTitle method signature

Source: https://github.com/pxlrbt/filament-activity-log

Returns the page title: the translation 'filament-activity-log::activities.title' with the ':record' placeholder replaced by getRecordTitle().

```php
public function getTitle(): string
```

--------------------------------

### getActivities method signature

Source: https://github.com/pxlrbt/filament-activity-log

Builds the query for the current record's activities using activitiesAsSubject()->with('causer')->latest()->getQuery() and passes it through paginateQuery(). Returns a Paginator or CursorPaginator.

```php
public function getActivities()
```

--------------------------------

### getSubjectResource method signature

Source: https://github.com/pxlrbt/filament-activity-log

Maps a subject's morph class to its Filament resource.

```php
public function getSubjectResource(string $subjectType): ?string
```

--------------------------------

### User model with CausesActivity trait

Source: https://github.com/pxlrbt/filament-activity-log/blob/main/readme.md

Add the CausesActivity trait to your user model to enable activity logging for that model. This is required for the ListActivitiesByCauser page to work.

```php
<?php

use Spatie\Activitylog\Models\Concerns\CausesActivity;

class User extends Authenticatable implements FilamentUser
{
    use CausesActivity;
}
```

--------------------------------

### Manual registration of FilamentActivityLogServiceProvider

Source: https://github.com/pxlrbt/filament-activity-log

Registers the provider manually in a Laravel service provider's register() method. Only needed if auto-discovery is disabled.

```php
use pxlrbt\FilamentActivityLog\FilamentActivityLogServiceProvider;

public function register(): void
{
    $this->app->register(FilamentActivityLogServiceProvider::class);
}
```

--------------------------------

### ListActivitiesBySubject class definition

Source: https://github.com/pxlrbt/filament-activity-log

Abstract Filament resource page for rendering the activity log of a single record. Extends Filament\Resources\Pages\Page, implements HasForms, and uses CanPaginate, InteractsWithFormActions, InteractsWithRecord, and WithPagination traits. Requires the subject model to use the spatie LogsActivity trait.

```php
<?php

namespace pxlrbt\FilamentActivityLog\Pages;

use Exception;
use Filament\Forms\Components\Field;
use Filament\Forms\Components\MorphToSelect;
use Filament\Forms\Contracts\HasForms;
use Filament\Notifications\Notification;
use Filament\Pages\Concerns\InteractsWithFormActions;
use Filament\Resources\Pages\Concerns\InteractsWithRecord;
use Filament\Resources\Pages\Page;
use Filament\Schemas\Schema;
use Filament\Tables\Enums\PaginationMode;
use Illuminate\Support\Collection;
use Livewire\WithPagination;
use pxlrbt\FilamentActivityLog\Pages\Concerns\CanPaginate;

abstract class ListActivitiesBySubject extends Page implements HasForms
{
    use CanPaginate;
    use InteractsWithFormActions;
    use InteractsWithRecord;
    use WithPagination;

    protected string $view = 'filament-activity-log::pages.list-activities-by-subject';

    protected static Collection $fieldLabelMap;

    public function mount($record)
    // ... (see method listings below)
}
```

--------------------------------

### canRestoreActivity method signature

Source: https://github.com/pxlrbt/filament-activity-log

Returns whether the activity can be restored, delegating to static::getResource()::canRestore($this->record). Controls the Restore button visibility.

```php
public function canRestoreActivity(): bool
```

--------------------------------

### Use CausesActivity trait on the causer model

Source: https://github.com/pxlrbt/filament-activity-log

The model that causes activities must use the Spatie CausesActivity trait. This is required for the causer to be tracked.

```php
use Spatie\Activitylog\Models\Concerns\CausesActivity;

class User extends Authenticatable implements FilamentUser
{
    use CausesActivity;
}
```

--------------------------------

### restoreActivity(int|string $key)

Source: https://github.com/pxlrbt/filament-activity-log

Restores the record to the attribute values captured in the activity's attribute_changes.old. Authorization is enforced first.

```APIDOC
## restoreActivity(int|string $key)

### Description
Restores the record to the attribute values captured in the activity's `attribute_changes.old`. Authorization is enforced first.

### Method
Livewire action (triggered via `wire:click`)

### Parameters
#### Path Parameters
- `$key` (int|string) - Required - Primary key of the `Spatie\Activitylog\Models\Activity` row being restored.

### Response
#### Success Response
- **Return type:** `void` (no return value)

#### Throws
- `Symfony\Component\HttpKernel\Exception\HttpException` (via `abort(403)`) - Called when `canRestoreActivity()` returns `false`.

#### Failure paths (no exception thrown, fallback notifications)
- `attribute_changes.old` is `null` → `sendRestoreFailureNotification()` with no message.
- `$this->record->update($oldAttributes)` throws an `Exception` → caught and surfaced as `sendRestoreFailureNotification($e->getMessage())`.

### Request Example
```php
public function restoreActivity(int|string $key)
{
    if (! $this->canRestoreActivity()) {
        abort(403);
    }

    $activity = $this->record->activitiesAsSubject()
        ->whereKey($key)
        ->first();

    $oldAttributes = data_get($activity, 'attribute_changes.old');

    if ($oldAttributes === null) {
        $this->sendRestoreFailureNotification();

        return;
    }

    try {
        $this->record->update($oldAttributes);

        $this->sendRestoreSuccessNotification();
    } catch (Exception $e) {
        $this->sendRestoreFailureNotification($e->getMessage());
    }
}
```
```

--------------------------------

### restoreActivity method

Source: https://github.com/pxlrbt/filament-activity-log

Restores the record to the attribute values captured in the activity's attribute_changes.old. Enforces authorization via canRestoreActivity() and aborts with 403 if unauthorized. Falls back to sendRestoreFailureNotification() when old attributes are null or an exception occurs during update.

```php
public function restoreActivity(int|string $key)
{
    if (! $this->canRestoreActivity()) {
        abort(403);
    }

    $activity = $this->record->activitiesAsSubject()
        ->whereKey($key)
        ->first();

    $oldAttributes = data_get($activity, 'attribute_changes.old');

    if ($oldAttributes === null) {
        $this->sendRestoreFailureNotification();

        return;
    }

    try {
        $this->record->update($oldAttributes);

        $this->sendRestoreSuccessNotification();
    } catch (Exception $e) {
        $this->sendRestoreFailureNotification($e->getMessage());
    }
}
```

--------------------------------

### sendRestoreSuccessNotification method signature

Source: https://github.com/pxlrbt/filament-activity-log

Protected method that returns a Filament success notification titled 'filament-activity-log::activities.events.restore_successful', sent via ->send(). No parameters.

```php
protected function sendRestoreSuccessNotification(): Notification
```

--------------------------------

### Subclass ListActivitiesBySubject for a resource

Source: https://github.com/pxlrbt/filament-activity-log

Create a page class extending ListActivitiesBySubject and set the resource. This is the basic usage from the README, adapted.

```php
<?php

namespace App\Filament\Resources\Orders\Pages;

use pxlrbt\FilamentActivityLog\Pages\ListActivitiesBySubject;

class ListOrderActivities extends ListActivitiesBySubject
{
    protected static string $resource = OrderResource::class;
}
```

--------------------------------

### Resolve subject resource for deep linking

Source: https://github.com/pxlrbt/filament-activity-log

In application or extended code, resolve the subject resource from the activity's subject_type. If the resource exists and has a record title, generate a deep link to the subject's edit page.

```php
// Given an activity whose subject_type is stored as a morph alias or class:
$subjectType = $activityItem->subject_type;
$resource = $this->getSubjectResource($subjectType);

if ($resource !== null && $activityItem->subject && $resource::hasRecordTitle()) {
    $url = $resource::getUrl('edit', ['record' => $activityItem->subject]); // deep link to subject
}
```

--------------------------------

### ListActivitiesByCauser class definition

Source: https://github.com/pxlrbt/filament-activity-log

Abstract Filament resource page that renders the activity log caused by a record (e.g., a user) across all subjects. Requires the spatie trait CausesActivity on the causal model for the activitiesAsCauser() relation. Does not expose a restoreActivity() action, unlike ListActivitiesBySubject.

```php
<?php

namespace pxlrbt\FilamentActivityLog\Pages;

use Filament\Facades\Filament;
use Filament\Forms\Components\Field;
use Filament\Forms\Components\MorphToSelect;
use Filament\Forms\Contracts\HasForms;
use Filament\Pages\Concerns\InteractsWithFormActions;
use Filament\Resources\Pages\Concerns\InteractsWithRecord;
use Filament\Resources\Pages\Page;
use Filament\Schemas\Schema;
use Filament\Tables\Enums\PaginationMode;
use Illuminate\Database\Eloquent\Relations\Relation;
use Illuminate\Support\Collection;
use Livewire\WithPagination;
use pxlrbt\FilamentActivityLog\Pages\Concerns\CanPaginate;

abstract class ListActivitiesByCauser extends Page implements HasForms
{
    use CanPaginate;
    use InteractsWithFormActions;
    use InteractsWithRecord;
    use WithPagination;

    protected string $view = 'filament-activity-log::pages.list-activities-by-causer';

    /** @var array<class-string, Collection<string, string>> */
    protected static array $fieldLabelMaps = [];

    public function mount($record)
    // ... (see method listings below)
}
```

--------------------------------

### Use LogsActivity trait on the subject model

Source: https://github.com/pxlrbt/filament-activity-log

The subject model must use the Spatie LogsActivity trait for the relation used by getActivities().

```php
use Spatie\Activitylog\Models\Concerns\LogsActivity;

class Order extends Model
{
    use LogsActivity;
}
```

--------------------------------

### Subclass ListActivitiesByCauser in a resource page

Source: https://github.com/pxlrbt/filament-activity-log

Create a custom page class extending ListActivitiesByCauser and set the resource to the target resource. Register this page in the resource's getPages() method to display activities for a causer.

```php
<?php

namespace App\Filament\Resources\Users\Pages;

use pxlrbt\FilamentActivityLog\Pages\ListActivitiesByCauser;

class ListUserActivities extends ListActivitiesByCauser
{
    protected static string $resource = UserResource::class;
}
```

--------------------------------

### getFieldLabel method signature

Source: https://github.com/pxlrbt/filament-activity-log

Returns a human-readable label for a changed field, scoped to the subject's resource.

```php
public function getFieldLabel(?string $resourceClass, string $name): string
```

--------------------------------

### Equivalent non-deprecated version using ListActivitiesBySubject

Source: https://github.com/pxlrbt/filament-activity-log

Recommended replacement for the deprecated ListActivities usage. Subclass ListActivitiesBySubject directly.

```php
use pxlrbt\FilamentActivityLog\Pages\ListActivitiesBySubject;

class ListOrderActivities extends ListActivitiesBySubject
{
    protected static string $resource = OrderResource::class;
}
```

--------------------------------

### getBreadcrumb method signature

Source: https://github.com/pxlrbt/filament-activity-log

Returns the breadcrumb string: static::$breadcrumb if set, otherwise the translation 'filament-activity-log::activities.breadcrumb'.

```php
public function getBreadcrumb(): string
```

--------------------------------

### Override getRecordsPerPageSelectOptions() in a subclass

Source: https://github.com/pxlrbt/filament-activity-log

Overriding behavior in a subclass to change the offered page sizes and the persisted default. The trait's methods are overridable in the subclass. Because recordsPerPage is Livewire-bound, the user-selected page size is stored in the session and restored on the next visit via getDefaultRecordsPerPageSelectOption(). Invalid previously-stored values are automatically discarded and reset to the first option.

```php
class MyActivitiesPage extends ListActivitiesBySubject
{
    // The trait's methods are overridable in the subclass:
    protected function getRecordsPerPageSelectOptions(): ?array
    {
        return [5, 20, 50, 'all'];
    }
}
```

--------------------------------

### getPaginationMode method signature

Source: https://github.com/pxlrbt/filament-activity-log

Returns the pagination mode, always PaginationMode::Default.

```php
public function getPaginationMode(): PaginationMode
```

--------------------------------

### sendRestoreFailureNotification method signature

Source: https://github.com/pxlrbt/filament-activity-log

Protected method that returns a Filament danger notification titled 'filament-activity-log::activities.events.restore_failed', optionally with the exception message as body, sent via ->send(). Accepts an optional $message parameter.

```php
protected function sendRestoreFailureNotification(?string $message = null): Notification
```

--------------------------------

### sendRestoreSuccessNotification(): Notification

Source: https://github.com/pxlrbt/filament-activity-log

Sends a success notification titled 'filament-activity-log::activities.events.restore_successful'.

```APIDOC
## sendRestoreSuccessNotification(): Notification

### Description
Sends a success notification titled `filament-activity-log::activities.events.restore_successful`.

### Method
Protected method

### Parameters
None

### Response
#### Success Response
- **Return type:** `Filament\Notifications\Notification` — a success notification titled `filament-activity-log::activities.events.restore_successful`, sent via `->send()`.

### Request Example
```php
protected function sendRestoreSuccessNotification(): Notification
```
```

--------------------------------

### getFieldLabel method signature

Source: https://github.com/pxlrbt/filament-activity-log

Returns a human-readable label for a changed field name, mapping through the resource's form schema. Unknown field names are returned unchanged.

```php
public function getFieldLabel(string $name): string
```

--------------------------------

### Call paginateQuery() inside a subclass of ListActivitiesBySubject / ListActivitiesByCauser

Source: https://github.com/pxlrbt/filament-activity-log

Basic usage of the CanPaginate trait. Typically you don't call the trait's methods yourself; the shipped page classes call paginateQuery() and getDefaultRecordsPerPageSelectOption() internally, and the Blade x-filament::pagination component reads getRecordsPerPageSelectOptions(). This snippet shows calling paginateQuery() with the activities query.

```php
// Inside a subclass of ListActivitiesBySubject / ListActivitiesByCauser,
// or any page that uses the trait:
$paginator = $this->paginateQuery(
    $this->record->activitiesAsSubject()->latest()->getQuery()
);
```

--------------------------------

### sendRestoreFailureNotification(?string $message = null): Notification

Source: https://github.com/pxlrbt/filament-activity-log

Sends a danger notification titled 'filament-activity-log::activities.events.restore_failed', optionally with the exception message as body.

```APIDOC
## sendRestoreFailureNotification(?string $message = null): Notification

### Description
Sends a danger notification titled `filament-activity-log::activities.events.restore_failed`, optionally with the exception message as body.

### Method
Protected method

### Parameters
#### Path Parameters
- `$message` (?string) - Optional - Default: `null` - Optional failure detail appended as the notification body.

### Response
#### Success Response
- **Return type:** `Filament\Notifications\Notification` — a danger notification titled `filament-activity-log::activities.events.restore_failed`, optionally with the exception message as body, sent via `->send()`.

### Request Example
```php
protected function sendRestoreFailureNotification(?string $message = null): Notification
```
```

--------------------------------

### ListActivities (deprecated) - Class Definition

Source: https://github.com/pxlrbt/filament-activity-log

A deprecated abstract alias for ListActivitiesBySubject. It exists only for backward compatibility so that subclasses written against the older page name continue to work unchanged. New code should target ListActivitiesBySubject directly.

```APIDOC
## ListActivities (deprecated)

### Description
A deprecated abstract alias for `ListActivitiesBySubject`. It exists only for backward compatibility so that subclasses written against the older page name continue to work unchanged. New code should target `ListActivitiesBySubject` directly.

### Namespace / Import Path
`pxlrbt\FilamentActivityLog\Pages\ListActivities`

### Class Definition
```php
<?php

namespace pxlrbt\FilamentActivityLog\Pages;

/**
 * @deprecated Use ListActivitiesBySubject directly
 */
abstract class ListActivities extends ListActivitiesBySubject {}
```

### Attributes
- `@deprecated` - Marks the class as deprecated and instructs consumers to use `ListActivitiesBySubject` directly.

### Inherited Members
Since `ListActivities` extends `ListActivitiesBySubject` without adding or overriding anything, it inherits all members documented under `ListActivitiesBySubject`:
- `protected string $view` = `'filament-activity-log::pages.list-activities-by-subject'`
- `mount($record)`, `getBreadcrumb()`, `getTitle()`, `getActivities()`, `getPaginationMode()`, `getFieldLabel(string $name)`
- `canRestoreActivity()`, `restoreActivity(int|string $key)`
- the `CanPaginate`, `InteractsWithFormActions`, `InteractsWithRecord`, and `WithPagination` traits
- `implements HasForms`

### Usage Notes
This class is purely an identity marker — it adds zero behavior and only forwards inheritance to `ListActivitiesBySubject`. You would only subclass it when migrating an existing codebase that names the page this way. New code should target `ListActivitiesBySubject`. The deprecation is advisory only (a docblock); the class still functions as before and no removal warning is emitted at runtime in the current codebase.

### Example
Legacy usage (still functional, but deprecated — prefer `ListActivitiesBySubject` in new code):

```php
<?php

namespace App\Filament\Resources\Orders\Pages;

use pxlrbt\FilamentActivityLog\Pages\ListActivities;

class ListOrderActivities extends ListActivities
{
    protected static string $resource = OrderResource::class;
}
```

Equivalent non-deprecated version:

```php
use pxlrbt\FilamentActivityLog\Pages\ListActivitiesBySubject;

class ListOrderActivities extends ListActivitiesBySubject
{
    protected static string $resource = OrderResource::class;
}
```

### Related Pages
- `ListActivitiesBySubject`
- `ListActivitiesByCauser`
```

--------------------------------

### ListActivities abstract class definition (deprecated)

Source: https://github.com/pxlrbt/filament-activity-log

Deprecated abstract alias for ListActivitiesBySubject, kept for backward compatibility. It is an empty subclass that inherits all members from ListActivitiesBySubject.

```php
<?php

namespace pxlrbt\FilamentActivityLog\Pages;

/**
 * @deprecated Use ListActivitiesBySubject directly
 */
abstract class ListActivities extends ListActivitiesBySubject {}
```
Tokens:
Raw