NOTE: Have in mind that the CI and PHPLIST have a common function named “redirect”. You either need to rename that in CI or in PHPLIST.

<?php if (!defined('BASEPATH')) exit('No direct script access allowed');

/**
* CodeIgniter phplist Library
*
* CodeIgniter phplist bridge allowing adding users to lists and blacklisting them
*
* @author Georgi Budinov
* @version	1.0
* @link http://georgi.budinov.com
*/
class Phplist_library
{
    public $CI;

    /**
     * Constructor.
     */
    public function __construct()
    {
    	global $tables, $table_prefix, $config, $usertable_prefix, $database_connection;
        if (!isset($this->CI))
		{
			$this->CI =& get_instance();
		}

		$rootPath = $this->CI->config->item('root_path');

		define('BULLETIN_ROOT_PATH', $rootPath.'bulletin/');

		$phplist_root_path = (defined('PHPLIST_ROOT_PATH')) ? PHPLIST_ROOT_PATH : BULLETIN_ROOT_PATH;

		// Include needed files
		include($phplist_root_path . 'admin/defaultconfig.inc');
		include($phplist_root_path . 'config/config.php');
		include($phplist_root_path . 'admin/mysql.inc');
		include($phplist_root_path . 'admin/connect.php');
    }

    /**
     *
     * @param $email
     * @param $lists
     * @return mixed
     */
    public function user_add($email, $lists = array())
    {
    	if(!$email) return false;

    	if(is_array($lists) && count($lists))
    	{
    		$userID = addNewUser($email);

    		if($userID > 0)
    		{
    			foreach($lists as $list)
    			{
    				$this->userAddToList($userID, $list);
    			}
    		}
    	}
    	else
    	{
        	return addNewUser($email);
    	}
    }

	public function get_lists()
    {
    	$results = $this->getLists();

    	return $results;
    }

	public function user_add_list($email, $list)
    {
    	if(!$email || !$list) return;

    	$userid = $this->getUserIDByEmail($email);

    	if($userid > 0)
    	{
    		$this->userAddToList($userid, $list);
    	}
    	else
    	{
    		return;
    	}
    }

	public function user_remove_list($email, $list)
    {
    	if(!$email || !$list) return;

    	$userid = $this->getUserIDByEmail($email);

    	if($userid > 0)
    	{
    		$this->userRemoveToList($userid, $list);
    	}
    	else
    	{
    		return;
    	}
    }

    /**
     *
     * @param $email
     * @return mixed
     */
    public function user_blacklist($email)
    {
    	if(!$email) return;

    	return addUserToBlackList($email);
    }

	/**
     *
     * @param $email
     * @return mixed
     */
    public function user_unblacklist($email)
    {
    	if(!$email) return;

    	$userid = $this->getUserIDByEmail($email);

    	if($userid > 0)
    	{
    		return unBlackList($userid);
    	}
    	else
    	{
    		return false;
    	}
    }

	private function getUserIDByEmail($email = '') {
	  global $tables, $table_prefix, $config, $usertable_prefix, $database_connection;
	  if (!$email) return;

	  # workaround for integration webbler/phplist
	  if (!isset($table_prefix))
	    $table_prefix = "phplist_";

	  if (isset($tables["attribute"])) {
	    $att_table = $tables["attribute"];
	    $user_att_table = $tables["user_attribute"];
	    $usertable = $tables["user"];
	  } else {
	    $att_table = "attribute";
	    $user_att_table = "user_attribute";
	    $usertable = "user";
	  }
	  $email = mysql_real_escape_string($email, $database_connection);
	  $userid = Sql_Fetch_Row_Query("select id from {$usertable} where email = \"$email\"");
	  $id = $userid[0];

	  return $id;
	}

	private function userAddToList($id = 0, $listID = 0)
	{
		global $tables, $table_prefix, $config, $usertable_prefix, $database_connection;

		$id = intval($id);
		$listID = intval($listID);
		if(!$id || !$listID) return false;

		$query = "replace into ".$tables["listuser"]." (userid,listid,entered) values($id,$listID,now())";
	    $result = Sql_query($query);
	}

	private function userRemoveToList($id = 0, $listID = 0)
	{
		global $tables, $table_prefix, $config, $usertable_prefix, $database_connection;

		$id = intval($id);
		$listID = intval($listID);
		if(!$id || !$listID) return false;

		$query = "delete from ".$tables["listuser"]." where userid = $id and listid = $listID";
	    $result = Sql_query($query);
	}

	private function getLists()
	{
		global $tables, $table_prefix, $config, $usertable_prefix, $database_connection;

		$results = array();
		$result = Sql_query("SELECT * FROM {$tables['list']} order by listorder");
		while ($row = Sql_fetch_array($result))
		{
			$results[$row['id']] = $row;
		}

		return $results;
	}
}

/* End of file phplist_library.php */
/* Location: ./application/libraries/phplist_library.php */

Bookmark It

After some thinking what to do – I realized that in most of the projects I am extending the Controller class and I am using my own. So in the extended class I just added the variables to the definition + phpdoc style comment. This way I succeeded in enabling the IntelliSense with Eclipse PDT and CodeIgniter’s main libraries. Here is the code:

<?php
class MY_Controller extends Controller
{
	/**
	 * @var CI_User_agent
	 */
 	var $agent;
	/**
	 * @var CI_Benchmark
	 */
 	var $benchmark;
	/**
	 * @var CI_Calendar
	 */
 	var $calendar;
	/**
	 * @var CI_Cart
	 */
 	var $cart;
	/**
	 * @var CI_Config
	 */
 	var $config;
	/**
	 * @var CI_DB_driver
	 */
 	var $db;
	/**
	 * @var CI_Email
	 */
 	var $email;
	/**
	 * @var CI_Encrypt
	 */
 	var $encrypt;
	/**
	 * @var CI_Form_validation
	 */
 	var $form_validation;
	/**
	 * @var CI_FTP
	 */
 	var $ftp;
	/**
	 * @var CI_Image_lib
	 */
 	var $image_lib;
	/**
	 * @var CI_Input
	 */
 	var $input;
	/**
	 * @var CI_Language
	 */
 	var $lang;
	/**
	 * @var CI_Output
	 */
 	var $output;
	/**
	 * @var CI_Pagination
	 */
 	var $pagination;
	/**
	 * @var CI_Parser
	 */
 	var $parser;
	/**
	 * @var CI_Session
	 */
 	var $session;
	/**
	 * @var CI_Table
	 */
 	var $table;
	/**
	 * @var CI_Trackback
	 */
 	var $trackback;
	/**
	 * @var CI_Typography
	 */
 	var $typography;
	/**
	 * @var CI_Unit_test
	 */
 	var $unit;
	/**
	 * @var CI_Upload
	 */
 	var $upload;
	/**
	 * @var CI_URI
	 */
 	var $uri;
	/**
	 * @var CI_Xmlrpc
	 */
 	var $xmlrpc;
	/**
	 * @var CI_Xmlrpcs
	 */
 	var $xmlrpcs;
	/**
	 * @var CI_Zip
	 */
 	var $zip;
}
?>

Note that there is no need to initialize anything, update core classes in the system folder or anything else. Simple as extending the Controller and using it.

Bookmark It

echo $this->lang->line('sample_label');

So today I found a forum thread in CodeIgniter forums asking about using the language functionality and a shortcut to that language variables. That made me think of some kind of simplification of the code that we all use. So what I did was just small improvement in the Loader class – specifically the view function. I created  MY_Loader file in libraries folder and put simply these contents:

<?php
class MY_Loader extends CI_Loader
{
 /**
 * Load View
 *
 * This function is used to load a "view" file.  It has three parameters:
 *
 * 1. The name of the "view" file to be included.
 * 2. An associative array of data to be extracted for use in the view.
 * 3. TRUE/FALSE - whether to return the data or load it.  In
 * some cases it's advantageous to be able to return data so that
 * a developer can process it in some way.
 *
 * @access    public
 * @param    string
 * @param    array
 * @param    bool
 * @return    void
 */
 function view($view, $vars = array(), $return = FALSE)
 {
     $vars = $this->_ci_object_to_array($vars);
     $CI =& get_instance();
     $vars['lang'] = &$CI->lang->language;
     return $this->_ci_load(array('_ci_view' => $view, '_ci_vars' => $this->_ci_object_to_array($vars),
     '_ci_return' => $return));
  }
}
?>

This way I could just use the $lang array in the view like this:

$lang['sample_label']

UPDATE:
Sorry for messing this … I found out that in the lang helper
of CodeIgniter there is a magic function I have never been aware of -> lang(‘language key’)

Bookmark It

RewriteEngine on

RewriteCond $1 !^(index\.php)
RewriteRule ^([^/]+)/(.*)?$ - [E=PATH_APPLICATION:$1,NE]

RewriteCond $1 !^(index\.php)
RewriteRule ^([^/]+)/(.*)?$ /index.php?/$2 [L]

Using this .htaccess file I manage the hiding of the index.php file and the most
interesting part is setting the environment variable REDIRECT_PATH_APPLICATION
with the first segment of the accessed uri. So in the index.php I can access
$_SERVER['REDIRECT_PATH_APPLICATION'] which holds the first segment. This segment
shows me where is the application folder I need to use with this request. So
in the index.php I have the following:

$application_folder = "/var/www/".$_SERVER['REDIRECT_PATH_APPLICATION'];

Bookmark It

<?php if (!defined('BASEPATH')) exit('No direct script access allowed');

/**
* CodeIgniter phpBB3 Bridge
* @author Georgi Budinov, credits to Tomaž Muraus at http://www.tomaz-muraus.info
* @link georgi.budinov.com
*/
class Phpbb_bridge
{
 public $CI;
 protected $_user;

 /**
 * Constructor.
 */
 public function __construct()
 {
   if (!isset($this->CI))
   {
     $this->CI =& get_instance();
   }

   // Set the variables scope
   global $phpbb_root_path, $phpEx, $user, $auth, $cache, $db, $config, $template, $table_prefix;

   $rootPath = $this->CI->config->item('root_path');

   define('IN_PHPBB', TRUE);
   define('FORUM_ROOT_PATH', $rootPath.'forum/');

   $phpbb_root_path = (defined('PHPBB_ROOT_PATH')) ? PHPBB_ROOT_PATH : FORUM_ROOT_PATH;
   $phpEx = substr(strrchr(__FILE__, '.'), 1);

   // Include needed files
   include($phpbb_root_path . 'common.' . $phpEx);
   include($phpbb_root_path . 'config.' . $phpEx);
   include($phpbb_root_path . 'includes/functions_user.' . $phpEx);
   include($phpbb_root_path . 'includes/functions_display.' . $phpEx);
   include($phpbb_root_path . 'includes/functions_privmsgs.' . $phpEx);
   include($phpbb_root_path . 'includes/functions_posting.' . $phpEx);

   // Initialize phpBB user session
   $user->session_begin();

   $auth->acl($user->data);
   $user->setup();

   // Save user data into $_user variable
   $this->_user = $user;
 }

 /**
 * @param $email
 * @param $username
 * @param $password
 * @return unknown_type</pre>
 */
 public function user_add($email, $username, $password)
 {
   $user_row = array(
     'username'              => $username,
     'user_password'         => phpbb_hash($password),
     'user_email'            => $email,
     'group_id'              => 2, // by default, the REGISTERED user group is id 2
     'user_timezone'         => (float) date('T'),
     'user_lang'             => 'bg',
     'user_type'             => USER_NORMAL,
     'user_ip'               => $_SERVER['REMOTE_ADDR'],
     'user_regdate'          => time(),
   );

   return user_add($user_row, false);
 }

 /**
 * @param $username
 * @param $password
 * @return bool
 */
 public function user_edit($username, $password)
 {
   return user_edit($username, $password);
 }

 /*
 * Logins the user in forum
 */
 public function user_login($username, $password)
 {
   $auth = new auth();

   return $auth->login($username, $password);
 }

 public function user_logout()
 {
   $this->_user->session_kill();
   $this->_user->session_begin();
 }

 /**
 * @param $user_id
 * @return unknown_type
 */
 public function user_delete($user_id)
 {
   return user_delete('remove', $user_id, false);
 }
}

One more thing to add here: the user_edit function is not available in phpbb3 so I defined one in includes/functions_user.php:

/**
* Change password
*
* @param string $username
* @param string $newPassword
* @return boolean
*/
function user_edit($username, $newPassword)
{
 global $db, $user, $auth, $config, $phpbb_root_path, $phpEx;

 if (empty($username) || empty($newPassword))
 {
   return false;
 }

 $sql = 'UPDATE ' . USERS_TABLE . ' SET user_password=\'' . $db->sql_escape(md5($newPassword)) . '\' WHERE username = \''.$db->sql_escape($username).'\'';
 $db->sql_query($sql);

 return true;
}

And last but not least you will have to decide wich way to go … there is duplication of the function redirect. I replaced it in the CodeIgniter framework as it was easier for me.
Enjoy!

UPDATE 1:

For versions of PHPBB greater or equal than 3.0.8. you must change the cache class name from cache to cache_phpbb. The files that need changes are:

./common.php , ./style.php , ./download/file.php and ./includes/cache.php

UPDATE 2:

In order to run the library correctly you must choose a different connection driver for the database from the one chosen for CI. For example mysql for CI and mysqli for PHPBB (set up in ./config.php)

Bookmark It