Download the PHP package mediawiki/opensearch-query without Composer

On this page you can find all versions of the php package mediawiki/opensearch-query. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of mediawiki/opensearch-query

Informations about the package opensearch-query

Extension for querying OpenSearch indices within a MediaWiki instance.

Formerly known as CouchDB_Query. See docs/migration-from-couchdb.md if you are upgrading from the CouchDB-backed version.

Requirements

Installation

  1. Clone or download this extension into your MediaWiki extensions/ directory:

  2. Add the following to the bottom of your LocalSettings.php:

  3. Configure the OpenSearch connection in LocalSettings.php after the wfLoadExtension line:

  4. Define the named queries your wiki will use. A view-equivalent query names an index and the field that plays the role of a CouchDB view key; a full-text query names an index and the fields to search:

    queries[$db][$index] also accepts a plain string, treated as [ 'index' => <string> ], for the simplest case.

  5. Single-document fetches (#OpenSearch_Query_field-style lookups by id) use a separate connection block, since it is often a different index or cluster:

  6. When a hit's _id does not resolve to a MediaWiki page id (full-text results from a document store keyed some other way), name the _source field to use as the page name instead:

Usage

Two parser functions are available in wiki pages:

{{#OpenSearch_Query_table:}}

Renders a dynamic table populated from an OpenSearch query.

Parameter Description
index Query name, resolved against queries[$db]
db Connection identifier, resolved against params[$db] (default: current wiki's DB name)
type API action to call: opensearch-query (view-equivalent) or opensearch-search (full text). The legacy couchdb-query, couchdb-lucene-query, couchdb-nouveau-query values still work.
limit Maximum rows to return (default: 25)
fields Comma-separated list of fields to display. Supports * (page name), *link, #link (link with @... and Namespace: stripped from the label), *score, ~field (field rendered as a link), #field (as ~field, but also strips @.../Namespace: from the label)
raw Comma-separated list of field names to render unescaped. All other field values are HTML-escaped by default
query Query template. $1 is replaced with the current search text; javascript:funcName dispatches to window.opensearchjsfunc.funcName(text) (falls back to the legacy window.couchjsfunc)
text Initial value for the search input
start / end Passed through as startkey / endkey for view-equivalent queries
header Column header label(s), comma-separated (default: Page name)
class CSS class for the table (default: wikitable sortable jquery-tablesorter)
prefix field:value,... - prepends value: to the named field before display
prefixurl field:urlbase,... - link base to use for ~field / #field
prefixcondurl field:otherfield@value=urlbase,... - link base for ~field / #field, chosen by the value of another field in the same result
extra Comma-separated list of CSS selectors pointing at {{#OpenSearch_Query_field}} elements elsewhere on the page whose values are appended to the query
full Set to 1 to retrieve the complete result set (paged internally via search_after) and paginate client-side

{{#OpenSearch_Query_field:}}

Renders an input field that can be wired into a table's extra list.

Parameter Description
tag HTML tag to render (input, select, etc.)
type Input type attribute
query Query fragment substituted with this field's value and appended to the parent table's query
values Predefined values, comma-separated (for select)
id Element ID
class CSS class (currently not applied to the rendered element - see docs/migration-from-couchdb.md)
default Default selected value (for select)

API Modules

Module Action Description
opensearch-query api.php?action=opensearch-query View-equivalent query: key / keys / startkey / endkey against keyfield
opensearch-search api.php?action=opensearch-search Full-text query_string search over textfields
opensearch-document api.php?action=opensearch-document Retrieve a single document by id
couchdb-query, couchdb-lucene-query, couchdb-nouveau-query, couchdb-document same paths Deprecated aliases of the above, kept for existing callers. Marked isDeprecated().

opensearch-query params: index, db, key, keys (JSON array), startkey, endkey, fields, limit, skip, include_docs. Response: { status, count, results[], groups[]? }, each result { id, pagename, fields }.

opensearch-search params: index, db, q, limit, skip, sort, full. Response: { status, count, results[], warning? }, each result { id, score, pagename, fields }. A malformed q (e.g. partially typed query_string syntax) yields count: 0 plus a warning, not an API error.

opensearch-document params: db, key. Response: { status, count, results[] }, the single result being the document's _source flattened alongside its _id.

TODO

All versions of opensearch-query with dependencies

PHP Build Version
Package Version
Requires php Version >=7.4
composer/installers Version >=1.0.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package mediawiki/opensearch-query contains the following files

Loading the files please wait ...