PHP Class Spatie\Activitylog\ActivityLogger

Inheritance: use trait Illuminate\Support\Traits\Macroable
Show file Open project: spatie/laravel-activitylog

Protected Properties

Property Type Description
$auth Illuminate\Auth\AuthManager
$causedBy Illuminate\Database\Eloquent\Model
$logEnabled boolean
$logName
$performedOn Illuminate\Database\Eloquent\Model
$properties Illuminate\Support\Collection

Public Methods

Method Description
__construct ( Illuminate\Auth\AuthManager $auth, Illuminate\Contracts\Config\Repository $config )
by ( $modelOrId )
causedBy ( Model | integer | string $modelOrId )
inLog ( string $logName )
log ( string $description ) : null | mixed
on ( Model $model )
performedOn ( Model $model )
useLog ( string $logName )
withProperties ( array | Collection $properties )
withProperty ( string $key, mixed $value )

Protected Methods

Method Description
normalizeCauser ( Model | integer | string $modelOrId ) : Model
replacePlaceholders ( string $description, Activity $activity ) : string

Method Details

__construct() public method

public __construct ( Illuminate\Auth\AuthManager $auth, Illuminate\Contracts\Config\Repository $config )
$auth Illuminate\Auth\AuthManager
$config Illuminate\Contracts\Config\Repository

by() public method

public by ( $modelOrId )

causedBy() public method

public causedBy ( Model | integer | string $modelOrId )
$modelOrId Illuminate\Database\Eloquent\Model | integer | string

inLog() public method

public inLog ( string $logName )
$logName string

log() public method

public log ( string $description ) : null | mixed
$description string
return null | mixed

normalizeCauser() protected method

protected normalizeCauser ( Model | integer | string $modelOrId ) : Model
$modelOrId Illuminate\Database\Eloquent\Model | integer | string
return Illuminate\Database\Eloquent\Model

on() public method

public on ( Model $model )
$model Illuminate\Database\Eloquent\Model

performedOn() public method

public performedOn ( Model $model )
$model Illuminate\Database\Eloquent\Model

replacePlaceholders() protected method

protected replacePlaceholders ( string $description, Activity $activity ) : string
$description string
$activity Spatie\Activitylog\Models\Activity
return string

useLog() public method

public useLog ( string $logName )
$logName string

withProperties() public method

public withProperties ( array | Collection $properties )
$properties array | Illuminate\Support\Collection

withProperty() public method

public withProperty ( string $key, mixed $value )
$key string
$value mixed

Property Details

$auth protected property

protected AuthManager,Illuminate\Auth $auth
return Illuminate\Auth\AuthManager

$causedBy protected property

protected Model,Illuminate\Database\Eloquent $causedBy
return Illuminate\Database\Eloquent\Model

$logEnabled protected property

protected bool $logEnabled
return boolean

$logName protected property

protected $logName

$performedOn protected property

protected Model,Illuminate\Database\Eloquent $performedOn
return Illuminate\Database\Eloquent\Model

$properties protected property

protected Collection,Illuminate\Support $properties
return Illuminate\Support\Collection