Inheritance diagram for ilObjAdvancedEditing:

Collaboration diagram for ilObjAdvancedEditing:

Public Member Functions
	__construct ($a_id=0, $a_call_by_reference=true)
	Constructor public. More...

	update ()
	update object data More...

	delete ()
	delete object and all related data 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...

Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor public. More...

	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not) More...

	read ()
	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...

	setOfflineStatus ($a_status)
	Set offline status. More...

	getOfflineStatus ()
	Get offline status. More...

	supportsOfflineHandling ()
	Check whether object supports offline handling. More...

	getOwner ()
	get object owner More...

	getOwnerName ()

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

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

	putInTree ($a_parent_ref)
	maybe this method should be in tree object!? More...

	setPermissions ($a_parent_ref)
	set permissions of object More...

	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...

	createReference ()
	creates reference for object More...

	countReferences ()
	count references of object 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...

	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	getXMLZip ()

	getHTMLDirectory ()

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

	getPossibleSubObjects ($a_filter=true)
	get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	_getUsedHTMLTags ($a_module="")
	Returns an array of all allowed HTML tags for text editing. More...

static	_getUsedHTMLTagsAsString ($a_module="")
	Returns a string of all allowed HTML tags for text editing. More...

static	_getRichTextEditor ()
	Returns the identifier for the Rich Text Editor. More...

static	_getAllHTMLTags ()
	Returns an array of all possible HTML tags for text editing. More...

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 Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupImportId ($a_obj_id)

static	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...

static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

static	_getAllReferences ($a_id)
	get all reference ids of object More...

static	_lookupTitle ($a_id)
	lookup object title More...

static	lookupOfflineStatus ($a_obj_id)
	Lookup offline status using objectDataCache. More...

static	_lookupOwner ($a_id)
	lookup object owner More...

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)
	lookup object description More...

static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...

static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree More...

static	setDeletedDates ($a_ref_ids)
	Set deleted date. More...

static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...

static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...

static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...

static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...

static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...

static	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...

static	_lookupObjectId ($a_ref_id)
	lookup object id More...

static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type 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	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	fixMissingTitles ($a_type, array &$a_obj_title_map)
	Try to fix missing object titles. More...

static	_lookupCreationDate ($a_id)
	Lookup creation date. More...

static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

Data Fields
	$setting

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...

const	DESC_LENGTH = 128

	$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

Additional Inherited Members
Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

Detailed Description

Class ilObjAdvancedEditing.

Author: Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilObjAdvancedEditing::__construct	(	$a_id = `0`,
		$a_call_by_reference = `true`
	)

Constructor public.

Parameters

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

     {
         global $DIC;
 
         $this->lng = $DIC->language();
         include_once "./Services/Administration/classes/class.ilSetting.php";
         $this->setting = new ilSetting("advanced_editing");
         $this->type = "adve";
         parent::__construct($a_id, $a_call_by_reference);
     }

Member Function Documentation

◆ _getAllHTMLTags()

static ilObjAdvancedEditing::_getAllHTMLTags ( )

static

Returns an array of all possible HTML tags for text editing.

Returns an array of all possible HTML tags for text editing

Returns: array HTML tags

Definition at line 327 of file class.ilObjAdvancedEditing.php.

References $tags.

     {
         $tags = array(
             "a",
             "abbr",
             "acronym",
             "address",
             "applet",
             "area",
             "b",
             "base",
             "basefont",
             "bdo",
             "big",
             "blockquote",
             "br",
             "button",
             "caption",
             "center",
             "cite",
             "code",
             "col",
             "colgroup",
             "dd",
             "del",
             "dfn",
             "dir",
             "div",
             "dl",
             "dt",
             "em",
             "fieldset",
             "font",
             "form",
             "h1",
             "h2",
             "h3",
             "h4",
             "h5",
             "h6",
             "hr",
             "i",
             "iframe",
             "img",
             "input",
             "ins",
             "isindex",
             "kbd",
             "label",
             "legend",
             "li",
             "link",
             "map",
             "menu",
             "object",
             "ol",
             "optgroup",
             "option",
             "p",
             "param",
             "pre",
             "q",
             "s",
             "samp",
             "select",
             "small",
             "span",
             "strike",
             "strong",
             "sub",
             "sup",
             "table",
             "tbody",
             "td",
             "textarea",
             "tfoot",
             "th",
             "thead",
             "tr",
             "tt",
             "u",
             "ul",
             "var",
             "ruby", // Ruby Annotation XHTML module
             "rbc",
             "rtc",
             "rb",
             "rt",
             "rp"
         );
         return $tags;
     }

◆ _getRichTextEditor()

static ilObjAdvancedEditing::_getRichTextEditor ( )

static

Returns the identifier for the Rich Text Editor.

Returns the identifier for the Rich Text Editor

Returns: string Identifier for the Rich Text Editor

Definition at line 200 of file class.ilObjAdvancedEditing.php.

References $js, and $setting.

Referenced by ilRTE\_getRTEClassname(), ilTinyMCE\addRTESupport(), and ilNewsItemGUI\isRteActivated().

     {
         include_once "./Services/Administration/classes/class.ilSetting.php";
         $setting = new ilSetting("advanced_editing");
         $js = $setting->get("advanced_editing_javascript_editor");
         return $js;
     }

Here is the caller graph for this function:

◆ _getRichTextEditorUserState()

static ilObjAdvancedEditing::_getRichTextEditorUserState ( )

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

Returns: integer 0 if the RTE should be disabled, 1 otherwise

Definition at line 443 of file class.ilObjAdvancedEditing.php.

References $DIC, and $ilUser.

Referenced by ilTinyMCE\addRTESupport(), and ilObjForumGUI\getCensorshipFormHTML().

     {
         global $DIC;
 
         $ilUser = $DIC->user();
         if (strlen($ilUser->getPref("show_rte")) > 0) {
             return $ilUser->getPref("show_rte");
         }
         return 1;
     }

Here is the caller graph for this function:

◆ _getUsedHTMLTags()

static ilObjAdvancedEditing::_getUsedHTMLTags ( $a_module = "" )

static

Returns an array of all allowed HTML tags for text editing.

Returns an array of all allowed HTML tags for text editing

Parameters

string $a_module Name of the module or object which uses the tags

Returns: array HTML tags

Definition at line 99 of file class.ilObjAdvancedEditing.php.

References $setting, and $tags.

Referenced by ilTermsOfServiceDocumentHtmlPurifier\__construct(), _getUsedHTMLTagsAsString(), assClozeTestGUI\addBasicQuestionFormProperties(), assQuestionGUI\addBasicQuestionFormProperties(), ilTinyMCE\addRTESupport(), ilAssQuestionFeedback\buildFeedbackContentFormProperty(), ilAssQuestionHintGUI\buildForm(), ilAssHtmlPurifier\getElementsUsedForAdvancedEditing(), ilHtmlForumPostPurifier\getPurifierConfigInstance(), SurveyQuestionGUI\initEditForm(), ilSurveyEditorGUI\initHeadingForm(), ilObjSurveyGUI\initPropertiesForm(), ilObjAdvancedEditingGUI\initTagsForm(), assLongMenuGUI\populateQuestionSpecificFormPart(), assClozeTestGUI\populateQuestionSpecificFormPart(), ilSurveyPageGUI\renderPage(), and ilExSubmissionTextGUI\updateAssignmentTextObject().

     {
         $usedtags = array();
         include_once "./Services/Administration/classes/class.ilSetting.php";
         $setting = new ilSetting("advanced_editing");
         $tags = $setting->get("advanced_editing_used_html_tags_" . $a_module);
         if (strlen($tags)) {
             $usedtags = unserialize($tags);
         } else {
             if ($a_module == 'frm_post' || $a_module == 'exc_ass') {
                 $usedtags = array(
                 "a",
                 "blockquote",
                 "br",
                 "code",
                 "div",
                 "em",
                 "img",
                 "li",
                 "ol",
                 "p",
                 "strong",
                 "u",
                 "ul",
                 "span"
                 );
             } else {
                 // default: everything but tables
                 $usedtags = array(
                 "a",
                 "blockquote",
                 "br",
                 "cite",
                 "code",
                 "dd",
                 "div",
                 "dl",
                 "dt",
                 "em",
                 "h1",
                 "h2",
                 "h3",
                 "h4",
                 "h5",
                 "h6",
                 "hr",
                 "img",
                 "li",
                 "ol",
                 "p",
                 "pre",
                 "span",
                 "strike",
                 "strong",
                 "sub",
                 "sup",
                 "u",
                 "ul"
                 );
             }
         }
         
         // frm_posts need blockquote and div urgently
         if ($a_module === 'frm_post') {
             if (!in_array('div', $usedtags)) {
                 $usedtags[] = 'div';
             }
             
             if (!in_array('blockquote', $usedtags)) {
                 $usedtags[] = 'blockquote';
             }
         }
         
         return $usedtags;
     }

Here is the caller graph for this function:

◆ _getUsedHTMLTagsAsString()

static ilObjAdvancedEditing::_getUsedHTMLTagsAsString ( $a_module = "" )

static

Returns a string of all allowed HTML tags for text editing.

Returns a string of all allowed HTML tags for text editing

Parameters

string $a_module Name of the module or object which uses the tags

Returns: string Used HTML tags

Definition at line 183 of file class.ilObjAdvancedEditing.php.

References $result, $tag, $tags, and _getUsedHTMLTags().

     {
         $result = "";
         $tags = ilObjAdvancedEditing::_getUsedHTMLTags($a_module);
         foreach ($tags as $tag) {
             $result .= "<$tag>";
         }
         return $result;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _setRichTextEditorUserState()

static ilObjAdvancedEditing::_setRichTextEditorUserState ( $a_state )

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

Parameters

integer $a_state 0 if the RTE should be disabled, 1 otherwise

Definition at line 427 of file class.ilObjAdvancedEditing.php.

References $DIC, and $ilUser.

Referenced by ilTinyMCE\addRTESupport(), and ilObjForumGUI\getCensorshipFormHTML().

     {
         global $DIC;
 
         $ilUser = $DIC->user();
         $ilUser->writePref("show_rte", $a_state);
     }

Here is the caller graph for this function:

◆ delete()

ilObjAdvancedEditing::delete ( )

delete object and all related data

public

Returns: boolean true if all object data were removed; false if only a references were removed

Definition at line 79 of file class.ilObjAdvancedEditing.php.

     {
         // always call parent delete function first!!
         if (!parent::delete()) {
             return false;
         }
 
         //put here your module specific stuff
 
         return true;
     }

◆ getHTMLTags()

& ilObjAdvancedEditing::getHTMLTags ( )

Returns an array of all possible HTML tags for text editing.

Returns an array of all possible HTML tags for text editing

Returns: array HTML tags

Definition at line 273 of file class.ilObjAdvancedEditing.php.

References $tags.

     {
         $tags = array(
             "a",
             "blockquote",
             "br",
             "cite",
             "code",
             "dd",
             "div",
             "dl",
             "dt",
             "em",
             "h1",
             "h2",
             "h3",
             "h4",
             "h5",
             "h6",
             "hr",
             "img",
             "li",
             "object",
             "ol",
             "p",
             "param",
             "pre",
             "span",
             "strike",
             "strong",
             "sub",
             "sup",
             "table",
             "td",
             "tr",
             "u",
             "ul",
             "ruby", // Ruby Annotation XHTML module
             "rbc",
             "rtc",
             "rb",
             "rt",
             "rp"
         );
         return $tags;
     }

◆ setRichTextEditor()

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

Parameters

boolean $a_js_editor A boolean indicating if the JS editor should be used or not

Definition at line 215 of file class.ilObjAdvancedEditing.php.

References $setting.

     {
         include_once "./Services/Administration/classes/class.ilSetting.php";
         $setting = new ilSetting("advanced_editing");
         $setting->set("advanced_editing_javascript_editor", $a_js_editor);
     }

◆ setUsedHTMLTags()

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

Parameters

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

Exceptions

ilAdvancedEditingRequiredTagsException

Definition at line 232 of file class.ilObjAdvancedEditing.php.

References ilObject\$lng, and $setting.

     {
         $lng = $this->lng;
         
         if (strlen($a_module)) {
             $auto_added_tags = array();
             
             // frm_posts need blockquote and div urgently
             if ($a_module == 'frm_post') {
                 if (!in_array('div', $a_html_tags)) {
                     $auto_added_tags[] = 'div';
                 }
                 
                 if (!in_array('blockquote', $a_html_tags)) {
                     $auto_added_tags[] = 'blockquote';
                 }
             }
             
             include_once "./Services/Administration/classes/class.ilSetting.php";
             $setting = new ilSetting("advanced_editing");
             $setting->set("advanced_editing_used_html_tags_" . $a_module, serialize(array_merge((array) $a_html_tags, $auto_added_tags)));
             
             if (count($auto_added_tags)) {
                 require_once 'Services/AdvancedEditing/exceptions/class.ilAdvancedEditingRequiredTagsException.php';
                 throw new ilAdvancedEditingRequiredTagsException(
                     sprintf(
                         $lng->txt('advanced_editing_required_tags'),
                         implode(', ', $auto_added_tags)
                     )
                 );
             }
         }
     }

◆ update()

ilObjAdvancedEditing::update ( )

update object data

public

Returns: boolean

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

References League\Flysystem\Adapter\Polyfill\update().

     {
         if (!parent::update()) {
             return false;
         }
 
         // put here object specific stuff
 
         return true;
     }

Here is the call graph for this function:

Field Documentation

◆ $setting

ilObjAdvancedEditing::$setting

Definition at line 36 of file class.ilObjAdvancedEditing.php.

Referenced by _getRichTextEditor(), _getUsedHTMLTags(), setRichTextEditor(), and setUsedHTMLTags().

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

Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php

Public Member Functions

Static Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getAllHTMLTags()

◆ _getRichTextEditor()

◆ _getRichTextEditorUserState()

◆ _getUsedHTMLTags()

◆ _getUsedHTMLTagsAsString()

◆ _setRichTextEditorUserState()

◆ delete()

◆ getHTMLTags()

◆ setRichTextEditor()

◆ setUsedHTMLTags()

◆ update()

Field Documentation

◆ $setting