Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/heimrichhannot/contao-search-bundle

This bundle contains enhancements for Contao Search.
https://github.com/heimrichhannot/contao-search-bundle

contao pdf search

Last synced: about 1 month ago
JSON representation

This bundle contains enhancements for Contao Search.

Awesome Lists containing this project

README 

        
# Contao Search Bundle



[![](https://img.shields.io/packagist/v/heimrichhannot/contao-search-bundle.svg)](https://packagist.org/packages/heimrichhannot/contao-search-bundle)

[![](https://img.shields.io/packagist/dt/heimrichhannot/contao-search-bundle.svg)](https://packagist.org/packages/heimrichhannot/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

* pdf search

* set maximum number of search terms

* Page filter for search module

* Related search content element

* log search terms



## Usage



### Install



1. Install composer bundle: `composer require heimrichhannot/contao-search-bundle`

1. Optional: Install guzze HTTP client: `composer require guzzlehttp/guzzle` (needed for rebuild search index command)

1. Optional: Install Smalot PdfParser: `"smalot/pdfparser": "^2.3"` (needed for pdf search, minimum supported version is 0.18.2)

1. Enable/Disable features you want in your project config (see chapter configuration) and clear your cache

1. 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)

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



    ![Search engine module max keyword input](docs/images/screenshot_max_keywords.png)

    

1. 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.

1. 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: 

```php

// mod_search.html5



maxKeywordsExceededMessage): ?>

    
= $this->maxKeywordsExceededMessage ?>



header): ?>

    
= $this->header ?> (= $this->duration ?>)



```



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)

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



    ![Search engine module filter section](docs/images/screenshot_page_filter_module.png)



### 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

1. 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

    ```yaml

   # config/config.yml (Contao 4.9) or app/Resources/config.yml (Contao 4.4)

    huh_search:

      pdf_indexer:

        enabled: true

    ```



1. Add `"smalot/pdfparser": "^0.18"` as composer dependency

1. Rebuild search index



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



## Configuration



Complete configuration reference



```yaml

# Default configuration for extension with alias: "huh_search"

huh_search:



   # Configure the pdf indexer.

   pdf_indexer:



      # Enable pdf indexing for search.

      enabled:              false



      # Max characters to process and store from a pdf file. 0 means no limit.

      max_indexed_characters: 2000



      # Maximum file size of a pdf that can be processed by the pdf parser to prevent memory overflow or process timeout. Specify in KiB. 0 means no limit. 1024KiB = 1MB.

      max_file_size:        8096



   # Enable or disable search filter for search module

   enable_search_filter: true



   # Enable or disable max keyword filter for search module

   disable_max_keyword_filter: false



   # Enable a search keyword logging.

   enable_search_log:    false



   # Set additional chars that should be not break a word (used for charlist parameter of str_word_count function).

   valid_word_chars:     ÄäÖöÜüẞß

```



## Acknowledgments



The pdf search integration was sponsored by [fanthomas communications](https://fanthomas-communications.de/).