Приклади

AnythingRating: Приклади

Приклади виклику сніпета AnythingRating.

Використання

Додайте перший виклик на початку сторінки, для визначення групи рейтингу:

[!AnythingRating? &define=`1` &atrGrp=`grpName`!]

де:

• &define=`1` - вказуємо, що даний виклик сніпета призначений для визначення групи рейтингу
• &atrGrp=`grpName` - ім'я групи рейтингу. Будь-яка комбінація символів AZ, підкреслення і цифр 0-9

Біля предмета (зображення, статті тощо), до якого додаємо голосування розміщуємо такий виклик сніпета:

[!AnythingRating? &atrGrp=`grpName` &atrId=`idItem`!]

де:

• &atrGrp=`grpName` - визначаємо, до якої групи належить наш рейтинг
• &atrId=`idItem` - унікальний ідентифікатор предмета рейтингу. Може бути [*id*] або [+maxigallery.picture.id+] в чанку maxigallery або будь-яким іншим id.

Для виведення ТОП рейтингу використовуємо наступний виклик сніпета:

[!AnythingRating? &getTopRated=`1` &atrGrp=`grpName` &topTable=`site_content` &topTitleField=`pagetitle`!]

де:

• &getTopRated=`1` - вказуємо, що даний виклик призначений для виведення результатів голосування
• &atrGrp=`grpName` - визначаємо групу по якій будемо виводити результати
• &topTable=`site_content` - вказуємо ім'я таблиці, яка містить дані предметів рейтингу. Ім'я таблиці вказується без префікса MODX
• &topTitleField=`pagetitle` -поле, яке використовується в якості назви предмета рейтингу

Ви можете налаштувати зовнішній вигляд результатів голосування за допомогою CSS в файлі css/anythingRating.css. Також ви можете налаштувати форму для голосування в шаблоні templates/anythingRating.tpl.html або форму виведення результатів голосування в шаблоні templates/topRated.tpl.html. Дивіться можливі плейсхолдери для використання в шаблонах.

Визначення рейтингу групи

Це найпростіший приклад виклику - визначає рейтинг групи 'photos':

[!AnythingRating? &define=`1` &atrGrp=`photos`!]

• зберігання всіх IP-адрес тих, хто проголосував за кожним пунктом
• віджет з 5 зірок (визначене за умовчанням файлом CSS)
• дата проведення рейтингу необмежена
• мова встановлена в якості мови менеджера MODX

Цей виклик сніпета визначає рейтинг групи 'travelbook':

[!AnythingRating?
&define=`1`
&atrGrp=`travelbook`
&language=`francais-utf8`
&canVote=`travel`
&nbIP=`200`
&nbStars=`10`
&endDate=`2014-06-30`
&atrTpl=`@FILE:assets/snippets/anythingRating/templates/travelBookTpl.tpl.html`
&atrCss=`@FILE:assets/snippets/anythingRating/css/travelBookCss.css`!]

• &language=`francais-utf8` - мовний пакет Francais-utf8
• &canVote=`travel` - проголосувати можуть тільки веб-користувачі з веб-групи "travel"
• &nbIP=`200` - зберігання до 200 IP-адрес тих, хто проголосував за кожним пунктом
• &nbStars=`10` - віджет і 10 зірок (визначається CSS-файлом)
• &endDate=`2014-06-30` - дата закінчення конкурсу
• travelBookTpl.tpl.html - як файл шаблону
• travelBookCss.css - як CSS-файл

Пункт голосування

[!AnythingRating? &atrGrp=`travelbook` &atrId=`[*id*]`!]

де:

• &atrGrp=`travelbook` - група рейтингу
• &atrId=[*id*] - унікальний ідентифікатор поточного документу

Цей приклад виклику сніпета може використовуватися, наприклад в шаблоні для Ditto:

[[AnythingRating? &atrGrp=`travelbooks` &atrId=`[+id+]` &init=`opinion:[+id+]`]]

де:

• &atrGrp=`travelbook` - група рейтингу
• &atrId=[+id+] - унікальний ідентифікатор поточного документу
• &init=`opinion:[+id+]` - початкове значення рейтингу з TV 'opinion' документу [+id+]

Цей сніпет викликається в шаблоні зображення maxigallery:

[!AnythingRating? &atrGrp=`photos` &atrId=`[+maxigallery.picture.id+]`!]

де:

• &atrGrp=`photos` - група рейтингу
• &atrId=[+maxigallery.picture.id+] - унікальний ідентифікатор зображення, яке ви хочете оцінити

[!AnythingRating? &atrGrp=`products` &atrId=`[*id*]` &noVotes=`1` &init=`opinion`!]

де:

• &atrGrp=`products` - група рейтингу
• &atrId=[*id*] - унікальний ідентифікатор поточного документу
• &noVotes=`1` - голосування забороняється, відображається тільки результат
• &init=`opinion` - ініціалізація голосів від TV 'opinion'

Кращі за рейтингом

Цей сніпет виведе рейтинг документів в конкурсі `travelbook`:

[[AnythingRating? &getTopRated=`1` &atrGrp=`travelbook` &topTable=`site_content` &topTitleField=`pagetitle` &topLabel=`travelbooks`]]

• відображення 5 кращих за рейтингом
• ідентифікатор, назва і опис в рейтингу береться з таблиці"site_content"
• поле ідентифікатора використовується як "ID" за замовчуванням
• назва блоку з результатами рейтингу"travelbooks"
• ім'я поля для назви pagetitle з таблиці"site_content"
• поля з описом, зображенням і посиланням за замовчуванням не використовуються
• шаблон за замовчуванням: assets/snippets/anythingRating/templates/topRated.tpl.html

Цей сніпет виведе рейтинг зображень в конкурсі `photos`:

[!AnythingRating?
&getTopRated=`1`
&topDir=`worst`
&atrGrp=`photos`
&topNb=`3`
&topTpl=`@FILE:assets/snippets/anythingRating/templates/anotherTopRated.tpl.html`
&topTable=`maxigallery`
&topDescrField=`descr`
&topImageField=`filename`
&topLinkField=`gal_id`
&topLabel=`photos`!]

• відображення 3 гірших по рейтингу!
• ідентифікатор, назва і опис в рейтингу береться з таблиці "maxigallery"
• поля для ідентифікатора і назви використовується як 'id' і 'title' за замовчуванням
• назва блоку з результатми рейтингу "photos"
• ім'я поля для опису 'descr' береться з таблиці "maxigallery"
• для посилання використовується поле 'gal_id'
• для зображення використовується поле 'filename'
• шаблон за замовчуванням: assets/snippets/anythingRating/templates/anotherTopRated.tpl.html