item Class Reference

Inheritance diagram for item:

Public Member Functions
	__construct ($guild, $slot, $icon_name, $q, $s)
	flunkerId ()
	getTitle ()
	barCode ()
	description ()
	getFormAndIconLi ()
	getIconLi ()
	getFormLi ()
Data Fields
	$ryzom_code
	<string> the "Ryzom" code : the Icon Name without ".sitem" at the end
	$flunker_code
	<string> the Flunker code : The code corresponding to the title of the Item
	$guild
	<guild> the guild which owns the item
	$slot
	<int> the position of the item in the inventory
	$icon_name
	<string> the Ryzom name of the icon
	$q
	<int> quality
	$s
	<int> stack size
Protected Member Functions
	_description ()
	_getIcon ()
	_getFormContent ()

---

Constructor & Destructor Documentation

__construct	(	$	guild,
		$	slot,
		$	icon_name,
		$	q,
		$	s
	)

Parameters:

	guild	<Guild> the guild which owns the item
	slot	<int> the position of the item in the inventory
	icon_name	<string> the Ryzom name of the icon
	q	<int> quality
	s	<int> stack size

---

Member Function Documentation

_description

(

)

[protected]

Get some word you do not find in the title and that can help the texte search.

Returns:

<string>a set of word, not a text

Reimplemented in itemCraft, cloth, and weapon.

_getFormContent

(

)

[protected]

Give the HTML code for displaying the content of the item form.

See also:

Use in getFormLi and getFormAndIconLi.

Returns:

<string> the HTML code

Reimplemented in itemCraft, cloth, jewel, weapon, meleeWeapon, rangeWeapon, and material.

_getIcon

(

)

[protected]

Give the HTML code for displaying the item icon.

See also:

Use in _getFormContent, getIconLi and getFormAndIconLi.

Returns:

<string> the HTML code

Reimplemented in cloth, weapon, and material.

barCode

(

)

Get the Flunker bar code of the Item. The code contains almost all information for filtring the item. The bar code : BC_{the Flunker/Ryzom code}_

Returns:

<string>

Reimplemented in cloth, jewel, weapon, and material.

description

(

)

Get the description of the Item.

Returns:

<string>a set of word, not a text

flunkerId

(

)

Get the Flunker identifiant of the Item. id : item_{id}_{slot}

Returns:

<string>

getFormAndIconLi

(

)

Give the HTML code for displaying the item icon and a hidden item form(start with the <li> balise).

Returns:

<string> the HTML code

getFormLi

(

)

Give the HTML code for displaying the item form(start with the <li> balise).

Returns:

<string> the HTML code

getIconLi

(

)

Give the HTML code for displaying the item icon(start with the <li> balise).

Returns:

<string> the HTML code

getTitle

(

)

Give the Ryzom title for the item. Need to load the file local/{lang}.code_{room}.php before.

Returns:

<string> the item title in the curent language

Reimplemented in itemCraft.

---

Field Documentation

$flunker_code

<string> the Flunker code : The code corresponding to the title of the Item

$guild

<guild> the guild which owns the item

$icon_name

<string> the Ryzom name of the icon

$q

<int> quality

$ryzom_code

<string> the "Ryzom" code : the Icon Name without ".sitem" at the end

$s

<int> stack size

$slot

<int> the position of the item in the inventory

---

The documentation for this class was generated from the following file:

• inc/core/class_item.php