Spotlight Class Reference

Basic class describing a spotlight. More...

List of all members.

Public Member Functions
	getAssocId ()
	getAssocType ()
	getDescription ($locale)
	getLocalizedDescription ()
	getLocalizedTitle ()
	getLocalizedType ()
	getPressId ()
	getSpotlightItem ()
	getTitle ($locale)
	setAssocId ($assocId)
	setAssocType ($assocType)
	setDescription ($description, $locale)
	setPressId ($pressId)
	setTitle ($title, $locale)
	Spotlight ()

---

Detailed Description

Basic class describing a spotlight.

See also:

SpotlightDAO

Definition at line 22 of file Spotlight.inc.php.

---

Member Function Documentation

Spotlight.getAssocId

(

)

Get assoc ID for this spotlight.

Returns:

int

Definition at line 38 of file Spotlight.inc.php.

Referenced by getSpotlightItem().

Spotlight.getAssocType

(

)

Get assoc type for this spotlight.

Returns:

int

Definition at line 54 of file Spotlight.inc.php.

Referenced by getLocalizedType(), and getSpotlightItem().

Spotlight.getDescription

(

$

locale

)

Get spotlight description.

Parameters:

$locale

string

Returns:

string

Definition at line 121 of file Spotlight.inc.php.

Spotlight.getLocalizedDescription

(

)

Get localized full description

Returns:

string

Definition at line 112 of file Spotlight.inc.php.

Spotlight.getLocalizedTitle

(

)

Get localized spotlight title

Returns:

string

Definition at line 86 of file Spotlight.inc.php.

Spotlight.getLocalizedType

(

)

Fetch a plain text (localized) string for this Spotlight type

Returns:

string

Definition at line 138 of file Spotlight.inc.php.

References getAssocType().

Spotlight.getPressId

(

)

Get the press id for this spotlight.

Returns:

int

Definition at line 70 of file Spotlight.inc.php.

Referenced by getSpotlightItem().

Spotlight.getSpotlightItem

(

)

Returns the associated item with this spotlight.

Returns:

DataObject

Definition at line 152 of file Spotlight.inc.php.

References getAssocId(), getAssocType(), and getPressId().

Spotlight.getTitle

(

$

locale

)

Get spotlight title.

Parameters:

$locale

Returns:

string

Definition at line 95 of file Spotlight.inc.php.

Spotlight.setAssocId

(

$

assocId

)

Set assoc ID for this spotlight.

Parameters:

$assocId

int

Definition at line 46 of file Spotlight.inc.php.

Spotlight.setAssocType

(

$

assocType

)

Set assoc type for this spotlight.

Parameters:

$assocType

int

Definition at line 62 of file Spotlight.inc.php.

Spotlight.setDescription	(	$	description,
		$	locale
	)

Set spotlight description.

Parameters:

	$description	string
	$locale	string

Definition at line 130 of file Spotlight.inc.php.

Spotlight.setPressId

(

$

pressId

)

Set press Id for this spotlight.

Parameters:

$pressId

int

Definition at line 78 of file Spotlight.inc.php.

Spotlight.setTitle	(	$	title,
		$	locale
	)

Set spotlight title.

Parameters:

	$title	string
	$locale	string

Definition at line 104 of file Spotlight.inc.php.

Spotlight.Spotlight

(

)

Constructor

Definition at line 26 of file Spotlight.inc.php.

---

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

• classes/spotlight/Spotlight.inc.php