ApiFormatTestBase.php

Go to the documentation of this file.

<?php
 
abstract class ApiFormatTestBase extends MediaWikiTestCase {
 
    protected $printerName;
 
    public static function provideGeneralEncoding() {
        throw new BadMethodCallException( static::class . ' must implement ' . __METHOD__ );
    }
 
    protected function encodeData( array $params, array $data, $options = [] ) {
        if ( is_string( $options ) ) {
            $options = [ 'class' => $options ];
        }
        $printerName = $options['name'] ?? $this->printerName;
        $flags = $options['flags'] ?? 0;
 
        $context = new RequestContext;
        $context->setRequest( new FauxRequest( $params, true ) );
        $main = new ApiMain( $context );
        if ( isset( $options['class'] ) ) {
            $factory = $options['factory'] ?? null;
            $main->getModuleManager()->addModule( $printerName, 'format', $options['class'], $factory );
        }
        $result = $main->getResult();
        $result->addArrayType( null, 'default' );
        foreach ( $data as $k => $v ) {
            $result->addValue( null, $k, $v, $flags );
        }
 
        $ret = [];
        $printer = $main->createPrinterByName( $printerName );
        $printer->initPrinter();
        $printer->execute();
        ob_start();
        try {
            $printer->closePrinter();
            $ret['text'] = ob_get_clean();
        } catch ( Exception $ex ) {
            ob_end_clean();
            throw $ex;
        }
 
        if ( !empty( $options['returnPrinter'] ) ) {
            $ret['printer'] = $printer;
        }
 
        return count( $ret ) === 1 ? $ret['text'] : $ret;
    }
 
    public function testGeneralEncoding(
        array $data, $expect, array $params = [], array $options = []
    ) {
        if ( $expect instanceof Exception ) {
            $this->setExpectedException( get_class( $expect ), $expect->getMessage() );
            $this->encodeData( $params, $data, $options ); // Should throw
        } else {
            $this->assertSame( $expect, $this->encodeData( $params, $data, $options ) );
        }
    }
 
}