Open Journal Systems  3.3.0
Note Class Reference
Inheritance diagram for Note:
DataObject

Public Member Functions

 getAssocId ()
 
 getAssocType ()
 
 getContents ()
 
 getDateCreated ()
 
 getDateModified ()
 
 getTitle ()
 
 getUser ()
 
 getUserId ()
 
 markViewed ($userId)
 
 setAssocId ($assocId)
 
 setAssocType ($assocType)
 
 setContents ($contents)
 
 setDateCreated ($dateCreated)
 
 setDateModified ($dateModified)
 
 setTitle ($title)
 
 setUserId ($userId)
 
- Public Member Functions inherited from DataObject
 __construct ()
 
 addSupportedMetadataAdapter ($metadataAdapter)
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
 getDAO ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
 getLocalizedData ($key, $preferredLocale=null)
 
 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)
 
 unsetData ($key, $locale=null)
 
 upcastTo ($targetObject)
 

Additional Inherited Members

- Data Fields inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Class for Note.

See also
NoteDAO

Definition at line 17 of file Note.inc.php.

Member Function Documentation

◆ getAssocId()

Note::getAssocId ( )

get note assoc id

Returns
int

Definition at line 128 of file Note.inc.php.

References DataObject\getData().

◆ getAssocType()

Note::getAssocType ( )

get note type

Returns
int

Definition at line 112 of file Note.inc.php.

References DataObject\getData().

◆ getContents()

Note::getContents ( )

get note contents

Returns
string

Definition at line 80 of file Note.inc.php.

References DataObject\getData().

◆ getDateCreated()

Note::getDateCreated ( )

get date note was created

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

Definition at line 48 of file Note.inc.php.

References DataObject\getData().

◆ getDateModified()

Note::getDateModified ( )

get date note was modified

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

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

References DataObject\getData().

◆ getTitle()

Note::getTitle ( )

get note title

Returns
string

Definition at line 96 of file Note.inc.php.

References DataObject\getData().

◆ getUser()

Note::getUser ( )

Return the user of the note's author.

Returns
User

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

References DAORegistry\getDAO(), and getUserId().

◆ getUserId()

Note::getUserId ( )

get user id of the note's author

Returns
int

Definition at line 23 of file Note.inc.php.

References DataObject\getData().

Referenced by getUser().

◆ markViewed()

Note::markViewed (   $userId)

Mark a note viewed.

Parameters
$userIdint
Returns
int RECORD_VIEW_RESULT_...

Definition at line 145 of file Note.inc.php.

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

◆ setAssocId()

Note::setAssocId (   $assocId)

set note assoc id

Parameters
$assocIdint

Definition at line 136 of file Note.inc.php.

References DataObject\setData().

◆ setAssocType()

Note::setAssocType (   $assocType)

set note type

Parameters
$assocTypeint

Definition at line 120 of file Note.inc.php.

References DataObject\setData().

◆ setContents()

Note::setContents (   $contents)

set note contents

Parameters
$contentsstring

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

References DataObject\setData().

◆ setDateCreated()

Note::setDateCreated (   $dateCreated)

set date note was created

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

Definition at line 56 of file Note.inc.php.

References DataObject\setData().

◆ setDateModified()

Note::setDateModified (   $dateModified)

set date note was modified

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

Definition at line 72 of file Note.inc.php.

References DataObject\setData().

◆ setTitle()

Note::setTitle (   $title)

set note title

Parameters
$titlestring

Definition at line 104 of file Note.inc.php.

References DataObject\setData().

◆ setUserId()

Note::setUserId (   $userId)

set user id of the note's author

Parameters
$userIdint

Definition at line 31 of file Note.inc.php.

References DataObject\setData().


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