Как создать приложение для IPS 5 — Начало работы

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

В этом руководстве мы создадим базовую структуру приложения для IPS 5 и подготовим его к разработке.

Мы пока не будем рассматривать контроллеры, модели, шаблоны, структуру базы данных и другие концепции разработки — эти темы будут разобраны отдельно в следующих руководствах.

Что такое IPS-приложение?

Приложение IPS — это автономное расширение для Invision Community, добавляющее на платформу новые функциональные возможности.

Приложение может добавлять такие элементы, как:

• Новые страницы фронтенда.

• Страницы панели управления администратора.

• Таблицы и модели базы данных.

• Новые типы контента.

• Пользовательские настройки.

• Права доступа.

• Функциональность на JavaScript.

• Интеграция с внешними сервисами.

• Кастомный функционал, отсутствующий в базовой платформе.

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

Вам нужно создать приложение?

Необязательно.

Незначительные визуальные изменения (например, корректировку стилей CSS) обычно можно внести непосредственно через раздел управления темой.

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

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

Простое правило:

Визуальные изменения → Редактор тем и редактор страниц.

Функциональные изменения → Приложение.

Включить инструменты разработчика.

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

Откройте папку с установленной IPS и создайте файл с именем constants.php, если он еще не существует. Этот файл не входит в стандартный комплект свежей установки IPS.

constants.php

Добавьте константу инструментов разработчика:

<?php
define( 'IN_DEV', TRUE );

Сохраните файл и перезагрузите панель управления администратора.

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

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

Создание нового приложения.

Теперь откройте панель управления администратора.

Перейдите в раздел «Приложения» (Applications), затем нажмите «Создать новое» (Create New).

IPS запросит основную информацию о вашей заявке.

Название приложения.

Введите название, которое увидят пользователи.

Например:

Live Search

Это понятное человеку название вашего приложения; оно может содержать пробелы и использовать обычный регистр.

Описание.

Описание приложения служит для разъяснения его назначения. Составьте четкое и краткое описание того, что делает ваше приложение и какие функции оно предоставляет.

Каталог приложения.

Затем выберите папку или ключ приложения, используемые приложением.

Например:

livesearch

Пусть это значение будет простым.

Хорошее название папки приложения, как правило, должно:

• Используйте строчные буквы.

• Избегайте пробелов.

• Избегайте лишних специальных символов.

• Пишите кратко и информативно.

• Обеспечьте уникальность в рамках вашей установки.

Например:

livesearch
forumcollection
story
valalms

Избегайте таких названий, как:

Live Search
Live_Search
My Awesome Application

Имя папки — это внутренний идентификатор, поэтому, если вы сразу дадите ему корректное название, это избавит вас от проблем в будущем.

Информация об авторе.

Введите сведения о разработчике, включая:

• Имя автора.

• Сайт автора.

• Любая другая информация, запрашиваемая формой создания приложения.

Используйте информацию, которую вы хотите связать с приложением.

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

Создание приложения.

Заполнив необходимые данные, отправьте форму.

IPS создаст для вас начальную версию приложения.

На этом этапе вы успешно создали базовое приложение IPS 5.

Вы еще не реализовали никакой функциональности — вы создали лишь основу приложения.

Что дальше?

Теперь, когда приложение создано, следующий шаг — разобраться в том, что именно для нас подготовила IPS.

Мы рассмотрим структуру каталогов и файлов приложения и объясним, за что отвечает каждый из них.