dokeos-blogs
[ class tree: dokeos-blogs ] [ index: dokeos-blogs ] [ all elements ]

Class: Blog

Source Location: /main/inc/lib/blog.lib.php

Class Overview


Blog class Contains several functions dealing with displaying, editing,... of a blog


Author(s):

Version:

  • 1.0

Methods



Class Details

[line 40]
Blog class Contains several functions dealing with displaying, editing,... of a blog



Tags:

author:  Toon Keppens <toon@vi-host.net>
version:  1.0


[ Top ]


Class Methods


method add_rating [line 888]

Boolean add_rating( String $type, Integer $blog_id, Integer $item_id, Integer $rating)

Adds rating to a certain post or comment



Tags:

return:  success
author:  Toon Keppens


Parameters:

String   $type  
Integer   $blog_id  
Integer   $item_id  
Integer   $rating  

[ Top ]

method assign_task [line 1844]

void assign_task( Integer $blog_id, Integer $user_id, Integer $task_id, Date $target_date)

Assigns a task to a user in a blog



Parameters:

Integer   $blog_id  
Integer   $user_id  
Integer   $task_id  
Date   $target_date  

[ Top ]

method change_blog_visibility [line 635]

void change_blog_visibility( Integer $blog_id)

Changes the visibility of a blog



Tags:

author:  Toon Keppens


Parameters:

Integer   $blog_id  

[ Top ]

method create_blog [line 136]

void create_blog( String $title, $subtitle, Integer $course_id, Text $description)

Creates a new blog in the given course



Tags:

author:  Toon Keppens


Parameters:

Integer   $course_id   Id
String   $title  
Text   $description  
   $subtitle  

[ Top ]

method create_comment [line 329]

void create_comment( String $title, String $full_text, Integer $blog_id, Integer $post_id, Integer $parent_id, [ $task_id = 'NULL'])

Creates a comment on a post in a given blog



Tags:

author:  Toon Keppens


Parameters:

String   $title  
String   $full_text  
Integer   $blog_id  
Integer   $post_id  
Integer   $parent_id  
   $task_id  

[ Top ]

method create_post [line 248]

void create_post( String $title, String $full_text, Integer $blog_id)

Creates a new post in a given blog



Tags:

author:  Toon Keppens


Parameters:

String   $title  
String   $full_text  
Integer   $blog_id  

[ Top ]

method create_task [line 395]

void create_task( Integer $blog_id, String $title, String $description, $articleDelete, $articleEdit, $commentsDelete, String $color)

Creates a new task in a blog



Tags:

author:  Toon Keppens


Parameters:

Integer   $blog_id  
String   $title  
String   $description  
String   $color  
   $articleDelete  
   $articleEdit  
   $commentsDelete  

[ Top ]

method delete_assigned_task [line 568]

void delete_assigned_task( Integer $blog_id, Integer $assignment_id)

Deletes an assigned task from a blog



Parameters:

Integer   $blog_id  
Integer   $assignment_id  

[ Top ]

method delete_blog [line 206]

void delete_blog( Integer $blog_id)

Deletes a blog and it's posts from the course database



Tags:

author:  Toon Keppens


Parameters:

Integer   $blog_id  

[ Top ]

method delete_comment [line 357]

void delete_comment( Integer $blog_id, Integer $comment_id)

Deletes a comment from a blogpost



Tags:

author:  Toon Keppens


Parameters:

Integer   $blog_id  
Integer   $comment_id  

[ Top ]

method delete_post [line 295]

void delete_post( Integer $blog_id, Integer $post_id)

Deletes an article and it's comments



Tags:

author:  Toon Keppens


Parameters:

Integer   $blog_id  
Integer   $post_id  

[ Top ]

method delete_task [line 550]

void delete_task( Integer $blog_id, Integer $task_id)

Deletes a task from a blog



Parameters:

Integer   $blog_id  
Integer   $task_id  

[ Top ]

method display_assigned_task_list [line 1331]

void display_assigned_task_list( Integer $blog_id)

Displays a list of tasks assigned to a user in this blog



Tags:

author:  Toon Keppens


Parameters:

Integer   $blog_id  

[ Top ]

method display_assign_task_form [line 1556]

void display_assign_task_form( $blog_id)

Displays assign task form



Tags:

author:  Toon Keppens


Parameters:

   $blog_id  

[ Top ]

method display_blog_list [line 2529]

void display_blog_list( )

Blog admin | Returns table with blogs in this course



[ Top ]

method display_blog_posts [line 678]

void display_blog_posts( Integer $blog_id, [ $filter = '1=1'], [ $max_number_of_posts = 20])

Shows the posts of a blog



Tags:

author:  Toon Keppens


Parameters:

Integer   $blog_id  
   $filter  
   $max_number_of_posts  

[ Top ]

method display_day_results [line 788]

void display_day_results( Integer $blog_id, String $query_string)

Display posts from a certain date



Parameters:

Integer   $blog_id  
String   $query_string  

[ Top ]

method display_edit_assigned_task_form [line 1677]

void display_edit_assigned_task_form( $blog_id, $assignment_id)

Displays assign task form



Tags:

author:  Toon Keppens


Parameters:

   $blog_id  
   $assignment_id  

[ Top ]

method display_edit_blog_form [line 2492]

void display_edit_blog_form( $blog_id)

Blog admin | Display the form to edit a blog.



Parameters:

   $blog_id  

[ Top ]

method display_edit_task_form [line 1461]

void display_edit_task_form( $blog_id, $task_id)

Displays edit task form



Tags:

author:  Toon Keppens


Parameters:

   $blog_id  
   $task_id  

[ Top ]

method display_form_edit_post [line 1194]

void display_form_edit_post( Integer $blog_id, $post_id)

Displays the form to edit a post



Tags:

author:  Toon Keppens


Parameters:

Integer   $blog_id  
   $post_id  

[ Top ]

method display_form_new_post [line 1060]

void display_form_new_post( Integer $blog_id)

Displays the form to create a new post



Tags:

author:  Toon Keppens


Parameters:

Integer   $blog_id  

[ Top ]

method display_form_user_rights [line 2224]

void display_form_user_rights( Integer $blog_id)

Displays a matrix with selectboxes. On the left: users, on top: possible rights.

The blog admin can thus select what a certain user can do in the current blog




Parameters:

Integer   $blog_id  

[ Top ]

method display_form_user_subscribe [line 2016]

Html display_form_user_subscribe( Integer $blog_id)

Displays the form to register users in a blog (in a course) The listed users are users subcribed in the course.



Tags:

return:  Form with sortable table with users to subcribe in a blog, in a course.
author:  Toon Keppens


Parameters:

Integer   $blog_id  

[ Top ]

method display_form_user_unsubscribe [line 2122]

Html display_form_user_unsubscribe( Integer $blog_id)

Displays the form to register users in a blog (in a course) The listed users are users subcribed in the course.



Tags:

return:  Form with sortable table with users to unsubcribe from a blog.
author:  Toon Keppens


Parameters:

Integer   $blog_id  

[ Top ]

method display_minimonthcalendar [line 2311]

html display_minimonthcalendar( $month, $year, $blog_id, Array $blogitems, Integer $month:, Integer $year:, String $monthName:)

show the calender of the given month



Tags:

return:  code
author:  Patrick Cool
author:  Toon Keppens


Parameters:

Array   $blogitems   an array containing all the blog items for the given month
Integer   $month:   the integer value of the month we are viewing
Integer   $year:   the 4-digit year indication e.g. 2005
String   $monthName:   the language variable for the mont name
   $month  
   $year  
   $blog_id  

[ Top ]

method display_new_blog_form [line 2462]

void display_new_blog_form( )

Blog admin | Display the form to add a new blog.



[ Top ]

method display_new_comment_form [line 2242]

void display_new_comment_form( Integer $blog_id, $post_id, $title)

Displays the form to create a new post



Tags:

author:  Toon Keppens


Parameters:

Integer   $blog_id  
   $post_id  
   $title  

[ Top ]

method display_new_task_form [line 1389]

void display_new_task_form( $blog_id)

Displays new task form



Tags:

author:  Toon Keppens


Parameters:

   $blog_id  

[ Top ]

method display_post [line 810]

void display_post( Integer $blog_id, Integer $post_id)

Displays a post and his comments



Parameters:

Integer   $blog_id  
Integer   $post_id  

[ Top ]

method display_rating [line 917]

void display_rating( $type, $blog_id, $item_id)



Parameters:

   $type  
   $blog_id  
   $item_id  

[ Top ]

method display_rating_form [line 937]

void display_rating_form( String $type, Integer $blog_id, $post_id, [ $comment_id = NULL], Integer $item_id)

Shows the rating form if not already rated by that user



Tags:

author:  Toon Keppens


Parameters:

String   $type  
Integer   $blog_id  
Integer   $item_id  
   $post_id  
   $comment_id  

[ Top ]

method display_search_results [line 766]

void display_search_results( Integer $blog_id, String $query_string)

Display the search results



Parameters:

Integer   $blog_id  
String   $query_string  

[ Top ]

method display_select_task_post [line 1921]

void display_select_task_post( Integer $blog_id, unknown_type $task_id)

Displays a list with posts a user can select to execute his task.



Parameters:

Integer   $blog_id  
unknown_type   $task_id  

[ Top ]

method display_task_list [line 1259]

void display_task_list( Integer $blog_id)

Displays a list of tasks in this blog



Tags:

author:  Toon Keppens


Parameters:

Integer   $blog_id  

[ Top ]

method edit_assigned_task [line 1879]

void edit_assigned_task( $blog_id, $user_id, $task_id, $target_date, $old_user_id, $old_task_id, $old_target_date)



Parameters:

   $blog_id  
   $user_id  
   $task_id  
   $target_date  
   $old_user_id  
   $old_task_id  
   $old_target_date  

[ Top ]

method edit_blog [line 178]

void edit_blog( $blog_id, String $title, $subtitle, Integer $course_id, Text $description)

Update title and subtitle of a blog in the given course



Tags:

author:  Toon Keppens


Parameters:

Integer   $course_id   Id
String   $title  
Text   $description  
   $blog_id  
   $subtitle  

[ Top ]

method edit_post [line 274]

void edit_post( $post_id, String $title, String $full_text, Integer $blog_id)

Edits a post in a given blog



Tags:

author:  Toon Keppens


Parameters:

Integer   $blog_id  
String   $title  
String   $full_text  
   $post_id  

[ Top ]

method edit_task [line 471]

void edit_task( $blog_id, Integer $task_id, String $title, String $description, $articleDelete, $articleEdit, $commentsDelete, String $color)

Edit a task in a blog



Tags:

author:  Toon Keppens


Parameters:

Integer   $task_id  
String   $title  
String   $description  
String   $color  
   $blog_id  
   $articleDelete  
   $articleEdit  
   $commentsDelete  

[ Top ]

method get_blog_subtitle [line 78]

String get_blog_subtitle( Integer $blog_id)

Get the description of a blog



Tags:

return:  Blog description
author:  Toon Keppens


Parameters:

Integer   $blog_id  

[ Top ]

method get_blog_title [line 50]

String get_blog_title( Integer $blog_id)

Get the title of a blog



Tags:

return:  Blog Title
author:  Toon Keppens


Parameters:

Integer   $blog_id  

[ Top ]

method get_blog_users [line 98]

Array get_blog_users( Integer $blog_id)

Get the users of a blog



Tags:

return:  Returns an array with [userid]=>[username]
author:  Toon Keppens


Parameters:

Integer   $blog_id  

[ Top ]

method get_personal_task_list [line 589]

Returns get_personal_task_list( )

Get personal task list



Tags:

return:  an unsorted list (
author:  Toon Keppens


[ Top ]

method get_threaded_comments [line 992]

void get_threaded_comments( [Integer $current = 0], [Integer $current_level = 0], Integer $blog_id, Integer $post_id, [ $task_id = 0])

This functions gets all replys to a post, threaded.



Parameters:

Integer   $current  
Integer   $current_level  
Integer   $blog_id  
Integer   $post_id  
   $task_id  

[ Top ]

method set_user_subscribed [line 1968]

void set_user_subscribed( Integer $blog_id, Integer $user_id)

Subscribes a user to a given blog



Tags:

author:  Toon Keppens


Parameters:

Integer   $blog_id  
Integer   $user_id  

[ Top ]

method set_user_unsubscribed [line 1992]

void set_user_unsubscribed( Integer $blog_id, Integer $user_id)

Unsubscribe a user from a given blog



Tags:

author:  Toon Keppens


Parameters:

Integer   $blog_id  
Integer   $user_id  

[ Top ]


Documentation generated on Wed, 05 Sep 2007 06:14:25 +0200 by phpDocumentor 1.4.0