SemanticMediaWiki/includes/storage/SMW_PrintRequest.php

Go to the documentation of this file.

<?php
class SMWPrintRequest {
        
        const PRINT_CATS = 0;
        const PRINT_PROP = 1;
        const PRINT_THIS = 2;
        const PRINT_CCAT = 3;

        protected $m_mode; // type of print request
        protected $m_label; // string for labelling results, contains no markup
        protected $m_data; // data entries specifyin gwhat was requested (mixed type)
        protected $m_typeid = false; // id of the datatype of the printed objects, if applicable
        protected $m_outputformat; // output format string for formatting results, if applicable
        protected $m_hash = false; // cache your hash (currently useful since SMWQueryResult accesses the hash many times, might be dropped at some point)
        protected $m_params = array();

        public function __construct( $mode, $label, $data = null, $outputformat = false, $params = null ) {
                if ( ( ( $mode == self::PRINT_CATS || $mode == self::PRINT_THIS ) &&
                         !is_null( $data ) ) ||
                     ( $mode == self::PRINT_PROP &&
                         ( !( $data instanceof SMWPropertyValue ) || !$data->isValid() ) ) ||
                     ( $mode == self::PRINT_CCAT &&
                         !( $data instanceof Title ) ) ) {
                        throw new InvalidArgumentException( 'Data provided for print request does not fit the type of printout.' );
                }

                $this->m_mode = $mode;
                $this->m_label = $label;
                $this->m_data = $data;
                $this->m_outputformat = $outputformat;

                if ( ( $mode == self::PRINT_CCAT ) && ( $outputformat == false ) ) {
                        $this->m_outputformat = 'x'; // changed default for Boolean case
                }

                if ( $this->m_data instanceof SMWDataValue ) {
                        // $this->m_data = clone $data; // we assume that the caller denotes the object ot us; else he needs provide us with a clone
                        $this->m_data->setCaption( $label );
                }

                if ( null != $params ) $this->m_params = $params;
        }

        public function getMode() {
                return $this->m_mode;
        }

        public function getLabel() {
                return $this->m_label;
        }

        public function getHTMLText( $linker = null ) {
                if ( is_null( $linker ) || ( $this->m_label === '' ) ) {
                        return htmlspecialchars( $this->m_label );
                }
                
                switch ( $this->m_mode ) {
                        case self::PRINT_CATS:
                                return htmlspecialchars( $this->m_label ); // TODO: link to Special:Categories
                        case self::PRINT_CCAT:
                                return $linker->makeLinkObj( $this->m_data, htmlspecialchars( $this->m_label ) );
                        case self::PRINT_PROP:
                                return $this->m_data->getShortHTMLText( $linker );
                        case self::PRINT_THIS: default: return htmlspecialchars( $this->m_label );
                }
        }

        public function getWikiText( $linked = false ) {
                if ( is_null( $linked ) || ( $linked === false ) || ( $this->m_label === '' ) ) {
                        return $this->m_label;
                } else {
                        switch ( $this->m_mode ) {
                                case self::PRINT_CATS:
                                        return $this->m_label; // TODO: link to Special:Categories
                                case self::PRINT_PROP:
                                        return $this->m_data->getShortWikiText( $linked );
                                case self::PRINT_CCAT:
                                        return '[[:' . $this->m_data->getPrefixedText() . '|' . $this->m_label . ']]';
                                case self::PRINT_THIS: default:
                                        return $this->m_label;
                        }
                }
        }

        public function getText( $outputmode, $linker = null ) {
                switch ( $outputmode ) {
                        case SMW_OUTPUT_WIKI: return $this->getWikiText( $linker );
                        case SMW_OUTPUT_HTML: case SMW_OUTPUT_FILE: default: return $this->getHTMLText( $linker );
                }
        }

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

        public function getOutputFormat() {
                return $this->m_outputformat;
        }

        public function getTypeID() {
                if ( $this->m_typeid === false ) {
                        if ( $this->m_mode == self::PRINT_PROP ) {
                                $this->m_typeid = $this->m_data->getDataItem()->findPropertyTypeID();
                        } else {
                                $this->m_typeid = '_wpg';
                        }
                }

                return $this->m_typeid;
        }

        public function getHash() {
                if ( $this->m_hash === false ) {
                        $this->m_hash = $this->m_mode . ':' . $this->m_label . ':';
                        
                        if ( $this->m_data instanceof Title ) {
                                $this->m_hash .= $this->m_data->getPrefixedText() . ':';
                        } elseif ( $this->m_data instanceof SMWDataValue ) {
                                $this->m_hash .= $this->m_data->getHash() . ':';
                        }
                        
                        $this->m_hash .= $this->m_outputformat . ':' . implode( '|', $this->m_params );
                }
                
                return $this->m_hash;
        }

        public function getSerialisation( $showparams = false ) {
                $parameters = '';
                
                if ( $showparams ) foreach ( $this->m_params as $key => $value ) {
                        $parameters .= "|+" . $key . "=" . $value;
                }
                
                switch ( $this->m_mode ) {
                        case self::PRINT_CATS:
                                global $wgContLang;
                                $catlabel = $wgContLang->getNSText( NS_CATEGORY );
                                $result = '?' . $catlabel;
                                if ( $this->m_label != $catlabel ) {
                                        $result .= '=' . $this->m_label;
                                }
                                return $result . $parameters;
                        case self::PRINT_PROP: case self::PRINT_CCAT:
                                if ( $this->m_mode == self::PRINT_CCAT ) {
                                        $printname = $this->m_data->getPrefixedText();
                                        $result = '?' . $printname;
                                        
                                        if ( $this->m_outputformat != 'x' ) {
                                                $result .= '#' . $this->m_outputformat;
                                        }
                                } else {
                                        $printname = $this->m_data->getWikiValue();
                                        $result = '?' . $printname;
                                        
                                        if ( $this->m_outputformat !== '' ) {
                                                $result .= '#' . $this->m_outputformat;
                                        }
                                }
                                if ( $printname != $this->m_label ) {
                                        $result .= '=' . $this->m_label;
                                }
                                return $result . $parameters;
                        case self::PRINT_THIS:
                                $result = '?';
                                
                                if ( $this->m_label !== '' ) {
                                        $result .= '=' . $this->m_label;
                                }
                                
                                if ( $this->m_outputformat !== '' ) {
                                        $result .= '#' . $this->m_outputformat;
                                }
                                                                        
                                return $result . $parameters; 
                        default: return ''; // no current serialisation
                }
        }

        public function getParameter( $key ) {
                return array_key_exists( $key, $this->m_params ) ? $this->m_params[$key] : false;
        }

        public function getParameters() {
                return $this->m_params;
        }

        public function setParameter( $key, $value ) {
                $this->m_params[$key] = $value;
        }
        
}

---