Download the PHP package suilven/freetextsearch without Composer

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

Free Text Search

Build Scrutinizer Code Quality codecov.io

Latest Stable Version Total Downloads License Monthly Downloads Daily Downloads composer.lock

GitHub Code Size GitHub Repo Size GitHub Last Commit GitHub Activity GitHub Issues

This module allows configuration of freetext search indexes, and provides tools to create indexes and reindex them. By default only a sitetree index is configured, but one can add indexes for subclasses of SiteTree (e.g. a BlogPost) or a DataObject only index, e.g. flickr photos. The template for rendering the search results can also be overridden.

Note that one also has to install an implementation, currently only one for Manticore Search (formerly Sphinx) exists, package name is suilven/silverstripe-manticore-search

Configuration

Indexes

By default the core fields of SiteTree are indexed. You can override as follows to allow for third party modules or your own. Each index should map to a model class, and the field names match those in the database.

An example follows, code can be found at https://github.com/gordonbanderson/flickr-editor/tree/upgradess4

The above is compulsory. Additional indexes start here.

The name of the index

The class of DataObject being indexed

These fields are indexed as free text.

It is not always desirable to show highlights from all of the fields, this is a filter list of fields to render highlights from in search results.

These fields are stored but not searchable. Their function is to provide fields to render in the search results, and avoid hydrating objects from the database. Note that Link is a hybrid field, the existence of a Link() method is checked for at indexing time and the field added if the method exists.


The following indexes correctly with Manticoresearch, but note that the ManticoreSearch PHP client does not currently allow for facetted searching. It is in pipeline though. Raw queries show facetted groups returned, but it makes sense to wait for this to be implemented in the PHP client instead.

Fields that can be used for facetted searching.

Have one fields are effectively another facet.

This example shows how to index a has many field, tags, for facetting. Each entry has 3 fields:

Extensions

Any class referenced in indexes configuration needs the following extension, Suilven\FreeTextSearch\Extension\IndexingExtension, added. This performs one of two jobs: 1) Index a DataObject immediately after it's been saved 2) /or mark a DataObject as dirty and add a job to the queue to process the indexes affected.

Indexing Mode

In the site configuration there is an additional tab called Free Text Search. It contains two fields:

Install

Via Composer

Usage

Indexing

Note that these commands require an implementation of freetextsearch.

Creating an Index

Change the name of the index as appropriate. Note that when this command is run, the contents of the index will be dropped, and a reindex will be required.

Reindexing an Index

Change the name of the index as appropriate. This will reindex in bulk.

Adding a Search Page for an Index

In the CMS add a page of type Search Page. The following fields are editable:

The following are related to facets and not yet implemented:

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

Contributing

Please see CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.


All versions of freetextsearch with dependencies

PHP Build Version
Package Version
Requires php Version ~7.1
league/climate Version ^3.5
silverstripe/cms Version ^4
symbiote/silverstripe-queuedjobs Version ^4.5
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 suilven/freetextsearch contains the following files

Loading the files please wait ....