Achievement.php

Go to the documentation of this file.

<?php

namespace Combu;

class Achievement extends DataClass {

    const TABLE_NAME = "Achievement";

    public $Id = 0;
    public $IdApp = 0;
    public $Title = "";
    public $Description = "";
    public $UniqueRecords = 1;
    public $Position = 0;


    public function __construct($src = null, $stripSlashes = false) {
        if ($src == null)
            return;
        if (is_array($src)) {
            // Load by array
            $this->_loadByRow($src, $stripSlashes);
        } else if (is_numeric($src) && intval($src) > 0) {
            // Load by Id
            $this->_loadFilter(self::GetTableName(__CLASS__), "Id = " . intval($src));
        }
    }

    public static function Load ($idApp = 0, $limit = null, $offset = null, &$count = null, $returnArray = false) {
        $where = "";
        if ($idApp > 0) {
            $where = sprintf("(IdApp = 0 OR IdApp = %d)", $idApp);
        }
        return self::_load(self::GetTableName(__CLASS__), ($returnArray ? "" : __CLASS__), $where, "IdApp, Position", $limit, $offset, $count);
    }

    public function Save() {
        global $Database;
        if ($this->Id > 0) {
            $query = sprintf("UPDATE %s SET Title = '%s', Description = '%s' WHERE Id = %d",
                    self::GetTableName(__CLASS__),
                    $Database->Escape($this->Title),
                    $Database->Escape($this->Description),
                    $this->Id);
        } else {
            $this->Position = self::GetNextPosition($this->IdApp);
            $query = sprintf("INSERT INTO %s (IdApp, Title, Description, UniqueRecords, Position) VALUES (%d, '%s', '%s', %d, %d)",
                    self::GetTableName(__CLASS__),
                    $this->IdApp,
                    $Database->Escape($this->Title),
                    $Database->Escape($this->Description),
                    $this->UniqueRecords,
                    $this->Position);
        }
        $saved = $Database->Query($query);
        if ($saved) {
            if ($this->Id <= 0) {
                $this->Id = $Database->InsertedId();
            }
            return TRUE;
        }
        return FALSE;
    }
    
    private static function GetNextPosition($idApp) {
        $maxPosition = 0;
        $count = self::CountRecords(self::GetTableName(__CLASS__), sprintf("IdApp = %d", $idApp));
        if ($count > 0) {
            $maxPosition = $count;
        }
        return $maxPosition;
    }
    
    public function MoveUp() {
        global $Database;
        if ($this->Id > 0 && $this->Position > 0) {
            // Calculate the desired position
            $newPosition = $this->Position - 1;
            // Try to update the early positions
            $query = sprintf("UPDATE %s SET Position = Position + 1 WHERE Position = %d AND IdApp = %d",
                    self::GetTableName(__CLASS__), $newPosition, $this->IdApp);
            if ($Database->Query($query)) {
                // Try to update the current position
                $query = sprintf("UPDATE %s SET Position = %d WHERE Id = %d",
                        self::GetTableName(__CLASS__), $newPosition, $this->Id);
                if ($Database->Query($query)) {
                    $this->Position = $newPosition;
                    return TRUE;
                } else {
                    // Update current position failed, revert the previous statement
                    $query = sprintf("UPDATE %s SET Position = Position - 1 WHERE Position <= %d AND IdApp = %d",
                            self::GetTableName(__CLASS__), $newPosition, $this->IdApp);
                    $Database->Query($query);
                }
            }
        }
        return FALSE;
    }
    
    public function MoveDown() {
        global $Database;
        if ($this->Id > 0) {
            $maxPosition = self::GetNextPosition($this->IdApp) - 1;
            if ($maxPosition > 0 && $this->Position < $maxPosition) {
                // Calculate the desired position
                $newPosition = $this->Position + 1;
                // Try to update the early positions
                $query = sprintf("UPDATE %s SET Position = Position - 1 WHERE Position = %d AND IdApp = %d",
                        self::GetTableName(__CLASS__), $newPosition, $this->IdApp);
                if ($Database->Query($query)) {
                    // Try to update the current position
                    $query = sprintf("UPDATE %s SET Position = %d WHERE Id = %d",
                            self::GetTableName(__CLASS__), $newPosition, $this->Id);
                    if ($Database->Query($query)) {
                        $this->Position = $newPosition;
                        return TRUE;
                    } else {
                        // Update current position failed, revert the previous statement
                        $query = sprintf("UPDATE %s SET Position = Position + 1 WHERE Position <= %d AND IdApp = %d",
                                self::GetTableName(__CLASS__), $newPosition, $this->IdApp);
                        $Database->Query($query);
                    }
                }
            }
        }
        return FALSE;
    }

    public function Delete() {
        global $Database;
        if ($this->Id < 1)
            return FALSE;
        if ($this->_Delete(self::GetTableName(__CLASS__), "Id = " . $this->Id)) {
            // Reorder the next positions
            $query = sprintf("UPDATE %s SET Position = Position - 1 WHERE Position > %d",
                        self::GetTableName(__CLASS__), $this->Position);
            $Database->Query($query);
            // Delete all the associated resources
            $this->_Delete(self::GetTableName(Achievement_User::class), "IdAchievement = " . $this->Id);
            return TRUE;
        }
        return FALSE;
    }
    
    public static function Prune() {
        self::TruncateClass(__CLASS__);
        self::TruncateClass(Achievement_User::class);
    }
    
    public static function LoadUserAchievements ($idAccount, $idApp = 0) {
        $result = array();
        $where = "";
        if ($idApp > 0) {
            $where = sprintf("(IdApp = 0 OR IdApp = %d)", $idApp);
        }
        $achievements = self::_load(self::GetTableName(__CLASS__), __CLASS__, $where, "IdApp, Position");
        foreach ($achievements as $achievement) {
            $records = Achievement_User::LoadAccount($idAccount, $achievement->Id);
            if (count($records) == 0 && $idAccount > 0) {
                $newAchievement = new Achievement_User();
                $newAchievement->IdAchievement = $achievement->Id;
                $newAchievement->IdAccount = $idAccount;
                $newAchievement->Progress = 0;
                $records[] = $newAchievement;
            }
            $finished = 0;
            foreach ($records as $progress1) {
                if ($progress1->Progress >= 100)
                    ++$finished;
            }
            foreach ($records as $progress) {
                $result[] = array(
                    "Id" => $achievement->Id,
                    "Title" => $achievement->Title,
                    "Description" => $achievement->Description,
                    "Progress" => $progress->Progress,
                    "Finished" => $finished
                );
            }
        }
        return $result;
    }
    
    public function PostProgress ($account, $progressValue, &$newProgress = 0, &$cannotRepeat = NULL) {
        $newProgress = $progressValue;
        $cannotRepeat = FALSE;
        // Load the current saved records for this user
        $records = Achievement_User::LoadAccount($account->Id, $this->Id);
        if (count($records) == 0) {
            // We still haven't records, create new one
            $newRecord = new Achievement_User();
            $newRecord->IdAchievement = $this->Id;
            $newRecord->IdAccount = $account->Id;
            $newRecord->Progress = $progressValue;
            return $newRecord->Save();
        }
        // Ok! So we have at least one record for this user in the achievement...
        // Check to see if the achievement requires unique records per user
        if ($this->UniqueRecords == 1) {
            // Achievement has already been completed, return TRUE
            if ($records[0]->Progress >= 100)
                return TRUE;
            // It requires unique records, so update the current saved
            $records[0]->Progress += $progressValue;
            if ($records[0]->Progress > 100)
                $records[0]->Progress = 100;
            $newProgress = $records[0]->Progress;
            return $records[0]->Save();
        }
        // It doesn't require unique records, so create new one if needed
        if ($records[count($records) - 1]->Progress < 100)
            $newRecord = $records[count($records) - 1];
        else {
            $newRecord = new Achievement_User();
            $newRecord->IdAchievement = $this->Id;
            $newRecord->IdAccount = $account->Id;
        }
        $newRecord->Progress += $progressValue;
        if ($newRecord->Progress > 100)
            $newRecord->Progress = 100;
        $newProgress = $newRecord->Progress;
        return $newRecord->Save();
    }
}