Series Class Reference [Press]

Describes basic series properties. More...

List of all members.

Public Member Functions
	getDescription ($locale)
	getDescription ($locale)
	getEditorsString ()
	getEditorsString ()
	getFeatured ()
	getFeatured ()
	getImage ()
	getImage ()
	getLocalizedDescription ()
	getLocalizedDescription ()
	getLocalizedFullTitle ()
	getLocalizedFullTitle ()
	getLocalizedPrefix ()
	getLocalizedPrefix ()
	getLocalizedSubtitle ()
	getLocalizedSubtitle ()
	getLocalizedTitle ()
	getLocalizedTitle ()
	getPath ()
	getPath ()
	getPrefix ($locale)
	getPrefix ($locale)
	getPressId ()
	getPressId ()
	getSubtitle ($locale)
	getSubtitle ($locale)
	getTitle ($locale)
	getTitle ($locale)
	Series ()
	Series ()
	setDescription ($description, $locale)
	setDescription ($description, $locale)
	setFeatured ($featured)
	setFeatured ($featured)
	setImage ($image)
	setImage ($image)
	setPath ($path)
	setPath ($path)
	setPrefix ($prefix, $locale)
	setPrefix ($prefix, $locale)
	setPressId ($pressId)
	setPressId ($pressId)
	setSubtitle ($subtitle, $locale)
	setSubtitle ($subtitle, $locale)
	setTitle ($title, $locale)
	setTitle ($title, $locale)

---

Detailed Description

Describes basic series properties.

See also:

SeriesDAO

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

---

Member Function Documentation

Series.getDescription

(

$

locale

)

Get series description.

Returns:

string

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

Series.getDescription

(

$

locale

)

Get series description.

Returns:

string

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

Series.getEditorsString

(

)

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

Returns:

string

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

References getPressId().

Series.getEditorsString

(

)

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

Returns:

string

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

References getPressId().

Series.getFeatured

(

)

Get the featured flag.

Returns:

boolean

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

Series.getFeatured

(

)

Get the featured flag.

Returns:

boolean

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

Series.getImage

(

)

Get the image.

Returns:

array

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

Series.getImage

(

)

Get the image.

Returns:

array

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

Series.getLocalizedDescription

(

)

Get series description.

Returns:

string

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

Series.getLocalizedDescription

(

)

Get series description.

Returns:

string

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

Series.getLocalizedFullTitle

(

)

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

Returns:

string

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

References getLocalizedPrefix(), getLocalizedSubtitle(), and getLocalizedTitle().

Series.getLocalizedFullTitle

(

)

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

Returns:

string

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

References getLocalizedPrefix(), getLocalizedSubtitle(), and getLocalizedTitle().

Series.getLocalizedPrefix

(

)

Get localized prefix for the series.

Returns:

string

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

Referenced by getLocalizedFullTitle().

Series.getLocalizedPrefix

(

)

Get localized prefix for the series.

Returns:

string

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

Series.getLocalizedSubtitle

(

)

Get the localized version of the subtitle

Returns:

string

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

Series.getLocalizedSubtitle

(

)

Get the localized version of the subtitle

Returns:

string

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

Referenced by getLocalizedFullTitle().

Series.getLocalizedTitle

(

)

Get localized title of the series.

Returns:

string

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

Referenced by getLocalizedFullTitle().

Series.getLocalizedTitle

(

)

Get localized title of the series.

Returns:

string

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

Series.getPath

(

)

Get path to series (in URL).

Returns:

string

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

Series.getPath

(

)

Get path to series (in URL).

Returns:

string

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

Series.getPrefix

(

$

locale

)

Get prefix of series.

Parameters:

$locale

string

Returns:

string

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

Series.getPrefix

(

$

locale

)

Get prefix of series.

Parameters:

$locale

string

Returns:

string

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

Series.getPressId

(

)

Get ID of press.

Returns:

int

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

Referenced by getEditorsString().

Series.getPressId

(

)

Get ID of press.

Returns:

int

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

Series.getSubtitle

(

$

locale

)

Get the subtitle for a given locale

Parameters:

string

$locale

Returns:

string

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

Series.getSubtitle

(

$

locale

)

Get the subtitle for a given locale

Parameters:

string

$locale

Returns:

string

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

Series.getTitle

(

$

locale

)

Get title of series.

Parameters:

$locale

string

Returns:

string

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

Series.getTitle

(

$

locale

)

Get title of series.

Parameters:

$locale

string

Returns:

string

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

Series.Series

(

)

Constructor.

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

Series.Series

(

)

Constructor.

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

Series.setDescription	(	$	description,
		$	locale
	)

Set series description.

Parameters:

string

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

Series.setDescription	(	$	description,
		$	locale
	)

Set series description.

Parameters:

string

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

Series.setFeatured

(

$

featured

)

Set the featured flag.

Parameters:

$featured

boolean

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

Series.setFeatured

(

$

featured

)

Set the featured flag.

Parameters:

$featured

boolean

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

Series.setImage

(

$

image

)

Set the image.

Parameters:

$image

array

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

Series.setImage

(

$

image

)

Set the image.

Parameters:

$image

array

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

Series.setPath

(

$

path

)

Set path to series (in URL).

Parameters:

$path

string

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

Series.setPath

(

$

path

)

Set path to series (in URL).

Parameters:

$path

string

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

Series.setPrefix	(	$	prefix,
		$	locale
	)

Set prefix of series.

Parameters:

	$prefix	string
	$locale	string

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

Series.setPrefix	(	$	prefix,
		$	locale
	)

Set prefix of series.

Parameters:

	$prefix	string
	$locale	string

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

Series.setPressId

(

$

pressId

)

Set ID of press.

Parameters:

$pressId

int

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

Series.setPressId

(

$

pressId

)

Set ID of press.

Parameters:

$pressId

int

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

Series.setSubtitle	(	$	subtitle,
		$	locale
	)

Set the subtitle for a locale

Parameters:

	string	$subtitle
	string	$locale

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

Series.setSubtitle	(	$	subtitle,
		$	locale
	)

Set the subtitle for a locale

Parameters:

	string	$subtitle
	string	$locale

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

Series.setTitle	(	$	title,
		$	locale
	)

Set title of series.

Parameters:

	$title	string
	$locale	string

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

Series.setTitle	(	$	title,
		$	locale
	)

Set title of series.

Parameters:

	$title	string
	$locale	string

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

---

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

• classes/press/Series.inc.php
• omp.JipGdx/omp-1.0b/classes/press/Series.inc.php