Параметри

Формат: 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
Примітка: Перш ніж витягти відповідний фрагмент тексту навколо пошукового терміна, документ аналізується. Визначивши функцію stripOutput, користувач міг змінити вихід

Приклад:

&stripOutput=``

Формат: 0 | рядок
Значення за замовчуваннямю:
Примітка: Панірувальні сухарі - це функція за замовчуванням передбачено для таблиці "зміст". Функція за ім'ям може слідувати якийсь параметр ініціалізація

Приклад:

&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`