Справка по плагину Friendly URLs

Установка плагина (инсталляция)

Инсталляция происходит классическим способом (копирование в папку plugins и включение плагина на странице управления плагинами в админ-панели). Настройка заключается в задания шаблонов для адресов страниц (смотрите страницу опций плагина). Кроме этого обязательно нужно в настройках движка нужно запретить использование синонимов страниц. Для этого откройте на редактирование файл \application\config\mso_config.php и задать следующие значения параметрам:

$config['mso_permalink_no_slug'] = "no"; // полностью отключить синонимы 
$config['mso_permalink_slug_cat'] = "no"; // разрешить также синонимы рубрик

Чтобы плагин начал обрабатывать RSS потоки вашего сайта необходимо скопировать в папку вашего шаблона в подпапку /type/feed/ содержимое папки feed, которая находится в каталоге плагина. Если у вас в шаблоне нет папки /type/feed/ (т.е. используются стандартные type-файлы), то можно безбоязненно скопировать указанные файлы из папки плагина. Если же в вашем шаблоне уже есть такие файлы, то перед копированием поверх них файлов из папки плагина необходимо убедиться, что не будет потерян нужный вам функционал формирования rss-потоков. При необходимости, обратитесь за помощью к автору шаблона или другому php-специалисту, чтобы они провели анализ кода.

Коды шаблонов

Для записей доступны коды, вместо которых будут подставляться соответствующие значения:

• {page-slug} - slug записи,
• {page-id} - id записи (число),
• {cat-slug} - slug основной рубрики (если значение не определено, то будет подставлено значение no-cat),
• {sub-cat-slug} - slug подрубрики (если значение не определено, то будет подставлено значение no-subcat),
• {cat-sub-cat-slug} - макрос для обозначения конструкции вида {cat-slug}/{sub-cat-slug}, т.е. {cat-sub-cat-slug} сперва будет заменяться на указанную конструкцию, а уже потом обрабатываться алгоритмом. Если {sub-cat-slug} не определено, то {cat-slug}/{sub-cat-slug} урезается до конструкции {cat-slug},
• {year} - год публикации записи (формат: YYYY, например - «2015»),
• {month} - номер месяца публикации записи (формат: MM, например - «02» для февраля),
• {day} - день месяца публикации записи (формат: DD, например - «02» для второго дня месяца),
• {hour} - час публикации записи (формат: HH, например - «03» для третьего часа),
• {minute} - минута публикации записи (формат: II, например - «20» для двадцатой минуты),
• {second} - секунды публикации записи (формат: SS, например - «12» для двенадцатой секунды),
• {author} - ник автора записи,
• {type} - имя типа записи (по умолчанию в движке для записей определены «blog» и «static»).

Для рубрик доступны свои коды, вместо которых тоже будут подставляться соответствующие значения:

• {cat-id} - id рубрики,
• {cat-slug} - slug рубрики,
• {cat-parent-id} - id родительской рубрики (если есть, иначе используется значение no-parent-cat-id),
• {cat-parent-slug} - slug родительской рубрики (если есть, иначе используется значение no-parent-cat-slug),
• {parent-child-cat-slug} - макрос для обозначения конструкции вида {cat-parent-slug}/{cat-slug}, т.е. {parent-child-cat-slug} сперва будет заменяться на указанную конструкцию, а уже потом обрабатываться алгоритмом. Если {cat-parent-slug} не определено, то {cat-parent-slug}/{cat-slug} урезается до конструкции {cat-slug},

Шаблоны не обязательно начинать с косой черты (слеша) «/» - плагин сам приводит шаблон к нужному виду.

Известные особенности работы плагина

Т.к. обрабатываются только адреса страниц стандартного вида без учёта синонимов, то если у вас на сайте были вручную (или автоматически) расставлены ссылки с использованием стандартного механизма синонимов, то вам придётся самостоятельно позаботиться о том, чтобы привести эти ссылки к виду /page/page-slug и /category/category-slug.

Подсчёт просмотров страниц

В движке для подсчёта просмотров страниц имеется специальная функция mso_page_view_count_first, которая вызывается в начале файла шаблона \type\page\page.php. В этой функции жестко прописан алгоритм определения страницы на основе стандартной чпу движка (т.е. /page/slug). Из-за этого при включении плагина friendly_urls может «поломаться» отображение количества просмотров страниц. Чтобы восстановить работу подсчёта страниц нужно заменить вызов стандартной функции mso_page_view_count_first на соответсвующую функцию плагина - friendly_urls_page_view_count_first. Если у вас на сайте используется дефолтный шаблон и вы не создавали свой type-файл для кастомизации вывода страниц записей, то вам нужно создать в папке используемого шаблона папку \type\page\ и скопировать в неё файл \application\maxsite\shared\type\page\page.php. Затем нужно найти в скопированном файле функцию mso_page_view_count_first (обычно вызов находится в самом начале файла) и заменить её на friendly_urls_page_view_count_first. В качестве примера проведённой замены в папке плагина находится файл \friendly_urls\type\page\page.php.