Public Member Functions | Data Fields

ilObjAdvancedEditing Class Reference

Class ilObjAdvancedEditing. More...

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
 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.
 _setRichTextEditorUserState ($a_state)
 Sets the state of the rich text editor visibility for the current user.
 _getRichTextEditorUserState ()
 Gets the state of the rich text editor visibility for the current user.

Data Fields

 $setting

Detailed Description

Class ilObjAdvancedEditing.

Author:
Helmut Schottmüller <helmut.schottmueller@mac.com>
Version:
Id:
class.ilObjAdvancedEditing.php 14023 2007-05-31 08:51:57Z hschottm

Definition at line 35 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 360 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 459 of file class.ilObjAdvancedEditing.php.

References _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 262 of file class.ilObjAdvancedEditing.php.

References $setting.

Referenced by ilRTE::_getRTEClassname(), and ilTinyMCE::addRTESupport().

        {
                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::_getRichTextEditorUserState (  ) 

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

Referenced by ilTinyMCE::addRTESupport().

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

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 191 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",
                        "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 244 of file class.ilObjAdvancedEditing.php.

References _getUsedHTMLTags().

Referenced by ilObjSurvey::cloneTextblocks(), ilHtmlBlockGUIGen::getValuesHtmlBlock(), assTextSubsetGUI::saveFeedback(), assTextQuestionGUI::saveFeedback(), assSingleChoiceGUI::saveFeedback(), assQuestionTypeTemplateGUI::saveFeedback(), assOrderingQuestionGUI::saveFeedback(), assNumericGUI::saveFeedback(), assMultipleChoiceGUI::saveFeedback(), assMatchingQuestionGUI::saveFeedback(), assJavaAppletGUI::saveFeedback(), assImagemapQuestionGUI::saveFeedback(), assFlashAppGUI::saveFeedback(), assClozeTestGUI::saveFeedback(), ilObjSurveyGUI::saveHeadingObject(), ilHtmlBlockGUIGen::saveHtmlBlock(), ilContainerGUI::savePageContentObject(), ilObjTestGUI::savePropertiesObject(), ilObjSurveyGUI::savePropertiesObject(), ilTestScoringGUI::setFeedbackManual(), ilHtmlBlockGUIGen::updateHtmlBlock(), assTextSubsetGUI::writePostData(), assTextQuestionGUI::writePostData(), assSingleChoiceGUI::writePostData(), assOrderingQuestionGUI::writePostData(), assNumericGUI::writePostData(), assMultipleChoiceGUI::writePostData(), assMatchingQuestionGUI::writePostData(), assJavaAppletGUI::writePostData(), assImagemapQuestionGUI::writePostData(), assFlashAppGUI::writePostData(), assClozeTestGUI::writePostData(), SurveyTextQuestionGUI::writePostData(), SurveyOrdinalQuestionGUI::writePostData(), SurveyNominalQuestionGUI::writePostData(), SurveyMetricQuestionGUI::writePostData(), and SurveyMatrixQuestionGUI::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 277 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);
        }

ilObjAdvancedEditing::_setRichTextEditorUserState ( $  a_state  ) 

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

Referenced by ilTinyMCE::addRTESupport().

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

Here is the caller graph for this function:

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

References $setting.

        {
                if (strlen($a_module))
                {
                        include_once "./Services/Administration/classes/class.ilSetting.php";
                        $setting = new ilSetting("advanced_editing");
                        $setting->set("advanced_editing_used_html_tags_" . $a_module, serialize($a_html_tags));
                }
        }

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 78 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 309 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",
                        "param",
                        "pre",
                        "span",
                        "strike",
                        "strong",
                        "sub",
                        "sup",
                        "table",
                        "td",
                        "tr",
                        "u",
                        "ul",
                        "ruby", // Ruby Annotation XHTML module
                        "rbc",
                        "rtc",
                        "rb",
                        "rt",
                        "rp"
                );
                return $tags;
        }

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

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

References $_GET, 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 59 of file class.ilObjAdvancedEditing.php.

        {
                if (!parent::update())
                {
                        return false;
                }

                // put here object specific stuff

                return true;
        }

Field Documentation

ilObjAdvancedEditing::$setting

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

Referenced by _getRichTextEditor(), _getUsedHTMLTags(), _setRichTextEditor(), and _setUsedHTMLTags().

The documentation for this class was generated from the following file:
Generated on Fri Dec 13 2013 17:57:20 for ILIAS Release_3_9_x_branch .rev 46835 by  doxygen 1.7.1