Model/Ticket.php

Go to the documentation of this file.

<?php
// {{{ license

// +----------------------------------------------------------------------+
// | FastFrame Application Framework                                      |
// +----------------------------------------------------------------------+
// | Copyright (c) 2002-2006 The Codejanitor Group                        |
// +----------------------------------------------------------------------+
// | This source file is subject to the GNU Lesser Public License (LGPL), |
// | that is bundled with this package in the file LICENSE, and is        |
// | available at through the world-wide-web at                           |
// | http://www.fsf.org/copyleft/lesser.html                              |
// | If you did not receive a copy of the LGPL and are unable to          |
// | obtain it through the world-wide-web, you can get it by writing the  |
// | Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, |
// | MA 02111-1307, USA.                                                  |
// +----------------------------------------------------------------------+
// | Authors: Jason Rust <jrust@codejanitor.com>                          |
// +----------------------------------------------------------------------+

// }}}
// {{{ requires

require_once FASTFRAME_ROOT . 'lib/FastFrame/Model.php';
require_once FASTFRAME_ROOT . 'lib/FastFrame/Util.php';

// }}}
// {{{ class FF_Model_Ticket

// }}}
class FF_Model_Ticket extends FF_Model {
    // {{{ properties

    var $extraValues = array();

    var $createDate;

    var $lastUpdated;

    var $lastCommentUpdate;
    
    var $dueDate;
    
    var $reporterId = 0;

    var $handlerId = 0;

    var $handlerName = null;

    var $reporterName = null;

    var $reporterPhone = null;

    var $reporterDepartment = null;

    var $reporterEmail = null;

    var $summary;

    var $description;

    var $points;

    var $locationId;

    var $statusId;

    var $statusName;

    var $statusColor;

    var $resolutionId;

    var $categoryId;

    var $lastAction;

    var $lastViewTime = 0;

    var $progress = 0;

    var $numAttachments = 0;
     
    // }}}
    // {{{ reset()

    function reset()
    {
        $this->id = null;
        $this->createDate = null;
        $this->dueDate = null;
        $this->lastUpdated = 0;
        $this->lastCommentUpdate = 0;
        $this->reporterId = 0;
        $this->handlerId = 0;
        $this->summary = null;
        $this->description = null;
        $this->points = null;
        $this->locationId = null;
        $this->statusId = null;
        $this->resolutionId = null;
        $this->categoryId = null;
        $this->statusName = null;
        $this->statusColor = null;
        $this->lastAction = null;
        $this->lastViewTime = 0;
        $this->progress = 0;
        $this->numAttachments = 0;
    }

    // }}}
    // {{{ importFromArray()

    function importFromArray($in_data)
    {
        $this->setId($in_data['id']);
        $this->setCreateDate(@$in_data['create_date']);
        $this->setDueDate(@$in_data['due_date']);
        $this->setReporterId(@$in_data['reporter_id']);
        $this->setHandlerId(@$in_data['handler_id']);
        $this->setSummary($in_data['summary']);
        $this->setDescription(@$in_data['description']);
        $this->setPoints($in_data['points']);
        $this->setLocationId(@$in_data['location_id']);
        $this->setStatusId(@$in_data['status_id']);
        $this->setResolutionId(@$in_data['resolution_id']);
        $this->setCategoryId(@$in_data['category_id']);
        $this->lastUpdated = @$in_data['last_updated'];
        $this->lastCommentUpdate = @$in_data['last_comment_update'];
        $this->statusName = @$in_data['status_name'];
        $this->statusColor = @$in_data['status_color'];
        $this->categoryName = @$in_data['category_name'];
        $this->handlerName = @$in_data['handler_name'];
        $this->reporterName = @$in_data['reporter_name'];
        $this->reporterPhone = @$in_data['reporter_phone'];
        $this->reporterDepartment = @$in_data['reporter_dept'];
        $this->reporterEmail = @$in_data['reporter_email'];
        $this->lastAction = @$in_data['last_action'];
        $this->progress = @$in_data['progress'];
        $this->numAttachments = @$in_data['num_attachments'];
        $this->lastViewTime = @$in_data['last_view_time'];

        // Since extra values aren't model properties, repopulate them as POST data
        if (isset($in_data['extra_values'])) {
            foreach ($in_data['extra_values'] as $s_name => $s_value) {
                FF_Request::setParam($s_name, $s_value, 'p');
            }
        }
    }

    // }}}
    // {{{ exportToArray()

    function exportToArray()
    {
        $a_data = array();
        $a_data['id'] = $this->getId();
        $a_data['create_date'] = $this->getCreateDate();
        $a_data['due_date'] = $this->getDueDate();
        $a_data['reporter_id'] = $this->getReporterId();
        $a_data['reporter_name'] = $this->getReporterName();
        $a_data['reporter_phone'] = $this->getReporterPhone();
        $a_data['reporter_dept'] = $this->getReporterDepartment();
        $a_data['reporter_email'] = $this->getReporterEmail();
        $a_data['handler_id'] = $this->getHandlerId();
        $a_data['summary'] = $this->getSummary();
        $a_data['description'] = $this->getDescription();
        $a_data['points'] = $this->getPoints();
        $a_data['location_id'] = $this->getLocationId();
        $a_data['status_id'] = $this->getStatusId();
        $a_data['resolution_id'] = $this->getResolutionId(false);
        $a_data['category_id'] = $this->getCategoryId();
        $a_data['last_action'] = $this->getLastAction();
        $a_data['progress'] = $this->getProgress();
        $a_data['num_attachments'] = $this->getNumAttachments();
        $a_data['extra_values'] = $this->extraValues;
        return $a_data;
    }

    // }}}
    // {{{ setExtraValueToExport()

    function setExtraValueToExport($in_field, $in_value)
    {
        $this->extraValues[$in_field] = $in_value;
    }

    // }}}
    // {{{ email()

    function email($in_emails, $in_short = false)
    {
                return;
        $o_result = new FF_Result();
        // remove any empty or duplicate values
        $in_emails = array_filter(array_unique($in_emails));
        $s_email = implode(',', $in_emails);
        if (empty($s_email)) {
            return $o_result;
        }

        require_once 'Mail.php';
        $o_registry =& FF_Registry::singleton();
        $o_mail =& Mail::factory($o_registry->getConfigParam('mailer/type'),
                $o_registry->getConfigParam('mailer/params'));
        if (PEAR::isError($o_mail)) {
            $o_result->addMessage($o_mail->getMessage());
            $o_result->setSuccess(false);
            return $o_result;
        }

        $a_headers = array();
        $a_headers['From'] = $o_registry->getConfigParam('mailer/default_from');
        $a_headers['To'] = $s_email;
        $tmp_summary = $this->getSummary();
        $tmp_summary = strlen($tmp_summary) > 50 ? substr($tmp_summary, 0, 50) . '...' : $tmp_summary;
        switch ($this->getLastAction()) {
            case ACTION_ADD_SUBMIT:
                $a_headers['Subject'] = sprintf(_('[Mayday] %s Opened: %s'), $this->getId(), $tmp_summary);
            break;
            case ACTION_EDIT_SUBMIT:
            case 'new_private_comment':
            case 'new_public_comment':
                $a_headers['Subject'] = sprintf(_('[Mayday] %s Updated: %s'), $this->getId(), $tmp_summary);
            break;
            case ACTION_RESOLVE_SUBMIT:
                $a_headers['Subject'] = sprintf(_('[Mayday] %s Closed: %s'), $this->getId(), $tmp_summary);
            break;
            default:
                $a_headers['Subject'] = sprintf(_('[Mayday] %s: %s'), $this->getId(), $tmp_summary);
            break;
        }

        if ($in_short) {
            // Make from as short as possible
            $a_headers['From'] = preg_replace('/.*?<(.*?)>/', '\\1', $a_headers['From']);
            $a_headers['Subject'] = '[Mayday] ' . $tmp_summary;
            $a_headers['Bcc'] = $a_headers['To'];
            unset($a_headers['To']);
            $s_phone = $this->getReporterPhone();
            $s_phone = empty($s_phone) ? '' : ' (' . $s_phone . ')';
            $s_body = $this->getReporterName() . $s_phone . '. ';
            // Make the maximum length of the text-message 100 characters
            if (strlen($s_body) < 100) {
                $s_body .= substr($this->getDescription(), 0, 100 - strlen($s_body));
            }
        }
        else {
            require_once dirname(__FILE__) . '/../Action/TicketDisplay.php';
            $o_display =& new FF_Action_Display_Ticket($this);
            $a_data = $o_display->getTableData(true);
            $o_output = FF_Output::factory();
            // Put comments at top, and description below
            array_splice($a_data, 4, 0, array($a_data[2]));
            unset($a_data[2]);
            $s_url = FastFrame::url('index.php', array(
                'objectId' => $this->getId(), session_name() => false,
                'actionId' => ACTION_DISPLAY, 'app' => 'mayday'), true);
            array_splice($a_data, 4, 0, array(
                    array('title' => _('URL:'), 'data' => $o_output->link($s_url, $s_url))));
            $s_body = '';
            foreach ($a_data as $a_element) {
                $s_body .= str_pad($a_element['title'], 20, ' ', STR_PAD_RIGHT) . ' ' . $a_element['data'] . "\n";
            }

            $s_body .= $o_registry->getConfigParam('mayday/footer');
            require_once 'Mail/mime.php';
            $o_mime =& new Mail_mime("\n");
            $o_mime->setTXTBody(strip_tags($s_body));
            $o_mime->setHTMLBody('<html><body><pre>' . $s_body . '</pre></body></html>');
            $s_body = $o_mime->get();
            $a_headers = $o_mime->headers($a_headers);
        }

        $tmp_result =& $o_mail->send($s_email, $a_headers, $s_body);
        if (PEAR::isError($tmp_result)) {
            $o_result->addMessage($tmp_result->getMessage());
            $o_result->setSuccess(false);
        }

        return $o_result;
    }

    // }}}
    // {{{ getLastViewTime()

    function getLastViewTime()
    {        
        return $this->lastViewTime;
    }

    // }}}
    // {{{ hasNewComment()

    function hasNewComment()
    {
        return $this->getLastCommentUpdate() > $this->getLastViewTime();
    }

    // }}}
     // {{{ markRead()

    function markRead($in_userId)
    {        
        $o_dao =& FF_DataAccess::factory('TicketComment');
        $o_dao->markRead($this->id, $in_userId);
    }

    // }}}
    // {{{ getSummaryInfo()

    function getSummaryInfo($in_id, $in_type, &$in_list)
    {
        if ($in_type == SUMMARY_FILTER) {
            require_once dirname(__FILE__) . '/Filter.php';
            $o_model =& new FF_Model_Filter();
            if ($o_model->fillById($in_id)) {
                $s_desc = $o_model->getName();
                $in_list->setSortField($o_model->getSortField());
                $in_list->setSortOrder($o_model->getSortOrder());
            }
            else {
                return '<i>' . _('Invalid Filter Specified') . '</i>';
            }
        }
        else {
            require_once dirname(__FILE__) . '/Category.php';
            $o_model =& new FF_Model_Category();
            $in_list->setSortField('points');
            $in_list->setSortOrder(0);
            if ($o_model->fillById($in_id)) {
                $s_desc = $o_model->getName() . ' ' . _('Category');
            }
            else {
                return '<i>' . _('Invalid Category Specified') . '</i>';
            }
        }

        return array($s_desc, 
                $this->o_dataAccess->getSummaryData($o_model, $in_list->getSortField(), $in_list->getSortOrder()));
    }

    // }}}
    // {{{ getNavigationIds()

    function getNavigationIds($in_currentBlock)
    {
        @list($s_blockId, $s_blockType) = explode(':', $in_currentBlock);
        if (empty($s_blockId)) {
            return array();
        }

        // Need constants
        require_once dirname(__FILE__) . '/MaydayProfile.php';
        if ($s_blockType == SUMMARY_FILTER) {
            require_once dirname(__FILE__) . '/Filter.php';
            $o_model =& new FF_Model_Filter();
            if (!$o_model->fillById($s_blockId)) {
                return array();
            }
        }
        else {
            require_once dirname(__FILE__) . '/Category.php';
            $o_model =& new FF_Model_Category();
            if (!$o_model->fillById($s_blockId)) {
                return array();
            }
        }

        return $this->o_dataAccess->getNavigationIds($this->getId(), $o_model);
    }

    // }}}
    // {{{ getModuleName()

    function getModuleName($in_id, $in_moduleName)
    {
        $o_moduleDao =& FF_DataAccess::factory($in_moduleName);
        $tmp_method = 'get' . $in_moduleName . 'Name';
        return $o_moduleDao->$tmp_method($in_id);
    }

    // }}}
    // {{{ getModuleOptions()

    function getModuleOptions($in_moduleName, $in_extraOptions = array())
    {
        $a_options = array();
        if (!empty($in_extraOptions['addAll'])) {
            $a_options = array('__all' => _('All'));
        }

        $o_moduleDao =& FF_DataAccess::factory($in_moduleName);
        $tmp_method = 'get' . $in_moduleName . 'Options';        
        $a_options += $o_moduleDao->$tmp_method($in_extraOptions);


        return $a_options;
    }

    // }}}
    // {{{ getModuleDefault()

    function getModuleDefault($in_moduleName)
    {
        $o_moduleDao =& FF_DataAccess::factory($in_moduleName);
        return $o_moduleDao->getDefaultValue();
    }

    // }}}
   // {{{ getFormattedDueDate()

    function getFormattedDueDate($in_showShortDate = false)
    {
        return $this->getDueDate() ? FF_Util::formatRelativeDate($this->getDueDate(), $in_showShortDate) : _('N/A');
    }

    // }}}
    // {{{ getDueDate()

    function getDueDate()
    {
        return $this->dueDate;
    }

    // }}}
    // {{{ setDueDate()

    function setDueDate($in_value)
    {
        $this->dueDate = $in_value;
    }

    // }}}
    // {{{ getFormattedCreateDate()

    function getFormattedCreateDate($in_showShortDate = false)
    {
        return FF_Util::formatRelativeDate($this->getCreateDate(), $in_showShortDate);
    }

    // }}}
    // {{{ getCreateDate()

    function getCreateDate()
    {
        return $this->createDate;
    }

    // }}}
    // {{{ setCreateDate()

    function setCreateDate($in_value)
    {
        $this->createDate = $in_value;
    }

    // }}}
    // {{{ getFormattedLastUpdated()

    function getFormattedLastUpdated()
    {
        return FF_Util::formatRelativeDate($this->getLastUpdated());
    }

    // }}}
    // {{{ getLastCommentUpdate()

    function getLastCommentUpdate()
    {
        return $this->lastCommentUpdate;
    }

    // }}}
    // {{{ getLastUpdated()

    function getLastUpdated()
    {
        return $this->lastUpdated;
    }

    // }}}
    // {{{ getProgress()

    function getProgress()
    {
        return (int) $this->progress;
    }

    // }}}
    // {{{ setProgress()

    function setProgress($in_value)
    {
        $this->progress = $in_value;
    }

    // }}}
    // {{{ getReporterName()

    function getReporterName()
    {
        return $this->reporterName;
    }

    // }}}
    // {{{ getReporterPhone()

    function getReporterPhone()
    {
        if (empty($this->reporterPhone)) {
            return;
        }
        elseif (strlen($this->reporterPhone) >= 10) {
            return preg_replace('/(\d{3})(\d{3})(\d{4})/', '\\1-\\2-\\3', $this->reporterPhone);
        }
        else {
            return preg_replace('/(\d{3})(\d{4})/', '\\1-\\2', $this->reporterPhone);
        }
    }

    // }}}
    // {{{ getReporterDepartment()

    function getReporterDepartment()
    {
        return $this->reporterDepartment;
    }

    // }}}
    // {{{ getReporterEmail()

    function getReporterEmail()
    {
        return $this->reporterEmail;
    }

    // }}}
    // {{{ getReporterId()

    function getReporterId()
    {
        return $this->reporterId;
    }

    // }}}
    // {{{ setReporterId()

    function setReporterId($in_value)
    {
        $this->reporterId = $in_value;
    }

    // }}}
    // {{{ getHandlerOptions()
    
    function getHandlerOptions($in_addUnassigned = false, $in_addAny = false, $in_catId = null)
    {
        $a_users = array();
        if ($in_addAny) {
            $a_users['__any'] = _('Any User');
        }

        if ($in_addUnassigned) {
            $a_users[0] = _('Unassigned');
        }

        $in_catId = is_null($in_catId) ? $this->getCategoryId() : ($in_catId == '__all' ? 'any' : $in_catId);
        $o_dao =& FF_DataAccess::factory('Permissions', 'permissions');
        $a_users += $o_dao->getUsersForObject($in_catId, PERMS_EDIT, 'Category');
        return $a_users;
    }

    // }}}
    // {{{ changeHandler()

    function changeHandler($in_id, $in_userId)
    {
        // History needs to know it changed
        $this->setHandlerId($in_userId);
        $o_result = $this->o_dataAccess->changeHandler($in_id, $in_userId);
        return !PEAR::isError($o_result);
    }

    // }}}
    // {{{ getHandlerName()

    function getHandlerName($in_force = false)
    {
        if ($this->getHandlerId() == 0) {
            return _('Unassigned');
        }
        else {
            if (empty($this->handlerName) || $in_force) {
                $o_dao =& FF_DataAccess::factory('Profile', 'profile');
                $this->handlerName = $o_dao->getFullNameById($this->getHandlerId());
            }

            return $this->handlerName;
        }
    }

    // }}}
    // {{{ getHandlerId()

    function getHandlerId()
    {
        return $this->handlerId;
    }

    // }}}
    // {{{ setHandlerId()

    function setHandlerId($in_value)
    {
        $this->handlerId = $in_value;
    }

    // }}}
    // {{{ getSummary()

    function getSummary()
    {
        return $this->summary;
    }

    // }}}
    // {{{ setSummary()

    function setSummary($in_value)
    {
        $this->summary = $in_value;
    }

    // }}}
    // {{{ getDescription()

    function getDescription($in_formatted = false)
    {
        if ($in_formatted) {
            $tmp_desc = $this->description;
            $tmp_desc = strlen($tmp_desc) > 100 ? substr($tmp_desc, 0, 100) . '...' : $tmp_desc;
            $tmp_desc = str_replace(array("\n", "\r"), array(' ', ' '), htmlspecialchars($tmp_desc));
            return $tmp_desc;
        }
        else {
            return $this->description;
        }
    }

    // }}}
    // {{{ setDescription()

    function setDescription($in_value)
    {
        $this->description = $in_value;
    }

    // }}}
    // {{{ getPriorityAlerts()

    function getPriorityAlerts()
    {
        $o_dao =& FF_DataAccess::factory('Priority');
        return $o_dao->getPriorityAlerts();
    }

    // }}}
    // {{{ changePoints()

    function changePoints($in_dir)
    {
        $o_result = new FF_Result();
        $o_dao =& FF_DataAccess::factory('Priority');
        $a_next = $o_dao->getNextPriority($this->getPoints(), $in_dir);
        if (empty($a_next)) {
            $o_result->setSuccess(false);
            $o_result->addMessage(sprintf(_('The ticket is already at the %s priority.'), $in_dir ? _('highest') : _('lowest')));
            return array($o_result, null);
        }
        else {
            // History needs to know it changed
            $this->setPoints($a_next['points']);
            $tmp_result = $this->o_dataAccess->changePoints($this->getId(), $this->getPoints());
            if (!PEAR::isError($tmp_result)) {
                $o_result->addMessage(sprintf(_('Successfully changed the priority to %s'), $a_next['name']));
            }
            else {
                $o_result->setSuccess(false);
                $o_result->addMessage($tmp_result->getMessage());
            }
        }

        return array($o_result, $a_next['name']);
    }

    // }}}
    // {{{ getPriorityDesc()

    function getPriorityDesc()
    {
        $o_dao =& FF_DataAccess::factory('Priority');
        $a_data = $o_dao->getClosestPriority($this->points);
        return $a_data['name'] . ' (' . $this->points . ' ' . _('points') . ')';
    }

    // }}}
    // {{{ getPoints()

    function getPoints($in_closest = false)
    {
        if (is_null($this->points)) {
            return $this->getModuleDefault('Priority');
        }
        else {
            // If looking for the closest actual priority we need to query the database
            if ($in_closest) {
                $o_dao =& FF_DataAccess::factory('Priority');
                $a_data = $o_dao->getClosestPriority($this->points);
                return $a_data['points'];
            }
            else {
                return $this->points;
            }
        }
    }

    // }}}
    // {{{ setPoints()

    function setPoints($in_value)
    {
        // Don't let points go out of range
        $in_value = $in_value < 0 ? 0 : $in_value;
        $in_value = $in_value > 100 ? 100 : $in_value;
        $this->points = $in_value;
    }

    // }}}
    // {{{ getLocationId()

    function getLocationId()
    {
        return is_null($this->locationId) ? $this->getModuleDefault('Location') : $this->locationId;
    }

    // }}}
    // {{{ setLocationId()

    function setLocationId($in_value)
    {
        $this->locationId = $in_value;
    }

    // }}}
    // {{{ getNumAttachments()

    function getNumAttachments()
    {
        return $this->numAttachments;
    }

    // }}}
    // {{{ setNumAttachments()

    function setNumAttachments($in_value)
    {
        $this->numAttachments = $in_value;
    }

    // }}}
    // {{{ updateNumAttachments()

    function updateNumAttachments($in_num) 
    {
        $this->o_dataAccess->updateNumAttachments($this->getId(), $in_num);
    }

    // }}}
    // {{{ getStatusName()

    function getStatusName()
    {
        return $this->statusName;
    }

    // }}}
    // {{{ getStatusColor()

    function getStatusColor()
    {
        return $this->statusColor;
    }

    // }}}
    // {{{ isTicketResolved()

    function isTicketResolved()
    {
        static $s_resolveId;
        if (!isset($s_resolveId)) {
            $o_dao =& FF_DataAccess::factory('Status');
            $s_resolveId = $o_dao->getResolutionStatus();
        }

        return $s_resolveId == $this->getStatusId();
    }

    // }}}
    // {{{ getStatusId()

    function getStatusId($in_checkInProgress = false)
    {
        // Check to see if we sould return the in progress status id
        if ($in_checkInProgress) {
            $o_dao =& FF_DataAccess::factory('Status');
            if (($s_progressId = $o_dao->getInProgressStatus()) &&
                $this->statusId == $this->getModuleDefault('Status')) {
                $this->statusId = $s_progressId;
            }
        }

        return is_null($this->statusId) ? $this->getModuleDefault('Status') : $this->statusId;
    }

    // }}}
    // {{{ setStatusId()

    function setStatusId($in_value)
    {
        $this->statusId = $in_value;
    }

    // }}}
    // {{{ getResolutionResponses()

    function getResolutionResponses()
    {
        $o_dao =& FF_DataAccess::factory('Resolution');
        return $o_dao->getResolutionResponses();
    }

    // }}}
    // {{{ getResolutionId()

    function getResolutionId($in_checkDefault = true)
    {
        if ($in_checkDefault) {
            return empty($this->resolutionId) ? $this->getModuleDefault('Resolution') : $this->resolutionId;
        }
        else {
            return $this->resolutionId;
        }
    }

    // }}}
    // {{{ setResolutionId()

    function setResolutionId($in_value)
    {
        $this->resolutionId = $in_value;
    }

    // }}}
    // {{{ getCategoryName()

    function getCategoryName()
    {
        return $this->categoryName;
    }

    // }}}
    // {{{ getCategoryId()

    function getCategoryId()
    {
        return is_null($this->categoryId) ? $this->getModuleDefault('Category') : $this->categoryId;
    }

    // }}}
    // {{{ setCategoryId()

    function setCategoryId($in_value)
    {
        $this->categoryId = $in_value;
    }

    // }}}
    // {{{ getLastAction()

    function getLastAction()
    {
        return $this->lastAction;
    }

    // }}}
    // {{{ setLastAction()

    function setLastAction($in_value)
    {
        $this->lastAction = $in_value;
    }

    // }}}
    // {{{ _initDataAccess()

    function _initDataAccess()
    {
        $this->o_dataAccess =& FF_DataAccess::factory('Ticket');
    }

    // }}}
}
?>

---