babaev-an / ANB Python Components
CI/CD
Реестр контейнеров и пакетов

class_desc/models/shortcode_model.md

Класс модели ShortCodeModel

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

Основная информация

  • Имя файла: anb_python_components\models\shortcode_model.py
  • Автор: —
  • Версия: 1.0.0
  • Дата начала поддержки: с версии 1.1

Атрибуты и методы класса

Конструктор (__init__)

Принимает четыре параметра, которые определяют поведение шорткода:

  • short_code: str | None: Буква, символ или последовательность символов, которая будет использоваться для шорткода. Если не указана, то будет использована пустая строка. По умолчанию, None.
  • on_set: Обработчик, вызываемый при включении шорткода (функция с двумя аргументами: содержимое и параметры).
  • on_unset: Обработчик, вызываемый при выключении шорткода (аналогичен on_set).
  • on_validate: Обработчик, вызываемый при проверке корректности самого шорткода.

Пример использования:

from anb_python_components import ShortCodeModel

model = ShortCodeModel(
        short_code = 'SC',
        on_set = lambda content, params: f'<strong>{content}</strong>',
        on_unset = lambda content, params: content,
        on_validate = lambda content, params: len(content) > 0
        )

Основные атрибуты

  • shortcode: Текущий шорткод.
  • on_set, on_unset, on_validate: Связанные обработчики действий.

Заключение

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

На главную

Назад