Genre Class Reference

Inheritance diagram for Genre:

Public Member Functions
	getCategory ()
	getContextId ()
	getDependent ()
	getEnabled ()
	getKey ()
	getLocalizedName ()
	getName ($locale)
	getSequence ()
	getSupplementary ()
	isDefault ()
	setCategory ($category)
	setContextId ($contextId)
	setDependent ($dependent)
	setEnabled ($enabled)
	setKey ($key)
	setName ($name, $locale)
	setSequence ($sequence)
	setSupplementary ($supplementary)
Public Member Functions inherited from DataObject
	__construct ()
	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

Basic class describing a genre.

See also

GenreDAO

Definition at line 21 of file Genre.inc.php.

Member Function Documentation

getCategory()

Genre::getCategory

(

)

Get context file category (e.g. artwork or document)

Returns

int GENRE_CATEGORY_...

Definition at line 117 of file Genre.inc.php.

References DataObject\getData().

getContextId()

Genre::getContextId

(

)

Get ID of context.

Returns

int

Definition at line 27 of file Genre.inc.php.

References DataObject\getData().

getDependent()

Genre::getDependent

(

)

Get dependent flag

Returns

bool

Definition at line 133 of file Genre.inc.php.

References DataObject\getData().

getEnabled()

Genre::getEnabled

(

)

Get enabled status of genre.

Returns

boolean

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

References DataObject\getData().

getKey()

Genre::getKey

(

)

Get key of genre.

Returns

string

Definition at line 59 of file Genre.inc.php.

References DataObject\getData().

Referenced by isDefault().

getLocalizedName()

Genre::getLocalizedName

(

)

Get the localized name of the genre

Returns

string

Definition at line 109 of file Genre.inc.php.

References DataObject\getLocalizedData().

getName()

Genre::getName

(

$locale

)

Get the name of the genre

Parameters

$locale

string

Returns

string

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

References DataObject\getData().

getSequence()

Genre::getSequence

(

)

Get sequence of genre.

Returns

float

Definition at line 43 of file Genre.inc.php.

References DataObject\getData().

getSupplementary()

Genre::getSupplementary

(

)

Get supplementary flag

Returns

bool

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

References DataObject\getData().

isDefault()

Genre::isDefault

(

)

Is this a default genre.

Returns

bool

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

References DAORegistry\getDAO(), and getKey().

setCategory()

Genre::setCategory

(

$category

)

Set context file category (e.g. artwork or document)

Parameters

$category

int GENRE_CATEGORY_...

Definition at line 125 of file Genre.inc.php.

References DataObject\setData().

setContextId()

Genre::setContextId

(

$contextId

)

Set ID of context.

Parameters

$contextId

int

Definition at line 35 of file Genre.inc.php.

References DataObject\setData().

setDependent()

Genre::setDependent

(

$dependent

)

Set dependent flag

Parameters

$dependent

bool

Definition at line 141 of file Genre.inc.php.

References DataObject\setData().

setEnabled()

Genre::setEnabled

(

$enabled

)

Set enabled status of genre.

Parameters

$enabled

boolean

Definition at line 83 of file Genre.inc.php.

References DataObject\setData().

setKey()

Genre::setKey

(

$key

)

Set key of genre.

Parameters

$key

string

Definition at line 67 of file Genre.inc.php.

References DataObject\setData().

setName()

Genre::setName	(		$name,
			$locale
	)

Set the name of the genre

Parameters

$name	string
$locale	string

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

References DataObject\setData().

setSequence()

Genre::setSequence

(

$sequence

)

Set sequence of genre.

Parameters

$sequence

float

Definition at line 51 of file Genre.inc.php.

References DataObject\setData().

setSupplementary()

Genre::setSupplementary

(

$supplementary

)

Set supplementary flag

Parameters

$supplementary

bool

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

References DataObject\setData().

---

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

• Genre.inc.php