Ban::setDuration() - Code Metrics - Inspection of "Fix SearchHelper calls expecting a map" - enwikipedia-acc/waca - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — rbac ( 1ec5d5...5c33ef )

by Simon

created 2017-02-07 00:39 UTC

Ban::setDuration() A

↳ Parent: Ban

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	2
c	0
b	0
f	0
nc	1
nop	1
dl	0
loc	4
ccs	0
cts	3
cp	0
crap	2
rs	10

<?php
/******************************************************************************
 * Wikipedia Account Creation Assistance tool                                 *
 *                                                                            *
 * All code in this file is released into the public domain by the ACC        *
 * Development Team. Please see team.json for a list of contributors.         *
 ******************************************************************************/

namespace Waca\DataObjects;

use Exception;
use PDO;
use Waca\DataObject;
use Waca\Exceptions\OptimisticLockFailedException;
use Waca\PdoDatabase;

/**
 * Ban data object
 */
class Ban extends DataObject
{
    private $type;
    private $target;
    private $user;
    private $reason;
    private $date;
    private $duration;
    private $active;

    /**
     * Gets all active bans, filtered by the optional target.
     *
     * @param string|null $target
     * @param PdoDatabase $database
     *
     * @return Ban[]
     */
    public static function getActiveBans($target, PdoDatabase $database)
    {
        if ($target !== null) {
            $query = <<<SQL
SELECT * FROM ban WHERE target = :target AND (duration > UNIX_TIMESTAMP() OR duration = -1) AND active = 1;
SQL;
            $statement = $database->prepare($query);
            $statement->bindValue(":target", $target);
        }
        else {
            $query = "SELECT * FROM ban WHERE (duration > UNIX_TIMESTAMP() OR duration = -1) AND active = 1;";
            $statement = $database->prepare($query);
        }

        $statement->execute();

        $result = array();

        /** @var Ban $v */
        foreach ($statement->fetchAll(PDO::FETCH_CLASS, get_called_class()) as $v) {
            $v->setDatabase($database);
            $result[] = $v;
        }

        return $result;
    }

    /**
     * Gets a ban by it's ID if it's currently active.
     *
     * @param     integer $id
     * @param PdoDatabase $database
     *
     * @return Ban
     */
    public static function getActiveId($id, PdoDatabase $database)
    {
        $statement = $database->prepare(<<<SQL
SELECT *
FROM ban
WHERE id = :id  AND (duration > UNIX_TIMESTAMP() OR duration = -1) AND active = 1;
SQL
        );
        $statement->bindValue(":id", $id);

        $statement->execute();

        $resultObject = $statement->fetchObject(get_called_class());

        if ($resultObject != false) {
            $resultObject->setDatabase($database);
        }

        return $resultObject;
    }

    /**
     * Get all active bans for a target and type.
     *
     * @param string      $target
     * @param string      $type
     * @param PdoDatabase $database
     *
     * @return Ban
     */
    public static function getBanByTarget($target, $type, PdoDatabase $database)
    {
        $query = <<<SQL
SELECT * FROM ban
WHERE type = :type
	AND target = :target
	AND (duration > UNIX_TIMESTAMP() OR duration = -1)
	AND active = 1;
SQL;
        $statement = $database->prepare($query);
        $statement->bindValue(":target", $target);
        $statement->bindValue(":type", $type);

        $statement->execute();

        $resultObject = $statement->fetchObject(get_called_class());

        if ($resultObject != false) {
            $resultObject->setDatabase($database);
        }

        return $resultObject;
    }

    /**
     * @throws Exception
     */
    public function save()
    {
        if ($this->isNew()) {
            // insert
            $statement = $this->dbObject->prepare(<<<SQL
INSERT INTO `ban` (type, target, user, reason, date, duration, active)
VALUES (:type, :target, :user, :reason, CURRENT_TIMESTAMP(), :duration, :active);
SQL
            );
            $statement->bindValue(":type", $this->type);
            $statement->bindValue(":target", $this->target);
            $statement->bindValue(":user", $this->user);
            $statement->bindValue(":reason", $this->reason);
            $statement->bindValue(":duration", $this->duration);
            $statement->bindValue(":active", $this->active);

            if ($statement->execute()) {
                $this->id = (int)$this->dbObject->lastInsertId();
            }
            else {
                throw new Exception($statement->errorInfo());
            }
        }
        else {
            // update
            $statement = $this->dbObject->prepare(<<<SQL
UPDATE `ban`
SET duration = :duration, active = :active, user = :user, updateversion = updateversion + 1
WHERE id = :id AND updateversion = :updateversion
LIMIT 1;
SQL
            );
            $statement->bindValue(':id', $this->id);
            $statement->bindValue(':updateversion', $this->updateversion);

            $statement->bindValue(':duration', $this->duration);
            $statement->bindValue(':active', $this->active);
            $statement->bindValue(':user', $this->user);

            if (!$statement->execute()) {
                throw new Exception($statement->errorInfo());
            }

            if ($statement->rowCount() !== 1) {
                throw new OptimisticLockFailedException();
            }

            $this->updateversion++;
        }
    }

    /**
     * @return string
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * @param string $type
     */
    public function setType($type)
    {
        $this->type = $type;
    }

    /**
     * @return string
     */
    public function getTarget()
    {
        return $this->target;
    }

    /**
     * @param string $target
     */
    public function setTarget($target)
    {
        $this->target = $target;
    }

    /**
     * @return string
     */
    public function getReason()
    {
        return $this->reason;
    }

    /**
     * @param string $reason
     */
    public function setReason($reason)
    {
        $this->reason = $reason;
    }

    /**
     * @return mixed
     */
    public function getDate()
    {
        return $this->date;
    }

    /**
     * @return mixed
     */
    public function getDuration()
    {
        return $this->duration;
    }

    /**
     * @param mixed $duration
     */
    public function setDuration($duration)
    {
        $this->duration = $duration;
    }

    /**
     * @return bool
     */
    public function isActive()
    {
        return $this->active == 1;
    }

    /**
     * @param bool $active
     */
    public function setActive($active)
    {
        $this->active = $active ? 1 : 0;
    }

    /**
     * @return int
     */
    public function getUser()
    {
        return $this->user;
    }

    /**
     * @param int $user UserID of user who is setting the ban
     *
     * @throws Exception
     */
    public function setUser($user)
    {
        $this->user = $user;
    }
}


1		<?php
2		/******************************************************************************
3		* Wikipedia Account Creation Assistance tool *
4		* *
5		* All code in this file is released into the public domain by the ACC *
6		* Development Team. Please see team.json for a list of contributors. *
7		******************************************************************************/
8
9		namespace Waca\DataObjects;
10
11		use Exception;
12		use PDO;
13		use Waca\DataObject;
14		use Waca\Exceptions\OptimisticLockFailedException;
15		use Waca\PdoDatabase;
16
17		/**
18		* Ban data object
19		*/
20		class Ban extends DataObject
21		{
22		private $type;
23		private $target;
24		private $user;
25		private $reason;
26		private $date;
27		private $duration;
28		private $active;
29
30		/**
31		* Gets all active bans, filtered by the optional target.
32		*
33		* @param string\|null $target
34		* @param PdoDatabase $database
35		*
36		* @return Ban[]
37		*/
38		public static function getActiveBans($target, PdoDatabase $database)
39		{
40		if ($target !== null) {
41		$query = <<<SQL
42		SELECT * FROM ban WHERE target = :target AND (duration > UNIX_TIMESTAMP() OR duration = -1) AND active = 1;
43		SQL;
44		$statement = $database->prepare($query);
45		$statement->bindValue(":target", $target);
46		}
47		else {
48		$query = "SELECT * FROM ban WHERE (duration > UNIX_TIMESTAMP() OR duration = -1) AND active = 1;";
49		$statement = $database->prepare($query);
50		}
51
52		$statement->execute();
53
54		$result = array();
55
56		/** @var Ban $v */
57		foreach ($statement->fetchAll(PDO::FETCH_CLASS, get_called_class()) as $v) {
58		$v->setDatabase($database);
59		$result[] = $v;
60		}
61
62		return $result;
63		}
64
65		/**
66		* Gets a ban by it's ID if it's currently active.
67		*
68		* @param integer $id
69		* @param PdoDatabase $database
70		*
71		* @return Ban
72		*/
73		public static function getActiveId($id, PdoDatabase $database)
74		{
75		$statement = $database->prepare(<<<SQL
76		SELECT *
77		FROM ban
78		WHERE id = :id AND (duration > UNIX_TIMESTAMP() OR duration = -1) AND active = 1;
79		SQL
80		);
81		$statement->bindValue(":id", $id);
82
83		$statement->execute();
84
85		$resultObject = $statement->fetchObject(get_called_class());
86
87		if ($resultObject != false) {
88		$resultObject->setDatabase($database);
89		}
90
91		return $resultObject;
92		}
93
94		/**
95		* Get all active bans for a target and type.
96		*
97		* @param string $target
98		* @param string $type
99		* @param PdoDatabase $database
100		*
101		* @return Ban
102		*/
103	2	public static function getBanByTarget($target, $type, PdoDatabase $database)
104		{
105		$query = <<<SQL
106		SELECT * FROM ban
107		WHERE type = :type
108		AND target = :target
109		AND (duration > UNIX_TIMESTAMP() OR duration = -1)
110		AND active = 1;
111	2	SQL;
112	2	$statement = $database->prepare($query);
113	2	$statement->bindValue(":target", $target);
114	2	$statement->bindValue(":type", $type);
115
116	2	$statement->execute();
117
118	2	$resultObject = $statement->fetchObject(get_called_class());
119
120	2	if ($resultObject != false) {
121	1	$resultObject->setDatabase($database);
122	1	}
123
124	2	return $resultObject;
125		}
126
127		/**
128		* @throws Exception
129		*/
130		public function save()
131		{
132		if ($this->isNew()) {
133		// insert
134		$statement = $this->dbObject->prepare(<<<SQL
135		INSERT INTO `ban` (type, target, user, reason, date, duration, active)
136		VALUES (:type, :target, :user, :reason, CURRENT_TIMESTAMP(), :duration, :active);
137		SQL
138		);
139		$statement->bindValue(":type", $this->type);
140		$statement->bindValue(":target", $this->target);
141		$statement->bindValue(":user", $this->user);
142		$statement->bindValue(":reason", $this->reason);
143		$statement->bindValue(":duration", $this->duration);
144		$statement->bindValue(":active", $this->active);
145
146		if ($statement->execute()) {
147		$this->id = (int)$this->dbObject->lastInsertId();
148		}
149		else {
150		throw new Exception($statement->errorInfo());
151		}
152		}
153		else {
154		// update
155		$statement = $this->dbObject->prepare(<<<SQL
156		UPDATE `ban`
157		SET duration = :duration, active = :active, user = :user, updateversion = updateversion + 1
158		WHERE id = :id AND updateversion = :updateversion
159		LIMIT 1;
160		SQL
161		);
162		$statement->bindValue(':id', $this->id);
163		$statement->bindValue(':updateversion', $this->updateversion);
164
165		$statement->bindValue(':duration', $this->duration);
166		$statement->bindValue(':active', $this->active);
167		$statement->bindValue(':user', $this->user);
168
169		if (!$statement->execute()) {
170		throw new Exception($statement->errorInfo());
171		}
172
173		if ($statement->rowCount() !== 1) {
174		throw new OptimisticLockFailedException();
175		}
176
177		$this->updateversion++;
178		}
179		}
180
181		/**
182		* @return string
183		*/
184		public function getType()
185		{
186		return $this->type;
187		}
188
189		/**
190		* @param string $type
191		*/
192	1	public function setType($type)
193		{
194	1	$this->type = $type;
195	1	}
196
197		/**
198		* @return string
199		*/
200		public function getTarget()
201		{
202		return $this->target;
203		}
204
205		/**
206		* @param string $target
207		*/
208	1	public function setTarget($target)
209		{
210	1	$this->target = $target;
211	1	}
212
213		/**
214		* @return string
215		*/
216		public function getReason()
217		{
218		return $this->reason;
219		}
220
221		/**
222		* @param string $reason
223		*/
224		public function setReason($reason)
225		{
226		$this->reason = $reason;
227		}
228
229		/**
230		* @return mixed
231		*/
232		public function getDate()
233		{
234		return $this->date;
235		}
236
237		/**
238		* @return mixed
239		*/
240		public function getDuration()
241		{
242		return $this->duration;
243		}
244
245		/**
246		* @param mixed $duration
247		*/
248		public function setDuration($duration)
249		{
250		$this->duration = $duration;
251		}
252
253		/**
254		* @return bool
255		*/
256		public function isActive()
257		{
258		return $this->active == 1;
259		}
260
261		/**
262		* @param bool $active
263		*/
264		public function setActive($active)
265		{
266		$this->active = $active ? 1 : 0;
267		}
268
269		/**
270		* @return int
271		*/
272		public function getUser()
273		{
274		return $this->user;
275		}
276
277		/**
278		* @param int $user UserID of user who is setting the ban
279		*
280		* @throws Exception
281		*/
282		public function setUser($user)
283		{
284		$this->user = $user;
285		}
286		}
287

enwikipedia-acc / waca

Push — rbac ( 1ec5d5...5c33ef )

Ban::setDuration() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like