JsonContent.php

Go to the documentation of this file.

<?php
class JsonContent extends TextContent {

    protected $jsonParse;

    public function __construct( $text, $modelId = CONTENT_MODEL_JSON ) {
        parent::__construct( $text, $modelId );
    }

    public function getJsonData() {
        wfDeprecated( __METHOD__, '1.25' );
        return FormatJson::decode( $this->getNativeData(), true );
    }

    public function getData() {
        if ( $this->jsonParse === null ) {
            $this->jsonParse = FormatJson::parse( $this->getNativeData() );
        }
        return $this->jsonParse;
    }

    public function isValid() {
        return $this->getData()->isGood();
    }

    public function beautifyJSON() {
        return FormatJson::encode( $this->getData()->getValue(), true, FormatJson::UTF8_OK );
    }

    public function preSaveTransform( Title $title, User $user, ParserOptions $popts ) {
        // FIXME: WikiPage::doEditContent invokes PST before validation. As such, native data
        // may be invalid (though PST result is discarded later in that case).
        if ( !$this->isValid() ) {
            return $this;
        }

        return new static( self::normalizeLineEndings( $this->beautifyJSON() ) );
    }

    protected function fillParserOutput( Title $title, $revId,
        ParserOptions $options, $generateHtml, ParserOutput &$output
    ) {
        // FIXME: WikiPage::doEditContent generates parser output before validation.
        // As such, native data may be invalid (though output is discarded later in that case).
        if ( $generateHtml && $this->isValid() ) {
            $output->setText( $this->rootValueTable( $this->getData()->getValue() ) );
            $output->addModuleStyles( 'mediawiki.content.json' );
        } else {
            $output->setText( '' );
        }
    }

    protected function rootValueTable( $val ) {
        if ( is_object( $val ) ) {
            return $this->objectTable( $val );
        }

        if ( is_array( $val ) ) {
            // Wrap arrays in another array so that they're visually boxed in a container.
            // Otherwise they are visually indistinguishable from a single value.
            return $this->arrayTable( [ $val ] );
        }

        return Html::rawElement( 'table', [ 'class' => 'mw-json mw-json-single-value' ],
            Html::rawElement( 'tbody', [],
                Html::rawElement( 'tr', [],
                    Html::element( 'td', [], $this->primitiveValue( $val ) )
                )
            )
        );
    }

    protected function objectTable( $mapping ) {
        $rows = [];
        $empty = true;

        foreach ( $mapping as $key => $val ) {
            $rows[] = $this->objectRow( $key, $val );
            $empty = false;
        }
        if ( $empty ) {
            $rows[] = Html::rawElement( 'tr', [],
                Html::element( 'td', [ 'class' => 'mw-json-empty' ],
                    wfMessage( 'content-json-empty-object' )->text()
                )
            );
        }
        return Html::rawElement( 'table', [ 'class' => 'mw-json' ],
            Html::rawElement( 'tbody', [], implode( '', $rows ) )
        );
    }

    protected function objectRow( $key, $val ) {
        $th = Html::element( 'th', [], $key );
        $td = $this->valueCell( $val );
        return Html::rawElement( 'tr', [], $th . $td );
    }

    protected function arrayTable( $mapping ) {
        $rows = [];
        $empty = true;

        foreach ( $mapping as $val ) {
            $rows[] = $this->arrayRow( $val );
            $empty = false;
        }
        if ( $empty ) {
            $rows[] = Html::rawElement( 'tr', [],
                Html::element( 'td', [ 'class' => 'mw-json-empty' ],
                    wfMessage( 'content-json-empty-array' )->text()
                )
            );
        }
        return Html::rawElement( 'table', [ 'class' => 'mw-json' ],
            Html::rawElement( 'tbody', [], implode( "\n", $rows ) )
        );
    }

    protected function arrayRow( $val ) {
        $td = $this->valueCell( $val );
        return Html::rawElement( 'tr', [], $td );
    }

    protected function valueCell( $val ) {
        if ( is_object( $val ) ) {
            return Html::rawElement( 'td', [], $this->objectTable( $val ) );
        }

        if ( is_array( $val ) ) {
            return Html::rawElement( 'td', [], $this->arrayTable( $val ) );
        }

        return Html::element( 'td', [ 'class' => 'value' ], $this->primitiveValue( $val ) );
    }

    protected function primitiveValue( $val ) {
        if ( is_string( $val ) ) {
            // Don't FormatJson::encode for strings since we want quotes
            // and new lines to render visually instead of escaped.
            return '"' . $val . '"';
        }
        return FormatJson::encode( $val );
    }
}