Model/Filter.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';

// }}}
// {{{ constants

define('TEXT_EQUALS', 1);
define('TEXT_BEGINS_WITH', 2);
define('TEXT_ENDS_WITH', 3);
define('TEXT_CONTAINS', 4);
define('TEXT_MATCHES', 5);
define('DATE_MINUTES', 1);
define('DATE_HOURS', 2);
define('DATE_DAYS', 3);
define('DATE_MONTHS', 4);
define('DATE_LESS', 1);
define('DATE_MORE', 2);
define('FILTER_AND', 0);
define('FILTER_OR', 1);
define('COMMENTS_BOTH', 0);
define('COMMENTS_NEW', 1);
define('COMMENTS_NOT_NEW', 2);

// }}}
// {{{ class FF_Model_Filter

// }}}
class FF_Model_Filter extends FF_Model {
    // {{{ properties

    var $name = '';

    var $operator = 0;

    var $sortField = 'last_updated';

    var $sortOrder = 0;

    var $newComments = 0;

    var $summaryOperator = 0;
    
    var $summaryType = 0;

    var $summary = '';

    var $descriptionOperator = 0;
    
    var $descriptionType = 0;

    var $description = '';

    var $reporterOperator = 0;
    
    var $reporterType = 0;

    var $reporter = '';

    var $points = array();

    var $locations = array();

    var $resolutions = array();

    var $categories = array();

    var $handlers = array();

    var $statuses = array();

    var $ownerId;

    var $lastUpdatedOperator = 0;

    var $lastUpdatedNum = 0;

    var $lastUpdatedType = 0;

    var $createDateOperator = 0;

    var $createDateNum = 0;

    var $createDateType = 0;

    var $dueDateOperator = 0;

    var $dueDateNum = 0;

    var $dueDateType = 0;

    var $lastAction = array();

    // }}}
    // {{{ reset()


    function reset()
    {
        $this->id = null;
        $this->name = '';
        $this->operator = 0;
        $this->sortField = '';
        $this->sortOrder = 1;
        $this->newComments = 0;
        $this->summaryType = 0;
        $this->summary = '';
        $this->descriptionOperator = 0;
        $this->descriptionType = 0;
        $this->description = '';
        $this->reporterOperator = 0;
        $this->reporterType = 0;
        $this->reporter = '';
        $this->points = array();
        $this->locations = array();
        $this->resolutions = array();
        $this->categories = array();
        $this->handlers = array();
        $this->statuses = array();
        $this->ownerId = null;
        $this->lastUpdatedOperator = 0;
        $this->lastUpdatedNum = 0;
        $this->lastUpdatedType = 0;
        $this->createDateOperator = 0;
        $this->createDateNum = 0;
        $this->createDateType = 0;
        $this->dueDateOperator = 0;
        $this->dueDateNum = 0;
        $this->dueDateType = 0;
        $this->lastAction = array();
    }

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

    function importFromArray($in_data)
    {
        $this->setId($in_data['id']);
        $this->setName($in_data['name']);
        $this->setOperator($in_data['operator']);
        $this->setSortField($in_data['sort_field']);
        $this->setSortOrder($in_data['sort_order']);
        $this->setNewComments($in_data['new_comments']);
        $this->setSummaryOperator($in_data['summary_operator']);
        $this->setSummaryType($in_data['summary_type']);
        $this->setSummary($in_data['summary']);
        $this->setDescriptionOperator($in_data['description_operator']);
        $this->setDescriptionType($in_data['description_type']);
        $this->setDescription($in_data['description']);
        $this->setReporterOperator($in_data['reporter_operator']);
        $this->setReporterType($in_data['reporter_type']);
        $this->setReporter($in_data['reporter']);
        $this->setOwnerId($in_data['owner_id']);
        $this->setPoints(unserialize($in_data['points']));
        $this->setLocations(unserialize($in_data['locations']));
        $this->setResolutions(unserialize($in_data['resolutions']));
        $this->setCategories(unserialize($in_data['categories']));
        $this->setHandlers(unserialize($in_data['handlers']));
        $this->setStatuses(unserialize($in_data['statuses']));
        $this->setLastAction(unserialize($in_data['last_action']));
        $this->setLastUpdatedOperator($in_data['last_updated_operator']);
        $this->setLastUpdatedNum($in_data['last_updated_num']);
        $this->setLastUpdatedType($in_data['last_updated_type']);
        $this->setCreateDateOperator($in_data['create_date_operator']);
        $this->setCreateDateNum($in_data['create_date_num']);
        $this->setCreateDateType($in_data['create_date_type']);
        $this->setDueDateOperator($in_data['due_date_operator']);
        $this->setDueDateNum($in_data['due_date_num']);
        $this->setDueDateType($in_data['due_date_type']);
    }

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

    function exportToArray()
    {
        $a_data = array();
        $a_data['id'] = $this->getId();
        $a_data['name'] = $this->getName();
        $a_data['operator'] = $this->getOperator();
        $a_data['sort_field'] = $this->getSortField();
        $a_data['sort_order'] = $this->getSortOrder();
        $a_data['new_comments'] = $this->getNewComments();
        $a_data['summary_operator'] = $this->getSummaryOperator();
        $a_data['summary_type'] = $this->getSummaryType();
        $a_data['summary'] = $this->getSummary();
        $a_data['description_operator'] = $this->getDescriptionOperator();
        $a_data['description_type'] = $this->getDescriptionType();
        $a_data['description'] = $this->getDescription();
        $a_data['reporter_operator'] = $this->getReporterOperator();
        $a_data['reporter_type'] = $this->getReporterType();
        $a_data['reporter'] = $this->getReporter();
        $a_data['owner_id'] = $this->getOwnerId();
        $a_data['points'] = serialize($this->getPoints());
        $a_data['locations'] = serialize($this->getLocations());
        $a_data['resolutions'] = serialize($this->getResolutions());
        $a_data['categories'] = serialize($this->getCategories());
        $a_data['handlers'] = serialize($this->getHandlers());
        $a_data['statuses'] = serialize($this->getStatuses());
        $a_data['last_action'] = serialize($this->getLastAction());
        $a_data['last_updated_operator'] = $this->getLastUpdatedOperator();
        $a_data['last_updated_num'] = $this->getLastUpdatedNum();
        $a_data['last_updated_type'] = $this->getLastUpdatedType();
        $a_data['create_date_operator'] = $this->getCreateDateOperator();
        $a_data['create_date_num'] = $this->getCreateDateNum();
        $a_data['create_date_type'] = $this->getCreateDateType();
        $a_data['due_date_operator'] = $this->getDueDateOperator();
        $a_data['due_date_num'] = $this->getDueDateNum();
        $a_data['due_date_type'] = $this->getDueDateType();
        return $a_data;
    }

    // }}}
    // {{{ getName()

    function getName()
    {
        return $this->name;
    }

    // }}}
    // {{{ setName()

    function setName($in_value)
    {
        $this->name = $in_value;
    }

    // }}}
    // {{{ getOperator()

    function getOperator()
    {
        return $this->operator;
    }

    // }}}
    // {{{ setOperator()

    function setOperator($in_value)
    {
        $this->operator = $in_value;
    }

    // }}}
    // {{{ getSortFieldOptions()

    function getSortFieldOptions()
    {
        return array('points' => _('Priority'), 'ticket_updated' => _('Has New Comments'), 
                'create_date' => _('Submitted'), 'last_updated' => _('Last Updated'),
                'due_date' => _('Due Date'), 'progress' => _('Progress'),
                'status_name' => _('Status'));
    }

    // }}}
    // {{{ getSortField()

    function getSortField()
    {
        return empty($this->sortField) ? 'points' : $this->sortField;
    }

    // }}}
    // {{{ setSortField()

    function setSortField($in_value)
    {
        $this->sortField = $in_value;
    }

    // }}}
    // {{{ getSortOrder()

    function getSortOrder()
    {
        return $this->sortOrder;
    }

    // }}}
    // {{{ setSortOrder()

    function setSortOrder($in_value)
    {
        $this->sortOrder = $in_value;
    }

    // }}}
    // {{{ getNewComments()

    function getNewComments()
    {
        return $this->newComments;
    }

    // }}}
    // {{{ setNewComments()

    function setNewComments($in_value)
    {
        $this->newComments = $in_value;
    }

    // }}}
    // {{{ getDateOperatorOptions()

    function getDateOperatorOptions()
    {
        return array(DATE_LESS => _('less than'), DATE_MORE => _('more than'));
    }

    // }}}
    // {{{ getDateTypeOptions()

    function getDateTypeOptions()
    {
        return array(DATE_MINUTES => _('Minutes'), DATE_HOURS => _('Hours'), DATE_DAYS => _('Days'), DATE_MONTHS => _('Months'));
    }

    // }}}
    // {{{ getTextOperatorOptions()

    function getTextOperatorOptions()
    {
        return array(0 => _('Does Not'), 1 => _('Does'));
    }

    // }}}
    // {{{ getTextTypeOptions()

    function getTextTypeOptions()
    {
        return array(TEXT_EQUALS => _('Equal'), TEXT_BEGINS_WITH => _('Begin with'),
                TEXT_ENDS_WITH => _('End with'), TEXT_CONTAINS => _('Contain'),
                TEXT_MATCHES => _('Match (regexp)'));
    }

    // }}}
    // {{{ getSummaryOperator()

    function getSummaryOperator()
    {
        return $this->summaryOperator;
    }

    // }}}
    // {{{ setSummaryOperator()

    function setSummaryOperator($in_value)
    {
        $this->summaryOperator = $in_value;
    }

    // }}}
    // {{{ getSummaryType()

    function getSummaryType()
    {
        return $this->summaryType;
    }

    // }}}
    // {{{ setSummaryType()

    function setSummaryType($in_value)
    {
        $this->summaryType = $in_value;
    }

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

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

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

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

    // }}}
    // {{{ getDescriptionOperator()

    function getDescriptionOperator()
    {
        return $this->descriptionOperator;
    }

    // }}}
    // {{{ setDescriptionOperator()

    function setDescriptionOperator($in_value)
    {
        $this->descriptionOperator = $in_value;
    }

    // }}}
    // {{{ getDescriptionType()

    function getDescriptionType()
    {
        return $this->descriptionType;
    }

    // }}}
    // {{{ setDescriptionType()

    function setDescriptionType($in_value)
    {
        $this->descriptionType = $in_value;
    }

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

    function getDescription()
    {
        return $this->description;
    }

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

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

    // }}}
    // {{{ getReporterOperator()

    function getReporterOperator()
    {
        return $this->reporterOperator;
    }

    // }}}
    // {{{ setReporterOperator()

    function setReporterOperator($in_value)
    {
        $this->reporterOperator = $in_value;
    }

    // }}}
    // {{{ getReporterType()

    function getReporterType()
    {
        return $this->reporterType;
    }

    // }}}
    // {{{ setReporterType()

    function setReporterType($in_value)
    {
        $this->reporterType = $in_value;
    }

    // }}}
    // {{{ getReporter()

    function getReporter()
    {
        return $this->reporter;
    }

    // }}}
    // {{{ setReporter()

    function setReporter($in_value)
    {
        $this->reporter = $in_value;
    }

    // }}}
    // {{{ getOwnerId()

    function getOwnerId()
    {
        return is_null($this->ownerId) ? FF_Auth::getCredential('userId') : $this->ownerId;
    }

    // }}}
    // {{{ setOwnerId()

    function setOwnerId($in_value)
    {
        $this->ownerId = $in_value;
    }

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

    function getPoints()
    {
        return $this->points;
    }

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

    function setPoints($in_value)
    {
        $this->points = $in_value;
    }

    // }}}
    // {{{ getLocations()

    function getLocations()
    {
        return $this->locations;
    }

    // }}}
    // {{{ setLocations()

    function setLocations($in_value)
    {
        $this->locations = $in_value;
    }

    // }}}
    // {{{ getResolutions()

    function getResolutions()
    {
        return $this->resolutions;
    }

    // }}}
    // {{{ setResolutions()

    function setResolutions($in_value)
    {
        $this->resolutions = $in_value;
    }

    // }}}
    // {{{ getCategories()

    function getCategories()
    {
        return $this->categories;
    }

    // }}}
    // {{{ setCategories()

    function setCategories($in_value)
    {
        $this->categories = $in_value;
    }

    // }}}
    // {{{ getHandlers()

    function getHandlers()
    {
        return $this->handlers;
    }

    // }}}
    // {{{ setHandlers()

    function setHandlers($in_value)
    {
        $this->handlers = $in_value;
    }

    // }}}
    // {{{ getStatuses()

    function getStatuses()
    {
        return $this->statuses;
    }

    // }}}
    // {{{ setStatuses()

    function setStatuses($in_value)
    {
        $this->statuses = $in_value;
    }

    // }}}
    // {{{ getLastUpdatedOperator()

    function getLastUpdatedOperator()
    {
        return $this->lastUpdatedOperator;
    }

    // }}}
    // {{{ setLastUpdatedOperator()

    function setLastUpdatedOperator($in_value)
    {
        $this->lastUpdatedOperator = $in_value;
    }

    // }}}
    // {{{ getLastUpdatedNum()

    function getLastUpdatedNum()
    {
        return empty($this->lastUpdatedNum) ? '' : $this->lastUpdatedNum;
    }

    // }}}
    // {{{ setLastUpdatedNum()

    function setLastUpdatedNum($in_value)
    {
        $this->lastUpdatedNum = $in_value;
    }

    // }}}
    // {{{ getLastUpdatedType()

    function getLastUpdatedType()
    {
        return $this->lastUpdatedType;
    }

    // }}}
    // {{{ setLastUpdatedType()

    function setLastUpdatedType($in_value)
    {
        $this->lastUpdatedType = $in_value;
    }

    // }}}
    // {{{ getCreateDateOperator()

    function getCreateDateOperator()
    {
        return $this->createDateOperator;
    }

    // }}}
    // {{{ setCreateDateOperator()

    function setCreateDateOperator($in_value)
    {
        $this->createDateOperator = $in_value;
    }

    // }}}
    // {{{ getCreateDateNum()

    function getCreateDateNum()
    {
        return empty($this->createDateNum) ? '' : $this->createDateNum;
    }

    // }}}
    // {{{ setCreateDateNum()

    function setCreateDateNum($in_value)
    {
        $this->createDateNum = $in_value;
    }

    // }}}
    // {{{ getCreateDateType()

    function getCreateDateType()
    {
        return $this->createDateType;
    }

    // }}}
    // {{{ setCreateDateType()

    function setCreateDateType($in_value)
    {
        $this->createDateType = $in_value;
    }

    // }}}
    // {{{ getDueDateOperator()

    function getDueDateOperator()
    {
        return $this->dueDateOperator;
    }

    // }}}
    // {{{ setDueDateOperator()

    function setDueDateOperator($in_value)
    {
        $this->dueDateOperator = $in_value;
    }

    // }}}
    // {{{ getDueDateNum()

    function getDueDateNum()
    {
        return empty($this->dueDateNum) ? '' : $this->dueDateNum;
    }

    // }}}
    // {{{ setDueDateNum()

    function setDueDateNum($in_value)
    {
        $this->dueDateNum = $in_value;
    }

    // }}}
    // {{{ getDueDateType()

    function getDueDateType()
    {
        return $this->dueDateType;
    }

    // }}}
    // {{{ setDueDateType()

    function setDueDateType($in_value)
    {
        $this->dueDateType = $in_value;
    }

    // }}}
    // {{{ getLastActionOptions()

    function getLastActionOptions()
    {
        return array(ACTION_ADD_SUBMIT => _('Mayday Created'), 
                     'email_add' => _('Mayday Created via Email'),
                     ACTION_EDIT_SUBMIT => _('Mayday Updated'),
                     ACTION_RESOLVE_SUBMIT => _('Mayday Resolved'),
                     'new_public_comment' => _('Public Comment Added'),
                     'new_private_comment' => _('Private Comment Added'));
    }

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

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

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

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

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

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

    // }}}
}
?>

---