Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
Genre Class Reference
Inheritance diagram for Genre:
DataObject

Public Member Functions

 Genre ()
 
 getCategory ()
 
 getContextId ()
 
 getDependent ()
 
 getDesignation ()
 
 getEnabled ()
 
 getKey ()
 
 getLocalizedName ()
 
 getName ($locale)
 
 getSequence ()
 
 getSortable ()
 
 setCategory ($category)
 
 setContextId ($contextId)
 
 setDependent ($dependent)
 
 setDesignation ($abbrev)
 
 setEnabled ($enabled)
 
 setKey ($key)
 
 setName ($name, $locale)
 
 setSequence ($sequence)
 
 setSortable ($sortable)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter ($metadataAdapter)
 
 DataObject ()
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 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)
 
 upcastTo ($targetObject)
 

Additional Inherited Members

- Public Attributes 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 22 of file Genre.inc.php.

Member Function Documentation

Genre::Genre ( )

Constructor

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

Genre::getCategory ( )

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

Returns
int GENRE_CATEGORY_...

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

References DataObject\getData().

Genre::getContextId ( )

Get ID of context.

Returns
int

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

References DataObject\getData().

Genre::getDependent ( )

Get dependent flag

Returns
bool

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

References DataObject\getData().

Genre::getDesignation ( )

Get the designation of the genre

Returns
string

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

References DataObject\getData().

Genre::getEnabled ( )

Get enabled status of genre.

Returns
boolean

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

References DataObject\getData().

Genre::getKey ( )

Get key of genre.

Returns
string

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

References DataObject\getData().

Genre::getLocalizedName ( )

Get the localized name of the genre

Returns
string

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

References DataObject\getLocalizedData().

Genre::getName (   $locale)

Get the name of the genre

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Genre::getSequence ( )

Get sequence of genre.

Returns
float

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

References DataObject\getData().

Genre::getSortable ( )

Get sortable flag of the context type

Returns
bool

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

References DataObject\getData().

Genre::setCategory (   $category)

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

Parameters
$categoryint GENRE_CATEGORY_...

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

References DataObject\setData().

Genre::setContextId (   $contextId)

Set ID of context.

Parameters
$contextIdint

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

References DataObject\setData().

Genre::setDependent (   $dependent)

Set dependent flag

Parameters
$dependentbool

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

References DataObject\setData().

Genre::setDesignation (   $abbrev)

Set the designation of the genre

Parameters
$abbrevstring

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

References DataObject\setData().

Genre::setEnabled (   $enabled)

Set enabled status of genre.

Parameters
$enabledboolean

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

References DataObject\setData().

Genre::setKey (   $key)

Set key of genre.

Parameters
$keystring

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

References DataObject\setData().

Genre::setName (   $name,
  $locale 
)

Set the name of the genre

Parameters
$namestring
$localestring

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

References DataObject\setData().

Genre::setSequence (   $sequence)

Set sequence of genre.

Parameters
$sequencefloat

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

References DataObject\setData().

Genre::setSortable (   $sortable)

Set sortable flag of the context type

Parameters
$sortablebool

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

References DataObject\setData().


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