Документация для разработчиков
Темная тема

convert

Описание и параметры

string
convert(
 string text,
 bool   bPreview = true,
 array  arImages = array(),
 array  arAllow = array("HTML" =>   "N", 
                        "ANCHOR" => "Y", 
                        "BIU" =>    "Y", 
                        "IMG" =>    "Y", 
                        "QUOTE" =>  "Y", 
                        "CODE" =>   "Y", 
                        "FONT" =>   "Y", 
                        "LIST" =>   "Y", 
                        "SMILES" => "Y", 
                        "NL2BR" =>  "N")
);

Метод форматирует текст text в соответствии с параметрами bPreview, arImages, arAllow. Метод нестатический.

Параметры метода

ПараметрОписание С версии
text Исходный текст сообщения.
bPreview Флаг - обрезать ли текст для просмотра (по тегу [CUT]).
Необязательный. По умолчанию true - текст будет обрезан до тега [CUT].
arImages Массив вида array(array(IMAGE_ID, FILE_ID)[, ...]).
  • IMAGE_ID - идентификaтор изображения в сообщении;
  • FILE_ID - идентификатор файла этого изображения.
Необязательный. По умолчания теги изображений не будут заменяться.
arAllow Массив параметров форматирования сообщения. Необязательный параметр. Допустимы следующие параметры:
  • HTML - в тексте могут содержаться любые HTML теги
  • ANCHOR - разрешен тег <a>;
  • BIU - разрешены теги <b>, <i>, <u>;
  • IMG - разрешен тег <img>;
  • QUOTE - разрешен тег цитирования <quote>;
  • CODE - разрешен тег показа кода <code>;
  • FONT - разрешен тег <font>;
  • LIST - разрешены теги <ul>, <li>;
  • SMILES - показ смайликов в виде картинок;
  • NL2BR - заменять переводы каретки на тег <br> при разрешении принимать любые HTML теги;
  • VIDEO;
  • TABLE;
  • CUT_ANCHOR;
  • SHORT_ANCHOR.
Параметры могут принимать значения Y и N.
type Необязательный параметр. Значение по умолчанию - "html". Удален с версии 10.0.0 9.0.0
arParams Необязательный параметр. 12.0.0

Возвращаемое значение

Метод возвращает отформатированное сообщение.

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

<?
$arPost = CBlogPost::GetByID(3);
$p = new blogTextParser();

$res = CBlogImage::GetList(array("ID"=>"ASC"),
                           array("POST_ID"=>$arPost['ID'], 
                           "BLOG_ID"=>$arPost['BLOG_ID']));
while ($arImage = $res->Fetch())
    $arImages[$arImage['ID']] = $arImage['FILE_ID'];

$text = $p->convert($arPost["DETAIL_TEXT"], false, $arImages);
?>


Пользовательские комментарии

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

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2023, «1С-Битрикс», 2023
Наверх