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

Public Member Functions

 getAssocId ()
 
 getAssocType ()
 
 getBuyerEmail ()
 
 getBuyerFirstName ()
 
 getBuyerFullName ($lastFirst=false)
 
 getBuyerLastName ()
 
 getBuyerMiddleName ()
 
 getBuyerUserId ()
 
 getDatetimeRedeemed ()
 
 getGiftAssocId ()
 
 getGiftName ($locale=null)
 
 getGiftNote ()
 
 getGiftNoteTitle ()
 
 getGiftType ()
 
 getLocale ()
 
 getNotes ()
 
 getRecipientEmail ()
 
 getRecipientFirstName ()
 
 getRecipientFullName ($lastFirst=false)
 
 getRecipientLastName ()
 
 getRecipientMiddleName ()
 
 getRecipientUserId ()
 
 getStatus ()
 
 PKPGift ()
 
 setAssocId ($assocId)
 
 setAssocType ($assocType)
 
 setBuyerEmail ($buyerEmail)
 
 setBuyerFirstName ($buyerFirstName)
 
 setBuyerLastName ($buyerLastName)
 
 setBuyerMiddleName ($buyerMiddleName)
 
 setBuyerUserId ($userId)
 
 setDatetimeRedeemed ($datetimeRedeemed)
 
 setGiftAssocId ($giftAssocId)
 
 setGiftNote ($giftNote)
 
 setGiftNoteTitle ($giftNoteTitle)
 
 setGiftType ($type)
 
 setLocale ($locale)
 
 setNotes ($notes)
 
 setRecipientEmail ($recipientEmail)
 
 setRecipientFirstName ($recipientFirstName)
 
 setRecipientLastName ($recipientLastName)
 
 setRecipientMiddleName ($recipientMiddleName)
 
 setRecipientUserId ($userId)
 
 setStatus ($status)
 
- 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 gift.

See Also
GiftDAO, PKPGiftDAO

Definition at line 28 of file PKPGift.inc.php.

Member Function Documentation

PKPGift::getAssocId ( )

Get assoc ID for this gift.

Returns
int

Definition at line 60 of file PKPGift.inc.php.

References DataObject\getData().

PKPGift::getAssocType ( )

Get assoc type for this gift.

Returns
int

Definition at line 44 of file PKPGift.inc.php.

References DataObject\getData().

PKPGift::getBuyerEmail ( )

Get the gift buyer email.

Returns
string

Definition at line 199 of file PKPGift.inc.php.

References DataObject\getData().

PKPGift::getBuyerFirstName ( )

Get the gift buyer first name.

Returns
string

Definition at line 134 of file PKPGift.inc.php.

References DataObject\getData().

PKPGift::getBuyerFullName (   $lastFirst = false)

Get the buyer's complete name. Includes first name, middle name (if applicable), and last name.

Parameters
$lastFirstboolean return in "LastName, FirstName" format
Returns
string

Definition at line 184 of file PKPGift.inc.php.

References DataObject\getData().

PKPGift::getBuyerLastName ( )

Get the gift buyer last name.

Returns
string

Definition at line 166 of file PKPGift.inc.php.

References DataObject\getData().

PKPGift::getBuyerMiddleName ( )

Get the gift buyer middle name.

Returns
string

Definition at line 150 of file PKPGift.inc.php.

References DataObject\getData().

PKPGift::getBuyerUserId ( )

Get the gift buyer user id .

Returns
int

Definition at line 215 of file PKPGift.inc.php.

References DataObject\getData().

PKPGift::getDatetimeRedeemed ( )

Get gift redeemed datetime.

Returns
datetime (YYYY-MM-DD HH:MM:SS)

Definition at line 392 of file PKPGift.inc.php.

References DataObject\getData().

PKPGift::getGiftAssocId ( )

Get the gift assoc id.

Returns
in

Definition at line 118 of file PKPGift.inc.php.

References DataObject\getData().

PKPGift::getGiftName (   $locale = null)

Get the name of the gift based on gift type.

Parameters
$localestring
Returns
string

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

PKPGift::getGiftNote ( )

Get the gift note from buyer.

Returns
string

Definition at line 360 of file PKPGift.inc.php.

References DataObject\getData().

PKPGift::getGiftNoteTitle ( )

Get the gift note title from buyer.

Returns
string

Definition at line 344 of file PKPGift.inc.php.

References DataObject\getData().

PKPGift::getGiftType ( )

Get the gift type of the gift.

Returns
int

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

References DataObject\getData().

PKPGift::getLocale ( )

Get locale.

Returns
string

Definition at line 328 of file PKPGift.inc.php.

References DataObject\getData().

PKPGift::getNotes ( )

Get the gift admin notes.

Returns
string

Definition at line 376 of file PKPGift.inc.php.

References DataObject\getData().

PKPGift::getRecipientEmail ( )

Get the gift recipient email.

Returns
string

Definition at line 296 of file PKPGift.inc.php.

References DataObject\getData().

PKPGift::getRecipientFirstName ( )

Get the gift recipient first name.

Returns
string

Definition at line 231 of file PKPGift.inc.php.

References DataObject\getData().

PKPGift::getRecipientFullName (   $lastFirst = false)

Get the recipient's complete name. Includes first name, middle name (if applicable), and last name.

Parameters
$lastFirstboolean return in "LastName, FirstName" format
Returns
string

Definition at line 281 of file PKPGift.inc.php.

References DataObject\getData().

PKPGift::getRecipientLastName ( )

Get the gift recipient last name.

Returns
string

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

References DataObject\getData().

PKPGift::getRecipientMiddleName ( )

Get the gift recipient middle name.

Returns
string

Definition at line 247 of file PKPGift.inc.php.

References DataObject\getData().

PKPGift::getRecipientUserId ( )

Get the gift recipient user id .

Returns
int

Definition at line 312 of file PKPGift.inc.php.

References DataObject\getData().

PKPGift::getStatus ( )

Get the gift status of the gift.

Returns
int

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

References DataObject\getData().

PKPGift::PKPGift ( )

Constructor

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

PKPGift::setAssocId (   $assocId)

Set assoc ID for this gift.

Parameters
$assocIdint

Definition at line 68 of file PKPGift.inc.php.

References DataObject\setData().

PKPGift::setAssocType (   $assocType)

Set assoc type for this gift.

Parameters
$assocTypeint

Definition at line 52 of file PKPGift.inc.php.

References DataObject\setData().

PKPGift::setBuyerEmail (   $buyerEmail)

Set the gift buyer email.

Parameters
$buyerEmailstring

Definition at line 207 of file PKPGift.inc.php.

References DataObject\setData().

PKPGift::setBuyerFirstName (   $buyerFirstName)

Set the gift buyer first name.

Parameters
$buyerFirstNamestring

Definition at line 142 of file PKPGift.inc.php.

References DataObject\setData().

PKPGift::setBuyerLastName (   $buyerLastName)

Set the gift buyer last name.

Parameters
$buyerLastNamestring

Definition at line 174 of file PKPGift.inc.php.

References DataObject\setData().

PKPGift::setBuyerMiddleName (   $buyerMiddleName)

Set the gift buyer middle name.

Parameters
$buyerMiddleNamestring

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

References DataObject\setData().

PKPGift::setBuyerUserId (   $userId)

Set the gift buyer user id.

Parameters
$userIdint

Definition at line 223 of file PKPGift.inc.php.

References DataObject\setData().

PKPGift::setDatetimeRedeemed (   $datetimeRedeemed)

Set gift redeemed datetime.

Parameters
$datetimeRedeemeddatetime (YYYY-MM-DD HH:MM:SS)

Definition at line 400 of file PKPGift.inc.php.

References DataObject\setData().

PKPGift::setGiftAssocId (   $giftAssocId)

Set the gift assoc id.

Parameters
$giftAssocIdint

Definition at line 126 of file PKPGift.inc.php.

References DataObject\setData().

PKPGift::setGiftNote (   $giftNote)

Set the gift note from buyer.

Parameters
$giftNotestring

Definition at line 368 of file PKPGift.inc.php.

References DataObject\setData().

PKPGift::setGiftNoteTitle (   $giftNoteTitle)

Set the gift note title from buyer.

Parameters
$giftNotestring

Definition at line 352 of file PKPGift.inc.php.

References DataObject\setData().

PKPGift::setGiftType (   $type)

Set the gift type of the gift.

Parameters
$typeint

Definition at line 100 of file PKPGift.inc.php.

References DataObject\setData().

PKPGift::setLocale (   $locale)

Set locale.

Parameters
$localestring

Definition at line 336 of file PKPGift.inc.php.

References DataObject\setData().

PKPGift::setNotes (   $notes)

Set the gift admin notes.

Parameters
$notesstring

Definition at line 384 of file PKPGift.inc.php.

References DataObject\setData().

PKPGift::setRecipientEmail (   $recipientEmail)

Set the gift recipient email.

Parameters
$recipientEmailstring

Definition at line 304 of file PKPGift.inc.php.

References DataObject\setData().

PKPGift::setRecipientFirstName (   $recipientFirstName)

Set the gift recipient first name.

Parameters
$recipientFirstNamestring

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

References DataObject\setData().

PKPGift::setRecipientLastName (   $recipientLastName)

Set the gift recipient last name.

Parameters
$recipientLastNamestring

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

References DataObject\setData().

PKPGift::setRecipientMiddleName (   $recipientMiddleName)

Set the gift recipient middle name.

Parameters
$recipientMiddleNamestring

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

References DataObject\setData().

PKPGift::setRecipientUserId (   $userId)

Set the gift recipient user id.

Parameters
$userIdint

Definition at line 320 of file PKPGift.inc.php.

References DataObject\setData().

PKPGift::setStatus (   $status)

Set the gift status of the gift.

Parameters
$statusint

Definition at line 84 of file PKPGift.inc.php.

References DataObject\setData().


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