class DeactivateUser extends UserInfo implements SubjectInterface (View source)

Properties

protected $ui from  UserInfo
protected User $applier from  UserInfo
protected DateTime $created

The datetime this event was created

protected User|null $user

The user that is running the deactivate operation

protected User|null $actor

The user that is running the deactivate operation

Methods

__construct(User $user, User $actorEntity = null, DateTime $dateCreated = null)

DeactivateUser constructor.

getApplier()

No description

from  UserInfo
setApplier(User $applier)

No description

from  UserInfo
getUserInfoObject()

Pass through calls for the user info object to the associated user info object

getNotificationDate()

Get the date of this notification

User[]
getUsersToExcludeFromNotification()

Get the users that should be excluded from notifications Expected return value would be users involved in the creation of the notification, they may not need to be notified.

getUserEntity()

Get the user that is being deactivated

User|null
getActorEntity()

Get the user that is running the deactivation

static DeactivateUser
create(User $userEntity, User $actorEntity = null, DateTime $dateCreated = null)

Factory method for creating new User event objects

Details

__construct(User $user, User $actorEntity = null, DateTime $dateCreated = null)

DeactivateUser constructor.

Parameters

User $user
User $actorEntity
DateTime $dateCreated

User getApplier()

No description

Return Value

User

setApplier(User $applier)

No description

Parameters

User $applier

getUserInfoObject()

Pass through calls for the user info object to the associated user info object

DateTime getNotificationDate()

Get the date of this notification

Return Value

DateTime

User[] getUsersToExcludeFromNotification()

Get the users that should be excluded from notifications Expected return value would be users involved in the creation of the notification, they may not need to be notified.

Return Value

User[]

User getUserEntity()

Get the user that is being deactivated

Return Value

User

User|null getActorEntity()

Get the user that is running the deactivation

Return Value

User|null

static DeactivateUser create(User $userEntity, User $actorEntity = null, DateTime $dateCreated = null)

Factory method for creating new User event objects

Parameters

User $userEntity

The user being deactivated

User $actorEntity

The user running the deactivate action

DateTime $dateCreated

Return Value

DeactivateUser