questlab/questtypes/bossfight/BossfightQuesttypeModel.inc

<?php

    /**
     * The Legend of Z
     *
     * @author      Oliver Hanraths <oliver.hanraths@uni-duesseldorf.de>
     * @copyright   2014 Heinrich-Heine-Universität Düsseldorf
     * @license     http://www.gnu.org/licenses/gpl.html
     * @link        https://bitbucket.org/coderkun/the-legend-of-z
     */

    namespace hhu\z\questtypes;


    /**
     * Model of the BossfightQuesttypeAgent for a boss-fight.
     *
     * @author  Oliver Hanraths <oliver.hanraths@uni-duesseldorf.de>
     */
    class BossfightQuesttypeModel extends \hhu\z\models\QuesttypeModel
    {
        /**
         * Required models
         *
         * @var array
         */
        public $models = array('media');




        /**
         * Copy a Quest
         *
         * @param   int $userId             ID of creating user
         * @param   int $sourceQuestId      ID of Quest to copy from
         * @param   int $targetQuestId      ID of Quest to copy to
         * @param   int $seminaryMediaIds   Mapping of SeminaryMedia-IDs from source Seminary to targetSeminary
         */
        public function copyQuest($userId, $sourceQuestId, $targetQuestId, $seminaryMediaIds)
        {
            // Check Seminary media
            if(is_null($seminaryMediaIds)) {
                return;
            }

            // Get boss fight
            $bossfight = $this->getBossFight($sourceQuestId);

            // Copy media
            $this->Media->copyQuestsmedia($userId, $seminaryMediaIds[$bossfight['boss_seminarymedia_id']]);

            // Copy boss fight
            $this->db->query(
                'INSERT INTO questtypes_bossfight '.
                '(quest_id, created_user_id, bossname, boss_seminarymedia_id, lives_character, lives_boss) '.
                'SELECT ?, ?, bossname, ?, lives_character, lives_boss '.
                'FROM questtypes_bossfight '.
                'WHERE quest_id = ?',
                'iiii',
                $targetQuestId, $userId, $seminaryMediaIds[$bossfight['boss_seminarymedia_id']],
                $sourceQuestId
            );

            // Copy stages
            $stage = $this->getFirstStage($sourceQuestId);
            $this->copyStage($userId, $targetQuestId, $stage);
        }


        /**
         * Delete a Quest.
         * 
         * @param   int $questId    ID of Quest to delete
         */
        public function deleteQuest($questId)
        {
            $this->db->query('DELETE FROM questtypes_bossfight WHERE quest_id = ?', 'i', $questId);
        }


        /**
         * Get a Boss-Fight.
         *
         * @param   int     $questId    ID of Quest
         * @return  array               Boss-Fight data
         */
        public function getBossFight($questId)
        {
            $data = $this->db->query(
                'SELECT bossname, boss_seminarymedia_id, lives_character, lives_boss '.
                'FROM questtypes_bossfight '.
                'WHERE quest_id = ?',
                'i',
                $questId
            );
            if(!empty($data)) {
                return $data[0];
            }

            return null;
        }


        /**
         * Get the first Stage to begin the Boss-Fight with.
         *
         * @param   int     $questId    ID of Quest
         * @return  array               Data of first Stage
         */
        public function getFirstStage($questId)
        {
            $data = $this->db->query(
                'SELECT id, parent_stage_id, text, question, livedrain_character, livedrain_boss '.
                'FROM questtypes_bossfight_stages '.
                'WHERE questtypes_bossfight_quest_id = ? AND parent_stage_id IS NULL',
                'i',
                $questId
            );
            if(!empty($data)) {
                return $data[0];
            }


            return null;
        }


        /**
         * Get a Stage by its ID.
         *
         * @param   int     $stageId    ID of Stage
         * @return  array               Stage data or null
         */
        public function getStageById($stageId)
        {
            $data = $this->db->query(
                'SELECT id, text, question, livedrain_character, livedrain_boss '.
                'FROM questtypes_bossfight_stages '.
                'WHERE id = ?',
                'i',
                $stageId
            );
            if(!empty($data)) {
                return $data[0];
            }


            return null;
        }


        /**
         * Get the follow-up Stages for a Stage.
         *
         * @param   int     $parentStageId  ID of Stage to get follow-up Stages for
         * @return  array                   List of follow-up Stages
         */
        public function getChildStages($parentStageId)
        {
            return $this->db->query(
                'SELECT id, parent_stage_id, text, question, livedrain_character, livedrain_boss '.
                'FROM questtypes_bossfight_stages '.
                'WHERE parent_stage_id = ?',
                'i',
                $parentStageId
            );
        }


        /**
         * Reset all Character submissions of a Boss-Fight.
         *
         * @param   int $questId        ID of Quest
         * @param   int $characterId    ID of Character
         */
        public function clearCharacterSubmissions($questId, $characterId)
        {
            $this->db->query(
                'DELETE FROM questtypes_bossfight_stages_characters '.
                'WHERE questtypes_bossfight_stage_id IN ('.
                    'SELECT id '.
                    'FROM questtypes_bossfight_stages '.
                    'WHERE questtypes_bossfight_quest_id = ?'.
                ') AND character_id = ?',
                'ii',
                $questId,
                $characterId
            );
        }


        /**
         * Save Character’s submitted answer for one Boss-Fight-Stage.
         *
         * @param   int $stageId        ID of list
         * @param   int $characterId    ID of Character
         */
        public function setCharacterSubmission($stageId, $characterId)
        {
            $this->db->query(
                'INSERT INTO questtypes_bossfight_stages_characters '.
                '(questtypes_bossfight_stage_id, character_id) '.
                'VALUES '.
                '(?, ?) '.
                'ON DUPLICATE KEY UPDATE '.
                'questtypes_bossfight_stage_id = ?',
                'iii',
                $stageId, $characterId, $stageId
            );
        }


        /**
         * Get answer of one Boss-Fight-Stage submitted by Character.
         *
         * @param   int     $stageId        ID of list
         * @param   int     $characterId    ID of Character
         * @return  boolean                 Stage taken
         */
        public function getCharacterSubmission($stageId, $characterId)
        {
            $data = $this->db->query(
                'SELECT questtypes_bossfight_stage_id '.
                'FROM questtypes_bossfight_stages_characters '.
                'WHERE questtypes_bossfight_stage_id = ? AND character_id = ? ',
                'ii',
                $stageId, $characterId
            );


            return (!empty($data));
        }




        /**
         * Copy a Bossfight stage and its child-stages.
         *
         * @param   int     $userId         ID of copying user
         * @param   int     $targetQuestId  ID of Quest to copy to
         * @param   array   $stage          Data of stage to copy
         * @param   array   $stageIds       Mapping of Stage-IDs from source Seminary to target Seminary
         */
        private function copyStage($userId, $targetQuestId, $stage, $stageIds=array())
        {
            // Copy stage
            if(is_null($stage['parent_stage_id']))
            {
                $this->db->query(
                    'INSERT INTO questtypes_bossfight_stages '.
                    '(questtypes_bossfight_quest_id, text, question, livedrain_character, livedrain_boss) '.
                    'SELECT ?, text, question, livedrain_character, livedrain_boss '.
                    'FROM questtypes_bossfight_stages '.
                    'WHERE id = ?',
                    'ii',
                    $targetQuestId,
                    $stage['id']
                );
            }
            else
            {
                $this->db->query(
                    'INSERT INTO questtypes_bossfight_stages '.
                    '(questtypes_bossfight_quest_id, parent_stage_id, text, question, livedrain_character, livedrain_boss) '.
                    'SELECT ?, ?, text, question, livedrain_character, livedrain_boss '.
                    'FROM questtypes_bossfight_stages '.
                    'WHERE id = ?',
                    'iii',
                    $targetQuestId, $stageIds[$stage['parent_stage_id']],
                    $stage['id']
                );
            }
            $stageIds[$stage['id']] = $this->db->getInsertId();

            // Copy child stages
            $childStages = $this->getChildStages($stage['id']);
            foreach($childStages as $childStage) {
                $this->copyStage($userId, $targetQuestId, $childStage, $stageIds);
            }
        }

    }

?>