__swift/modules/base/api/class.Controller_UserSearch.php

class.Controller_UserSearch.php

<?php
/**
 * =======================================
 * ###################################
 * SWIFT Framework
 *
 * @package	SWIFT
 * @author	Kayako Infotech Ltd.
 * @copyright	Copyright (c) 2001-2009, Kayako Infotech Ltd.
 * @license	http://www.kayako.com/license
 * @link		http://www.kayako.com
 * @filesource
 * ###################################
 * =======================================
 */

/**
 * User Search API Controller
 *
 * @author Mahesh Salaria
 */
class Controller_UserSearch extends Controller_api implements SWIFT_REST_Interface
{

	/**
	 * Constructor
	 *
	 * @author Mahesh Salaria
	 * @return bool "true" on Success, "false" otherwise
	 */
	public function __construct()
	{
		parent::__construct();

		$this->Load->Library('XML:XML');
		$this->Load->Library('User:User', false, false);
		$this->Load->Library('User:UserEmail', false, false);
		$this->Load->Library('User:UserGroup', false, false);
		$this->Load->Library('User:UserOrganization', false, false);

		$this->Language->Load('staff_users');

		return true;
	}

	/**
	 * Destructor
	 *
	 * @author Mahesh Salaria
	 * @return bool "true" on Success, "false" otherwise
	 */
	public function __destruct()
	{
		parent::__destruct();

		return true;
	}

	/**
	 * Initiate the User Search
	 *
	 * Example Output: http://wiki.kayako.com/display/DEV/REST+-+UserSearch
	 *
	 * @author Mahesh Salaria
	 * @return bool "true" on Success, "false" otherwise
	 * @throws SWIFT_Exception If the Class is not Loaded
	 */
	public function Post()
	{
		if (!$this->GetIsClassLoaded())
		{
			throw new SWIFT_Exception(SWIFT_CLASSNOTLOADED);

			return false;
		}

		$_query = '';
		if (isset($_POST['query']) && !empty($_POST['query'])) {
			$_query = $_POST['query'];
		}

		$_userIDList = array();
		$_userContainer = array();

		$this->Database->Query("SELECT * FROM " . TABLE_PREFIX . "useremails AS useremails
			LEFT JOIN " . TABLE_PREFIX . "users AS users ON (useremails.linktypeid = users.userid)
			LEFT JOIN " . TABLE_PREFIX . "userorganizations AS userorganizations ON (users.userorganizationid = userorganizations.userorganizationid)
			LEFT JOIN " . TABLE_PREFIX . "usergroups AS usergroups ON (users.usergroupid = usergroups.usergroupid)
			WHERE useremails.linktype = '" . SWIFT_UserEmail::LINKTYPE_USER . "' AND
				((" . BuildSQLSearch('useremails.email', $_POST['query']) . ")
					OR (" . BuildSQLSearch('users.fullname', $_POST['query']) . ")
					OR (" . BuildSQLSearch('users.phone', $_POST['query']) . ")
					OR (" . BuildSQLSearch('userorganizations.organizationname', $_POST['query']) . ")
					OR (" . BuildSQLSearch('usergroups.title', $_POST['query']) . "))");
		while ($this->Database->NextRecord())
		{
			$_userContainer[$this->Database->Record['userid']] = $this->Database->Record;
			$_userContainer[$this->Database->Record['userid']]['emails'] = array();

			$_userIDList[] = $this->Database->Record['userid'];
		}

		$this->Database->Query("SELECT useremails.* FROM " . TABLE_PREFIX . "useremails AS useremails
				WHERE useremails.linktype = '" . SWIFT_UserEmail::LINKTYPE_USER . "'
				AND useremails.linktypeid IN (" . BuildIN($_userIDList) . ")");
		while ($this->Database->NextRecord())
		{
			$_userContainer[$this->Database->Record['linktypeid']]['emails'][] = $this->Database->Record['email'];
		}

		$_salutationList = SWIFT_User::RetrieveSalutationList();

		$this->XML->AddParentTag('users');
			foreach ($_userContainer as $_userID => $_user) {
				$_userRole = 'user';
				if ($_user['userrole'] == SWIFT_User::ROLE_MANAGER) {
					$_userRole = 'manager';
				}

				$_userSalutation = '';
				if (isset($_salutationList[$_user['salutation']])) {
					$_userSalutation = $_salutationList[$_user['salutation']];
				}

				$this->XML->AddParentTag('user');
					$this->XML->AddTag('id', $_userID);
					$this->XML->AddTag('usergroupid', intval($_user['usergroupid']));
					$this->XML->AddTag('userrole', $_userRole);
					$this->XML->AddTag('userorganizationid', intval($_user['userorganizationid']));
					$this->XML->AddTag('salutation', $_userSalutation);

					$this->XML->AddTag('userexpiry', $_user['userexpirytimeline']);

					$this->XML->AddTag('fullname', $_user['fullname']);
					foreach ($_user['emails'] as $_emailAddress) {
						$this->XML->AddTag('email', $_emailAddress);
					}

					$this->XML->AddTag('designation', $_user['userdesignation']);
					$this->XML->AddTag('phone', $_user['phone']);

					$this->XML->AddTag('dateline', $_user['dateline']);
					$this->XML->AddTag('lastvisit', $_user['lastvisit']);
					$this->XML->AddTag('isenabled', $_user['isenabled']);
					$this->XML->AddTag('timezone', $_user['timezonephp']);
					$this->XML->AddTag('enabledst', $_user['enabledst']);

					$this->XML->AddTag('slaplanid', $_user['slaplanid']);
					$this->XML->AddTag('slaplanexpiry', $_user['slaexpirytimeline']);
				$this->XML->EndParentTag('user');
			}
		$this->XML->EndParentTag('users');

		$this->XML->EchoXML();
	}
	/**
	 * Not Implemented
	 *
	 * Example Output: http://wiki.kayako.com/display/DEV/REST+-+UserSearch
	 *
	 * @author Mahesh Salaria
	 * @return bool "true" on Success, "false" otherwise
	 * @throws SWIFT_Exception If the Class is not Loaded
	 */
	public function GetList()
	{
		if (!$this->GetIsClassLoaded())
		{
			throw new SWIFT_Exception(SWIFT_CLASSNOTLOADED);

			return false;
		}

		$this->RESTServer->DispatchStatus(SWIFT_RESTServer::HTTP_BADREQUEST, 'Not Implemented, Call POST /Base/UserSearch instead.');

		return true;
	}

	/**
	 * Not Implemented
	 *
	 * Example Output: http://wiki.kayako.com/display/DEV/REST+-+UserSearch
	 *
	 * @author Mahesh Salaria
	 * @return bool "true" on Success, "false" otherwise
	 * @throws SWIFT_Exception If the Class is not Loaded
	 */
	public function Get()
	{
		if (!$this->GetIsClassLoaded())
		{
			throw new SWIFT_Exception(SWIFT_CLASSNOTLOADED);

			return false;
		}

		$this->RESTServer->DispatchStatus(SWIFT_RESTServer::HTTP_BADREQUEST, 'Not Implemented, Call POST /Base/UserSearch instead.');

		return true;
	}

	/**
	 * Not Implemented
	 *
	 * Example Output: http://wiki.kayako.com/display/DEV/REST+-+UserSearch
	 *
	 * @author Mahesh Salaria
	 * @return bool "true" on Success, "false" otherwise
	 * @throws SWIFT_Exception If the Class is not Loaded
	 */
	public function Put()
	{
		if (!$this->GetIsClassLoaded())
		{
			throw new SWIFT_Exception(SWIFT_CLASSNOTLOADED);

			return false;
		}

		$this->RESTServer->DispatchStatus(SWIFT_RESTServer::HTTP_BADREQUEST, 'Not Implemented, Call POST /Base/UserSearch instead.');

		return true;
	}

	/**
	 * Not Implemented
	 *
	 * Example Output: http://wiki.kayako.com/display/DEV/REST+-+UserSearch
	 *
	 * @author Mahesh Salaria
	 * @return bool "true" on Success, "false" otherwise
	 * @throws SWIFT_Exception If the Class is not Loaded
	 */
	public function Delete()
	{
		if (!$this->GetIsClassLoaded())
		{
			throw new SWIFT_Exception(SWIFT_CLASSNOTLOADED);

			return false;
		}

		$this->RESTServer->DispatchStatus(SWIFT_RESTServer::HTTP_BADREQUEST, 'Not Implemented, Call POST /Base/UserSearch instead.');

		return true;
	}

}
?>