SemanticMediaWiki/includes/parserhooks/SMW_SMWDoc.php

Go to the documentation of this file.

<?php

class SMWSMWDoc extends ParserHook {

        protected $language;

        public static function staticInit( Parser &$parser ) {
                $instance = new self;
                return $instance->init( $parser );
        }

        protected function getName() {
                return 'smwdoc';
        }

        protected function getParameterInfo( $type ) {
                $params = array();

                $params['format'] = new Parameter( 'format' );
                $params['format']->addCriteria( new CriterionInArray( array_keys( $GLOBALS['smwgResultFormats'] ) ) );
                $params['format']->setMessage( 'smw-smwdoc-par-format' );

                $params['language'] = new Parameter( 'language' );
                $params['language']->setDefault( $GLOBALS['wgLanguageCode'] );
                $params['language']->setMessage( 'smw-smwdoc-par-language' );
                
                $params['parameters'] = new Parameter( 'parameters', Parameter::TYPE_STRING, 'specific' );
                $params['parameters']->setMessage( 'smw-smwdoc-par-parameters' );
                $params['parameters']->addCriteria( new CriterionInArray( 'all', 'specific', 'base' ) );

                return $params;
        }

        protected function getDefaultParameters( $type ) {
                return array( 'format', 'language', 'parameters' );
        }

        public function render( array $parameters ) {
                $this->language = $parameters['language'];

                $params = array();
                
                if ( in_array( $parameters['parameters'], array( 'all', 'base' ) ) ) {
                        $params = array_merge( $params, SMWQueryProcessor::getParameters() );
                }
                
                if ( in_array( $parameters['parameters'], array( 'all', 'specific' ) ) ) {
                        $params = array_merge( $params, $this->getFormatParameters( $parameters['format'] ) );
                }

                return $this->getParameterTable( $params );
        }

        protected function getParameterTable( array $parameters ) {
                $tableRows = array();
                $hasAliases = false;

                foreach ( $parameters as $parameter ) {
                        $hasAliases = count( $parameter->getAliases() ) != 0;
                        if ( $hasAliases ) break;
                }

                foreach ( $parameters as $parameter ) {
                        if ( $parameter->getName() != 'format' ) {
                                $tableRows[] = $this->getDescriptionRow( $parameter, $hasAliases );
                        }
                }

                $table = '';

                if ( count( $tableRows ) > 0 ) {
                        $tableRows = array_merge( array(
                        '!' . $this->msg( 'validator-describe-header-parameter' ) ."\n" .
                        ( $hasAliases ? '!' . $this->msg( 'validator-describe-header-aliases' ) ."\n" : '' ) .
                        '!' . $this->msg( 'validator-describe-header-type' ) ."\n" .
                        '!' . $this->msg( 'validator-describe-header-default' ) ."\n" .
                        '!' . $this->msg( 'validator-describe-header-description' )
                        ), $tableRows );

                        $table = implode( "\n|-\n", $tableRows );

                        $table =
                                        '{| class="wikitable sortable"' . "\n" .
                                        $table .
                                        "\n|}";
                }

                return $table;
        }

        protected function getDescriptionRow( Parameter $parameter, $hasAliases ) {
                if ( $hasAliases ) {
                        $aliases = $parameter->getAliases();
                        $aliases = count( $aliases ) > 0 ? implode( ', ', $aliases ) : '-';
                }


                $description = $parameter->getMessage();
                if ( $description === false ) {
                        $description = $parameter->getDescription();
                        if ( $description === false ) $description = '-';
                }
                else {
                        $description = $this->msg( $description );
                }

                $type = $parameter->getTypeMessage();

                $default = $parameter->isRequired() ? "''" . $this->msg( 'validator-describe-required' ) . "''" : $parameter->getDefault();
                if ( is_array( $default ) ) {
                        $default = implode( ', ', $default );
                }
                elseif ( is_bool( $default ) ) {
                        $default = $default ? 'yes' : 'no';
                }

                if ( $default === '' ) $default = "''" . $this->msg( 'validator-describe-empty' ) . "''";

                return "| {$parameter->getName()}\n"
. ( $hasAliases ? '| ' . $aliases . "\n" : '' ) .
<<<EOT
| {$type}
| {$default}
| {$description}
EOT;
        }

        protected function getFormatParameters( $format ) {
                if ( array_key_exists( $format, $GLOBALS['smwgResultFormats'] ) ) {
                        return SMWQueryProcessor::getResultPrinter( $format )->getValidatorParameters();
                }
                else {
                        return array();
                }
        }

        public function getMessage() {
                return 'smw-smwdoc-description';
        }

        protected function msg( $key ) {
                $args = func_get_args();
                $key = array_shift( $args );
                return wfMsgReal( $key, $args, true, $this->language );
        }
}

---