SemanticMediaWiki/includes/SMW_GlobalFunctions.php

Go to the documentation of this file.

<?php
// Constants for displaying the factbox.
define( 'SMW_FACTBOX_HIDDEN', 1 );
define( 'SMW_FACTBOX_SPECIAL', 2 );
define( 'SMW_FACTBOX_NONEMPTY',  3 );
define( 'SMW_FACTBOX_SHOWN',  5 );

// Constants for regulating equality reasoning.
define( 'SMW_EQ_NONE', 0 );
define( 'SMW_EQ_SOME', 1 );
define( 'SMW_EQ_FULL', 2 );

// Flags to classify available query descriptions, used to enable/disable certain features.
define( 'SMW_PROPERTY_QUERY', 1 );     // [[some property::...]]
define( 'SMW_CATEGORY_QUERY', 2 );     // [[Category:...]]
define( 'SMW_CONCEPT_QUERY', 4 );      // [[Concept:...]]
define( 'SMW_NAMESPACE_QUERY', 8 );    // [[User:+]] etc.
define( 'SMW_CONJUNCTION_QUERY', 16 ); // any conjunctions
define( 'SMW_DISJUNCTION_QUERY', 32 ); // any disjunctions (OR, ||)
define( 'SMW_ANY_QUERY', 0xFFFFFFFF );  // subsumes all other options

// Constants for defining which concepts to show only if cached.
define( 'CONCEPT_CACHE_ALL', 4 ); // show concept elements anywhere only if cached
define( 'CONCEPT_CACHE_HARD', 1 ); // show without cache if concept is not harder than permitted inline queries
define( 'CONCEPT_CACHE_NONE', 0 ); // show all concepts even without any cache

// Constants for identifying javascripts as used in SMWOutputs.
define( 'SMW_HEADER_TOOLTIP', 2 );
define( 'SMW_HEADER_SORTTABLE', 3 );
define( 'SMW_HEADER_STYLE', 4 );

// Constants for denoting output modes in many functions: HTML or Wiki?
// "File" is for printing results into stand-alone files (e.g. building RSS)
// and should be treated like HTML when building single strings. Only query
// printers tend to have special handling for that.
define( 'SMW_OUTPUT_HTML', 1 );
define( 'SMW_OUTPUT_WIKI', 2 );
define( 'SMW_OUTPUT_FILE', 3 );

// Comparators for datavalues:
define( 'SMW_CMP_EQ', 1 ); // Matches only datavalues that are equal to the given value.
define( 'SMW_CMP_LEQ', 2 ); // Matches only datavalues that are less or equal than the given value.
define( 'SMW_CMP_GEQ', 3 ); // Matches only datavalues that are greater or equal to the given value.
define( 'SMW_CMP_NEQ', 4 ); // Matches only datavalues that are unequal to the given value.
define( 'SMW_CMP_LIKE', 5 ); // Matches only datavalues that are LIKE the given value.
define( 'SMW_CMP_NLKE', 6 ); // Matches only datavalues that are not LIKE the given value.
define( 'SMW_CMP_LESS', 7 ); // Matches only datavalues that are less than the given value.
define( 'SMW_CMP_GRTR', 8 ); // Matches only datavalues that are greater than the given value.

// Constants for date formats (using binary encoding of nine bits: 3 positions x 3 interpretations).
define( 'SMW_MDY', 785 );  // Month-Day-Year
define( 'SMW_DMY', 673 );  // Day-Month-Year
define( 'SMW_YMD', 610 );  // Year-Month-Day
define( 'SMW_YDM', 596 );  // Year-Day-Month
define( 'SMW_MY', 97 );    // Month-Year
define( 'SMW_YM', 76 );    // Year-Month
define( 'SMW_Y', 9 );      // Year
define( 'SMW_YEAR', 1 );   // an entered digit can be a year
define( 'SMW_DAY', 2 );   // an entered digit can be a year
define( 'SMW_MONTH', 4 );  // an entered digit can be a month
define( 'SMW_DAY_MONTH_YEAR', 7 ); // an entered digit can be a day, month or year
define( 'SMW_DAY_YEAR', 3 ); // an entered digit can be either a month or a year

function smwfIsSemanticsProcessed( $namespace ) {
        global $smwgNamespacesWithSemanticLinks;
        return !empty( $smwgNamespacesWithSemanticLinks[$namespace] );
}

function smwfNormalTitleDBKey( $text ) {
        global $wgCapitalLinks;

        $text = trim( $text );

        if ( $wgCapitalLinks ) {
                $text = ucfirst( $text );
        }

        return str_replace( ' ', '_', $text );
}

function smwfNormalTitleText( $text ) {
        global $wgCapitalLinks;

        $text = trim( $text );

        if ( $wgCapitalLinks ) {
                $text = ucfirst( $text );
        }

        return str_replace( '_', ' ', $text );
}

function smwfXMLContentEncode( $text ) {
        return str_replace( array( '&', '<', '>' ), array( '&amp;', '&lt;', '&gt;' ), Sanitizer::decodeCharReferences( $text ) );
}

function smwfHTMLtoUTF8( $text ) {
        return Sanitizer::decodeCharReferences( $text );
}

function smwfNumberFormat( $value, $decplaces = 3 ) {
        global $smwgMaxNonExpNumber;

        $decseparator = wfMsgForContent( 'smw_decseparator' );

        // If number is a trillion or more, then switch to scientific
        // notation. If number is less than 0.0000001 (i.e. twice decplaces),
        // then switch to scientific notation. Otherwise print number
        // using number_format. This may lead to 1.200, so then use trim to
        // remove trailing zeroes.
        $doScientific = false;

        // @todo: Don't do all this magic for integers, since the formatting does not fit there
        //       correctly. E.g. one would have integers formatted as 1234e6, not as 1.234e9, right?
        // The "$value!=0" is relevant: we want to scientify numbers that are close to 0, but never 0!
        if ( ( $decplaces > 0 ) && ( $value != 0 ) ) {
                $absValue = abs( $value );
                if ( $absValue >= $smwgMaxNonExpNumber ) {
                        $doScientific = true;
                } elseif ( $absValue <= pow( 10, - $decplaces ) ) {
                        $doScientific = true;
                } elseif ( $absValue < 1 ) {
                        if ( $absValue <= pow( 10, - $decplaces ) ) {
                                $doScientific = true;
                        } else {
                                // Increase decimal places for small numbers, e.g. .00123 should be 5 places.
                                for ( $i = 0.1; $absValue <= $i; $i *= 0.1 ) {
                                        $decplaces++;
                                }
                        }
                }
        }

        if ( $doScientific ) {
                // Should we use decimal places here?
                $value = sprintf( "%1.6e", $value );
                // Make it more readable by removing trailing zeroes from n.n00e7.
                $value = preg_replace( '/(\\.\\d+?)0*e/u', '${1}e', $value, 1 );
                // NOTE: do not use the optional $count parameter with preg_replace. We need to
                //      remain compatible with PHP 4.something.
                if ( $decseparator !== '.' ) {
                        $value = str_replace( '.', $decseparator, $value );
                }
        } else {
                // Format to some level of precision; number_format does rounding and locale formatting,
                // x and y are used temporarily since number_format supports only single characters for either
                $value = number_format( $value, $decplaces, 'x', 'y' );
                $value = str_replace( array( 'x', 'y' ), array( $decseparator, wfMsgForContent( 'smw_kiloseparator' ) ), $value );

                // Make it more readable by removing ending .000 from nnn.000
                //    Assumes substr is faster than a regular expression replacement.
                $end = $decseparator . str_repeat( '0', $decplaces );
                $lenEnd = strlen( $end );

                if ( substr( $value, - $lenEnd ) === $end ) {
                        $value = substr( $value, 0, - $lenEnd );
                } else {
                        // If above replacement occurred, no need to do the next one.
                        // Make it more readable by removing trailing zeroes from nn.n00.
                        $value = preg_replace( "/(\\$decseparator\\d+?)0*$/u", '$1', $value, 1 );
                }
        }

        return $value;
}

function smwfEncodeMessages( array $messages, $icon = 'warning', $seperator = ' <!--br-->', $escape = true ) {
        if ( count( $messages ) > 0 ) {
                SMWOutputs::requireResource( 'ext.smw.tooltips' );

                if ( $escape ) {
                        $messages = array_map( 'htmlspecialchars', $messages );
                }

                if ( count( $messages ) == 1 )  {
                        $errorList = $messages[0];
                }
                else {
                        foreach ( $messages as &$message ) {
                                $message = '<li>' . $message . '</li>';
                        }
                        
                        $errorList = '<ul>' . implode( $seperator, $messages ) . '</ul>';
                }

                return '<span class="smwttpersist">' .
                                '<span class="smwtticon">' . htmlspecialchars( $icon ) . '.png</span>' .
                                '<span class="smwttcontent">' . $errorList . '</span>' . 
                        '</span>';
        } else {
                return '';
        }
}

function smwfLoadExtensionMessages( $extensionName ) {}

function &smwfGetStore() {
        global $smwgMasterStore, $smwgDefaultStore;

        if ( is_null( $smwgMasterStore ) ) {
                $smwgMasterStore = new $smwgDefaultStore();
        }

        return $smwgMasterStore;
}

function &smwfGetSparqlDatabase() {
        global $smwgSparqlDatabase, $smwgSparqlDefaultGraph, $smwgSparqlQueryEndpoint,
                $smwgSparqlUpdateEndpoint, $smwgSparqlDataEndpoint, $smwgSparqlDatabaseMaster;
        if ( !isset( $smwgSparqlDatabaseMaster ) ) {
                $smwgSparqlDatabaseMaster = new $smwgSparqlDatabase( $smwgSparqlDefaultGraph,
                        $smwgSparqlQueryEndpoint, $smwgSparqlUpdateEndpoint, $smwgSparqlDataEndpoint );
        }
        return $smwgSparqlDatabaseMaster;
}

function smwfGetLinker() {
        static $linker = false;

        if ( $linker === false ) {
                $linker = class_exists( 'DummyLinker' ) ? new DummyLinker() : new Linker();
        }

        return $linker;
}

---