[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/actions/ -> FormAction.php (summary)

Base classes for actions done on pages. 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: 123 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 5 functions

  preText()
  postText()
  alterForm()
  getForm()
  show()

Functions
Functions that are not part of a class:

preText()   X-Ref
Add pre- or post-text to the form

return: string HTML which will be sent to $form->addPreText()

postText()   X-Ref

return: string

alterForm( HTMLForm $form )   X-Ref
Play with the HTMLForm if you need to more substantially

param: HTMLForm $form

getForm()   X-Ref
Get the HTMLForm to control behavior

return: HTMLForm|null

show()   X-Ref
The basic pattern for actions is to display some sort of HTMLForm UI, maybe with
some stuff underneath (history etc); to do some processing on submission of that
form (delete, protect, etc) and to do something exciting on 'success', be that
display something new or redirect to somewhere.  Some actions have more exotic
behavior, but that's what subclassing is for :D




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