FormSpecialPage.php

Go to the documentation of this file.

<?php
abstract class FormSpecialPage extends SpecialPage {
    protected $par = null;

    abstract protected function getFormFields();

    protected function preText() {
        return '';
    }

    protected function postText() {
        return '';
    }

    protected function alterForm( HTMLForm $form ) {
    }

    protected function getMessagePrefix() {
        return strtolower( $this->getName() );
    }

    protected function getDisplayFormat() {
        return 'table';
    }

    protected function getForm() {
        $form = HTMLForm::factory(
            $this->getDisplayFormat(),
            $this->getFormFields(),
            $this->getContext(),
            $this->getMessagePrefix()
        );
        $form->setSubmitCallback( [ $this, 'onSubmit' ] );
        if ( $this->getDisplayFormat() !== 'ooui' ) {
            // No legend and wrapper by default in OOUI forms, but can be set manually
            // from alterForm()
            $form->setWrapperLegendMsg( $this->getMessagePrefix() . '-legend' );
        }

        $headerMsg = $this->msg( $this->getMessagePrefix() . '-text' );
        if ( !$headerMsg->isDisabled() ) {
            $form->addHeaderText( $headerMsg->parseAsBlock() );
        }

        $form->addPreText( $this->preText() );
        $form->addPostText( $this->postText() );
        $this->alterForm( $form );
        if ( $form->getMethod() == 'post' ) {
            // Retain query parameters (uselang etc) on POST requests
            $params = array_diff_key(
                $this->getRequest()->getQueryValues(), [ 'title' => null ] );
            $form->addHiddenField( 'redirectparams', wfArrayToCgi( $params ) );
        }

        // Give hooks a chance to alter the form, adding extra fields or text etc
        Hooks::run( 'SpecialPageBeforeFormDisplay', [ $this->getName(), &$form ] );

        return $form;
    }

    abstract public function onSubmit( array $data /* $form = null */ );

    public function onSuccess() {
    }

    public function execute( $par ) {
        $this->setParameter( $par );
        $this->setHeaders();

        // This will throw exceptions if there's a problem
        $this->checkExecutePermissions( $this->getUser() );

        $form = $this->getForm();
        if ( $form->show() ) {
            $this->onSuccess();
        }
    }

    protected function setParameter( $par ) {
        $this->par = $par;
    }

    protected function checkExecutePermissions( User $user ) {
        $this->checkPermissions();

        if ( $this->requiresUnblock() && $user->isBlocked() ) {
            $block = $user->getBlock();
            throw new UserBlockedError( $block );
        }

        if ( $this->requiresWrite() ) {
            $this->checkReadOnly();
        }
    }

    public function requiresWrite() {
        return true;
    }

    public function requiresUnblock() {
        return true;
    }
}