ILIAS
Release_4_0_x_branch Revision 61816
|
New implementation of ilObjectGUI. More...
Public Member Functions | |
__construct ($a_id=0, $a_call_by_reference=true) | |
Constructor. | |
& | executeCommand () |
execute command | |
performCommand ($cmd) | |
Handles all commmands of this class, centralizes permission checks. | |
withReferences () | |
Final/Private declaration of unchanged parent methods. | |
setCreationMode ($a_mode=true) | |
if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui | |
getCreationMode () | |
get creation mode | |
getHTML () | |
isVisible () | |
deleteObject () | |
trashObject () | |
Show trash content of object. | |
undeleteObject () | |
Get objects back from trash. | |
confirmedDeleteObject () | |
confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled | |
cancelDeleteObject () | |
cancel deletion of object | |
removeFromSystemObject () | |
remove objects from trash bin and all entries therefore every object needs a specific deleteObject() method | |
cloneAllObject () | |
Clone single (not container object) Method is overwritten in ilContainerGUI. | |
viewObject () | |
list childs of current object | |
getAdminTabs ($a) | |
getTemplateFile () | |
copyWizardHasOptions ($a_mode) | |
Check if there is any modules specific option. | |
getType () | |
Functions that must be overwritten. | |
create () | |
Deleted in ilObject. | |
save () | |
save object | |
initEditForm ($a_mode="edit", $a_new_type="") | |
Init object creation form. | |
getEditFormValues () | |
Get values for edit form. | |
cancelCreation ($in_rep=false) | |
cancel action and go back to previous page public | |
editObject () | |
edit object | |
cancelUpdate () | |
cancel action and go back to previous page public | |
updateObject () | |
updates object entry in object_data | |
afterUpdate () | |
Public Member Functions inherited from ilObjectGUI | |
ilObjectGUI ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=true) | |
Constructor public. | |
getAdminTabs (&$tabs_gui) | |
administration tabs show only permissions and trash folder | |
createObject () | |
create new object form | |
cancelObject ($in_rep=false) | |
cancel action and go back to previous page public | |
saveObject () | |
save object | |
getFormAction ($a_cmd, $a_formaction="") | |
get form action for command (command is method name without "Object", e.g. | |
isVisible ($a_ref_id, $a_type) | |
deleteObject ($a_error=false) | |
Display deletion confirmation screen. | |
getTemplateFile ($a_cmd, $a_type="") | |
get a template blockfile format: tpl. |
Protected Member Functions | |
afterConstructor () | |
Do anything that should be done after constructor in here. | |
assignObject () | |
prepareOutput () | |
prepare output | |
setTitleAndDescription () | |
called by prepare output | |
showUpperIcon () | |
setLocator () | |
set Locator | |
omitLocator ($a_omit=true) | |
getTargetFrame () | |
setTargetFrame ($a_cmd, $a_target_frame) | |
set specific target frame for command | |
getCenterColumnHTML () | |
Get center column. | |
getRightColumnHTML () | |
Display right column. | |
setColumnSettings ($column_gui) | |
May be overwritten in subclasses. | |
checkPermission ($a_perm, $a_cmd="") | |
showPossibleSubObjects () | |
show possible subobjects (pulldown menu) | |
redirectToRefId () | |
fillCloneTemplate ($a_tpl_varname, $a_type) | |
Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. | |
fillCloneSearchTemplate ($a_tpl_varname, $a_type) | |
Add an object search in case the number of existing objects is too big to offer a selection list. | |
searchCloneSourceObject () | |
Search clone source by title. | |
buildCloneSelect ($existing_objs) | |
Build a select box for clonable objects (permission write) | |
addAdminLocatorItems () | |
should be overwritten to add object specific items (repository items are preloaded) | |
getReturnLocation () | |
Deprecated functions. | |
setReturnLocation () | |
showActions () | |
getTitlesByRefId () | |
getTabs () | |
__showButton () | |
hitsperpageObject () | |
__initTableGUI () | |
__setTableGUIBasicData () | |
__showClipboardTable () | |
addLocatorItems () | |
Functions to be overwritten. | |
setTabs () | |
set admin tabs public | |
cancel () | |
cancel action and go back to previous page public | |
Protected Member Functions inherited from ilObjectGUI | |
setAdminTabs () | |
set admin tabs public | |
displayEditForm ($fields) | |
display edit form (usually called by editObject) | |
setFormAction ($a_cmd, $a_formaction) | |
set specific form action for command | |
getReturnLocation ($a_cmd, $a_location="") | |
get return location for command (command is method name without "Object", e.g. | |
setReturnLocation ($a_cmd, $a_location) | |
set specific return location for command | |
getTargetFrame ($a_cmd, $a_target_frame="") | |
get target frame for command (command is method name without "Object", e.g. | |
getTitlesByRefId ($a_ref_ids) | |
get Titles of objects this method is used for error messages in methods cut/copy/paste | |
getTabs (&$tabs_gui) | |
get tabs abstract method. | |
__showButton ($a_cmd, $a_text, $a_target= '') | |
__setTableGUIBasicData (&$tbl, &$result_set, $a_from="") | |
standard implementation for tables use 'from' variable use different initial setting of table | |
__showClipboardTable ($a_result_set, $a_from="") | |
redirectToRefId ($a_ref_id, $a_cmd="") | |
redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current $_GET["ref_id"] value |
Private Member Functions | |
displayList () |
Additional Inherited Members | |
Data Fields inherited from ilObjectGUI | |
const | COPY_WIZARD_NEEDS_PAGE = 1 |
$ilias | |
$objDefinition | |
$tpl | |
$tree | |
$lng | |
$data | |
$object | |
$ref_id | |
$obj_id | |
$maxcount | |
$formaction | |
$return_location | |
$target_frame | |
$tab_target_script | |
$actions | |
$sub_objects | |
$omit_locator = false |
New implementation of ilObjectGUI.
(alpha)
Differences to the ilObject implementation:
All new modules should derive from this class.
Definition at line 27 of file class.ilObject2GUI.php.
ilObject2GUI::__construct | ( | $a_id = 0 , |
|
$a_call_by_reference = true |
|||
) |
Constructor.
Definition at line 32 of file class.ilObject2GUI.php.
References $_GET, $ilCtrl, $ilErr, ilObjectGUI\$lng, ilObjectGUI\$objDefinition, $params, ilObjectGUI\$tpl, afterConstructor(), assignObject(), getType(), and PEAR_ERROR_CALLBACK.
|
finalprotected |
Reimplemented from ilObjectGUI.
Definition at line 194 of file class.ilObject2GUI.php.
|
finalprotected |
Definition at line 195 of file class.ilObject2GUI.php.
|
finalprotected |
Definition at line 192 of file class.ilObject2GUI.php.
|
finalprotected |
Definition at line 196 of file class.ilObject2GUI.php.
|
finalprotected |
should be overwritten to add object specific items (repository items are preloaded)
Reimplemented from ilObjectGUI.
Definition at line 178 of file class.ilObject2GUI.php.
Referenced by ilObjectPluginGUI\executeCommand().
|
protected |
Functions to be overwritten.
Reimplemented from ilObjectGUI.
Reimplemented in ilObjMediaPoolGUI, and ilObjectPluginGUI.
Definition at line 201 of file class.ilObject2GUI.php.
|
protected |
Do anything that should be done after constructor in here.
Reimplemented in ilObjMediaPoolGUI.
Definition at line 89 of file class.ilObject2GUI.php.
Referenced by __construct().
ilObject2GUI::afterUpdate | ( | ) |
Reimplemented from ilObjectGUI.
Reimplemented in ilObjMediaPoolGUI.
Definition at line 419 of file class.ilObject2GUI.php.
Referenced by updateObject().
|
finalprotected |
Reimplemented from ilObjectGUI.
Definition at line 138 of file class.ilObject2GUI.php.
Referenced by __construct().
|
finalprotected |
Build a select box for clonable objects (permission write)
protected
string | obj_type |
Reimplemented from ilObjectGUI.
Definition at line 171 of file class.ilObject2GUI.php.
|
protected |
cancel action and go back to previous page public
Reimplemented in ilObjMediaPoolGUI.
Definition at line 357 of file class.ilObject2GUI.php.
|
final |
cancel action and go back to previous page public
Definition at line 367 of file class.ilObject2GUI.php.
References $_GET, and ilUtil\redirect().
|
final |
cancel deletion of object
public
Reimplemented from ilObjectGUI.
Definition at line 162 of file class.ilObject2GUI.php.
|
final |
cancel action and go back to previous page public
Definition at line 391 of file class.ilObject2GUI.php.
|
finalprotected |
Reimplemented from ilObjectGUI.
Definition at line 152 of file class.ilObject2GUI.php.
Referenced by ilObjMediaPoolGUI\copyToClipboard(), ilObjectPluginGUI\executeCommand(), and ilObjectPluginGUI\infoScreen().
|
final |
Clone single (not container object) Method is overwritten in ilContainerGUI.
public
Reimplemented from ilObjectGUI.
Definition at line 170 of file class.ilObject2GUI.php.
Referenced by ilObjectPluginGUI\cloneAll().
|
final |
confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled
Reimplemented from ilObjectGUI.
Definition at line 161 of file class.ilObject2GUI.php.
ilObject2GUI::copyWizardHasOptions | ( | $a_mode | ) |
Check if there is any modules specific option.
public
int | wizard mode COPY_WIZARD_GENERAL,COPY_WIZARD_NEEDS_PAGE, COPY_WIZARD_OBJ_SPECIFIC |
Reimplemented from ilObjectGUI.
Definition at line 202 of file class.ilObject2GUI.php.
ilObject2GUI::create | ( | ) |
Deleted in ilObject.
create new object form
public
Definition at line 229 of file class.ilObject2GUI.php.
References $_GET, $_POST, ilObjectGUI\$tpl, fillCloneTemplate(), and initEditForm().
|
final |
Definition at line 157 of file class.ilObject2GUI.php.
|
finalprivate |
Definition at line 174 of file class.ilObject2GUI.php.
ilObject2GUI::editObject | ( | ) |
edit object
public
Reimplemented from ilObjectGUI.
Reimplemented in ilObjMediaPoolGUI.
Definition at line 377 of file class.ilObject2GUI.php.
References ilObjectGUI\$tpl, getEditFormValues(), and initEditForm().
& ilObject2GUI::executeCommand | ( | ) |
execute command
Reimplemented from ilObjectGUI.
Reimplemented in ilObjMediaPoolGUI, and ilObjectPluginGUI.
Definition at line 96 of file class.ilObject2GUI.php.
References $cmd, and performCommand().
|
finalprotected |
Add an object search in case the number of existing objects is too big to offer a selection list.
string | template variable name that will be filled |
string | type of new object public |
Reimplemented from ilObjectGUI.
Definition at line 168 of file class.ilObject2GUI.php.
|
finalprotected |
Fill object clone template This method can be called from any object GUI class that wants to offer object cloning.
public
string | template variable name that will be filled |
string | type of new object |
Reimplemented from ilObjectGUI.
Definition at line 167 of file class.ilObject2GUI.php.
Referenced by create().
|
final |
Definition at line 177 of file class.ilObject2GUI.php.
|
finalprotected |
Get center column.
Reimplemented from ilObjectGUI.
Definition at line 149 of file class.ilObject2GUI.php.
|
final |
get creation mode
Reimplemented from ilObjectGUI.
Definition at line 137 of file class.ilObject2GUI.php.
Referenced by ilObjectPluginGUI\addLocatorItems(), ilObjMediaPoolGUI\addLocatorItems(), ilObjectPluginGUI\executeCommand(), and ilObjMediaPoolGUI\executeCommand().
ilObject2GUI::getEditFormValues | ( | ) |
Get values for edit form.
Reimplemented in ilObjMediaPoolGUI.
Definition at line 345 of file class.ilObject2GUI.php.
Referenced by editObject().
|
final |
Reimplemented from ilObjectGUI.
Definition at line 143 of file class.ilObject2GUI.php.
|
finalprotected |
Deprecated functions.
Definition at line 186 of file class.ilObject2GUI.php.
|
finalprotected |
Display right column.
Reimplemented from ilObjectGUI.
Definition at line 150 of file class.ilObject2GUI.php.
|
finalprotected |
Definition at line 191 of file class.ilObject2GUI.php.
|
finalprotected |
Definition at line 146 of file class.ilObject2GUI.php.
|
final |
Definition at line 189 of file class.ilObject2GUI.php.
|
finalprotected |
Definition at line 190 of file class.ilObject2GUI.php.
|
abstract |
Functions that must be overwritten.
Reimplemented in ilObjMediaPoolGUI.
Referenced by ilObjectPluginGUI\__construct(), __construct(), and ilObjectPluginGUI\executeCommand().
|
finalprotected |
Reimplemented from ilObjectGUI.
Definition at line 193 of file class.ilObject2GUI.php.
ilObject2GUI::initEditForm | ( | $a_mode = "edit" , |
|
$a_new_type = "" |
|||
) |
Init object creation form.
int | $a_mode | Edit Mode |
Reimplemented in ilObjMediaPoolGUI, and ilObjectPluginGUI.
Definition at line 303 of file class.ilObject2GUI.php.
References $ilCtrl, ilObjectGUI\$lng, ilTextAreaInputGUI\setCols(), and ilTextInputGUI\setMaxLength().
Referenced by create(), editObject(), save(), and updateObject().
|
final |
Definition at line 148 of file class.ilObject2GUI.php.
|
finalprotected |
Reimplemented from ilObjectGUI.
Definition at line 145 of file class.ilObject2GUI.php.
ilObject2GUI::performCommand | ( | $cmd | ) |
Handles all commmands of this class, centralizes permission checks.
Definition at line 120 of file class.ilObject2GUI.php.
Referenced by ilObjectPluginGUI\executeCommand(), and executeCommand().
|
finalprotected |
prepare output
Reimplemented from ilObjectGUI.
Definition at line 139 of file class.ilObject2GUI.php.
Referenced by ilObjMediaPoolGUI\executeCommand().
|
finalprotected |
Definition at line 164 of file class.ilObject2GUI.php.
|
final |
remove objects from trash bin and all entries therefore every object needs a specific deleteObject() method
public
Reimplemented from ilObjectGUI.
Definition at line 163 of file class.ilObject2GUI.php.
ilObject2GUI::save | ( | ) |
save object
public
Definition at line 260 of file class.ilObject2GUI.php.
References $_GET, $_POST, ilObjectGUI\$lng, $location, ilObjectGUI\$objDefinition, ilObjectGUI\$tpl, initEditForm(), ilUtil\sendSuccess(), and ilUtil\stripSlashes().
|
finalprotected |
Search clone source by title.
protected
Reimplemented from ilObjectGUI.
Definition at line 169 of file class.ilObject2GUI.php.
|
finalprotected |
May be overwritten in subclasses.
Reimplemented from ilObjectGUI.
Definition at line 151 of file class.ilObject2GUI.php.
|
final |
if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui
Reimplemented from ilObjectGUI.
Definition at line 136 of file class.ilObject2GUI.php.
Referenced by ilObjMediaPoolGUI\executeCommand().
|
finalprotected |
set Locator
object | tree object |
integer | reference id |
scriptanme | that is used for linking; public |
Reimplemented from ilObjectGUI.
Definition at line 144 of file class.ilObject2GUI.php.
Referenced by ilObjectPluginGUI\executeCommand(), and ilObjMediaPoolGUI\executeCommand().
|
finalprotected |
Definition at line 187 of file class.ilObject2GUI.php.
|
protected |
set admin tabs public
Reimplemented from ilObjectGUI.
Reimplemented in ilObjMediaPoolGUI.
Definition at line 203 of file class.ilObject2GUI.php.
Referenced by ilObjectPluginGUI\executeCommand().
|
finalprotected |
set specific target frame for command
string | $a_cmd | command |
string | $a_target_frame | default target frame (is returned, if no special target frame was set) public |
Reimplemented from ilObjectGUI.
Definition at line 147 of file class.ilObject2GUI.php.
|
finalprotected |
called by prepare output
Reimplemented from ilObjectGUI.
Definition at line 140 of file class.ilObject2GUI.php.
|
finalprotected |
Definition at line 188 of file class.ilObject2GUI.php.
|
finalprotected |
show possible subobjects (pulldown menu)
public
Reimplemented from ilObjectGUI.
Definition at line 155 of file class.ilObject2GUI.php.
|
finalprotected |
Reimplemented from ilObjectGUI.
Definition at line 141 of file class.ilObject2GUI.php.
|
final |
Show trash content of object.
public
Reimplemented from ilObjectGUI.
Definition at line 158 of file class.ilObject2GUI.php.
|
final |
Get objects back from trash.
Reimplemented from ilObjectGUI.
Definition at line 160 of file class.ilObject2GUI.php.
ilObject2GUI::updateObject | ( | ) |
updates object entry in object_data
public
Reimplemented from ilObjectGUI.
Reimplemented in ilObjMediaPoolGUI.
Definition at line 401 of file class.ilObject2GUI.php.
References $_POST, ilObjectGUI\$lng, ilObjectGUI\$tpl, afterUpdate(), initEditForm(), and ilUtil\sendSuccess().
|
final |
list childs of current object
public
Reimplemented from ilObjectGUI.
Definition at line 175 of file class.ilObject2GUI.php.
Referenced by ilObjectPluginGUI\executeCommand(), and ilObjMediaPoolGUI\view().
|
final |
Final/Private declaration of unchanged parent methods.
Reimplemented from ilObjectGUI.
Definition at line 135 of file class.ilObject2GUI.php.