ILIAS
Release_5_0_x_branch Revision 61816
|
Note class. More...
Public Member Functions | |
ilNote ($a_id=0) | |
constructor | |
setId ($a_id) | |
set id | |
getId () | |
get id | |
setObject ($a_obj_type, $a_rep_obj_id, $a_obj_id=0) | |
set assigned object | |
getObject () | |
setType ($a_type) | |
set type | |
getType () | |
get type | |
setAuthor ($a_user_id) | |
set author | |
getAuthor () | |
get author | |
setText ($a_text) | |
set text | |
getText () | |
get text | |
setSubject ($a_subject) | |
set subject | |
getSubject () | |
get subject | |
setCreationDate ($a_date) | |
set creation date | |
getCreationDate () | |
get creation date | |
setUpdateDate ($a_date) | |
set update date | |
getUpdateDate () | |
get update date | |
setLabel ($a_label) | |
set label | |
getLabel () | |
get label | |
setInRepository ($a_value) | |
set repository object status | |
isInRepository () | |
belongs note to repository object? | |
create ($a_use_provided_creation_date=false) | |
update () | |
read () | |
delete () | |
delete note | |
setAllData ($a_note_rec) | |
set all note data by record array | |
_lookupCreationDate ($a_id) | |
lookup creation date of note | |
_lookupUpdateDate ($a_id) | |
lookup update date of note | |
_getNotesOfObject ($a_rep_obj_id, $a_obj_id, $a_obj_type, $a_type=IL_NOTE_PRIVATE, $a_incl_sub=false, $a_filter="", $a_all_public="y", $a_repository_mode=true, $a_sort_ascending=false) | |
get all notes related to a specific object | |
_getLastNotesOfUser () | |
get last notes of current user | |
_getRelatedObjectsOfUser ($a_mode) | |
get all related objects for user |
Static Public Member Functions | |
static | getUserCount ($a_rep_obj_id, $a_obj_id, $a_type) |
How many users have attached a note/comment to a given object? | |
static | _countNotesAndCommentsMultiple ($a_rep_obj_ids, $a_no_sub_objs=false) |
Get all notes related to multiple objcts. | |
static | _countNotesAndComments ($a_rep_obj_id, $a_sub_obj_id=null) |
Get all notes related to a specific object. | |
static | activateComments ($a_rep_obj_id, $a_obj_id, $a_obj_type, $a_activate=true) |
Activate notes feature. | |
static | commentsActivated ($a_rep_obj_id, $a_obj_id, $a_obj_type) |
Are comments activated for object? | |
static | getRepObjActivation ($a_rep_obj_ids) |
Get activation for repository objects. |
Note class.
Represents a single note.
Definition at line 24 of file class.ilNote.php.
|
static |
Get all notes related to a specific object.
array | $a_rep_obj_ids | repository object IDs array |
int | $a_sub_obj_id | sub objects (if null, all comments are counted) |
Definition at line 665 of file class.ilNote.php.
References $ilDB, $ilUser, IL_NOTE_PRIVATE, and IL_NOTE_PUBLIC.
Referenced by ilObjectListGUI\getHeaderAction(), and ilPollBlockGUI\getNumberOfComments().
|
static |
Get all notes related to multiple objcts.
array | $a_rep_obj_ids | repository object IDs array |
boolean | $a_no_sub_objs | include subobjects true/false |
Definition at line 632 of file class.ilNote.php.
References $ilDB, $ilUser, IL_NOTE_PRIVATE, and IL_NOTE_PUBLIC.
Referenced by ilObjectListGUI\preloadCommonProperties().
ilNote::_getLastNotesOfUser | ( | ) |
get last notes of current user
Definition at line 448 of file class.ilNote.php.
References $ilDB, $ilUser, IL_NOTE_PRIVATE, and ilNote().
Referenced by ilPDNotesBlockGUI\fillDataSection().
ilNote::_getNotesOfObject | ( | $a_rep_obj_id, | |
$a_obj_id, | |||
$a_obj_type, | |||
$a_type = IL_NOTE_PRIVATE , |
|||
$a_incl_sub = false , |
|||
$a_filter = "" , |
|||
$a_all_public = "y" , |
|||
$a_repository_mode = true , |
|||
$a_sort_ascending = false |
|||
) |
get all notes related to a specific object
Definition at line 393 of file class.ilNote.php.
References $ilDB, $ilUser, IL_NOTE_PRIVATE, and ilNote().
Referenced by ilDataCollectionRecord\getComments(), ilNoteGUI\getNoteListHTML(), and ilObjBlogGUI\renderList().
ilNote::_getRelatedObjectsOfUser | ( | $a_mode | ) |
get all related objects for user
Definition at line 474 of file class.ilNote.php.
References $ilDB, $ilUser, $ref_id, ilObject\_getAllReferences(), ilObjUser\_lookupDesktopItems(), ilObject\_lookupType(), commentsActivated(), IL_NOTE_PRIVATE, IL_NOTE_PUBLIC, ilWorkspaceTree\lookupNodeId(), and ilPDNotesGUI\PRIVATE_NOTES.
Referenced by ilPDNotesGUI\view().
ilNote::_lookupCreationDate | ( | $a_id | ) |
lookup creation date of note
Definition at line 363 of file class.ilNote.php.
References $ilDB, and getId().
Referenced by create().
ilNote::_lookupUpdateDate | ( | $a_id | ) |
lookup update date of note
Definition at line 378 of file class.ilNote.php.
References $ilDB, and getId().
Referenced by update().
|
static |
Activate notes feature.
@return |
Definition at line 698 of file class.ilNote.php.
References $ilDB.
Referenced by ilObjContentObject\createProperties(), ilObjBlog\doCreate(), ilObjBlog\doUpdate(), ilObjPortfolioBase\doUpdate(), ilObjPoll\doUpdate(), and ilObjContentObject\updateProperties().
|
static |
Are comments activated for object?
@return |
Definition at line 746 of file class.ilNote.php.
References $ilDB.
Referenced by _getRelatedObjectsOfUser(), ilObjBlog\doRead(), ilObjPortfolioBase\doRead(), ilObjPoll\doRead(), ilNoteGUI\getNotesHTML(), ilPortfolioDataSet\getXmlRecord(), ilPollDataSet\getXmlRecord(), ilBlogDataSet\getXmlRecord(), ilNoteGUI\ilNoteGUI(), ilObjectGUI\initHeaderAction(), ilObjectListGUI\isCommentsActivated(), and ilObjContentObject\readProperties().
ilNote::create | ( | $a_use_provided_creation_date = false | ) |
Definition at line 246 of file class.ilNote.php.
References $ilDB, _lookupCreationDate(), getCreationDate(), getId(), and ilUtil\now().
ilNote::delete | ( | ) |
ilNote::getAuthor | ( | ) |
get author
Definition at line 119 of file class.ilNote.php.
ilNote::getCreationDate | ( | ) |
get creation date
Definition at line 179 of file class.ilNote.php.
Referenced by create().
ilNote::getId | ( | ) |
get id
Definition at line 54 of file class.ilNote.php.
Referenced by _lookupCreationDate(), _lookupUpdateDate(), create(), delete(), read(), and update().
ilNote::getLabel | ( | ) |
get label
Definition at line 221 of file class.ilNote.php.
ilNote::getObject | ( | ) |
Definition at line 76 of file class.ilNote.php.
|
static |
Get activation for repository objects.
@return |
Definition at line 769 of file class.ilNote.php.
References $ilDB.
Referenced by ilObjectListGUI\preloadCommonProperties().
ilNote::getSubject | ( | ) |
get subject
Definition at line 159 of file class.ilNote.php.
ilNote::getText | ( | ) |
get text
Definition at line 139 of file class.ilNote.php.
ilNote::getType | ( | ) |
get type
Definition at line 99 of file class.ilNote.php.
ilNote::getUpdateDate | ( | ) |
get update date
Definition at line 199 of file class.ilNote.php.
|
static |
How many users have attached a note/comment to a given object?
int | $a_rep_obj_id | object id (as in object data) |
int | $a_obj_id | (sub) object id |
string | $a_type | (sub) object type |
Definition at line 614 of file class.ilNote.php.
References $ilDB.
Referenced by ilBlogPostingGUI\deleteBlogPostingConfirmationScreen(), and ilWikiPageGUI\deleteWikiPageConfirmationScreen().
ilNote::ilNote | ( | $a_id = 0 | ) |
constructor
Definition at line 30 of file class.ilNote.php.
References read().
Referenced by _getLastNotesOfUser(), and _getNotesOfObject().
ilNote::isInRepository | ( | ) |
belongs note to repository object?
Definition at line 241 of file class.ilNote.php.
ilNote::read | ( | ) |
Definition at line 320 of file class.ilNote.php.
References $ilDB, getId(), and setAllData().
Referenced by ilNote().
ilNote::setAllData | ( | $a_note_rec | ) |
set all note data by record array
Definition at line 346 of file class.ilNote.php.
References setAuthor(), setCreationDate(), setId(), setInRepository(), setLabel(), setObject(), setSubject(), setText(), setType(), and setUpdateDate().
Referenced by read().
ilNote::setAuthor | ( | $a_user_id | ) |
set author
int | author user id |
Definition at line 109 of file class.ilNote.php.
Referenced by setAllData().
ilNote::setCreationDate | ( | $a_date | ) |
set creation date
string | creation date |
Definition at line 169 of file class.ilNote.php.
Referenced by setAllData().
ilNote::setId | ( | $a_id | ) |
set id
int | note id |
Definition at line 44 of file class.ilNote.php.
Referenced by setAllData().
ilNote::setInRepository | ( | $a_value | ) |
set repository object status
bool |
Definition at line 231 of file class.ilNote.php.
Referenced by setAllData().
ilNote::setLabel | ( | $a_label | ) |
set label
int | IL_NOTE_UNLABELED | IL_NOTE_IMPORTANT | IL_NOTE_QUESTION | IL_NOTE_PRO | IL_NOTE_CONTRA |
Definition at line 210 of file class.ilNote.php.
Referenced by setAllData().
ilNote::setObject | ( | $a_obj_type, | |
$a_rep_obj_id, | |||
$a_obj_id = 0 |
|||
) |
set assigned object
$a_type | string type of the object (e.g st,pg,crs ...) |
$a_rep_obj_id | int object id (NOT ref_id!) of repository object (e.g for page objects the obj_id of the learning module; for personal desktop this is set to 0) |
$a_obj_id | int object id (e.g for page objects the obj_id of the page object) for, this is set to 0 for normal repository objects like forums ... |
Definition at line 69 of file class.ilNote.php.
Referenced by setAllData().
ilNote::setSubject | ( | $a_subject | ) |
set subject
string | text |
Definition at line 149 of file class.ilNote.php.
Referenced by setAllData().
ilNote::setText | ( | $a_text | ) |
set text
string | text |
Definition at line 129 of file class.ilNote.php.
Referenced by setAllData().
ilNote::setType | ( | $a_type | ) |
set type
int | IL_NOTE_PUBLIC | IL_NOTE_PRIVATE |
Definition at line 89 of file class.ilNote.php.
Referenced by setAllData().
ilNote::setUpdateDate | ( | $a_date | ) |
set update date
string | update date |
Definition at line 189 of file class.ilNote.php.
Referenced by setAllData().
ilNote::update | ( | ) |
Definition at line 286 of file class.ilNote.php.
References $ilDB, _lookupUpdateDate(), getId(), and ilUtil\now().