ILIAS
release_5-4 Revision v5.4.26-12-gabc799a52e6
|
Notes GUI class. More...
Public Member Functions | |
__construct ( $a_rep_obj_id="", $a_obj_id="", $a_obj_type="", $a_include_subobjects=false, $a_news_id=0) | |
constructor, specifies notes set More... | |
setDefaultCommand ($a_val) | |
Set default command. More... | |
getDefaultCommand () | |
Get default command. More... | |
executeCommand () | |
execute command More... | |
enablePrivateNotes ($a_enable=true) | |
enable private notes More... | |
enablePublicNotes ($a_enable=true) | |
enable public notes More... | |
enableCommentsSettings ($a_enable=true) | |
enable private notes More... | |
enablePublicNotesDeletion ($a_enable=true) | |
enable public notes More... | |
enableHiding ($a_enable=true) | |
enable hiding More... | |
enableTargets ($a_enable=true) | |
enable target objects More... | |
enableMultiSelection ($a_enable=true) | |
enable multi selection (checkboxes and commands) More... | |
enableAnchorJump ($a_enable=true) | |
enable anchor for form jump More... | |
setRepositoryMode ($a_value) | |
Set repository mode. More... | |
getOnlyNotesHTML () | |
Get only notes html. More... | |
getOnlyCommentsHTML () | |
Get only comments html. More... | |
getNotesHTML ($a_init_form=true) | |
activateComments () | |
Activate Comments. More... | |
deactivateComments () | |
Deactivate Comments. More... | |
getNoteListHTML ($a_type=IL_NOTE_PRIVATE, $a_init_form=true) | |
get notes/comments list as html code More... | |
checkDeletion ($a_note) | |
Check whether deletion is allowed. More... | |
checkEdit ($a_note) | |
Check edit. More... | |
initNoteForm ($a_mode="edit", $a_type, $a_note=null) | |
Init note form. More... | |
getPDNoteHTML ($note_id) | |
Note display for personal desktop. More... | |
renderTargets ($a_note) | |
show related objects as links More... | |
addNoteForm ($a_init_form=true) | |
get notes list including add note area More... | |
cancelAddNote () | |
cancel add note More... | |
cancelUpdateNote () | |
cancel edit note More... | |
addNote () | |
add note More... | |
updateNote () | |
update note More... | |
editNoteForm ($a_init_form=true) | |
get notes list including add note area More... | |
deleteNote () | |
delete note confirmation More... | |
deleteNotes () | |
delete notes confirmation More... | |
cancelDelete () | |
cancel deletion of note More... | |
confirmDelete () | |
cancel deletion of note More... | |
exportNotesHTML () | |
export selected notes to html More... | |
printNotes () | |
notes print view screen More... | |
showNotes () | |
show notes More... | |
hideNotes () | |
hide notes More... | |
showAllPublicNotes () | |
show all public notes to user More... | |
showMyPublicNotes () | |
show only public notes of user More... | |
renderLink ($a_tpl, $a_var, $a_txt, $a_cmd, $a_anchor="") | |
Render a link. More... | |
addObserver ($a_callback) | |
Add observer. More... | |
getHTML () | |
Get HTML. More... | |
Static Public Member Functions | |
static | initJavascript ($a_ajax_url, $a_type=IL_NOTE_PRIVATE, ilTemplate $a_main_tpl=null) |
Init javascript. More... | |
static | getListNotesJSCall ($a_hash, $a_update_code=null) |
Get list notes js call. More... | |
static | getListCommentsJSCall ($a_hash, $a_update_code=null) |
Get list comments js call. More... | |
Data Fields | |
$public_deletion_enabled = false | |
$repository_mode = false | |
$old = false | |
Protected Member Functions | |
getSubObjectTitle ($parent_obj_id, $sub_obj_id) | |
Get sub object title if available with callback. More... | |
notifyObserver ($a_action, $a_note) | |
Notify observers on update/create. More... | |
listSortAsc () | |
listSortDesc () | |
getCommentsWidget () | |
Get widget. More... | |
updateWidget () | |
Update widget. More... | |
Static Protected Member Functions | |
static | buildAjaxHash ($a_node_type, $a_node_id, $a_sub_id, $a_sub_type) |
Combine properties to hash. More... | |
Protected Attributes | |
$ctrl | |
$lng | |
$user | |
$settings | |
$obj_definition | |
$tree | |
$access | |
$default_command = "getNotesHTML" | |
$observer = [] | |
$ui | |
$news_id = 0 | |
$hide_new_form = false | |
$only_latest = false | |
$widget_header = "" | |
$no_actions = false | |
Notes GUI class.
An instance of this class handles all notes (and their lists) of an object.
Definition at line 18 of file class.ilNoteGUI.php.
ilNoteGUI::__construct | ( | $a_rep_obj_id = "" , |
|
$a_obj_id = "" , |
|||
$a_obj_type = "" , |
|||
$a_include_subobjects = false , |
|||
$a_news_id = 0 |
|||
) |
constructor, specifies notes set
$a_rep_obj_id | int object id of repository object (0 for personal desktop) |
$a_obj_id | int subobject id (0 for repository items, user id for personal desktop) |
$a_obj_type | string "pd" for personal desktop |
$a_include_subobjects | string include all subobjects of rep object (e.g. pages) |
Definition at line 105 of file class.ilNoteGUI.php.
References $_GET, $DIC, $ilCtrl, $lng, ilObject\_lookupType(), ilNote\commentsActivated(), ilUtil\getImagePath(), IL_NOTE_CONTRA, IL_NOTE_IMPORTANT, IL_NOTE_PRO, IL_NOTE_QUESTION, IL_NOTE_UNLABELED, setRepositoryMode(), settings(), and user().
ilNoteGUI::activateComments | ( | ) |
Activate Comments.
Definition at line 462 of file class.ilNoteGUI.php.
References $ctrl, $ilCtrl, and ilNote\activateComments().
ilNoteGUI::addNote | ( | ) |
add note
Definition at line 1360 of file class.ilNoteGUI.php.
References $_GET, $_POST, $ctrl, $ilCtrl, $ilUser, $lng, $user, initNoteForm(), and notifyObserver().
ilNoteGUI::addNoteForm | ( | $a_init_form = true | ) |
get notes list including add note area
Definition at line 1328 of file class.ilNoteGUI.php.
References $_GET, $ilUser, $user, getNotesHTML(), and IL_NOTE_PRIVATE.
ilNoteGUI::addObserver | ( | $a_callback | ) |
Add observer.
string | array | $a_callback |
Definition at line 1694 of file class.ilNoteGUI.php.
|
staticprotected |
Combine properties to hash.
string | $a_node_type | |
int | $a_node_id | |
int | $a_sub_id | |
string | $a_sub_type |
Definition at line 1656 of file class.ilNoteGUI.php.
ilNoteGUI::cancelAddNote | ( | ) |
cancel add note
Definition at line 1344 of file class.ilNoteGUI.php.
References getNotesHTML().
ilNoteGUI::cancelDelete | ( | ) |
cancel deletion of note
Definition at line 1470 of file class.ilNoteGUI.php.
References getNotesHTML().
ilNoteGUI::cancelUpdateNote | ( | ) |
cancel edit note
Definition at line 1352 of file class.ilNoteGUI.php.
References getNotesHTML().
ilNoteGUI::checkDeletion | ( | $a_note | ) |
Check whether deletion is allowed.
Definition at line 951 of file class.ilNoteGUI.php.
References $ilSetting, $ilUser, $public_deletion_enabled, $settings, $user, IL_NOTE_PRIVATE, and IL_NOTE_PUBLIC.
Referenced by confirmDelete(), and getNoteListHTML().
ilNoteGUI::checkEdit | ( | $a_note | ) |
Check edit.
Definition at line 980 of file class.ilNoteGUI.php.
References $ilUser, and $user.
Referenced by getNoteListHTML(), and updateNote().
ilNoteGUI::confirmDelete | ( | ) |
cancel deletion of note
Definition at line 1478 of file class.ilNoteGUI.php.
References $_POST, $ctrl, $id, $ilCtrl, $ilUser, $lng, $user, and checkDeletion().
ilNoteGUI::deactivateComments | ( | ) |
Deactivate Comments.
Definition at line 476 of file class.ilNoteGUI.php.
References $ctrl, $ilCtrl, and ilNote\activateComments().
ilNoteGUI::deleteNote | ( | ) |
delete note confirmation
Definition at line 1443 of file class.ilNoteGUI.php.
References getNotesHTML().
ilNoteGUI::deleteNotes | ( | ) |
delete notes confirmation
Definition at line 1453 of file class.ilNoteGUI.php.
References $_POST, $lng, and getNotesHTML().
ilNoteGUI::editNoteForm | ( | $a_init_form = true | ) |
get notes list including add note area
Definition at line 1433 of file class.ilNoteGUI.php.
References getNotesHTML().
Referenced by updateNote().
ilNoteGUI::enableAnchorJump | ( | $a_enable = true | ) |
enable anchor for form jump
Definition at line 295 of file class.ilNoteGUI.php.
ilNoteGUI::enableCommentsSettings | ( | $a_enable = true | ) |
enable private notes
Definition at line 255 of file class.ilNoteGUI.php.
ilNoteGUI::enableHiding | ( | $a_enable = true | ) |
enable hiding
Definition at line 271 of file class.ilNoteGUI.php.
ilNoteGUI::enableMultiSelection | ( | $a_enable = true | ) |
enable multi selection (checkboxes and commands)
Definition at line 287 of file class.ilNoteGUI.php.
ilNoteGUI::enablePrivateNotes | ( | $a_enable = true | ) |
enable private notes
Definition at line 239 of file class.ilNoteGUI.php.
Referenced by ilPageObjectGUI\getNotesHTML(), and ilPDNotesGUI\view().
ilNoteGUI::enablePublicNotes | ( | $a_enable = true | ) |
enable public notes
Definition at line 247 of file class.ilNoteGUI.php.
Referenced by ilAssQuestionPreviewGUI\executeCommand(), assQuestionGUI\getNotesHTML(), and ilInfoScreenGUI\showNotesSection().
ilNoteGUI::enablePublicNotesDeletion | ( | $a_enable = true | ) |
enable public notes
Definition at line 263 of file class.ilNoteGUI.php.
Referenced by ilLMPresentationGUI\ilLMNotes().
ilNoteGUI::enableTargets | ( | $a_enable = true | ) |
enable target objects
Definition at line 279 of file class.ilNoteGUI.php.
ilNoteGUI::executeCommand | ( | ) |
execute command
Definition at line 224 of file class.ilNoteGUI.php.
References getDefaultCommand().
ilNoteGUI::exportNotesHTML | ( | ) |
export selected notes to html
Definition at line 1503 of file class.ilNoteGUI.php.
References $tpl, ilUtil\deliverData(), and getNotesHTML().
|
protected |
Get widget.
Definition at line 1748 of file class.ilNoteGUI.php.
References $_GET, $c, $ctrl, $f, $html, $id, $lng, $r, $tpl, ilNote\_countNotesAndComments(), ilObject\_lookupType(), ilCommonActionDispatcherGUI\buildAjaxHash(), getNoteListHTML(), IL_NOTE_PUBLIC, ilCommonActionDispatcherGUI\TYPE_REPOSITORY, and ILIAS\UI\Implementation\Component\withAdditionalOnLoadCode().
Referenced by getHTML(), and updateWidget().
ilNoteGUI::getDefaultCommand | ( | ) |
Get default command.
Definition at line 216 of file class.ilNoteGUI.php.
References $default_command.
Referenced by executeCommand().
ilNoteGUI::getHTML | ( | ) |
Get HTML.
Definition at line 1736 of file class.ilNoteGUI.php.
References getCommentsWidget().
|
static |
Get list comments js call.
string | $a_hash | |
string | $a_update_code |
Definition at line 1636 of file class.ilNoteGUI.php.
Referenced by ilObjectListGUI\determineProperties(), ilDclRecordListTableGUI\getCommentsAjaxLink(), ilQuestionBrowserTableGUI\getCommentsAjaxLink(), ilObjectListGUI\getHeaderAction(), ilDclBaseRecordModel\getStandardFieldHTML(), and ilObjectListGUI\insertCommonSocialCommands().
|
static |
Get list notes js call.
string | $a_hash | |
string | $a_update_code |
Definition at line 1618 of file class.ilNoteGUI.php.
Referenced by ilObjectListGUI\determineProperties(), ilObjectListGUI\getHeaderAction(), and ilObjectListGUI\insertCommonSocialCommands().
ilNoteGUI::getNoteListHTML | ( | $a_type = IL_NOTE_PRIVATE , |
|
$a_init_form = true |
|||
) |
get notes/comments list as html code
Definition at line 490 of file class.ilNoteGUI.php.
References $_GET, $_POST, $_SESSION, $a_type, $ctrl, $hide_new_form, $ilCtrl, $ilUser, $img, $lng, $mtype, $target, $text, $title, $tpl, $txt, $user, ilObject\_exists(), ilNote\_getNotesOfObject(), ilObjUser\_lookupLogin(), ilContainerReference\_lookupTitle(), ilObject\_lookupTitle(), checkDeletion(), checkEdit(), ilGlyphGUI\CLOSE, ilDatePresentation\formatDate(), ilGlyphGUI\get(), ilUtil\getImagePath(), ilUserUtil\getNamePresentation(), getSubObjectTitle(), IL_CAL_DATETIME, IL_NOTE_PRIVATE, IL_NOTE_PUBLIC, ilUtil\img(), initNoteForm(), renderLink(), renderTargets(), ilDatePresentation\setUseRelativeDates(), and ilDatePresentation\useRelativeDates().
Referenced by getCommentsWidget(), and getNotesHTML().
ilNoteGUI::getNotesHTML | ( | $a_init_form = true | ) |
Definition at line 343 of file class.ilNoteGUI.php.
References $_GET, $ctrl, $ilCtrl, $ilSetting, $ilUser, $lng, $settings, $user, ilNote\commentsActivated(), exit, getNoteListHTML(), IL_NOTE_PRIVATE, IL_NOTE_PUBLIC, and renderLink().
Referenced by addNoteForm(), cancelAddNote(), cancelDelete(), cancelUpdateNote(), deleteNote(), deleteNotes(), editNoteForm(), exportNotesHTML(), getOnlyCommentsHTML(), getOnlyNotesHTML(), hideNotes(), printNotes(), showAllPublicNotes(), showMyPublicNotes(), and showNotes().
ilNoteGUI::getOnlyCommentsHTML | ( | ) |
Get only comments html.
Definition at line 331 of file class.ilNoteGUI.php.
References $ctrl, $ilCtrl, and getNotesHTML().
ilNoteGUI::getOnlyNotesHTML | ( | ) |
Get only notes html.
Definition at line 317 of file class.ilNoteGUI.php.
References $ctrl, $ilCtrl, and getNotesHTML().
ilNoteGUI::getPDNoteHTML | ( | $note_id | ) |
Note display for personal desktop.
Definition at line 1095 of file class.ilNoteGUI.php.
References $ctrl, $ilCtrl, $ilUser, $lng, $target, $text, $tpl, $user, ilDatePresentation\formatDate(), IL_CAL_DATETIME, and renderTargets().
|
protected |
Get sub object title if available with callback.
int | $parent_obj_id | |
int | $sub_obj_id |
Definition at line 934 of file class.ilNoteGUI.php.
References $ctrl, $ilCtrl, $obj_definition, and ilObject\_lookupType().
Referenced by getNoteListHTML(), and renderTargets().
ilNoteGUI::hideNotes | ( | ) |
hide notes
Definition at line 1545 of file class.ilNoteGUI.php.
References $_GET, $ilUser, $user, getNotesHTML(), and IL_NOTE_PRIVATE.
|
static |
Init javascript.
Definition at line 1584 of file class.ilNoteGUI.php.
References $DIC, $lng, $tpl, iljQueryUtil\initjQuery(), ilModalGUI\initJS(), and ilYuiUtil\initPanel().
Referenced by ilQuestionBrowserTableGUI\__construct(), assQuestionGUI\addHeaderAction(), and ilObjectListGUI\prepareJsLinks().
ilNoteGUI::initNoteForm | ( | $a_mode = "edit" , |
|
$a_type, | |||
$a_note = null |
|||
) |
Init note form.
int | $a_mode | Edit Mode |
Definition at line 997 of file class.ilNoteGUI.php.
References $_GET, $a_type, $ctrl, $ilCtrl, $lng, IL_NOTE_PUBLIC, and ilUtil\prepareFormOutput().
Referenced by addNote(), getNoteListHTML(), and updateNote().
|
protected |
|
protected |
|
protected |
Notify observers on update/create.
string | $a_action | |
ilNote | $a_note |
Definition at line 1705 of file class.ilNoteGUI.php.
Referenced by addNote(), and updateNote().
ilNoteGUI::printNotes | ( | ) |
notes print view screen
Definition at line 1516 of file class.ilNoteGUI.php.
References $tpl, exit, and getNotesHTML().
ilNoteGUI::renderLink | ( | $a_tpl, | |
$a_var, | |||
$a_txt, | |||
$a_cmd, | |||
$a_anchor = "" |
|||
) |
Render a link.
Definition at line 1664 of file class.ilNoteGUI.php.
References $ctrl, and $ilCtrl.
Referenced by getNoteListHTML(), and getNotesHTML().
ilNoteGUI::renderTargets | ( | $a_note | ) |
show related objects as links
Definition at line 1151 of file class.ilNoteGUI.php.
References $access, $additional, $ilUser, $location, $obj_definition, $path, $target, $title, $tree, $type, $user, ilObject\_getAllReferences(), ilLink\_getLink(), ilObject\_lookupObjId(), ilObject\_lookupOwner(), ilObject\_lookupOwnerName(), ilContainerReference\_lookupTargetId(), ilSCORM2004Node\_lookupTitle(), ilObject\_lookupTitle(), ilObject\_lookupType(), ilUtil\appendUrlParameterString(), ilWorkspaceAccessHandler\getGotoLink(), and getSubObjectTitle().
Referenced by getNoteListHTML(), and getPDNoteHTML().
ilNoteGUI::setDefaultCommand | ( | $a_val | ) |
Set default command.
string | $a_val | default command |
Definition at line 206 of file class.ilNoteGUI.php.
Referenced by ilNewsTimelineItemGUI\renderFooter().
ilNoteGUI::setRepositoryMode | ( | $a_value | ) |
Set repository mode.
bool | $a_value |
Definition at line 305 of file class.ilNoteGUI.php.
Referenced by __construct().
ilNoteGUI::showAllPublicNotes | ( | ) |
show all public notes to user
Definition at line 1560 of file class.ilNoteGUI.php.
References $ilUser, $user, and getNotesHTML().
ilNoteGUI::showMyPublicNotes | ( | ) |
show only public notes of user
Definition at line 1572 of file class.ilNoteGUI.php.
References $ilUser, $user, and getNotesHTML().
ilNoteGUI::showNotes | ( | ) |
show notes
Definition at line 1530 of file class.ilNoteGUI.php.
References $_GET, $ilUser, $user, getNotesHTML(), and IL_NOTE_PRIVATE.
ilNoteGUI::updateNote | ( | ) |
update note
Definition at line 1394 of file class.ilNoteGUI.php.
References $_GET, $_POST, $ctrl, $ilCtrl, $ilUser, $lng, $user, checkEdit(), editNoteForm(), initNoteForm(), notifyObserver(), and ilUtil\stripSlashes().
|
protected |
Update widget.
Definition at line 1810 of file class.ilNoteGUI.php.
References exit, and getCommentsWidget().
|
protected |
Definition at line 53 of file class.ilNoteGUI.php.
Referenced by renderTargets().
|
protected |
Definition at line 23 of file class.ilNoteGUI.php.
Referenced by activateComments(), addNote(), confirmDelete(), deactivateComments(), getCommentsWidget(), getNoteListHTML(), getNotesHTML(), getOnlyCommentsHTML(), getOnlyNotesHTML(), getPDNoteHTML(), getSubObjectTitle(), initNoteForm(), renderLink(), and updateNote().
|
protected |
Definition at line 59 of file class.ilNoteGUI.php.
Referenced by getDefaultCommand().
|
protected |
Definition at line 78 of file class.ilNoteGUI.php.
Referenced by getNoteListHTML().
|
protected |
Definition at line 28 of file class.ilNoteGUI.php.
Referenced by __construct(), addNote(), confirmDelete(), deleteNotes(), getCommentsWidget(), getNoteListHTML(), getNotesHTML(), getPDNoteHTML(), initJavascript(), initNoteForm(), and updateNote().
|
protected |
Definition at line 72 of file class.ilNoteGUI.php.
|
protected |
Definition at line 95 of file class.ilNoteGUI.php.
|
protected |
Definition at line 43 of file class.ilNoteGUI.php.
Referenced by getSubObjectTitle(), and renderTargets().
|
protected |
Definition at line 62 of file class.ilNoteGUI.php.
ilNoteGUI::$old = false |
Definition at line 57 of file class.ilNoteGUI.php.
|
protected |
Definition at line 84 of file class.ilNoteGUI.php.
ilNoteGUI::$public_deletion_enabled = false |
Definition at line 55 of file class.ilNoteGUI.php.
Referenced by checkDeletion().
ilNoteGUI::$repository_mode = false |
Definition at line 56 of file class.ilNoteGUI.php.
|
protected |
Definition at line 38 of file class.ilNoteGUI.php.
Referenced by checkDeletion(), and getNotesHTML().
|
protected |
Definition at line 48 of file class.ilNoteGUI.php.
Referenced by renderTargets().
|
protected |
Definition at line 67 of file class.ilNoteGUI.php.
|
protected |
Definition at line 33 of file class.ilNoteGUI.php.
Referenced by addNote(), addNoteForm(), checkDeletion(), checkEdit(), confirmDelete(), getNoteListHTML(), getNotesHTML(), getPDNoteHTML(), hideNotes(), renderTargets(), showAllPublicNotes(), showMyPublicNotes(), showNotes(), and updateNote().
|
protected |
Definition at line 89 of file class.ilNoteGUI.php.