PivotActivityFluent

class Zairakai\LaravelActivity\Support\PivotActivityFluent

Fluent API for pivot table activity logging.

Source: src/Support/PivotActivityFluent.php

Methods

__construct()

public function __construct(BelongsToMany $relation)

attach()

public function attach(mixed $ids, array $attributes = [], bool $touch = true): void

Attach models to the pivot table with activity logging.

by()

public function by(Model $model = null): static

Set the user or model causing this activity.

byAnonymous()

public function byAnonymous(): static

Mark activity as anonymous (no causer).

detach()

public function detach(mixed $ids = null, bool $touch = true): int

Detach models from the pivot table with activity logging.

Parameter	Description
$ids	IDs to detach, or null to detach all
$touch	Whether to touch parent timestamps

Returns int Number of detached records

sync()

public function sync(array|Collection|Model $ids, bool $detaching = true): array

Sync the pivot table with activity logging.

Returns array<string, array<int, int|string>>

syncWithoutDetaching()

public function syncWithoutDetaching(array|Collection|Model $ids): array

Sync without detaching with activity logging.

Returns array<string, array<int, int|string>>

toggle()

public function toggle(mixed $ids, bool $touch = true): array

Toggle models in the pivot table with activity logging.

Parameter	Description
$ids	IDs to toggle
$touch	Whether to touch parent timestamps

Returns array<string, array<int, int|string>> Result with 'attached' and 'detached' keys

updateExistingPivot()

public function updateExistingPivot(array|int|string $ids, array $attributes, bool $touch = true): int

Update existing pivot attributes with activity logging.

withMessage()

public function withMessage(string $message): static

Set a custom log message.

getCurrentPivotIds()

protected function getCurrentPivotIds(): array

Returns array<int, int|string>

getPivotAttributes()

protected function getPivotAttributes(array $ids): array

Returns array<int|string, array<string, mixed>>

hasChanged()

protected function hasChanged(array $before, array $after): bool

logActivity()

protected function logActivity(string $operation, mixed $before, mixed $after, string $defaultMessage): void

Write an activity log entry for the current operation.

Parameter	Description
$operation	Operation name (attached, detached, synced, …)
$before	State before the operation
$after	State after the operation
$defaultMessage	Fallback message when no custom message is set

normalizeIds()

protected function normalizeIds(mixed $ids): array

Returns array<int, int|string>