form_submission.inc

<?php
require_once SQ_INCLUDE_PATH.'/asset.inc';

class Form_Submission extends Asset
{


    function Form_Submission($assetid=0)
    {
        $this->_ser_attrs = TRUE;
        return $this->Asset($assetid);

    }//end constructor


    public function canCloneLink()
    {
        return FALSE;

    }//end isDeletableLink()


    function getAnswer($id)
    {
        $a = $this->attr('attributes');
        if (isset($a['answers'][$id]['answer'])) {
            return $a['answers'][$id]['answer'];
        }
        return FALSE;

    }//end getAnswer()


    function getExtraData($id)
    {
        $a = $this->attr('attributes');
        if (isset($a['answers'][$id]['extra_data'])) {
            return $a['answers'][$id]['extra_data'];
        }
        return Array();

    }//end getExtraData()


    function getName($id)
    {
        $a = $this->attr('attributes');
        if (isset($a['answers'][$id]['name'])) {
            return $a['answers'][$id]['name'];
        }
        return FALSE;

    }//end getName()


    function setAnswer($id, $value)
    {
        $a = $this->attr('attributes');
        if (empty($a['answers'])) $a['answers'] = Array();

        $a['answers'][$id]['answer'] = $value;

        if (!$this->setAttrValue('attributes', $a)) {
            return FALSE;
        }

        return TRUE;

    }//end setAnswer()


    function setExtraData($id, Array $data=NULL)
    {
        $a = $this->attr('attributes');
        if (empty($a['answers'])) $a['answers'] = Array();

        $a['answers'][$id]['extra_data'] = $data;

        if (!$this->setAttrValue('attributes', $a)) {
            return FALSE;
        }

        return TRUE;

    }//end setAnswer()


    function setError($error)
    {
        $a = $this->attr('attributes');
        if (!isset($a['is_error']) || !$a['is_error']) {
            $a['is_error'] = TRUE;
        }
        if (!isset($a['errors'])) $a['errors'] = Array();
        $a['errors'][] = $error;

        if (!$this->setAttrValue('attributes', $a)) {
            return FALSE;
        }
        return TRUE;

    }//end setError()


    function getErrors()
    {
        $a = $this->attr('attributes');
        return array_get_index($a, 'errors', Array());

    }//end getErrors()


    function flushErrors()
    {
        $a = $this->attr('attributes');
        $a['is_error'] = FALSE;
        $a['errors'] = Array();

        if (!$this->setAttrValue('attributes', $a)) {
            return FALSE;
        }

        return TRUE;

    }//end flushErrors()


    function isError()
    {
        $a = $this->attr('attributes');
        return (isset($a['is_error']) && ($a['is_error'])) ? TRUE : FALSE;

    }//end isError()


    function getAnswers()
    {
        $a = $this->attr('attributes');
        return array_get_index($a, 'answers', Array());

    }//end getAnswers()


    function setSummary($question_id, $name, $value)
    {
        $a = $this->attr('attributes');

        if (empty($a['summary'])) $a['summary'] = Array();

        $a['summary'][$question_id]['answer']  = $value;
        $a['summary'][$question_id]['name']    = $name;

        if (!$this->setAttrValue('attributes', $a)) {
            return FALSE;
        }

        return TRUE;

    }//end setSummary()


    function getSummary($q_id=NULL, $value='answer')
    {
        $a = $this->attr('attributes');
        if (!$a || !isset($a['summary'])) return FALSE;

        if (is_null($q_id)) {
            return $a['summary'];
        } else {
            return $a['summary'][$q_id][$value];
        }

    }//end getSummary()


    function saveAttributes($dont_run_updated=FALSE, $log_message=TRUE)
    {
        $GLOBALS['SQ_SYSTEM']->setRunLevel(SQ_RUN_LEVEL_FORCED);
        $val = parent::saveAttributes($dont_run_updated, $log_message);
        $GLOBALS['SQ_SYSTEM']->restoreRunLevel();

        return $val;

    }//end saveAttributes()


    function incrementVersion($number='micro', $update_parents=TRUE)
    {
        return parent::incrementVersion($number, FALSE);

    }//end incrementVersion()


    function printFrontend()
    {
        if (isset($_GET['q']) && $_GET['q'] && (SQ_IN_BACKEND || SQ_IN_LIMBO)) {
            // Download a file upload, but only if we are on the backend somewhere
            $question_assetid = $_GET['q'];
            $question_asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($question_assetid, '', TRUE);

            if ($question_asset && ($question_asset instanceof Form_Question_Type_File_Upload)) {
                $extra_data = $this->getExtraData($question_assetid);
                if (!empty($extra_data['filesystem_path'])) {
                    $filepath = $extra_data['filesystem_path'];
                    if (is_file($filepath)) {
                        require SQ_FUDGE_PATH.'/standards_lists/mime_types.inc';
                        $type = array_get_index($standards_lists_mime_types, get_file_type($filepath), 'application/octet-stream');

                        header('Content-type: '.$type);
                        header('Content-disposition: attachment; filename="'.(basename($filepath)).'"');
                        header('Content-length: '.filesize($filepath));
                        echo file_get_contents($filepath);
                    }
                }
            }

            exit(0);
        } else {
            parent::printFrontend();
        }

    }//end printFrontend()
    

    function printBody()
    {
        $summary = $this->attr('attributes');
        $summary = $summary['summary'];
        ?>
        <table>
            <thead>
                <tr>
                    <th>Question</th>
                    <th>Answer</th>
                </tr>
            </thead>
            <tbody>
            <?php
            foreach ($summary as $item) {
                ?>
                <tr>
                    <td><?php echo $item['name']; ?></td>
                    <td><?php echo $item['answer']; ?></td>
                </tr>
                <?php
            }
            ?>
            </tbody>
        </table>
        <?php

    }//end printBody()


    function getKeywordReplacement($keyword)
    {
        $matches = Array();
        $original_keyword = $keyword;
        $keyword = parse_keyword($keyword, $modifiers);

        if (preg_match('/question\_name\_q([0-9]+)/', $keyword, $matches)) {
            $attrs = $this->attr('attributes');         
            if (!isset($attrs['summary'])) return '';

            foreach ($attrs['summary'] as $name => $value) {
                $q_ids = explode(':q', $name);
                if ($q_ids[1] == $matches[1]) {
                    apply_keyword_modifiers($value['name'], $modifiers, Array('assetid' => $this->id));
                    return $value['name'];
                }
            }
            return '';
        }

        if (preg_match('/question\_name\_(([0-9]+)\_q([0-9]+))/', $keyword, $matches)) {
            $attrs = $this->attr('attributes');         
            if (!isset($attrs['summary'])) return '';

            $elt = array_get_index($attrs['summary'], $matches[2].':q'.$matches[3], Array('name' => ''));
            apply_keyword_modifiers($elt['name'], $modifiers, Array('assetid' => $this->id));
            return $elt['name'];
        }

        if (preg_match('/question\_answer\_q([0-9]+)/', $keyword, $matches)) {
            $attrs = $this->attr('attributes');         
            if (!isset($attrs['summary'])) return '';

            foreach ($attrs['summary'] as $name => $value) {
                $q_ids = explode(':q', $name);
                if ($q_ids[1] == $matches[1]) {
                    apply_keyword_modifiers($value['answer'], $modifiers, Array('assetid' => $this->id));
                    return $value['answer'];
                }
            }
            return '';
        }

        if (preg_match('/question\_answer\_(([0-9]+)\_q([0-9]+))/', $keyword, $matches)) {
            $attrs = $this->attr('attributes');
            if (!isset($attrs['summary'])) return '';

            $elt = array_get_index($attrs['summary'], $matches[2].':q'.$matches[3], Array('answer' => ''));
            apply_keyword_modifiers($elt['answer'], $modifiers, Array('assetid' => $this->id));
            return $elt['answer'];
        }

        if (preg_match('/question\_answer\_key\_q([0-9]+)/', $keyword, $matches)) {
            $attrs = $this->attr('attributes');         
            foreach ($attrs['answers'] as $name => $value) {
                $q_ids = explode(':q', $name);
                if ($q_ids[1] == $matches[1]) {
                    if (!is_scalar($value['answer'])) {
                        $value = array_get_index($attrs['summary'], $name, Array('answer' => ''));
                    }
                    apply_keyword_modifiers($value['answer'], $modifiers, Array('assetid' => $this->id));
                    return $value['answer'];
                }
            }
            return '';
        }

        //do keyword replacement for question types that have both keys and values in the answers such as select or country question types
        if (preg_match('/question\_answer\_key\_(([0-9]+)\_q([0-9]+))/', $keyword, $matches)) {
            $attrs = $this->attr('attributes');
            $elt = array_get_index($attrs['answers'], $matches[2].':q'.$matches[3], Array('answer' => ''));
            //return the summary if the answers key is not a scalar value such as tickbox list question type
            if (!is_scalar($elt['answer'])) {
                $elt = array_get_index($attrs['summary'], $matches[2].':q'.$matches[3], Array('answer' => ''));
            }
            apply_keyword_modifiers($elt['answer'], $modifiers, Array('assetid' => $this->id));
            return $elt['answer'];
        }

        // if we are falling back on parent to get the keyword replacement make
        // sure we pass the whole keyword i.e. including the modifier(s) if any
        return parent::getKeywordReplacement($original_keyword);

    }//end getKeywordReplacement()


    function getAvailableKeywords()
    {
        $res = parent::getAvailableKeywords();
        $res['question_name_X_qY'] = 'The name of the question with ID X:qY';
        $res['question_answer_X_qY'] = 'The answer to the question with ID X:qY';
        $res['question_answer_key_X_qY'] = 'The answer key to the question with ID X:qY';
        $res['submission_ip_address'] = 'IP address that created this submission';
        return $res;

    }//end getAvailableKeywords()


    function getIP()
    {
        $a = $this->attr('attributes');
        if (isset($a['misc']['ip'])) return $a['misc']['ip'];
        return FALSE;

    }//end getIP()


    function setIP($ip)
    {
        $a = $this->attr('attributes');
        if (empty($a['mics'])) $a['misc'] = Array();

        $a['misc']['ip'] = $ip;

        if (!$this->setAttrValue('attributes', $a)) {
            return FALSE;
        }

        return TRUE;

    }//end setIP()


    function getSubmissionIpAddressKeywordReplacement()
    {
        return $this->getIP();

    }//end getSubmissionIpAddressKeywordReplacement()


    function _getAllowedLinks()
    {
        $page_links = Array(
                        SQ_LINK_NOTICE  => Array(
                                            'file'  => Array(
                                                        'card'      => 'M',
                                                        'exclusive' => FALSE,
                                                       ),
                                           ),
                      );
        return $page_links;

    }//end _getAllowedLinks()


}//end class
?>