Public Member Functions

Genre Class Reference
[Monograph]

Basic class describing a genre. More...

List of all members.

Public Member Functions

 Genre ()
 getCategory ()
 getDesignation ($locale)
 getLocalizedDesignation ()
 getLocalizedName ()
 getName ($locale)
 getPressId ()
 getSortable ()
 setCategory ($category)
 setDesignation ($abbrev, $locale)
 setName ($name, $locale)
 setPressId ($pressId)
 setSortable ($sortable)

Detailed Description

Basic class describing a genre.

See also:
GenreDAO

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


Member Function Documentation

Genre.Genre (  ) 

Constructor

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

Genre.getCategory (  ) 

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

Returns:
int GENRE_CATEGORY_...

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

Genre.getDesignation ( locale  ) 

Get the designation of the genre

Parameters:
$locale string
Returns:
string

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

Genre.getLocalizedDesignation (  ) 

Get the localized designation of the genre

Returns:
string

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

Genre.getLocalizedName (  ) 

Get the localized name of the genre

Returns:
string

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

Genre.getName ( locale  ) 

Get the name of the genre

Parameters:
$locale string
Returns:
string

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

Genre.getPressId (  ) 

Get ID of press.

Returns:
int

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

Genre.getSortable (  ) 

Get sortable flag of the monograph type

Returns:
bool

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

Genre.setCategory ( category  ) 

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

Parameters:
$category int GENRE_CATEGORY_...

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

Genre.setDesignation ( abbrev,
locale 
)

Set the designation of the genre

Parameters:
$abbrev string
$locale string

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

Genre.setName ( name,
locale 
)

Set the name of the genre

Parameters:
$name string
$locale string

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

Genre.setPressId ( pressId  ) 

Set ID of press.

Parameters:
$pressId int

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

Genre.setSortable ( sortable  ) 

Set sortable flag of the monograph type

Parameters:
$sortable bool

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


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