ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ILIAS\Notes\Note Class Reference
+ Collaboration diagram for ILIAS\Notes\Note:

Public Member Functions

 __construct (int $id, Context $context, string $text, int $author, int $type=self::PRIVATE, ?string $creation_date=null, ?string $update_date=null, ?int $recipient=0)
 
 withCreationDate (string $creation_date)
 
 getId ()
 
 getContext ()
 
 getText ()
 
 getAuthor ()
 
 getType ()
 
 getCreationDate ()
 
 getUpdateDate ()
 
 getRecipient ()
 

Data Fields

const PRIVATE = 1
 
const PUBLIC = 2
 
const MESSAGE = 3
 

Protected Attributes

int $id = 0
 
string $update_date
 
string $creation_date
 
int $author = 0
 
int $type = 0
 
string $text = ""
 
int $recipient = 0
 
Context $context
 

Detailed Description

Author
Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 26 of file class.Note.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Notes\Note::__construct ( int  $id,
Context  $context,
string  $text,
int  $author,
int  $type = self::PRIVATE,
?string  $creation_date = null,
?string  $update_date = null,
?int  $recipient = 0 
)

Definition at line 41 of file class.Note.php.

50 {
51 $this->id = $id;
52 $this->context = $context;
53 $this->text = $text;
54 $this->author = $author;
55 $this->type = $type;
56 $this->update_date = $update_date;
57 $this->creation_date = $creation_date;
58 $this->recipient = $recipient;
59 }
Context $context
Definition: class.Note.php:39
string $update_date
Definition: class.Note.php:33
string $creation_date
Definition: class.Note.php:34

References ILIAS\Notes\Note\$author, ILIAS\Notes\Note\$context, ILIAS\Notes\Note\$creation_date, ILIAS\Notes\Note\$id, ILIAS\Notes\Note\$recipient, ILIAS\Notes\Note\$text, ILIAS\Notes\Note\$type, and ILIAS\Notes\Note\$update_date.

Member Function Documentation

◆ getAuthor()

ILIAS\Notes\Note::getAuthor ( )

Definition at line 83 of file class.Note.php.

83 : int
84 {
85 return $this->author;
86 }

References ILIAS\Notes\Note\$author.

Referenced by ilNoteGUI\exportNotesHTML(), ilCommentGUI\getItemTitle(), ilMessageGUI\getItemTitle(), and ilNoteGUI\getItemTitle().

+ Here is the caller graph for this function:

◆ getContext()

ILIAS\Notes\Note::getContext ( )

Definition at line 73 of file class.Note.php.

73 : Context
74 {
75 return $this->context;
76 }

References ILIAS\Notes\Note\$context.

Referenced by ilNoteGUI\deleteNote(), and ILIAS\Notes\NotificationsManager\notifyObserver().

+ Here is the caller graph for this function:

◆ getCreationDate()

ILIAS\Notes\Note::getCreationDate ( )

Definition at line 93 of file class.Note.php.

93 : ?string
94 {
96 }

References ILIAS\Notes\Note\$creation_date.

Referenced by ilCommentGUI\addItemProperties(), ilMessageGUI\addItemProperties(), ilNoteGUI\addItemProperties(), and ilNoteGUI\getItemTitle().

+ Here is the caller graph for this function:

◆ getId()

ILIAS\Notes\Note::getId ( )

Definition at line 68 of file class.Note.php.

68 : int
69 {
70 return $this->id;
71 }

References ILIAS\Notes\Note\$id.

Referenced by ilNoteGUI\confirmDelete(), ILIAS\Notes\NotesManager\deleteNote(), ilNoteGUI\getItemForNote(), ilNoteGUI\getNoteTextPlaceholder(), and ILIAS\Notes\NotificationsManager\notifyObserver().

+ Here is the caller graph for this function:

◆ getRecipient()

ILIAS\Notes\Note::getRecipient ( )

Definition at line 103 of file class.Note.php.

103 : int
104 {
105 return $this->recipient;
106 }

References ILIAS\Notes\Note\$recipient.

◆ getText()

ILIAS\Notes\Note::getText ( )

Definition at line 78 of file class.Note.php.

78 : string
79 {
80 return $this->text;
81 }

References ILIAS\Notes\Note\$text.

Referenced by ilNoteGUI\getNoteText().

+ Here is the caller graph for this function:

◆ getType()

ILIAS\Notes\Note::getType ( )

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

88 : int
89 {
90 return $this->type;
91 }

References ILIAS\Notes\Note\$type.

Referenced by ilNoteGUI\addItemProperties(), and ilNoteGUI\getItemTitle().

+ Here is the caller graph for this function:

◆ getUpdateDate()

ILIAS\Notes\Note::getUpdateDate ( )

Definition at line 98 of file class.Note.php.

98 : ?string
99 {
100 return $this->update_date;
101 }

References ILIAS\Notes\Note\$update_date.

◆ withCreationDate()

ILIAS\Notes\Note::withCreationDate ( string  $creation_date)

Definition at line 61 of file class.Note.php.

61 : self
62 {
63 $note = clone $this;
64 $note->creation_date = $creation_date;
65 return $note;
66 }

References ILIAS\Notes\Note\$creation_date.

Referenced by ILIAS\Notes\NotesManager\createNote().

+ Here is the caller graph for this function:

Field Documentation

◆ $author

int ILIAS\Notes\Note::$author = 0
protected

Definition at line 35 of file class.Note.php.

Referenced by ILIAS\Notes\Note\__construct(), and ILIAS\Notes\Note\getAuthor().

◆ $context

Context ILIAS\Notes\Note::$context
protected

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

Referenced by ILIAS\Notes\Note\__construct(), and ILIAS\Notes\Note\getContext().

◆ $creation_date

string ILIAS\Notes\Note::$creation_date
protected

◆ $id

int ILIAS\Notes\Note::$id = 0
protected

Definition at line 32 of file class.Note.php.

Referenced by ILIAS\Notes\Note\__construct(), and ILIAS\Notes\Note\getId().

◆ $recipient

int ILIAS\Notes\Note::$recipient = 0
protected

Definition at line 38 of file class.Note.php.

Referenced by ILIAS\Notes\Note\__construct(), and ILIAS\Notes\Note\getRecipient().

◆ $text

string ILIAS\Notes\Note::$text = ""
protected

Definition at line 37 of file class.Note.php.

Referenced by ILIAS\Notes\Note\__construct(), and ILIAS\Notes\Note\getText().

◆ $type

int ILIAS\Notes\Note::$type = 0
protected

Definition at line 36 of file class.Note.php.

Referenced by ILIAS\Notes\Note\__construct(), and ILIAS\Notes\Note\getType().

◆ $update_date

string ILIAS\Notes\Note::$update_date
protected

Definition at line 33 of file class.Note.php.

Referenced by ILIAS\Notes\Note\__construct(), and ILIAS\Notes\Note\getUpdateDate().

◆ MESSAGE

const ILIAS\Notes\Note::MESSAGE = 3

Definition at line 30 of file class.Note.php.

◆ PRIVATE

const ILIAS\Notes\Note::PRIVATE = 1

Definition at line 28 of file class.Note.php.

◆ PUBLIC

const ILIAS\Notes\Note::PUBLIC = 2

Definition at line 29 of file class.Note.php.


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