Spotlight Class Reference

Inheritance diagram for Spotlight:

Public Member Functions
	__construct ()
	getAssocId ()
	getAssocType ()
	getDescription ($locale)
	getLocalizedDescription ()
	getLocalizedTitle ()
	getLocalizedType ()
	getPressId ()
	getSpotlightItem ()
	getTitle ($locale)
	setAssocId ($assocId)
	setAssocType ($assocType)
	setDescription ($description, $locale)
	setPressId ($pressId)
	setTitle ($title, $locale)
Public Member Functions inherited from DataObject
	addSupportedMetadataAdapter ($metadataAdapter)
	extractMetadata ($metadataSchema)
	getAdditionalMetadataFieldNames ()
&	getAllData ()
	getDAO ()
&	getData ($key, $locale=null)
	getHasLoadableAdapters ()
	getId ()
	getLocaleMetadataFieldNames ()
	getLocalizedData ($key, $preferredLocale=null)
	getMetadataFieldNames ($translated=true)
	getSetMetadataFieldNames ($translated=true)
	getSupportedExtractionAdapters ()
	getSupportedInjectionAdapters ()
	getSupportedMetadataSchemas ()
	hasData ($key, $locale=null)
	injectMetadata ($metadataDescription)
	removeSupportedMetadataAdapter ($metadataSchemaName)
	setAllData (&$data)
	setData ($key, $value, $locale=null)
	setHasLoadableAdapters ($hasLoadableAdapters)
	setId ($id)
	unsetData ($key, $locale=null)
	upcastTo ($targetObject)

Additional Inherited Members
Data Fields inherited from DataObject
	$_data = array()
	$_extractionAdaptersLoaded = false
	$_hasLoadableAdapters = false
	$_injectionAdaptersLoaded = false
	$_metadataExtractionAdapters = array()
	$_metadataInjectionAdapters = array()

Detailed Description

Basic class describing a spotlight.

See also

SpotlightDAO

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

Constructor & Destructor Documentation

__construct()

Spotlight::__construct

(

)

Constructor

Reimplemented from DataObject.

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

Member Function Documentation

getAssocId()

Spotlight::getAssocId

(

)

Get assoc ID for this spotlight.

Returns

int

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

References DataObject\getData().

Referenced by getSpotlightItem().

getAssocType()

Spotlight::getAssocType

(

)

Get assoc type for this spotlight.

Returns

int

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

References DataObject\getData().

Referenced by getLocalizedType(), and getSpotlightItem().

getDescription()

Spotlight::getDescription

(

$locale

)

Get spotlight description.

Parameters

$locale

string

Returns

string

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

References DataObject\getData().

getLocalizedDescription()

Spotlight::getLocalizedDescription

(

)

Get localized full description

Returns

string

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

References DataObject\getLocalizedData().

getLocalizedTitle()

Spotlight::getLocalizedTitle

(

)

Get localized spotlight title

Returns

string

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

References DataObject\getLocalizedData().

getLocalizedType()

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().

getPressId()

Spotlight::getPressId

(

)

Get the press id for this spotlight.

Returns

int

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

References DataObject\getData().

Referenced by getSpotlightItem().

getSpotlightItem()

Spotlight::getSpotlightItem

(

)

Returns the associated item with this spotlight.

Returns

DataObject

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

References PKPServices\get(), getAssocId(), getAssocType(), DAORegistry\getDAO(), and getPressId().

getTitle()

Spotlight::getTitle

(

$locale

)

Get spotlight title.

Parameters

$locale

Returns

string

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

References DataObject\getData().

setAssocId()

Spotlight::setAssocId

(

$assocId

)

Set assoc ID for this spotlight.

Parameters

$assocId

int

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

References DataObject\setData().

setAssocType()

Spotlight::setAssocType

(

$assocType

)

Set assoc type for this spotlight.

Parameters

$assocType

int

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

References DataObject\setData().

setDescription()

Spotlight::setDescription	(		$description,
			$locale
	)

Set spotlight description.

Parameters

$description	string
$locale	string

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

References DataObject\setData().

setPressId()

Spotlight::setPressId

(

$pressId

)

Set press Id for this spotlight.

Parameters

$pressId

int

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

References DataObject\setData().

setTitle()

Spotlight::setTitle	(		$title,
			$locale
	)

Set spotlight title.

Parameters

$title	string
$locale	string

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

References DataObject\setData().

---

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

• Spotlight.inc.php