SemanticMediaWiki/includes/storage/SMW_Query.php

Go to the documentation of this file.

<?php
class SMWQuery {

        const MODE_INSTANCES = 1; // normal instance retrieval
        const MODE_COUNT = 2; // find result count only
        const MODE_DEBUG = 3; // prepare query, but show debug data instead of executing it
        const MODE_NONE = 4;  // do nothing with the query

        public $sort = false;
        public $sortkeys = array(); // format: "Property name" => "ASC" / "DESC" (note: order of entries also matters)
        public $querymode = SMWQuery::MODE_INSTANCES;

        protected $m_limit;
        protected $m_offset = 0;
        protected $m_description;
        protected $m_errors = array(); // keep any errors that occurred so far
        protected $m_querystring = false; // string (inline query) version (if fixed and known)
        protected $m_inline; // query used inline? (required for finding right default parameters)
        protected $m_concept; // query used in concept? (required for finding right default parameters)
        protected $m_extraprintouts = array(); // SMWPrintoutRequest objects supplied outside querystring
        protected $m_mainlabel = ''; // Since 1.6
        
        public function __construct( $description = null, $inline = false, $concept = false ) {
                global $smwgQMaxLimit, $smwgQMaxInlineLimit;
                $this->m_limit = $inline ? $smwgQMaxInlineLimit : $smwgQMaxLimit;
                $this->m_inline = $inline;
                $this->m_concept = $concept;
                $this->m_description = $description;
                $this->applyRestrictions();
        }
        
        public function setMainLabel( $mainlabel ) {
                $this->m_mainlabel = $mainlabel; 
        }

        public function getMainLabel() {
                return $this->m_mainlabel; 
        }

        public function setDescription( SMWDescription $description ) {
                $this->m_description = $description;
                foreach ( $this->m_extraprintouts as $printout ) {
                        $this->m_description->addPrintRequest( $printout );
                }
                $this->applyRestrictions();
        }

        public function getDescription() {
                return $this->m_description;
        }

        public function setExtraPrintouts( $extraprintouts ) {
                $this->m_extraprintouts = $extraprintouts;
                
                if ( !is_null( $this->m_description ) ) {
                        foreach ( $extraprintouts as $printout ) {
                                $this->m_description->addPrintRequest( $printout );
                        }
                }
        }

        public function getExtraPrintouts() {
                return $this->m_extraprintouts;
        }

        public function getErrors() {
                return $this->m_errors;
        }

        public function addErrors( $errors ) {
                $this->m_errors = array_merge( $this->m_errors, $errors );
        }

        public function setQueryString( $querystring ) {
                $this->m_querystring = $querystring;
        }

        public function getQueryString() {
                if ( $this->m_querystring !== false ) {
                        return $this->m_querystring;
                } elseif ( !is_null( $this->m_description ) ) {
                        return $this->m_description->getQueryString();
                } else {
                        return '';
                }
        }

        public function getOffset() {
                return $this->m_offset;
        }

        public function setOffset( $offset ) {
                global $smwgQMaxLimit;
                $this->m_offset = min( $smwgQMaxLimit, $offset ); // select integer between 0 and maximal limit;
                $this->m_limit = min( $smwgQMaxLimit - $this->m_offset, $this->m_limit ); // note that limit might become 0 here
                return $this->m_offset;
        }

        public function getLimit() {
                return $this->m_limit;
        }

        public function setLimit( $limit, $restrictinline = true ) {
                global $smwgQMaxLimit, $smwgQMaxInlineLimit;
                $maxlimit = ( $this->m_inline && $restrictinline ) ? $smwgQMaxInlineLimit : $smwgQMaxLimit;
                $this->m_limit = min( $smwgQMaxLimit - $this->m_offset, $limit, $maxlimit );
                return $this->m_limit;
        }

        public function applyRestrictions() {
                global $smwgQMaxSize, $smwgQMaxDepth, $smwgQConceptMaxSize, $smwgQConceptMaxDepth;
                
                if ( !is_null( $this->m_description ) ) {
                        if ( $this->m_concept ) {
                                $maxsize = $smwgQConceptMaxSize;
                                $maxdepth = $smwgQConceptMaxDepth;
                        } else {
                                $maxsize = $smwgQMaxSize;
                                $maxdepth = $smwgQMaxDepth;
                        }
                        
                        $log = array();
                        $this->m_description = $this->m_description->prune( $maxsize, $maxdepth, $log );
                        
                        if ( count( $log ) > 0 ) {
                                $this->m_errors[] = wfMsgForContent( 'smw_querytoolarge', str_replace( '[', '&#x005B;', implode( ', ' , $log ) ) );
                        }
                }
        }

}

---