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.

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.

      {
        $this->id = $id;
        $this->context = $context;
        $this->text = $text;
        $this->author = $author;
        $this->type = $type;
        $this->update_date = $update_date;
        $this->creation_date = $creation_date;
        $this->recipient = $recipient;
    }

Member Function Documentation

getAuthor()

ILIAS\Notes\Note::getAuthor

(

)

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

References ILIAS\Notes\Note\$author.

Referenced by ILIAS\Notes\AccessManager\canDelete(), ILIAS\Notes\AccessManager\canEdit(), ILIAS\Notes\NoteDBRepository\createNote(), ilNoteGUI\exportNotesHTML(), ilNoteGUI\getItemForNote(), ilMessageGUI\getItemTitle(), ilCommentGUI\getItemTitle(), and ilNoteGUI\getItemTitle().

                               : int
    {
        return $this->author;
    }

Here is the caller graph for this function:

getContext()

ILIAS\Notes\Note::getContext

(

)

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

References ILIAS\Notes\Note\$context.

Referenced by ILIAS\Notes\AccessManager\canDelete(), ILIAS\Notes\NoteDBRepository\createNote(), and ilNoteGUI\getTarget().

                                : Context
    {
        return $this->context;
    }

Here is the caller graph for this function:

getCreationDate()

ILIAS\Notes\Note::getCreationDate

(

)

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

References ILIAS\Notes\Note\$creation_date.

Referenced by ilCommentGUI\addItemProperties(), ilMessageGUI\addItemProperties(), ilNoteGUI\addItemProperties(), ILIAS\Notes\NoteDBRepository\createNote(), ilNoteGUI\getItemForNote(), and ilNoteGUI\getItemTitle().

                                     : ?string
    {
        return $this->creation_date;
    }

Here is the caller graph for this function:

getId()

ILIAS\Notes\Note::getId

(

)

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

References ILIAS\Notes\Note\$id.

Referenced by ILIAS\Notes\NotesManager\deleteNote(), ilNoteGUI\getItemForNote(), ilNoteGUI\getNoteTextPlaceholder(), and ilNoteGUI\getTarget().

                           : int
    {
        return $this->id;
    }

Here is the caller graph for this function:

getRecipient()

ILIAS\Notes\Note::getRecipient

(

)

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

References ILIAS\Notes\Note\$recipient.

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

                                  : int
    {
        return $this->recipient;
    }

Here is the caller graph for this function:

getText()

ILIAS\Notes\Note::getText

(

)

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

References ILIAS\Notes\Note\$text.

Referenced by ILIAS\Notes\NoteDBRepository\createNote(), and ilNoteGUI\getNoteText().

                             : string
    {
        return $this->text;
    }

Here is the caller graph for this function:

getType()

ILIAS\Notes\Note::getType

(

)

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

References ILIAS\Notes\Note\$type.

Referenced by ilNoteGUI\addItemProperties(), ILIAS\Notes\AccessManager\canDelete(), ILIAS\Notes\NoteDBRepository\createNote(), ilNoteGUI\getItemForNote(), and ilNoteGUI\getItemTitle().

                             : int
    {
        return $this->type;
    }

Here is the caller graph for this function:

getUpdateDate()

ILIAS\Notes\Note::getUpdateDate

(

)

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

References ILIAS\Notes\Note\$update_date.

Referenced by ilNoteGUI\getItemForNote().

                                   : ?string
    {
        return $this->update_date;
    }

Here is the caller graph for this function:

withCreationDate()

ILIAS\Notes\Note::withCreationDate

(

string

$creation_date

)

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

References ILIAS\Notes\Note\$creation_date.

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

                                                           : self
    {
        $note = clone $this;
        $note->creation_date = $creation_date;
        return $note;
    }

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

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

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

$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.

Referenced by ILIAS\Notes\AccessManager\canDelete(), ILIAS\Notes\NoteDBRepository\countNotesAndCommentsMultipleObjects(), ILIAS\Notes\Export\NotesHtmlExport\exportPage(), ILIAS\Notes\DomainService\getNrOfNotesForContext(), and ILIAS\Notes\NotificationsManager\sendNotifications().

PUBLIC

const ILIAS\Notes\Note::PUBLIC = 2

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

Referenced by ILIAS\Notes\AccessManager\canDelete(), ILIAS\Notes\NoteDBRepository\countNotesAndCommentsMultipleObjects(), ILIAS\Notes\DomainService\getAllCommentsForObjId(), ILIAS\Notes\DomainService\getNrOfCommentsForContext(), and ILIAS\Notes\NotesManager\getRelatedObjectsOfUser().

---

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

• components/ILIAS/Notes/Note/class.Note.php