Collaboration diagram for ilForumProperties:

Public Member Functions
	insert ()

	update ()

	copy ($a_new_obj_id)

	isIsThreadRatingEnabled ()

	setIsThreadRatingEnabled ($is_thread_rating_enabled)

	setDefaultView ($a_default_view)

	getDefaultView ()

	setStatisticsStatus ($a_statistic_status)

	isStatisticEnabled ()

	setAnonymisation ($a_anonymized)

	isAnonymized ()

	setPostActivation ($a_post_activation)

	isPostActivationEnabled ()

	setObjId ($a_obj_id=0)

	getObjId ()

	setAdminForceNoti ($a_admin_force)

	isAdminForceNoti ()

	setUserToggleNoti ($a_user_toggle)

	isUserToggleNoti ()

	setPresetSubject ($a_preset_subject)

	getPresetSubject ()

	setAddReSubject ($a_add_re_subject)

	getAddReSubject ()

	setNotificationType ($a_notification_type)

	getNotificationType ()

	getSubjectSetting ()

	setSubjectSetting ($a_subject_setting)

	setMarkModeratorPosts ($a_mod_post)

	getMarkModeratorPosts ()

	setThreadSorting ($a_thread_sorting)

	getThreadSorting ()

	getUserToggleNoti ()

	getAdminForceNoti ()

	setFileUploadAllowed ($allowed)

	getFileUploadAllowed ()

	isFileUploadAllowed ()

Static Public Member Functions
static	getInstance ($a_obj_id=0)

static	_isAnonymized ($a_obj_id)

static	_isAdminForceNoti ($a_obj_id)

static	_isUserToggleNoti ($a_obj_id)

Data Fields
const	VIEW_TREE = 1

const	VIEW_DATE = 2

const	VIEW_DATE_ASC = 2

const	VIEW_DATE_DESC = 3

const	FORUM_OVERVIEW_WITH_NEW_POSTS = 0

const	FORUM_OVERVIEW_NO_NEW_POSTS = 1

const	FILE_UPLOAD_GLOBALLY_ALLOWED = 0

const	FILE_UPLOAD_INDIVIDUAL = 1

Protected Member Functions
	__construct ($a_obj_id=0)

Private Member Functions
	__clone ()

	read ()

Private Attributes
	$obj_id
	Object id of current forum private. More...

	$default_view = self::VIEW_TREE
	Default view ( 1 => 'order by answers', 2 => 'order by date ascending', 3 => 'order by date descending') private. More...

	$anonymized = 0
	Defines if a forum is anonymized or not private. More...

	$statistics_enabled = 0
	Defines if a forum can show ranking statistics private. More...

	$post_activation_enabled = 0
	Activation of new posts private. More...

	$notification_type = null
	Global notification-type setting (CRS/GRP) possible values: 'all_users', 'per_user', null (default) More...

	$admin_force_noti = false
	Activation of (CRS/GRP) forum notification by mod/admin private. More...

	$user_toggle_noti = false
	Activation of allowing members to deactivate (CRS/GRP)forum notification private. More...

	$preset_subject = 1
	Preset subject on reply. More...

	$add_re_subject = 0
	Add 'Re: ' to subject on reply. More...

	$mark_mod_posts = 0

	$thread_sorting = 0
	sorting type for threads 0 = default 1 = manual More...

	$is_thread_rating_enabled = false

	$db = null
	DB Object private. More...

	$file_upload_allowed = 0

Static Private Attributes
static	$instances = array()

Detailed Description

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Version

Id

Definition at line 10 of file class.ilForumProperties.php.

Constructor & Destructor Documentation

◆ __construct()

ilForumProperties::__construct ( $a_obj_id = 0 )

protected

Definition at line 121 of file class.ilForumProperties.php.

References $ilDB, and read().

         {
                 global $ilDB;
 
                 $this->db = $ilDB;
                 $this->obj_id = $a_obj_id;
                 $this->read();
         }

Here is the call graph for this function:

Member Function Documentation

◆ __clone()

ilForumProperties::__clone ( )

private

Definition at line 130 of file class.ilForumProperties.php.

131 {

132 }

◆ _isAdminForceNoti()

static ilForumProperties::_isAdminForceNoti ( $a_obj_id )

static

Definition at line 366 of file class.ilForumProperties.php.

References $ilDB, and $res.

Referenced by ilForumNotification\checkForumsExistsInsert().

         {
                 global $ilDB;
 
                 $res = $ilDB->queryF("SELECT admin_force_noti FROM frm_settings WHERE obj_id = %s",
                                 array('integer'),
                                 array($a_obj_id));
                 while($record = $ilDB->fetchAssoc($res))
                 {
                         return $record['admin_force_noti'];
                 }
 
                 return 0;
         }

Here is the caller graph for this function:

◆ _isAnonymized()

static ilForumProperties::_isAnonymized ( $a_obj_id )

static

Definition at line 313 of file class.ilForumProperties.php.

References $ilDB, and $result.

Referenced by ilPDNewsTableGUI\fillRow().

         {
                 global $ilDB;
                 
                 $result = $ilDB->queryf("SELECT anonymized FROM frm_settings WHERE obj_id = %s",
                                 array('integer'),array($a_obj_id));
 
                 while($record = $ilDB->fetchAssoc($result))
                 {
                         return $record['anonymized'];
                 }
                 
                 return 0;
         }

Here is the caller graph for this function:

◆ _isUserToggleNoti()

static ilForumProperties::_isUserToggleNoti ( $a_obj_id )

static

Definition at line 381 of file class.ilForumProperties.php.

References $ilDB, and $res.

Referenced by ilForumNotification\checkForumsExistsInsert().

         {
                 global $ilDB;
 
                 $res = $ilDB->queryF("SELECT user_toggle_noti FROM frm_settings WHERE obj_id = %s",
                                 array('integer'),
                                 array($a_obj_id));
                 while($record = $ilDB->fetchAssoc($res))
                 {
                         return $record['user_toggle_noti'];
                 }
                 return 0;
         }

Here is the caller graph for this function:

◆ copy()

ilForumProperties::copy ( $a_new_obj_id )

Definition at line 243 of file class.ilForumProperties.php.

References isIsThreadRatingEnabled().

         {
                 if ($a_new_obj_id)
                 {
                         $this->db->update('frm_settings',
                                 array(
                                         'default_view'        => array('integer', $this->default_view),
                                         'anonymized'          => array('integer', $this->anonymized),
                                         'statistics_enabled'  => array('integer', $this->statistics_enabled),
                                         'post_activation'     => array('integer', $this->post_activation_enabled),
                                         'admin_force_noti'    => array('integer', $this->admin_force_noti),
                                         'user_toggle_noti'    => array('integer', $this->user_toggle_noti),
                                         'preset_subject'      => array('integer', $this->preset_subject),
                                         'add_re_subject'      => array('integer', $this->add_re_subject),
                                         'notification_type'   => array('text', $this->notification_type),
                                         'mark_mod_posts'      => array('integer', $this->mark_mod_posts),
                                         'thread_sorting'      => array('integer', $this->thread_sorting),
                                         'thread_rating'       => array('integer', $this->isIsThreadRatingEnabled()),
                                         'file_upload_allowed' => array('integer', $this->file_upload_allowed)
                                 ),
                                 array(
                                         'obj_id' => array('integer', $a_new_obj_id)
                                 )
                         );
                         return true;
                 }
                 
                 return false;
         }

Here is the call graph for this function:

◆ getAddReSubject()

ilForumProperties::getAddReSubject ( )

Definition at line 407 of file class.ilForumProperties.php.

References $add_re_subject.

Referenced by getSubjectSetting().

         {
                 return $this->add_re_subject;
         }

Here is the caller graph for this function:

◆ getAdminForceNoti()

ilForumProperties::getAdminForceNoti ( )

Returns: mixed

Definition at line 490 of file class.ilForumProperties.php.

References $admin_force_noti.

         {
                 return $this->admin_force_noti;
         }

◆ getDefaultView()

ilForumProperties::getDefaultView ( )

Definition at line 293 of file class.ilForumProperties.php.

References $default_view.

         {
                 return $this->default_view;
         }

◆ getFileUploadAllowed()

ilForumProperties::getFileUploadAllowed ( )

Returns: int

Definition at line 507 of file class.ilForumProperties.php.

References $file_upload_allowed.

Referenced by isFileUploadAllowed().

         {
                 return $this->file_upload_allowed;
         }

Here is the caller graph for this function:

◆ getInstance()

static ilForumProperties::getInstance ( $a_obj_id = 0 )

static

Parameters

int $a_obj_id

Returns: ilForumProperties

Definition at line 138 of file class.ilForumProperties.php.

Referenced by ilForumExportGUI\__construct(), ilForumModeratorsGUI\addModerator(), ilObjForum\create(), ilForum\deletePost(), ilForumModeratorsGUI\detachModeratorRole(), ilForumExportGUI\executeCommand(), ilObjForum\getDiskUsage(), ilForumTopic\getNestedSetPostChildren(), ilForumXMLParser\handlerEndTag(), ilObjForumListGUI\initItem(), and ilObjForum\lookupForumIdByRefId().

         {
                 if (!self::$instances[$a_obj_id])
                 {
                 self::$instances[$a_obj_id] = new ilForumProperties($a_obj_id);
             }
             
             return self::$instances[$a_obj_id];             
         }

Here is the caller graph for this function:

◆ getMarkModeratorPosts()

ilForumProperties::getMarkModeratorPosts ( )

Definition at line 465 of file class.ilForumProperties.php.

References $mark_mod_posts.

         {
                 return $this->mark_mod_posts;
         }

◆ getNotificationType()

ilForumProperties::getNotificationType ( )

Definition at line 419 of file class.ilForumProperties.php.

References $notification_type.

         {
                 return $this->notification_type;
         }

◆ getObjId()

ilForumProperties::getObjId ( )

Definition at line 341 of file class.ilForumProperties.php.

References $obj_id.

         {
                 return $this->obj_id;
         }

◆ getPresetSubject()

ilForumProperties::getPresetSubject ( )

Definition at line 399 of file class.ilForumProperties.php.

References $preset_subject.

Referenced by getSubjectSetting().

         {
                 return $this->preset_subject;
         }

Here is the caller graph for this function:

◆ getSubjectSetting()

ilForumProperties::getSubjectSetting ( )

Definition at line 424 of file class.ilForumProperties.php.

References getAddReSubject(), and getPresetSubject().

         {
                 if($this->getPresetSubject() == 0
                 && $this->getAddReSubject() == 0)
                 {
                         return "empty_subject";
                 }
                 else if($this->getPresetSubject() == 1)
                 {
                         return "preset_subject";
                 }
                 else if($this->getAddReSubject() == 1)
                 {
                         return "add_re_to_subject";
                 }
                 else return "preset_subject";
         }

Here is the call graph for this function:

◆ getThreadSorting()

ilForumProperties::getThreadSorting ( )

Definition at line 474 of file class.ilForumProperties.php.

References $thread_sorting.

         {
                 return $this->thread_sorting;
         }

◆ getUserToggleNoti()

ilForumProperties::getUserToggleNoti ( )

Returns: mixed

Definition at line 482 of file class.ilForumProperties.php.

References $user_toggle_noti.

         {
                 return $this->user_toggle_noti;
         }

◆ insert()

ilForumProperties::insert ( )

Definition at line 185 of file class.ilForumProperties.php.

References isIsThreadRatingEnabled().

         {
                 if ($this->obj_id)
                 {
                         $this->db->insert('frm_settings', 
                                 array(
                                         'obj_id'              => array('integer', $this->obj_id),
                                         'default_view'        => array('integer', $this->default_view),
                                         'anonymized'          => array('integer', $this->anonymized),
                                         'statistics_enabled'  => array('integer', $this->statistics_enabled),
                                         'post_activation'     => array('integer', $this->post_activation_enabled),
                                         'admin_force_noti'    => array('integer', $this->admin_force_noti),
                                         'user_toggle_noti'    => array('integer', $this->user_toggle_noti),
                                         'preset_subject'      => array('integer', $this->preset_subject),
                                         'add_re_subject'      => array('integer', $this->add_re_subject),
                                         'notification_type'   => array('text', $this->notification_type),
                                         'mark_mod_posts'      => array('integer', $this->mark_mod_posts),
                                         'thread_sorting'      => array('integer', $this->thread_sorting),
                                         'thread_rating'       => array('integer', $this->isIsThreadRatingEnabled()),
                                         'file_upload_allowed' => array('integer', $this->file_upload_allowed)
                                 )
                         );
 
                         return true;
                 }
                 
                 return false;
         }

Here is the call graph for this function:

◆ isAdminForceNoti()

ilForumProperties::isAdminForceNoti ( )

Definition at line 351 of file class.ilForumProperties.php.

References $admin_force_noti.

         {
                 return $this->admin_force_noti;
         }

◆ isAnonymized()

ilForumProperties::isAnonymized ( )

Definition at line 309 of file class.ilForumProperties.php.

References $anonymized.

         {
                 return $this->anonymized;
         }               

◆ isFileUploadAllowed()

ilForumProperties::isFileUploadAllowed ( )

Returns: bool

Definition at line 515 of file class.ilForumProperties.php.

References $ilSetting, and getFileUploadAllowed().

         {
                 if(self::isFileUploadGloballyAllowed())
                 {
                         return true;
                 }
 
                 if((bool)$this->getFileUploadAllowed())
                 {
                         return true;
                 }
                 
                 return false;
         }

Here is the call graph for this function:

◆ isIsThreadRatingEnabled()

ilForumProperties::isIsThreadRatingEnabled ( )

Returns: boolean

Definition at line 276 of file class.ilForumProperties.php.

References $is_thread_rating_enabled.

Referenced by copy(), insert(), and update().

         {
                 return (bool)$this->is_thread_rating_enabled;
         }

Here is the caller graph for this function:

◆ isPostActivationEnabled()

ilForumProperties::isPostActivationEnabled ( )

Definition at line 332 of file class.ilForumProperties.php.

References $post_activation_enabled.

         {
                 return $this->post_activation_enabled;
         }

◆ isStatisticEnabled()

ilForumProperties::isStatisticEnabled ( )

Definition at line 301 of file class.ilForumProperties.php.

References $statistics_enabled.

         {
                 return $this->statistics_enabled;
         }

◆ isUserToggleNoti()

ilForumProperties::isUserToggleNoti ( )

Definition at line 361 of file class.ilForumProperties.php.

References $user_toggle_noti.

         {
                 return $this->user_toggle_noti;
         }

◆ read()

ilForumProperties::read ( )

private

Definition at line 148 of file class.ilForumProperties.php.

References $res, $row, and setIsThreadRatingEnabled().

Referenced by __construct(), and setObjId().

         {
                 if ($this->obj_id)
                 {
                         $res = $this->db->queryf('
                                 SELECT * FROM frm_settings
                                 WHERE obj_id = %s',
                                 array('integer'), array($this->obj_id));
                         
                         $row = $this->db->fetchObject($res);
                         
                         if (is_object($row))
                         {
                                 $this->default_view = $row->default_view;
                                 $this->anonymized = $row->anonymized ;// == 1 ? true : false;
                                 $this->statistics_enabled = $row->statistics_enabled ;// == 1 ? true : false;
                                 $this->post_activation_enabled = $row->post_activation ;// == 1 ? true : false;
                                 $this->admin_force_noti = $row->admin_force_noti == 1 ? true : false;
                                 $this->user_toggle_noti = $row->user_toggle_noti == 1 ? true : false;
                                 $this->preset_subject = $row->preset_subject;
                                 $this->add_re_subject = $row->add_re_subject;
 
                                 $this->notification_type = $row->notification_type == null ? 'default': $row->notification_type;
                                 $this->mark_mod_posts = $row->mark_mod_posts == 1 ? true : false;
                                 $this->thread_sorting = $row->thread_sorting == 1? true : false;
                                 $this->setIsThreadRatingEnabled((bool)$row->thread_rating);
                                 $this->file_upload_allowed = $row->file_upload_allowed == 1 ? true : false;
 
                                 return true;
                         }
                         
                         return false;
                 }
                 
                 return false;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAddReSubject()

ilForumProperties::setAddReSubject ( $a_add_re_subject )

Definition at line 403 of file class.ilForumProperties.php.

Referenced by setSubjectSetting().

         {
                 $this->add_re_subject = $a_add_re_subject;
         }

Here is the caller graph for this function:

◆ setAdminForceNoti()

ilForumProperties::setAdminForceNoti ( $a_admin_force )

Definition at line 346 of file class.ilForumProperties.php.

         {
                 $this->admin_force_noti = $a_admin_force;
         }

◆ setAnonymisation()

ilForumProperties::setAnonymisation ( $a_anonymized )

Definition at line 305 of file class.ilForumProperties.php.

         {
                 $this->anonymized = $a_anonymized;
         }

◆ setDefaultView()

ilForumProperties::setDefaultView ( $a_default_view )

Definition at line 289 of file class.ilForumProperties.php.

         {
                 $this->default_view = $a_default_view;
         }

◆ setFileUploadAllowed()

ilForumProperties::setFileUploadAllowed ( $allowed )

Parameters

int $allowed

Exceptions

InvalidArgumentException

Definition at line 499 of file class.ilForumProperties.php.

         {
                 $this->file_upload_allowed = $allowed;
         }

◆ setIsThreadRatingEnabled()

ilForumProperties::setIsThreadRatingEnabled ( $is_thread_rating_enabled )

Parameters

boolean $is_thread_rating_enabled

Definition at line 284 of file class.ilForumProperties.php.

References $is_thread_rating_enabled.

Referenced by read().

         {
                 $this->is_thread_rating_enabled = (bool)$is_thread_rating_enabled;
         }

Here is the caller graph for this function:

◆ setMarkModeratorPosts()

ilForumProperties::setMarkModeratorPosts ( $a_mod_post )

Definition at line 460 of file class.ilForumProperties.php.

         {
                 $this->mark_mod_posts = $a_mod_post;
         }

◆ setNotificationType()

ilForumProperties::setNotificationType ( $a_notification_type )

Definition at line 412 of file class.ilForumProperties.php.

         {
                 if($a_notification_type == null)
                         $this->notification_type = 'default';
                 else
                         $this->notification_type = $a_notification_type;
         }

◆ setObjId()

ilForumProperties::setObjId ( $a_obj_id = 0 )

Definition at line 336 of file class.ilForumProperties.php.

References read().

         {
                 $this->obj_id = $a_obj_id;
                 $this->read();
         }

Here is the call graph for this function:

◆ setPostActivation()

ilForumProperties::setPostActivation ( $a_post_activation )

Definition at line 328 of file class.ilForumProperties.php.

         {
                 $this->post_activation_enabled = $a_post_activation;
         }       

◆ setPresetSubject()

ilForumProperties::setPresetSubject ( $a_preset_subject )

Definition at line 395 of file class.ilForumProperties.php.

Referenced by setSubjectSetting().

         {
                 $this->preset_subject = $a_preset_subject;
         }

Here is the caller graph for this function:

◆ setStatisticsStatus()

ilForumProperties::setStatisticsStatus ( $a_statistic_status )

Definition at line 297 of file class.ilForumProperties.php.

         {
                 $this->statistics_enabled = $a_statistic_status;
         }

◆ setSubjectSetting()

ilForumProperties::setSubjectSetting ( $a_subject_setting )

Definition at line 441 of file class.ilForumProperties.php.

References setAddReSubject(), and setPresetSubject().

         {
                 if($a_subject_setting == 'empty_subject')
                 {
                         $this->setPresetSubject(0);
                         $this->setAddReSubject(0);
                 }
                 else if($a_subject_setting == 'preset_subject')
                 {
                         $this->setPresetSubject(1);
                         $this->setAddReSubject(0);
                 }
                 else if($a_subject_setting == 'add_re_to_subject')
                 {
                         $this->setPresetSubject(0);
                         $this->setAddReSubject(1);
                 }
         }

Here is the call graph for this function:

◆ setThreadSorting()

ilForumProperties::setThreadSorting ( $a_thread_sorting )

Definition at line 470 of file class.ilForumProperties.php.

         {
                 $this->thread_sorting = $a_thread_sorting;
         }

◆ setUserToggleNoti()

ilForumProperties::setUserToggleNoti ( $a_user_toggle )

Definition at line 356 of file class.ilForumProperties.php.

         {
                 $this->user_toggle_noti = $a_user_toggle;
         }

◆ update()

ilForumProperties::update ( )

Definition at line 214 of file class.ilForumProperties.php.

References isIsThreadRatingEnabled().

         {
                 if ($this->obj_id)
                 {
                         $this->db->update('frm_settings',
                                 array(
                                         'default_view'        => array('integer', $this->default_view),
                                         'anonymized'          => array('integer', $this->anonymized),
                                         'statistics_enabled'  => array('integer', $this->statistics_enabled),
                                         'post_activation'     => array('integer', $this->post_activation_enabled),
                                         'admin_force_noti'    => array('integer', $this->admin_force_noti),
                                         'user_toggle_noti'    => array('integer', $this->user_toggle_noti),
                                         'preset_subject'      => array('integer', $this->preset_subject),
                                         'add_re_subject'      => array('integer', $this->add_re_subject),
                                         'notification_type'   => array('text', $this->notification_type),
                                         'mark_mod_posts'      => array('integer', $this->mark_mod_posts),
                                         'thread_sorting'      => array('integer', $this->thread_sorting),
                                         'thread_rating'       => array('integer', $this->isIsThreadRatingEnabled()),
                                         'file_upload_allowed' => array('integer', $this->file_upload_allowed)
                                 ),
                                 array(
                                         'obj_id' => array('integer', $this->obj_id)
                                 )
                         );
                         return true;
                 }               
                 return false;           
         }