SpecialSemanticWatchlist Class Reference

Inheritance diagram for SpecialSemanticWatchlist:

Collaboration diagram for SpecialSemanticWatchlist:

Public Member Functions
	__construct ()
	getDescription ()
	setHeaders ()
	execute ( $subPage)

Protected Member Functions
	getAndDisplaySets ( $subPage)
	registerUserView (User $user)
	getPagingControlHTML ( $limit, $currentContinue, $subPage, $newContinue, $offset)
	displayWatchlist (array $sets)
	getChangeSetsData ( $limit, $continue)
	getChangeSetHTML (SWLChangeSet $changeSet)
	getPropertyHTML (SMWDIProperty $property, array $changes)
	userHasWatchlistGroups (User $user)

Protected Attributes
	$lastViewed

Constructor & Destructor Documentation

__construct()

SpecialSemanticWatchlist::__construct

(

)

Constructor.

Since

0.1

Member Function Documentation

displayWatchlist()

SpecialSemanticWatchlist::displayWatchlist ( array  $sets )

protected

Displays the watchlist.

Since

0.1

Parameters

array

$sets

Array of SWLChangeSet

execute()

SpecialSemanticWatchlist::execute

(

$subPage

)

Main method.

Since

0.1

Parameters

string

$subPage

getAndDisplaySets()

SpecialSemanticWatchlist::getAndDisplaySets (   $subPage )

protected

Obtains the change sets and displays them by calling displayWatchlist. Also takes care of pagination and displaying appropriate message when there are no results.

Since

0.1

Parameters

string

$subPage

getChangeSetHTML()

SpecialSemanticWatchlist::getChangeSetHTML ( SWLChangeSet  $changeSet )

protected

Gets the HTML for a single change set (edit).

Since

0.1

Parameters

SWLChangeSet

$changeSet

Returns

string

getChangeSetsData()

SpecialSemanticWatchlist::getChangeSetsData (   $limit,   $continue  )

protected

Returns the response of an internal request to the API semanticwatchlist query module.

Since

0.1

Parameters

integer	$limit
string	$continue

Returns

array

getDescription()

SpecialSemanticWatchlist::getDescription

(

)

See also

SpecialPage::getDescription

Since

0.1

getPagingControlHTML()

SpecialSemanticWatchlist::getPagingControlHTML (   $limit,   $currentContinue,   $subPage,   $newContinue,   $offset  )

protected

Since

0.1

Returns

string

getPropertyHTML()

SpecialSemanticWatchlist::getPropertyHTML ( SMWDIProperty  $property, array  $changes  )

protected

Returns the HTML for the changes to a single propety.

Parameters

SMWDIProperty	$property
array	$changes	Array of SWLPropertyChange

Returns

string

registerUserView()

SpecialSemanticWatchlist::registerUserView ( User  $user )

protected

Register the user viewed the watchlist, so we know that following chnages should result into notification emails is desired.

Since

0.1

Parameters

User

$user

setHeaders()

SpecialSemanticWatchlist::setHeaders

(

)

Sets headers - this should be called from the execute() method of all derived classes!

Since

0.1

userHasWatchlistGroups()

SpecialSemanticWatchlist::userHasWatchlistGroups ( User  $user )

protected

Rteurns if the specified user has any watchlist groups in his notification list.

Since

0.1

Parameters

User

$user

Returns

boolean

---

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

• SpecialSemanticWatchlist.php