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

Public Member Functions

 getArticleId ()
 
 getDateAdded ()
 
 getLinkCount ()
 
 getName ($locale)
 
 getReferralName ()
 
 getStatus ()
 
 getStatusKey ()
 
 getURL ()
 
 setArticleId ($articleId)
 
 setDateAdded ($dateAdded)
 
 setLinkCount ($linkCount)
 
 setName ($name, $locale)
 
 setStatus ($status)
 
 setURL ($url)
 
- 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 referral.

See Also
ReferralDAO

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

Member Function Documentation

Referral::getArticleId ( )

Get the article ID of the referral.

Returns
int

Definition at line 30 of file Referral.inc.php.

References DataObject\getData().

Referral::getDateAdded ( )

Get the date added of the referral.

Returns
boolean

Definition at line 89 of file Referral.inc.php.

References DataObject\getData().

Referral::getLinkCount ( )

Get the link count of the referral.

Returns
int

Definition at line 131 of file Referral.inc.php.

References DataObject\getData().

Referral::getName (   $locale)

Get the name of the referral.

Parameters
$localestring
Returns
string

Definition at line 114 of file Referral.inc.php.

References DataObject\getData().

Referral::getReferralName ( )

Get the name of the referral.

Returns
string

Definition at line 105 of file Referral.inc.php.

References DataObject\getLocalizedData().

Referral::getStatus ( )

Get the status flag of the referral (REFERRAL_STATUS_...).

Returns
int

Definition at line 62 of file Referral.inc.php.

References DataObject\getData().

Referenced by getStatusKey().

Referral::getStatusKey ( )

Get the locale key corresponding to this referral's status

Definition at line 69 of file Referral.inc.php.

References getStatus().

Referral::getURL ( )

Get the URL of the referral.

Returns
string

Definition at line 46 of file Referral.inc.php.

References DataObject\getData().

Referral::setArticleId (   $articleId)

Set the article ID of the referral.

Parameters
$articleIdint

Definition at line 38 of file Referral.inc.php.

References DataObject\setData().

Referral::setDateAdded (   $dateAdded)

Set the date added of the referral.

Parameters
$dateAddeddate

Definition at line 97 of file Referral.inc.php.

References DataObject\setData().

Referral::setLinkCount (   $linkCount)

Set the link count of the referral.

Parameters
$linkCountint

Definition at line 139 of file Referral.inc.php.

References DataObject\setData().

Referral::setName (   $name,
  $locale 
)

Set the name of the referral.

Parameters
$namestring
$localestring

Definition at line 123 of file Referral.inc.php.

References DataObject\setData().

Referral::setStatus (   $status)

Set the status flag of the referral.

Parameters
$statusint REFERRAL_STATUS_...

Definition at line 81 of file Referral.inc.php.

References DataObject\setData().

Referral::setURL (   $url)

Set the URL of the referral.

Parameters
$urlstring

Definition at line 54 of file Referral.inc.php.

References DataObject\setData().


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