This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilObjAdvancedEditing:

Collaboration diagram for ilObjAdvancedEditing:

Public Member Functions
	__construct (int $a_id=0, bool $a_call_by_reference=true)

	setRichTextEditor (string $a_js_editor)

	setUsedHTMLTags (array $a_html_tags, string $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
	getObjectProperties ()

	flushObjectProperties ()

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

	processAutoRating ()

	read ()

	getId ()

	setId (int $id)

	setRefId (int $ref_id)

	getRefId ()

	getType ()

	setType (string $type)

	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...

	getTitle ()

	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...

	setTitle (string $title)

	getDescription ()

	setDescription (string $description)

	getLongDescription ()
	get object long description (stored in object_description) More...

	getImportId ()

	setImportId (string $import_id)

	setOfflineStatus (bool $status)

	getOfflineStatus ()

	supportsOfflineHandling ()

	getOwner ()

	getOwnerName ()
	get full name of object owner More...

	setOwner (int $usr_id)

	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...

	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...

	create ()
	note: title, description and type should be set when this function is called More...

	update ()

	MDUpdateListener (string $element)
	Metadata update listener. More...

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

	updateOwner ()
	update owner of object in db More...

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

	setPermissions (int $parent_ref_id)

	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...

	createReference ()
	creates reference for object More...

	countReferences ()

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

	applyDidacticTemplate (int $tpl_id)

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo (int $target_id, int $copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...

	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...

	selfOrParentWithRatingEnabled ()

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

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

static	_getUsedHTMLTagsAsString (string $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 (int $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 (string $import_id)
	Get (latest) object id for an import id. More...

static	_lookupImportId (int $obj_id)

static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...

static	_getIdForImportId (string $import_id)

static	_getAllReferences (int $id)
	get all reference ids for object ID More...

static	_lookupTitle (int $obj_id)

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

static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...

static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)

static	_lookupDescription (int $obj_id)

static	_lookupLastUpdate (int $obj_id, bool $formatted=false)

static	_getLastUpdateOfObjects (array $obj_ids)

static	_lookupObjId (int $ref_id)

static	_setDeletedDate (int $ref_id, int $deleted_by)

static	setDeletedDates (array $ref_ids, int $user_id)

static	_resetDeletedDate (int $ref_id)

static	_lookupDeletedDate (int $ref_id)

static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...

static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...

static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...

static	_lookupType (int $id, bool $reference=false)

static	_isInTrash (int $ref_id)

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

static	_lookupObjectId (int $ref_id)

static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...

static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType (string $obj_type="", ?int $owner=null)

static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...

static	getIconForType (string $type)

static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $obj_ids)

static	getAllOwnedRepositoryObjects (int $user_id)

static	fixMissingTitles ($type, array &$obj_title_map)
	Try to fix missing object titles. More...

static	_lookupCreationDate (int $obj_id)

static	_getObjectTypeIdByTitle (string $type, ?\ilDBInterface $ilDB=null)

Data Fields
ilSetting	$setting

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255

const	DESC_LENGTH = 128

const	LONG_DESC_LENGTH = 4000

const	TABLE_OBJECT_DATA = "object_data"

array	$objectList

string	$untranslatedTitle

Additional Inherited Members
Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)

	beforeMDUpdateListener (string $a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDeleteMetaData ()

	beforeDeleteMetaData ()

	handleAutoRating ()

	hasAutoRating ()

Protected Attributes inherited from ilObject
ilLogger	$obj_log

ILIAS	$ilias

ilObjectDefinition	$obj_definition

ilDBInterface	$db

ilLogger	$log

ilErrorHandling	$error

ilTree	$tree

ilAppEventHandler	$app_event_handler

ilRbacAdmin	$rbac_admin

ilRbacReview	$rbac_review

ilObjUser	$user

ilLanguage	$lng

LOMServices	$lom_services

bool	$call_by_reference

int	$max_title = self::TITLE_LENGTH

int	$max_desc = self::DESC_LENGTH

bool	$add_dots = true

int	$ref_id = null

string	$type = ""

string	$title = ""

string	$desc = ""

string	$long_desc = ""

int	$owner = 0

string	$create_date = ""

string	$last_update = ""

string	$import_id = ""

bool	$register = false

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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

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

Constructor & Destructor Documentation

◆ __construct()

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

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\lng().

       {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->setting = new ilSetting("advanced_editing");
         $this->type = "adve";
         parent::__construct($a_id, $a_call_by_reference);
     }

Here is the call graph for this function:

Member Function Documentation

◆ _getAllHTMLTags()

static ilObjAdvancedEditing::_getAllHTMLTags ( )

static

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

Returns: array HTML tags

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

                                             : array
     {
         return 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"
         );
     }

◆ _getRichTextEditor()

static ilObjAdvancedEditing::_getRichTextEditor ( )

static

Returns the identifier for the Rich Text Editor.

Returns: string Identifier for the Rich Text Editor

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

Referenced by ilRTE\_getRTEClassname(), ilTinyMCE\addRTESupport(), assTextQuestion\getSolutionSubmit(), ilObjAdvancedEditingGUI\getTinyForm(), ilExAssignmentEditorGUI\initAssignmentForm(), ilExSubmissionTextGUI\initAssignmentTextForm(), SurveyQuestionGUI\initEditForm(), ILIAS\Test\Scoring\Manual\TestScoringByQuestionGUI\initJavascript(), ILIAS\Survey\Settings\SettingsFormGUI\withAfterEnd(), and ILIAS\Survey\Settings\SettingsFormGUI\withBeforeStart().

                                                : string
     {
         return (new ilSetting("advanced_editing"))->get("advanced_editing_javascript_editor", "0");
     }

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.

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

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

References $DIC.

Referenced by ilTinyMCE\addRTESupport().

                                                         : int
     {
         global $DIC;
 
         $ilUser = $DIC->user();
         if ($ilUser->getPref("show_rte") != '') {
             return (int) $ilUser->getPref("show_rte");
         }
         return 1;
     }

Here is the caller graph for this function:

◆ _getUsedHTMLTags()

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

static

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 45 of file class.ilObjAdvancedEditing.php.

References ilSetting\get().

Referenced by ilWebDAVMountInstructionsDocumentPurifier\__construct(), ilAccessibilityDocumentHtmlPurifier\__construct(), ILIAS\LegalDocuments\HTMLPurifier\__construct(), assQuestionGUI\addBasicQuestionFormProperties(), ilTinyMCE\addRTESupport(), ilAssQuestionFeedback\buildFeedbackContentFormProperty(), ilAssQuestionHintGUI\buildForm(), ilAssHtmlPurifier\getElementsUsedForAdvancedEditing(), ilHtmlForumPostPurifier\getPurifierConfigInstance(), ilUserImportParser\importEndTag(), ilObjAdvancedEditingGUI\initTagsForm(), assLongMenuGUI\populateQuestionSpecificFormPart(), assClozeTestGUI\populateQuestionSpecificFormPart(), and ilExSubmissionTextGUI\updateAssignmentTextObject().

                                                                   : array
     {
         $setting = new ilSetting("advanced_editing");
         $tags = $setting->get("advanced_editing_used_html_tags_" . $a_module, '');
         if ($tags !== '') {
             $usedtags = unserialize($tags, ["allowed_classes" => false]);
         } elseif ($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, true)) {
                 $usedtags[] = 'div';
             }
 
             if (!in_array('blockquote', $usedtags, true)) {
                 $usedtags[] = 'blockquote';
             }
         }
 
         return $usedtags;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getUsedHTMLTagsAsString()

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

static

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 122 of file class.ilObjAdvancedEditing.php.

Referenced by ilKprimChoiceWizardInputGUI\cleanupAnswerText(), assQuestionGUI\cleanupAnswerText(), ilObjSurvey\cloneTextblocks(), ilSurveyEditorGUI\saveHeadingObject(), ILIAS\Test\Scoring\Manual\TestScoringByQuestionGUI\saveManScoringByQuestion(), and ILIAS\Test\Scoring\Manual\TestScoringByParticipantGUI\saveManScoringParticipantScreen().

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

Here is the caller graph for this function:

◆ _setRichTextEditorUserState()

static ilObjAdvancedEditing::_setRichTextEditorUserState ( int $a_state )

static

Sets the state of the rich text editor visibility for the current user.

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

References $DIC.

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

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

Here is the caller graph for this function:

◆ getHTMLTags()

& ilObjAdvancedEditing::getHTMLTags ( )

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

Returns: array HTML tags

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

                                   : array
     {
         $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 ( string $a_js_editor )

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

References ilSetting\set().

                                                           : void
     {
         $setting = new ilSetting("advanced_editing");
         $setting->set("advanced_editing_javascript_editor", $a_js_editor);
     }

Here is the call graph for this function:

◆ setUsedHTMLTags()

ilObjAdvancedEditing::setUsedHTMLTags	(	array	$a_html_tags,
		string	$a_module
	)

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 153 of file class.ilObjAdvancedEditing.php.

References ilObject\$lng, ilSetting\set(), and ilLanguage\txt().

      : void {
         $lng = $this->lng;
 
         if ($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, true)) {
                     $auto_added_tags[] = 'div';
                 }
 
                 if (!in_array('blockquote', $a_html_tags, true)) {
                     $auto_added_tags[] = 'blockquote';
                 }
             }
 
             $setting = new ilSetting("advanced_editing");
             $setting->set("advanced_editing_used_html_tags_" . $a_module, serialize(array_merge($a_html_tags, $auto_added_tags)));
 
             if (count($auto_added_tags)) {
                 throw new ilAdvancedEditingRequiredTagsException(
                     sprintf(
                         $lng->txt('advanced_editing_required_tags'),
                         implode(', ', $auto_added_tags)
                     )
                 );
             }
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $setting

ilSetting ilObjAdvancedEditing::$setting

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

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

components/ILIAS/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()

◆ getHTMLTags()

◆ setRichTextEditor()

◆ setUsedHTMLTags()

Field Documentation

◆ $setting