Documentation

SignupList
in package
implements OrganResourceInterface, CreatorResourceInterface uses IdentifiableTrait

SignupList model.

Tags
psalm-import-type

SignupFieldArrayType from SignupField as ImportedSignupFieldArrayType

psalm-import-type

LocalisedTextGdprArrayType from LocalisedTextModel as ImportedLocalisedTextGdprArrayType

psalm-import-type

SignupFieldGdprArrayType from SignupField as ImportedSignupFieldGdprArrayType

psalm-type

SignupListArrayType = array{ id: int, name: ?string, nameEn: ?string, openDate: datetime, closeDate: datetime, onlyGEWIS: bool, displaySubscribedNumber: bool, limitedCapacity: bool, fields: ImportedSignupFieldArrayType[], presenceTaken: bool, }

psalm-type

SignupListGdprArrayType = array{ id: int, name: ImportedLocalisedTextGdprArrayType, openDate: string, closeDate: string, onlyGEWIS: bool, displaySubscribedNumber: bool, limitedCapacity: bool, fields: ImportedSignupFieldGdprArrayType[], presenceTaken: bool, }

Attributes
#[Entity]

Table of Contents

Interfaces

OrganResourceInterface
CreatorResourceInterface

Properties

$activity  : Activity
The Activity this SignupList belongs to.
$closeDate  : DateTime
The date and time after which the SignupList is no longer open.
$displaySubscribedNumber  : bool
Determines if the number of signed up members should be displayed when the user is NOT logged in.
$fields  : Collection<string|int, SignupField>
All additional fields belonging to the activity.
$id  : int|null
The default value must be `null` to prevent issues with auto generating the value. The column is strictly not nullable.
$limitedCapacity  : bool
If the sign-up list has limited capacity, we should show users a warning that this is the case.
$name  : ActivityLocalisedText
The name of the SignupList.
$onlyGEWIS  : bool
Determines if people outside of GEWIS can sign up.
$openDate  : DateTime
The date and time the SignupList is open for signups.
$presenceTaken  : bool
Determines if presence was taken for this SignupList
$signUps  : Collection<string|int, Signup>
All the people who signed up for this SignupList.

Methods

__construct()  : mixed
getActivity()  : Activity
Returns the associated Activity.
getCloseDate()  : DateTime
Returns the closing DateTime of this SignupList.
getDisplaySubscribedNumber()  : bool
Returns true if this SignupList shows the number of members who signed up when the user is not logged in.
getFields()  : Collection<string|int, SignupField>
getId()  : int|null
Get the identifier of the object.
getLimitedCapacity()  : bool
Returns true if this SignupList has a limited capacity.
getName()  : ActivityLocalisedText
getOnlyGEWIS()  : bool
Returns true if this SignupList is only available to members of GEWIS.
getOpenDate()  : DateTime
Returns the opening DateTime of this SignupList.
getResourceCreator()  : Member
Get the creator of this resource.
getResourceId()  : string
Returns the string identifier of the Resource.
getResourceOrgan()  : Organ|null
Get the organ of this resource.
getSignUps()  : Collection<string|int, Signup>
isOpen()  : bool
Whether the sign-up list period is now.
isPresenceTaken()  : bool
Gets presenceTaken for this SignupList
setActivity()  : void
Sets the associated Activity.
setCloseDate()  : void
Sets the closing DateTime of this SignupList.
setDisplaySubscribedNumber()  : void
Sets whether or not this SignupList should show the number of members who signed up when the user is not logged in.
setFields()  : void
setId()  : void
Setting the identifier manually will, in most instances, result in undefined behaviour. Use with caution!
setLimitedCapacity()  : void
Sets whether or not this SignupList has limited capacity.
setName()  : void
setOnlyGEWIS()  : void
Sets whether or not this SignupList is available to members of GEWIS.
setOpenDate()  : void
Sets the opening DateTime of this SignupList.
setPresenceTaken()  : void
Sets presenceTaken for this SignupList
setSignUps()  : void
toArray()  : SignupListArrayType
Returns an associative array representation of this object.
toGdprArray()  : SignupListGdprArrayType

Properties

$activity

The Activity this SignupList belongs to.

protected Activity $activity
Attributes
#[JoinColumn]
$name: 'activity_id'
$referencedColumnName: 'id'
$nullable: false
#[ManyToOne]
$targetEntity: \Activity\Model\Activity::class
$cascade: ['persist']
$inversedBy: 'signupLists'

$closeDate

The date and time after which the SignupList is no longer open.

protected DateTime $closeDate
Attributes
#[Column]
$type: 'datetime'

$displaySubscribedNumber

Determines if the number of signed up members should be displayed when the user is NOT logged in.

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

$fields

All additional fields belonging to the activity.

protected Collection<string|int, SignupField> $fields
Attributes
#[OneToMany]
$mappedBy: 'signupList'
$targetEntity: \Activity\Model\SignupField::class
$orphanRemoval: true

$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]

$limitedCapacity

If the sign-up list has limited capacity, we should show users a warning that this is the case.

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

$name

The name of the SignupList.

protected ActivityLocalisedText $name
Attributes
#[JoinColumn]
$name: 'name_id'
$referencedColumnName: 'id'
$nullable: false
#[OneToOne]
$targetEntity: \Activity\Model\ActivityLocalisedText::class
$cascade: ['persist']
$orphanRemoval: true

$onlyGEWIS

Determines if people outside of GEWIS can sign up.

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

$openDate

The date and time the SignupList is open for signups.

protected DateTime $openDate
Attributes
#[Column]
$type: 'datetime'

$presenceTaken

Determines if presence was taken for this SignupList

protected bool $presenceTaken = false
Attributes
#[Column]
$type: 'boolean'

$signUps

All the people who signed up for this SignupList.

protected Collection<string|int, Signup> $signUps
Attributes
#[OneToMany]
$mappedBy: 'signupList'
$targetEntity: \Activity\Model\Signup::class
$orphanRemoval: true
#[OrderBy]
$value: ['id' => 'ASC']

Methods

getCloseDate()

Returns the closing DateTime of this SignupList.

public getCloseDate() : DateTime
Return values
DateTime

getDisplaySubscribedNumber()

Returns true if this SignupList shows the number of members who signed up when the user is not logged in.

public getDisplaySubscribedNumber() : bool
Return values
bool

getId()

Get the identifier of the object.

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

getLimitedCapacity()

Returns true if this SignupList has a limited capacity.

public getLimitedCapacity() : bool
Return values
bool

getOnlyGEWIS()

Returns true if this SignupList is only available to members of GEWIS.

public getOnlyGEWIS() : bool
Return values
bool

getOpenDate()

Returns the opening DateTime of this SignupList.

public getOpenDate() : DateTime
Return values
DateTime

getResourceCreator()

Get the creator of this resource.

public getResourceCreator() : Member
Return values
Member

getResourceId()

Returns the string identifier of the Resource.

public getResourceId() : string
Return values
string

getResourceOrgan()

Get the organ of this resource.

public getResourceOrgan() : Organ|null
Return values
Organ|null

getSignUps()

public getSignUps() : Collection<string|int, Signup>
Return values
Collection<string|int, Signup>

isOpen()

Whether the sign-up list period is now.

public isOpen() : bool

NOTE: this does not indicate that one is able to sign up, that depends on other factors such as approval status of the actual activity.

Return values
bool

isPresenceTaken()

Gets presenceTaken for this SignupList

public isPresenceTaken() : bool
Return values
bool

setCloseDate()

Sets the closing DateTime of this SignupList.

public setCloseDate(DateTime $closeDate) : void
Parameters
$closeDate : DateTime

setDisplaySubscribedNumber()

Sets whether or not this SignupList should show the number of members who signed up when the user is not logged in.

public setDisplaySubscribedNumber(bool $displaySubscribedNumber) : void
Parameters
$displaySubscribedNumber : bool

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

setLimitedCapacity()

Sets whether or not this SignupList has limited capacity.

public setLimitedCapacity(bool $limitedCapacity) : void
Parameters
$limitedCapacity : bool

setOnlyGEWIS()

Sets whether or not this SignupList is available to members of GEWIS.

public setOnlyGEWIS(bool $onlyGEWIS) : void
Parameters
$onlyGEWIS : bool

setOpenDate()

Sets the opening DateTime of this SignupList.

public setOpenDate(DateTime $openDate) : void
Parameters
$openDate : DateTime

setPresenceTaken()

Sets presenceTaken for this SignupList

public setPresenceTaken(bool $presenceTaken) : void
Parameters
$presenceTaken : bool

setSignUps()

public setSignUps(Collection<string|int, Signup> $signUps) : void
Parameters
$signUps : Collection<string|int, Signup>

toArray()

Returns an associative array representation of this object.

public toArray() : SignupListArrayType
Return values
SignupListArrayType

toGdprArray()

public toGdprArray() : SignupListGdprArrayType
Return values
SignupListGdprArrayType 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results