509 lines
14 KiB
PHP
509 lines
14 KiB
PHP
<?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\models;
|
|
|
|
|
|
/**
|
|
* Model to interact with Questgroups-table.
|
|
*
|
|
* @author Oliver Hanraths <oliver.hanraths@uni-duesseldorf.de>
|
|
*/
|
|
class QuestgroupsModel extends \hhu\z\Model
|
|
{
|
|
/**
|
|
* Required models
|
|
*
|
|
* @var array
|
|
*/
|
|
public $models = array('questgroupshierarchy', 'quests', 'questtexts');
|
|
|
|
|
|
|
|
|
|
/**
|
|
* Construct a new QuestgroupsModel.
|
|
*/
|
|
public function __construct()
|
|
{
|
|
parent::__construct();
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
* Get all Questgroups for a Questgroup hierarchy.
|
|
*
|
|
* @param int $hierarchyId ID of the Questgroup hierarchy to get Questgroups for
|
|
* @param int $parentQuestgroupId ID of the parent Questgroup hierarchy
|
|
* @return array Questgroups for the given hierarchy
|
|
*/
|
|
public function getQuestgroupsForHierarchy($hierarchyId, $parentQuestgroupId=null)
|
|
{
|
|
// Get Questgroups
|
|
$questgroups = array();
|
|
if(is_null($parentQuestgroupId))
|
|
{
|
|
$questgroups = $this->db->query(
|
|
'SELECT questgroups.id, questgroups_questgroupshierarchy.questgroupshierarchy_id, questgroups_questgroupshierarchy.pos, questgroups.title, questgroups.url, questgroups.questgroupspicture_id '.
|
|
'FROM questgroups_questgroupshierarchy '.
|
|
'INNER JOIN questgroups ON questgroups.id = questgroups_questgroupshierarchy.questgroup_id '.
|
|
'WHERE questgroups_questgroupshierarchy.questgroupshierarchy_id = ? AND questgroups_questgroupshierarchy.parent_questgroup_id IS NULL '.
|
|
'ORDER BY questgroups_questgroupshierarchy.pos ASC',
|
|
'i',
|
|
$hierarchyId
|
|
);
|
|
}
|
|
else
|
|
{
|
|
$questgroups = $this->db->query(
|
|
'SELECT questgroups.id, questgroups_questgroupshierarchy.questgroupshierarchy_id, questgroups_questgroupshierarchy.pos, questgroups.title, questgroups.url, questgroups.questgroupspicture_id '.
|
|
'FROM questgroups_questgroupshierarchy '.
|
|
'INNER JOIN questgroups ON questgroups.id = questgroups_questgroupshierarchy.questgroup_id '.
|
|
'WHERE questgroups_questgroupshierarchy.questgroupshierarchy_id = ? AND questgroups_questgroupshierarchy.parent_questgroup_id = ? '.
|
|
'ORDER BY questgroups_questgroupshierarchy.pos ASC',
|
|
'ii',
|
|
$hierarchyId, $parentQuestgroupId
|
|
);
|
|
}
|
|
|
|
// Add additional data
|
|
foreach($questgroups as &$questgroup)
|
|
{
|
|
// Total XPs
|
|
$questgroup['xps'] = $this->getAchievableXPsForQuestgroup($questgroup['id']);
|
|
}
|
|
|
|
|
|
// Return Questgroups
|
|
return $questgroups;
|
|
}
|
|
|
|
|
|
/**
|
|
* Get a Questgroup by its ID.
|
|
*
|
|
* @throws IdNotFoundException
|
|
* @param int $questgroupId ID of a Questgroup
|
|
* @return array Questgroup data
|
|
*/
|
|
public function getQuestgroupById($questgroupId)
|
|
{
|
|
$data = $this->db->query(
|
|
'SELECT id, title, url, questgroupspicture_id '.
|
|
'FROM questgroups '.
|
|
'WHERE questgroups.id = ?',
|
|
'i',
|
|
$questgroupId
|
|
);
|
|
if(empty($data)) {
|
|
throw new \nre\exceptions\IdNotFoundException($questgroupId);
|
|
}
|
|
|
|
|
|
return $data[0];
|
|
}
|
|
|
|
|
|
/**
|
|
* Get a Questgroup by its URL.
|
|
*
|
|
* @throws IdNotFoundException
|
|
* @param int $seminaryId ID of the corresponding seminary
|
|
* @param string $questgroupURL URL-title of a Questgroup
|
|
* @return array Questgroup data
|
|
*/
|
|
public function getQuestgroupByUrl($seminaryId, $questgroupUrl)
|
|
{
|
|
$data = $this->db->query(
|
|
'SELECT id, title, url, questgroupspicture_id '.
|
|
'FROM questgroups '.
|
|
'WHERE seminary_id = ? AND url = ?',
|
|
'is',
|
|
$seminaryId, $questgroupUrl
|
|
);
|
|
if(empty($data)) {
|
|
throw new \nre\exceptions\IdNotFoundException($questgroupUrl);
|
|
}
|
|
|
|
|
|
return $data[0];
|
|
}
|
|
|
|
|
|
/**
|
|
* Get texts of a Questgroup.
|
|
*
|
|
* @param int $questgroupId ID of a Questgroup
|
|
* @return array Texts of this Questgroup
|
|
*/
|
|
public function getQuestgroupTexts($questgroupId)
|
|
{
|
|
return $this->db->query(
|
|
'SELECT id, pos, text '.
|
|
'FROM questgrouptexts '.
|
|
'WHERE questgroup_id = ? '.
|
|
'ORDER BY pos ASC',
|
|
'i',
|
|
$questgroupId
|
|
);
|
|
}
|
|
|
|
|
|
/**
|
|
* Get first texts of a Questgroup.
|
|
*
|
|
* @param int $questgroupId ID of a Questgroup
|
|
* @return array First Text of this Questgroup
|
|
*/
|
|
public function getFirstQuestgroupText($questgroupId)
|
|
{
|
|
$data = $this->db->query(
|
|
'SELECT id, pos, text '.
|
|
'FROM questgrouptexts '.
|
|
'WHERE questgroup_id = ? '.
|
|
'ORDER BY pos ASC '.
|
|
'LIMIT 1',
|
|
'i',
|
|
$questgroupId
|
|
);
|
|
if(!empty($data)) {
|
|
return $data[0];
|
|
}
|
|
|
|
|
|
return null;
|
|
}
|
|
|
|
|
|
/**
|
|
* Get the next Questgroup.
|
|
*
|
|
* Determine the next Questgroup. If there is no next Questgroup
|
|
* on the same level as the given Quest then the followed-up
|
|
* Questgroup from a higher hierarchy level is returned.
|
|
*
|
|
* @param int $questgroupId ID of Questgroup to get next Questgroup of
|
|
* @return array Questgroup data
|
|
*/
|
|
public function getNextQuestgroup($questgroupId)
|
|
{
|
|
$currentQuestgroup = $this->getQuestgroupById($questgroupId);
|
|
$currentQuestgroup['hierarchy'] = $this->Questgroupshierarchy->getHierarchyForQuestgroup($currentQuestgroup['id']);
|
|
if(empty($currentQuestgroup['hierarchy'])) {
|
|
return null;
|
|
}
|
|
|
|
$nextQuestgroup = $this->_getNextQuestgroup($currentQuestgroup['hierarchy']['parent_questgroup_id'], $currentQuestgroup['hierarchy']['questgroup_pos']);
|
|
if(is_null($nextQuestgroup) && !is_null($currentQuestgroup['hierarchy']['parent_questgroup_id'])) {
|
|
$nextQuestgroup = $this->getNextQuestgroup($currentQuestgroup['hierarchy']['parent_questgroup_id']);
|
|
}
|
|
|
|
|
|
return $nextQuestgroup;
|
|
}
|
|
|
|
|
|
/**
|
|
* Get the previous Questgroup.
|
|
*
|
|
* Determine the previous Questgroup. If there is no previous
|
|
* Questgroup on the same level as the given Quest then the
|
|
* followed-up Questgroup from a higher hierarchy level is
|
|
* returned.
|
|
*
|
|
* @param int $questgroupId ID of Questgroup to get previous Questgroup of
|
|
* @return array Questgroup data
|
|
*/
|
|
public function getPreviousQuestgroup($questgroupId)
|
|
{
|
|
$currentQuestgroup = $this->getQuestgroupById($questgroupId);
|
|
$currentQuestgroup['hierarchy'] = $this->Questgroupshierarchy->getHierarchyForQuestgroup($currentQuestgroup['id']);
|
|
if(empty($currentQuestgroup['hierarchy'])) {
|
|
return null;
|
|
}
|
|
|
|
$previousQuestgroup = $this->_getPreviousQuestgroup($currentQuestgroup['hierarchy']['parent_questgroup_id'], $currentQuestgroup['hierarchy']['questgroup_pos']);
|
|
if(is_null($previousQuestgroup) && !is_null($currentQuestgroup['hierarchy']['parent_questgroup_id'])) {
|
|
$previousQuestgroup = $this->getPreviousQuestgroup($currentQuestgroup['hierarchy']['parent_questgroup_id']);
|
|
}
|
|
|
|
|
|
return $previousQuestgroup;
|
|
}
|
|
|
|
|
|
/**
|
|
* Determine if the given Character has solved the Quests form
|
|
* this Questgroup.
|
|
*
|
|
* @param int $questgroupId ID of Questgroup to check
|
|
* @param int $characterId ID of Character to check
|
|
* @result boolean Whether Character has solved the Questgroup or not
|
|
*/
|
|
public function hasCharacterSolvedQuestgroup($questgroupId, $characterId)
|
|
{
|
|
// Get data of Questgroup
|
|
$questgroup = $this->getQuestgroupById($questgroupId);
|
|
|
|
// Chack all Quests
|
|
$quests = $this->Quests->getQuestsForQuestgroup($questgroup['id']);
|
|
foreach($quests as &$quest) {
|
|
if(!$this->Quests->hasCharacterSolvedQuest($quest['id'], $characterId)) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
// Check all child Questgroups
|
|
$questgroup['hierarchy'] = $this->Questgroupshierarchy->getHierarchyForQuestgroup($questgroup['id']);
|
|
if(!empty($questgroup['hierarchy']))
|
|
{
|
|
$childQuestgroupshierarchy = $this->Questgroupshierarchy->getChildQuestgroupshierarchy($questgroup['hierarchy']['id']);
|
|
foreach($childQuestgroupshierarchy as &$hierarchy)
|
|
{
|
|
// Get Questgroups
|
|
$questgroups = $this->getQuestgroupsForHierarchy($hierarchy['id'], $questgroup['id']);
|
|
foreach($questgroups as &$group) {
|
|
if(!$this->hasCharacterSolvedQuestgroup($group['id'], $characterId)) {
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
/**
|
|
* Get all related Questgroups of a Questtext.
|
|
*
|
|
* @param int $questtextId ID of the questtext
|
|
* @return array Sidequests for the questtext
|
|
*/
|
|
public function getRelatedQuestsgroupsOfQuesttext($questtextId)
|
|
{
|
|
return $this->db->query(
|
|
'SELECT questgroups.id, questgroups_questtexts.questtext_id, questgroups.title, questgroups.url, questgroups_questtexts.entry_text '.
|
|
'FROM questgroups_questtexts '.
|
|
'INNER JOIN questgroups ON questgroups.id = questgroups_questtexts.questgroup_id '.
|
|
'WHERE questgroups_questtexts.questtext_id = ?',
|
|
'i',
|
|
$questtextId
|
|
);
|
|
}
|
|
|
|
|
|
/**
|
|
* Get all related Questgroups of a Quest.
|
|
*
|
|
* @param int $questId ID of the quest
|
|
* @return array Sidequests for the quest
|
|
*/
|
|
public function getRelatedQuestsgroupsOfQuest($questId)
|
|
{
|
|
$questgroups = array();
|
|
$questtexts = $this->Questtexts->getQuesttextsOfQuest($questId);
|
|
foreach($questtexts as &$questtext) {
|
|
$questgroups = array_merge($questgroups, $this->getRelatedQuestsgroupsOfQuesttext($questtext['id']));
|
|
}
|
|
|
|
|
|
return $questgroups;
|
|
}
|
|
|
|
|
|
/**
|
|
* Summarize XPs of all Quests for a Questgroup and its
|
|
* sub-Questgroups.
|
|
*
|
|
* @param int $questgroupId ID of Questgroup
|
|
* @return Sum of XPs
|
|
*/
|
|
public function getAchievableXPsForQuestgroup($questgroupId)
|
|
{
|
|
// Sum of XPs
|
|
$xps = 0;
|
|
|
|
// Current Questgroup
|
|
$questgroup = $this->getQuestgroupById($questgroupId);
|
|
$questgroup['hierarchy'] = $this->Questgroupshierarchy->getHierarchyForQuestgroup($questgroup['id']);
|
|
|
|
// Quests of current Questgroup
|
|
$quests = $this->Quests->getQuestsForQuestgroup($questgroup['id']);
|
|
foreach($quests as &$quest)
|
|
{
|
|
$xps += $quest['xps'];
|
|
|
|
// Related Questgroups
|
|
$relatedQuestgroups = $this->getRelatedQuestsgroupsOfQuest($quest['id']);
|
|
foreach($relatedQuestgroups as $group) {
|
|
$xps += $this->getAchievableXPsForQuestgroup($group['id']);
|
|
}
|
|
}
|
|
|
|
// XPs of child Questgroups
|
|
$questgroupHierarchy = $this->Questgroupshierarchy->getHierarchyForQuestgroup($questgroup['id']);
|
|
if(!empty($questgroupHierarchy))
|
|
{
|
|
$childQuestgroupshierarchy = $this->Questgroupshierarchy->getChildQuestgroupshierarchy($questgroupHierarchy['id']);
|
|
foreach($childQuestgroupshierarchy as &$hierarchy)
|
|
{
|
|
$questgroups = $this->getQuestgroupsForHierarchy($hierarchy['id'], $questgroup['id']);
|
|
foreach($questgroups as &$questgroup) {
|
|
$xps += $this->getAchievableXPsForQuestgroup($questgroup['id']);
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
// Return summarized XPs
|
|
return $xps;
|
|
}
|
|
|
|
|
|
/**
|
|
* Summarize XPs of all Quests for a Questgroup and its
|
|
* sub-Questgroups solved by a Character.
|
|
*
|
|
* @param int $questgroupId ID of Questgroup
|
|
* @param int $characterId ID of Character
|
|
* @return Sum of XPs
|
|
*/
|
|
public function getAchievedXPsForQuestgroup($questgroupId, $characterId)
|
|
{
|
|
// Sum of XPs
|
|
$xps = 0;
|
|
|
|
// Current Questgroup
|
|
$questgroup = $this->getQuestgroupById($questgroupId);
|
|
|
|
// Quests of current Questgroup
|
|
$quests = $this->Quests->getQuestsForQuestgroup($questgroup['id']);
|
|
foreach($quests as &$quest)
|
|
{
|
|
if($this->Quests->hasCharacterSolvedQuest($quest['id'], $characterId)) {
|
|
$xps += $quest['xps'];
|
|
}
|
|
|
|
// Related Questgroups
|
|
$relatedQuestgroups = $this->getRelatedQuestsgroupsOfQuest($quest['id']);
|
|
foreach($relatedQuestgroups as $group) {
|
|
$xps += $this->getAchievedXPsForQuestgroup($group['id'], $characterId);
|
|
}
|
|
}
|
|
|
|
// XPs of child Questgroups
|
|
$questgroupHierarchy = $this->Questgroupshierarchy->getHierarchyForQuestgroup($questgroup['id']);
|
|
if(empty($questgroupHierarchy)) {
|
|
return $xps;
|
|
}
|
|
$childQuestgroupshierarchy = $this->Questgroupshierarchy->getChildQuestgroupshierarchy($questgroupHierarchy['id']);
|
|
foreach($childQuestgroupshierarchy as &$hierarchy)
|
|
{
|
|
$questgroups = $this->getQuestgroupsForHierarchy($hierarchy['id'], $questgroup['id']);
|
|
foreach($questgroups as &$questgroup) {
|
|
$xps += $this->getAchievedXPsForQuestgroup($questgroup['id'], $characterId);
|
|
}
|
|
}
|
|
|
|
|
|
// Return summarized XPs
|
|
return $xps;
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
* Get the next (direct) Questgroup.
|
|
*
|
|
* @param int $parentQuestgroupId ID of parent Questgroup to get next Questgroup of
|
|
* @param int $questgroupPos Position of Questgroup to get next Questgroup of
|
|
* @return array Data of next Questgroup or NULL
|
|
*/
|
|
private function _getNextQuestgroup($parentQuestgroupId, $questgroupPos)
|
|
{
|
|
if(!is_null($parentQuestgroupId))
|
|
{
|
|
$data = $this->db->query(
|
|
'SELECT * '.
|
|
'FROM questgroups_questgroupshierarchy '.
|
|
'INNER JOIN questgroups ON questgroups.id = questgroups_questgroupshierarchy.questgroup_id '.
|
|
'WHERE parent_questgroup_id = ? AND pos = ? + 1',
|
|
'ii',
|
|
$parentQuestgroupId, $questgroupPos
|
|
);
|
|
}
|
|
else
|
|
{
|
|
$data = $this->db->query(
|
|
'SELECT * '.
|
|
'FROM questgroups_questgroupshierarchy '.
|
|
'INNER JOIN questgroups ON questgroups.id = questgroups_questgroupshierarchy.questgroup_id '.
|
|
'WHERE parent_questgroup_id IS NULL AND pos = ? + 1',
|
|
'i',
|
|
$questgroupPos
|
|
);
|
|
}
|
|
if(empty($data)) {
|
|
return null;
|
|
}
|
|
|
|
|
|
return $data[0];
|
|
}
|
|
|
|
|
|
/**
|
|
* Get the previous (direct) Questgroup.
|
|
*
|
|
* @param int $parentQuestgroupId ID of parent Questgroup to get previous Questgroup of
|
|
* @param int $questgroupPos Position of Questgroup to get previous Questgroup of
|
|
* @return array Data of previous Questgroup or NULL
|
|
*/
|
|
private function _getPreviousQuestgroup($parentQuestgroupId, $questgroupPos)
|
|
{
|
|
if(!is_null($parentQuestgroupId))
|
|
{
|
|
$data = $this->db->query(
|
|
'SELECT * '.
|
|
'FROM questgroups_questgroupshierarchy '.
|
|
'INNER JOIN questgroups ON questgroups.id = questgroups_questgroupshierarchy.questgroup_id '.
|
|
'WHERE parent_questgroup_id = ? AND pos = ? - 1',
|
|
'ii',
|
|
$parentQuestgroupId, $questgroupPos
|
|
);
|
|
}
|
|
else
|
|
{
|
|
$data = $this->db->query(
|
|
'SELECT * '.
|
|
'FROM questgroups_questgroupshierarchy '.
|
|
'INNER JOIN questgroups ON questgroups.id = questgroups_questgroupshierarchy.questgroup_id '.
|
|
'WHERE parent_questgroup_id IS NULL AND pos = ? - 1',
|
|
'i',
|
|
$questgroupPos
|
|
);
|
|
}
|
|
if(empty($data)) {
|
|
return null;
|
|
}
|
|
|
|
|
|
return $data[0];
|
|
}
|
|
|
|
}
|
|
|
|
?>
|