VideoIfdoReportGenerator
class VideoIfdoReportGenerator extends ProjectVideoReportGenerator
Traits
Properties
| Collection | $options | Options for this report. |
from ReportGenerator |
| string | $name | Name of the report for use in text. |
|
| string | $filename | Name of the report for use as (part of) a filename. |
|
| string | $extension | File extension of the report file. |
from ProjectReportGenerator |
| protected mixed | $source | Source this report belongs to (e.g. a volume). |
from ReportGenerator |
| protected array | $tmpFiles | Temporary files that are created when generating a report. |
from ReportGenerator |
| protected Collection | $labels | Cache for labels of all label trees that are used for this report. |
from ReportGenerator |
| protected string | $reportClass | The class of the volume report to use for this project report. |
Methods
Get the report generator for the given type.
Constructs a label name from the names of all parent labels and the label itself.
Get all labels that belong to the label tree of the given label.
Should this report separate the output files for different label trees?
Should this report separate the output files for different user?
Returns the array of label ids to which this report should be restricted.
Determines if this report is restricted to a subset of labels.
Sanitizes a filename.
Get sources for the sub-reports that should be generated for this project.
Determines if this report should take only the newest label for each annotation.
Details
in
ReportGenerator at line 75
static ReportGenerator
get(string $sourceClass, ReportType $type, array $options = [])
Get the report generator for the given type.
in
ReportGenerator at line 103
__construct(array $options = [])
Create a report generator instance.
in
ReportGenerator at line 116
string
generate(mixed $source)
Generate the report.
in
ProjectReportGenerator at line 31
generateReport(string $path)
Generate the report.
in
ReportGenerator at line 163
setSource(mixed $source)
Set the source.
in
ReportGenerator at line 173
string
getName()
Get the report name.
in
ReportGenerator at line 183
string
getFilename()
Get the report filename.
in
ReportGenerator at line 193
string
getFullFilename()
Get the filename with extension.
in
ReportGenerator at line 206
string
expandLabelName(int $id)
Constructs a label name from the names of all parent labels and the label itself.
Example: Animalia > Annelida > Polychaeta > Buskiella sp
in
ReportGenerator at line 237
protected Collection
getSiblingLabels(int $id)
Get all labels that belong to the label tree of the given label.
in
ReportGenerator at line 253
protected bool
shouldSeparateLabelTrees()
Should this report separate the output files for different label trees?
in
ReportGenerator at line 263
protected bool
shouldSeparateUsers()
Should this report separate the output files for different user?
in
ReportGenerator at line 273
protected array
getOnlyLabels()
Returns the array of label ids to which this report should be restricted.
in
ReportGenerator at line 283
protected bool
isRestrictedToLabels()
Determines if this report is restricted to a subset of labels.
in
MakesZipArchives at line 22
protected
makeZip(array $files, string $path)
Create a ZIP archive as a report.
This function will create a ZIP archive at $this->availableReport->path.
in
MakesZipArchives at line 48
protected string
sanitizeFilename(string $name, string $extension)
Sanitizes a filename.
at line 36
mixed
getProjectSources()
Get sources for the sub-reports that should be generated for this project.
in
ProjectReportGenerator at line 59
protected ReportGenerator
getReportGenerator()
Get the report generator.
in
ProjectReportGenerator at line 69
protected bool
isRestrictedToNewestLabel()
Determines if this report should take only the newest label for each annotation.