AjaxSearch: Основные параметры

Формат: default | custom_example | @FILE
Значение по умолчанию: default
Примечание: Конфигурационные файлы должны вызываться в виде: .config.php. Устанавливаются в папку configs или другую папку через @FILE

Пример:

&config=`example`

Формат: 0 | 1 | 2 | 3
Значение по умолчанию: 0
Примечание:
0 : Режим не активирован.
Файл отчета (ajaxSearch/debug/ajaxSearch_log.txt):
1 : Parameters, search context and sql query logged.
2 : Parameters, search context, sql query AND templates logged
3 : Parameters, search context, sql query, templates AND Results logged

Пример:

&debug=`1`

Формат: chinese | english | finish | francais | german | hebrew | italian | japanese | nederlands | norsk | persian | portuguese | portuguese-br | russian | slovak | spanish | svenska
Значение по умолчанию: язык, установленный для MODX
Примечание: Вы можете самостоятельно добавлять языковые файлы в папку /ajaxSearch/lang/

Пример:

&language=`english`

Формат: 1 | 0
Значение по умолчанию: 1
Примечание: 1 - использовать | 0 - не использовать

Пример:

&ajaxSearch=`0`

Формат: exactphrase | allwords | nowords | oneword
Значение по умолчанию: oneword
Примечание:
exactphrase: предоставляет документы, которые содержат точную фразу
allwords: предоставляет документы, которые содержат все слова
nowords: предоставляет документы, которые не содержат указанных слов
oneword: предоставляет документы, которые содержат хотя бы одно слово

Пример:

&advSearch=`exactphrase`

Формат: a-z, _ , 0-9 (с учетом регистра)
Значение по умолчанию: нет
Примечание: Необходим при многократном (более одного) вызове AjaxSearch на одной странице. Может состоять из: латинских букв (с учетом регистра), цифр, знака подчеркивания.
ВАЖНО! При многократном вызове сниппета на странице в режиме &ajaxSearch=`1` у первого сниппета &asId не используется.

Пример:

&asId=`abc123`

Формат: время в секундах
Значение по умолчанию: 60
Примечание: при значении 0 - в течении неограниченного времени.

Пример:

&timeLimit=`30`

Формат: content:pagetitle,longtitle,description,alias,introtext,menutitle,content | tv:tv_value | jot:jot_content | maxigallery:gal_title,gal_descr,gal_filename
Значение по умолчанию: content|tv
Примечание: Вы можете использовать ключевые слова:
"content" для site_content, "tv" для site_tmplvar_contentvalues, "jot" для jot_content, "maxigallery" для maxigallery.
Формат: keywords:table fields
По умолчанию: content|tv что означает: content:pagetitle,longtitle,description,alias,in trotext,menutitle,content | tv:tv_value
Примеры:
content:null|maxigallery - для поиска только в maxigallery.
content:pagetitle,introtext,content|tv:tv_value|maxigallery:gal_title - поиск по всем основным полям

Пример:

&whereSearch=`content:null|maxigallery`

Формат: [ [ + | - ] [ : tvlist] ] список TV-параметров, разделенный запятой
Значение по умолчанию: все TV-параметры
Примечание:
+: - использовать только эти TV-параметры
-: - исключить эти TV-параметры из поиска
&withTvs=`tv1,tv2,tv3` // поиск по указанным параметрам
&withTvs=`+:tv1,tv2,tv3` // поиск по указанным параметрам
&withTvs=`+` // поиск по всем параметрам
&withTvs=`-:tv1,tv2,tv3` // поиск по всем параметрам кроме этих

Пример:

&withTvs=`tv1,tv2,tv3`

Формат: [ [ + | - ] [ : tvlist] ] список параметров, разделенный запятой
Значение по умолчанию: все параметры
Примечание:
+: - использовать только эти параметры
-: - исключить эти параметры из поиска
&withTvs=`tv1,tv2,tv3` // поиск по указанным параметрам
&tvPhx=`+:tv1,tv2,tv3` // поиск по указанным параметрам
&tvPhx=`+` // поиск по всем параметрам
&tvPhx=`-:tv1,tv2,tv3` // поиск по всем параметрам кроме этих

В коде сниппета другое описание:
&tvPhx - display and set placeHolders for TV (template variables)
0 : disallow the feature
1 : allow the display of all Modx TVs of the document found (default)
'tb_alias:display_function_name[,[tb_alias:display_function_name]*]' : set up placeholders for custom joined tables
Default: 1 - tvPhx allowed for TV only

Пример:

&tvPhx=`tv1,tv2,tv3`

Формат: любое корректное имя TV параметра
Значение по умолчанию: нет
Примечание: Необходимо создать TV параметр с названиями категорий и указать его при вызове сниппета в качестве значения &category.

Пример:

&category=`tv1`

Формат: mixed | unmixed
Значение по умолчанию: unmixed
Примечание: mixed -смешивать, unmixed - не смешивать

Пример:

&display=`mixed`

Формат: разделенный запятыми список параметров с указанием направления сортировки "DESC"
Значение по умолчанию: publishedon, pagetitle (сортировка по дате опубликования, затем по заголовоку документа)
Примечание:

Пример:

&order=`pagetitle DESC, publishedon`

Формат: разделенный запятыми список полей с указанием веса кадждого поля [string[:Integer][|[string[:Integer]]]]
Значение по умолчанию: pagetitle:100,extract
Примечание: Результаты с одинаковым рангом будут отсортированы согласно значению параметра &order

Пример:

&rank=`pagetitle:100,alias:10,extract`

Формат: число от 1 до 10
Значение по умолчанию: 5
Примечание:

Пример:

&maxWords=`7`

Формат: число от 2 до 100
Значение по умолчанию: 3
Примечание: Не применяется при &advSearch = 'allwords', 'oneword' или 'nowords'
Возможно при &advSearch = 'exactphrase' с учетом пробелов
В AjaxSearch 1.9.3 число от 1 до 100.

Пример:

&minChars=`5`

Формат: 0 (false) | 1 (true)
Значение по умолчанию: 1
Примечание: В версии 1.8.4 применяется параметр &AS_showForm

Пример:

&showInputForm=`0`

Формат: 0 (отключить) | 1 (включить)
Значение по умолчанию: 1
Примечание: фраза "Пожалуйста, введите поисковый запрос, чтобы начать поиск" под окном поиска (отображается по умолчанию)

Пример:

&showIntro=`0`

Формат: число:разделенный запятыми список полей
Значение по умолчанию: 1:content,description,introtext,tv_content
Примечание:
n: максимальное количество выдержек
1:content,description,introtext,tv_value - одна выдержка

Пример:

&extract=`99:content`

Формат: 50 < число < 800
Значение по умолчанию: 200
Примечание:

Пример:

&extractLength=`300`

Формат: строка, используемая вместо многоточия для обозначения начала и конца извлечения
Значение по умолчанию: ... (многоточие)
Примечание:

Пример:

&extractEllips=`***`

Формат:
|

---

| другой html тэг
Значение по умолчанию:

Примечание:

Пример:

&extractSeparator=`
`

Формат: любой валидный формат времени, который соответствует правилам функции PHP - strftime
Значение по умолчанию: 'd/m/y : H:i:s' - результат: 21/01/08 : 23:09:22
Примечание:

Пример:

&formatDate=`%d.%m.%Y`

Формат: 0 | 1
Значение по умолчанию: 1
Примечание: Необходимо использовать плагин highligth

Пример:

&highlightResult=`0`

Формат: 0 | 1 (без использования ajax) 1 | 2 (при использовании ajax)
Значение по умолчанию: 1
Примечание:
0: Без постраничного разбиения
1: Previous - X-Y /Z - Next
2: X-Y/Z - больше 10 результатов

Пример:

&pagingType=`0`

Формат: строка
Значение по умолчанию: | (вертикальная черта)
Примечание:

Пример:

&pageLinkSeparator=`-`

Формат: 0 | 1
Значение по умолчанию: 1
Примечание: В версии 1.8.4: &AS_showResults

Пример:

&showResults=`0`

Формат: [ in | not in ] :список ID через запятую
Значение по умолчанию: по всем опубликованным документам
Примечание:
&parents=`in:2,3` поиск только в дочерних ресурсах указанных папок.
&parents=`not in:2,3` поиск по всем документам кроме дочерних ресурсов папок с идентификаторами 2 и 3.
Глубина задается параметром &depth

Пример:

&parents=`in:2,3`

Формат: число больше 0
Значение по умолчанию: 10
Примечание: должен использоваться с &parents

Пример:

&depth=`5`

Формат: [ in | not in ] :список ID через запятую
Значение по умолчанию: по всем опубликованным документам
Примечание:
&documents = `in:28,29,30,31` поиск в документах 28,29,30,31
&documents = `not in:28,29,30,31` поиск во всех документах кроме 28,29,30,31

Пример:

&documents=`in:28,29,30,31`

Формат: 0 | 1 | 2
Значение по умолчанию: 2
Примечание:
0: поиск только в документах, видимых в меню
1: поиск только в документах, не видимых в меню
2: поиск в видимых и невидимых в меню документах

Пример:

&hideMenu=`0`

Формат: 0 | 1
Значение по умолчанию: 1
Примечание:
0: искать в документе с типом ресурса Веб-страница и Веб-ссылка
1: искать в документе с типом ресурса Веб-страница

Пример:

&hideLink=`0`

Формат: Аналогично параметру filter для Ditto 2.1.
Значение по умолчанию:
Примечание:
Аналогично параметру filter для Ditto 2.1.
'#' Метасимвол заменяется строкой поиска, предоставляемого веб-пользователем при использовании параметра фильтра. AdvSearch параметр также принимается во внимание. Если advSearch = 'oneword', 'nowords','allwords' тогда # может применяться вместо множественного фильтра.
Возможен фильтр по TV-параметрам.
&filter=`pagetitle,#,8` при поисковом запросе `school child` при advSearch='oneword' эквивалентно &filter=`pagetitle,school,8|pagetitle,child,8`
&filter=`articleTags,вулкан,7` покажет документы с `вулкан`. Документы отфильтруются по TV-параметру 'articleTags'

Пример:

&filter=`pagetitle,#,8`

Формат: 0 | 1
Значение по умолчанию: 0
Примечание: 0 - стандартный вывод, результаты отображаются под формой поиска
1 - пользовательский вывод с использованием плейсхолдеров [+as.inputForm+] и [+as.results+]

Пример:

&output=`1`

Формат: имя пользовательской PHP функции, определенной в файле конфигурации.
Значение по умолчанию: defaultStripInput
Примечание:

Пример:

&stripInput=``

Формат: имя пользовательской PHP функции, определенной в файле конфигурации.
Значение по умолчанию: defaultStripOutput
Примечание: Before to extract the relevant piece of text around the search term, the document is parsed. By definig a stripOutput function the user could change the output

Пример:

&stripOutput=``

Формат: 0 | строка
Значение по умолчанию:
Примечание: Breadcrumbs is the default function provided for the "content" table. The function name could be followed by some parameter initialization

Пример:

&breadcrumbs=`Breadcrumbs,showHomeCrumb: 0,showCrumbsAtHome:1`

Формат: 1 | 0
Значение по умолчанию: 0
Примечание:
добавить класс "cleardefault" в форму ввода текста и установить этот параметр.
0: не активирован
1: активирован

Пример:

&clearDefault=`1`

Формат: путь к файлу
Значение по умолчанию: js/clearDefault/clearDefault.js
Примечание:

Пример:

&jsClearDefault=``

Формат: 0 (off) | 1 (on)
Значение по умолчанию: 1
Примечание:

Пример:

&mbstring=`0`

Формат: ajaxSearch log [ level [: comment [: Purge]]]
Значение по умолчанию: 0:0:200
Примечание:
level:
0: запретить использование ajaxSearch журнала (по умолчанию)
1: регистрировать неудавшиеся запросы поиска
2: все ajaxSearch запросы заносятся в журнал
comment:
0: комментарии пользователей не допускаются (по умолчанию)
1: комментарии пользователей разрешенены
Purge: число регистраций, до автоматической очистки таблицы
0: неограниченное число регистраций
по умолчанию: 200
&asLog = `x` эквивалентен &asLog = `x:0:200`
&asLog = `x:y` эквивалентен &asLog = `x:y:200`
&asLog = `1:1:500` означает, что возможно 500 неудачных запросов поиска, разрешены комментарии.
Неудавшиеся запросы храниться в таблице ajaxSearch_log

Пример:

&asLog=`1:1:500`