Интерфейс ILearnPath

Граф наследования:ILearnPath:

Открытые члены
	__construct ()
	SetPath ()
	SetPathFromArray ($arPath)
	ImportUrlencoded ($str)
	ExportUrlencoded ()
	GetPathAsArray ()
	GetTop ()
	GetBottom ()
	PopBottom ()
	ShiftTop ()
	Count ()
	GetPathAsHumanReadableString ($delimiter='/', $pattern='#NAME#')

Подробное описание

См. определение в файле clearnpath.php строка 3

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

__construct()

__construct

(

)

Аргументы

integer/string/array

(if string must be strictly castable to integer). allowed many params. First param - is the id of top, etc. if array => than it must be one argument and it will be parsed as path in format for self::SetPathFromArray()

Замещается в CLearnPath.

Методы

Count()

Count

(

)

Возвращает

integer count of elements in path

Замещается в CLearnPath.

ExportUrlencoded()

ExportUrlencoded

(

)

Возвращает

string urlencoded path, which can be used for importUrlencoded()

Замещается в CLearnPath.

GetBottom()

GetBottom

(

)

Возвращает

integer/bool id of bottom (right) element in path. If path is empty - returns FALSE

Замещается в CLearnPath.

GetPathAsArray()

GetPathAsArray

(

)

Возвращает

array of lessons' ids in current path (from top to bottom)

Замещается в CLearnPath.

GetPathAsHumanReadableString()

GetPathAsHumanReadableString	(		$delimiter = '/',
			$pattern = '#NAME#' )

Аргументы

string	delimiter, by default is ' / '
string	pattern, how names will be renderred. Default pattern is '#NAME#' Available fields: #NAME#, #LESSON_ID#

Возвращает

string such as "Course bla bla bla / chapter XXX / lesson XXX"

Замещается в CLearnPath.

GetTop()

GetTop

(

)

Возвращает

integer/bool id of top (left) element in path. If path is empty - returns FALSE

Замещается в CLearnPath.

ImportUrlencoded()

ImportUrlencoded

(

$str

)

Аргументы

string

urlencoded path, which can produced by exportUrlencoded()

Замещается в CLearnPath.

PopBottom()

PopBottom

(

)

Removes last element (if exists) from path

Возвращает

integer/bool id of bottom (right) element in path. If path is empty - returns FALSE

Замещается в CLearnPath.

SetPath()

SetPath

(

)

Аргументы

integer/string

(if string must be strictly castable to integer). allowed many params. First param - is the id of top, etc.

Замещается в CLearnPath.

SetPathFromArray()

SetPathFromArray

(

$arPath

)

Аргументы

array

of lessons' ids

Замещается в CLearnPath.

ShiftTop()

ShiftTop

(

)

Removes first element (if exists) from path

Возвращает

integer/bool id of first (left) element in path. If path is empty - returns FALSE

Замещается в CLearnPath.

---

Объявления и описания членов интерфейса находятся в файле:

• C:/bitrix/modules/learning/classes/general/clearnpath.php