AssignmentList.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/Action/List.php';

// }}}
// {{{ class FF_Action_List_Assignment

// }}}
class FF_Action_List_Assignment extends FF_Action_List {
    // {{{ renderAdditionalLinks()

    function renderAdditionalLinks()
    {
        $this->o_output->o_tpl->append('page_links', $this->o_output->link(
                    '#', sprintf(_('Batch Edit'), $this->getSingularText()), 
                    array('onclick' => 'validateAndSubmit("' . ACTION_BATCH_EDIT . '")')));

        $this->o_output->o_tpl->append('page_links', $this->o_output->link(
                    '#', sprintf(_('Batch Delete'), $this->getSingularText()), 
                    array('onclick' => 'validateAndSubmit("' . ACTION_BATCH_DELETE . '")')));

        $this->o_output->o_tpl->append('page_links', $this->o_output->link(
                    FastFrame::selfURL(array('actionId' => ACTION_ADD)),
                    sprintf(_('Add New %s'), $this->getSingularText())));
    }

    // }}}
    // {{{ createListTable()

    function createListTable()
    {
        $s_html = parent::createListTable();
        return '<form action="' . FastFrame::selfURL() . '" name="batch_assignments" method="post">
                <input type="hidden" name="actionId" />
                ' . $s_html . '
                </form>';
    }
    
    // }}}
    // {{{ getHighlightedRowUrl()

    function getHighlightedRowUrl()
    {
        return FastFrame::selfURL(array('actionId' => ACTION_EDIT, 'objectId' => $this->o_model->getId()));
    }

    // }}}
    // {{{ getFilter()

    function getFilter()
    {
        return array(FILTER_BY_OWNER, array('ownerId' => FF_Auth::getCredential('userId')));
    }

    // }}}
    // {{{ getDefaultSortField()
    
    function getDefaultSortField()
    {
        return 'course_code';
    }

    // }}}
    //{{{ getFieldMap()

    function getFieldMap()
    {
        $this->_renderCheckboxJs();
        return array(
            array('description' => _('Batch Edit'), 'img' => '<input type="checkbox" id="chkbox_toggler" onclick="toggleCheckboxes();" />',
                'method' => '_getCheckBox', 'object' => &$this, 'dataIsSafe' => true),
            array('description' => _('Options'), 'method' => 'getOptions'),
            array('field' => 'course_code', 'description' => _('Course Code'), 'method' => 'getCourseCode'),
            array('field' => 'name', 'description' => _('Name'), 'method' => 'getName'),
            array('field' => 'session', 'description' => _('Session'), 'method' => 'getSession'),
            array('field' => 'open_time', 'description' => _('Open Date'), 'method' => 'getFormattedOpenTime'),
            array('field' => 'late_time', 'description' => _('Due Date'), 'method' => 'getFormattedLateTime'),
            array('field' => 'close_time', 'description' => _('Close Date'), 'method' => 'getFormattedCloseTime'),
        );
    }

    // }}}
    // {{{ getButtonCells()
    
    function getButtonCells()
    {
        return array('getOptions', '_getCheckBox');
    }

    // }}}
    // {{{ getSingularText()

    function getSingularText()
    {
        return _('Assignment');
    }

    // }}}
    // {{{ getPluralText()

    function getPluralText()
    {
        return _('Assignments');
    }

    // }}}
    // {{{ getOptions()

    function getOptions()
    {
        $tmp_text = '';
        $tmp_text .= $this->o_output->link(
                FastFrame::selfURL(array(
                        'actionId' => ACTION_EDIT, 'objectId' => $this->o_model->getId())),
                $this->o_output->imgTag('edit.gif', 'actions'),
                array('title' => sprintf (_('Edit %s'), $this->getSingularText()))); 

        $tmp_text .= ' ';
        $tmp_text .= $this->o_output->link(
                FastFrame::selfURL(array(
                        'actionId' => ACTION_DELETE, 'objectId' => $this->o_model->getId())),
                $this->o_output->imgTag('delete.gif', 'actions'),
                array('title' => sprintf (_('Delete %s'), $this->getSingularText()), 
                    'confirm' => sprintf(_('Are you sure you want to delete this %1$s?  All ftp data associated with this %1$s will also be deleted!'), $this->getSingularText()))); 

        return $tmp_text;
    }

    // }}}
    // {{{ checkPerms()

    function checkPerms()
    {
        if (!$this->o_perms->hasPerm('can_use_homework')) {
            $this->o_nextAction->setNextActionId(ACTION_PROBLEM);
            $this->o_output->setMessage(_('You cannot use the assignment application.'), FASTFRAME_ERROR_MESSAGE);
            return false;
        }
        else {
            return true;
        }
    }

    // }}}
    // {{{ _getCheckBox()

    function _getCheckBox()
    {
        return '<input type="checkbox" name="assignment[' . $this->o_model->getId() . ']" />';
    }

    // }}}
    // {{{ _renderCheckboxJs()

    function _renderCheckboxJs()
    {
        ob_start();
        ?>
        <script language="JavaScript" type="text/javascript">
        <!--
        // {{{ toggleCheckboxes()

        function toggleCheckboxes()
        {
            var ckBx = document.getElementById('listTableHighlight').getElementsByTagName('input')
            for (i=0; i < ckBx.length; i++) {
                if (ckBx[i].getAttribute('type') == 'checkbox') {
                    ckBx[i].checked = document.getElementById('chkbox_toggler').checked;
                }
            }
        } 

        // }}}
        // {{{ validateAndSubmit()

        function validateAndSubmit(actionId)
        {
            if (validateCheckboxes()) {
                if (actionId == "<?php echo ACTION_BATCH_DELETE; ?>" &&
                    !window.confirm("<?php echo _('Are you sure you want to delete the checked assignments?  All ftp data associated with these assignments will also be deleted!'); ?>")) {
                    return false;
                }

                document.batch_assignments["actionId"].value = actionId;
                document.batch_assignments.submit();
                return true;
            }
            else {
                return false;
            }
        }

        // }}}
        // {{{ validateCheckboxes()

        function validateCheckboxes()
        {
            var ckBx = document.getElementById('listTableHighlight').getElementsByTagName('input')
            for (i=0; i < ckBx.length; i++) {
                if (ckBx[i].getAttribute('type') == 'checkbox' && 
                    ckBx[i].id != 'chkbox_toggler' &&
                    ckBx[i].checked) {
                    return true;
                }
            }

            alert("<?php echo _('You must check at least one checkbox in order to use the batch editing feature.'); ?>");
            return false;
        } 

        // }}}
        //-->
        </script>
        <?php
        $this->o_output->o_tpl->append('javascript', ob_get_contents());
        ob_end_clean();
    }

    // }}}
}
?>

---