Класс ResultItem

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

Открытые члены
	__construct ($title, $showLink, $id=null)
	getId ()
	setId ($id)
	getType ()
	setType ($type)
	getTitle ()
	setTitle ($title)
	getShowLink ()
	setShowLink ($showLink)
	getModule ()
	setModule ($module)
	getSubTitle ()
	setSubTitle ($subTitle)
	getActions ()
	getLinks ()
	setLinks (array $links)
	addLink ($name, $link)
	getAttributes ()
	setAttributes ($attributes)
	setAttribute ($name, $value)
	unsetAttribute ($name)
	jsonSerialize ()
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)

Защищенные члены
	adjustLink ($link)

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

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

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

__construct()

__construct	(		$title,
			$showLink,
			$id = null )

ResultItem constructor.

Аргументы

	$title
Uri | string	$showLink
null	$id

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

Методы

addLink()

addLink	(		$name,
			$link )

Adds link on searched item.

Аргументы

string	$name	Name of link.
Uri | string	$link	Link.

Возвращает

$this

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

adjustLink()

adjustLink ( $link )

protected

Adjusts link.

Аргументы

Uri | string

$link

Link.

Возвращает

Uri

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

getActions()

getActions

(

)

Returns actions. It's reserved field and unused.

Возвращает

array

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

getAttributes()

getAttributes

(

)

Returns attributes.

Возвращает

array

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

getId()

getId

(

)

Returns id.

Возвращает

mixed

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

getLinks()

getLinks

(

)

Returns links on searched item.

Возвращает

Uri[]

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

getModule()

getModule

(

)

Returns module which provides searched item.

Возвращает

string

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

getShowLink()

getShowLink

(

)

Returns link to show searched item.

Возвращает

Uri

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

getSubTitle()

getSubTitle

(

)

Returns subtitle of searched item. Subtitle is is unnecessary.

Возвращает

string

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

getTitle()

getTitle

(

)

Returns title of searched item.

Возвращает

string

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

getType()

getType

(

)

Returns type of element. For example: lead, deal, file, folder, etc. Type is unnecessary.

Возвращает

string|null

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

jsonSerialize()

jsonSerialize

(

)

Specify data which should be serialized to JSON mixed data which can be serialized by json_encode, which is a value of any type other than a resource. 5.4.0

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

offsetExists()

offsetExists

(

$offset

)

Whether a offset exists mixed $offset An offset to check for.

Возвращает

boolean true on success or false on failure.

The return value will be casted to boolean if non-boolean was returned.

Начиная с

5.0.0

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

offsetGet()

offsetGet

(

$offset

)

Offset to retrieve mixed $offset The offset to retrieve.

Возвращает

mixed Can return all value types.

Начиная с

5.0.0

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

offsetSet()

offsetSet	(		$offset,
			$value )

Offset to set mixed $offset The offset to assign the value to.

Аргументы

mixed

$value

The value to set.

Возвращает

void

Начиная с

5.0.0

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

offsetUnset()

offsetUnset

(

$offset

)

Offset to unset mixed $offset The offset to unset.

Возвращает

void

Начиная с

5.0.0

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

setAttribute()

setAttribute	(		$name,
			$value )

Sets value for attribute with name.

Аргументы

string	$name
mixed	$value

Возвращает

$this

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

setAttributes()

setAttributes

(

$attributes

)

Sets attributes.

Аргументы

array

$attributes

Возвращает

ResultItem

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

setId()

setId

(

$id

)

Sets id.

Аргументы

mixed

$id

Возвращает

ResultItem

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

setLinks()

setLinks

(

array

$links

)

Sets links on searched item. Should be associative array.

Аргументы

Uri[] | string[]

$links

Links.

Возвращает

ResultItem

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

setModule()

setModule

(

$module

)

Sets module which provides searched item. Module is unnecessary and will generate automatically.

Аргументы

string

$module

Module id.

Возвращает

ResultItem

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

setShowLink()

setShowLink

(

$showLink

)

Sets link to show searched item.

Аргументы

Uri

$showLink

Show link.

Возвращает

ResultItem

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

setSubTitle()

setSubTitle

(

$subTitle

)

Sets subtitle of searched item. Subtitle is is unnecessary.

Аргументы

string

$subTitle

Subtitle.

Возвращает

ResultItem

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

setTitle()

setTitle

(

$title

)

Sets title of searched item.

Аргументы

string

$title

Title.

Возвращает

ResultItem

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

setType()

setType

(

$type

)

Sets type of element. For example: lead, deal, file, folder, etc. Type is unnecessary.

Аргументы

string

$type

Возвращает

ResultItem

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

unsetAttribute()

unsetAttribute

(

$name

)

Deletes attribute by name.

Аргументы

string

$name

Возвращает

$this

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

---

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

• C:/bitrix/modules/main/lib/search/resultitem.php