MediaWiki  master
SpecialEditWatchlist Class Reference

Provides the UI through which users can perform editing operations on their watchlist. More...

Inheritance diagram for SpecialEditWatchlist:
Collaboration diagram for SpecialEditWatchlist:

Public Member Functions

 __construct (WatchedItemStoreInterface $watchedItemStore=null, TitleParser $titleParser=null, GenderCache $genderCache=null, LinkBatchFactory $linkBatchFactory=null, NamespaceInfo $nsInfo=null, WikiPageFactory $wikiPageFactory=null)
 
 doesWrites ()
 Indicates whether this special page may perform database writes. More...
 
 execute ( $mode)
 Main execution point. More...
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept. More...
 
 submitClear ( $data)
 Handler for the clear form submission. More...
 
 submitNormal ( $data)
 
 submitRaw ( $data)
 
- Public Member Functions inherited from UnlistedSpecialPage
 __construct ( $name, $restriction='', $function=false, $file='default')
 Stable to call. More...
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages Stable to override. More...
 
- Public Member Functions inherited from SpecialPage
 __construct ( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false)
 Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called. More...
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators. More...
 
 checkPermissions ()
 Checks if userCanExecute, and if not throws a PermissionsError. More...
 
 checkReadOnly ()
 If the wiki is currently in readonly mode, throws a ReadOnlyError. More...
 
 getConfig ()
 Shortcut to get main config object. More...
 
 getContentLanguage ()
 Shortcut to get content language. More...
 
 getContext ()
 Gets the context this SpecialPage is executed in. More...
 
 getDescription ()
 Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages. More...
 
 getFinalGroupName ()
 Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side. More...
 
 getFullTitle ()
 Return the full title, including $par. More...
 
 getLanguage ()
 Shortcut to get user's language. More...
 
 getLinkRenderer ()
 
 getLocalName ()
 Get the localised name of the special page Stable to override. More...
 
 getName ()
 Get the name of this Special Page. More...
 
 getOutput ()
 Get the OutputPage being used for this instance. More...
 
 getPageTitle ( $subpage=false)
 Get a self-referential title object. More...
 
 getRequest ()
 Get the WebRequest being used for this instance. More...
 
 getRestriction ()
 Get the permission that a user must have to execute this page. More...
 
 getSkin ()
 Shortcut to get the skin being used for this instance. More...
 
 getUser ()
 Shortcut to get the User executing this instance. More...
 
 including ( $x=null)
 Whether the special page is being evaluated via transclusion. More...
 
 isCached ()
 Is this page cached? Expensive pages are cached or disabled in miser mode. More...
 
 isExpensive ()
 Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode. More...
 
 isIncludable ()
 Whether it's allowed to transclude the special page via {{Special:Foo/params}} Stable to override. More...
 
 isRestricted ()
 Can be overridden by subclasses with more complicated permissions schemes. More...
 
 listed ( $x=null)
 Get or set whether this special page is listed in Special:SpecialPages. More...
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included. More...
 
 msg ( $key,... $params)
 Wrapper around wfMessage that sets the current context. More...
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept. More...
 
 requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in, throws UserNotLoggedIn error. More...
 
 run ( $subPage)
 Entry point. More...
 
 setContentLanguage (Language $contentLanguage)
 Set content language. More...
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in. More...
 
 setHookContainer (HookContainer $hookContainer)
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setListed ( $listed)
 Set whether this page is listed in Special:Specialpages, at run-time. More...
 
 setSpecialPageFactory (SpecialPageFactory $specialPageFactory)
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction). More...
 

Static Public Member Functions

static buildTools ( $lang, LinkRenderer $linkRenderer=null)
 Build a set of links for convenient navigation between watchlist viewing and editing modes. More...
 
static getMode ( $request, $par)
 Determine whether we are editing the watchlist, and if so, what kind of editing operation. More...
 
- Static Public Member Functions inherited from SpecialPage
static getSafeTitleFor ( $name, $subpage=false)
 Get a localised Title object for a page name with a possibly unvalidated subpage. More...
 
static getTitleFor ( $name, $subpage=false, $fragment='')
 Get a localised Title object for a specified special page name If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below. More...
 
static getTitleValueFor ( $name, $subpage=false, $fragment='')
 Get a localised TitleValue object for a specified special page name. More...
 

Public Attributes

const EDIT_CLEAR = 1
 Editing modes. More...
 
const EDIT_NORMAL = 3
 
const EDIT_RAW = 2
 

Protected Member Functions

 executeViewEditWatchlist ()
 Executes an edit mode for the watchlist view, from which you can manage your watchlist. More...
 
 getClearForm ()
 Get a form for clearing the watchlist. More...
 
 getNormalForm ()
 Get the standard watchlist editing form. More...
 
 getRawForm ()
 Get a form for editing the watchlist in "raw" mode. More...
 
 getWatchlistInfo ()
 Get a list of titles on a user's watchlist, excluding talk pages, and return as a two-dimensional array with namespace and title. More...
 
 outputSubtitle ()
 Renders a subheader on the watchlist page. More...
 
- Protected Member Functions inherited from SpecialPage
 addFeedLinks ( $params)
 Adds RSS/atom links. More...
 
 afterExecute ( $subPage)
 Gets called after. More...
 
 beforeExecute ( $subPage)
 Gets called before. More...
 
 buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
 Generate (prev x| next x) (20|50|100...) type links for paging. More...
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process. More...
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have Stable to override. More...
 
 getAuthManager ()
 
 getCacheTTL ()
 Stable to override. More...
 
 getGroupName ()
 Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'. More...
 
 getHookContainer ()
 
 getHookRunner ()
 
 getLanguageConverter ()
 Shortcut to get language's converter. More...
 
 getLoginSecurityLevel ()
 Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g. More...
 
 getRobotPolicy ()
 Return the robot policy. More...
 
 getSpecialPageFactory ()
 
 outputHeader ( $summaryMessageKey='')
 Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e. More...
 
 prefixSearchString ( $search, $limit, $offset, SearchEngineFactory $searchEngineFactory=null)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 setAuthManager (AuthManager $authManager)
 Set the injected AuthManager from the special page constructor. More...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! Stable to override. More...
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Protected Attributes

 $successMessage
 
 $toc
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
bool $mIncludable
 Whether the special page can be included in an article. More...
 
bool $mIncluding
 Whether or not this special page is being included from an article. More...
 
string $mName
 The canonical name of this special page Also used for the default. More...
 
string $mRestriction
 Minimum user level required to access this page, or "" for anyone. More...
 

Private Member Functions

 buildRemoveLine ( $title, string $expiryDaysText='')
 Build the label for a checkbox, with a link to the title, and various additional bits. More...
 
 checkTitle ( $title, $namespace, $dbKey)
 Validates watchlist entry. More...
 
 cleanupWatchlist ()
 Attempts to clean up broken items. More...
 
 clearUserWatchedItems (string $messageFor)
 Makes a decision about using the JobQueue or not for clearing a users watchlist. More...
 
 clearUserWatchedItemsNow (string $messageFor)
 You should call clearUserWatchedItems() instead to decide if this should use the JobQueue. More...
 
 clearUserWatchedItemsUsingJobQueue ()
 You should call clearUserWatchedItems() instead to decide if this should use the JobQueue. More...
 
 extractTitles ( $list)
 Extract a list of titles from a blob of text, returning (prefixed) strings; unwatchable titles are ignored. More...
 
 getExpandedTargets (array $targets)
 
 getWatchlist ()
 Prepare a list of titles on a user's watchlist (excluding talk pages) and return an array of (prefixed) strings. More...
 
 runWatchUnwatchCompleteHook ( $action, $targets)
 
 showTitles ( $titles, &$output)
 Print out a list of linked titles. More...
 
 unwatchTitles (array $targets)
 Remove a list of titles from a user's watchlist. More...
 
 watchTitles (array $targets)
 Add a list of targets to a user's watchlist. More...
 

Private Attributes

 $badItems = []
 
GenderCache $genderCache
 
bool $isWatchlistExpiryEnabled
 Watchlist Expiry flag. More...
 
LinkBatchFactory $linkBatchFactory
 
NamespaceInfo $nsInfo
 
TitleParser $titleParser
 
WatchedItemStoreInterface $watchedItemStore
 
WikiPageFactory $wikiPageFactory
 

Additional Inherited Members

- Static Protected Member Functions inherited from SpecialPage
static prefixSearchArray ( $search, $limit, array $subpages, $offset)
 Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query). More...
 

Detailed Description

Provides the UI through which users can perform editing operations on their watchlist.

Author
Rob Church robch.nosp@m.ur@g.nosp@m.mail..nosp@m.com

Definition at line 43 of file SpecialEditWatchlist.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialEditWatchlist::__construct ( WatchedItemStoreInterface  $watchedItemStore = null,
TitleParser  $titleParser = null,
GenderCache  $genderCache = null,
LinkBatchFactory  $linkBatchFactory = null,
NamespaceInfo  $nsInfo = null,
WikiPageFactory  $wikiPageFactory = null 
)
Parameters
WatchedItemStoreInterface | null$watchedItemStore
TitleParser | null$titleParser
GenderCache | null$genderCache
LinkBatchFactory | null$linkBatchFactory
NamespaceInfo | null$nsInfo
WikiPageFactory | null$wikiPageFactory

Definition at line 87 of file SpecialEditWatchlist.php.

References $genderCache, $linkBatchFactory, $nsInfo, $titleParser, $watchedItemStore, $wikiPageFactory, and SpecialPage\getConfig().

Member Function Documentation

◆ buildRemoveLine()

SpecialEditWatchlist::buildRemoveLine (   $title,
string  $expiryDaysText = '' 
)
private

Build the label for a checkbox, with a link to the title, and various additional bits.

Parameters
Title$title
string$expiryDaysTextmessage shows the number of days a title has remaining in a user's watchlist. If this param is not empty then include a message that states the time remaining in a watchlist.
Returns
string

Definition at line 697 of file SpecialEditWatchlist.php.

References SpecialPage\$linkRenderer, $title, Html\element(), SpecialPage\getHookRunner(), SpecialPage\getLanguage(), SpecialPage\getLinkRenderer(), SpecialPage\getTitleFor(), MediaWiki\Linker\LinkRenderer\makeKnownLink(), MediaWiki\Linker\LinkRenderer\makeLink(), SpecialPage\msg(), and NS_USER.

Referenced by getNormalForm().

◆ buildTools()

static SpecialEditWatchlist::buildTools (   $lang,
LinkRenderer  $linkRenderer = null 
)
static

Build a set of links for convenient navigation between watchlist viewing and editing modes.

Parameters
Language$lang
LinkRenderer | null$linkRenderer
Returns
string

Definition at line 826 of file SpecialEditWatchlist.php.

References $lang, SpecialPage\$linkRenderer, $wgLang, SpecialPage\getTitleFor(), MediaWiki\Linker\LinkRenderer\makeKnownLink(), Html\rawElement(), and wfMessage().

Referenced by SpecialWatchlist\doHeader().

◆ checkTitle()

SpecialEditWatchlist::checkTitle (   $title,
  $namespace,
  $dbKey 
)
private

Validates watchlist entry.

Parameters
Title$title
int$namespace
string$dbKey
Returns
bool Whether this item is valid

Definition at line 468 of file SpecialEditWatchlist.php.

References $title.

Referenced by getNormalForm(), and getWatchlist().

◆ cleanupWatchlist()

SpecialEditWatchlist::cleanupWatchlist ( )
private

Attempts to clean up broken items.

Definition at line 490 of file SpecialEditWatchlist.php.

References $badItems, $title, DeferredUpdates\addCallableUpdate(), SpecialPage\getUser(), Title\makeTitle(), and wfDebug().

Referenced by getNormalForm(), and getWatchlist().

◆ clearUserWatchedItems()

SpecialEditWatchlist::clearUserWatchedItems ( string  $messageFor)
private

Makes a decision about using the JobQueue or not for clearing a users watchlist.

Also displays the appropriate messages to the user based on that decision.

Parameters
string$messageFor'raw' or 'clear'. Only used when JobQueue is not used.

Definition at line 297 of file SpecialEditWatchlist.php.

References clearUserWatchedItemsNow(), and clearUserWatchedItemsUsingJobQueue().

Referenced by submitClear(), and submitRaw().

◆ clearUserWatchedItemsNow()

SpecialEditWatchlist::clearUserWatchedItemsNow ( string  $messageFor)
private

You should call clearUserWatchedItems() instead to decide if this should use the JobQueue.

Parameters
string$messageFor'raw' or 'clear'

Definition at line 310 of file SpecialEditWatchlist.php.

References SpecialPage\getUser(), getWatchlist(), SpecialPage\msg(), and showTitles().

Referenced by clearUserWatchedItems().

◆ clearUserWatchedItemsUsingJobQueue()

SpecialEditWatchlist::clearUserWatchedItemsUsingJobQueue ( )
private

You should call clearUserWatchedItems() instead to decide if this should use the JobQueue.

Definition at line 327 of file SpecialEditWatchlist.php.

References SpecialPage\getUser(), and SpecialPage\msg().

Referenced by clearUserWatchedItems().

◆ doesWrites()

SpecialEditWatchlist::doesWrites ( )

Indicates whether this special page may perform database writes.

Stable to override

Returns
bool
Since
1.27

Reimplemented from SpecialPage.

Definition at line 107 of file SpecialEditWatchlist.php.

◆ execute()

◆ executeViewEditWatchlist()

SpecialEditWatchlist::executeViewEditWatchlist ( )
protected

Executes an edit mode for the watchlist view, from which you can manage your watchlist.

Definition at line 176 of file SpecialEditWatchlist.php.

References getNormalForm(), SpecialPage\getOutput(), SpecialPage\getTitleFor(), and SpecialPage\msg().

Referenced by execute().

◆ extractTitles()

SpecialEditWatchlist::extractTitles (   $list)
private

Extract a list of titles from a blob of text, returning (prefixed) strings; unwatchable titles are ignored.

Parameters
string$list
Returns
array

Definition at line 210 of file SpecialEditWatchlist.php.

References $title, and Title\newFromText().

Referenced by submitRaw().

◆ getClearForm()

SpecialEditWatchlist::getClearForm ( )
protected

Get a form for clearing the watchlist.

Returns
HTMLForm

Definition at line 777 of file SpecialEditWatchlist.php.

References SpecialPage\getContext(), SpecialPage\getPageTitle(), and SpecialPage\msg().

Referenced by execute().

◆ getExpandedTargets()

SpecialEditWatchlist::getExpandedTargets ( array  $targets)
private
Parameters
string[] | LinkTarget[]$targets
Returns
TitleValue[]

Definition at line 575 of file SpecialEditWatchlist.php.

References NS_MAIN.

Referenced by unwatchTitles(), and watchTitles().

◆ getMode()

static SpecialEditWatchlist::getMode (   $request,
  $par 
)
static

Determine whether we are editing the watchlist, and if so, what kind of editing operation.

Parameters
WebRequest$request
string | null$par
Returns
int|false

Definition at line 800 of file SpecialEditWatchlist.php.

References EDIT_CLEAR, EDIT_NORMAL, and EDIT_RAW.

Referenced by execute(), and SpecialWatchlist\execute().

◆ getNormalForm()

◆ getRawForm()

SpecialEditWatchlist::getRawForm ( )
protected

Get a form for editing the watchlist in "raw" mode.

Returns
HTMLForm

Definition at line 750 of file SpecialEditWatchlist.php.

References SpecialPage\getContext(), SpecialPage\getPageTitle(), getWatchlist(), and SpecialPage\msg().

Referenced by execute().

◆ getSubpagesForPrefixSearch()

SpecialEditWatchlist::getSubpagesForPrefixSearch ( )

Return an array of subpages that this special page will accept.

See also
also SpecialWatchlist::getSubpagesForPrefixSearch
Returns
string[] subpages

Reimplemented from SpecialPage.

Definition at line 194 of file SpecialEditWatchlist.php.

◆ getWatchlist()

SpecialEditWatchlist::getWatchlist ( )
private

Prepare a list of titles on a user's watchlist (excluding talk pages) and return an array of (prefixed) strings.

Returns
array

Definition at line 390 of file SpecialEditWatchlist.php.

References $title, checkTitle(), cleanupWatchlist(), SpecialPage\getRequest(), SpecialPage\getUser(), and Title\makeTitleSafe().

Referenced by clearUserWatchedItemsNow(), getRawForm(), and submitRaw().

◆ getWatchlistInfo()

SpecialEditWatchlist::getWatchlistInfo ( )
protected

Get a list of titles on a user's watchlist, excluding talk pages, and return as a two-dimensional array with namespace and title.

Returns
array

Definition at line 431 of file SpecialEditWatchlist.php.

References SpecialPage\getContext(), SpecialPage\getUser(), and WatchedItemStoreInterface\SORT_ASC.

Referenced by getNormalForm().

◆ outputSubtitle()

SpecialEditWatchlist::outputSubtitle ( )
protected

Renders a subheader on the watchlist page.

Definition at line 161 of file SpecialEditWatchlist.php.

References SpecialPage\getLanguage(), SpecialPage\getLinkRenderer(), SpecialPage\getName(), SpecialPage\getOutput(), SpecialPage\getUser(), and SpecialPage\msg().

Referenced by execute().

◆ runWatchUnwatchCompleteHook()

SpecialEditWatchlist::runWatchUnwatchCompleteHook (   $action,
  $targets 
)
private
Parameters
string$actionCan be "Watch" or "Unwatch"
string[] | LinkTarget[]$targets
Returns
bool
Exceptions
FatalError
MWException

Definition at line 555 of file SpecialEditWatchlist.php.

References $title, SpecialPage\getHookRunner(), SpecialPage\getUser(), Title\newFromLinkTarget(), and Title\newFromText().

Referenced by unwatchTitles(), and watchTitles().

◆ showTitles()

SpecialEditWatchlist::showTitles (   $titles,
$output 
)
private

Print out a list of linked titles.

$titles can be an array of strings or Title objects; the former is preferred, since Titles are very memory-heavy

Parameters
array$titlesArray of strings, or Title objects
string&$output

Definition at line 341 of file SpecialEditWatchlist.php.

References SpecialPage\$linkRenderer, $title, SpecialPage\getLinkRenderer(), MediaWiki\Linker\LinkRenderer\makeLink(), SpecialPage\msg(), and Title\newFromText().

Referenced by clearUserWatchedItemsNow(), submitNormal(), and submitRaw().

◆ submitClear()

SpecialEditWatchlist::submitClear (   $data)

Handler for the clear form submission.

Parameters
array$data
Returns
bool

Definition at line 286 of file SpecialEditWatchlist.php.

References clearUserWatchedItems().

◆ submitNormal()

SpecialEditWatchlist::submitNormal (   $data)

Definition at line 597 of file SpecialEditWatchlist.php.

References SpecialPage\msg(), showTitles(), and unwatchTitles().

◆ submitRaw()

SpecialEditWatchlist::submitRaw (   $data)

◆ unwatchTitles()

SpecialEditWatchlist::unwatchTitles ( array  $targets)
private

Remove a list of titles from a user's watchlist.

$titles can be an array of strings or Title objects; the former is preferred, since Titles are very memory-heavy

Parameters
string[] | LinkTarget[]$targets
Returns
bool
Exceptions
FatalError
MWException

Definition at line 541 of file SpecialEditWatchlist.php.

References getExpandedTargets(), SpecialPage\getUser(), and runWatchUnwatchCompleteHook().

Referenced by submitNormal(), and submitRaw().

◆ watchTitles()

SpecialEditWatchlist::watchTitles ( array  $targets)
private

Add a list of targets to a user's watchlist.

Parameters
string[] | LinkTarget[]$targets
Returns
bool
Exceptions
FatalError
MWException

Definition at line 523 of file SpecialEditWatchlist.php.

References getExpandedTargets(), SpecialPage\getUser(), and runWatchUnwatchCompleteHook().

Referenced by submitRaw().

Member Data Documentation

◆ $badItems

SpecialEditWatchlist::$badItems = []
private

Definition at line 56 of file SpecialEditWatchlist.php.

Referenced by cleanupWatchlist().

◆ $genderCache

GenderCache SpecialEditWatchlist::$genderCache
private

Definition at line 65 of file SpecialEditWatchlist.php.

Referenced by __construct().

◆ $isWatchlistExpiryEnabled

bool SpecialEditWatchlist::$isWatchlistExpiryEnabled
private

Watchlist Expiry flag.

Definition at line 77 of file SpecialEditWatchlist.php.

◆ $linkBatchFactory

LinkBatchFactory SpecialEditWatchlist::$linkBatchFactory
private

Definition at line 68 of file SpecialEditWatchlist.php.

Referenced by __construct().

◆ $nsInfo

NamespaceInfo SpecialEditWatchlist::$nsInfo
private

Definition at line 71 of file SpecialEditWatchlist.php.

Referenced by __construct().

◆ $successMessage

SpecialEditWatchlist::$successMessage
protected

Definition at line 52 of file SpecialEditWatchlist.php.

◆ $titleParser

TitleParser SpecialEditWatchlist::$titleParser
private

Definition at line 59 of file SpecialEditWatchlist.php.

Referenced by __construct().

◆ $toc

SpecialEditWatchlist::$toc
protected

Definition at line 54 of file SpecialEditWatchlist.php.

◆ $watchedItemStore

WatchedItemStoreInterface SpecialEditWatchlist::$watchedItemStore
private

Definition at line 62 of file SpecialEditWatchlist.php.

Referenced by __construct().

◆ $wikiPageFactory

WikiPageFactory SpecialEditWatchlist::$wikiPageFactory
private

Definition at line 74 of file SpecialEditWatchlist.php.

Referenced by __construct().

◆ EDIT_CLEAR

const SpecialEditWatchlist::EDIT_CLEAR = 1

Editing modes.

EDIT_CLEAR is no longer used; the "Clear" link scared people too much. Now it's passed on to the raw editor, from which it's very easy to clear.

Definition at line 48 of file SpecialEditWatchlist.php.

Referenced by execute(), SpecialWatchlist\execute(), and getMode().

◆ EDIT_NORMAL

const SpecialEditWatchlist::EDIT_NORMAL = 3

Definition at line 50 of file SpecialEditWatchlist.php.

Referenced by execute(), and getMode().

◆ EDIT_RAW

const SpecialEditWatchlist::EDIT_RAW = 2

Definition at line 49 of file SpecialEditWatchlist.php.

Referenced by execute(), SpecialWatchlist\execute(), and getMode().


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