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

Public Member Functions

 getDescription ($locale)
 
 getEditorsString ()
 
 getFeatured ()
 
 getImage ()
 
 getLocalizedDescription ()
 
 getLocalizedFullTitle ()
 
 getLocalizedPrefix ()
 
 getLocalizedSubtitle ()
 
 getPrefix ($locale)
 
 getPressId ()
 
 getSequence ()
 
 getSubtitle ($locale)
 
 Series ()
 
 setDescription ($description, $locale)
 
 setFeatured ($featured)
 
 setImage ($image)
 
 setPrefix ($prefix, $locale)
 
 setPressId ($pressId)
 
 setSequence ($sequence)
 
 setSubtitle ($subtitle, $locale)
 
- Public Member Functions inherited from PKPSection
 getContextId ()
 
 getEditorRestricted ()
 
 getLocalizedTitle ()
 
 getPath ()
 
 getTitle ($locale)
 
 getViews ()
 
 PKPSection ()
 
 setContextId ($contextId)
 
 setEditorRestricted ($editorRestricted)
 
 setPath ($path)
 
 setTitle ($title, $locale)
 
- 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 basic series properties.

See Also
SeriesDAO

Definition at line 19 of file Series.inc.php.

Member Function Documentation

Series::getDescription (   $locale)

Get series description.

Returns
string

Definition at line 126 of file Series.inc.php.

References DataObject\getData().

Series::getEditorsString ( )

Returns a string with the full name of all series editors, separated by a comma.

Returns
string

Definition at line 191 of file Series.inc.php.

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

Series::getFeatured ( )

Get the featured flag.

Returns
boolean

Definition at line 142 of file Series.inc.php.

References DataObject\getData().

Series::getImage ( )

Get the image.

Returns
array

Definition at line 158 of file Series.inc.php.

References DataObject\getData().

Series::getLocalizedDescription ( )

Get series description.

Returns
string

Definition at line 118 of file Series.inc.php.

References DataObject\getLocalizedData().

Series::getLocalizedFullTitle ( )

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

Returns
string

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

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

Series::getLocalizedPrefix ( )

Get localized prefix for the series.

Returns
string

Definition at line 66 of file Series.inc.php.

References DataObject\getLocalizedData().

Referenced by getLocalizedFullTitle().

Series::getLocalizedSubtitle ( )

Get the localized version of the subtitle

Returns
string

Definition at line 92 of file Series.inc.php.

References DataObject\getLocalizedData().

Referenced by getLocalizedFullTitle().

Series::getPrefix (   $locale)

Get prefix of series.

Parameters
$localestring
Returns
string

Definition at line 75 of file Series.inc.php.

References DataObject\getData().

Series::getPressId ( )

Get ID of press.

Returns
int

Definition at line 31 of file Series.inc.php.

References PKPSection\getContextId().

Referenced by getEditorsString().

Series::getSequence ( )

Get sequence of series.

Returns
float

Definition at line 174 of file Series.inc.php.

References DataObject\getData().

Series::getSubtitle (   $locale)

Get the subtitle for a given locale

Parameters
string$locale
Returns
string

Definition at line 101 of file Series.inc.php.

References DataObject\getData().

Series::Series ( )

Constructor.

Definition at line 23 of file Series.inc.php.

Series::setDescription (   $description,
  $locale 
)

Set series description.

Parameters
string

Definition at line 134 of file Series.inc.php.

References DataObject\setData().

Series::setFeatured (   $featured)

Set the featured flag.

Parameters
$featuredboolean

Definition at line 150 of file Series.inc.php.

References DataObject\setData().

Series::setImage (   $image)

Set the image.

Parameters
$imagearray

Definition at line 166 of file Series.inc.php.

References DataObject\setData().

Series::setPrefix (   $prefix,
  $locale 
)

Set prefix of series.

Parameters
$prefixstring
$localestring

Definition at line 84 of file Series.inc.php.

References DataObject\setData().

Series::setPressId (   $pressId)

Set ID of press.

Parameters
$pressIdint

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

References PKPSection\setContextId().

Series::setSequence (   $sequence)

Set sequence of series.

Parameters
$sequencefloat

Definition at line 182 of file Series.inc.php.

References DataObject\setData().

Series::setSubtitle (   $subtitle,
  $locale 
)

Set the subtitle for a locale

Parameters
string$subtitle
string$locale

Definition at line 110 of file Series.inc.php.

References DataObject\setData().


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