SemanticMediaWiki/includes/api/ApiAskArgs.php

Go to the documentation of this file.

<?php

class ApiAskArgs extends ApiSMWQuery {
        
        public function execute() {
                $params = $this->extractRequestParams();
                $this->requireParameters( $params, array( 'conditions' ) );
                
                foreach ( $params['parameters'] as $param ) {
                        $parts = explode( '=', $param, 2 );
                        
                        if ( count( $parts ) == 2 ) {
                                $this->parameters[$parts[0]] = $parts[1];
                        }
                }
                
                $query = $this->getQuery( 
                        implode( array_map( array( __CLASS__, 'wrapCondition' ), $params['conditions'] ) ),
                        array_map( array( __CLASS__, 'printoutFromString' ), $params['printouts'] )
                );
                
                $this->addQueryResult( $this->getQueryResult( $query ) );
        }
        
        public static function wrapCondition( $c ) {
                return "[[$c]]"; 
        }
        
        public static function printoutFromString( $printout ) {
                return new SMWPrintRequest(
                        SMWPrintRequest::PRINT_PROP,
                        $printout,
                        SMWPropertyValue::makeUserProperty( $printout )
                );
        }

        public function getAllowedParams() {
                return array(
                        'conditions' => array(
                                ApiBase::PARAM_TYPE => 'string',
                                ApiBase::PARAM_ISMULTI => true,
                        ),
                        'printouts' => array(
                                ApiBase::PARAM_TYPE => 'string',
                                ApiBase::PARAM_DFLT => '',
                                ApiBase::PARAM_ISMULTI => true,
                        ),
                        'parameters' => array(
                                ApiBase::PARAM_TYPE => 'string',
                                ApiBase::PARAM_DFLT => '',
                                ApiBase::PARAM_ISMULTI => true,
                        ),
                );
        }
        
        public function getParamDescription() {
                return array(
                        'conditions' => 'The query conditions, i.e. the requirements for a subject to be included',
                        'printouts' => 'The query printouts, i.e. the properties to show per subject',
                        'parameters' => 'The query parameters, i.e. all non-condition and non-printout arguments',
                );
        }
        
        public function getDescription() {
                return array(
                        'API module to query SMW by providing a query specified as a list of conditions, printouts and parameters.
                        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=askargs&conditions=Modification%20date::%2B&printouts=Modification%20date&parameters=|sort%3DModification%20date|order%3Ddesc',
                );
        }       
        
        public function getVersion() {
                return __CLASS__ . ': $Id: ApiAskArgs.php 112438 2012-02-26 14:21:22Z nikerabbit $';
        }               
        
}

---