FormAction.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Actions;
 
use MediaWiki\HTMLForm\HTMLForm;
use MediaWiki\Status\Status;
 
abstract class FormAction extends Action {
 
    protected function getFormFields() {
        // Default to an empty form with just a submit button
        return [];
    }
 
    protected function preText() {
        return '';
    }
 
    protected function postText() {
        return '';
    }
 
    protected function alterForm( HTMLForm $form ) {
    }
 
    protected function usesOOUI() {
        return false;
    }
 
    protected function getForm() {
        $this->fields = $this->getFormFields();
 
        // Give hooks a chance to alter the form, adding extra fields or text etc
        $this->getHookRunner()->onActionModifyFormFields(
            $this->getName(),
            $this->fields,
            $this->getArticle()
        );
 
        if ( $this->usesOOUI() ) {
            $form = HTMLForm::factory( 'ooui', $this->fields, $this->getContext(), $this->getName() );
        } else {
            $form = new HTMLForm( $this->fields, $this->getContext(), $this->getName() );
        }
        $form->setSubmitCallback( [ $this, 'onSubmit' ] );
 
        $title = $this->getTitle();
        $form->setAction( $title->getLocalURL( [ 'action' => $this->getName() ] ) );
        // Retain query parameters (uselang etc)
        $params = array_diff_key(
            $this->getRequest()->getQueryValues(),
            [ 'action' => null, 'title' => null ]
        );
        if ( $params ) {
            $form->addHiddenField( 'redirectparams', wfArrayToCgi( $params ) );
        }
 
        $form->addPreHtml( $this->preText() );
        $form->addPostHtml( $this->postText() );
        $this->alterForm( $form );
 
        // Give hooks a chance to alter the form, adding extra fields or text etc
        $this->getHookRunner()->onActionBeforeFormDisplay(
            $this->getName(),
            $form,
            $this->getArticle()
        );
 
        return $form;
    }
 
    abstract public function onSubmit( $data );
 
    abstract public function onSuccess();
 
    public function show() {
        $this->setHeaders();
 
        // This will throw exceptions if there's a problem
        $this->checkCanExecute( $this->getUser() );
 
        $form = $this->getForm();
        if ( $form->show() ) {
            $this->onSuccess();
        }
    }
 
    public function doesWrites() {
        return true;
    }
}
 
class_alias( FormAction::class, 'FormAction' );