SPermission Class Reference
[Event Handling]

Check permissions for SWAT events. More...

Inheritance diagram for SPermission:

[legend]

List of all members.

Public Member Functions
	checkPermission ($e)
	Check whether an event can be performed.
	doc ()
	Return a documentation string about this class.

---

Detailed Description

Check permissions for SWAT events.

Do permission checks to determine what user can perform what action. Extend this class in your project to do project-specific permission checks.

Author:

Jonathan Stuart-Moore <jwsm@shodor.org> (2007)

Date:

11/28/07

6/17/07

---

Member Function Documentation

SPermission::checkPermission

(

$

e

)

Check whether an event can be performed.

Check whether an event can be performed, based on the source user (the user trying to perform the event), the action (what the event is trying to do), and the target (the object being acted upon by the event).

In your project, extend this function in your extended Permission module. First call parent::checkPermission($e) to make sure that the event is not null. Then run your own checks based on the permissions defined in your local event handler object.

Parameters:

$e

[SEvent]: The event to check

Returns:

[bool]: True if the event can be performed, false if not.

---

The documentation for this class was generated from the following file:

• SWAT/event/SPermission.php5