SocialMedia Class Reference [Press]

Describes basic SocialMedia properties. More...

List of all members.

Public Member Functions
	getCode ()
	getIncludeInCatalog ()
	getLocalizedPlatform ()
	getPlatform ($locale)
	getPressId ()
	replaceCodeVars ($publishedMonograph=null)
	setCode ($code)
	setIncludeInCatalog ($includeInCatalog)
	setPlatform ($platform, $locale)
	setPressId ($pressId)
	SocialMedia ()

---

Detailed Description

Describes basic SocialMedia properties.

See also:

SocialMediaDAO

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

---

Member Function Documentation

SocialMedia.getCode

(

)

Get media block code.

Returns:

string

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

Referenced by replaceCodeVars().

SocialMedia.getIncludeInCatalog

(

)

Get whether or not this should be included on a monograph's catalog page.

Returns:

boolean

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

SocialMedia.getLocalizedPlatform

(

)

Get localized platform name.

Returns:

string

Definition at line 76 of file SocialMedia.inc.php.

SocialMedia.getPlatform

(

$

locale

)

Get media platform.

Parameters:

$locale

string

Returns:

string

Definition at line 85 of file SocialMedia.inc.php.

SocialMedia.getPressId

(

)

Get ID of press.

Returns:

int

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

SocialMedia.replaceCodeVars

(

$

publishedMonograph = null

)

Replace various variables in the code template with data relevant to the assigned monograph.

Parameters:

PublishedMonograph

$publishedMonograph

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

References getCode(), and setCode().

SocialMedia.setCode

(

$

code

)

Set media block code.

Parameters:

$path

string

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

Referenced by replaceCodeVars().

SocialMedia.setIncludeInCatalog

(

$

includeInCatalog

)

Set whether or not this should be included on a monograph's catalog page.

Parameters:

$path

string

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

SocialMedia.setPlatform	(	$	platform,
		$	locale
	)

Set media platform.

Parameters:

	$title	string
	$locale	string

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

SocialMedia.setPressId

(

$

pressId

)

Set ID of press.

Parameters:

$pressId

int

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

SocialMedia.SocialMedia

(

)

Constructor.

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

---

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

• classes/press/SocialMedia.inc.php