h1. Список доступных шорткодов и их параметров
Все содержат параметр *template* для замены шаблона.
[CarbonBilling:Замена шаблонов страниц личного кабинета]
Некоторые шорткоды реализованы в [плагине|CarbonBilling:Пользовательские плагины] личного кабинета в директории {{/app/asr_cabinet/var/wordpress/wp-content/plugins/carbon-billing/shortcodes/login.php}}
Остальные (в том числе [пользовательские модули|CarbonBilling:Пользовательские модули в cabinet_modules]) реализованы в директории модулей личного кабинета {{/app/asr_cabinet/usr/local/lib/cabinet_modules}}
h3. cabinet_help
Выводит справочную информацию о шорткодах.
h3. cabinet_field
Вывод информации об абоненте.
Статья документации: [CarbonBilling:Wordpress. Вывод номера договора абонента, логина учетной записи и других полей. Шорткоды]
Пример использования: [CarbonBilling:Страница добровольной блокировки]
h3. cabinet_field attrib_1
Выводит [реквизит|http://docs.carbonsoft.ru/x/XgDnAg] абонента, при указании через "_" соответствующего id реквизита, например, шорткод [cabinet_field attrib_1] выведет реквизит "Телефон".
h3. cabinet_abonent_account
Выводит номер счета, баланс и договор.
h3. cabinet_abonent_status
Выводит статус, тариф и дату активации.
h3. cabinet_account_stat
Статистики платежей и списаний.
Параметр type:
* get_pay_log - платежи
* get_credit_log - расход
* get_traffic_log - трафик
* get_voip_log - звонки
Параметр per_page: указывает, сколько элементов отображать (по умолчанию 10)
h3. cabinet_action_button
Модуль *cabinet_action_button* вызывает метод API по нажатию кнопки.
Параметры:
* text - надпись на кнопке
* action - метод для выполнения
* а так же дополнительные параметры с собственными именами, являются дополнением к *action*
h3. cabinet_check
Модуль *cabinet_check* в зависимости от результата выполнения метода API либо выводит, либо прячет содержимое.
Что можно проверить:
- balance - True, если остаток на лицевом счёте абонента положительный.
- in_own_block - True, если абонент в добровольной блокировке.
- empty_phone - True, если у абонента указан номер телефона.
- plan_own_block - True, если у абонента запланирована добровольная блокировка.
- autopay_enabled - True, если подключен автоплатёж абоненту.
- always_false - False всегда.
Флаг inverse меняет True на False и наоборот.
Примеры использования:
* [Настройка SMS оповещений в личном кабинете]
* [Страница добровольной блокировки]
h3. cabinet_apply_for_connection
Страница для создания заявки на подключение. _Не требует авторизации._
Статья документации: [Форма заявки на подключение]
h3. cabinet_authorize
Страница авторизации в личном кабинете. _Не требует авторизации._
h3. cabinet_autopay_payment
Страница настройки автоплатежа.
Статья документации: [Автоплатежи (рекуррентные платежи)|CarbonBilling:Автоплатежи (рекуррентные платежи)]
h3. cabinet_block_abonent
Форма добровольной блокировки абонента.
h3. cabinet_change_mac
Получение MAC для текущего IP.
Статья документации: [CarbonBilling:Изменение данных абонента в ЛК]
h3. cabinet_change_tarif
Смена тарифа абонента.
h3. cabinet_change_tarif_history
Выводит историю смены тарифов.
h3. cabinet_current_month_expenses
Выводит стоимость услуг на текущий месяц.
h3. cabinet_detail_search
Детальный поиск по сессиям Radius для реализации СОРМ.
h3. cabinet_documents
Страница скачивания документов в PDF: счёт и акт.
h3. cabinet_helpdesk_chat
Отображает список заявок HelpDesk абонента или отображается заявка HelpDesk с комментариями по GET параметру *cabinet_ticket* с ID.
Возможность комментирования заявки.
Параметр status: отображать в списке заявки HelpDesk с данным статусом.
Статья документации: [CarbonBilling:CRM. HelpDesk]
h3. cabinet_helpdesk_ticket_add
Кнопка и модальная форма создания заявки HelpDesk.
Параметр add_class: добавить CSS класс к кнопке.
Параметр status: создавать заявку с указанным статусом.
Статья документации: [CarbonBilling:CRM. HelpDesk]
h3. cabinet_iptv
Список учетных записей абонента с привязкой к IPTV оборудованию.
[CarbonBilling:ЛК. Отображение учетных записей IPTV]
h3. cabinet_megogo
Лендинг IPTV Megogo.
Статья документации: [Интеграция с Megogo]
h3. cabinet_old_cabinet
Детальная статистика _(устарело)_.
[Детальная статистика в личном кабинете]
h3. cabinet_payment
Форма оплаты платежной системы в личном кабинете.
Статья документации: [CarbonBilling:Отображение платежных систем в личном кабинете абонента]
h3. cabinet_payment_result
После возврата с сайта платежной системы выводит информацию о платеже и/или результате операции.
Поддерживается некоторыми платежными системами. Информация о поддержке указана в статье о платежной системе (раздел [CarbonBilling:Платёжные системы]).
Для работы шорткода необходимо создать страницу paycheck в ЛК с адресом {code}<Адрес ЛК>/cabinet/paycheck/{code} и содержащей шорткод {code}[cabinet_payment_result]{code}
h3. cabinet_promise_pay
Форма подключения обещанного платежа.
Статья о замене шаблона страницы на подробное описание обещанного платежа: [CarbonBilling:Замена шаблонов страниц личного кабинета]
h3. cabinet_redirect
Перенаправление браузера.
Параметр url: ссылка для перенаправления.
h3. cabinet_rensoft_wordpress
Магазин программного обеспечения Rentsoft.
Статья документации: [ПО по подписке (Rentsoft)|CarbonBilling:ПО по подписке (Rentsoft)]
h3. cabinet_reports
Отчеты из [CarbonBilling:Конструктор отчетов].
Статья документации: [Отчёты в личном кабинете]
h3. cabinet_set_user_info
Смена данных абонента.
Параметрами являются поля абонента.
Примеры использования:
Статья документации: [CarbonBilling:Изменение данных абонента в ЛК]
Пример использования: [Настройка SMS оповещений в личном кабинете]
h3. cabinet_tarif_info
Информация о текущем тарифе абонента.
h3. cabinet_tarif_list
Список тарифов. Параметры:
* only_available=1 - отображать в списке только тарифы доступные абоненту
h3. cabinet_user_info
Информация об абоненте.
h3. cabinet_user_info_sidebar
Данные абонента, предназначенные для левого сайдбара.
Статьи документации:
* [CarbonBilling:Настройка выводимой информации в левом сайдбаре ЛК]
* [CarbonBilling:Wordpress. Настройка меню кабинета.]
h3. cabinet_uslugi
Список услуг абонента и форма подключения доступных услуг.
h2. Добавление опций к шорткоду
Добавить опции к шорткоду можно следующим образом: \[ Шорткод Опция1=Значение1 Опция2=Значение2 \]
Пример, добавляем к *шорткоду* cabinet_tarif_list *опцию* only_available со *значением* 1:
{code}
[cabinet_tarif_list only_available=1]
{code}
Все содержат параметр *template* для замены шаблона.
[CarbonBilling:Замена шаблонов страниц личного кабинета]
Некоторые шорткоды реализованы в [плагине|CarbonBilling:Пользовательские плагины] личного кабинета в директории {{/app/asr_cabinet/var/wordpress/wp-content/plugins/carbon-billing/shortcodes/login.php}}
Остальные (в том числе [пользовательские модули|CarbonBilling:Пользовательские модули в cabinet_modules]) реализованы в директории модулей личного кабинета {{/app/asr_cabinet/usr/local/lib/cabinet_modules}}
h3. cabinet_help
Выводит справочную информацию о шорткодах.
h3. cabinet_field
Вывод информации об абоненте.
Статья документации: [CarbonBilling:Wordpress. Вывод номера договора абонента, логина учетной записи и других полей. Шорткоды]
Пример использования: [CarbonBilling:Страница добровольной блокировки]
h3. cabinet_field attrib_1
Выводит [реквизит|http://docs.carbonsoft.ru/x/XgDnAg] абонента, при указании через "_" соответствующего id реквизита, например, шорткод [cabinet_field attrib_1] выведет реквизит "Телефон".
h3. cabinet_abonent_account
Выводит номер счета, баланс и договор.
h3. cabinet_abonent_status
Выводит статус, тариф и дату активации.
h3. cabinet_account_stat
Статистики платежей и списаний.
Параметр type:
* get_pay_log - платежи
* get_credit_log - расход
* get_traffic_log - трафик
* get_voip_log - звонки
Параметр per_page: указывает, сколько элементов отображать (по умолчанию 10)
h3. cabinet_action_button
Модуль *cabinet_action_button* вызывает метод API по нажатию кнопки.
Параметры:
* text - надпись на кнопке
* action - метод для выполнения
* а так же дополнительные параметры с собственными именами, являются дополнением к *action*
h3. cabinet_check
Модуль *cabinet_check* в зависимости от результата выполнения метода API либо выводит, либо прячет содержимое.
Что можно проверить:
- balance - True, если остаток на лицевом счёте абонента положительный.
- in_own_block - True, если абонент в добровольной блокировке.
- empty_phone - True, если у абонента указан номер телефона.
- plan_own_block - True, если у абонента запланирована добровольная блокировка.
- autopay_enabled - True, если подключен автоплатёж абоненту.
- always_false - False всегда.
Флаг inverse меняет True на False и наоборот.
Примеры использования:
* [Настройка SMS оповещений в личном кабинете]
* [Страница добровольной блокировки]
h3. cabinet_apply_for_connection
Страница для создания заявки на подключение. _Не требует авторизации._
Статья документации: [Форма заявки на подключение]
h3. cabinet_authorize
Страница авторизации в личном кабинете. _Не требует авторизации._
h3. cabinet_autopay_payment
Страница настройки автоплатежа.
Статья документации: [Автоплатежи (рекуррентные платежи)|CarbonBilling:Автоплатежи (рекуррентные платежи)]
h3. cabinet_block_abonent
Форма добровольной блокировки абонента.
h3. cabinet_change_mac
Получение MAC для текущего IP.
Статья документации: [CarbonBilling:Изменение данных абонента в ЛК]
h3. cabinet_change_tarif
Смена тарифа абонента.
h3. cabinet_change_tarif_history
Выводит историю смены тарифов.
h3. cabinet_current_month_expenses
Выводит стоимость услуг на текущий месяц.
h3. cabinet_detail_search
Детальный поиск по сессиям Radius для реализации СОРМ.
h3. cabinet_documents
Страница скачивания документов в PDF: счёт и акт.
h3. cabinet_helpdesk_chat
Отображает список заявок HelpDesk абонента или отображается заявка HelpDesk с комментариями по GET параметру *cabinet_ticket* с ID.
Возможность комментирования заявки.
Параметр status: отображать в списке заявки HelpDesk с данным статусом.
Статья документации: [CarbonBilling:CRM. HelpDesk]
h3. cabinet_helpdesk_ticket_add
Кнопка и модальная форма создания заявки HelpDesk.
Параметр add_class: добавить CSS класс к кнопке.
Параметр status: создавать заявку с указанным статусом.
Статья документации: [CarbonBilling:CRM. HelpDesk]
h3. cabinet_iptv
Список учетных записей абонента с привязкой к IPTV оборудованию.
[CarbonBilling:ЛК. Отображение учетных записей IPTV]
h3. cabinet_megogo
Лендинг IPTV Megogo.
Статья документации: [Интеграция с Megogo]
h3. cabinet_old_cabinet
Детальная статистика _(устарело)_.
[Детальная статистика в личном кабинете]
h3. cabinet_payment
Форма оплаты платежной системы в личном кабинете.
Статья документации: [CarbonBilling:Отображение платежных систем в личном кабинете абонента]
h3. cabinet_payment_result
После возврата с сайта платежной системы выводит информацию о платеже и/или результате операции.
Поддерживается некоторыми платежными системами. Информация о поддержке указана в статье о платежной системе (раздел [CarbonBilling:Платёжные системы]).
Для работы шорткода необходимо создать страницу paycheck в ЛК с адресом {code}<Адрес ЛК>/cabinet/paycheck/{code} и содержащей шорткод {code}[cabinet_payment_result]{code}
h3. cabinet_promise_pay
Форма подключения обещанного платежа.
Статья о замене шаблона страницы на подробное описание обещанного платежа: [CarbonBilling:Замена шаблонов страниц личного кабинета]
h3. cabinet_redirect
Перенаправление браузера.
Параметр url: ссылка для перенаправления.
h3. cabinet_rensoft_wordpress
Магазин программного обеспечения Rentsoft.
Статья документации: [ПО по подписке (Rentsoft)|CarbonBilling:ПО по подписке (Rentsoft)]
h3. cabinet_reports
Отчеты из [CarbonBilling:Конструктор отчетов].
Статья документации: [Отчёты в личном кабинете]
h3. cabinet_set_user_info
Смена данных абонента.
Параметрами являются поля абонента.
Примеры использования:
Статья документации: [CarbonBilling:Изменение данных абонента в ЛК]
Пример использования: [Настройка SMS оповещений в личном кабинете]
h3. cabinet_tarif_info
Информация о текущем тарифе абонента.
h3. cabinet_tarif_list
Список тарифов. Параметры:
* only_available=1 - отображать в списке только тарифы доступные абоненту
h3. cabinet_user_info
Информация об абоненте.
h3. cabinet_user_info_sidebar
Данные абонента, предназначенные для левого сайдбара.
Статьи документации:
* [CarbonBilling:Настройка выводимой информации в левом сайдбаре ЛК]
* [CarbonBilling:Wordpress. Настройка меню кабинета.]
h3. cabinet_uslugi
Список услуг абонента и форма подключения доступных услуг.
h2. Добавление опций к шорткоду
Добавить опции к шорткоду можно следующим образом: \[ Шорткод Опция1=Значение1 Опция2=Значение2 \]
Пример, добавляем к *шорткоду* cabinet_tarif_list *опцию* only_available со *значением* 1:
{code}
[cabinet_tarif_list only_available=1]
{code}