Documentation

Member

in package

• gewisweb

Member model.

Tags

psalm-type

MemberGdprArrayType = array{ lidnr: int, email: ?string, fullName: string, lastName: string, middleName: string, initials: string, firstName: string, birth: string, generation: int, type: string, paid: int, changedOn: string, membershipEndsOn: ?string, expiration: string, supremum: ?string, hidden: bool, deleted: bool, }

Table of Contents

Properties

$addresses  : Collection<string|int, Address>

Addresses of this member.

$authenticationKey  : string|null

$birth  : DateTime

Member birth date.

$boardInstallations  : Collection<string|int, BoardMember>

Board memberships.

$changedOn  : DateTime

Last changed date of membership.

$deleted  : bool

Determines if a member is deleted. A deleted member is a member whose basic info needs to be retained to ensure that all decisions that mention this member can be kept (i.e., administrative purposes). This value is only set when deleting a member and cannot be altered via the interface.

$email  : string|null

Member's email address.

$expiration  : DateTime

The date on which the membership of the member is set to expire and will therefore have to be renewed, which happens either automatically or has to be done manually, as set forth in the articles of association and internal regulations.

$firstName  : string

First name.

$generation  : int

Generation.

$hidden  : bool

Stores whether a member should be 'hidden'.

$initials  : string

Initials.

$installations  : Collection<string|int, Installation>

Installations of this member.

$keyGrantings  : Collection<string|int, Keyholder>

Keyholdership.

$lastName  : string

Member's last name.

$lidnr  : int

The user.

$lists  : Collection<string|int, MailingList>

Memberships of mailing lists.

$membershipEndsOn  : DateTime|null

Date when the real membership ("ordinary" or "external") of the member will have ended, in other words, from this date onwards they are "graduate". If `null`, the expiration is rolling and will be silently renewed if the member still meets the requirements as set forth in the articles of association and internal regulations.

$middleName  : string

Middle name.

$organInstallations  : Collection<string|int, OrganMember>

Organ memberships.

$paid  : int

How much the member has paid for membership. 0 by default.

$supremum  : string|null

If the member receives a 'supremum'.

$tags  : Collection<string|int, Tag>

Member tags.

$type  : MembershipTypes

Member type.

Methods

__construct()  : mixed

addAddress()  : void

Add an address.

addAddresses()  : void

Add multiple addresses.

addList()  : void

Add a mailing list subscription.

addLists()  : void

Add multiple mailing lists.

clearAddresses()  : void

Clear all addresses.

clearLists()  : void

Clear the lists.

getAddresses()  : Collection<string|int, Address>

Get all addresses.

getAuthenticationKey()  : string|null

getBirth()  : DateTime

Get the birth date.

getBoardInstallations()  : Collection<string|int, BoardMember>

Get the board installations.

getChangedOn()  : DateTime

Get the date of the last membership change.

getCurrentBoardInstallation()  : BoardMember|null

Get the current board the member is part of.

getCurrentOrganInstallations()  : Collection<string|int, OrganMember>

Get the organ installations of organs that the member is currently part of.

getDeleted()  : bool

Get if the member is deleted.

getEmail()  : string|null

Get the member's email address.

getExpiration()  : DateTime

Get the expiration date.

getFirstName()  : string

Get the member's first name.

getFullName()  : string

Assemble the member's full name.

getGeneration()  : int

Get the generation.

getHidden()  : bool

Get if the member is hidden.

getInitials()  : string

Get the member's initials.

getInstallations()  : Collection<string|int, Installation>

Get the installations.

getKeyGrantings()  : Collection<string|int, Keyholder>

Get keyholderships.

getLastName()  : string

Get the member's last name.

getLidnr()  : int

Get the membership number.

getLists()  : Collection<string|int, MailingList>

Get mailing list subscriptions.

getMembershipEndsOn()  : DateTime|null

Get the date on which the membership of the member will have ended (i.e., they have become "graduate").

getMiddleName()  : string

Get the member's middle name.

getOrganInstallations()  : Collection<string|int, OrganMember>

Get the organ installations.

getPaid()  : int

Get how much has been paid.

getSupremum()  : string|null

Get if the member wants a supremum.

getTags()  : Collection<string|int, Tag>

Get the tags.

getType()  : MembershipTypes

Get the member type.

is18Plus()  : bool

isActive()  : bool

Returns whether the member is currently part of any organs.

isBoardMember()  : bool

Returns true the member is currently installed as a board member and false otherwise.

isExpired()  : bool

isKeyholder()  : bool

Returns true if the member is currently granted a key code (that is not withdrawn prematurely).

setAuthenticationKey()  : void

setBirth()  : void

Set the birthdate.

setChangedOn()  : void

Set the date of the last membership change.

setDeleted()  : void

Set if the member is deleted.

setEmail()  : void

Set the member's email address.

setExpiration()  : void

Set the expiration date.

setFirstName()  : void

Set the member's first name.

setGeneration()  : void

Set the generation.

setHidden()  : void

Set if the member is hidden.

setInitials()  : void

Set the member's initials.

setLastName()  : void

Set the member's last name.

setLidnr()  : void

Set the lidnr.

setMembershipEndsOn()  : void

Set the date on which the membership of the member will have ended (i.e., they have become "graduate").

setMiddleName()  : void

Set the member's middle name.

setPaid()  : void

Set how much has been paid.

setSupremum()  : void

Set if the member wants a supremum.

setType()  : void

Set the member type.

toGdprArray()  : MemberGdprArrayType

Convert most relevant items to array.

isCurrentBoard()  : bool

Check if this is a current board member.