IPBlockForm Class Reference
Inheritance diagram for IPBlockForm:
Collaboration diagram for IPBlockForm:
Additional Inherited Members | |
 Public Member Functions inherited from SpecialBlock | |
| __construct () | |
| onSubmit (array $data) | |
| Process the form on POST submission. More... | |
| onSuccess () | |
| Do something exciting on successful processing of the form, most likely to show a confirmation message. More... | |
| Public Member Functions inherited from FormSpecialPage | |
| execute ( $par) | |
| Basic SpecialPage workflow: get a form, send it to the user; get some data back,. More... | |
| requiresUnblock () | |
| Whether this action cannot be executed by a blocked user. More... | |
| requiresWrite () | |
| Whether this action requires the wiki not to be locked. More... | |
| Public Member Functions inherited from SpecialPage | |
| __construct ( $name='', $restriction='', $listed=true, $function=false, $file='default', $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... | |
| checkPermissions () | |
| Checks if userCanExecute, and if not throws a PermissionsError. More... | |
| checkReadOnly () | |
| If the wiki is currently in readonly mode, throws a ReadOnlyError. More... | |
| displayRestrictionError () | |
| Output an error message telling the user what access level they have to have. 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... | |
| getFile () | |
| Get the file which will be included by SpecialPage::execute() if your extension is still stuck in the past and hasn't overridden the execute() method. 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... | |
| getLang () | |
| Shortcut to get user's language. More... | |
| getLanguage () | |
| Shortcut to get user's language. More... | |
| getLocalName () | |
| Get the localised name of the special page. 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... | |
| getTitle ( $subpage=false) | |
| Get a self-referential title object. 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}}. More... | |
| isListed () | |
| Whether this special page is listed in Special:SpecialPages. 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... | |
| msg () | |
| Wrapper around wfMessage that sets the current context. More... | |
| 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... | |
| requireLogin ( $reasonMsg=null, $titleMsg=null) | |
| If the user is not logged in, throws UserNotLoggedIn error. More... | |
| run ( $subPage) | |
| Entry point. More... | |
| setContext ( $context) | |
| Sets the context this SpecialPage is executed in. More... | |
| setHeaders () | |
| Sets headers - this should be called from the execute() method of all derived classes! More... | |
| setListed ( $listed) | |
| Set whether this page is listed in Special:Specialpages, at run-time. More... | |
| 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 inherited from SpecialBlock | |
| static | canBlockEmail ( $user) |
| Can we do an email block? More... | |
| static | checkUnblockSelf ( $user, User $performer) |
| bug 15810: blocked admins should not be able to block/unblock others, and probably shouldn't be able to unblock themselves either. More... | |
| static | getSuggestedDurations ( $lang=null) |
| Get an array of suggested block durations from MediaWiki:Ipboptions. More... | |
| static | getTargetAndType ( $par, WebRequest $request=null) |
| Determine the target of the block, and the type of target TODO: should be in Block.php? More... | |
| static | parseExpiryInput ( $expiry) |
| Convert a submitted expiry time, which may be relative ("2 weeks", etc) or absolute ("24 May 2034", etc), into an absolute timestamp we can put into the database. More... | |
| static | processForm (array $data, IContextSource $context) |
| Given the form data, actually implement a block. More... | |
| static | processUIForm (array $data, HTMLForm $form) |
| Submit callback for an HTMLForm object, will simply pass. More... | |
| static | validateTarget ( $value, User $user) |
| Validate a block target. More... | |
| static | validateTargetField ( $value, $alldata, $form) |
| HTMLForm field validation-callback for Target field. 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. More... | |
| Protected Member Functions inherited from SpecialBlock | |
| alterForm (HTMLForm $form) | |
| Customizes the HTMLForm a bit. More... | |
| checkExecutePermissions (User $user) | |
| Checks that the user can unblock themselves if they are trying to do so. More... | |
| getFormFields () | |
| Get the HTMLForm descriptor array for the block form. 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... | |
| maybeAlterFormDefaults (&$fields) | |
| If the user has already been blocked with similar settings, load that block and change the defaults for the form fields to match the existing settings. More... | |
| postText () | |
| Add footer elements to the form. More... | |
| preText () | |
| Add header elements like block log entries, etc. More... | |
| setParameter ( $par) | |
| Handle some magic here. More... | |
| Protected Member Functions inherited from FormSpecialPage | |
| getForm () | |
| Get the HTMLForm to control behavior. More... | |
| getMessagePrefix () | |
| Get message prefix for HTMLForm. 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... | |
| getRobotPolicy () | |
| Return the robot policy. More... | |
| Static Protected Member Functions inherited from SpecialBlock | |
| static | blockLogFlags (array $data, $type) |
| Return a comma-delimited list of "flags" to be passed to the log reader for this block, to provide more information in the logs. More... | |
| static | getTargetUserTitle ( $target) |
| Get a user page target for things like logs. More... | |
| Protected Attributes inherited from SpecialBlock | |
| Bool | $alreadyBlocked |
| Array | $preErrors = array() |
| User String | $previousTarget |
| the previous block target * More... | |
| Bool | $requestedHideUser |
| whether the previous submission of the form asked for HideUser * More... | |
| $target | |
| Integer | $type |
| Block::TYPE_ constant *. More... | |
| Protected Attributes inherited from FormSpecialPage | |
| string | $par = null |
| The sub-page of the special page. More... | |
| Protected Attributes inherited from SpecialPage | |
| IContextSource | $mContext |
| Current request context. More... | |
| $mIncludable | |
| $mIncluding | |
| $mName | |
Detailed Description
Definition at line 969 of file SpecialBlock.php.
The documentation for this class was generated from the following file:
- includes/specials/SpecialBlock.php
