Skip to content

Commit

Permalink
main messaging library
Browse files Browse the repository at this point in the history
  • Loading branch information
@jrmadsen67
jrmadsen67 committed Jul 5, 2011
1 parent 2bdb1e4 commit 6e948d1
Show file tree
Hide file tree
Showing 5 changed files with 638 additions and 0 deletions.
35 changes: 35 additions & 0 deletions application/config/mahana.php
View file
@@ -0,0 +1,35 @@
<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');

// application's Users table - define your user table and columns here

define('USER_TABLE_TABLENAME', 'users u');
define('USER_TABLE_ID', 'u.id');
define('USER_TABLE_USERNAME', 'CONCAT(u.first_name, " ", u.last_name) as user_name');


// message statuses
define('MSG_STATUS_UNREAD', 0);
define('MSG_STATUS_READ', 1);
define('MSG_STATUS_ARCHIVED', 2);

// priority
define('PRIORITY_LOW', 1);
define('PRIORITY_NORMAL', 2);
define('PRIORITY_HIGH', 3);
define('PRIORITY_URGENT', 4);

// status return message codes
define('MSG_SUCCESS', 0);
define('MSG_ERR_GENERAL', 1);
define('MSG_ERR_INVALID_USER_ID', 2);
define('MSG_ERR_INVALID_MSG_ID', 3);
define('MSG_ERR_INVALID_THREAD_ID', 4);
define('MSG_ERR_INVALID_STATUS_ID', 5);
define('MSG_ERR_INVALID_SENDER_ID', 6);
define('MSG_ERR_INVALID_RECIPIENTS', 7);
define('MSG_MESSAGE_SENT', 8);
define('MSG_STATUS_UPDATE', 9);
define('MSG_PARTICIPANT_ADDED', 10);
define('MSG_ERR_PARTICIPANT_EXISTS', 11);
define('MSG_ERR_PARTICIPANT_NONSYSTEM', 12);
define('MSG_PARTICIPANT_REMOVED', 13);
17 changes: 17 additions & 0 deletions application/language/english/mahana_lang.php
View file
@@ -0,0 +1,17 @@
<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');

// Account Creation
$lang['mahana_'.MSG_SUCCESS] = 'Success';
$lang['mahana_'.MSG_ERR_GENERAL] = 'Error';
$lang['mahana_'.MSG_ERR_INVALID_USER_ID] = 'No user id specified';
$lang['mahana_'.MSG_ERR_INVALID_MSG_ID] = 'No message id specified';
$lang['mahana_'.MSG_ERR_INVALID_THREAD_ID] = 'No message thread id specified';
$lang['mahana_'.MSG_ERR_INVALID_STATUS_ID] = 'No status specified';
$lang['mahana_'.MSG_ERR_INVALID_SENDER_ID] = 'Not a valid sender';
$lang['mahana_'.MSG_ERR_INVALID_RECIPIENTS] = 'No valid recipients';
$lang['mahana_'.MSG_MESSAGE_SENT] = 'Message sent';
$lang['mahana_'.MSG_STATUS_UPDATE] = 'Status updated';
$lang['mahana_'.MSG_PARTICIPANT_ADDED] = 'Participant added';
$lang['mahana_'.MSG_ERR_PARTICIPANT_EXISTS] = 'User is already participating in this thread';
$lang['mahana_'.MSG_ERR_PARTICIPANT_NONSYSTEM] = 'This user id is not in the system';
$lang['mahana_'.MSG_PARTICIPANT_REMOVED] = 'Participant removed from thread';
221 changes: 221 additions & 0 deletions application/libraries/Mahana_messaging.php
View file
@@ -0,0 +1,221 @@
<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/**
* Name: Mahana Messaging Library for CodeIgniter
*
* Author: Jeff Madsen
* jrmadsen67@gmail.com
*
* Location: - will be on github shortly
*
* Description: CI library for linking to application's existing user table and creating basis of an internal messaging system
* No views or controllers included - DO CHECK the README.txt for setup instructions and notes
*
*/

class Mahana_messaging
{


public function __construct()
{

$this->ci =& get_instance();
require_once(APPPATH.'config/mahana.php');

$this->ci->load->model('mahana_model');
$this->ci->load->helper('language');
$this->ci->lang->load('mahana');


}

/*
function get_message() - will return a single message, including the status for specified user.
@parameters - $msg_id REQUIRED, $user_id REQUIRED
*/

function get_message($msg_id, $user_id)
{
$status = array('err'=>1, 'code'=>MSG_ERR_GENERAL, 'msg'=>lang('mahana_'.MSG_ERR_GENERAL));

if (empty($msg_id)){$status = array('err'=>1, 'code'=>MSG_ERR_INVALID_MSG_ID, 'msg'=>lang('mahana_'.MSG_ERR_INVALID_MSG_ID));return $status;}
if (empty($user_id)){$status = array('err'=>1, 'code'=>MSG_ERR_INVALID_USER_ID, 'msg'=>lang('mahana_'.MSG_ERR_INVALID_USER_ID));return $status;}

if ($message = $this->ci->mahana_model->get_message($msg_id, $user_id))
{
return $status = array('err'=>0, 'code'=>MSG_SUCCESS, 'msg'=>lang('mahana_'.MSG_SUCCESS), 'retval'=>$message);
}
return $status;
}


/*
function get_full_thread() - will return a entire thread, including the status for specified user.
@parameters - $thread_id REQUIRED, $user_id REQUIRED, $order_by OPTIONAL
- $full_thread - if true, user will also see messages from thread posted BEFORE user became participant
*/

function get_full_thread($thread_id, $user_id, $full_thread=false, $order_by='asc')
{
$status = array('err'=>1, 'code'=>MSG_ERR_GENERAL, 'msg'=>lang('mahana_'.MSG_ERR_GENERAL));

if (empty($thread_id)){$status = array('err'=>1, 'code'=>MSG_ERR_INVALID_THREAD_ID, 'msg'=>lang('mahana_'.MSG_ERR_INVALID_THREAD_ID));return $status;}
if (empty($user_id)){$status = array('err'=>1, 'code'=>MSG_ERR_INVALID_USER_ID, 'msg'=>lang('mahana_'.MSG_ERR_INVALID_USER_ID));return $status;}

if ($message = $this->ci->mahana_model->get_full_thread($thread_id, $user_id, $full_thread, $order_by))
{
return $status = array('err'=>0, 'code'=>MSG_SUCCESS, 'msg'=>lang('mahana_'.MSG_SUCCESS), 'retval'=>$message);
}
return $status;
}

/*
function get_all_threads() - will return all threads for user, including the status for specified user.
@parameters - $user_id REQUIRED, $order_by OPTIONAL
- $full_thread - if true, user will also see messages from thread posted BEFORE user became participant
*/

function get_all_threads($user_id, $full_thread=false, $order_by='asc')
{
$status = array('err'=>1, 'code'=>MSG_ERR_GENERAL, 'msg'=>lang('mahana_'.MSG_ERR_GENERAL));

if (empty($user_id)){$status = array('err'=>1, 'code'=>MSG_ERR_INVALID_USER_ID, 'msg'=>lang('mahana_'.MSG_ERR_INVALID_USER_ID));return $status;}

if ($message = $this->ci->mahana_model->get_all_threads($user_id, $full_thread, $order_by))
{
return $status = array('err'=>0, 'code'=>MSG_SUCCESS, 'msg'=>lang('mahana_'.MSG_SUCCESS), 'retval'=>$message);
}
return $status;
}


/*
function update_message_status() - will change status on message for particular user
@parameters - $msg_id REQUIRED, $user_id REQUIRED, $status_id REQUIRED
- $status_id should come from config/mahana.php list of constants
*/
function update_message_status($msg_id, $user_id, $status_id )
{
$status = array('err'=>1, 'code'=>MSG_ERR_GENERAL, 'msg'=>lang('mahana_'.MSG_ERR_GENERAL));

if (empty($msg_id)){$status = array('err'=>1, 'code'=>MSG_ERR_INVALID_MSG_ID, 'msg'=>lang('mahana_'.MSG_ERR_INVALID_MSG_ID));return $status;}
if (empty($user_id)){$status = array('err'=>1, 'code'=>MSG_ERR_INVALID_USER_ID, 'msg'=>lang('mahana_'.MSG_ERR_INVALID_USER_ID));return $status;}
if (empty($status_id)){$status = array('err'=>1, 'code'=>MSG_ERR_INVALID_STATUS_ID, 'msg'=>lang('mahana_'.MSG_ERR_INVALID_STATUS_ID));return $status;}

if ($this->ci->mahana_model->update_message_status($msg_id, $user_id, $status_id ))
{
$status = array('err'=>0, 'code'=>MSG_SUCCESS, 'msg'=>lang('mahana_'.MSG_STATUS_UPDATE));
}
return $status;
}

/*
function add_participant() - adds user to existing thread
@parameters - $thread_id REQUIRED, $user_id REQUIRED
*/
function add_participant($thread_id, $user_id)
{
$status = array('err'=>1, 'code'=>MSG_ERR_GENERAL, 'msg'=>lang('mahana_'.MSG_ERR_GENERAL));

if (empty($thread_id)){$status = array('err'=>1, 'code'=>MSG_ERR_INVALID_THREAD_ID, 'msg'=>lang('mahana_'.MSG_ERR_INVALID_THREAD_ID));return $status;}
if (empty($user_id)){$status = array('err'=>1, 'code'=>MSG_ERR_INVALID_USER_ID, 'msg'=>lang('mahana_'.MSG_ERR_INVALID_USER_ID));return $status;}

if (!$this->ci->mahana_model->valid_new_participant($thread_id, $user_id))
{
$status = array('err'=>1, 'code'=>1, 'msg'=>lang('mahana_'.MSG_ERR_PARTICIPANT_EXISTS));
return $status;
}

if (!$this->ci->mahana_model->application_user($user_id))
{
$status = array('err'=>1, 'code'=>1, 'msg'=>lang('mahana_'.MSG_ERR_PARTICIPANT_NONSYSTEM));
return $status;
}

if ($this->ci->mahana_model->add_participant($thread_id, $user_id ))
{
$status = array('err'=>0, 'code'=>MSG_SUCCESS, 'msg'=>lang('mahana_'.MSG_PARTICIPANT_ADDED));
}
return $status;
}

/*
function remove_participant() - removes user from existing thread
@parameters - $thread_id REQUIRED, $user_id REQUIRED
*/
function remove_participant($thread_id, $user_id)
{
$status = array('err'=>1, 'code'=>MSG_ERR_GENERAL, 'msg'=>lang('mahana_'.MSG_ERR_GENERAL));

if (empty($thread_id)){$status = array('err'=>1, 'code'=>MSG_ERR_INVALID_THREAD_ID, 'msg'=>lang('mahana_'.MSG_ERR_INVALID_THREAD_ID));return $status;}
if (empty($user_id)){$status = array('err'=>1, 'code'=>MSG_ERR_INVALID_USER_ID, 'msg'=>lang('mahana_'.MSG_ERR_INVALID_USER_ID));return $status;}

if ($this->ci->mahana_model->remove_participant($thread_id, $user_id ))
{
$status = array('err'=>0, 'code'=>MSG_SUCCESS, 'msg'=>lang('mahana_'.MSG_PARTICIPANT_REMOVED));
}
return $status;
}

/*
function send_new_message() - sends new internal message. This function will create a new thread
@parameters - $sender_id REQUIRED, $recipients REQUIRED
- $recipients may be either a single integer or an array of integers, representing user_ids
*/
function send_new_message($sender_id, $recipients, $subject='', $body='', $priority=PRIORITY_NORMAL){
$status = array('err'=>1, 'code'=>MSG_ERR_GENERAL, 'msg'=>lang('mahana_'.MSG_ERR_GENERAL));

if (empty($sender_id)){$status = array('err'=>1, 'code'=>MSG_ERR_INVALID_SENDER_ID, 'msg'=>lang('mahana_'.MSG_ERR_INVALID_SENDER_ID));return $status;}
if (empty($recipients)){$status = array('err'=>1, 'code'=>MSG_ERR_INVALID_RECIPIENTS, 'msg'=>lang('mahana_'.MSG_ERR_INVALID_RECIPIENTS));return $status;}

if ($this->ci->mahana_model->send_new_message($sender_id, $recipients, $subject, $body, $priority))
{
$status = array('err'=>0, 'code'=>MSG_SUCCESS, 'msg'=>lang('mahana_'.MSG_MESSAGE_SENT));
}
return $status;
}

/*
function reply_to_message() - replies to internal message. This function will NOT create a new thread or participant list
@parameters - $sender_id REQUIRED, $msg_id REQUIRED
*/
function reply_to_message($msg_id, $sender_id, $subject='', $body='', $priority=PRIORITY_NORMAL)
{
$status = array('err'=>1, 'code'=>MSG_ERR_GENERAL, 'msg'=>lang('mahana_'.MSG_ERR_GENERAL));

if (empty($sender_id)){$status = array('err'=>1, 'code'=>MSG_ERR_INVALID_SENDER_ID, 'msg'=>lang('mahana_'.MSG_ERR_INVALID_SENDER_ID));return $status;}
if (empty($msg_id)){$status = array('err'=>1, 'code'=>MSG_ERR_INVALID_MSG_ID, 'msg'=>lang('mahana_'.MSG_ERR_INVALID_MSG_ID));return $status;}

if ($this->ci->mahana_model->reply_to_message($msg_id, $sender_id, $body, $priority))
{
$status = array('err'=>0, 'code'=>MSG_SUCCESS, 'msg'=>lang('mahana_'.MSG_MESSAGE_SENT));
}
return $status;
}

/*
function get_participant_list() - returns list of participants on given thread. If sender_id set, sender_id will be left off list
@parameters - $sender_id REQUIRED, $thread_id REQUIRED
*/
function get_participant_list($thread_id, $sender_id=0)
{
$status = array('err'=>1, 'code'=>MSG_ERR_GENERAL, 'msg'=>lang('mahana_'.MSG_ERR_GENERAL));

if (empty($thread_id)){$status = array('err'=>1, 'code'=>MSG_ERR_INVALID_THREAD_ID, 'msg'=>lang('mahana_'.MSG_ERR_INVALID_THREAD_ID));return $status;}

if ($participants = $this->ci->mahana_model-> get_participant_list($thread_id, $sender_id))
{
$status = array('err'=>0, 'code'=>MSG_SUCCESS, 'msg'=>lang('mahana_'.MSG_SUCCESS) ,'retval'=>$participants);
}
return $status;
}

}

0 comments on commit 6e948d1

Please sign in to comment.