sunzinet/sz-quickfinder

SzQuickfinder - Quickfinder Plugin from SUNZINET GmbH

Maintainers

Details

github.com/sunzinetAG/sz-quickfinder

Homepage

Source

Installs: 25 755

Dependents: 0

Suggesters: 0

Security: 0

Stars: 3

Watchers: 2

Forks: 4

Type:typo3-cms-extension

6.2.0 2023-06-21 13:34 UTC

Requires

Requires (Dev)

GPL-3.0-or-later 6bdef52b4706cdf97be7a0c8d76f74759953aa08

  • Dennis Römmich

searchautocompleteQuickfinder

This package is auto-updated.

Last update: 2024-04-15 14:13:46 UTC

README

Installation

  1. Run 
    composer req sunzinet/sz-quickfinder
  2. Activate sz-quickfinder in the Extens**ionmanager
  3. Include TypoScript
  4. Include sz-quickfinder in your template. Example:
lib.contents {
  pageSearch =< lib.tx_szquickfinder
}

Settings:

Type Default
homePageUid integer 2
searchPid integer 140
newsPid integer 28
regEx string %|%
maxResults integer 3
includeNavHiddenPages bool false
orderBy string uid
ascending bool true
customSearch
class string
searchFields searchFields
blacklistPid string

All settings can be overridden in 'customSearch' section.

Important notes:

It's required to give a data-attribute to the body-tag called "data-languid" with the current sys_language_uid to make multilingualism work.

page {
  bodyTagCObject = COA
  bodyTagCObject {
    10 = TEXT
    10.value = default
    10.stdWrap.noTrimWrap = |language-| |

    stdWrap.trim = 1
    stdWrap.dataWrap = <body class="|" data-languid="{sitelanguage:languageId}">
  }
}

Known problems:

  • Autocomplete doesn't work correctly on detail pages (e.g. tx_news). Workaround: Set $GLOBALS['TYPO3_CONF_VARS']['FE']['pageNotFoundOnCHashError'] = false
  • Search won't be executed on any page if pageNotFoundOnCHashError activated. Use $GLOBALS['TYPO3_CONF_VARS']['FE']['cacheHash']['excludedParameters']

PHPUnit Tests:

composer install
./vendor/bin/phpunit -c Tests/phpunit.xml

Todos:

  • Redesign interfaces for example:
    • interface SearchResult
    • interface PageResult implements SearchResult
    • interface FileResult implements SearchResult
    • interface NewsResult implements SearchResult