1. class
  2. Biigle
  3. \
  4. Modules
  5. \
  6. Reports
  7. \
  8. Report

Report

class Report extends Model

Traits

HasFactory

Properties

protected ReportGenerator $reportGenerator

The report generator for this report.
protected array $casts

The attributes that should be casted to native types.

Methods

BelongsTo
user()

The user that requested the report.

BelongsTo
type()

Type of the report.

MorphTo
source()

Source of the report (\Biigle\Volume, \Biigle\Project or \Biigle\Video).

string
getSourceNameAttribute()

Get the source name dynamically if the source still exists.

setReportGenerator(ReportGenerator $generator)

Set the report generator for this model.

ReportGenerator
getReportGenerator()

Get the report generator for this report;.

generate()

Generate the report file for this report.

string
getSubjectAttribute()

Get the subject for this report.

string
getNameAttribute()

Get the name for this report.

string
getFilenameAttribute()

Get the filename for this report.

string
getUrl()

Get the URL to download the report.

deleteFile()

Delete the file that belongs to this report.

string
getStorageFilename()

Get the filename of the report in storage (not the filename for download).

static Factory
newFactory()

Create a new factory instance for the model.

Details

at line 43
BelongsTo user()

The user that requested the report.

Return Value

BelongsTo

at line 53
BelongsTo type()

Type of the report.

Return Value

BelongsTo

at line 64
MorphTo source()

Source of the report (\Biigle\Volume, \Biigle\Project or \Biigle\Video).

Return Value

MorphTo

at line 74
string getSourceNameAttribute()

Get the source name dynamically if the source still exists.

Return Value

string

at line 88
setReportGenerator(ReportGenerator $generator)

Set the report generator for this model.

Parameters

ReportGenerator $generator

at line 98
ReportGenerator getReportGenerator()

Get the report generator for this report;.

Return Value

ReportGenerator

at line 110
generate()

Generate the report file for this report.

at line 126
string getSubjectAttribute()

Get the subject for this report.

Return Value

string

at line 138
string getNameAttribute()

Get the name for this report.

Return Value

string

at line 148
string getFilenameAttribute()

Get the filename for this report.

Return Value

string

at line 158
string getUrl()

Get the URL to download the report.

Return Value

string

at line 166
deleteFile()

Delete the file that belongs to this report.

at line 176
string getStorageFilename()

Get the filename of the report in storage (not the filename for download).

Return Value

string

at line 188
static protected Factory newFactory()

Create a new factory instance for the model.

Return Value

Factory