SemanticMediaWiki/includes/datavalues/SMW_DV_Number.php

Go to the documentation of this file.

<?php
class SMWNumberValue extends SMWDataValue {

        protected $m_unitvalues;

        protected $m_unitin;

        static protected function parseNumberValue( $value, &$number, &$unit ) {
                // Parse to find $number and (possibly) $unit
                $decseparator = wfMsgForContent( 'smw_decseparator' );
                $kiloseparator = wfMsgForContent( 'smw_kiloseparator' );

                $parts = preg_split( '/([-+]?\s*\d+(?:\\' . $kiloseparator . '\d\d\d)*' .
                                      '(?:\\' . $decseparator . '\d+)?\s*(?:[eE][-+]?\d+)?)/u',
                                      trim( str_replace( array( '&nbsp;', '&#160;', '&thinsp;', ' ' ), '', $value ) ),
                                      2, PREG_SPLIT_DELIM_CAPTURE );

                if ( count( $parts ) >= 2 ) {
                        $numstring = str_replace( $kiloseparator, '', preg_replace( '/\s*/u', '', $parts[1] ) ); // simplify
                        if ( $decseparator != '.' ) {
                                $numstring = str_replace( $decseparator, '.', $numstring );
                        }
                        list( $number ) = sscanf( $numstring, "%f" );
                        if ( count( $parts ) >= 3 ) {
                                $unit = self::normalizeUnit( $parts[2] );
                        }
                }

                if ( ( count( $parts ) == 1 ) || ( $numstring === '' ) ) { // no number found
                        return 1;
                } elseif ( is_infinite( $number ) ) { // number is too large for this platform
                        return 2;
                } else {
                        return 0;
                }
        }

        protected function parseUserValue( $value ) {
                // Set caption
                if ( $this->m_caption === false ) {
                        $this->m_caption = $value;
                }
                $this->m_unitin = false;
                $this->m_unitvalues = false;
                $number = $unit = '';
                $error = self::parseNumberValue( $value, $number, $unit );
                if ( $error == 1 ) { // no number found
                        $this->addError( wfMsgForContent( 'smw_nofloat', $value ) );
                } elseif ( $error == 2 ) { // number is too large for this platform
                        $this->addError( wfMsgForContent( 'smw_infinite', $value ) );
                } elseif ( $this->convertToMainUnit( $number, $unit ) === false ) { // so far so good: now convert unit and check if it is allowed
                        $this->addError( wfMsgForContent( 'smw_unitnotallowed', $unit ) );
                } // note that convertToMainUnit() also sets m_dataitem if valid
        }

        protected function loadDataItem( SMWDataItem $dataItem ) {
                if ( $dataItem->getDIType() == SMWDataItem::TYPE_NUMBER ) {
                        $this->m_dataitem = $dataItem;
                        $this->m_caption = false;
                        $this->m_unitin = false;
                        $this->makeUserValue();
                        $this->m_unitvalues = false;
                        return true;
                } else {
                        return false;
                }
        }

        public function setOutputFormat( $formatstring ) {
                if ( $formatstring != $this->m_outformat ) {
                        $this->m_outformat = $formatstring;
                        if ( $this->isValid() ) { // update caption/unitin for this format
                                $this->m_caption = false;
                                $this->m_unitin = false;
                                $this->makeUserValue();
                        }
                }
        }

        public function getShortWikiText( $linked = null ) {
                if ( is_null( $linked ) || ( $linked === false ) || ( $this->m_outformat == '-' )
                        || ( $this->m_outformat == '-u' ) || ( $this->m_outformat == '-n' ) || ( !$this->isValid() ) ) {
                        return $this->m_caption;
                } else {
                        $this->makeConversionValues();
                        $tooltip = '';
                        $i = 0;
                        $sep = '';
                        foreach ( $this->m_unitvalues as $unit => $value ) {
                                if ( $unit != $this->m_unitin ) {
                                        $tooltip .= $sep . smwfNumberFormat( $value );
                                        if ( $unit !== '' ) {
                                                $tooltip .= '&#160;' . $unit;
                                        }
                                        $sep = ' <br />';
                                        $i++;
                                        if ( $i >= 5 ) { // limit number of printouts in tooltip
                                                break;
                                        }
                                }
                        }
                        if ( $tooltip !== '' ) {
                                SMWOutputs::requireResource( 'ext.smw.tooltips' );
                                return '<span class="smwttinline">' . $this->m_caption . '<span class="smwttcontent">' . $tooltip . '</span></span>';
                        } else {
                                return $this->m_caption;
                        }
                }
        }

        public function getShortHTMLText( $linker = null ) {
                return $this->getShortWikiText( $linker );
        }

        public function getLongWikiText( $linked = null ) {
                if ( !$this->isValid() ) {
                        return $this->getErrorText();
                } else {
                        $this->makeConversionValues();
                        $result = '';
                        $i = 0;
                        foreach ( $this->m_unitvalues as $unit => $value ) {
                                if ( $i == 1 ) {
                                        $result .= ' (';
                                } elseif ( $i > 1 ) {
                                        $result .= ', ';
                                }
                                $result .= ( $this->m_outformat != '-' ? smwfNumberFormat( $value ) : $value );
                                if ( $unit !== '' ) {
                                        $result .= '&#160;' . $unit;
                                }
                                $i++;
                                if ( $this->m_outformat == '-' ) { // no further conversions for plain output format
                                        break;
                                }
                        }
                        if ( $i > 1 ) {
                                $result .= ')';
                        }
                        return $result;
                }
        }

        public function getLongHTMLText( $linker = null ) {
                return $this->getLongWikiText( $linker );
        }

        public function getNumber() {
                return $this->isValid() ? $this->m_dataitem->getNumber() : 32202;
        }

        public function getWikiValue() {
                if ( $this->isValid() ) {
                        $unit = $this->getUnit();
                        return smwfNumberFormat( $this->m_dataitem->getSerialization() ) . ( $unit !== '' ? ' ' . $unit : '' );
                } else {
                        return 'error';
                }
        }

        public function getUnit() {
                return '';
        }

        protected function getServiceLinkParams() {
                if ( $this->isValid() ) {
                        return array( strval( $this->m_dataitem->getNumber() ), strval( round( $this->m_dataitem->getNumber() ) ) );
                } else {
                        return array();
                }
        }

        static protected function normalizeUnit( $unit ) {
                $unit = str_replace( array( '[[', ']]' ), '', trim( $unit ) ); // allow simple links to be used inside annotations
                $unit = str_replace( array( '²', '<sup>2</sup>' ), '&sup2;', $unit );
                $unit = str_replace( array( '³', '<sup>3</sup>' ), '&sup3;', $unit );
                return smwfXMLContentEncode( $unit );
        }

        protected function convertToMainUnit( $number, $unit ) {
                $this->m_dataitem = new SMWDINumber( $number );
                $this->m_unitin = '';
                return ( $unit === '' );
        }

        protected function makeConversionValues() {
                $this->m_unitvalues = array( '' => $this->m_dataitem->getNumber() );
        }

        protected function makeUserValue() {
                $this->m_caption = '';
                if ( $this->m_outformat != '-u' ) { // -u is the format for displaying the unit only
                        $this->m_caption .= ( ( $this->m_outformat != '-' ) && ( $this->m_outformat != '-n' ) ? smwfNumberFormat( $this->m_dataitem->getNumber() ) : $this->m_dataitem->getNumber() );
                }
                // no unit ever, so nothing to do about this
                $this->m_unitin = '';
        }

        public function getUnitList() {
                return array( '' );
        }

}

---