Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
Spotlight Class Reference
Inheritance diagram for Spotlight:
DataObject

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 ()
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter ($metadataAdapter)
 
 DataObject ()
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 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)
 
 upcastTo ($targetObject)
 

Additional Inherited Members

- Public Attributes 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 23 of file Spotlight.inc.php.

Member Function Documentation

Spotlight::getAssocId ( )

Get assoc ID for this spotlight.

Returns
int

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

References DataObject\getData().

Referenced by getSpotlightItem().

Spotlight::getAssocType ( )

Get assoc type for this spotlight.

Returns
int

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

References DataObject\getData().

Referenced by getLocalizedType(), and getSpotlightItem().

Spotlight::getDescription (   $locale)

Get spotlight description.

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Spotlight::getLocalizedDescription ( )

Get localized full description

Returns
string

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

References DataObject\getLocalizedData().

Spotlight::getLocalizedTitle ( )

Get localized spotlight title

Returns
string

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

References DataObject\getLocalizedData().

Spotlight::getLocalizedType ( )

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

Returns
string

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

References getAssocType().

Spotlight::getPressId ( )

Get the press id for this spotlight.

Returns
int

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

References DataObject\getData().

Referenced by getSpotlightItem().

Spotlight::getSpotlightItem ( )

Returns the associated item with this spotlight.

Returns
DataObject

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

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

Spotlight::getTitle (   $locale)

Get spotlight title.

Parameters
$locale
Returns
string

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

References DataObject\getData().

Spotlight::setAssocId (   $assocId)

Set assoc ID for this spotlight.

Parameters
$assocIdint

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

References DataObject\setData().

Spotlight::setAssocType (   $assocType)

Set assoc type for this spotlight.

Parameters
$assocTypeint

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

References DataObject\setData().

Spotlight::setDescription (   $description,
  $locale 
)

Set spotlight description.

Parameters
$descriptionstring
$localestring

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

References DataObject\setData().

Spotlight::setPressId (   $pressId)

Set press Id for this spotlight.

Parameters
$pressIdint

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

References DataObject\setData().

Spotlight::setTitle (   $title,
  $locale 
)

Set spotlight title.

Parameters
$titlestring
$localestring

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

References DataObject\setData().

Spotlight::Spotlight ( )

Constructor

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


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