getDescription

string
public function getDescription(
	$format = CTaskItem::DESCR_FORMAT_HTML
);

This method returns description for task.

Parameter	Description
$format	Available values: CTaskItem::DESCR_FORMAT_HTML — description will be returned in HTML format, and will be preliminarily processed by sanitizer (if it is enabled in the task module settings); CTaskItem::DESCR_FORMAT_PLAIN_TEXT — description will be returned as the «flat» text (without HTML-tags); CTaskItem::DESCR_FORMAT_RAW — description will be returned in the same format, in which it is stored in the database (HTML, or BB-code), Sanitizer processing will not be performed.

Parameter

Description

$format

Available values:

CTaskItem::DESCR_FORMAT_HTML — description will be returned in HTML format, and will be preliminarily processed by sanitizer (if it is enabled in the task module settings);
CTaskItem::DESCR_FORMAT_PLAIN_TEXT — description will be returned as the «flat» text (without HTML-tags);
CTaskItem::DESCR_FORMAT_RAW — description will be returned in the same format, in which it is stored in the database (HTML, or BB-code), Sanitizer processing will not be performed.