Inheritance diagram for ilObjAdvancedEditing:
Collaboration diagram for ilObjAdvancedEditing:
Public Member Functions | |
| ilObjAdvancedEditing ($a_id=0, $a_call_by_reference=true) | |
| Constructor public. | |
| update () | |
| update object data | |
| ilClone ($a_parent_ref) | |
| copy all entries of your object. | |
| delete () | |
| delete object and all related data | |
| initDefaultRoles () | |
| init default roles settings | |
| 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. | |
| & | _getUsedHTMLTags ($a_module="") |
| Returns an array of all allowed HTML tags for text editing. | |
| & | _getUsedHTMLTagsAsString ($a_module="") |
| Returns a string of all allowed HTML tags for text editing. | |
| _getRichTextEditor () | |
| Returns the identifier for the Rich Text Editor. | |
| _setRichTextEditor ($a_js_editor) | |
| Sets wheather a Rich Text Editor should be used or not. | |
| _setUsedHTMLTags ($a_html_tags, $a_module) | |
| Writes an array with allowed HTML tags to the ILIAS settings. | |
| & | getHTMLTags () |
| Returns an array of all possible HTML tags for text editing. | |
| & | _getAllHTMLTags () |
| Returns an array of all possible HTML tags for text editing. | |
| _getAllHTMLTagsAsString () | |
| Returns a string of all HTML tags. | |
Data Fields | |
| $setting | |
Detailed Description
Definition at line 36 of file class.ilObjAdvancedEditing.php.
Member Function Documentation
| & ilObjAdvancedEditing::_getAllHTMLTags | ( | ) |
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 390 of file class.ilObjAdvancedEditing.php.
Referenced by _getAllHTMLTagsAsString().
{
$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;
}
Here is the caller graph for this function:
| ilObjAdvancedEditing::_getAllHTMLTagsAsString | ( | ) |
Returns a string of all HTML tags.
Returns a string of all HTML tags
- Returns:
- string Used HTML tags
Definition at line 490 of file class.ilObjAdvancedEditing.php.
References $result, and _getAllHTMLTags().
{
$result = "";
$tags =& ilObjAdvancedEditing::_getAllHTMLTags();
foreach ($tags as $tag)
{
$result .= "<$tag>";
}
return $result;
}
Here is the call graph for this function:
| ilObjAdvancedEditing::_getRichTextEditor | ( | ) |
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 293 of file class.ilObjAdvancedEditing.php.
References $setting.
Referenced by ilRTE::_getRTEClassname().
{
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:
| & 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
- Parameters:
-
string $a_module Name of the module or object which uses the tags
- Returns:
- array HTML tags
Definition at line 221 of file class.ilObjAdvancedEditing.php.
References $setting.
Referenced by _getUsedHTMLTagsAsString(), and ilTinyMCE::addRTESupport().
{
$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
{
// default: everything but tables
$usedtags = array(
"a",
"blockquote",
"br",
"cite",
"code",
"div",
"em",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6",
"hr",
"img",
"li",
"ol",
"object",
"p",
"pre",
"span",
"strike",
"strong",
"sub",
"sup",
"u",
"ul"
);
}
return $usedtags;
}
Here is the caller graph for this function:
| & 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
- Parameters:
-
string $a_module Name of the module or object which uses the tags
- Returns:
- string Used HTML tags
Definition at line 275 of file class.ilObjAdvancedEditing.php.
References $result, and _getUsedHTMLTags().
Referenced by ilContainerGUI::savePageContentObject(), ilObjSurveyGUI::savePropertiesObject(), ilObjTestGUI::savePropertiesObject(), SurveyTextQuestionGUI::writePostData(), SurveyOrdinalQuestionGUI::writePostData(), SurveyNominalQuestionGUI::writePostData(), SurveyMetricQuestionGUI::writePostData(), assTextSubsetGUI::writePostData(), assTextQuestionGUI::writePostData(), assSingleChoiceGUI::writePostData(), assOrderingQuestionGUI::writePostData(), assNumericGUI::writePostData(), assMultipleChoiceGUI::writePostData(), assMatchingQuestionGUI::writePostData(), assJavaAppletGUI::writePostData(), assImagemapQuestionGUI::writePostData(), and assClozeTestGUI::writePostData().
{
$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:
| 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 308 of file class.ilObjAdvancedEditing.php.
References $setting.
| 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
Definition at line 323 of file class.ilObjAdvancedEditing.php.
References $setting.
| 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
Reimplemented from ilObject.
Definition at line 108 of file class.ilObjAdvancedEditing.php.
{
// always call parent delete function first!!
if (!parent::delete())
{
return false;
}
//put here your module specific stuff
return true;
}
| & 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 340 of file class.ilObjAdvancedEditing.php.
{
$tags = array(
"a",
"blockquote",
"br",
"cite",
"code",
"div",
"em",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6",
"hr",
"img",
"li",
"object",
"ol",
"p",
"pre",
"span",
"strike",
"strong",
"sub",
"sup",
"table",
"td",
"tr",
"u",
"ul",
"ruby", // Ruby Annotation XHTML module
"rbc",
"rtc",
"rb",
"rt",
"rp"
);
return $tags;
}
| ilObjAdvancedEditing::ilClone | ( | $ | a_parent_ref | ) |
copy all entries of your object.
public
- Parameters:
-
integer ref_id of parent object
- Returns:
- integer new ref id
Reimplemented from ilObject.
Definition at line 79 of file class.ilObjAdvancedEditing.php.
References $rbacadmin.
{
global $rbacadmin;
// always call parent ilClone function first!!
$new_ref_id = parent::ilClone($a_parent_ref);
// get object instance of ilCloned object
//$newObj =& $this->ilias->obj_factory->getInstanceByRefId($new_ref_id);
// create a local role folder & default roles
//$roles = $newObj->initDefaultRoles();
// ...finally assign role to creator of object
//$rbacadmin->assignUser($roles[0], $newObj->getOwner(), "n");
// always destroy objects in ilClone method because ilClone() is recursive and creates instances for each object in subtree!
//unset($newObj);
// ... and finally always return new reference ID!!
return $new_ref_id;
}
| ilObjAdvancedEditing::ilObjAdvancedEditing | ( | $ | 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 46 of file class.ilObjAdvancedEditing.php.
References ilObject::ilObject().
{
include_once "./Services/Administration/classes/class.ilSetting.php";
$this->setting = new ilSetting("advanced_editing");
$this->type = "adve";
$this->ilObject($a_id,$a_call_by_reference);
}
Here is the call graph for this function:
| 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
- Returns:
- array object IDs of created local roles.
Reimplemented from ilObject.
Definition at line 130 of file class.ilObjAdvancedEditing.php.
References $rbacadmin.
{
global $rbacadmin;
// create a local role folder
//$rfoldObj = $this->createRoleFolder("Local roles","Role Folder of forum obj_no.".$this->getId());
// create moderator role and assign role to rolefolder...
//$roleObj = $rfoldObj->createRole("Moderator","Moderator of forum obj_no.".$this->getId());
//$roles[] = $roleObj->getId();
//unset($rfoldObj);
//unset($roleObj);
return $roles ? $roles : array();
}
| 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
- Parameters:
-
string event integer reference id of object where the event occured array passes optional parameters if required
- Returns:
- boolean
Reimplemented from ilObject.
Definition at line 160 of file class.ilObjAdvancedEditing.php.
References $_GET, $tree, and ilObject::getType().
{
global $tree;
switch ($a_event)
{
case "link":
//var_dump("<pre>",$a_params,"</pre>");
//echo "Module name ".$this->getRefId()." triggered by link event. Objects linked into target object ref_id: ".$a_ref_id;
//exit;
break;
case "cut":
//echo "Module name ".$this->getRefId()." triggered by cut event. Objects are removed from target object ref_id: ".$a_ref_id;
//exit;
break;
case "copy":
//var_dump("<pre>",$a_params,"</pre>");
//echo "Module name ".$this->getRefId()." triggered by copy event. Objects are copied into target object ref_id: ".$a_ref_id;
//exit;
break;
case "paste":
//echo "Module name ".$this->getRefId()." triggered by paste (cut) event. Objects are pasted into target object ref_id: ".$a_ref_id;
//exit;
break;
case "new":
//echo "Module name ".$this->getRefId()." triggered by paste (new) event. Objects are applied to target object ref_id: ".$a_ref_id;
//exit;
break;
}
// At the beginning of the recursive process it avoids second call of the notify function with the same parameter
if ($a_node_id==$_GET["ref_id"])
{
$parent_obj =& $this->ilias->obj_factory->getInstanceByRefId($a_node_id);
$parent_type = $parent_obj->getType();
if($parent_type == $this->getType())
{
$a_node_id = (int) $tree->getParentId($a_node_id);
}
}
parent::notify($a_event,$a_ref_id,$a_parent_non_rbac_id,$a_node_id,$a_params);
}
Here is the call graph for this function:
| ilObjAdvancedEditing::update | ( | ) |
update object data
public
- Returns:
- boolean
Reimplemented from ilObject.
Definition at line 60 of file class.ilObjAdvancedEditing.php.
{
if (!parent::update())
{
return false;
}
// put here object specific stuff
return true;
}
Field Documentation
| ilObjAdvancedEditing::$setting |
Definition at line 38 of file class.ilObjAdvancedEditing.php.
Referenced by _getRichTextEditor(), _getUsedHTMLTags(), _setRichTextEditor(), and _setUsedHTMLTags().
The documentation for this class was generated from the following file:
- classes/class.ilObjAdvancedEditing.php
