Press Class Reference [Press]

Basic class describing a press. More...

List of all members.

Public Member Functions
	getContactEmail ()
	getContactName ()
	getDescription ()
	getEnabled ()
	getId ()
	getLocalizedDescription ()
	getLocalizedName ()
	getName ($locale)
	getPath ()
	getPressPageHeaderLogo ()
	getPressPageHeaderTitle ()
	getPrimaryLocale ()
	getSequence ()
&	getSetting ($name, $locale=null)
&	getSettings ()
&	getSupportedFormLocaleNames ()
&	getSupportedLocaleNames ()
	hasRequiredOnixHeaderFields ()
	Press ()
	setContactEmail ($contactEmail)
	setContactName ($contactName)
	setDescription ($description)
	setEnabled ($enabled)
	setId ($pressId)
	setName ($name)
	setPath ($path)
	setPrimaryLocale ($primaryLocale)
	setSequence ($sequence)
	updateSetting ($name, $value, $type=null, $isLocalized=false)

---

Detailed Description

Basic class describing a press.

See also:

PressDAO

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

---

Member Function Documentation

Press.getContactEmail

(

)

Get the contact email for this press

Returns:

string

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

References getSetting().

Press.getContactName

(

)

Get the contact name for this press

Returns:

string

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

References getSetting().

Press.getDescription

(

)

Get press description.

Returns:

string

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

Press.getEnabled

(

)

Get enabled flag of press

Returns:

int

Definition at line 136 of file Press.inc.php.

Press.getId

(

)

Get the ID of the press

Returns:

int

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

Referenced by updateSetting().

Press.getLocalizedDescription

(

)

Get the localized description of the press.

Returns:

string

Definition at line 183 of file Press.inc.php.

Press.getLocalizedName

(

)

Get the name of the press

Returns:

string

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

Press.getName

(

$

locale

)

get the name of the press

Definition at line 63 of file Press.inc.php.

References getSetting().

Press.getPath

(

)

Get path to press (in URL).

Returns:

string

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

Press.getPressPageHeaderLogo

(

)

Get "localized" press page logo (if applicable).

Returns:

string

Definition at line 280 of file Press.inc.php.

References getSetting().

Press.getPressPageHeaderTitle

(

)

Get "localized" press page title (if applicable). param $home boolean get homepage title

Returns:

string

Definition at line 259 of file Press.inc.php.

References getSetting().

Press.getPrimaryLocale

(

)

Return the primary locale of this press.

Returns:

string

Definition at line 152 of file Press.inc.php.

Press.getSequence

(

)

Get sequence of press in site table of contents.

Returns:

float

Definition at line 167 of file Press.inc.php.

& Press.getSetting	(	$	name,
		$	locale = null
	)

Retrieve a press setting value.

Parameters:

	$name	string
	$locale	string

Returns:

mixed

Definition at line 203 of file Press.inc.php.

Referenced by getContactEmail(), getContactName(), getName(), getPressPageHeaderLogo(), getPressPageHeaderTitle(), getSupportedFormLocaleNames(), getSupportedLocaleNames(), and hasRequiredOnixHeaderFields().

& Press.getSettings

(

)

Retrieve array of press settings.

Returns:

array

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

& Press.getSupportedFormLocaleNames

(

)

Return associative array of all locales supported by forms on the site. These locales are used to provide a language toggle on the main site pages.

Returns:

array

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

References getSetting().

& Press.getSupportedLocaleNames

(

)

Return associative array of all locales supported by the site. These locales are used to provide a language toggle on the main site pages.

Returns:

array

Definition at line 293 of file Press.inc.php.

References getSetting().

Press.hasRequiredOnixHeaderFields

(

)

Returns true if this press contains the fields required for creating valid ONIX export metadata.

Returns:

boolean

Definition at line 318 of file Press.inc.php.

References getSetting().

Press.Press

(

)

Constructor

Definition at line 24 of file Press.inc.php.

Press.setContactEmail

(

$

contactEmail

)

Set the contact email for this press

Parameters:

$contactEmail

string

Definition at line 95 of file Press.inc.php.

Press.setContactName

(

$

contactName

)

Set the contact name for this press

Parameters:

$contactName

string

Definition at line 79 of file Press.inc.php.

Press.setDescription

(

$

description

)

Set announcement description.

Parameters:

	$description	string
	$locale	string

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

Press.setEnabled

(

$

enabled

)

Set enabled flag of press

Parameters:

$enabled

int

Definition at line 144 of file Press.inc.php.

Press.setId

(

$

pressId

)

Set the ID of the press.

Parameters:

$announcementId

int

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

Press.setName

(

$

name

)

Set the name of the press

Parameters:

$pressName

string

Definition at line 56 of file Press.inc.php.

Press.setPath

(

$

path

)

Set path to press (in URL).

Parameters:

$path

string

Definition at line 128 of file Press.inc.php.

Press.setPrimaryLocale

(

$

primaryLocale

)

Set the primary locale of this press.

Parameters:

$locale

string

Definition at line 160 of file Press.inc.php.

Press.setSequence

(

$

sequence

)

Set sequence of press in site table of contents.

Parameters:

$sequence

float

Definition at line 175 of file Press.inc.php.

Press.updateSetting	(	$	name,
		$	value,
		$	type = null,
		$	isLocalized = false
	)

Update a press setting value.

Parameters:

	$name	string
	$value	mixed
	$type	string optional
	$isLocalized	boolean optional

Definition at line 216 of file Press.inc.php.

References getId().

---

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

• classes/press/Press.inc.php