[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/specials/ -> SpecialEmailuser.php (summary)

Implements Special:Emailuser This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

File Size: 384 lines (11 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

SpecialEmailUser:: (10 methods):
  __construct()
  getDescription()
  getFormFields()
  execute()
  getTarget()
  getPermissionsError()
  userForm()
  uiSubmit()
  submit()
  getGroupName()


Class: SpecialEmailUser  - X-Ref

A special page that allows users to send e-mails to other users

__construct()   X-Ref


getDescription()   X-Ref
No description

getFormFields()   X-Ref
No description

execute( $par )   X-Ref
No description

getTarget( $target )   X-Ref
Validate target User

param: string $target Target user name
return: User User object on success or a string on error

getPermissionsError( $user, $editToken, Config $config = null )   X-Ref
Check whether a user is allowed to send email

param: User $user
param: string $editToken Edit token
param: Config $config optional for backwards compatibility
return: string|null Null on success or string on error

userForm( $name )   X-Ref
Form to ask for target user name.

param: string $name User name submitted.
return: string Form asking for user name.

uiSubmit( array $data, HTMLForm $form )   X-Ref
Submit callback for an HTMLForm object, will simply call submit().

param: array $data
param: HTMLForm $form
return: Status|string|bool

submit( array $data, IContextSource $context )   X-Ref
Really send a mail. Permissions should have been checked using
getPermissionsError(). It is probably also a good
idea to check the edit token and ping limiter in advance.

param: array $data
param: IContextSource $context
return: Status|string|bool Status object, or potentially a String on error

getGroupName()   X-Ref
No description



Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1