Documentation

Signup
in package

Table of Contents

Properties

$aclService  : AclService
$entityManager  : EntityManager
$signupFieldValueMapper  : SignupFieldValue
$signupMapper  : Signup
$signupOptionMapper  : SignupOption
$translator  : Translator

Methods

__construct()  : mixed
adminSignUp()  : ExternalSignup
Sign an external user up for an activity, which the current user may admin.
deleteOldSignups()  : void
Delete all sign-ups for activities that are older than 5 years.
editSignUp()  : void
externalSignOff()  : void
externalSignUp()  : Signup
Sign an external user up for an activity, allowed by a guest.
getExternalAdminForm()  : Signup
getExternalForm()  : Signup
getForm()  : Signup
Return the form for signing up in the preferred language, if available.
getNumberOfSubscribedMembers()  : int
getSignedUpData()  : array<string|int, SignupOption|string|null>}>
Gets an array of the signed-up users and the associated data.
isAllowedToExternalSubscribe()  : bool
Is the (guest) user allowed to use the external signup.
isAllowedToInternalSubscribe()  : bool
isAllowedToSubscribe()  : bool
Is the currently logged-in user allowed to signup.
isAllowedToViewSubscriptions()  : bool
isInSubscriptionWindow()  : bool
isSignedUp()  : bool
Check if a member is signed up for an activity.
signOff()  : void
Undo an activity sign up.
signUp()  : UserSignup
Sign a User up for an activity with the specified field values.
createSignup()  : ExternalSignup|UserSignup
Creates the generic parts of a signup.
manualSignUp()  : ExternalSignup
Sign an external user up for an activity.
removeSignUp()  : void

Properties

$entityManager read-only

private EntityManager $entityManager

$translator read-only

private Translator $translator

Methods

adminSignUp()

Sign an external user up for an activity, which the current user may admin.

public adminSignUp(SignupList $signupList, string $fullName, string $email, array<string|int, mixed> $fieldResults) : ExternalSignup
Parameters
$signupList : SignupList
$fullName : string
$email : string
$fieldResults : array<string|int, mixed>
Tags
throws
NotAllowedException
throws
ORMException
phpcsSuppress

SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingTraversableTypeHintSpecification

Return values
ExternalSignup

deleteOldSignups()

Delete all sign-ups for activities that are older than 5 years.

public deleteOldSignups() : void

We can automatically DELETE all sign-ups at once instead of retrieving them and iterating over them before using $this->removeSignup() to remove them.

editSignUp()

public editSignUp(UserSignup $signup, array<string|int, mixed> $fieldResults) : void
Parameters
$signup : UserSignup
$fieldResults : array<string|int, mixed>
Tags
phpcsSuppress

SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingTraversableTypeHintSpecification

externalSignUp()

Sign an external user up for an activity, allowed by a guest.

public externalSignUp(SignupList $signupList, string $fullName, string $email, array<string|int, mixed> $fieldResults) : Signup
Parameters
$signupList : SignupList
$fullName : string
$email : string
$fieldResults : array<string|int, mixed>
Tags
throws
NotAllowedException
throws
ORMException
phpcsSuppress

SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingTraversableTypeHintSpecification

Return values
Signup

getNumberOfSubscribedMembers()

public getNumberOfSubscribedMembers(SignupList $signupList) : int
Parameters
$signupList : SignupList
Return values
int

getSignedUpData()

Gets an array of the signed-up users and the associated data.

public getSignedUpData(SignupList $signupList) : array<string|int, SignupOption|string|null>}>
Parameters
$signupList : SignupList
Return values
array<string|int, SignupOption|string|null>}>

isAllowedToExternalSubscribe()

Is the (guest) user allowed to use the external signup.

public isAllowedToExternalSubscribe() : bool
Return values
bool

isAllowedToInternalSubscribe()

public isAllowedToInternalSubscribe() : bool
Return values
bool

isAllowedToSubscribe()

Is the currently logged-in user allowed to signup.

public isAllowedToSubscribe() : bool
Return values
bool

isAllowedToViewSubscriptions()

public isAllowedToViewSubscriptions() : bool
Return values
bool

isInSubscriptionWindow()

public static isInSubscriptionWindow(DateTime $openDate, DateTime $closeDate) : bool
Parameters
$openDate : DateTime
$closeDate : DateTime
Return values
bool

isSignedUp()

Check if a member is signed up for an activity.

public isSignedUp(SignupList $signupList, User $user) : bool
Parameters
$signupList : SignupList
$user : User
Return values
bool

signUp()

Sign a User up for an activity with the specified field values.

public signUp(SignupList $signupList, array<string|int, mixed> $fieldResults) : UserSignup
Parameters
$signupList : SignupList
$fieldResults : array<string|int, mixed>
Tags
phpcsSuppress

SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingTraversableTypeHintSpecification

Return values
UserSignup

createSignup()

Creates the generic parts of a signup.

protected createSignup(ExternalSignup|UserSignup $signup, SignupList $signupList, array<string|int, mixed> $fieldResults) : ExternalSignup|UserSignup
Parameters
$signup : ExternalSignup|UserSignup
$signupList : SignupList
$fieldResults : array<string|int, mixed>
Tags
template

T of ExternalSignupModel|UserSignupModel

psalm-param

T $signup

psalm-return

T

throws
ORMException
throws
OptimisticLockException
phpcsSuppress

SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingTraversableTypeHintSpecification

Return values
ExternalSignup|UserSignup

manualSignUp()

Sign an external user up for an activity.

protected manualSignUp(SignupList $signupList, string $fullName, string $email, array<string|int, mixed> $fieldResults) : ExternalSignup
Parameters
$signupList : SignupList
$fullName : string
$email : string
$fieldResults : array<string|int, mixed>
Tags
throws
ORMException
phpcsSuppress

SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingTraversableTypeHintSpecification

Return values
ExternalSignup

removeSignUp()

protected removeSignUp(Signup $signup) : void
Parameters
$signup : Signup
Tags
throws
ORMException
throws
OptimisticLockException

        
On this page

Search results