+++ /dev/null
-<?php
-
-/**
- * Base query module for querying results from ORMTables.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- * http://www.gnu.org/copyleft/gpl.html
- *
- * @since 1.21
- *
- * @file
- * @ingroup API
- *
- * @license GNU GPL v2+
- * @author Jeroen De Dauw < jeroendedauw@gmail.com >
- */
-abstract class ApiQueryORM extends ApiQueryBase {
-
- /**
- * Returns an instance of the IORMTable table being queried.
- *
- * @since 1.21
- *
- * @return IORMTable
- */
- abstract protected function getTable();
-
- /**
- * Returns the name of the individual rows.
- * For example: page, user, contest, campaign, etc.
- * This is used to appropriately name elements in XML.
- * Deriving classes typically override this method.
- *
- * @since 1.21
- *
- * @return string
- */
- protected function getRowName() {
- return 'item';
- }
-
- /**
- * Returns the name of the list of rows.
- * For example: pages, users, contests, campaigns, etc.
- * This is used to appropriately name nodes in the output.
- * Deriving classes typically override this method.
- *
- * @since 1.21
- *
- * @return string
- */
- protected function getListName() {
- return 'items';
- }
-
- /**
- * Returns the path to where the items results should be added in the result.
- *
- * @since 1.21
- *
- * @return null|string|array
- */
- protected function getResultPath() {
- return null;
- }
-
- /**
- * Get the parameters, find out what the conditions for the query are,
- * run it, and add the results.
- *
- * @since 1.21
- */
- 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 );
- }
-
- /**
- * Get the request parameters and remove all params set
- * to null (ie those that are not actually provided).
- *
- * @since 1.21
- *
- * @return array
- */
- protected function getParams() {
- return array_filter(
- $this->extractRequestParams(),
- function ( $prop ) {
- return isset( $prop );
- }
- );
- }
-
- /**
- * Get the conditions for the query. These will be provided as
- * regular parameters, together with limit, props, continue,
- * and possibly others which we need to get rid off.
- *
- * @since 1.21
- *
- * @param array $params
- *
- * @return array
- */
- 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;
- }
-
- /**
- * Get the actual results.
- *
- * @since 1.21
- *
- * @param array $params
- * @param array $conditions
- *
- * @return ORMResult
- */
- 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__
- );
- }
-
- /**
- * Serialize the results and add them to the result object.
- *
- * @since 1.21
- *
- * @param array $params
- * @param ORMResult $results
- */
- 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 );
- }
-
- /**
- * Formats a row to it's desired output format.
- *
- * @since 1.21
- *
- * @param IORMRow $result
- * @param array $params
- *
- * @return mixed
- */
- protected function formatRow( IORMRow $result, array $params ) {
- return $result->toArray( $params['props'] );
- }
-
- /**
- * Set the tag names for formats such as XML.
- *
- * @since 1.21
- *
- * @param array $serializedResults
- */
- protected function setIndexedTagNames( array &$serializedResults ) {
- ApiResult::setIndexedTagName( $serializedResults, $this->getRowName() );
- }
-
- /**
- * Add the serialized results to the result object.
- *
- * @since 1.21
- *
- * @param array $serializedResults
- */
- protected function addSerializedResults( array $serializedResults ) {
- $this->getResult()->addValue(
- $this->getResultPath(),
- $this->getListName(),
- $serializedResults
- );
- }
-
- /**
- * @see ApiBase::getAllowedParams()
- * @return array
- */
- public function getAllowedParams() {
- $params = array(
- 'props' => array(
- ApiBase::PARAM_TYPE => $this->getTable()->getFieldNames(),
- ApiBase::PARAM_ISMULTI => true,
- ApiBase::PARAM_REQUIRED => true,
- ApiBase::PARAM_HELP_MSG => 'api-orm-param-props',
- ),
- '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,
- ApiBase::PARAM_HELP_MSG => 'api-orm-param-limit',
- ),
- 'continue' => array(
- ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
- ),
- );
-
- return array_merge( $this->getTable()->getAPIParams(), $params );
- }
-
- /**
- * @see ApiBase::getParamDescription()
- * @deprecated since 1.25
- * @return array
- */
- 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 );
- }
-}
dépôts / lhc / web / wiklou.git / commitdiff