Class UserEvent in namespace com\setasign\SetaSite\Events in SetaSite API Reference

Index

\com\setasign\SetaSite
1. Events
  1. PageEvent
  2. UserEvent

com\setasign\SetaSite\Events

UserEvent Class Event

File: /SetaSite/src/Events/UserEvent.php

Class hierarchy

com\setasign\SetaFramework\EventManager\Events\Event
- UserEvent

Implements

\com\setasign\SetaFramework\EventManager\Events\EventInterface

Summary

Properties

$cancelable
$canceled
$eventManager
$extraParams
$name
$user

Properties

$cancelable

protected bool \com\setasign\SetaFramework\EventManager\Events\Event::$cancelable

$canceled

protected bool \com\setasign\SetaFramework\EventManager\Events\Event::$canceled = false

$eventManager

protected \com\setasign\SetaFramework\EventManager\EventManager \com\setasign\SetaFramework\EventManager\Events\Event::$eventManager

$extraParams

protected array \com\setasign\SetaFramework\EventManager\Events\Event::$extraParams

$name

protected string \com\setasign\SetaFramework\EventManager\Events\Event::$name

$user

protected \com\setasign\SetaSite\User\User UserEvent::$user

Methods

__construct()

public UserEvent::__construct (

string $name,
\com\setasign\SetaSite\User\User $user,
bool $cancelable = false,
array $extraParams = array ( )

)

Parameters

$name : string
$user : \com\setasign\SetaSite\User\User
$cancelable : bool
$extraParams : array

getExtraParams()

public \com\setasign\SetaFramework\EventManager\Events\Event::getExtraParams (

void

): array

getName()

public \com\setasign\SetaFramework\EventManager\Events\Event::getName (

void

): string

getUser()

public UserEvent::getUser (

void

): \com\setasign\SetaSite\User\User

isCanceled()

public \com\setasign\SetaFramework\EventManager\Events\Event::isCanceled (

void

): bool

setCanceled()

public \com\setasign\SetaFramework\EventManager\Events\Event::setCanceled (

void

): self

Cancels the event. The other listeners will be called.