Index of All Elements

c d i m p r t top

c

$category
in file mooan_annotea_lib.php, variable MooanMessageData::$category
    String, category of the comment, if this is a comment.
$content
in file mooan_annotea_lib.php, variable MooanMessageData::$content
    String, Content of the message. Will also temporarily hold the URI to fetch the content from before it does get loaded.
$creator
in file mooan_annotea_lib.php, variable MooanMessageData::$creator
    String, Name of the creator of this message.
top

d

$date
in file mooan_annotea_lib.php, variable MooanMessageData::$date
    String, last modified data in W3C date format.
top

i

$id
in file mooan_annotea_lib.php, variable MooanMessageData::$id
    String, ID of this message.
is_last_message
in file mooan_handle_request.php, function is_last_message()
    Tests if a given message is the last reply in a given comment tree.
is_last_messageX
in file mooan_handle_request.php, function is_last_messageX()
    Tests if a given message is the last reply in a given comment tree.
top

m

MooanMessageData
in file mooan_annotea_lib.php, class MooanMessageData
mooan_add_big_view
in file mooan_handle_request.php, function mooan_add_big_view()
    Creates a view for "suurennettu" (big)
mooan_add_comment
in file mooan_annotea_lib.php, function mooan_add_comment()
    Adds a comment to the given document.
mooan_add_init
in file mooan_handle_request.php, function mooan_add_init()
    Adds a javascript functionality to the body element.
mooan_add_javascript
in file mooan_handle_request.php, function mooan_add_javascript()
    Adds javascript functionality to the content element
mooan_add_message
in file mooan_annotea_lib.php, function mooan_add_message()
    Adds a response to the given message.
mooan_add_new_comment_view
in file mooan_handle_request.php, function mooan_add_new_comment_view()
    Adds a 'new comment view' to the page
mooan_add_reply_view
in file mooan_handle_request.php, function mooan_add_reply_view()
    Creates a view for replying.
mooan_annotation_on
in file mooan_handle_action_test_st.php, function mooan_annotation_on()
MOOAN_ANNOTEA_ADDRESS
in file mooan_configuration.php, constant MOOAN_ANNOTEA_ADDRESS
    Address of the Annotea server we store data in.
mooan_annotea_lib.php
procedural page mooan_annotea_lib.php
MOOAN_ANNOTEA_MODIFY_IS_BUGGED
in file mooan_configuration.php, constant MOOAN_ANNOTEA_MODIFY_IS_BUGGED
    There is a bug in bakunin Annotea server version 0.5 where modifying an annotation or a reply will corrupt the internal state of the modified annotation or reply. During modification, the server deletes the old data. The bug is in that it does not preserve list of replies.
mooan_annotea_request
in file mooan_annotea_lib.php, function mooan_annotea_request()
    Sends the given request via HTTP to the Annotea server and hands back the reponse.
mooan_check_ownership
in file mooan_handle_action_test_st.php, function mooan_check_ownership()
MOOAN_COMMENT_CATEGORY_NS
in file mooan_configuration.php, constant MOOAN_COMMENT_CATEGORY_NS
    Location where the RDF schema describing the comment categories is stored.
mooan_comment_history
in file mooan_readcomments.php, function mooan_comment_history()
    Reads from the DB which comments attached to the current document the current user has read, and if read, when.
mooan_configuration.php
procedural page mooan_configuration.php
mooan_create_comment_messages
in file mooan_handle_request.php, function mooan_create_comment_messages()
    Returns the view of a given message and its replies, replies's replies and so on.
mooan_create_comment_type_selector
in file mooan_handle_request.php, function mooan_create_comment_type_selector()
    Adds a comment type selector
mooan_create_comment_view
in file mooan_handle_request.php, function mooan_create_comment_view()
    Goes through a given comment and creates html elements according to a specific syntax.
mooan_create_comment_views
in file mooan_handle_request.php, function mooan_create_comment_views()
    Creates a comment view for each comment in the document.
mooan_create_header_rows
in file mooan_handle_request.php, function mooan_create_header_rows()
    Adds header rows telling where to fetch all required js and css files.
mooan_create_indicator
in file mooan_handle_request.php, function mooan_create_indicator()
    Adds a hidden element that pops up when something is added to the db.
mooan_create_span_node
in file mooan_x_pointer_lib.php, function mooan_create_span_node()
    Creates a new span node and sets it's id attribute and class attributes.
mooan_create_top_banner
in file mooan_handle_request.php, function mooan_create_top_banner()
    Prints the Mooan banner at the top of a page that's being modified
mooan_create_view_pane
in file mooan_handle_request.php, function mooan_create_view_pane()
    Creates and adds a comment view pane to the htmlpage
mooan_delete
in file mooan_annotea_lib.php, function mooan_delete()
    Removes an entry with the given ID from Annotea. Will only work on entries that have no responses.
mooan_delete_rec
in file mooan_annotea_lib.php, function mooan_delete_rec()
    Removes an entry with the given ID, and all responses to it, from Annotea.
mooan_delete_rec_aux
in file mooan_annotea_lib.php, function mooan_delete_rec_aux()
    The actual recursive deletion, separated from mooan_delete_rec due to optimisation reasons.
mooan_documentlib.php
procedural page mooan_documentlib.php
mooan_do_rangeto
in file mooan_x_pointer_lib.php, function mooan_do_rangeto()
    Handles a range-to type XPointer. Wraps all of the text within the given range with span nodes, respecting element boundaries and cutting text elements to smaller ones at the range edges if necessary.
mooan_do_response
in file mooan_handle_action.php, function mooan_do_response()
    A function for sending the response to the client.
mooan_do_stringrange
in file mooan_x_pointer_lib.php, function mooan_do_stringrange()
    Handles a string-range type XPointer. Wraps all of the text within the given range with span nodes, respecting element boundaries and cutting text elements to smaller ones at the range edges if necessary.
mooan_get_annotation
in file mooan_documentlib.php, function mooan_get_annotation()
    This function checks, if annotating is on for the current document It gets document_id as parameter.
mooan_get_body
in file mooan_annotea_lib.php, function mooan_get_body()
    Gets the content of an entry from Annotea.
mooan_get_comments
in file mooan_annotea_lib.php, function mooan_get_comments()
    Gets all comments, and replies to those comments, made to the given document.
mooan_get_comment_base_data
in file mooan_annotea_lib.php, function mooan_get_comment_base_data()
    Gets the ID, body URI, creator and position of all the comments attached to the given document.
mooan_get_common_parent
in file mooan_x_pointer_lib.php, function mooan_get_common_parent()
    Calculates the deepest node that is a parent of both $node1 and $node2.
mooan_get_current_document_id
in file mooan_moodle_interface.php, function mooan_get_current_document_id()
    Returns the request portion of the URI that was used to retrieve this document.
mooan_get_current_user_id
in file mooan_moodle_interface.php, function mooan_get_current_user_id()
    Determines the userid of the current user and returns in in "serialised" form: numericalid:fullname
mooan_get_last_modified
in file mooan_x_pointer_lib.php, function mooan_get_last_modified()
    Gets the UNIX timestamp of when a modification was last made to the comment & response subtree starting with the given comment.
mooan_get_reply_tree
in file mooan_annotea_lib.php, function mooan_get_reply_tree()
    Retrieves the response subtree attached to the given entry. The subtree will be attached to the parent node's data structure.
mooan_get_single_message_base_data
in file mooan_annotea_lib.php, function mooan_get_single_message_base_data()
    Retrieves the given message's creator and last modification data from Annotea.
mooan_get_user_rights
in file mooan_handle_action_test_st.php, function mooan_get_user_rights()
mooan_handle_action.php
procedural page mooan_handle_action.php
mooan_handle_action2.php
procedural page mooan_handle_action2.php
mooan_handle_action_test_st.php
procedural page mooan_handle_action_test_st.php
mooan_handle_request.php
procedural page mooan_handle_request.php
mooan_is_owner
in file mooan_handle_request.php, function mooan_is_owner()
    This function checks the ownership between a user and a comment/message It returns a boolean value, true if given user is the creator.
mooan_mark_read
in file mooan_handle_action_test_st.php, function mooan_mark_read()
mooan_modify_comment
in file mooan_annotea_lib.php, function mooan_modify_comment()
    Modifies a comment with the given ID. Works by loading the original message from Annotea and altering it's values based on the parameters. If a parameter is NULL, the original value is kept.
mooan_modify_message
in file mooan_annotea_lib.php, function mooan_modify_message()
    Modifies a response with the given ID. The position of the response in the response tree is not alterable via this function. Works by loading the original message from Annotea and altering it's values based on the parameters. If a parameter is NULL, the original value is kept.
mooan_modify_page
in file mooan_handle_request.php, function mooan_modify_page()
    This function gets a parsed dom-tree from mooan_moodle_interface as a parameter. The function modifies it and returns it to the www-server.
mooan_moodle_interface.php
procedural page mooan_moodle_interface.php
mooan_output_buffering_end
in file mooan_moodle_interface.php, function mooan_output_buffering_end()
    Ends output buffering if the same checks as were run in mooan_output_buffering_start() before starting it pass.
mooan_output_buffering_start
in file mooan_moodle_interface.php, function mooan_output_buffering_start()
    Starts output buffering if the current document is annotable or if it's not annotable but the current user has the rights to turn it on.
mooan_parse_id
in file mooan_annotea_lib.php, function mooan_parse_id()
    Given an Annotea entity ID in the format of an URI, crops off everything preceding the actual entity ID. For example for 'http://localhost/annotea/01234' returns '01234'.
mooan_parse_rangeto
in file mooan_x_pointer_lib.php, function mooan_parse_rangeto()
    Parses the sub-parameters from a range-to type XPointer.
mooan_parse_stringrange
in file mooan_x_pointer_lib.php, function mooan_parse_stringrange()
    A function to wrap the massive regexp used to get the string-range paramaters out of a string-range part of an XPointer.
mooan_parse_timestamp
in file mooan_handle_request.php, function mooan_parse_timestamp()
    ****************************************\
mooan_parse_user_id
in file mooan_moodle_interface.php, function mooan_parse_user_id()
    Parses the numerical id and the user's fullname out of an userid generated by mooan_get_current_user_id().
mooan_parse_xpath
in file mooan_x_pointer_lib.php, function mooan_parse_xpath()
    Determines the element pointed at by the given "XPath".
mooan_place
in file mooan_x_pointer_lib.php, function mooan_place()
    Sets span elements to highlight all comments in $commentarray whose location can be found.
mooan_print_table
in file mooan_documentlib.php, function mooan_print_table()
    this exist to help testing. it prints the database table
mooan_readcomments.php
procedural page mooan_readcomments.php
mooan_remove
in file mooan_handle_action_test_st.php, function mooan_remove()
MOOAN_RIGHTS_ALL
in file mooan_configuration.php, constant MOOAN_RIGHTS_ALL
    A logged-in admin or a logged-in teacher who is a teacher in the current course.
MOOAN_RIGHTS_ALTER_ANNOTABILITY
in file mooan_configuration.php, constant MOOAN_RIGHTS_ALTER_ANNOTABILITY
    A logged-in student who is the owner of the current document. Has the same rights as MOOAN_RIGHTS_NORMAL and in addition may toggle whether the current document is annotable.
MOOAN_RIGHTS_NORMAL
in file mooan_configuration.php, constant MOOAN_RIGHTS_NORMAL
    A logged-in student or a logged-in teacher who does not have teacher rights in the current course.
MOOAN_RIGHTS_VISITOR
in file mooan_configuration.php, constant MOOAN_RIGHTS_VISITOR
    An unlogged-in user or a guest. May only read comments.
mooan_set_annotation
in file mooan_documentlib.php, function mooan_set_annotation()
    This function sets annotating on/off by the parameter $status It gets boolean $status as parameter: if $status is true it sets annotation on, else off.
MOOAN_SET_ERROR_LEVEL
in file mooan_configuration.php, constant MOOAN_SET_ERROR_LEVEL
    If this is true, E_USER_* type errors will be set to be reported via a call error_reporting(). Mooan prints warnings and notices using trigger_error().
mooan_wrap_children_new_span
in file mooan_x_pointer_lib.php, function mooan_wrap_children_new_span()
    Loops over all the text elements in the subtree starting from the target and moves them to be children of span nodes.
mooan_x_pointer_lib.php
procedural page mooan_x_pointer_lib.php
top

p

$position
in file mooan_annotea_lib.php, variable MooanMessageData::$position
    XPointer string, the location if this is a comment.
top

r

$replies
in file mooan_annotea_lib.php, variable MooanMessageData::$replies
    Array containing MooanMessageData objects representing replies to this message.
top

t

test_create_comment_messages
in file mooan_handle_request.php, function test_create_comment_messages()
    Returns the view of a given message and its replies, replies's replies and so on.
test_create_comment_view
in file mooan_handle_request.php, function test_create_comment_view()
test_create_comment_views
in file mooan_handle_request.php, function test_create_comment_views()

Documentation generated on Tue, 06 Feb 2007 13:09:10 +0200 by phpDocumentor 1.3.0RC6