Documentation

MailingList
in package

Mailing List model.

Tags
psalm-type

MailingListGdprArrayType = array{ name: string, description_en: string, description_nl: string, }

Attributes
#[Entity]

Table of Contents

Properties

$defaultSub  : bool
If members should be subscribed by default.
$en_description  : string
English description of the mailing list.
$members  : Collection<string|int, Member>
Mailing list members.
$name  : string
Mailman-identifier / name.
$nl_description  : string
Dutch description of the mailing list.
$onForm  : bool
If the mailing list should be on the form.

Methods

__construct()  : mixed
addMember()  : void
Add a member.
getDefaultSub()  : bool
Get if it is a default list.
getDescription()  : string
Get the description.
getEnDescription()  : string
Get the english description.
getMembers()  : Collection<string|int, Member>
Get subscribed members.
getName()  : string
Get the name.
getNlDescription()  : string
Get the dutch description.
getOnForm()  : bool
Get if it should be on the form.
setDefaultSub()  : void
Set if it is a default list.
setDescription()  : void
Set the description.
setEnDescription()  : void
Set the english description.
setName()  : void
Set the name.
setNlDescription()  : void
Set the dutch description.
setOnForm()  : void
Set if it should be on the form.
toGdprArray()  : MailingListGdprArrayType

Properties

$defaultSub

If members should be subscribed by default.

protected bool $defaultSub

(when it is on the form, that means that the checkbox is checked by default)

Attributes
#[Column]
$type: 'boolean'

$en_description

English description of the mailing list.

protected string $en_description
Attributes
#[Column]
$type: 'text'

$members

Mailing list members.

protected Collection<string|int, Member> $members
Attributes
#[ManyToMany]
$targetEntity: \Decision\Model\Member::class
$mappedBy: 'lists'

$name

Mailman-identifier / name.

protected string $name
Attributes
#[Column]
$type: 'string'
#[Id]

$nl_description

Dutch description of the mailing list.

protected string $nl_description
Attributes
#[Column]
$type: 'text'

$onForm

If the mailing list should be on the form.

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

Methods

getDefaultSub()

Get if it is a default list.

public getDefaultSub() : bool
Return values
bool

getDescription()

Get the description.

public getDescription() : string
Return values
string

getEnDescription()

Get the english description.

public getEnDescription() : string
Return values
string

getMembers()

Get subscribed members.

public getMembers() : Collection<string|int, Member>
Return values
Collection<string|int, Member>

getName()

Get the name.

public getName() : string
Return values
string

getNlDescription()

Get the dutch description.

public getNlDescription() : string
Return values
string

getOnForm()

Get if it should be on the form.

public getOnForm() : bool
Return values
bool

setDefaultSub()

Set if it is a default list.

public setDefaultSub(bool $default) : void
Parameters
$default : bool

setDescription()

Set the description.

public setDescription(string $description) : void
Parameters
$description : string

setEnDescription()

Set the english description.

public setEnDescription(string $description) : void
Parameters
$description : string

setName()

Set the name.

public setName(string $name) : void
Parameters
$name : string

setNlDescription()

Set the dutch description.

public setNlDescription(string $description) : void
Parameters
$description : string

setOnForm()

Set if it should be on the form.

public setOnForm(bool $onForm) : void
Parameters
$onForm : bool

toGdprArray()

public toGdprArray() : MailingListGdprArrayType
Return values
MailingListGdprArrayType 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results