SemanticMediaWiki/includes/api/ApiAsk.php

Go to the documentation of this file.

<?php

class ApiAsk extends ApiSMWQuery {
        
        public function execute() {
                $params = $this->extractRequestParams();
                $this->requireParameters( $params, array( 'query' ) );

                $rawParams = explode( '|', $params['query'] );
                $queryString = '';
                $printouts = array();
                
                SMWQueryProcessor::processFunctionParams( $rawParams, $queryString, $this->parameters, $printouts );
                
                $queryResult = $this->getQueryResult( $this->getQuery(
                        $queryString,
                        $printouts
                ) );
                
                $this->addQueryResult( $queryResult );
        }

        public function getAllowedParams() {
                return array(
                        'query' => array(
                                ApiBase::PARAM_TYPE => 'string',
                        ),
                );
        }
        
        public function getParamDescription() {
                return array(
                        'query' => 'The query string in ask-language'
                );
        }
        
        public function getDescription() {
                return array(
                        'API module to query SMW by providing a query in the ask language.
                        This API module is in alpha stage, and likely to see changes in upcomming versions of SMW.'
                );
        }

        protected function getExamples() {
                return array(
                        'api.php?action=ask&query=[[Modification%20date::%2B]]|%3FModification%20date|sort%3DModification%20date|order%3Ddesc',
                );
        }       
        
        public function getVersion() {
                return __CLASS__ . ': $Id: ApiAsk.php 112438 2012-02-26 14:21:22Z nikerabbit $';
        }               
        
}

---