Download the PHP package vulcandigital/silverstripe-search without Composer

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

Informations about the package silverstripe-search

silverstripe-search

This module is a single-line search replacement concept for SilverStripe that enables the use of tanks

Requirements

Installation

Getting Started

"What becomes searchable" would be the biggest question, and the answer is:

Any DataObject or subclass that has the SearchIndexExtension enabled

1. Apply the extension

To apply the extension to the DataObject add the following configuration properties:

Note: Currently does not support Dot Notation on has_many or many_many relationships

Afterwards, make sure you dev/build and ?flush.

2. Build the index

If you have just applied the extension to a DataObject or Page with existing records, you should then run the Build Search Index Manifest task from dev/tasks to index existing records

As new records are added to a DataObject they will also be indexed. When a record is deleted, the index entry will be deleted also

If the DataObject is Page, new records will only be indexed if the page is published, and unindexed when the page is unpublished or deleted

3. Create the search page

Open up the CMS, and create a new SearchPage. This can be a root item or a child of any other page

  1. Switch to the "Search" tab
  2. Select the appropriate tank for the page (default is "Main")
  3. Save & Publish the page
  4. Begin searching for results within that tank

If you would like to have multiple search pages where the records being searched differ, then you need to specify a unique index tank name for that DataObject (by default, the Main tank will be used):

This would ensure all records within that DataObject are stored under a custom tank identifier where that tank can be assigned to a particular SearchPage.

This module ships within a default SearchPage page type. The provided template is for example only and you should create your own override for it.

Renaming the filter title

If you want to change the name that appears for the search filter you will need to add the following to your DataObject/Page:

Result item rendering

You may want to render your results differently based on what classes they represent (as in the preview image above).

In order to do this for the above Recipe class you must create the following folder structure in your theme directory:

Then within that folder you can create a new template called RenderRecipe.ss. That template is passed (at a top level) complete access to everything in a single result:

FAQ

I cannot see existing records for my class in the search
Solution 1. ?flush=1
Solution 2. If you have applied the extension to a class that already has existing records, you should then run the Build Search Index Manifest task from dev/tasks

I'm seeing results for records that no longer exist
This should not occur, however if it does. You can run the Search Index Maintenance task from dev/tasks

License

BSD 3-Clause © Vulcan Digital Ltd

All versions of silverstripe-search with dependencies

PHP Build Version
Package Version
Requires silverstripe/framework Version ^4.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 vulcandigital/silverstripe-search contains the following files

Loading the files please wait ....