ApiQueryORM.php

Go to the documentation of this file.

<?php

abstract class ApiQueryORM extends ApiQueryBase {

        abstract protected function getTable();

        protected function getRowName() {
                return 'item';
        }

        protected function getListName() {
                return 'items';
        }

        protected function getResultPath() {
                return null;
        }

        public function execute() {
                $params = $this->getParams();

                if ( !in_array( 'id', $params['props'] ) ) {
                        $params['props'][] = 'id';
                }

                $results = $this->getResults( $params, $this->getConditions( $params ) );
                $this->addResults( $params, $results );
        }

        protected function getParams() {
                return array_filter(
                        $this->extractRequestParams(),
                        function( $prop ) {
                                return isset( $prop );
                        }
                );
        }

        protected function getConditions( array $params ) {
                $conditions = array();
                $fields = $this->getTable()->getFields();

                foreach ( $params as $name => $value ) {
                        if ( array_key_exists( $name, $fields ) ) {
                                $conditions[$name] = $value;
                        }
                }

                return $conditions;
        }

        protected function getResults( array $params, array $conditions ) {
                return $this->getTable()->select(
                        $params['props'],
                        $conditions,
                        array(
                                'LIMIT' => $params['limit'] + 1,
                                'ORDER BY' => $this->getTable()->getPrefixedField( 'id' ) . ' ASC',
                        ),
                        __METHOD__
                );
        }

        protected function addResults( array $params, ORMResult $results ) {
                $serializedResults = array();
                $count = 0;

                foreach ( $results as /* IORMRow */ $result ) {
                        if ( ++$count > $params['limit'] ) {
                                // We've reached the one extra which shows that
                                // there are additional pages to be had. Stop here...
                                $this->setContinueEnumParameter( 'continue', $result->getId() );
                                break;
                        }

                        $serializedResults[] = $this->formatRow( $result, $params );
                }

                $this->setIndexedTagNames( $serializedResults );
                $this->addSerializedResults( $serializedResults );
        }

        protected function formatRow( IORMRow $result, array $params ) {
                return $result->toArray( $params['props'] );
        }

        protected function setIndexedTagNames( array &$serializedResults ) {
                $this->getResult()->setIndexedTagName( $serializedResults, $this->getRowName() );
        }

        protected function addSerializedResults( array $serializedResults ) {
                $this->getResult()->addValue(
                        $this->getResultPath(),
                        $this->getListName(),
                        $serializedResults
                );
        }

        public function getAllowedParams() {
                $params = array (
                        'props' => array(
                                ApiBase::PARAM_TYPE => $this->getTable()->getFieldNames(),
                                ApiBase::PARAM_ISMULTI => true,
                                ApiBase::PARAM_REQUIRED => true,
                        ),
                        'limit' => array(
                                ApiBase::PARAM_DFLT => 20,
                                ApiBase::PARAM_TYPE => 'limit',
                                ApiBase::PARAM_MIN => 1,
                                ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
                                ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
                        ),
                        'continue' => null,
                );

                return array_merge( $this->getTable()->getAPIParams(), $params );
        }

        public function getParamDescription() {
                $descriptions = array (
                        'props' => 'Fields to query',
                        'continue' => 'Offset number from where to continue the query',
                        'limit' => 'Max amount of rows to return',
                );

                return array_merge( $this->getTable()->getFieldDescriptions(), $descriptions );
        }

}