1 files changed, 197 insertions, 0 deletions
diff --git a/www/wiki/extensions/SemanticMediaWiki/src/MediaWiki/Api/BrowseByProperty.php b/www/wiki/extensions/SemanticMediaWiki/src/MediaWiki/Api/BrowseByProperty.php
new file mode 100644
index 00000000..23c87ed6
--- /dev/null
+++ b/www/wiki/extensions/SemanticMediaWiki/src/MediaWiki/Api/BrowseByProperty.php
@@ -0,0 +1,197 @@
+<?php
+
+namespace SMW\MediaWiki\Api;
+
+use ApiBase;
+use SMW\ApplicationFactory;
+use SMW\Localizer;
+use SMW\NamespaceUriFinder;
+
+/**
+ * @license GNU GPL v2+
+ * @since 2.4
+ *
+ * @author mwjames
+ */
+class BrowseByProperty extends ApiBase {
+
+	/**
+	 * #2696
+	 * @deprecated since 3.0, use the smwbrowse API module
+	 */
+	public function isDeprecated() {
+		return true;
+	}
+
+	/**
+	 * @see ApiBase::execute
+	 */
+	public function execute() {
+
+		$params = $this->extractRequestParams();
+		$applicationFactory = ApplicationFactory::getInstance();
+
+		$propertyListByApiRequest = new PropertyListByApiRequest(
+			$applicationFactory->getStore(),
+			$applicationFactory->getPropertySpecificationLookup()
+		);
+
+		$propertyListByApiRequest->setLimit(
+			$params['limit']
+		);
+
+		$propertyListByApiRequest->setListOnly(
+			$params['listonly']
+		);
+
+		if ( ( $lang = $params['lang'] ) === null ) {
+			$lang = Localizer::getInstance()->getUserLanguage()->getCode();
+		}
+
+		$propertyListByApiRequest->setLanguageCode(
+			$lang
+		);
+
+		$propertyListByApiRequest->findPropertyListBy(
+			$params['property']
+		);
+
+		foreach ( $propertyListByApiRequest->getNamespaces() as $ns ) {
+
+			$uri = NamespaceUriFinder::getUri( $ns );
+
+			if ( !$uri ) {
+				continue;
+			}
+
+			$this->getResult()->addValue(
+				null,
+				'xmlns:' . $ns,
+				$uri
+			);
+		}
+
+		$data = $propertyListByApiRequest->getPropertyList();
+
+		// I'm without words for this utter nonsense introduced here
+		// because property keys can have a underscore _MDAT or for that matter
+		// any other data field can
+		// https://www.mediawiki.org/wiki/API:JSON_version_2
+		// " ... can indicate that a property beginning with an underscore is not metadata using"
+		if ( method_exists( $this->getResult(), 'setPreserveKeysList') ) {
+			$this->getResult()->setPreserveKeysList(
+				$data,
+				array_keys( $data )
+			);
+		}
+
+		$this->getResult()->addValue(
+			null,
+			'query',
+			$data
+		);
+
+		$this->getResult()->addValue(
+			null,
+			'version',
+			2
+		);
+
+		$this->getResult()->addValue(
+			null,
+			'query-continue-offset',
+			$propertyListByApiRequest->getContinueOffset()
+		);
+
+		$this->getResult()->addValue(
+			null,
+			'meta',
+			$propertyListByApiRequest->getMeta()
+		);
+	}
+
+	/**
+	 * @codeCoverageIgnore
+	 * @see ApiBase::getAllowedParams
+	 *
+	 * @return array
+	 */
+	public function getAllowedParams() {
+		return [
+			'property' => [
+				ApiBase::PARAM_TYPE => 'string',
+				ApiBase::PARAM_ISMULTI => false,
+				ApiBase::PARAM_REQUIRED => false,
+			],
+			'limit' => [
+				ApiBase::PARAM_TYPE => 'string',
+				ApiBase::PARAM_ISMULTI => false,
+				ApiBase::PARAM_DFLT => 50,
+				ApiBase::PARAM_REQUIRED => false,
+			],
+			'lang' => [
+				ApiBase::PARAM_TYPE => 'string',
+				ApiBase::PARAM_ISMULTI => false,
+				ApiBase::PARAM_REQUIRED => false,
+			],
+			'listonly' => [
+				ApiBase::PARAM_TYPE => 'string',
+				ApiBase::PARAM_DFLT => false,
+				ApiBase::PARAM_ISMULTI => false,
+				ApiBase::PARAM_REQUIRED => false,
+			]
+		];
+	}
+
+	/**
+	 * @codeCoverageIgnore
+	 * @see ApiBase::getParamDescription
+	 *
+	 * @return array
+	 */
+	public function getParamDescription() {
+		return [
+			'property' => 'To match a specific property',
+			'limit'    => 'To specify the size of the list request',
+			'lang'     => 'To specify a specific language used for some attributes (description etc.)',
+			'listonly' => 'To specify that only a property list is returned without further details'
+		];
+	}
+
+	/**
+	 * @codeCoverageIgnore
+	 * @see ApiBase::getDescription
+	 *
+	 * @return array
+	 */
+	public function getDescription() {
+		return [
+			'API module to query a property list or an individual property.'
+		];
+	}
+
+	/**
+	 * @codeCoverageIgnore
+	 * @see ApiBase::getExamples
+	 *
+	 * @return array
+	 */
+	public function getExamples() {
+		return [
+			'api.php?action=browsebyproperty&property=Modification_date',
+			'api.php?action=browsebyproperty&limit=50',
+			'api.php?action=browsebyproperty&limit=5&listonly=true',
+		];
+	}
+
+	/**
+	 * @codeCoverageIgnore
+	 * @see ApiBase::getVersion
+	 *
+	 * @return string
+	 */
+	public function getVersion() {
+		return __CLASS__ . '-' . SMW_VERSION;
+	}
+
+}