Download the PHP package heimrichhannot/contao-search-bundle without Composer

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

Informations about the package contao-search-bundle

Contao Search Bundle

This bundle contains enhancements for Contao Search. You can enable or disable all functionality to pick up just the features you need.

Features

Usage

Install

  1. Install composer bundle: composer require heimrichhannot/contao-search-bundle
  2. Optional: Install guzze HTTP client: composer require guzzlehttp/guzzle (needed for rebuild search index command)
  3. Optional: Install Smalot PdfParser: "smalot/pdfparser": "^2.3" (needed for pdf search, minimum supported version is 0.18.2)
  4. Enable/Disable features you want in your project config (see chapter configuration) and clear your cache
  5. Update your database

Maximum number of search terms

  1. Be sure huh_search.disable_max_keyword_filter is set to false (is false by default)

  2. Set maximum number of keywords to a value higher than 0 to enable

  3. If you want to output a user notice if the max keyword count is exceeded, select mod_search_searchbundle module template or output $this->maxKeywordsExceededMessage template variable where you like.
  4. If you need to support a language with special letters like german umlauts, you can pass additional chars to the huh_search.valid_word_chars option to get a correct word count. By default, the german umlauts and eszett are preconfigured. Keep in mind, that you override the default value by setting this option (so you need to add them in your config if you want to support them).

Example:

  1. If you want to customize the message, overwrite the translations keys for huh_search.module.max_keywords_exceeded_message (Symfony translations used). %count% (number of provided keywords) and %max% (max allowed number of keywords) are provided as placeholder values.

Filter your search results by page

  1. Enable huh_search.enable_search_filter in your config (enabled by default)

  2. Create or edit your search engine module and setup the search filter section as you like

Related search content element

This element is basically the content hyperlink element (also uses the same templates) but with the twist, that it keeps the search parameters. It's designed for use together with news filter to link to another search module with a different filter config.

  1. Create a Related search link content element on a page with an search module
  2. Set another page with a search module as target

Search keyword log

To log search keywords, just set huh_search.enable_search_log to true. Afterwards you'll find huh_search_log-files withing your log folder containing a csv-formatted list of datetime and keyword. Maximum 7 days are stored (you can alter this period by customizing the monolog settings for huh_search_log channel).

Pdf search

To enable pdf indexing for contao search, following steps are needed:

  1. Set huh_search.pdf_indexer.enabled to true

  2. Add "smalot/pdfparser": "^0.18" as composer dependency
  3. Rebuild search index

For more configuration options for the pdf indexer see the configuration reference.

Configuration

Complete configuration reference

Acknowledgments

The pdf search integration was sponsored by fanthomas communications.

All versions of contao-search-bundle with dependencies

PHP Build Version
Package Version
Requires php Version ^8.0
contao/core-bundle Version ^4.13 || ^5.0
heimrichhannot/contao-utils-bundle Version ^2.134 || ^3.0
symfony/config Version ^5.4 || ^6.0
symfony/console Version ^5.4 || ^6.0
symfony/deprecation-contracts Version ^1.0 || ^2.0 || ^3.0
symfony/event-dispatcher-contracts Version ^1.0 || ^2.0 || ^3.0
symfony/http-kernel Version ^5.4 || ^6.0
symfony/polyfill-php80 Version ^v1.27.0
symfony/translation-contracts Version ^1.0 || ^2.0 || ^3.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 heimrichhannot/contao-search-bundle contains the following files

Loading the files please wait ....