Skip to content

Structure of a bbcode

Visman edited this page Jan 6, 2021 · 6 revisions

Each bb-code is declared by means of an array. / Каждый bb-код объявляется с помощью массива.

It is a lot of examples: / Много примеров: bbcodes_test.php

Structure

  • 'tag' => string, required
    BB-code name. / Имя bb-кода.
    Name format: ^[a-z\*][a-z\d-]{0,10}$

  • 'type' => string
    BB-code type. / Тип bb-кода.
    inline by default. / По умолчанию inline.

  • 'parents' => array
    Types of a parent bb-code. / Типы родительского bb-кода.
    ['inline', 'block'] by default for inline bb-codes, ['block'] by default for other bb-codes. / По умолчанию ['inline', 'block'] для bb-кода с типом inline и ['block'] для других типов.

  • 'handler' => null|Closure
    The processor for HTML output. / Обработчик для вывода HTML.
    null by default. / По умолчанию null.

  • 'text_handler' => null|Closure (v 0.9.3+)
    The processor for TEXT output. / Обработчик для вывода текста без bb-кодов.
    null by default. / По умолчанию null.

  • 'recursive' => true
    It is the recursive bb-code. Before the end of recursion doesn't react to other bb-codes. / Это рекурсивный bb-код. До окончания рекурсии не реагирует на другие bb-коды.
    null by default. / По умолчанию null.

  • 'text_only' => true
    This bb-code contains only the text. / Этот bb-код содержит только текст.
    null by default. / По умолчанию null.

  • 'tags_only' => true
    This bb-code contains only other bb-codes. / Этот bb-код содержит только другие bb-коды.
    null by default. / По умолчанию null.

  • 'pre' => true
    Characters the new line, tabulation and spaces standing nearby won't be replaced. / Символы перевод строки, табуляция и пробелы стоящие рядом не будут заменены.
    null by default. / По умолчанию null.

  • 'single' => true
    Single tag. / Одиночный тег.
    null by default. / По умолчанию null.

  • 'self_nesting' => bool (v 0.9.2+ false or positive int)
    May it be nested a bb-code in same. And how many times. / Может ли это bb-код быть вложен в такой же. И сколько раз.
    false by default. / По умолчанию false.

  • 'auto' => bool
    Autoclosing of this tag with other bb-code. / Автозакрытие тега другим bb-кодом.
    true by default for inline bb-codes, false by default for other bb-codes. / По умолчанию true для bb-кода с типом inline и false для других типов.

  • 'attrs' => null|array
    Listing of attributes. / Перечисление атрибутов.
    null by default. / По умолчанию null.

    • 'No_attr' => true|array
      The description for this bb-code without attributes. / Описание для bb-кода без атрибутов.
      The array contains rules for this bb-code body. / Массив содержит правила для тела bb-кода.

      • 'body_format' => string
        The regular expression, sets the rule for a tag body. / Регулярное выражение, задает правило для тела тега.
        null by default. / По умолчанию null.
        You shall remember about the modifier D. / Помните про модификатор D.

      • 'text_only' => true
        This bb-code contains only the text. / Этот bb-код содержит только текст.
        null by default. / По умолчанию null.

    • 'Def' => true|array
      The description for primary attribute. / Описание для первичного атрибута.
      The array contains rules for attribute and (or) the body of this bb-code. / Массив содержит правила для атрибута и(или) тела bb-кода.

      • 'required' => true
        Required attribute. / Обязательный атрибут.
        null by default. / По умолчанию null.

      • 'format' => string
        The regular expression, sets the rule for attribute. / Регулярное выражение, задает правило для атрибута.
        null by default. / По умолчанию null.

      • 'body_format' => string
        The regular expression, sets the rule for a tag body. / Регулярное выражение, задает правило для тела тега.
        null by default. / По умолчанию null.
        You shall remember about the modifier D. / Помните про модификатор D.

      • 'text_only' => true
        This bb-code contains only the text. / Этот bb-код содержит только текст.
        null by default. / По умолчанию null.

    • 'name' => true|array
      The description for secondary attribute with the name name. / Описание для вторичного атрибута с именем name.
      The array contains rules for attribute and (or) the body of this bb-code. / Массив содержит правила для атрибута и(или) тела bb-кода.

    • ...
Clone this wiki locally