Moving constants into class constants

skala
Julio Montoya 13 years ago
parent 7d85fdf268
commit df88d50a8f
  1. 4
      main/inc/lib/message.lib.php
  2. 140
      main/inc/lib/notification.lib.php
  3. 2
      main/inc/lib/social.lib.php
  4. 24
      main/survey/survey.lib.php

@ -285,7 +285,7 @@ class MessageManager
$sender_info = api_get_user_info($user_sender_id);
if (empty($group_id)) {
$notification->save_notification(NOTIFICATION_TYPE_MESSAGE, array($receiver_user_id), $subject, $content, $sender_info);
$notification->save_notification(Notification::NOTIFICATION_TYPE_MESSAGE, array($receiver_user_id), $subject, $content, $sender_info);
} else {
$group_info = GroupPortalManager::get_group_data($group_id);
$group_info['topic_id'] = $topic_id;
@ -301,7 +301,7 @@ class MessageManager
$new_user_list[] = $user_data['user_id'];
}
$group_info = array('group_info' => $group_info, 'user_info' => $sender_info);
$notification->save_notification(NOTIFICATION_TYPE_GROUP, $new_user_list, $subject, $content, $group_info);
$notification->save_notification(Notification::NOTIFICATION_TYPE_GROUP, $new_user_list, $subject, $content, $group_info);
}
return $inbox_last_id;
}

@ -1,56 +1,52 @@
<?php
/* For licensing terms, see /license.txt */
/**
* This class provides methods for the Notification management.
* Include/require it in your code to use its features.
* @package chamilo.library
*/
* This class provides methods for the Notification management.
* Include/require it in your code to use its features.
* @package chamilo.library
*/
/**
* Code
*/
//@todo put constants in an array
//default values
//mail_notify_message ("At once", "Daily", "No")
define('NOTIFY_MESSAGE_AT_ONCE', '1');
define('NOTIFY_MESSAGE_DAILY', '8');
define('NOTIFY_MESSAGE_WEEKLY', '12');
define('NOTIFY_MESSAGE_NO', '0');
//mail_notify_invitation ("At once", "Daily", "No")
define('NOTIFY_INVITATION_AT_ONCE', '1');
define('NOTIFY_INVITATION_DAILY', '8');
define('NOTIFY_INVITATION_WEEKLY', '12');
define('NOTIFY_INVITATION_NO', '0');
// mail_notify_group_message ("At once", "Daily", "No")
define('NOTIFY_GROUP_AT_ONCE', '1');
define('NOTIFY_GROUP_DAILY', '8');
define('NOTIFY_GROUP_WEEKLY', '12');
define('NOTIFY_GROUP_NO', '0');
define('NOTIFICATION_TYPE_MESSAGE', 1);
define('NOTIFICATION_TYPE_INVITATION', 2);
define('NOTIFICATION_TYPE_GROUP', 3);
/**
* Notification class
* @package chamilo.library
*/
class Notification extends Model {
var $table;
var $columns = array('id','dest_user_id','dest_mail','title','content','send_freq','created_at','sent_at');
var $max_content_length = 254; //Max lenght of the notification.content field
var $debug = false;
class Notification extends Model
{
public $table;
public $columns = array('id', 'dest_user_id', 'dest_mail', 'title', 'content', 'send_freq', 'created_at', 'sent_at');
public $max_content_length = 254; //Max lenght of the notification.content field
public $debug = false;
/* message, invitation, group messages */
var $type;
var $admin_name;
var $admin_email;
public function __construct() {
public $type;
public $admin_name;
public $admin_email;
//mail_notify_message ("At once", "Daily", "No")
const NOTIFY_MESSAGE_AT_ONCE = 1;
const NOTIFY_MESSAGE_DAILY = 8;
const NOTIFY_MESSAGE_WEEKLY = 12;
const NOTIFY_MESSAGE_NO = 0;
//mail_notify_invitation ("At once", "Daily", "No")
const NOTIFY_INVITATION_AT_ONCE = 1;
const NOTIFY_INVITATION_DAILY = 8;
const NOTIFY_INVITATION_WEEKLY = 12;
const NOTIFY_INVITATION_NO = 0;
// mail_notify_group_message ("At once", "Daily", "No")
const NOTIFY_GROUP_AT_ONCE = 1;
const NOTIFY_GROUP_DAILY = 8;
const NOTIFY_GROUP_WEEKLY = 12;
const NOTIFY_GROUP_NO = 0;
const NOTIFICATION_TYPE_MESSAGE = 1;
const NOTIFICATION_TYPE_INVITATION = 2;
const NOTIFICATION_TYPE_GROUP = 3;
public function __construct()
{
$this->table = Database::get_main_table(TABLE_NOTIFICATION);
$this->admin_email = api_get_setting('noreply_email_address');
@ -67,27 +63,24 @@ class Notification extends Model {
* Send the notifications
* @param int notification frecuency
*/
public function send($frec = NOTIFY_MESSAGE_DAILY) {
$notifications = $this->find('all',array('where'=>array('sent_at IS NULL AND send_freq = ?'=>$frec)));
public function send($frec = 8)
{
$notifications = $this->find('all', array('where' => array('sent_at IS NULL AND send_freq = ?' => $frec)));
if (!empty($notifications)) {
foreach ($notifications as $item_to_send) {
//Sending email
api_mail_html($item_to_send['dest_mail'],
$item_to_send['dest_mail'],
Security::filter_terms($item_to_send['title']),
Security::filter_terms($item_to_send['content']),
$this->admin_name,
$this->admin_email
);
if ($this->debug) { error_log('Sending message to: '.$item_to_send['dest_mail']); }
api_mail_html($item_to_send['dest_mail'], $item_to_send['dest_mail'], Security::filter_terms($item_to_send['title']), Security::filter_terms($item_to_send['content']), $this->admin_name, $this->admin_email);
if ($this->debug) {
error_log('Sending message to: '.$item_to_send['dest_mail']);
}
//Updating
$item_to_send['sent_at'] = api_get_utc_datetime();
$this->update($item_to_send);
if ($this->debug) { error_log('Updating record : '.print_r($item_to_send,1)); }
if ($this->debug) {
error_log('Updating record : '.print_r($item_to_send, 1));
}
}
}
}
@ -100,7 +93,8 @@ class Notification extends Model {
* @param string content of the message
* @param array result of api_get_user_info() or GroupPortalManager:get_group_data()
*/
public function save_notification($type, $user_list, $title, $content, $sender_info = array()) {
public function save_notification($type, $user_list, $title, $content, $sender_info = array())
{
$this->type = intval($type);
$content = $this->format_content($content, $sender_info);
@ -108,17 +102,17 @@ class Notification extends Model {
$avoid_my_self = false;
switch ($this->type) {
case NOTIFICATION_TYPE_MESSAGE;
case self::NOTIFICATION_TYPE_MESSAGE;
$setting_to_check = 'mail_notify_message';
$default_status = NOTIFY_MESSAGE_AT_ONCE;
$default_status = self::NOTIFY_MESSAGE_AT_ONCE;
break;
case NOTIFICATION_TYPE_INVITATION;
case self::NOTIFICATION_TYPE_INVITATION;
$setting_to_check = 'mail_notify_invitation';
$default_status = NOTIFY_INVITATION_AT_ONCE;
$default_status = self::NOTIFY_INVITATION_AT_ONCE;
break;
case NOTIFICATION_TYPE_GROUP;
case self::NOTIFICATION_TYPE_GROUP;
$setting_to_check = 'mail_notify_group_message';
$default_status = NOTIFY_GROUP_AT_ONCE;
$default_status = self::NOTIFY_GROUP_AT_ONCE;
$avoid_my_self = true;
break;
}
@ -146,14 +140,14 @@ class Notification extends Model {
switch ($user_setting) {
//No notifications
case NOTIFY_MESSAGE_NO:
case NOTIFY_INVITATION_NO:
case NOTIFY_GROUP_NO:
case self::NOTIFY_MESSAGE_NO:
case self::NOTIFY_INVITATION_NO:
case self::NOTIFY_GROUP_NO:
break;
//Send notification right now!
case NOTIFY_MESSAGE_AT_ONCE:
case NOTIFY_INVITATION_AT_ONCE:
case NOTIFY_GROUP_AT_ONCE:
case self::NOTIFY_MESSAGE_AT_ONCE:
case self::NOTIFY_INVITATION_AT_ONCE:
case self::NOTIFY_GROUP_AT_ONCE:
if (!empty($user_info['mail'])) {
$name = api_get_person_name($user_info['firstname'], $user_info['lastname']);
if (!empty($sender_info['complete_name']) && !empty($sender_info['email'])) {
@ -185,11 +179,12 @@ class Notification extends Model {
* @param string the content
* @param array result of api_get_user_info() or GroupPortalManager:get_group_data()
* */
public function format_content($content, $sender_info) {
public function format_content($content, $sender_info)
{
$new_message_text = $link_to_new_message = '';
switch($this->type) {
case NOTIFICATION_TYPE_MESSAGE:
switch ($this->type) {
case self::NOTIFICATION_TYPE_MESSAGE:
if (!empty($sender_info)) {
$sender_name = api_get_person_name($sender_info['firstname'], $sender_info['lastname'], null, PERSON_NAME_EMAIL_ADDRESS);
//$sender_mail = $sender_info['email'] ;
@ -197,7 +192,7 @@ class Notification extends Model {
}
$link_to_new_message = Display::url(get_lang('SeeMessage'), api_get_path(WEB_CODE_PATH).'messages/inbox.php');
break;
case NOTIFICATION_TYPE_INVITATION:
case self::NOTIFICATION_TYPE_INVITATION:
if (!empty($sender_info)) {
$sender_name = api_get_person_name($sender_info['firstname'], $sender_info['lastname'], null, PERSON_NAME_EMAIL_ADDRESS);
//$sender_mail = $sender_info['email'] ;
@ -205,15 +200,14 @@ class Notification extends Model {
}
$link_to_new_message = Display::url(get_lang('SeeInvitation'), api_get_path(WEB_CODE_PATH).'social/invitations.php');
break;
case NOTIFICATION_TYPE_GROUP:
case self::NOTIFICATION_TYPE_GROUP:
$topic_page = intval($_REQUEST['topics_page_nr']);
if (!empty($sender_info)) {
$sender_name = $sender_info['group_info']['name'];
$new_message_text = sprintf(get_lang('YouHaveReceivedANewMessageInTheGroupX'), $sender_name);
$sender_name = api_get_person_name($sender_info['user_info']['firstname'], $sender_info['user_info']['lastname'], null, PERSON_NAME_EMAIL_ADDRESS);
$sender_name = Display::url($sender_name , api_get_path(WEB_CODE_PATH).'social/profile.php?'.$sender_info['user_info']['user_id']);
$sender_name = Display::url($sender_name, api_get_path(WEB_CODE_PATH).'social/profile.php?'.$sender_info['user_info']['user_id']);
$new_message_text .= '<br />'.get_lang('User').': '.$sender_name;
}
$group_url = api_get_path(WEB_CODE_PATH).'social/group_topics.php?id='.$sender_info['group_info']['id'].'&topic_id='.$sender_info['group_info']['topic_id'].'&msg_id='.$sender_info['group_info']['msg_id'].'&topics_page_nr='.$topic_page;
$link_to_new_message = Display::url(get_lang('SeeMessage'), $group_url);

@ -197,7 +197,7 @@ class SocialManager extends UserManager {
$sender_info = api_get_user_info($user_id);
$notification = new Notification();
$notification->save_notification(NOTIFICATION_TYPE_INVITATION, array($friend_id), $message_title, $message_content, $sender_info);
$notification->save_notification(Notification::NOTIFICATION_TYPE_INVITATION, array($friend_id), $message_title, $message_content, $sender_info);
return true;
} else {

@ -26,6 +26,12 @@ $htmlHeadXtra[] = '<script>
class survey_manager {
/**
* Deletes all survey invitations of a user
* @param int $user_id
* @return boolean
* @assert ('') === false
*/
public static function delete_all_survey_invitations_by_user($user_id) {
$user_id = intval($user_id);
@ -36,9 +42,18 @@ class survey_manager {
$sql = "DELETE FROM $table_survey_invitation WHERE user = '$user_id'";
Database::query($sql);
}
/**
*
* @param type $course_code
* @param type $session_id
* @return type
* @assert ('') === false
*/
public static function get_surveys($course_code, $session_id = 0) {
$table_survey = Database :: get_course_table(TABLE_SURVEY);
if (empty($course_code)) {
return false;
}
$course_info = api_get_course_info($course_code);
$session_condition = api_get_session_condition($session_id, true, true);
@ -48,12 +63,8 @@ class survey_manager {
return $result;
}
/***
* SYRVEY FUNCTIONS
*/
/**
* This function retrieves all the survey information
* Retrieves all the survey information
*
* @param integer $survey_id the id of the survey
* @param boolean $shared this parameter determines if we have to get the information of a survey from the central (shared) database or from the
@ -62,6 +73,7 @@ class survey_manager {
*
* @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
* @version February 2007
* @assert ('') === false
*
* @todo this is the same function as in create_new_survey.php
*/

Loading…
Cancel
Save