ILIAS
release_4-4 Revision
|
Class ilObjAdvancedEditing. More...
Public Member Functions | |
ilObjAdvancedEditing ($a_id=0, $a_call_by_reference=true) | |
Constructor public. More... | |
update () | |
update object data More... | |
delete () | |
delete object and all related data More... | |
initDefaultRoles () | |
init default roles settings More... | |
notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0) | |
notifys an object about an event occured Based on the event happend, each object may decide how it reacts. More... | |
& | _getUsedHTMLTags ($a_module="") |
Returns an array of all allowed HTML tags for text editing. More... | |
& | _getUsedHTMLTagsAsString ($a_module="") |
Returns a string of all allowed HTML tags for text editing. More... | |
_getRichTextEditor () | |
Returns the identifier for the Rich Text Editor. More... | |
_setRichTextEditor ($a_js_editor) | |
Sets wheather a Rich Text Editor should be used or not. More... | |
_setUsedHTMLTags ($a_html_tags, $a_module) | |
Writes an array with allowed HTML tags to the ILIAS settings. More... | |
& | getHTMLTags () |
Returns an array of all possible HTML tags for text editing. More... | |
& | _getAllHTMLTags () |
Returns an array of all possible HTML tags for text editing. More... | |
_getAllHTMLTagsAsString () | |
Returns a string of all HTML tags. More... | |
![]() | |
ilObject ($a_id=0, $a_reference=true) | |
Constructor public. More... | |
withReferences () | |
determines wehter objects are referenced or not (got ref ids or not) More... | |
read ($a_force_db=false) | |
read object data from db into object More... | |
getId () | |
get object id public More... | |
setId ($a_id) | |
set object id public More... | |
setRefId ($a_id) | |
set reference id public More... | |
getRefId () | |
get reference id public More... | |
getType () | |
get object type public More... | |
setType ($a_type) | |
set object type public More... | |
getPresentationTitle () | |
get presentation title Normally same as title Overwritten for sessions More... | |
getTitle () | |
get object title public More... | |
getUntranslatedTitle () | |
get untranslated object title public More... | |
setTitle ($a_title) | |
set object title More... | |
getDescription () | |
get object description More... | |
setDescription ($a_desc) | |
set object description More... | |
getLongDescription () | |
get object long description (stored in object_description) More... | |
getImportId () | |
get import id More... | |
setImportId ($a_import_id) | |
set import id More... | |
getOwner () | |
get object owner More... | |
getOwnerName () | |
_lookupOwnerName ($a_owner_id) | |
lookup owner name for owner id More... | |
setOwner ($a_owner) | |
set object owner More... | |
getCreateDate () | |
get create date public More... | |
getLastUpdateDate () | |
get last update date public More... | |
getDiskUsage () | |
Gets the disk usage of the object in bytes. More... | |
setObjDataRecord ($a_record) | |
set object_data record (note: this method should only be called from the ilObjectFactory class) More... | |
create () | |
create More... | |
update () | |
update object in db More... | |
MDUpdateListener ($a_element) | |
Meta data update listener. More... | |
createMetaData () | |
create meta data entry More... | |
updateMetaData () | |
update meta data entry More... | |
deleteMetaData () | |
delete meta data entry More... | |
updateOwner () | |
update owner of object in db More... | |
_getIdForImportId ($a_import_id) | |
get current object id for import id (static) More... | |
_lookupOwner ($a_id) | |
lookup object owner More... | |
_lookupLastUpdate ($a_id, $a_as_string=false) | |
lookup last update More... | |
_getLastUpdateOfObjects ($a_objs) | |
Get last update for a set of media objects. More... | |
_setDeletedDate ($a_ref_id) | |
only called in ilTree::saveSubTree More... | |
_resetDeletedDate ($a_ref_id) | |
only called in ilObjectGUI::insertSavedNodes More... | |
_lookupDeletedDate ($a_ref_id) | |
only called in ilObjectGUI::insertSavedNodes More... | |
_writeTitle ($a_obj_id, $a_title) | |
write title to db (static) More... | |
_writeDescription ($a_obj_id, $a_desc) | |
write description to db (static) More... | |
_writeImportId ($a_obj_id, $a_import_id) | |
write import id to db (static) More... | |
_isInTrash ($a_ref_id) | |
checks wether object is in trash More... | |
_hasUntrashedReference ($a_obj_id) | |
checks wether an object has at least one reference that is not in trash More... | |
_getObjectsDataForType ($a_type, $a_omit_trash=false) | |
get all objects of a certain type More... | |
putInTree ($a_parent_ref) | |
maybe this method should be in tree object!? More... | |
setPermissions ($a_parent_ref) | |
set permissions of object More... | |
createReference () | |
creates reference for object More... | |
countReferences () | |
count references of object More... | |
delete () | |
delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More... | |
initDefaultRoles () | |
init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) public More... | |
createRoleFolder () | |
creates a local role folder More... | |
applyDidacticTemplate ($a_tpl_id) | |
Apply template. More... | |
notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0) | |
notifys an object about an event occured Based on the event passed, each object may decide how it reacts. More... | |
setRegisterMode ($a_bool) | |
isUserRegistered ($a_user_id=0) | |
requireRegistration () | |
getXMLZip () | |
getHTMLDirectory () | |
cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false) | |
Clone object permissions, put in tree ... More... | |
appendCopyInfo ($a_target_id, $a_copy_id) | |
Prepend Copy info if object with same name exists in that container. More... | |
cloneDependencies ($a_target_id, $a_copy_id) | |
Clone object dependencies. More... | |
cloneMetaData ($target_obj) | |
Copy meta data. More... | |
_lookupCreationDate ($a_id) | |
Lookup creation date. More... | |
Static Public Member Functions | |
static | _setRichTextEditorUserState ($a_state) |
Sets the state of the rich text editor visibility for the current user. More... | |
static | _getRichTextEditorUserState () |
Gets the state of the rich text editor visibility for the current user. More... | |
![]() | |
static | _lookupObjIdByImportId ($a_import_id) |
static | _getAllReferences ($a_id) |
get all reference ids of object More... | |
static | _lookupTitle ($a_id) |
lookup object title More... | |
static | _getIdsForTitle ($title, $type='', $partialmatch=false) |
static | _lookupDescription ($a_id) |
lookup object description More... | |
static | _lookupObjId ($a_id) |
static | setDeletedDates ($a_ref_ids) |
Set deleted date type $ilDB. More... | |
static | _lookupType ($a_id, $a_reference=false) |
lookup object type More... | |
static | _lookupObjectId ($a_ref_id) |
lookup object id More... | |
static | _exists ($a_id, $a_reference=false, $a_type=null) |
checks if an object exists in object_data More... | |
static | _getObjectsByType ($a_obj_type="", $a_owner="") |
Get objects by type. More... | |
static | _prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true) |
Prepare copy wizard object selection. More... | |
static | _getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false) |
Get icon for repository item. More... | |
static | collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0) |
Collect deletion dependencies. More... | |
static | getDeletionDependencies ($a_obj_id) |
Get deletion dependencies. More... | |
static | getLongDescriptions (array $a_obj_ids) |
Get long description data. More... | |
static | getAllOwnedRepositoryObjects ($a_user_id) |
Get all ids of objects user owns. More... | |
static | hasAutoRating ($a_type, $a_ref_id) |
Check if auto rating is active for parent group/course. More... | |
Data Fields | |
$setting | |
![]() | |
const | TITLE_LENGTH = 255 |
max length of object title More... | |
const | DESC_LENGTH = 128 |
$ilias | |
$lng | |
$id | |
$ref_id | |
$type | |
$title | |
$untranslatedTitle | |
$desc | |
$long_desc | |
$owner | |
$create_date | |
$last_update | |
$import_id | |
$register = false | |
$referenced | |
$objectList | |
$max_title | |
$max_desc | |
$add_dots | |
$obj_data_record | |
object_data record More... | |
Class ilObjAdvancedEditing.
Definition at line 34 of file class.ilObjAdvancedEditing.php.
& ilObjAdvancedEditing::_getAllHTMLTags | ( | ) |
Returns an array of all possible HTML tags for text editing.
Returns an array of all possible HTML tags for text editing
Definition at line 433 of file class.ilObjAdvancedEditing.php.
Referenced by _getAllHTMLTagsAsString().
ilObjAdvancedEditing::_getAllHTMLTagsAsString | ( | ) |
Returns a string of all HTML tags.
Returns a string of all HTML tags
Definition at line 532 of file class.ilObjAdvancedEditing.php.
References $result, and _getAllHTMLTags().
ilObjAdvancedEditing::_getRichTextEditor | ( | ) |
Returns the identifier for the Rich Text Editor.
Returns the identifier for the Rich Text Editor
Definition at line 301 of file class.ilObjAdvancedEditing.php.
Referenced by ilRTE\_getRTEClassname(), and ilTinyMCE\addRTESupport().
|
static |
Gets the state of the rich text editor visibility for the current user.
Gets the state of the rich text editor visibility for the current user
Definition at line 564 of file class.ilObjAdvancedEditing.php.
References $ilUser.
Referenced by ilTinyMCE\addRTESupport(), and ilObjForumGUI\cancelPostObject().
& ilObjAdvancedEditing::_getUsedHTMLTags | ( | $a_module = "" | ) |
Returns an array of all allowed HTML tags for text editing.
Returns an array of all allowed HTML tags for text editing
string | $a_module | Name of the module or object which uses the tags |
Definition at line 190 of file class.ilObjAdvancedEditing.php.
Referenced by _getUsedHTMLTagsAsString(), assClozeTestGUI\addBasicQuestionFormProperties(), assQuestionGUI\addBasicQuestionFormProperties(), ilTinyMCE\addRTESupport(), ilAssQuestionFeedback\buildFeedbackContentFormProperty(), ilAssQuestionHintGUI\buildForm(), ilAssHtmlUserSolutionPurifier\getElementsUsedForAdvancedEditing(), ilHtmlForumPostPurifier\getPurifierConfigInstance(), SurveyQuestionGUI\initEditForm(), ilSurveyEditorGUI\initHeadingForm(), ilObjSurveyGUI\initPropertiesForm(), ilSurveyPageGUI\renderPage(), and ilObjExerciseGUI\updateAssignmentTextObject().
& ilObjAdvancedEditing::_getUsedHTMLTagsAsString | ( | $a_module = "" | ) |
Returns a string of all allowed HTML tags for text editing.
Returns a string of all allowed HTML tags for text editing
string | $a_module | Name of the module or object which uses the tags |
Definition at line 283 of file class.ilObjAdvancedEditing.php.
References $result, and _getUsedHTMLTags().
Referenced by ilEssayKeywordWizardInputGUI\checkInput(), ilMultipleChoiceWizardInputGUI\checkInput(), ilMatchingWizardInputGUI\checkInput(), ilSingleChoiceWizardInputGUI\checkInput(), ilObjSurvey\cloneTextblocks(), ilHtmlBlockGUIGen\getValuesHtmlBlock(), ilObjTestSettingsGeneralGUI\performSaveForm(), ilSurveyEditorGUI\saveHeadingObject(), ilHtmlBlockGUIGen\saveHtmlBlock(), ilTestScoringGUI\saveManScoringParticipantScreen(), ilContainerGUI\savePageContentObject(), and ilHtmlBlockGUIGen\updateHtmlBlock().
ilObjAdvancedEditing::_setRichTextEditor | ( | $a_js_editor | ) |
Sets wheather a Rich Text Editor should be used or not.
Sets wheather a Rich Text Editor should be used or not
boolean | $a_js_editor | A boolean indicating if the JS editor should be used or not |
Definition at line 316 of file class.ilObjAdvancedEditing.php.
|
static |
Sets the state of the rich text editor visibility for the current user.
Sets the state of the rich text editor visibility for the current user
integer | $a_state | 0 if the RTE should be disabled, 1 otherwise |
Definition at line 550 of file class.ilObjAdvancedEditing.php.
References $ilUser.
Referenced by ilTinyMCE\addRTESupport(), and ilObjForumGUI\cancelPostObject().
ilObjAdvancedEditing::_setUsedHTMLTags | ( | $a_html_tags, | |
$a_module | |||
) |
Writes an array with allowed HTML tags to the ILIAS settings.
Writes an array with allowed HTML tags to the ILIAS settings
array | $a_html_tags | An array containing the allowed HTML tags |
string | $a_module | The name of the module or object which uses the tags |
ilAdvancedEditingRequiredTagsException |
Definition at line 333 of file class.ilObjAdvancedEditing.php.
References ilObject\$lng.
ilObjAdvancedEditing::delete | ( | ) |
delete object and all related data
public
Definition at line 77 of file class.ilObjAdvancedEditing.php.
& ilObjAdvancedEditing::getHTMLTags | ( | ) |
Returns an array of all possible HTML tags for text editing.
Returns an array of all possible HTML tags for text editing
Definition at line 379 of file class.ilObjAdvancedEditing.php.
ilObjAdvancedEditing::ilObjAdvancedEditing | ( | $a_id = 0 , |
|
$a_call_by_reference = true |
|||
) |
Constructor public.
integer | reference_id or object_id |
boolean | treat the id as reference_id (true) or object_id (false) |
Definition at line 44 of file class.ilObjAdvancedEditing.php.
References ilObject\ilObject().
ilObjAdvancedEditing::initDefaultRoles | ( | ) |
init default roles settings
If your module does not require any default roles, delete this method (For an example how this method is used, look at ilObjForum)
public
Definition at line 99 of file class.ilObjAdvancedEditing.php.
ilObjAdvancedEditing::notify | ( | $a_event, | |
$a_ref_id, | |||
$a_parent_non_rbac_id, | |||
$a_node_id, | |||
$a_params = 0 |
|||
) |
notifys an object about an event occured Based on the event happend, each object may decide how it reacts.
If you are not required to handle any events related to your module, just delete this method. (For an example how this method is used, look at ilObjGroup)
public
string | event |
integer | reference id of object where the event occured |
array | passes optional parameters if required |
Definition at line 129 of file class.ilObjAdvancedEditing.php.
References $_GET, and ilObject\getType().
ilObjAdvancedEditing::update | ( | ) |
update object data
public
Definition at line 58 of file class.ilObjAdvancedEditing.php.
ilObjAdvancedEditing::$setting |
Definition at line 36 of file class.ilObjAdvancedEditing.php.