Completed
Push — fm-matches ( f867e2...7fc64f )
by Vladimir
14:12
created

Team::changeMatchCount()   B

Complexity

Conditions 5
Paths 5

Size

Total Lines 21
Code Lines 14

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 12
CRAP Score 5

Importance

Changes 0
Metric Value
c 0
b 0
f 0
dl 0
loc 21
ccs 12
cts 12
cp 1
rs 8.7624
cc 5
eloc 14
nc 5
nop 2
crap 5
1
<?php
2
/**
3
 * This file contains functionality relating to the teams belonging to the current league
4
 *
5
 * @package    BZiON\Models
6
 * @license    https://github.com/allejo/bzion/blob/master/LICENSE.md GNU General Public License Version 3
7
 */
8
9
/**
10
 * A league team
11
 * @package    BZiON\Models
12
 */
13
class Team extends AvatarModel
14
{
15
    /**
16
     * The description of the team written in markdown
17
     *
18
     * @var string
19
     */
20
    protected $description;
21
22
    /**
23
     * The creation date of the team
24
     *
25
     * @var TimeDate
26
     */
27
    protected $created;
28
29
    /**
30
     * The team's current elo
31
     *
32
     * @var int
33
     */
34
    protected $elo;
35
36
    /**
37
     * The team's activity
38
     *
39
     * null if we haven't calculated it yet
40
     *
41
     * @var float|null
42
     */
43
    protected $activity = null;
44
45
    /**
46
     * The id of the team leader
47
     *
48
     * @var int
49
     */
50
    protected $leader;
51
52
    /**
53
     * The number of matches won
54
     *
55
     * @var int
56
     */
57
    protected $matches_won;
58
59
    /**
60
     * The number of matches lost
61
     *
62
     * @var int
63
     */
64
    protected $matches_lost;
65
66
    /**
67
     * The number of matches tied
68
     *
69
     * @var int
70
     */
71
    protected $matches_draw;
72
73
    /**
74
     * The total number of matches
75
     *
76
     * @var int
77
     */
78
    protected $matches_total;
79
80
    /**
81
     * The number of members
82
     *
83
     * @var int
84
     */
85
    protected $members;
86
87
    /**
88
     * The team's status
89
     *
90
     * @var string
91
     */
92
    protected $status;
93
94
    /**
95
     * A list of cached matches to calculate team activity
96
     *
97
     * @var Match[]|null
98
     */
99
    public static $cachedMatches = null;
100
101
    /**
102
     * The name of the database table used for queries
103
     */
104
    const TABLE = "teams";
105
106
    /**
107
     * The location where avatars will be stored
108
     */
109
    const AVATAR_LOCATION = "/web/assets/imgs/avatars/teams/";
110
111
    const CREATE_PERMISSION = Permission::CREATE_TEAM;
112
    const EDIT_PERMISSION = Permission::EDIT_TEAM;
113
    const SOFT_DELETE_PERMISSION = Permission::SOFT_DELETE_TEAM;
114
    const HARD_DELETE_PERMISSION = Permission::HARD_DELETE_TEAM;
115
116
    /**
117
     * {@inheritdoc}
118
     */
119 18
    protected function assignResult($team)
120
    {
121 18
        $this->name = $team['name'];
122 18
        $this->alias = $team['alias'];
123 18
        $this->description = $team['description'];
124 18
        $this->avatar = $team['avatar'];
125 18
        $this->created = TimeDate::fromMysql($team['created']);
126 18
        $this->elo = $team['elo'];
127 18
        $this->activity = null;
128 18
        $this->leader = $team['leader'];
129 18
        $this->matches_won = $team['matches_won'];
130 18
        $this->matches_lost = $team['matches_lost'];
131 18
        $this->matches_draw = $team['matches_draw'];
132 18
        $this->members = $team['members'];
133 18
        $this->status = $team['status'];
134
135 18
        $this->matches_total = $this->matches_won + $this->matches_lost + $this->matches_draw;
136 18
    }
137
138
    /**
139
     * Adds a new member to the team
140
     *
141
     * @param int $id The id of the player to add to the team
142
     *
143
     * @return bool|null True if both the player was added to the team AND the team member count was incremented
144
     */
145 18
    public function addMember($id)
146
    {
147 18
        $player = Player::get($id);
148
149 18
        if (!$player->isTeamless()) {
150
            throw new Exception("The player already belongs in a team");
151
        }
152
153 18
        $player->setTeam($this->getId());
154 18
        $this->update('members', ++$this->members, "i");
155 18
    }
156
157
    /**
158
     * Increase or decrease the ELO of the team
159
     *
160
     * @param int $adjust The value to be added to the current ELO (negative to substract)
161
     */
162 9
    public function changeElo($adjust)
163
    {
164 9
        $this->elo += $adjust;
165 9
        $this->update("elo", $this->elo, "i");
166 9
    }
167
168
    /**
169
     * Change the ELO of the team
170
     *
171
     * @param int $elo The new team ELO
172
     */
173
    public function setElo($elo)
174
    {
175
        $this->updateProperty($this->elo, "elo", $elo, "i");
176
    }
177
178
    /**
179
     * Increment the team's match count
180
     *
181
     * @param int    $adjust The number to add to the current matches number (negative to substract)
182
     * @param string $type   The match count that should be changed. Can be 'win', 'draw' or 'loss'
183
     */
184 9
    public function changeMatchCount($adjust, $type)
185
    {
186 9
        $this->matches_total += $adjust;
187
188
        switch ($type) {
189 9
            case "win":
190 9
            case "won":
191 6
                $this->update("matches_won", $this->matches_won += $adjust, "i");
192
193 6
                return;
194 9
            case "loss":
195 4
            case "lost":
196 6
                $this->update("matches_lost", $this->matches_lost += $adjust, "i");
197
198 6
                return;
199
            default:
200 4
                $this->update("matches_draw", $this->matches_draw += $adjust, "i");
201
202 4
                return;
203
        }
204
    }
205
206
    /**
207
     * Decrement the team's match count by one
208
     *
209
     * @param string $type The type of the match. Can be 'win', 'draw' or 'loss'
210
     */
211
    public function decrementMatchCount($type)
212
    {
213
        $this->changeMatchCount(-1, $type);
214
    }
215
216
    /**
217
     * Get the activity of the team
218
     *
219
     * @return float The team's activity
220
     */
221 1
    public function getActivity()
222
    {
223 1
        if ($this->activity === null) {
224
            // We don't have a cached activity value
225 1
            if (self::$cachedMatches === null) {
226
                self::$cachedMatches = Match::getQueryBuilder()
227
                    ->active()
228
                    ->with($this)
229
                    ->where('time')->isAfter(TimeDate::from('45 days ago'))
230
                    ->getModels($fast = true);
231
            }
232
233 1
            $this->activity = 0.0;
234 1
            foreach (self::$cachedMatches as $match) {
235 1
                if ($match->involvesTeam($this)) {
236 1
                    $this->activity += $match->getActivity();
237
                }
238
            }
239
        }
240
241 1
        return $this->activity;
242
    }
243
244
    /**
245
     * Get the creation date of the team
246
     *
247
     * @return TimeDate The creation date of the team
248
     */
249 2
    public function getCreationDate()
250
    {
251 2
        return $this->created->copy();
252
    }
253
254
    /**
255
     * Get the description of the team
256
     *
257
     * @param  bool $md false for HTML format, true for the original markdown
0 ignored issues
show
Bug introduced by
There is no parameter named $md. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
258
     * @return string  The description of the team
259
     */
260 1
    public function getDescription()
261
    {
262 1
        return $this->description;
263
    }
264
265
    /**
266
     * Get the current elo of the team
267
     *
268
     * @return int The elo of the team
269
     */
270 9
    public function getElo()
271
    {
272 9
        return $this->elo;
273
    }
274
275
    /**
276
     * Get the leader of the team
277
     *
278
     * @return Player The object representing the team leader
279
     */
280 2
    public function getLeader()
281
    {
282 2
        return Player::get($this->leader);
283
    }
284
285
    /**
286
     * Get the matches this team has participated in
287
     *
288
     * @param string $matchType The filter for match types: "all", "wins", "losses", or "draws"
289
     * @param int    $count     The amount of matches to be retrieved
290
     * @param int    $page      The number of the page to return
291
     *
292
     * @return Match[] The array of match IDs this team has participated in
293
     */
294 2
    public function getMatches($matchType = "all", $count = 5, $page = 1)
295
    {
296 2
        return Match::getQueryBuilder()
297 2
             ->active()
298 2
             ->with($this, $matchType)
299 2
             ->sortBy('time')->reverse()
300 2
             ->limit($count)->fromPage($page)
301 2
             ->getModels($fast = true);
302
    }
303
304
    /**
305
     * Get the number of matches that resulted as a draw
306
     *
307
     * @return int The number of matches, respectively
308
     */
309 1
    public function getMatchesDraw()
310
    {
311 1
        return $this->matches_draw;
312
    }
313
314
    /**
315
     * Get the number of matches that the team has lost
316
     *
317
     * @return int The number of matches, respectively
318
     */
319 1
    public function getMatchesLost()
320
    {
321 1
        return $this->matches_lost;
322
    }
323
324
    /**
325
     * Get the URL that points to the team's list of matches
326
     *
327
     * @return string The team's list of matches
328
     */
329
    public function getMatchesURL()
330
    {
331
        return Service::getGenerator()->generate("match_by_team_list", array("team" => $this->getAlias()));
332
    }
333
334
    /**
335
     * Get the number of matches that the team has won
336
     *
337
     * @return int The number of matches, respectively
338
     */
339 1
    public function getMatchesWon()
340
    {
341 1
        return $this->matches_won;
342
    }
343
344
    /**
345
     * Get the members on the team
346
     *
347
     * @return Player[] The members on the team
348
     */
349 2
    public function getMembers()
350
    {
351 2
        $leader = $this->leader;
352 2
        $members = Player::getTeamMembers($this->id);
353
354
        usort($members, function ($a, $b) use ($leader) {
355
            // Leader always goes first
356 2
            if ($a->getId() == $leader) {
357 2
                return -1;
358
            }
359 1
            if ($b->getId() == $leader) {
360 1
                return 1;
361
            }
362
363
            // Sort the rest of the players alphabetically
364
            $sort = Player::getAlphabeticalSort();
365
366
            return $sort($a, $b);
367 2
        });
368
369 2
        return $members;
370
    }
371
372
    /**
373
     * Get the name of the team
374
     *
375
     * @return string The name of the team
376
     */
377 18
    public function getName()
378
    {
379 18
        if ($this->name === null) {
380
            return "None";
381
        }
382 18
        return $this->name;
383
    }
384
385
    /**
386
     * Get the name of the team, safe for use in your HTML
387
     *
388
     * @return string The name of the team
389
     */
390 1
    public function getEscapedName()
391
    {
392 1
        if (!$this->valid) {
393
            return "<em>None</em>";
394
        }
395 1
        return $this->escape($this->name);
396
    }
397
398
    /**
399
     * Get the number of members on the team
400
     *
401
     * @return int The number of members on the team
402
     */
403 2
    public function getNumMembers()
404
    {
405 2
        return $this->members;
406
    }
407
408
    /**
409
     * Get the total number of matches this team has played
410
     *
411
     * @return int The total number of matches this team has played
412
     */
413 2
    public function getNumTotalMatches()
414
    {
415 2
        return $this->matches_total;
416
    }
417
418
    /**
419
     * Get the rank category a team belongs too based on their ELO
420
     *
421
     * This value is always a multiple of 100 and less than or equal to 2000
422
     *
423
     * @return int The rank category a team belongs to
424
     */
425 1
    public function getRankValue()
426
    {
427 1
        return min(2000, floor($this->getElo() / 100) * 100);
428
    }
429
430
    /**
431
     * Get the HTML for an image with the rank symbol
432
     *
433
     * @return string The HTML for a rank image
434
     */
435 1
    public function getRankImageLiteral()
436
    {
437 1
        return '<div class="c-rank c-rank--' . $this->getRankValue() . '"></div>';
438
    }
439
440
    /**
441
     * Increment the team's match count by one
442
     *
443
     * @param string $type The type of the match. Can be 'win', 'draw' or 'loss'
444
     */
445
    public function incrementMatchCount($type)
446
    {
447
        $this->changeMatchCount(1, $type);
448
    }
449
450
    /**
451
     * Check if a player is part of this team
452
     *
453
     * @param int $playerID The player to check
454
     *
455
     * @return bool True if the player belongs to this team
456
     */
457 2
    public function isMember($playerID)
458
    {
459 2
        $player = Player::get($playerID);
460
461 2
        return $player->getTeam()->isSameAs($this);
462
    }
463
464
    /**
465
     * Removes a member from the team
466
     *
467
     * @param  int  $id The id of the player to remove
468
     * @return void
469
     */
470 2
    public function removeMember($id)
471
    {
472 2
        if (!$this->isMember($id)) {
473
            throw new Exception("The player is not a member of that team");
474
        }
475
476 2
        $player = Player::get($id);
477
478 2
        $player->update("team", null, "s");
479 2
        $this->update('members', --$this->members, "i");
480 2
    }
481
482
    /**
483
     * Update the description of the team
484
     *
485
     * @param  string $description The description of the team written as markdown
486
     * @return void
487
     */
488
    public function setDescription($description)
489
    {
490
        $this->update("description", $description, "s");
491
    }
492
493
    /**
494
     * Change the status of the team
495
     *
496
     * @param  string $newStatus The new status of the team (open, closed, disabled or deleted)
497
     * @return self
498
     */
499
    public function setStatus($newStatus)
500
    {
501
        return $this->updateProperty($this->status, 'status', $newStatus, 's');
502
    }
503
504
    /**
505
     * Change the leader of the team
506
     *
507
     * @param  int  $leader The ID of the new leader of the team
508
     * @return self
509
     */
510
    public function setLeader($leader)
511
    {
512
        return $this->updateProperty($this->leader, 'leader', $leader, 'i');
513
    }
514
515
    /**
516
     * Find if a specific match is the team's last one
517
     *
518
     * @param  int  $matchID The ID of the match
519
     * @return bool
520
     */
521 1
    public function isLastMatch($matchID)
522
    {
523
        // Find if this team participated in any matches after the current match
524 1
        return !Match::getQueryBuilder()
525 1
            ->with($this)
526 1
            ->where('status')->notEquals('deleted')
527 1
            ->where('time')->isAfter(Match::get($matchID)->getTimestamp())
528 1
            ->any();
529
    }
530
531
    /**
532
     * {@inheritdoc}
533
     */
534 1
    public function delete()
535
    {
536 1
        parent::delete();
537
538
        // Remove all the members of a deleted team
539 1
        $this->updateProperty($this->members, 'members', 0, 'i');
540 1
        $this->db->query("UPDATE `players` SET `team` = NULL WHERE `team` = ?",
541 1
            'i', $this->id);
542 1
    }
543
544
    /**
545
     * Create a new team
546
     *
547
     * @param  string           $name        The name of the team
548
     * @param  int              $leader      The ID of the person creating the team, also the leader
549
     * @param  string           $avatar      The URL to the team's avatar
550
     * @param  string           $description The team's description
551
     * @param  string           $status      The team's status (open, closed, disabled or deleted)
552
     * @param  string|\TimeDate $created     The date the team was created
553
     *
554
     * @return Team   An object that represents the newly created team
555
     */
556 19
    public static function createTeam($name, $leader, $avatar, $description, $status = 'closed', $created = "now")
557
    {
558 19
        $created = TimeDate::from($created);
559
560 19
        $team = self::create(array(
561 19
            'name'         => $name,
562 19
            'alias'        => self::generateAlias($name),
563 19
            'description'  => $description,
564 19
            'elo'          => 1200,
565 19
            'activity'     => 0.00,
566 19
            'matches_won'  => 0,
567 19
            'matches_draw' => 0,
568 19
            'matches_lost' => 0,
569 19
            'members'      => 0,
570 19
            'avatar'       => $avatar,
571 19
            'leader'       => $leader,
572 19
            'status'       => $status,
573 19
            'created'      => $created->toMysql(),
574 19
        ), 'sssidiiiissss');
575
576 18
        $team->addMember($leader);
577 18
        $team->getIdenticon($team->getId());
578
579 18
        return $team;
580
    }
581
582
    /**
583
     * Get all the teams in the database that are not disabled or deleted
584
     *
585
     * @return Team[] An array of Team IDs
586
     */
587
    public static function getTeams()
588
    {
589
        return self::arrayIdToModel(
590
            parent::fetchIdsFrom(
0 ignored issues
show
Comprehensibility Bug introduced by
It seems like you call parent on a different method (fetchIdsFrom() instead of getTeams()). Are you sure this is correct? If so, you might want to change this to $this->fetchIdsFrom().

This check looks for a call to a parent method whose name is different than the method from which it is called.

Consider the following code:

class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}

The getFirstName() method in the Son calls the wrong method in the parent class.

Loading history...
591
                "status", array("disabled", "deleted"),
592
                "s", true, "ORDER BY elo DESC"
593
            )
594
        );
595
    }
596
597
    /**
598
     * Get a single team by its name
599
     *
600
     * @param  string $name The team name to look for
601
     * @return Team
602
     */
603 1
    public static function getFromName($name)
604
    {
605 1
        $team = static::get(self::fetchIdFrom($name, 'name', 's'));
606
607 1
        return $team->inject('name', $name);
608
    }
609
610
    /**
611
     * Alphabetical order function for use in usort (case-insensitive)
612
     * @return Closure The sort function
613
     */
614
    public static function getAlphabeticalSort()
615
    {
616 1
        return function (Team $a, Team $b) {
617
            return strcasecmp($a->getName(), $b->getName());
618 1
        };
619
    }
620
621
    /**
622
     * {@inheritdoc}
623
     */
624 1
    public static function getActiveStatuses()
625
    {
626 1
        return array('open', 'closed');
627
    }
628
629
    /**
630
     * Get a query builder for teams
631
     * @return QueryBuilder
632
     */
633 1 View Code Duplication
    public static function getQueryBuilder()
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
634
    {
635 1
        return new QueryBuilder('Team', array(
636
            'columns' => array(
637
                'name'    => 'name',
638
                'elo'     => 'elo',
639
                'members' => 'members',
640
                'status'  => 'status'
641 1
            ),
642
            'name' => 'name',
643
        ));
644
    }
645
646
    /**
647
     * {@inheritdoc}
648
     */
649 1
    protected function isEditor($player)
650
    {
651 1
        return $player->isSameAs($this->getLeader());
652
    }
653
}
654