Управление сайтом (Website UI)

Содержание

1. Базовые понятия

Kernel Video Sharing предоставляет движок с огромным спектром возможностей по созданию и настройке страниц сайта. Основные достоинства движка перечислены ниже:

• Беспрецендентная скорость работы достигается за счет двух-уровневого кэширования содержимого страниц. Стратегия кэширования может быть изменена в любой момент времени, что позволяет снять нагрузку на сервер при увеличении траффика. Существует несколько важных аспектов кэширования, которые обязательно необходимо прочитать и понять, прежде чем работать с настройкой сайтом. Они будут описаны в разделе о кэшировании.
• Построение страниц сайта на основе блоков позволяет быстро настроить необходимый функционал каждой страницы. Это сможет сделать любой человек, знающий основы верстки и понимающий концепцию движка Kernel Video Sharing.
• При необходимости расширения базового функционала, вы можете написать свои собственные блоки и использовать их на сайте. Для этого не нужно разбираться с тысячами строк кода, достаточно лишь понять несколько базовых правил создания блоков.
• Любые новые блоки, разработанные позднее, могут быть подключены в любое место сайта без вероятности повредить существующий и работающий функционал.
• Встроенный анализ производительности сайта позволяет находить наиболее уязвимые с точки зрения производительности страницы и блоки сайта и оптимизировать их на лету.

Движок Kernel Video Sharing использует 4 сущности для построения сайта:

• Компоненты страниц (Page components) - это части верстки, которые могут использоваться во многих местах. Компоненты страницы просто отображают HTML код, следую логики, которая задается в шаблоне компонента. Это применяется для общих элементов сайта (например, шапка, нижняя часть, форма поиска, которая может отображаться на многих страницах и т.д.). Компоненты используются в шаблонах других сущностей, например на страницах и в блоках. Таким образом, если вам нужно поменять что-либо в шапке сайта (обычно это название ресурса и верстка шапки), это можно поменять в соответствующем компоненте страницы, и изменения подействуют для всех страниц, которые используют данный компонент в своем шаблоне.
• Блоки (Page blocks) - это основные логические модули страниц. Каждый блок предоставляет логически завершенный кусочек функционала сайта и может использоваться на любых страницах. Основное отличие блоков от компонентов страниц заключается в том, что блоки предоставляют выполнение бизнес логики (работа с базой данных, подготовка результатов для отображения, обработка форм, отправленных пользователями) и отображение результатов выполнения данной бизнес логики (шаблон с версткой), в то время как компоненты страниц содержат только отображение каких-либо данных или элементов дизайна. Большинство блоков поддерживает набор конфигурационных параметров, которыми можно управлять поведением блока (например, ограничить кол-во элементов в блоке списка, или включить визуальную защиту при входе в личную зону). Каждый блок кроме параметров поддерживает определенный уровень кэширования и может кэшироваться отдельно.
• Рекламные места (Advertising locations) - это слоты для отображения рекламы. Вы можете настроить сколько угодно рекламных мест на сайте и привязать к каждому из них рекламу.
• Страницы (Pages) - это основные элементы структуры сайта, каждая страница может содержать любое кол-во компонент, блоков и рекламных мест (или может просто содержать статический HTML код). Страницы поддерживают кэширование второго уровня, при включении которого результат отображения страницы полностью помещается в оперативную память и в течение настроенного интервала времени пользователи видят сохраненный в кэше HTML код (статику).

Для того, чтобы наглядно представить себе все основные сущности сайта, рассмотрим скриншот выше. Все что отображается на скриншоте - это отдельная страница, которая доступна по отдельному адресу. В самом верху страницы находится шапка. Шапка - это компонент страницы, поскольку она не несет в себе никакой логики, только выводит верхнюю часть HTML кода страницы. В шапке вставлено рекламное место, в котором отображается один баннер. Если к этому рекламному месту привязать несколько баннеров, то они будут ротироваться. Ниже шапки отображается блок списка видео (list_videos), который выводит 9 последних просмотренных видео. Чем отличается блок от компонента страницы очевидно - блок обращается в базу данных для того, чтобы вывести некоторую информацию, а компонент страницы просто отображает HTML код. Справа от блока списка видео отображается компонент страницы с формой поиска видео и под ним блок облака тэгов (tags_cloud).

В качестве другого примера рассмотрим страницу Community, на которой мы хотим отобразить такую информацию:

• 3 рекомендуемых к просмотру премиум видео
• 20 последних зарегистрированных пользователей сайта
• 3 наиболее активных пользователя
• 10 последних добавленных фотоальбомов
• 10 самых популярных фотоальбомов

Код шаблона страницы будет иметь приблизительно такой вид:

{{* Устанавливаем значение переменной page_title, которая используется в компоненте страницы header_general *}}
{{assign var=page_title value="Community"}}

{{* Включаем компонент страницы header_general, который отображает шапку страницы *}}
{{include file="header_general.tpl"}}

<div id="data">
    <div id="wide_col">
        {{* Включаем блок list_videos для отображения 3 премиум видео *}}
        {{insert name="getBlock" block_id="list_videos" block_name="Recommended premium videos"}}

        {{* Включаем блок list_members для отображения 20 последних пользователей *}}
        {{insert name="getBlock" block_id="list_members" block_name="Latest members"}}

        {{* Включаем блок list_albums для отображения 10 последних фотоальбомов *}}
        {{insert name="getBlock" block_id="list_albums" block_name="Latest albums"}}

        {{* Включаем блок list_albums для отображения 10 популярных фотоальбомов *}}
        {{insert name="getBlock" block_id="list_albums" block_name="Most popular albums"}}
    </div>
    <div id="side_col">
        {{* Включаем блок list_members для отображения 3 активных пользователей *}}
        {{insert name="getBlock" block_id="list_members" block_name="Active members"}}
    </div>
</div>

{{* Включаем компонент страницы footer_general, который отображает нижнюю часть страницы *}}
{{include file="footer_general.tpl"}}

Кроме непосредственного включения блоков в шаблоне страницы необходимо также настроить их параметры для данной страницы (например, блоку list_videos указать, что нужно выводить только 3 видео и обязательно премиум и т.д.) и при необходимости шаблоны блоков для данной страницы (логику отображения данных). Это будет детально рассмотрено в следующих разделах.

2. Компоненты страниц (Page components)

2.1. Использование компонентов страниц на сайте

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

Компоненты страниц могут использоваться в любых местах, где ожидается шаблон Smarty (в шаблонах страниц, шаблонах блоков и даже в шаблонах самих компонентов). Для включения компонента используется стандартная директива Smarty:

{{include file="%PAGE_COMPONENT_EXTERNAL_ID%.tpl"}}

В данном примере токен %PAGE_COMPONENT_EXTERNAL_ID% должен быть заменен на идентификатор (external ID) требуемого компонента, например header_general:

{{include file="header_general.tpl"}}

Во время обработки страницы данная директива будет заменена движком Smarty на содержимое шаблона указанного компонента. Это позволяет использовать любые переменные в шаблоне компонента страницы, значения которых могут быть установлены в месте непосредственного использования компонента. Для примера, рассмотрим шапку сайта, которая содержит информацию о названии страницы. Шапка не может содержать конкретное название страницы, поскольку она используется на разных страницах сайта с разными названиями. Поэтому вместо конкреного названия следует использовать переменную (например, page_title), значение которой будет устанавливаться в шаблоне конкретной страницы непосредственно перед включением компонента шапки на страницу. Код шаблона компонента шапки может выглядеть так:

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <!-- Выводим значение переменной page_title в названии страницы -->
    <title>{{$page_title}} - My Tube Site</title>
</head>
<body>

Для того, чтобы при отображении страницы переменная page_title заменилась на нужное значение, необходимо присвоить ей это значение перед включением компонента. Это может быть сделано таким образом (страница со списком премиум видео):

{{* Устанавливаем значение переменной page_title *}}
{{assign var=page_title value="Premium Videos"}}

{{* Включаем компонент страницы header_general, который отображает шапку страницы *}}
{{include file="header_general.tpl"}}

....

2.2. Работа с компонентами страниц в панели администрирования

Файлы компонентов страниц хранятся в папке /template на сервере. Для создания компонентов php должен иметь права на создание файлов в данной папке. Для редактирования какого либо компонента php должен иметь права на редактирование файла шаблона данного компонента.

Список компонентов (Page components list) находится в разделе UI сайта (Website UI) панели администрирования. Список содержит следующие столбцы:

• Имя файла (Filename) - имя файла под которым сохранен компонент на сервере; состоит из идентификатора компонента и расширения .tpl. Данное имя файла используется для включения компонента в шаблоны других объектов (как было показано в примерах выше).
• Включается в (Included in) - список страниц и блоков, где используется данный компонент. Если компонент используется в коде шаблона страницы, то в данном столбце выводится название шаблона страницы (например, index.tpl). Если же компонент используется в коде шаблона блока, то кроме названия шаблона страницы, на которой находится данный блок, выводится еще и название блока через // (например, index.tpl // Videos Watched Right Now). Элементы списка разделяются запятыми.
• Действия (Actions) - редактирование, удаление. Удаление доступно только для компонентов, которые нигде не используются.

При добавлении / редактировании компоненты страниц поддерживают следующие поля:

• Идентификатор (External ID) - уникальный идентификатор компонента, может содержать ограниченный набор символов (a-z, A-Z, 0-9, _). Данный идентификатор используется для сохранения кода шаблона компонента на сервере в файле с расширением .tpl. Идентификатор не может быть изменен после создания компонента.
• Код шаблона (Template code) - указывает код шаблона Smarty (или просто HTML код) для данного компонента.

Во время работы с содержимым страниц и блоков вы можете включать даже несуществующие компоненты страниц (через директиву Smarty {{include ...}}). В этом случае необходимый компонент будет создан автоматически с пустым шаблоном. Все что вам нужно будет сделать - это просто задать для него шаблон позже.

2.3. Обзор компонентов страниц demo-сайта

Данная таблица содержит краткое описание и предназначение компонентов страниц, которые используются на demo-сайте Kernel Video Sharing. Часть из приведенных ниже компонентов доступна только для владельцев полной версии.

3. Блоки (Blocks)

3.1. Общая информация о блоках

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

Список всех блоков и полную информацию о них с примерами использования можно посмотреть на странице Список блоков (Page blocks list) в разделе UI сайта (Website UI) панели администрирования. Список содержит следующие столбцы:

• ID блока (Block ID) - идентификатор блока (или класс блока). Данный идентификатор используется при включении блока на странице.
• Описание (Description) - краткая информация о предназначении блока.
• Автор (Author) - автор блока. Это поле может использоваться сторонними разработчиками блоков.
• Версия (Version) - версия блока.
• Состояние (State) - поле используется для отображения ошибок в блоках.

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

Блоки могут быть условно классифицированы по нескольким признакам. Например, по типу отображаемого контента блоки можно разделить на:

• Блоки листинга - блоки, которые отображают список каких-либо сущностей, например list_categories - отображает список категорий, video_comments - отображает список комментариев к видео, и т.д. Данные блоки выделяются тем, что они все поддерживают пагинацию (переход по страницам листинга) внутри блока, а также к ним можно подключать сторонний блок пагинации (для сохранения преемственности со старыми версиями софта).
• Блоки отображения данных - блоки, которые отображают данные какой-либо сущности, например, member_profile_view - отображает данные профиля пользователя, album_view - отображает данные фотоальбома и т.д.
• Блоки редактирования данных / форм - блоки, которые отображают форму для заполнения, например, logon - отображает форму входа в личную зону, video_edit - отображает форму создания / редактирования видео и т.д. Особенностью этих блоков является то, что они не поддерживают кэширование.

По уровню доступа блоки условно могут быть разделены на следующие группы:

• Блоки публичного доступа - блоки доступные всем посетителям сайта при любых условиях, например, list_categories - отображает список категорий, invite_friend - отображает форму приглашения друга и т.д.
• Блоки приватного доступа - блоки, которые при любых условиях требуют, чтобы пользователь был залогинен, например, member_profile_edit - отображает формы управления данными профиля, list_messages - отображает список сообщений внутренней почты и т.д. В случае запроса незалогиненным пользователем страницы с данным блоком, пользователь будет перенаправлен на страницу логина (конфигурируется через параметр блока), а затем после логина он вернется на запрошенную ранее страницу с приватным блоком.
• Блоки комбинированного доступа - блоки, которые могут быть как публичными, так и приватными в зависимости от параметров их конфигурации, например, list_videos при отображении закладок видео текущего пользователя является приватным блоком, а при отображении списка премиум видео - публичным.

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

3.2. Использование блоков на страницах сайта

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

{{insert name="getBlock" block_id="%BLOCK_ID%" block_name="%UNIQUE_BLOCK_NAME%"}}

В данном примере токен %BLOCK_ID% должен быть заменен на идентификатор блока (block ID) требуемого блока, например, list_videos, а токен %UNIQUE_BLOCK_NAME% на любое уникальное имя блока для данной страницы:

{{insert name="getBlock" block_id="list_videos" block_name="Most Popular Videos"}}

Вы можете включать любое количество блоков любых типов на одной странице:

{{* Первый блок list_videos *}}
{{insert name="getBlock" block_id="list_videos" block_name="Most Popular Videos"}}

{{* Еще один блок list_videos *}}
{{insert name="getBlock" block_id="list_videos" block_name="Top Rated Videos"}}

{{* Третий блок list_videos *}}
{{insert name="getBlock" block_id="list_videos" block_name="Premium Videos"}}

{{* Список трейдеров *}}
{{insert name="getBlock" block_id="top_referers" block_name="Traders Text Links"}}

...

При простом включении блока на странице он будет вызываться и отображать результат непосредственно в том месте шаблона страницы, где вы его вставили. В некоторых случаях необходимо заставить блок выполниться в начале страницы, например, для того, чтобы показать данные из блока в заголовке страницы (title, description, keywords). Этого можно добиться, используя дополнительный параметр assign директивы {{insert ...}}. При использовании этого параметра результат выполнения блока будет не отображаться в текущем месте шаблона страницы, а помещаться в переменную, указанную в значении параметра assign. Этот результат выполнения можно будет вывести в любом месте страницы, используя стандартный вывод Smarty:

{{* Вызов блока просмотра видео в самом начале страницы и присвоение результата в переменную video_view_result *}}
{{insert name="getBlock" block_id="video_view" block_name="View Video" assign="video_view_result"}}

{{* Дальше идет много всего *}}
...

{{* Теперь нужно вывести результат блока просмотра видео *}}
{{$video_view_result|smarty:nodefaults}}

...

Этого достаточно, чтобы показать название видео в заголовке страницы, т.к. после отработки блока можно использовать его глобальное хранилище (storage):

{{* Вызов блока просмотра видео в самом начале страницы и присвоение результата в переменную video_view_result *}}
{{insert name="getBlock" block_id="video_view" block_name="View Video" assign="video_view_result"}}

{{* Присваиваем переменной page_title название видео доступное в глобальном хранилище *}}
{{assign var=page_title value=$storage.video_view_video_view.title}}

{{* Включаем компонент шапки, который отобразит значение из переменной page_title *}}
{{include file="header_general.tpl"}}

{{* Теперь нужно вывести результат блока просмотра видео *}}
{{$video_view_result|smarty:nodefaults}}

...

Как видно из примера, каждый блок использует глобальное хранилище данных под своим уникальным ключем (в примере это $storage.video_view_video_view). Нет никакого смысла понимать механизм формирования этих ключей, поскольку панель администрирования выводит эти ключи для каждого блока в таблице блоков данной страницы сайта. При необходимости использовать глобальное хранилище - ключ можно скопировать из таблицы.

Для удаления блока со страницы достаточно удалить из кода шаблона страницы директиву, которая его вставляет. При этом файлы блока на самом деле удаляться не будут. Это сделано для того, чтобы можно было быстро восстановить блок на странице в случае его ошибочного удаления. Если вы вставите снова директиву включения блока с такими же параметрами (имеются ввиду параметры директивы block_id и block_name) - блок будет восстановлен со всеми деталями его конфигурации. Если вы все же хотите финально удалить файлы блока (мы рекомендуем это делать, если вы проверили что блок удален корректно) - то откройте Список страниц (Pages list) в разделе UI сайта (Website UI). Вы увидите, что в боковом меню появится новая опция Подчистить файлы (Cleanup files), рядом с которой также показано количество файлов для очистки. Зайдите на эту опцию и удалите неиспользуемые файлы блоков.

Важно! После удаления файлов блоков (файл шаблона и файл конфигурации) на странице Подчистить файлы (Cleanup files) - восстановить детали удаленного блока будет невозможно. В случае необходимости восстановления вам придется заново создать и настроить блок на странице.

3.3. Параметры конфигурации и шаблоны блоков

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

При включении блока на странице он инициалируется параметрами и шаблоном, которые настроены по умолчанию. В подавляющем большинстве случаев это не то, что нужно, поэтому для изменения параметров блока и его шаблона следует зайти на страницу редактирования выбранного блока на выбранной странице. Сделать это можно либо с общего списка Cтраниц сайта (Pages list) - там для каждой страницы отображаются блоки со ссылками на их редактирование, либо с редактора отдельно взятой страницы, где отображается список включенных на странице блоков.

Страница редактирования блока поддерживает следующие поля:

• Название блока (Block name) - название блока на данной странице, поле не редактируется.
• Тип блока (Block type) - идентификатор типа блока, поле не редактируется. Рядом с идентификатором типа блока находятся ссылки для отображения описания блока и его дефолтового шаблона. Дефолтовый шаблон описывает практически все аспекты отображения блока, поэтому вы можете его использовать в качестве примера верстки блока.
• Код шаблона (Template code) - указывает код шаблона Smarty для данного блока на данной странице. Можно использовать включение компонентов страниц и рекламных мест.
• Время жизни кэша (Cache lifetime) - длительность жизни кэша в секундах, которая указывает, как долго данный блок будет использовать кэш на данной странице. Если указано значение 0 - то блок кэшироваться не будет. Для блоков, которые не поддерживают кэширование данное поле не редактируется.
• Параметры конфигурации (Configuration parameters) - таблица с поддерживаемыми параметрами и их значениями для данного блока (если блок имеет параметры конфигурации). Для того, чтобы включить параметр необходимо включить соответствующий чекбокс и ввести необходимое значение (для булевских параметров значение не требуется, такие параметры просто включаются / выключаются). Включенные параметры помечаются жирным шрифтом.

Среди разнообразных параметров стоит выделить так называемые var-параметры, которые используются во многих блоках, например, var_from - для пагинации, var_video_dir - для отображения видео и т.д. Данные параметры ссылаются на названия HTTP параметров, которые следует использовать блоку на данной странице для своей работы. Рассмотрим пример с блоком просмотра видео video_view. Для того чтобы отобразить информацию о каком-либо видео блоку необходимо знать идентификатор этого видео. Видео может быть идентифицировано 2-мя способами: по числовому идентификатору и директории. Предположим, что мы хотим отобразить видео по директории (как обычно делается). Для этого блоку необходимо знать, в каком HTTP параметре передается директория видео для отображения, за что отвечает параметр блока var_video_dir, который указывает где искать значение директории. Это значит, что если для данного параметра установлено значение dir, то ссылка на страницу с текущим блоком должна содержать значение директории видео в HTTP параметре dir, т.е. /page_id.php?dir=video_directory_value. Аналогичное правило справедливо для всех var-параметров.

К счастью, в подавляющем большинстве случаев значение соответсвующего var-параметра можно оставить как оно предлагается по умолчанию. Вам необходимо только учитывать, что для корректного поведения блока на странице ссылка на эту страницу должна содержать необходимые блоку значения var-параметров. Если на вашем сайте используется mod_rewrite для ссылок (что скорее всего), то правила mod_rewrite должны также учитывать необходимые блоку var-параметры.

var-параметры являются одним из ключевых звеньев движка Kernel Video Sharing, поскольку они обеспевают блоки необходимой для работы информацией, а также используются для кэширования блоков и страниц. Названия и значения var-параметров по умолчанию настроены таким образом, чтобы подходящие друг к другу блоки могли работать совместно на одной странице. Так, например, блоки video_view, video_comments, list_videos и top_referers имеют параметры с одинаковым названием и значением var_video_dir и var_video_id. При включении этих блоков на одной странице и включении во всех блоках одного из данных параметров блоки будут отображать информацию о видео, комментарии к видео, список похожих видео и список рефереров, подходящих к видео по категории соответственно.

В большинстве случаев одинаковые блоки на разных страницах имеют похожий внешний вид, за исключением конечного ряда элементов (например, название списка видео может быть разным на каждой странице - но в целом все списки видео выглядят одинаково). В таких случаях логику отображения блока (шаблон) стоит вынести в компонент страницы, а в самом шаблоне блока включить этот компонент. Различающиеся элементы (как название) следует вывести через переменные Smarty, значение которым должно быть присвоено непосредственно перед включением компонента на странице. Это сделано на demo-сайте Kernel Video Sharing, где существует несколько компонентов страниц для отображения наиболее часто используемых блоков (например, компоненты list_videos_block_common.tpl и list_videos_block_internal.tpl, которые используются блоком list_videos).

3.4. Блоки списков и пагинация

Почти половина существующих в Kernel Video Sharing блоков является блоками списка. Блоки списка отличаются от других блоков тем, что они поддерживают возможность отображать только часть списка и навигацию по страницам списка (пагинацию), хотя могут быть также настроены на отображение полного списка объектов (сколько есть).

Все блоки списка поддерживают пагинацию внутри самого блока, а также поддерживают возможность пагинации через ajax без перезагрузки страницы (по умолчанию это не используется). Для включения пагинации в блоке списка должен быть включен параметр блока var_from, который указывает блоку в каком HTTP параметре приходит информация о текущей странице (по умолчанию var_from=from). Кроме этого параметра блока, вы можете также использовать другие параметры пагинации, которые поддерживаются каждым блоком списка:

• items_per_page - количество объектов списка на одной странице. Исходя из этого значения и общего количества имеющихся у списка объектов будет рассчитано количество страниц списка.
• links_per_page - количество страниц списка, отображаемых на одной странице.

После настройки параметров блока вам также необходимо добавить в шаблон блока отображение ссылок пагинации (по умолчанию шаблоны блоков не содержат этого). Для этого вы можете просто включить в нужном месте шаблона блока компонент страницы pagination_block_common (который содержит логику отображения списка страниц):

...

{{* Подключаем пагинацию вверху списка *}}
{{include file="pagination_block_common.tpl"}}

{{* Дальше идет список *}}
...

{{* Подключаем вторую пагинацию снизу списка - это пример того, что можно в блоке 2 раза подключить *}}
{{include file="pagination_block_common.tpl"}}

...

Все ссылки пагинации, которые отображаются внутри блока работают по схеме, удобной для поисковых ботов:

http://your_domain.com/popular_videos/
http://your_domain.com/popular_videos/1/
http://your_domain.com/popular_videos/2/
... и т.д.

Для того, чтобы эти ссылки работали корректно, необходимы корректные правила mod_rewrite, которые созданы для всех существующих списков. Если вы добавляете новые списки (либо изменяете адреса страниц для существующих), вам необходимо следить за тем, чтобы правила mod_rewrite для пагинации были указаны верно.

Несмотря на то, что пагинация поддерживается всеми блоками списка, она может также отображаться отдельным блоком pagination. Во-первых, это необходимо для совместимости со старыми версиями Kernel Video Sharing. Во-вторых, отдельный блок пагинации поддерживает некоторые расширенные возможности пагинации для особых случаев (информация об этом есть в документации блока pagination).

В завершение разговора о пагинации рассмотрим пагинацию через ajax. Для этого вам нужно внести всего 2 изменения в концепцию пагинации описанную выше:

• Во-первых, весь шаблон (HTML код) блока списка должен быть обернут в div с уникальным идентификатором блока: <div id="{{$block_uid}}">
      ...
  </div>
• Во-вторых, вместо подключения компонента страницы pagination_block_common, вам необходимо подключить компонент страницы pagination_block_ajax: {{include file="pagination_block_ajax.tpl"}}

3.5. Краткий обзор существующих блоков

Данная таблица содержит краткое описание и предназначение существующих блоков. Часть блоков доступна только для владельцев полной версии. Более подробную информацию об установленных блоках можно получить на странице Список блоков (Page blocks list) в разделе UI сайта (Website UI) панели администрирования.

4. Реклама и Рекламные места (Advertising & Advertising locations)

4.1. Использование рекламных мест на сайте

Kernel Video Sharing предоставляет простой модуль управления рекламой, функциональности которого достаточно для большинства нужд.

Рекламные места являются контейнерами (или слотами) для рекламы на сайте. Они могут использоваться где угодно: в шаблонах страниц, компонентов и блоков. К каждому рекламному месту можно привязать любое кол-во рекламы, в таком случае реклама будет отображаться в случайном порядке.

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

{{insert name="getAdv" place_id="%ADVERTISING_LOCATION_EXTERNAL_ID%"}}

В данном примере токен %ADVERTISING_LOCATION_EXTERNAL_ID% должен быть заменен на идентификатор (external ID) требуемого рекламного места, например top_banner:

{{insert name="getAdv" place_id="top_banner"}}

4.2. Работа с рекламой в панели администрирования

Список рекламных мест (Locations list) находится в разделе UI сайта (Website UI) панели администрирования. Список содержит следующие столбцы:

• ID - числовой идентификатор рекламного места.
• Название (Title) - название рекламного места в панели администрирования.
• Идентификатор (External ID) - идентификатор, который должен использоваться при включении рекламного места на сайте.
• Реклама (Advertisements) - кол-во привязанной к данному рекламному месту рекламы и ссылка на список этой рекламы.
• Действия (Actions) - редактирование, удаление.

При добавлении / редактировании рекламные места поддерживают следующие поля:

• Название (Title) - название рекламного места для панели администрирования.
• Идентификатор (External ID) - уникальный идентификатор, который будет использоваться для включения рекламного места на сайте. Может содержать ограниченный набор символов (a-z, A-Z, 0-9, _).

Список рекламы (Advertisements list) находится в разделе UI сайта (Website UI) панели администрирования. Список содержит следующие столбцы:

• ID - числовой идентификатор рекламы.
• Название (Title) - название рекламы в панели администрирования.
• Рекл. место (Location) - рекламное место, к которому привязана данная реклама.
• Показывать с (Show from) - дата появления рекламы на сайте.
• Показывать по (Show to) - дата окончания показа рекламы на сайте.
• Статус (Status) - статус рекламы (активная или неактивная).
• Действия (Actions) - редактирование, удаление, активация / деактивация.

При добавлении / редактировании реклама поддерживают следующие поля:

• Название (Title) - название рекламы для панели администрирования.
• Рекл. место (Location) - позволяет выбрать рекламное место, к которому будет привязана данная реклама. Реклама будет отображаться только в выбранном рекламном месте.
• Статус (Status) - включение / выключение рекламы. На сайте будет отображаться только реклама в активном статусе.
• Дата показа (Show date) - позволяет указать интервал дат, в течение которого будет показываться данная реклама. Если дата показа не указана, то реклама будет отображаться постоянно. Возможно также указать только дату начала показа, либо только дату окончания показа.
• HTML код (HTML code) - рекламный контент (только статический HTML код).
• URL выхода (Outgoing URL) - позволяет включить подсчет кликов по данной рекламе в статистике. Если это поле используется, то HTML код для рекламы должен содержать токен %URL% везде, где ожидается URL выхода. В этом случае токен будет заменен на внутренний скрипт редиректа, которой зачтет клик в статистике.

5. Страницы (Pages)

5.1. Общая информация о страницах

Страницы являются точками входа в движок Kernel Video Sharing и элементами построения сайта самого верхнего уровня. Страницы могут состоять из всех элементов, описанных выше: компонентов, блоков и рекламных мест.

Каждая страница имеет свой уникальный идентификатор, на основе которого создается php файл страницы и ее шаблон отображения. php файл страницы используется для указания ссылок на нее.

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

Ссылки на страницу должны содержать все необходимые параметры для ее работы (этими параметрами на самом деле являются включенные var-параметры всех блоков данной страницы, как было описано выше. В большинстве случаев на демо сайте Kernel Video Sharing используются абстрактные ссылки, которые перекрываются через mod_rewrite, всвязи с чем многие необходимые странице параметры подставляются на основе частей URL-ов, например для ссылки на страницу просмотра видео /videos/my-uploaded-video/ применяется такое правило перенаправления:

RewriteRule ^videos/([^/]+)[/]* /view_video.php?dir=$1 [L,QSA]

Это правило говорит о том, что ссылка /videos/my-uploaded-video/ будет перенаправлена на страницу с идентификатором view_video (php файл страницы view_video.php), при этом в качестве параметра dir будет использоваться значение после videos/ без суффикса /, т.е. в нашем примере будет осуществлен такой вызов:

/view_video.php?dir=my-uploaded-video

Далее этот вызов подхватится движком, который вызовет все блоки на данной странице с параметром dir=my-uploaded-video. Блоки выведут всю необходимую информацию, базируясь на значении данного параметра (в приведенном примере блок video_view, который находится на данной странице, отобразит информацию о видео с директорией my-uploaded-video).

Аналогичным образом происходит обработка всех страниц сайта, которые созданы через панель администрирования.

Дополнительно к правилам mod_rewrite есть также две системные настройки, в которых нужно указать паттерны для ссылок на страницы просмотра видео и фотоальбомов. Эти паттерны используются в панели администрирования для создания ссылок на просмотр видео / фотоальбомов на сайте. Также эти паттерны используются некоторыми блоками сайта для автоматического открытия страницы видео или фотоальбома (при поиске, если результат только один). Эти настройки находятся на странице Системные настройки (System settings) в разделе Настройки (Settings) панели администрирования. Вы обязательно должны указать корректные значения!

5.2. Работа со страницами в панели администрирования

Файлы страниц хранятся в корне домена на сервере (php файл) и в папке /template (файл шаблона). Для создания страниц php должен иметь права на создание файлов в корне домена и в папке /template. Для редактирования страниц php должен иметь права на редактирование файла шаблона данной страницы в папке /template.

Список страниц (Pages list) является основным в разделе UI сайта (Website UI) панели администрирования. Список отображает иерархическую структуру страниц с блоками на них (строки, относящиеся к страницам выделены жирным). Список содержит следующие столбцы:

• Название страницы / блока (Page / block name) - название страницы либо блока в засимости от строки. Строки со страницами также содержат ссылку на данную страницу со стороны сайта, однако для большинства страниц данная ссылка не будет работать корректно, поскольку она не содержит необходимых параметров и их значений.
• ID блока (Block ID) - идентификатор блока на странице (для строк, которые показывают информацию о блоках).
• Кэш (Cache) - время жизни кэша страницы либо блока в секундах. Поскольку некоторые блоки не поддерживают кэширование, поле кэша не будет редактируемым для таких блоков, а также для страниц, которые содержат такие блоки.
• Сжатие (Compress) - указывает, используется ли сжатие кэша (только для строк страниц).
• Действия (Actions) - редактирование, удаление. Удаление возможно только для страниц. Для удаления блока со страницы необходимо удалить его включение из шаблона страницы.

Список страниц позволяет также массово настроить кэширование страниц и блоков. Для сохранения кэширования следует использовать кнопку Сохранить кэширование (Save caching) внизу списка.

При добавлении / редактировании страницы поддерживают следующие поля:

• Название (Title) - название страницы для панели администрирования.
• Идентификатор (External ID) - уникальный идентификатор страницы, может содержать ограниченный набор символов (a-z, A-Z, 0-9, _). Данный идентификатор используется для создания php файла и шаблона страницы. Идентификатор не может быть изменен после создания страницы.
• Время жизни кэша (Cache lifetime) - время кэширования страницы в оперативной памяти. Если указано значение 0 - то страница кэшироваться не будет. Для страниц, содержащих блоки, которые не поддерживают кэширование, данное поле не редактируется.
• Включить сжатие MemCache (Enable MemCache compression) - указывает, использовать ли для данной страницы сжатие кэша. Включенная опция позволяет уменьшить загрузку оперативной памяти, однако приводит к небольшой потери производительности страницы.
• XML содержимое (XML content type) - указывает, что данная страница будет выводить данные в XML формате. Используется для организации XML фидов.
• Код шаблона (Template code) - указывает код шаблона Smarty для данной страницы. Можно использовать включение блоков, компонентов страниц и рекламных мест.
• Содержимое страницы и стратегия кэширования (Page content and caching strategy) - таблица со списком блоков, которые включены на данную страницу, а также для каждого блока список включенных параметров, их значений и описание для каждого параметра. Таблица позволяет быстро изменить значение любого включенного параметра для любого блока на странице, а также время жизни кэша блока. Для добавления или удаления какого-либо из параметров блока вам нужно зайти на страницу редактирования этого блока, используя ссылку в названии блока. Для удобства таблица также содержит значение глобальной переменной storage, которое может быть использовано в шаблоне страницы для обращения к данным блоков из страницы.

Более подробная информация о кэшировании будет представлена ниже.

5.3. Краткий обзор существующих страниц

Все существующие на demo-сайте Kernel Video Sharing страницы можно разбить на три логические группы:

• Страницы, которые используются во внутренней зоне пользователей и недоступны посетителям извне, например, страница редактирования профиля пользователя, страница загрузки видео и т.д. Такие страницы имеют префикс [Memberzone] в названии, а также префикс member_my_ в идентификаторе страницы (например, [Memberzone] My Friends Events и member_my_friends_events).
• Страницы, которые отображают данные в контексте какого-либо пользователя и доступны всем пользователям, например, страница со списком видео, загруженного пользователем, страница со списком друзей пользователя и т.д. Такие страницы имеют префикс Member's в названии, а также префикс member_ в идентификаторе страницы (например, Member's Events и member_events).
• Другие публичные страницы не связанные с пользователями, например, список категорий, страница логина и т.д.

При создании новых страниц мы рекомендуем учитывать данные конвенции наименования.

6. Кэширование

Кэширование позволяет заметно снизить нагрузку на сервер при увеличении траффика на сайте. Движок Kernel Video Sharing поддерживает 2 уровня кэширования: стандартное кэширование на уровне шаблонов блоков и сверхбыстрое кэширование целых страниц в оперативной памяти.

Основным управляющим параметром кэширования является поле Время жизни кэша (Cache lifetime), которое используется как для блоков, так и для страниц. Чем больше время жизни кэша, тем меньше нагрузка на сервер, но в то же время меньше и актуальность информации. Страницы / блоки, которые обновляются не часто, могут быть закэшированы на более длительное время (например, список категорий). Страницы / блоки, которые должны обновляться регулярно - на меньшее время (например, индексная страница). Если вы хотите выключить кэширование для сраницы или блока, просто установите время жизни кэша в 0.

6.1. Кэширование первого уровня (кэширование блоков)

Кэширование первого уровня (кэширование блоков) является относительно медленным кэшированием. Этот вид кэширования можно использовать практически везде, где он поддерживается блоками. Как уже было замечено выше, некоторые блоки не поддерживают кэширование (в основном это блоки, которые содержат формы для заполнения, т.е. блок логина, блок загрузки видео и д.р.). Некоторые блоки не поддерживают кэширование при определенной конфигурации параметров, например, блок списка видео не позволяет кэширование при отображении результатов поиска, а также в некоторых других случаях. К счастью, даже при включенном кэшировании движок самостоятельно решит, что следует кэшировать, а что нет.

Для включения кэширования первого уровня вы можете установить время жизни кэша для каждого блока индивидуально. Вы можете сделать это в панели администрирования практически везде, где есть возможность редактирования блока. Лучше всего это сделать на Списке страниц (Pages list), где можно настроить кэширование для всего сайта глобально.

6.2. Кэширование второго уровня (кэширование страниц)

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

Кэширование второго уровня дополнительно поддерживает опцию сжатия кэша, которая помогает сэкономить оперативную память, но в то же время уменьшает скорость работы кэша. Данную опцию следует использовать на страницах, количество экземпляров которых в кэше относительно большое (например, для страницы просмотра видео, поскольку в кэше хранится большое количество экземпляров страницы для каждого видео).

Для включения кэширования второго уровня вы можете установить время жизни кэша для каждой страницы индивидуально. Вы можете сделать это в панели администрирования на Списке страниц (Pages list), где можно настроить кэширование для всего сайта глобально.

6.3. Важные аспекты кэширования

Существует несколько важных аспектов кэширования, которые обязательно необходимо прочитать и понять, прежде чем работать с настройкой сайта.

Кэширование не включается для администратора (если он залогинен в панели администрирования). Это сделано для того, чтобы при работе с сайтом не возникало каких-либо задержек при начальной отладке. Финальное же тестирование сайта должно быть выполнено с учетом кэширования. Этого можно добиться, если тестировать сайт в другом браузере (не в том, в котором идет работа с панелью администрирования).

Кэширование не используется, если на страницу передан параметр mode со значение async. Данный параметр используется для асинхронных запросов в различных блоках сайта (например, отправка пользовательского рейтинга на видео, либо отображение captcha).

Кэширование ограничивает возможности кастомизации сайта (особенно кэширование второго уровня). Так, нельзя, чтобы отображение какого-либо контента зависело от параметров, которые передаются на страницу. Рассмотрим простейший пример: необходимо передать идентификатор вебмастера, который затем будет подставлен в ссылку на спонсора (учет партнерского траффика). Если данный идентификатор передается в параметре wm_id, то простой вариант, который может прийти в голову - это вывести ссылку на спонсора и в ней указать значение из параметра запроса:

<a href="http://sponsor.com?wm_id={{$smarty.request.wm_id}}">

Это не будет работать при включенном кэшировании, поскольку в течение времени жизни кэша данная ссылка будет содержать одно и то же значение параметра wm_id. Для поддержки подобных параметров следует использовать поля Динамические HTTP параметры (Dynamic HTTP parameters) на странице Системные настройки (System settings) в разделе Настройки (Settings) панели администрирования. В этих полях вы можете перечислить 3 HTTP параметра, которые будут учитываться независимо от кэширования. Кроме того, эти HTTP параметры будут также учитываться в ссылках на контент провайдеров и на рекламу.

Для использования этих параметров вам нужно вставить в шаблоне (URL-е контент провайдера, URL-е рекламы) токен вида %param_name%, т.е. для примера выше ссылка на спонсора должна выглядеть таким образом:

<a href="http://sponsor.com?wm_id=%wm_id%">

Это подразумевает, что вы указали параметр wm_id в одном из полей Динамические HTTP параметры (Dynamic HTTP parameters).

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

Таким образом, в большинстве случаев вы не можете безболезненно использовать переменные типа $smarty.request, $smarty.get, $smarty.post в шаблонах сайта. Вместо них следует использовать динамические HTTP параметры.

Во многих случаях вы также не можете показывать различный контент различным пользователям сайта, поскольку для всех пользователей используется один и тот же экземпляр кэша. Исключение на данный момент составляют блоки video_view, video_comments, album_view, album_comments и album_images. Эти блоки (а значит и страницы, где они используются) сохраняют разные версии кэша для разных пользователей.

При необходимости сбросить кэш первого или второго уровня вы можете воспользоваться опциями Сбросить файловый кэш (Reset file cache) и Сбросить MemCache (Reset MemCache) соответственно. Эти опции находятся в боковой панели раздела UI сайта (Website UI) панели администрирования. Сброс кэша приведет к большому скачку нагрузки при большом траффике, поэтому эту операцию стоит выполнять только в исключительных случаях (например, при срочной необходимости обновить все страницы сайта). Сначала следует сбросить файловый кэш (кэш блоков), а через некоторое время MemCache (кэш страниц).

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

6.4. Статистика производительности

Статистика производительности позволяет оценить нагрузку на любую страницу или блок и понять, насколько корректно выбрана стратегия кэширования.

Для каждой страницы / блока на списке страниц выводятся 4 цифры:

• Количество загрузок страницы с начала процесса мониторинга.
• Среднее время срабатывания при использовании кэширования.
• Среднее время срабатывания без использования кэширования.
• Относительный процент кэширования. Наиболее важный параметр, который показывает как часто используется кэш данной страницы / блока. Чем выше это значение - тем чаще срабатывает кэш, а значит производительность выше.

Статистика производительности может быть сброшена в любой момент используя опцию Сбросить статистику производительности (Reset performance stats) в боковой панели раздела UI сайта (Website UI) панели администрирования.

7. Другие аспекты работы с сайтом

7.1. JavaScript файлы

Kernel Video Sharing использует несколько JavaScript файлов для работы сайта. Эти скрипты находятся в папке /js в корне домена. Некоторые блоки используют функции данных JavaScript файлов, поэтому требуют их включения на странице. JavaScript файлы, которые требуются блоками на какой-либо странице будут подключены автоматически. За вывод отвечает такая строка в шаблоне header_general.tpl:

{{$js_includes|smarty:nodefaults}}

Все JavaScript файлы подключаются ссылками, в которых указана текущая версия софта и которые используют расширение jsx, вместо js. Это нужно для того, чтобы при обновлении на новую версию софта у всех пользователей не осталось закэшированных браузеров JavaScript файлов (т.к. поменяются все ссылки на них). Вот пример одной из ссылок:

http://your_domain.com/js/KernelTeamVideoSharingSystem_2.0.0.jsx

Среди всех JavaScript файлов есть системные, которые добавляются независимо от блоков: KernelTeamVideoSharingSystem.js (добавляется всегда) и KernelTeamVideoSharingMembers.js (добавляется только для залогиненных пользователей).

По умолчанию все списки видео настроены на ротацию скриншотов видео формата 240x180. JavaScript с кодом ротатора подключается в шапке и доступен на каждой странице. Если вы используете только 1 скриншот для видео, либо вам не нужна ротация скриншотов, мы рекомендуем удалить включение скрипта ротатора в шаблоне шапки. Подключение ротатора задается таким образом:

<script type="text/javascript" src="{{$config.project_url}}/js/KernelTeamImageRotator_{{$config.project_version}}.jsx"></script>
<script type="text/javascript">
    KT_rotationEngineStartup(0.2, 0.5);
</script>

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

Сама ротация скриншотов запускается при наведении (останавливается при выходе) мышки на изображение скриншота:

// второй параметр - путь к папке, где лежат скриншоты
// третий параметр - кол-во скриншотов
onmouseover="KT_rotationStart(this, '{{$config.content_url_videos_screenshots}}/{{$item.screen_url}}/240x180/', {{$item.screen_amount}})"

onmouseout="KT_rotationStop(this)"

Если вам необходима ротация скриншотов других форматов, в обработчие события наведения мышки нужно заменить размер 240x180 на другой нужный.

Данная таблица перечисляет все JavaScript файлы, которые поставляются по умолчанию (все они находятся в папке /js в корне домена). Часть из них доступна только для владельцев полной версии.

7.2. Системные email сообщения

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

7.3. Таблицы стилей CSS

Демо-сайт Kernel Video Sharing содержит все стили в файле main.css, который назходится в папке /styles в корне домена. Структура данного файла очень проста:

• В начале файла описаны стили, которые имеют глобальную область применения.
• Затем описаны стили, которые применяются к компоновке структуры сайта. Такие стили применяются через идентификаторы элементов (#-селекторы, например, #top_menu {...}).
• Всю остальную часть файла занимают стили, которые применяются к отдельным блокам сайта. Стили для блоков всегда имеют префикс данного блока (например, стили для блока list_videos будут иметь префикс .list_videos).

7.4. Информация в сессии пользователя

Ниже приведен список полей сессии залогиненного пользователя, которые доступны в шаблонах сайта:

7.5. Подключение кастомного функционала к движку

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

Важно! Данные файлы не вызываются при запросах на отображение XML страниц.