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

Public Member Functions

 Chapter ()
 
 getAuthorNamesAsString ()
 
 getAuthors ()
 
 getLocalizedFullTitle ()
 
 getLocalizedSubtitle ()
 
 getLocalizedTitle ()
 
 getMonographId ()
 
 getSequence ()
 
 getSubtitle ($locale=null)
 
 getTitle ($locale=null)
 
 setMonographId ($monographId)
 
 setSequence ($sequence)
 
 setSubtitle ($subtitle, $locale=null)
 
 setTitle ($title, $locale=null)
 
- 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

Describes a monograph chapter (or section)

See Also
ChapterDAO

Definition at line 17 of file Chapter.inc.php.

Member Function Documentation

Chapter::Chapter ( )

Constructor

Definition at line 21 of file Chapter.inc.php.

Chapter::getAuthorNamesAsString ( )

Get the author names for this chapter and return them as a string.

Returns
string

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

References getAuthors().

Chapter::getAuthors ( )

Get all authors of this chapter.

Returns
array Authors

Definition at line 129 of file Chapter.inc.php.

References DAORegistry\getDAO(), DataObject\getId(), and getMonographId().

Referenced by getAuthorNamesAsString().

Chapter::getLocalizedFullTitle ( )

Get the chapter full title (with title and subtitle).

Returns
string

Definition at line 48 of file Chapter.inc.php.

References String\concatTitleFields(), getLocalizedSubtitle(), and getLocalizedTitle().

Chapter::getLocalizedSubtitle ( )

Get localized sub title of a chapter.

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

References DataObject\getLocalizedData().

Referenced by getLocalizedFullTitle().

Chapter::getLocalizedTitle ( )

Get localized title of a chapter.

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

References DataObject\getLocalizedData().

Referenced by getLocalizedFullTitle().

Chapter::getMonographId ( )

Get the monographId this chapter belongs to

Returns
int

Definition at line 32 of file Chapter.inc.php.

References DataObject\getData().

Referenced by getAuthors().

Chapter::getSequence ( )

Get sequence of chapter.

Returns
float

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

References DataObject\getData().

Chapter::getSubtitle (   $locale = null)

Get sub title of chapter (primary locale)

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Chapter::getTitle (   $locale = null)

Get title of chapter (primary locale)

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Chapter::setMonographId (   $monographId)

Set the monographId this chapter belongs to

Parameters
int$monographId

Definition at line 40 of file Chapter.inc.php.

References DataObject\setData().

Chapter::setSequence (   $sequence)

Set sequence of chapter.

Parameters
$sequencefloat

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

References DataObject\setData().

Chapter::setSubtitle (   $subtitle,
  $locale = null 
)

Set sub title of chapter

Parameters
$subtitlestring
$localestring

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

References DataObject\setData().

Chapter::setTitle (   $title,
  $locale = null 
)

Set title of chapter

Parameters
$titlestring
$localestring

Definition at line 80 of file Chapter.inc.php.

References DataObject\setData().


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