Collaboration diagram for ilForumProperties:

Public Member Functions
	insert ()

	update ()

	copy (int $a_new_obj_id)

	isIsThreadRatingEnabled ()

	setIsThreadRatingEnabled (bool $is_thread_rating_enabled)

	setDefaultView (int $a_default_view)

	getDefaultView ()

	setStatisticsStatus (bool $a_statistic_status)

	isStatisticEnabled ()

	setAnonymisation (bool $a_anonymized)

	isAnonymized ()

	setPostActivation (bool $a_post_activation)

	isPostActivationEnabled ()

	setObjId (int $a_obj_id)

	getObjId ()

	setAdminForceNoti (bool $a_admin_force)

	isAdminForceNoti ()

	setUserToggleNoti (bool $a_user_toggle)

	isUserToggleNoti ()

	setPresetSubject (bool $a_preset_subject)

	isSubjectPreset ()

	setAddReSubject (bool $a_add_re_subject)

	isSubjectAdded ()

	setNotificationType (NotificationType $a_notification_type)

	getNotificationType ()

	getSubjectSetting ()

	setSubjectSetting ($a_subject_setting)

	setMarkModeratorPosts (bool $a_mod_post)

	getMarkModeratorPosts ()

	getUserToggleNoti ()

	getAdminForceNoti ()

	setFileUploadAllowed (bool $allowed)

	getFileUploadAllowed ()

	isFileUploadAllowed ()

	getInterestedEvents ()

	setInterestedEvents (int $interested_events)

	getLpReqNumPostings ()

	setLpReqNumPostings (?int $lp_req_num_postings)

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

static	_isAnonymized (int $a_obj_id)

static	_isAdminForceNoti (int $a_obj_id)

static	_isUserToggleNoti (int $a_obj_id)

static	isFileUploadGloballyAllowed ()

static	isSendAttachmentsByMailEnabled ()

Data Fields
const	VIEW_TREE = 1

const	VIEW_DATE = 2

const	VIEW_DATE_ASC = 2

const	VIEW_DATE_DESC = 3

const	FILE_UPLOAD_GLOBALLY_ALLOWED = 0

const	FILE_UPLOAD_INDIVIDUAL = 1

const	PAGE_SIZE_THREAD_OVERVIEW = 10

const	PAGE_NAME_THREAD_OVERVIEW = 'page'

Protected Member Functions
	__construct (private int $obj_id=0)

Protected Attributes
int	$styleId = 0

ILIAS Style Content Object ObjectFacade	$content_style_service

Private Member Functions
	read ()

Private Attributes
readonly ilDBInterface	$db

int	$default_view = self::VIEW_DATE_ASC

bool	$anonymized = false

bool	$statistics_enabled = false

bool	$post_activation_enabled = false

NotificationType	$notification_type = NotificationType::DEFAULT

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

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

bool	$preset_subject = true
	If deactivated, user is forced to enter a new subject on repliees. More...

int	$interested_events = ilForumNotificationEvents::DEACTIVATED
	Preset notification events for forced notification. More...

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

bool	$mark_mod_posts = false

bool	$is_thread_rating_enabled = false

bool	$file_upload_allowed = false

bool	$exists = false

int	$lp_req_num_postings = null

Static Private Attributes
static array	$instances = []

Detailed Description

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

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

Constructor & Destructor Documentation

◆ __construct()

ilForumProperties::__construct ( private int $obj_id = 0 )

protected

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

References $DIC, and read().

     {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->read();
         $this->content_style_service = $DIC
             ->contentStyle()
             ->domain()
             ->styleForObjId($obj_id);
     }

Here is the call graph for this function:

Member Function Documentation

◆ _isAdminForceNoti()

static ilForumProperties::_isAdminForceNoti ( int $a_obj_id )

static

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

References $DIC, $ilDB, and $res.

Referenced by ilForumNotification\checkForumsExistsInsert().

                                                            : bool
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $res = $ilDB->queryF(
             'SELECT admin_force_noti FROM frm_settings WHERE obj_id = %s',
             ['integer'],
             [$a_obj_id]
         );
         if ($record = $ilDB->fetchAssoc($res)) {
             return (bool) $record['admin_force_noti'];
         }
 
         return false;
     }

Here is the caller graph for this function:

◆ _isAnonymized()

static ilForumProperties::_isAnonymized ( int $a_obj_id )

static

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

References $DIC, and $ilDB.

Referenced by ilPDNewsTableGUI\fillRow().

                                                        : bool
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $result = $ilDB->queryF(
             'SELECT anonymized FROM frm_settings WHERE obj_id = %s',
             ['integer'],
             [$a_obj_id]
         );
 
         while ($record = $ilDB->fetchAssoc($result)) {
             return (bool) $record['anonymized'];
         }
 
         return false;
     }

Here is the caller graph for this function:

◆ _isUserToggleNoti()

static ilForumProperties::_isUserToggleNoti ( int $a_obj_id )

static

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

References $DIC, $ilDB, and $res.

Referenced by ilForumNotification\checkForumsExistsInsert().

                                                            : bool
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $res = $ilDB->queryF(
             'SELECT user_toggle_noti FROM frm_settings WHERE obj_id = %s',
             ['integer'],
             [$a_obj_id]
         );
         while ($record = $ilDB->fetchAssoc($res)) {
             return (bool) $record['user_toggle_noti'];
         }
 
         return false;
     }

Here is the caller graph for this function:

◆ copy()

ilForumProperties::copy ( int $a_new_obj_id )

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

                                            : bool
     {
         if ($a_new_obj_id !== 0) {
             $this->content_style_service->cloneTo($a_new_obj_id);
 
             $this->db->update(
                 'frm_settings',
                 [
                     'default_view' => ['integer', $this->default_view],
                     'anonymized' => ['integer', (int) $this->anonymized],
                     'statistics_enabled' => ['integer', (int) $this->statistics_enabled],
                     'post_activation' => ['integer', (int) $this->post_activation_enabled],
                     'admin_force_noti' => ['integer', (int) $this->admin_force_noti],
                     'user_toggle_noti' => ['integer', (int) $this->user_toggle_noti],
                     'preset_subject' => ['integer', (int) $this->preset_subject],
                     'add_re_subject' => ['integer', (int) $this->add_re_subject],
                     'notification_type' => ['text', $this->notification_type->value],
                     'mark_mod_posts' => ['integer', (int) $this->mark_mod_posts],
                     'thread_rating' => ['integer', (int) $this->is_thread_rating_enabled],
                     'file_upload_allowed' => ['integer', (int) $this->file_upload_allowed],
                     'lp_req_num_postings' => ['integer', $this->lp_req_num_postings],
                     'interested_events' => ['integer', $this->interested_events]
                 ],
                 [
                     'obj_id' => ['integer', $a_new_obj_id]
                 ]
             );
 
             return true;
         }
 
         return false;
     }

◆ getAdminForceNoti()

ilForumProperties::getAdminForceNoti ( )

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

References $admin_force_noti.

                                        : bool
     {
         return $this->admin_force_noti;
     }

◆ getDefaultView()

ilForumProperties::getDefaultView ( )

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

References $default_view.

                                     : int
     {
         return $this->default_view;
     }

◆ getFileUploadAllowed()

ilForumProperties::getFileUploadAllowed ( )

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

References $file_upload_allowed.

Referenced by isFileUploadAllowed().

                                           : bool
     {
         return $this->file_upload_allowed;
     }

Here is the caller graph for this function:

◆ getInstance()

static ilForumProperties::getInstance ( int $a_obj_id = 0 )

static

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

Referenced by ilForumExportGUI\__construct(), ilObjForumGUI\__construct(), ilLPStatusContributionToDiscussion\_getCompleted(), ilLPStatusContributionToDiscussion\_getInProgress(), ilForumModeratorsGUI\addModerator(), ilForumLP\appendModeConfiguration(), ilObjForum\create(), ilForumModeratorsGUI\detachModeratorRole(), ilLPStatusContributionToDiscussion\determineStatus(), ilForum\getAllThreads(), ilForumLP\getModeText(), ilForumTopic\getNestedSetPostChildren(), ilForum\getOneThread(), ilObjForumListGUI\getProperties(), ilForumXMLParser\handlerEndTag(), ilObjForum\lookupStatisticsByRefId(), ilForumExportGUI\renderPostHtml(), ilForumLP\saveModeConfiguration(), ilObjForum\update(), and ilForumSettingsGUI\updateNotificationSettings().

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

Here is the caller graph for this function:

◆ getInterestedEvents()

ilForumProperties::getInterestedEvents ( )

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

References $interested_events.

Referenced by ilForumNotification\updateUserNotifications().

                                          : int
     {
         return $this->interested_events;
     }

Here is the caller graph for this function:

◆ getLpReqNumPostings()

ilForumProperties::getLpReqNumPostings ( )

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

References $lp_req_num_postings.

                                          : ?int
     {
         return $this->lp_req_num_postings;
     }

◆ getMarkModeratorPosts()

ilForumProperties::getMarkModeratorPosts ( )

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

References $mark_mod_posts.

                                            : bool
     {
         return $this->mark_mod_posts;
     }

◆ getNotificationType()

ilForumProperties::getNotificationType ( )

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

References $notification_type.

Referenced by ilForumNotification\updateUserNotifications().

                                          : NotificationType
     {
         return $this->notification_type;
     }

Here is the caller graph for this function:

◆ getObjId()

ilForumProperties::getObjId ( )

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

                               : int
     {
         return $this->obj_id;
     }

◆ getSubjectSetting()

ilForumProperties::getSubjectSetting ( )

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

References isSubjectAdded(), and isSubjectPreset().

                                        : string
     {
         if (!$this->isSubjectPreset() && !$this->isSubjectAdded()) {
             return "empty_subject";
         }
 
         if ($this->isSubjectPreset()) {
             return "preset_subject";
         }
 
         if ($this->isSubjectAdded()) {
             return "add_re_to_subject";
         }
 
         return "preset_subject";
     }

Here is the call graph for this function:

◆ getUserToggleNoti()

ilForumProperties::getUserToggleNoti ( )

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

References $user_toggle_noti.

                                        : bool
     {
         return $this->user_toggle_noti;
     }

◆ insert()

ilForumProperties::insert ( )

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

Referenced by update().

                             : void
     {
         if ($this->obj_id && !$this->exists) {
             $this->db->insert(
                 'frm_settings',
                 [
                     'obj_id' => ['integer', $this->obj_id],
                     'default_view' => ['integer', $this->default_view],
                     'anonymized' => ['integer', (int) $this->anonymized],
                     'statistics_enabled' => ['integer', (int) $this->statistics_enabled],
                     'post_activation' => ['integer', (int) $this->post_activation_enabled],
                     'admin_force_noti' => ['integer', (int) $this->admin_force_noti],
                     'user_toggle_noti' => ['integer', (int) $this->user_toggle_noti],
                     'preset_subject' => ['integer', (int) $this->preset_subject],
                     'add_re_subject' => ['integer', (int) $this->add_re_subject],
                     'notification_type' => ['text', $this->notification_type->value],
                     'mark_mod_posts' => ['integer', (int) $this->mark_mod_posts],
                     'thread_rating' => ['integer', (int) $this->is_thread_rating_enabled],
                     'file_upload_allowed' => ['integer', (int) $this->file_upload_allowed],
                     'lp_req_num_postings' => ['integer', $this->lp_req_num_postings],
                     'interested_events' => ['integer', $this->interested_events]
                 ]
             );
             $this->exists = true;
         }
     }

Here is the caller graph for this function:

◆ isAdminForceNoti()

ilForumProperties::isAdminForceNoti ( )

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

References $admin_force_noti.

                                       : bool
     {
         return $this->admin_force_noti;
     }

◆ isAnonymized()

ilForumProperties::isAnonymized ( )

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

References $anonymized.

                                   : bool
     {
         return $this->anonymized;
     }

◆ isFileUploadAllowed()

ilForumProperties::isFileUploadAllowed ( )

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

References getFileUploadAllowed().

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

Here is the call graph for this function:

◆ isFileUploadGloballyAllowed()

static ilForumProperties::isFileUploadGloballyAllowed ( )

static

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

References $DIC.

Referenced by ilForumSettingsGUI\getCustomForm(), and ilForumSettingsGUI\updateCustomValues().

                                                         : bool
     {
         global $DIC;
 
         return (
             (int) $DIC->settings()->get('file_upload_allowed_fora') === self::FILE_UPLOAD_GLOBALLY_ALLOWED
         );
     }

Here is the caller graph for this function:

◆ isIsThreadRatingEnabled()

ilForumProperties::isIsThreadRatingEnabled ( )

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

References $is_thread_rating_enabled.

                                              : bool
     {
         return $this->is_thread_rating_enabled;
     }

◆ isPostActivationEnabled()

ilForumProperties::isPostActivationEnabled ( )

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

References $post_activation_enabled.

                                              : bool
     {
         return $this->post_activation_enabled;
     }

◆ isSendAttachmentsByMailEnabled()

static ilForumProperties::isSendAttachmentsByMailEnabled ( )

static

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

References $DIC.

Referenced by ilForumCronNotificationDataProvider\readAttachments(), and ilForumNotificationDataProvider\readAttachments().

                                                            : bool
     {
         global $DIC;
 
         return (bool) $DIC->settings()->get('send_attachments_by_mail');
     }

Here is the caller graph for this function:

◆ isStatisticEnabled()

ilForumProperties::isStatisticEnabled ( )

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

References $statistics_enabled.

                                         : bool
     {
         return $this->statistics_enabled;
     }

◆ isSubjectAdded()

ilForumProperties::isSubjectAdded ( )

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

References $add_re_subject.

Referenced by getSubjectSetting().

                                     : bool
     {
         return $this->add_re_subject;
     }

Here is the caller graph for this function:

◆ isSubjectPreset()

ilForumProperties::isSubjectPreset ( )

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

References $preset_subject.

Referenced by getSubjectSetting().

                                      : bool
     {
         return $this->preset_subject;
     }

Here is the caller graph for this function:

◆ isUserToggleNoti()

ilForumProperties::isUserToggleNoti ( )

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

References $user_toggle_noti.

Referenced by ilForumNotification\updateUserNotifications().

                                       : bool
     {
         return $this->user_toggle_noti;
     }

Here is the caller graph for this function:

◆ read()

ilForumProperties::read ( )

private

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

References $res, ILIAS\Forum\Notification\DEFAULT, if, and ILIAS\Repository\int().

Referenced by __construct(), and setObjId().

                            : void
     {
         if ($this->obj_id !== 0) {
             $res = $this->db->queryF(
                 'SELECT * FROM frm_settings WHERE obj_id = %s',
                 ['integer'],
                 [$this->obj_id]
             );
 
             $row = $this->db->fetchObject($res);
             if (is_object($row)) {
                 $this->exists = true;
 
                 $this->default_view = (int) $row->default_view;
                 $this->anonymized = (bool) $row->anonymized;
                 $this->statistics_enabled = (bool) $row->statistics_enabled;
                 $this->post_activation_enabled = (bool) $row->post_activation;
                 $this->admin_force_noti = (bool) $row->admin_force_noti;
                 $this->user_toggle_noti = (bool) $row->user_toggle_noti;
                 $this->preset_subject = (bool) $row->preset_subject;
                 $this->add_re_subject = (bool) $row->add_re_subject;
                 $this->interested_events = (int) $row->interested_events;
 
                 $this->notification_type =
                     NotificationType::tryFrom($row->notification_type ?? NotificationType::DEFAULT->value) ??
                     NotificationType::DEFAULT;
                 $this->mark_mod_posts = (bool) $row->mark_mod_posts;
                 $this->is_thread_rating_enabled = (bool) $row->thread_rating;
                 $this->file_upload_allowed = (bool) $row->file_upload_allowed;
                 if (is_numeric($row->lp_req_num_postings)) {
                     $this->lp_req_num_postings = (int) $row->lp_req_num_postings;
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAddReSubject()

ilForumProperties::setAddReSubject ( bool $a_add_re_subject )

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

Referenced by setSubjectSetting().

                                                            : void
     {
         $this->add_re_subject = $a_add_re_subject;
     }

Here is the caller graph for this function:

◆ setAdminForceNoti()

ilForumProperties::setAdminForceNoti ( bool $a_admin_force )

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

                                                           : void
     {
         $this->admin_force_noti = $a_admin_force;
     }

◆ setAnonymisation()

ilForumProperties::setAnonymisation ( bool $a_anonymized )

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

                                                         : void
     {
         $this->anonymized = $a_anonymized;
     }

◆ setDefaultView()

ilForumProperties::setDefaultView ( int $a_default_view )

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

                                                        : void
     {
         $this->default_view = $a_default_view;
     }

◆ setFileUploadAllowed()

ilForumProperties::setFileUploadAllowed ( bool $allowed )

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

                                                        : void
     {
         $this->file_upload_allowed = $allowed;
     }

◆ setInterestedEvents()

ilForumProperties::setInterestedEvents ( int $interested_events )

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

References $interested_events.

                                                                : void
     {
         $this->interested_events = $interested_events;
     }

◆ setIsThreadRatingEnabled()

ilForumProperties::setIsThreadRatingEnabled ( bool $is_thread_rating_enabled )

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

References $is_thread_rating_enabled.

                                                                             : void
     {
         $this->is_thread_rating_enabled = $is_thread_rating_enabled;
     }

◆ setLpReqNumPostings()

ilForumProperties::setLpReqNumPostings ( ?int $lp_req_num_postings )

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

References $lp_req_num_postings.

                                                                   : void
     {
         $this->lp_req_num_postings = $lp_req_num_postings;
     }

◆ setMarkModeratorPosts()

ilForumProperties::setMarkModeratorPosts ( bool $a_mod_post )

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

                                                            : void
     {
         $this->mark_mod_posts = $a_mod_post;
     }

◆ setNotificationType()

ilForumProperties::setNotificationType ( NotificationType $a_notification_type )

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

                                                                               : void
     {
         $this->notification_type = $a_notification_type;
     }

◆ setObjId()

ilForumProperties::setObjId ( int $a_obj_id )

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

References read().

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

Here is the call graph for this function:

◆ setPostActivation()

ilForumProperties::setPostActivation ( bool $a_post_activation )

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

                                                               : void
     {
         $this->post_activation_enabled = $a_post_activation;
     }

◆ setPresetSubject()

ilForumProperties::setPresetSubject ( bool $a_preset_subject )

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

Referenced by setSubjectSetting().

                                                             : void
     {
         $this->preset_subject = $a_preset_subject;
     }

Here is the caller graph for this function:

◆ setStatisticsStatus()

ilForumProperties::setStatisticsStatus ( bool $a_statistic_status )

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

                                                                  : void
     {
         $this->statistics_enabled = $a_statistic_status;
     }

◆ setSubjectSetting()

ilForumProperties::setSubjectSetting ( $a_subject_setting )

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

References setAddReSubject(), and setPresetSubject().

                                                          : void
     {
         if ($a_subject_setting === 'empty_subject') {
             $this->setPresetSubject(false);
             $this->setAddReSubject(false);
         } elseif ($a_subject_setting === 'preset_subject') {
             $this->setPresetSubject(true);
             $this->setAddReSubject(false);
         } elseif ($a_subject_setting === 'add_re_to_subject') {
             $this->setPresetSubject(false);
             $this->setAddReSubject(true);
         }
     }

Here is the call graph for this function:

◆ setUserToggleNoti()

ilForumProperties::setUserToggleNoti ( bool $a_user_toggle )

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

                                                           : void
     {
         $this->user_toggle_noti = $a_user_toggle;
     }

◆ update()

ilForumProperties::update ( )

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

References insert().

                             : void
     {
         if ($this->obj_id !== 0) {
             if (!$this->exists) {
                 $this->insert();
                 return;
             }
 
             $this->db->update(
                 'frm_settings',
                 [
                     'default_view' => ['integer', $this->default_view],
                     'anonymized' => ['integer', (int) $this->anonymized],
                     'statistics_enabled' => ['integer', (int) $this->statistics_enabled],
                     'post_activation' => ['integer', (int) $this->post_activation_enabled],
                     'admin_force_noti' => ['integer', (int) $this->admin_force_noti],
                     'user_toggle_noti' => ['integer', (int) $this->user_toggle_noti],
                     'preset_subject' => ['integer', (int) $this->preset_subject],
                     'add_re_subject' => ['integer', (int) $this->add_re_subject],
                     'notification_type' => ['text', $this->notification_type->value],
                     'mark_mod_posts' => ['integer', (int) $this->mark_mod_posts],
                     'thread_rating' => ['integer', (int) $this->is_thread_rating_enabled],
                     'file_upload_allowed' => ['integer', (int) $this->file_upload_allowed],
                     'lp_req_num_postings' => ['integer', (int) $this->lp_req_num_postings],
                     'interested_events' => ['integer', $this->interested_events]
                 ],
                 [
                     'obj_id' => ['integer', $this->obj_id]
                 ]
             );
         }
     }