FormAction.php

Go to the documentation of this file.

<?php
abstract class FormAction extends Action {

    abstract protected function getFormFields();

    protected function preText() {
        return '';
    }

    protected function postText() {
        return '';
    }

    protected function alterForm( HTMLForm $form ) {
    }

    protected function getForm() {
        $this->fields = $this->getFormFields();

        // Give hooks a chance to alter the form, adding extra fields or text etc
        wfRunHooks( 'ActionModifyFormFields', array( $this->getName(), &$this->fields, $this->page ) );

        $form = new HTMLForm( $this->fields, $this->getContext(), $this->getName() );
        $form->setSubmitCallback( array( $this, 'onSubmit' ) );

        // Retain query parameters (uselang etc)
        $form->addHiddenField( 'action', $this->getName() ); // Might not be the same as the query string
        $params = array_diff_key(
            $this->getRequest()->getQueryValues(),
            array( 'action' => null, 'title' => null )
        );
        $form->addHiddenField( 'redirectparams', wfArrayToCgi( $params ) );

        $form->addPreText( $this->preText() );
        $form->addPostText( $this->postText() );
        $this->alterForm( $form );

        // Give hooks a chance to alter the form, adding extra fields or text etc
        wfRunHooks( 'ActionBeforeFormDisplay', array( $this->getName(), &$form, $this->page ) );

        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 execute( array $data = null, $captureErrors = true ) {
        try {
            // Set a new context so output doesn't leak.
            $this->context = clone $this->getContext();

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

            $fields = array();
            foreach ( $this->fields as $key => $params ) {
                if ( isset( $data[$key] ) ) {
                    $fields[$key] = $data[$key];
                } elseif ( isset( $params['default'] ) ) {
                    $fields[$key] = $params['default'];
                } else {
                    $fields[$key] = null;
                }
            }
            $status = $this->onSubmit( $fields );
            if ( $status === true ) {
                // This might do permanent stuff
                $this->onSuccess();
                return true;
            } else {
                return false;
            }
        }
        catch ( ErrorPageError $e ) {
            if ( $captureErrors ) {
                return false;
            } else {
                throw $e;
            }
        }
    }
}