/**
* Change user level to higher one.
*
* <code>
* $context = "com_user.registration";
*
* $keys = array(
* "id" => 1,
* "group_id" => 2
* );
*
* // Create user badge object based.
* $level = new Gamification\Level\Level(\JFactory::getDbo());
* $level->load($keys);
*
* $levelManager = new Gamification\User\Level\LevelManager(\JFactory::getDbo());
* $levelManager->setLevel($level);
*
* if ($levelManager->give($context, $userId, $options)) {
* // ...
* }
* </code>
*
* @param string $context
* @param int $userId
* @param array $options
*
* @throws \UnexpectedValueException
* @throws \RuntimeException
* @throws \InvalidArgumentException
*
* @return null|Level
*/
public function levelUp($context, $userId, array $options = array())
{
if (!$this->level instanceof BasicLevel) {
throw new \UnexpectedValueException('It is missing user level object.');
}
$keys = array('user_id' => $userId, 'group_id' => $this->level->getGroupId());
$userLevel = new Level(\JFactory::getDbo());
$userLevel->load($keys);
// Implement JObservableInterface: Pre-processing by observers
$this->observers->update('onBeforeLevelUp', array($context, &$userLevel, &$options));
if (!$userLevel->getId()) {
$keys['level_id'] = $this->level->getId();
$userLevel->startLeveling($keys);
} else {
if ((int) $this->level->getId() === (int) $userLevel->getLevelId()) {
return null;
}
// Change the current rank ID with another one.
$userLevel->setLevelId($this->level->getId());
$userLevel->store();
}
// Implement JObservableInterface: Post-processing by observers
$this->observers->update('onAfterLevelUp', array($context, &$userLevel, &$options));
return $userLevel;
}
/**
* Create an instance of the object and load data.
*
* <code>
* $levelId = 1;
* $level = Gamification\Level\Level::getInstance(\JFactory::getDbo(), $levelId);
* </code>
*
* @param \JDatabaseDriver $db
* @param int $id
*
* @return null|Level
*/
public static function getInstance(\JDatabaseDriver $db, $id)
{
if (empty(self::$instances[$id])) {
$item = new Level($db);
$item->load($id);
self::$instances[$id] = $item;
}
return self::$instances[$id];
}
public function isLevelAchieved(Level $level, $userId = 0)
{
if (!$userId and $this->id > 0) {
$userId = $this->id;
}
$query = $this->db->getQuery(true);
$query->select('COUNT(*)')->from($this->db->quoteName('#__gfy_userlevels', 'a'))->where('a.user_id = ' . (int) $userId)->where('a.group_id = ' . (int) $level->getGroupId())->where('a.level_id = ' . (int) $level->getId());
$this->db->setQuery($query, 0, 1);
return (bool) $this->db->loadResult();
}
/**
* Find the level that has to be reached by the user.
*
* <code>
* $keys = array(
* 'user_id' => 1,
* 'points_id' => 2
* );
* $points = new Gamification\User\Points\Points(\JFactory::getDbo());
* $points->load($keys);
*
* $levelSeeker = new Gamification\User\Level\LevelPointsSeeker(\JFactory::getDbo());
* $levelSeeker->setUserPoints($points);
*
* $newLevel = $levelSeeker->find();
* </code>
*
* @throws \RuntimeException
*
* @return null|BasicLevel
*/
public function find()
{
// Get basic levels based on specific points.
$options = array('points_id' => (int) $this->userPoints->getPointsId(), 'state' => (int) Constants::PUBLISHED, 'order_column' => 'a.points_number', 'order_direction' => 'ASC');
$levels = new BasicLevels($this->db);
$levels->load($options);
$results = $levels->toArray();
/** @var array $results */
$levelData = array();
for ($i = 0, $max = count($results); $i < $max; $i++) {
// Get current item
$current = array_key_exists($i, $results) ? $results[$i] : array();
/** @var $current array */
// Get next item
$n = $i + 1;
$next = array_key_exists($n, $results) ? $results[$n] : array();
/** @var $next array */
if (count($next) > 0) {
// Check for coincidence with next item
if ((int) $next['points_number'] === (int) $this->userPoints->getPointsNumber()) {
$levelData = $next;
break;
}
// Check for coincidence with current item
if ((int) $current['points_number'] <= (int) $this->userPoints->getPointsNumber() and (int) $next['points_number'] > (int) $this->userPoints->getPointsNumber()) {
$levelData = $current;
break;
}
} else {
// If there is not next item, we compare with last (current).
if ((int) $current['points_number'] <= (int) $this->userPoints->getPointsNumber()) {
$levelData = $current;
break;
}
}
}
// Create a level object.
$level = null;
if (count($levelData) > 0) {
$level = new BasicLevel($this->db);
$level->bind($levelData);
}
return $level;
}
/**
* Return the levels as array with objects.
*
* <code>
* $options = array(
* "ids" => array(1,2,3,4,5)
* );
*
* $levels = new Gamification\Level\Levels(\JFactory::getDbo());
* $levels->load($options);
*
* $levels = $levels->getLevels();
* </code>
*
* @return array
*/
public function getLevels()
{
$results = array();
$i = 0;
foreach ($this->items as $item) {
$level = new Level($this->db);
$level->bind($item);
$results[$i] = $level;
$i++;
}
return $results;
}
