Избранное v.2.0

Здравствуйте.

Вышла в свет очередная версия, хотя не очередная, а новая, это более подходящее слово для InstantCMS 2.3.0. Система стала полностью открытым продуктом со своим репозиторием на GitHub и группой энтузиастов-разработчиков которые внесли свой небольшой, но не менее ценный вклад в развитие системы. И первые плоды такого шага не заставили себя долго ждать. За время публикации проекта на GitHub внесено более 100 коммитов из них только за последний месяц было модифицировано 99 файлов системы, а это, ни много ни мало, более 2400 строк дополнений в коде и 1500 удалений. Всё это позволило InstantCMS стать более стабильной, быстрой, безопасной и просто удобной в использовании.
Так вот к чему это я всё?! Теперь ядро системы позволяет сделать то, чего раньше было не предусмотрено, а именно этого я так долго ждал, чтобы выпустить обновление компонента “Избранное”. Всех кому интересно что получилось в итоге

Теперь ближе к телу...

Компонент, как и ранее, предназначен для хранения пользователями сайта записей различных типов контента (статьи, посты, новости, фотоальбомы и др.). Списки выбранных записей территориально располагаются в профиле пользователя под табом “Избранное”. Также пользователь может добавлять свои теги для записей, чей тип контента предусматривает наличие тегов, по-просту говоря, для типов контента, в настройках которых указана галочка “Включить теги”:

Что нового:

Учёт тегов в избранных записях.
Добавление пользовательских тегов в избранное.
Виджет тегов избранного.
Возможность посмотреть список пользователей, которые добавили запись в избранное.
Общий вид компонента теперь более соответствует стилю дефолтного шаблона.

Исправления:

Работа компонента с кэшем. Теперь кэш своевременно очищается и нет никаких задержек между добавлением записи в избранное и ее просмотром в списке избранного.
Корректный вывод страницы, если в записи нет комментариев. Прощай белый экран =)
Многочисленный клик по ссылке избранного.
Различного рода удаления записи, комментария или пользователя из админки. Компонент получает уведомления посредством хуков и чистит нужное у себя в БД.
другие мелкие и не очень исправления. В общем всё, что указано здесь в комментариях и даже больше.

Для тех кто не любит читать — всё (или почти всё) нижеописанное в небольшом скринкасте:

Как поставить.

Установка дополнения стандартна в основной своей части и своеобразна в интеграционной составляющей.
Скачиваем компонент ниже по ссылке и следуем инструкциям описанным здесь: http://docs.instantcms.ru/manual/addons. Затем самое сложное. Компонент установлен в вашу систему, но его необходимо отобразить пользователю, чтобы он мог с ним взаимодействовать. Для этого в файлах шаблона нужно прописать где компонент, а точнее виджет избранного, должен выводиться. Поэтому в ручную добавляем:
для файлов вывода контента (..\templates\default\content\)
albums_list.tpl.php — 128 строка
default_item.tpl.php — 139 строка (или 141 после добавления формы тегов, см. ниже)
default_list.tpl.php — 137 строка
default_list_featured.tpl.php — 137 строка
default_list_tiles.tpl.php — 115 строка

Т.е. здесь мы добавляем кнопку избранного в элемент <div class="info_bar">...</div>, в котором также выводятся виджет рейтинга, никнейм автора записи, указатель колличества комментариев к записи, блок шаринга и др. информация.


Для шаблона вывода контента таблицей (по умолчанию используется в объявлениях) код немного изменяется:
default_list_table.tpl.php
вставляется в 25 строку (это заголовок таблицы, добавляем чтобы не поехала вёрстка).
эта часть добавляется в 62 строку (сам виджет избранного).

Теперь добавим возможность формы редактирования пользовательских тегов.
дописываем
сразу за кодом вывода тегов записи $item['tags']:
Для большей красоты вставляем $item['favorite_tags'] сразу за $item['tags'] без пробелов! Те кто в курсе про inline элементы поймут =)
Должно получиться так:
Это делается в файлах
albums_list.tpl.php — 95 строка
default_item.tpl.php — 90 строка
default_list.tpl.php — 87 строка
default_list_featured.tpl.php — 94 строка

И сама форма редактирования тегов. Добавляем код
в albums_list.tpl.php — 144 строка
default_item.tpl.php — 94 строка
default_list.tpl.php — 149 строка
default_list_featured.tpl.php — 149 строка
В принципе здесь не особо критично куда добавить форму, главное не кинуть её в цикл, чтобы она не дублировалась много раз (её одной на страницу вполне будет достаточно).

Последняя небольшая правочка для комментариев.
Добавляем код
в 64 строку файла ..\templates\default\controllers\comments\comment.tpl.php

Для дефолтного шаблона я подготовил все необходимые файлы с внесенными изменениями, скачать его можно ниже по ссылке.

Переходим к настройке компонента.

В панели администратора идём в раздел компонентов и выбираем “Избранное”.

На вкладке “Опции” устанавливаем галочки рядом с типом контента который можно будет добавлять в избранное. Чтобы разрешить выбор в избранное комментариев, устанавливаем галочку “Включить добавление комментариев в избранное”. И при необходимости отмечаем “Показывать пользователей добавивших запись в избранное”.
Жмём кнопку “Сохранить” и переходим на вкладку “Доступ”.

Здесь отмечаем каким группам пользователей разрешено пользоваться компонентом. Жмём “Сохранить” и идём в раздел “Виджеты”.
Находим в левой колонке папку “Профили пользователей”, а в ней выбираем “Профиль пользователя”. И в правой колонке в списке виджетов, группе “Избранное” перетаскиваем виджет “Теги избранного” в желаемую позицию на шаблоне. Я предпочел сайдбар, сразу после вывода меню пользователя.

На этом шаге долгая и утомительная установка этого злосчастного дополнения закончена!


Тем кто будет обновляться со старой версии компонента, необходимо к вышеописанным операциям провести еще одну — обновление таблицы избранного БД, сопоставление тегов избранного и удаление лишних записей избранного в БД. Для этого под учётной записью администратора необходимо перейти по ссылке ваш_сайт/favorites/repair и дождаться окончания выполнения всех операций.

Что дальше:

В планах стоят некоторые доработки по кодовой базе, и также есть еще несколько фич, которые хочу сделать. Поэтому когда будет достаточно свободного времени и возможности сяду за реализацию всего задуманного.



Файлы вывода контента для дефолтного шаблона с внесенными правками

демо-данные:
e-mail: demo@demo.ru
pw: 123456

Внимание!

В компонент внесены небольшие исправления устраняющие ряд недочётов. Просьба скачать дополнение v.2.0.1 и обновиться. Для обновления с версии 2.0 достаточно заменить файлы из папки package.

Всем удачи!

P.S. наверное это самый избранный пост по количеству слова “избранное” в тексте