Documentation

CourseDocument
in package
implements ResourceInterface uses IdentifiableTrait

AbstractYes
Tags
psalm-import-type

CourseGdprArrayType from Course as ImportedCourseGdprArrayType

psalm-type

CourseDocumentGdprArrayType = array{ id: int, course: ImportedCourseGdprArrayType, date: string, language: string, scanned: bool, path: string, }

Attributes
#[DiscriminatorColumn]
$name: 'type'
$type: 'string'
#[DiscriminatorMap]
$value: ['exam' => \Education\Model\Exam::class, 'summary' => \Education\Model\Summary::class]
#[Entity]
#[InheritanceType]
$value: 'SINGLE_TABLE'

Table of Contents

Interfaces

ResourceInterface

Properties

$course  : Course
The course to which this document belongs.
$date  : DateTime
Date of the exam.
$filename  : string
Filename of the exam.
$id  : int|null
The default value must be `null` to prevent issues with auto generating the value. The column is strictly not nullable.
$language  : Languages
The language of the exam.
$scanned  : bool
Whether the uploaded document is scanned or not. This influences the quality of the watermarking service.

Methods

getCourse()  : Course
Get the course.
getDate()  : DateTime
Get the date.
getFilename()  : string
Get the filename.
getId()  : int|null
Get the identifier of the object.
getLanguage()  : Languages
Get the language.
getResourceId()  : string
getScanned()  : bool
Get whether the document is scanned or not.
setCourse()  : void
Set the course.
setDate()  : void
Set the date.
setFilename()  : void
Set the filename.
setId()  : void
Setting the identifier manually will, in most instances, result in undefined behaviour. Use with caution!
setLanguage()  : void
Set the language.
setScanned()  : void
Set whether the document is scanned or not.
toGdprArray()  : CourseDocumentGdprArrayType

Properties

$course

The course to which this document belongs.

protected Course $course
Attributes
#[JoinColumn]
$name: 'course_code'
$referencedColumnName: 'code'
$nullable: false
#[ManyToOne]
$targetEntity: \Education\Model\Course::class
$inversedBy: 'documents'

$date

Date of the exam.

protected DateTime $date
Attributes
#[Column]
$type: 'date'

$filename

Filename of the exam.

protected string $filename
Attributes
#[Column]
$type: 'string'

$id

The default value must be `null` to prevent issues with auto generating the value. The column is strictly not nullable.

protected int|null $id = null
Attributes
#[Column]
$type: 'integer'
#[GeneratedValue]
$strategy: 'IDENTITY'
#[Id]

$language

The language of the exam.

protected Languages $language
Attributes
#[Column]
$type: 'string'
$enumType: \Application\Model\Enums\Languages::class

$scanned

Whether the uploaded document is scanned or not. This influences the quality of the watermarking service.

protected bool $scanned
Attributes
#[Column]
$type: 'boolean'

Methods

getDate()

Get the date.

public getDate() : DateTime
Return values
DateTime

getFilename()

Get the filename.

public getFilename() : string
Return values
string

getId()

Get the identifier of the object.

public getId() : int|null
Tags
psalm-ignore-nullable-return
Return values
int|null

getResourceId()

public getResourceId() : string
Return values
string

getScanned()

Get whether the document is scanned or not.

public getScanned() : bool
Return values
bool

setDate()

Set the date.

public setDate(DateTime $date) : void
Parameters
$date : DateTime

setFilename()

Set the filename.

public setFilename(string $filename) : void
Parameters
$filename : string

setId()

Setting the identifier manually will, in most instances, result in undefined behaviour. Use with caution!

public setId(int|null $id) : void
Parameters
$id : int|null

setScanned()

Set whether the document is scanned or not.

public setScanned(bool $scanned) : void
Parameters
$scanned : bool

toGdprArray()

public toGdprArray() : CourseDocumentGdprArrayType
Return values
CourseDocumentGdprArrayType 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results