Inheritance diagram for Series:

Public Member Functions
	__construct ()

	getDescription ($locale)

	getEditorsString ()

	getFeatured ()

	getImage ()

	getIsInactive ()

	getLocalizedDescription ()

	getLocalizedFullTitle ()

	getLocalizedPrefix ()

	getLocalizedSubtitle ()

	getLocalizedTitle ($includePrefix=true)

	getOnlineISSN ()

	getPath ()

	getPrefix ($locale)

	getPressId ()

	getPrintISSN ()

	getSortOption ()

	getSubtitle ($locale)

	getTitle ($locale, $includePrefix=true)

	setDescription ($description, $locale)

	setFeatured ($featured)

	setImage ($image)

	setIsInactive ($isInactive)

	setOnlineISSN ($onlineIssn)

	setPath ($path)

	setPrefix ($prefix, $locale)

	setPressId ($pressId)

	setPrintISSN ($printIssn)

	setSortOption ($sortOption)

	setSubtitle ($subtitle, $locale)

Public Member Functions inherited from PKPSection
	getContextId ()

	getEditorRestricted ()

	getLocalizedPolicy ()

	getLocalizedTitle ()

	getPolicy ($locale)

	getReviewFormId ()

	getSequence ()

	getTitle ($locale)

	getViews ()

	setContextId ($contextId)

	setEditorRestricted ($editorRestricted)

	setPolicy ($policy, $locale)

	setReviewFormId ($reviewFormId)

	setSequence ($sequence)

	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

Describes basic series properties.

See also: SeriesDAO

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

Constructor & Destructor Documentation

◆ __construct()

Series::__construct ( )

Constructor.

Reimplemented from DataObject.

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

Member Function Documentation

◆ getDescription()

Series::getDescription ( $locale )

Get series description.

Returns: string

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

References DataObject\getData().

◆ getEditorsString()

Series::getEditorsString ( )

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

Returns: string

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

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

◆ getFeatured()

Series::getFeatured ( )

Get the featured flag.

Returns: boolean

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

References DataObject\getData().

◆ getImage()

Series::getImage ( )

Get the image.

Returns: array

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

References DataObject\getData().

◆ getIsInactive()

Series::getIsInactive ( )

Return boolean indicating if series should be inactivated.

Returns: int

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

References DataObject\getData().

◆ getLocalizedDescription()

Series::getLocalizedDescription ( )

Get series description.

Returns: string

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

References DataObject\getLocalizedData().

◆ getLocalizedFullTitle()

Series::getLocalizedFullTitle ( )

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

Returns: string

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

References PKPString\concatTitleFields(), getLocalizedSubtitle(), and PKPSection\getLocalizedTitle().

◆ getLocalizedPrefix()

Series::getLocalizedPrefix ( )

Get localized prefix for the series.

Returns: string

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

References DataObject\getLocalizedData().

Referenced by getLocalizedTitle().

◆ getLocalizedSubtitle()

Series::getLocalizedSubtitle ( )

Get the localized version of the subtitle

Returns: string

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

References DataObject\getLocalizedData().

Referenced by getLocalizedFullTitle().

◆ getLocalizedTitle()

Series::getLocalizedTitle ( $includePrefix = true )

Get localized title of section.

Parameters

$includePrefix bool

Returns: string

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

References DataObject\getLocalizedData(), and getLocalizedPrefix().

◆ getOnlineISSN()

Series::getOnlineISSN ( )

Get online ISSN.

Returns: string

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

References DataObject\getData().

◆ getPath()

Series::getPath ( )

Get path to series (in URL).

Returns: string

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

References DataObject\getData().

◆ getPrefix()

Series::getPrefix ( $locale )

Get prefix of series.

Parameters

$locale string

Returns: string

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

References DataObject\getData().

Referenced by getTitle().

◆ getPressId()

Series::getPressId ( )

Get ID of press.

Returns: int

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

References PKPSection\getContextId().

Referenced by getEditorsString().

◆ getPrintISSN()

Series::getPrintISSN ( )

Get print ISSN.

Returns: string

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

References DataObject\getData().

◆ getSortOption()

Series::getSortOption ( )

Get the option how the books in this series should be sorted, in the form: concat(sortBy, sortDir).

Returns: string

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

References DataObject\getData().

◆ getSubtitle()

Series::getSubtitle ( $locale )

Get the subtitle for a given locale

Parameters

string $locale

Returns: string

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

References DataObject\getData().

◆ getTitle()

Series::getTitle	(	$locale,
		$includePrefix = `true`
	)

Get title of section.

Parameters

$locale
$includePrefix	bool

Returns: string

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

References DataObject\getData(), and getPrefix().

◆ setDescription()

Series::setDescription	(	$description,
		$locale
	)

Set series description.

Parameters

string

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

References DataObject\setData().

◆ setFeatured()

Series::setFeatured ( $featured )

Set the featured flag.

Parameters

$featured boolean

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

References DataObject\setData().

◆ setImage()

Series::setImage ( $image )

Set the image.

Parameters

$image array

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

References DataObject\setData().

◆ setIsInactive()

Series::setIsInactive ( $isInactive )

Set if series should be inactivated.

Parameters

$isInactive int

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

References DataObject\setData().

◆ setOnlineISSN()

Series::setOnlineISSN ( $onlineIssn )

Set online ISSN.

Parameters

$onlineIssn string

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

References DataObject\setData().

◆ setPath()

Series::setPath ( $path )

Set path to series (in URL).

Parameters

$path string

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

References DataObject\setData().

◆ setPrefix()

Series::setPrefix	(	$prefix,
		$locale
	)

Set prefix of series.

Parameters

$prefix	string
$locale	string

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

References DataObject\setData().

◆ setPressId()

Series::setPressId ( $pressId )

Set ID of press.

Parameters

$pressId int

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

References PKPSection\setContextId().

◆ setPrintISSN()

Series::setPrintISSN ( $printIssn )

Set print ISSN.

Parameters

$printIssn string

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

References DataObject\setData().

◆ setSortOption()

Series::setSortOption ( $sortOption )

Set the option how the books in this series should be sorted, in the form: concat(sortBy, sortDir).

Parameters

$sortOption string

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

References DataObject\setData().

◆ setSubtitle()

Series::setSubtitle	(	$subtitle,
		$locale
	)

Set the subtitle for a locale

Parameters

string	$subtitle
string	$locale

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

References DataObject\setData().

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

Series.inc.php

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDescription()

◆ getEditorsString()

◆ getFeatured()

◆ getImage()

◆ getIsInactive()

◆ getLocalizedDescription()

◆ getLocalizedFullTitle()

◆ getLocalizedPrefix()

◆ getLocalizedSubtitle()

◆ getLocalizedTitle()

◆ getOnlineISSN()

◆ getPath()

◆ getPrefix()

◆ getPressId()

◆ getPrintISSN()

◆ getSortOption()

◆ getSubtitle()

◆ getTitle()

◆ setDescription()

◆ setFeatured()

◆ setImage()

◆ setIsInactive()

◆ setOnlineISSN()

◆ setPath()

◆ setPrefix()

◆ setPressId()

◆ setPrintISSN()

◆ setSortOption()

◆ setSubtitle()