Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
BookForReview Class Reference
Inheritance diagram for BookForReview:
DataObject

Public Member Functions

 addAuthor ($author)
 
 BookForReview ()
 
 getArticleId ()
 
getAuthor ($authorId)
 
getAuthors ()
 
 getAuthorString ($lastOnly=false, $separator= ', ')
 
 getAuthorType ()
 
 getAuthorTypeString ()
 
 getCopy ()
 
 getCoverPageAltText ($locale)
 
 getDateAssigned ()
 
 getDateCreated ()
 
 getDateDue ()
 
 getDateMailed ()
 
 getDateRequested ()
 
 getDateSubmitted ()
 
 getDescription ($locale)
 
 getEdition ()
 
getEditor ()
 
 getEditorContactSignature ()
 
 getEditorEmail ()
 
 getEditorFullName ()
 
 getEditorId ()
 
 getEditorInitials ()
 
 getFileName ($locale)
 
 getHeight ($locale)
 
 getId ()
 
 getISBN ()
 
 getJournalId ()
 
 getLanguage ()
 
 getLanguageString ()
 
 getLocalizedCoverPageAltText ()
 
 getLocalizedDescription ()
 
 getLocalizedDescriptionShort ()
 
 getLocalizedFileName ()
 
 getLocalizedHeight ()
 
 getLocalizedOriginalFileName ()
 
 getLocalizedTitle ()
 
 getLocalizedWidth ()
 
 getNotes ()
 
 getOriginalFileName ($locale)
 
 getPages ()
 
 getPublisher ()
 
getRemovedAuthors ()
 
 getStatus ()
 
 getStatusString ()
 
 getTitle ($locale)
 
 getUrl ()
 
getUser ()
 
 getUserContactSignature ()
 
 getUserCountry ()
 
 getUserEmail ()
 
 getUserFullName ()
 
 getUserId ()
 
 getUserMailingAddress ()
 
 getWidth ($locale)
 
 getYear ()
 
 isLate ()
 
 removeAuthor ($authorId)
 
 setArticleId ($articleId)
 
 setAuthors ($authors)
 
 setAuthorType ($authorType)
 
 setCopy ($copy)
 
 setCoverPageAltText ($coverPageAltText, $locale)
 
 setDateAssigned ($dateAssigned)
 
 setDateCreated ($dateCreated)
 
 setDateDue ($dateDue)
 
 setDateMailed ($dateMailed)
 
 setDateRequested ($dateRequested)
 
 setDateSubmitted ($dateSubmitted)
 
 setDescription ($description, $locale)
 
 setEdition ($edition)
 
 setEditorId ($editorId)
 
 setFileName ($fileName, $locale)
 
 setHeight ($height, $locale)
 
 setId ($bookId)
 
 setISBN ($isbn)
 
 setJournalId ($journalId)
 
 setLanguage ($language)
 
 setNotes ($notes)
 
 setOriginalFileName ($originalFileName, $locale)
 
 setPages ($pages)
 
 setPublisher ($publisher)
 
 setStatus ($status)
 
 setTitle ($title, $locale)
 
 setUrl ($url)
 
 setUserId ($userId)
 
 setWidth ($width, $locale)
 
 setYear ($year)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter (&$metadataAdapter)
 
 DataObject ($callHooks=true)
 
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()
 

Detailed Description

Basic class describing a book for review.

See Also
BookForReviewDAO

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

Member Function Documentation

BookForReview::addAuthor (   $author)

Add an author.

Parameters
$authorBookForReviewAuthor

Definition at line 49 of file BookForReview.inc.php.

References getId().

BookForReview::BookForReview ( )

Constructor.

Definition at line 39 of file BookForReview.inc.php.

BookForReview::getArticleId ( )

Get the articleId of the book for review.

Returns
int

Definition at line 701 of file BookForReview.inc.php.

References DataObject\getData().

& BookForReview::getAuthor (   $authorId)

Get a specific author of this book for review.

Parameters
$authorIdint
Returns
BookForReviewAuthor

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

References getId().

& BookForReview::getAuthors ( )

Get all authors of this book for review.

Returns
array BookForReviewAuthors

Definition at line 107 of file BookForReview.inc.php.

BookForReview::getAuthorString (   $lastOnly = false,
  $separator = ',
 
)

Return string of author names, separated by the specified token

Parameters
$lastOnlyboolean return list of lastnames only (default false)
$separatorstring separator for names (default comma+space)
Returns
string

Definition at line 88 of file BookForReview.inc.php.

BookForReview::getAuthorType ( )

Get the authorType of the book for review.

Returns
int

Definition at line 420 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::getAuthorTypeString ( )

Get the authorType string for the book for review.

Returns
int

Definition at line 436 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::getCopy ( )

Get the copy available of the book for review.

Returns
int

Definition at line 525 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::getCoverPageAltText (   $locale)

get cover page alternate text

Parameters
$localestring
Returns
string

Definition at line 846 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::getDateAssigned ( )

Get the dateAssigned of the book for review.

Returns
date

Definition at line 621 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::getDateCreated ( )

Get the dateCreated of the book for review.

Returns
date

Definition at line 589 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::getDateDue ( )

Get the dateDue of the book for review.

Returns
date

Definition at line 653 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::getDateMailed ( )

Get the dateMailed of the book for review.

Returns
date

Definition at line 637 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::getDateRequested ( )

Get the dateRequested of the book for review.

Returns
date

Definition at line 605 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::getDateSubmitted ( )

Get the dateSubmitted of the book for review.

Returns
date

Definition at line 685 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::getDescription (   $locale)

Get the description of the book for review.

Parameters
$locale
Returns
string

Definition at line 371 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::getEdition ( )

Get the edition number of the book for review.

Returns
int

Definition at line 541 of file BookForReview.inc.php.

References DataObject\getData().

& BookForReview::getEditor ( )

Get the editor assigned to the book for review.

Returns
Editor

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

References DAORegistry\getDAO(), and DataObject\getData().

Referenced by getEditorContactSignature(), getEditorEmail(), getEditorFullName(), and getEditorInitials().

BookForReview::getEditorContactSignature ( )

Get the editor's contact signature assigned to the book for review.

Returns
string

Definition at line 230 of file BookForReview.inc.php.

References getEditor().

BookForReview::getEditorEmail ( )

Get the editor's email assigned to the book for review.

Returns
string

Definition at line 221 of file BookForReview.inc.php.

References getEditor().

BookForReview::getEditorFullName ( )

Get the editor's full name assigned to the book for review.

Returns
string

Definition at line 212 of file BookForReview.inc.php.

References getEditor().

BookForReview::getEditorId ( )

Get the editor ID of the book for review.

Returns
int

Definition at line 404 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::getEditorInitials ( )

Get the editor's initials assigned to the book for review.

Returns
string

Definition at line 239 of file BookForReview.inc.php.

References getEditor().

BookForReview::getFileName (   $locale)

get file name

Parameters
$localestring
Returns
string

Definition at line 742 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::getHeight (   $locale)

get height of cover page image

Parameters
$localestring
Returns
string

Definition at line 794 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::getId ( )

Get the ID of the book for review.

Returns
int

Definition at line 255 of file BookForReview.inc.php.

References DataObject\getData().

Referenced by addAuthor(), getAuthor(), and removeAuthor().

BookForReview::getISBN ( )

Get the ISBN of the book for review.

Returns
string

Definition at line 573 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::getJournalId ( )

Get the journal ID of the book for review.

Returns
int

Definition at line 271 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::getLanguage ( )

Get the language of the book for review.

Returns
string

Definition at line 499 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::getLanguageString ( )

Get the language (string) of the book for review.

Returns
string

Definition at line 507 of file BookForReview.inc.php.

References DAORegistry\getDAO(), and DataObject\getData().

BookForReview::getLocalizedCoverPageAltText ( )

Get the localized book for review cover alternate text

Returns
string

Definition at line 837 of file BookForReview.inc.php.

References DataObject\getLocalizedData().

BookForReview::getLocalizedDescription ( )

Get the localized description of the book for review.

Returns
string

Definition at line 350 of file BookForReview.inc.php.

References DataObject\getLocalizedData().

BookForReview::getLocalizedDescriptionShort ( )

Get the localized, truncated description of the book for review.

Returns
string

Definition at line 358 of file BookForReview.inc.php.

References DataObject\getLocalizedData(), String\strlen(), and String\substr().

BookForReview::getLocalizedFileName ( )

Get the localized book for review cover filename

Returns
string

Definition at line 733 of file BookForReview.inc.php.

References DataObject\getLocalizedData().

BookForReview::getLocalizedHeight ( )

Get the localized book for review cover height

Returns
string

Definition at line 785 of file BookForReview.inc.php.

References DataObject\getLocalizedData().

BookForReview::getLocalizedOriginalFileName ( )

Get the localized book for review cover filename on the uploader's computer

Returns
string

Definition at line 811 of file BookForReview.inc.php.

References DataObject\getLocalizedData().

BookForReview::getLocalizedTitle ( )

Get the localized title of the book for review.

Returns
string

Definition at line 324 of file BookForReview.inc.php.

References DataObject\getLocalizedData().

BookForReview::getLocalizedWidth ( )

Get the localized book for review cover width

Returns
string

Definition at line 759 of file BookForReview.inc.php.

References DataObject\getLocalizedData().

BookForReview::getNotes ( )

Get the notes of the book for review.

Returns
string

Definition at line 717 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::getOriginalFileName (   $locale)

get original file name

Parameters
$localestring
Returns
string

Definition at line 820 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::getPages ( )

Get the number of pages of the book for review.

Returns
int

Definition at line 557 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::getPublisher ( )

Get the publisher of the book for review.

Returns
int

Definition at line 451 of file BookForReview.inc.php.

References DataObject\getData().

& BookForReview::getRemovedAuthors ( )

Get the IDs of all authors removed from this book for review.

Returns
array int

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

BookForReview::getStatus ( )

Get the status of the book for review.

Returns
int

Definition at line 287 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::getStatusString ( )

Get book for review status locale key.

Returns
int

Definition at line 303 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::getTitle (   $locale)

Get the title of the book for review.

Parameters
$locale
Returns
string

Definition at line 333 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::getUrl ( )

Get the publisher url of the book for review.

Returns
string

Definition at line 467 of file BookForReview.inc.php.

References DataObject\getData().

& BookForReview::getUser ( )

Get the user assigned to the book for review.

Returns
User

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

References DAORegistry\getDAO(), and DataObject\getData().

Referenced by getUserContactSignature(), getUserCountry(), getUserEmail(), getUserFullName(), and getUserMailingAddress().

BookForReview::getUserContactSignature ( )

Get the user's contact signature assigned to the book for review.

Returns
string

Definition at line 194 of file BookForReview.inc.php.

References getUser().

BookForReview::getUserCountry ( )

Get the user's country assigned to the book for review.

Returns
string

Definition at line 185 of file BookForReview.inc.php.

References getUser().

BookForReview::getUserEmail ( )

Get the user's email assigned to the book for review.

Returns
string

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

References getUser().

BookForReview::getUserFullName ( )

Get the user's full name assigned to the book for review.

Returns
string

Definition at line 158 of file BookForReview.inc.php.

References getUser().

BookForReview::getUserId ( )

Get the user ID of the book for review.

Returns
int

Definition at line 388 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::getUserMailingAddress ( )

Get the user's mailing address assigned to the book for review.

Returns
string

Definition at line 176 of file BookForReview.inc.php.

References getUser().

BookForReview::getWidth (   $locale)

get width of cover page image

Parameters
$localestring
Returns
string

Definition at line 768 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::getYear ( )

Get the publication year of the book for review.

Returns
int

Definition at line 483 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::isLate ( )

Check whether book for review is past due date

Definition at line 668 of file BookForReview.inc.php.

References DataObject\getData().

BookForReview::removeAuthor (   $authorId)

Remove an author.

Parameters
$authorIdID of the author to remove
Returns
boolean author was removed

Definition at line 64 of file BookForReview.inc.php.

References getId().

BookForReview::setArticleId (   $articleId)

Set the articleId of the book for review.

Parameters
$articleIdint

Definition at line 709 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setAuthors (   $authors)

Set authors of this book for review.

Parameters
$authorsarray BookForReviewAuthors

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

BookForReview::setAuthorType (   $authorType)

Set the authorType of the book for review.

Parameters
$authorTypeint

Definition at line 428 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setCopy (   $copy)

Set the copy available of the book for review.

Parameters
$copyint

Definition at line 533 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setCoverPageAltText (   $coverPageAltText,
  $locale 
)

set cover page alternate text

Parameters
$coverPageAltTextstring
$localestring

Definition at line 855 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setDateAssigned (   $dateAssigned)

Set the dateAssigned of the book for review.

Parameters
$dateAssigneddate

Definition at line 629 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setDateCreated (   $dateCreated)

Set the dateCreated of the book for review.

Parameters
$dateCreateddate

Definition at line 597 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setDateDue (   $dateDue)

Set the dateDue of the book for review.

Parameters
$dateDuedate

Definition at line 661 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setDateMailed (   $dateMailed)

Set the dateMailed of the book for review.

Parameters
$dateMaileddate

Definition at line 645 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setDateRequested (   $dateRequested)

Set the dateRequested of the book for review.

Parameters
$dateRequesteddate

Definition at line 613 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setDateSubmitted (   $dateSubmitted)

Set the dateSubmitted of the book for review.

Parameters
$dateSubmitteddate

Definition at line 693 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setDescription (   $description,
  $locale 
)

Set the description of the book for review.

Parameters
$descriptionstring
$locale

Definition at line 380 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setEdition (   $edition)

Set the edition number of the book for review.

Parameters
$editionint

Definition at line 549 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setEditorId (   $editorId)

Set the editor ID of the book for review.

Parameters
$editorint

Definition at line 412 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setFileName (   $fileName,
  $locale 
)

set file name

Parameters
$fileNamestring
$localestring

Definition at line 751 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setHeight (   $height,
  $locale 
)

set height of cover page image

Parameters
$localestring
$heightint

Definition at line 803 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setId (   $bookId)

Set the ID of the book for review.

Parameters
$bookfor reviewId int

Definition at line 263 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setISBN (   $isbn)

Set the ISBN of the book for review.

Parameters
$isbnstring

Definition at line 581 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setJournalId (   $journalId)

Set the journal ID of the book for review.

Parameters
$journalIdint

Definition at line 279 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setLanguage (   $language)

Set the language of the book for review.

Parameters
$languagestring

Definition at line 517 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setNotes (   $notes)

Set the notes of the book for review.

Parameters
$notesstring

Definition at line 725 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setOriginalFileName (   $originalFileName,
  $locale 
)

set original file name

Parameters
$originalFileNamestring
$localestring

Definition at line 829 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setPages (   $pages)

Set the number of pages of the book for review.

Parameters
$pagesint

Definition at line 565 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setPublisher (   $publisher)

Set the publisher of the book for review.

Parameters
$publisherstring

Definition at line 459 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setStatus (   $status)

Set the status of the book for review.

Parameters
$statusint

Definition at line 295 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setTitle (   $title,
  $locale 
)

Set the title of the book for review.

Parameters
$titlestring
$locale

Definition at line 342 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setUrl (   $url)

Set the publisher url of the book for review.

Parameters
$publisherUrlstring

Definition at line 475 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setUserId (   $userId)

Set the user ID of the book for review.

Parameters
$userint

Definition at line 396 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setWidth (   $width,
  $locale 
)

set width of cover page image

Parameters
$localestring
$widthint

Definition at line 777 of file BookForReview.inc.php.

References DataObject\setData().

BookForReview::setYear (   $year)

Set the publication year of the book for review.

Parameters
$yearint

Definition at line 491 of file BookForReview.inc.php.

References DataObject\setData().


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