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

// }}}
// {{{ class FF_Model_Assignment

// }}}
class FF_Model_Assignment extends FF_Model {
    // {{{ properties

    var $name;

    var $openTime;

    var $lateTime;

    var $closeTime;

    var $session;

    var $ownerId;

    var $courseCode;

    var $batchIds = array();

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

    function reset()
    {
        $this->id = null;
        $this->name = null;
        $this->openTime = null;
        $this->lateTime = null;
        $this->closeTime = null;
        $this->session = null;
        $this->ownerId = null;
        $this->courseCode = null;
        $this->batchIds = array();
    }

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

    function importFromArray($in_data)
    {
        $this->setId($in_data['id']);
        $this->setName($in_data['name']);
        $this->setOpenTime($in_data['open_time']);
        $this->setLateTime($in_data['late_time']);
        $this->setCloseTime($in_data['close_time']);
        $this->setSession($in_data['session']);
        $this->setOwnerId($in_data['owner_id']);
        $this->setCourseCode($in_data['course_code']);
    }

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

    function exportToArray()
    {
        $a_data = array();
        $a_data['id'] = $this->getId();
        $a_data['name'] = $this->getName();
        $a_data['open_time'] = $this->getOpenTime();
        $a_data['late_time'] = $this->getLateTime();
        $a_data['close_time'] = $this->getCloseTime();
        $a_data['session'] = $this->getSession();
        $a_data['owner_id'] = $this->getOwnerId();
        $a_data['course_code'] = $this->getCourseCode();
        return $a_data;
    }

    // }}}
    // {{{ remove()

    function remove($in_id = null)
    {
        $s_id = is_null($in_id) ? $this->getId() : $in_id;
        $o_result =& $this->o_dataAccess->remove($s_id);
        // Remove the associated ftp files
        $o_registry =& FF_Registry::singleton();
        $s_path = $o_registry->getConfigParam('ftp/data_dir');
        if ($o_result->isSuccess() && !empty($s_path)) {
            require_once 'System.php';
            $s_path .= '/' . $s_id;
            @System::rm("-r $s_path");
        }

        return $o_result;
    }

    // }}}
    // {{{ batchEdit()

    function &batchEdit($in_action)
    {
        $o_result = new FF_Result();
        if ($in_action == 'copy') {
            $o_model =& new FF_Model_Assignment();
            foreach ($this->batchIds as $s_id) {
                $o_model->reset();
                if (!$o_model->fillById($s_id)) {
                    $o_result->setSuccess(false);
                    $o_result->addMessage(_('Was unable to copy one of the selected assignments'));
                    continue;
                }

                if ($o_model->getCourseCode() == $this->getCourseCode() ||
                    FastFrame::isEmpty($this->getCourseCode())) {
                    $o_model->setName($o_model->getName() . ' ' . _('[copy]'));
                }

                if (!FastFrame::isEmpty($this->getCourseCode())) {
                    $o_model->setCourseCode($this->getCourseCode());
                }

                if (!FastFrame::isEmpty($this->getSession())) {
                    $o_model->setSession($this->getSession());
                }

                if ($this->getLateTime() > 0) {
                    $o_model->setLateTime($o_model->getLateTime() + $this->getLateTime() * 86400);
                }

                if ($this->getOpenTime() > 0 && $o_model->getOpenTime() != 0) {
                    $o_model->setOpenTime($o_model->getOpenTime() + $this->getOpenTime() * 86400);
                }
                
                if ($this->getCloseTime() > 0 && $o_model->getCloseTime() != 0) {
                    $o_model->setCloseTime($o_model->getCloseTime() + $this->getCloseTime() * 86400);
                }

                $tmp_result =& $o_model->save(false);
                if (!$tmp_result->isSuccess()) {
                    $o_result->setSuccess(false);
                    $o_result->addMessage($tmp_result->getMessages());
                }
            }
        }
        else {
            if (!FastFrame::isEmpty($this->getCourseCode())) {
                if (!$this->o_dataAccess->updateCourseCodes($this->batchIds, $this->getCourseCode(), $this->getOwnerId())) {
                    $o_result->setSuccess(false);
                    $o_result->addMessage(_('Unable to update the course codes'));
                }
            }

            if (!FastFrame::isEmpty($this->getSession())) {
                if (!$this->o_dataAccess->updateSession($this->batchIds, $this->getSession(), $this->getOwnerId())) {
                    $o_result->setSuccess(false);
                    $o_result->addMessage(_('Unable to update the session'));
                }
            }

            if ($this->getLateTime() > 0) {
                if (!$this->o_dataAccess->updateTimes($this->batchIds, $this->getLateTime() * 86400, $this->getOwnerId(), 'late')) {
                    $o_result->setSuccess(false);
                    $o_result->addMessage(_('Unable to update the late times'));
                }
            }

            if ($this->getOpenTime() > 0) {
                if (!$this->o_dataAccess->updateTimes($this->batchIds, $this->getOpenTime() * 86400, $this->getOwnerId(), 'open')) {
                    $o_result->setSuccess(false);
                    $o_result->addMessage(_('Unable to update the open times'));
                }
            }

            if ($this->getCloseTime() > 0) {
                if (!$this->o_dataAccess->updateTimes($this->batchIds, $this->getCloseTime() * 86400, $this->getOwnerId(), 'close')) {
                    $o_result->setSuccess(false);
                    $o_result->addMessage(_('Unable to update the close times'));
                }
            }
        }

        return $o_result;
    }

    // }}}
    // {{{ setBatchIds()

    function setBatchIds($in_ids)
    {
        $this->batchIds = (array) $in_ids;
    }

    // }}}
    // {{{ getDescriptionsById()

    function getDescriptionsById($in_ids) {
        return $this->o_dataAccess->getDescriptionsById($in_ids);
    }

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

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

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

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

    // }}}
    // {{{ getFormattedOpenTime()

    function getFormattedOpenTime()
    {
        return empty($this->openTime) ? _('N/A') : date('m/d/Y H:i', $this->openTime);
    }

    // }}}
    // {{{ getOpenTime()

    function getOpenTime()
    {
        return $this->openTime;
    }

    // }}}
    // {{{ setOpenTime()

    function setOpenTime($in_value)
    {
        $this->openTime = $in_value;
    }

    // }}}
    // {{{ getFormattedLateTime()

    function getFormattedLateTime()
    {
        return date('m/d/Y H:i', $this->lateTime);
    }

    // }}}
    // {{{ getLateTime()

    function getLateTime()
    {
        return is_null($this->lateTime) ? time() : $this->lateTime;
    }

    // }}}
    // {{{ setLateTime()

    function setLateTime($in_value)
    {
        $this->lateTime = $in_value;
    }

    // }}}
    // {{{ getFormattedCloseTime()

    function getFormattedCloseTime()
    {
        return empty($this->closeTime) ? _('N/A') : date('m/d/Y H:i', $this->closeTime);
    }

    // }}}
    // {{{ getCloseTime()

    function getCloseTime()
    {
        return $this->closeTime;
    }

    // }}}
    // {{{ setCloseTime()

    function setCloseTime($in_value)
    {
        $this->closeTime = $in_value;
    }

    // }}}
    // {{{ getSessionOptions()

    function getSessionOptions($in_addEmpty = false)
    {
        $a_options = $this->o_dataAccess->getSessionOptions();
        if ($in_addEmpty) {
            $a_options = array_merge(array('' => ''), $a_options);
        }
        
        return $a_options;
    }

    // }}}
    // {{{ getSession()

    function getSession()
    {
        return $this->session;
    }

    // }}}
    // {{{ setSession()

    function setSession($in_value)
    {
        $this->session = $in_value;
    }

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

    function getOwnerId()
    {
        return $this->ownerId;
    }

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

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

    // }}}
    // {{{ getClassOptions()

    function getClassOptions($in_addEmpty = false)
    {
        $a_options = $this->o_dataAccess->getClassOptions();
        if ($in_addEmpty) {
            $a_options = array_merge(array('' => ''), $a_options);
        }
        
        return $a_options;
    }

    // }}}
    // {{{ getCourseCode()

    function getCourseCode()
    {
        return $this->courseCode;
    }

    // }}}
    // {{{ setCourseCode()

    function setCourseCode($in_value)
    {
        $this->courseCode = $in_value;
    }

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

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

    // }}}
}
?>

---