Download the PHP package coldtrick/opensearch without Composer

On this page you can find all versions of the php package coldtrick/opensearch. 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?

Informations about the package opensearch

OpenSearch

Elgg 6.0 OpenSearch 2.5 Lint Checks Latest Stable Version License

An OpenSearch implementation for Elgg

Requirements

A working OpenSearch server is required. Also the minute cron has to be working on your Elgg installation. The minute cron is used to update the index with all the required changes (create/update/delete).

The current supported version of OpenSearch is: 2.5.x

Configuration

Settings

The plugin settings allow you to configure the following:

Index Management

The index management page (found under Administer -> OpenSearch -> Indices in the admin sidebar) allows you to perform various actions on all the indexes available on the OpenSearch server. The following actions are supported:

Administration

Log files

Based on the log level of your Elgg site, there will also be logging of the OpenSearch PHP client library. Logging will appear in the same location as all other Elgg logs.

Statistics

You can find various statistics on the Administer -> OpenSearch -> Statistics page. Elgg statistics report on the amount of entities found in the Elgg database that should be in the index. It also reports on the amount of entities that need to be added/updated/deleted in the index and that are currently waiting on the minute cron to process them.

Also some statistics from the OpenSearch Cluster are shown like the status and the version information.

You can also find statistics for all available indexes on this page.

CLI commands

CLI commands are available to be used with the default elgg-cli command

opensearch:rebuild

This command will rebuild the current OpenSearch index with new configuration and/or mappings. This only works when there is an active index. Only use this command when a change was made to the index configuration and/or mappings.

opensearch:sync

This command will synchronize all pending entities to the OpenSearch index. This is especially usefull during the reindexing process of the database because a lot of entities need to be indexed. Using the normal cron task in this case could take a long time.

Recommendations

Use the Search Advanced plugin to add extra features to search. If both are enabled this plugin provides a menu to sort/order the results.

Developers

Plugin events

'boostable_types', 'opensearch'

Return an array of type.subtype to be used for configuring boosting in OpenSearch.

In the format:

Defaults to the registered searchable type/subtypes for OpenSearch.

'config:index', 'opensearch'

Return an array with the index configuration to be used by OpenSearch.

'config:mapping', 'opensearch'

Return an array with the mapping configuration to be used by OpenSearch.

'export:counters', 'opensearch'

Return an array of counters to be exported to OpenSearch.

In the format:

Params contain:

'export:metadata_names', 'opensearch'

Return an array of metadata names to be exported to OpenSearch.

Params contain:

'export:relationship_names', 'opensearch'

Return an array of relationship names to be exported to OpenSearch.

Params contain:

'index_entity_type_subtypes', 'opensearch'

Return an array of type/subtypes allowed to be indexed by OpenSearch.

In the format:

Defaults to all registered searchable type/subtypes in Elgg.

'index:entity:prevent', 'opensearch'

Return true if the provided entity shouldn't be added to the OpenSearch index

Params contain:

Default: false

'index:entity:type', 'opensearch'

Return a string under which type/subtype the entity should be indexed. This is used for type filtering during the search (eg. all blogs)

Params contain:

Default: {entity_type}.{entity_subtype} (eg. object.blog)

'params', 'opensearch'

Return an array of parameters to be using in initializing the \ColdTrick\OpenSearch\Client OpenSearch client.

'search', 'type_subtype_pairs'

Return an array of type/subtypes allowed to be searched by OpenSearch.

In the format:

Defaults to all registered searchable type/subtypes in Elgg.

'search_params', 'opensearch'

Return an \ColdTrick\OpenSearch\Di\SearchService to be used for the search. This allows you to alter the search parameters in opensearch.

Params contain:

'to:entity:before', 'opensearch'

Change the OpenSearch hit data before it's converted to an ElggEntity

Params contain:

'to:entity', 'opensearch'

Return an ElggEntity based on the search result data from OpenSearch.

Params contain:

Parameters passed to elgg_search

field_boosting

In the parameters passed to elgg_search you can add a configuration to control field boosting in OpenSearch. Add the key field_boosting to the array which holds an array with field-name and the boosting for that field.

Example:


All versions of opensearch with dependencies

PHP Build Version
Package Version
Requires opensearch-project/opensearch-php Version ^2.0.0
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 coldtrick/opensearch contains the following files

Loading the files please wait ....