News::getName() - Code Metrics - Inspection of "[WIP] Move to new QueryBuilder" - allejo/bzion - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#186)

by Vladimir

created 2018-02-12 07:49 UTC

News::getName() A

↳ Parent: News

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
dl	0
loc	4
ccs	0
cts	0
cp	0
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0
crap	2

<?php
/**
 * This file contains functionality relating to the news articles admins can post
 *
 * @package    BZiON\Models
 * @license    https://github.com/allejo/bzion/blob/master/LICENSE.md GNU General Public License Version 3
 */

/**
 * A news article
 * @package    BZiON\Models
 */
class News extends UrlModel implements NamedModel
{
    /**
     * The category of the article
     * @var int
     */
    protected $category;

    /**
     * The subject of the news article
     * @var string
     */
    protected $subject;

    /**
     * The content of the news article
     * @var string
     */
    protected $content;

    /**
     * The creation date of the news article
     * @var TimeDate
     */
    protected $created;

    /**
     * The date the news article was last updated
     * @var TimeDate
     */
    protected $updated;

    /**
     * The ID of the author of the news article
     * @var int
     */
    protected $author;

    /**
     * The ID of the last person to edit the news article
     * @var int
     */
    protected $editor;

    /** @var bool Whether or not the News item is a draft */
    protected $is_draft;

    const DELETED_COLUMN = 'is_deleted';
    const TABLE = "news";

    const CREATE_PERMISSION = Permission::CREATE_NEWS;
    const EDIT_PERMISSION = Permission::EDIT_NEWS;
    const SOFT_DELETE_PERMISSION = Permission::SOFT_DELETE_NEWS;
    const HARD_DELETE_PERMISSION = Permission::HARD_DELETE_NEWS;

    /**
     * {@inheritdoc}
     */
    protected function assignResult($news)
    {
        $this->category = $news['category'];
        $this->subject = $news['subject'];
        $this->content = $news['content'];
        $this->created = TimeDate::fromMysql($news['created']);
        $this->updated = TimeDate::fromMysql($news['updated']);
        $this->author = $news['author'];
        $this->editor = $news['editor'];
        $this->is_draft = $news['is_draft'];
        $this->is_deleted = $news['is_deleted'];
    }

    /**
     * Get the author of the news article
     * @return Player The author of the post
     */
    public function getAuthor()
    {
        return Player::get($this->author);
    }

    /**
     * Get the user ID of the author who wrote this article
     * @return int The author ID
     */
    public function getAuthorID()
    {
        return $this->author;
    }

    /**
     * Get the category of the news article
     * @return NewsCategory The category of the post
     */
    public function getCategory()
    {
        return NewsCategory::get($this->category);
    }

    /**
     * Get the database ID from the category the article belongs into
     * @return int The category ID
     */
    public function getCategoryID()
    {
        return $this->category;
    }

    /**
     * Get the content of the article
     * @return string The raw content of the article
     */
    public function getContent()
    {
        return $this->content;
    }

    /**
     * Get the time when the article was submitted
     *
     * @return TimeDate The article's creation time
     */
    public function getCreated()
    {
        return $this->created->copy();
    }

    /**
     * Get the time when the article was last updated
     *
     * @return TimeDate The article's last update time
     */
    public function getLastEdit()
    {
        return $this->updated->copy();
    }

    /**
     * Get the last editor of the post
     * @return Player A Player object of the last editor
     */
    public function getLastEditor()
    {
        return Player::get($this->editor);
    }

    /**
     * Get the ID of the person who last edited the article
     * @return int The ID of the last editor
     */
    public function getLastEditorID()
    {
        return $this->editor;
    }

    /**
     * Get the subject of the news article
     * @return string
     */
    public function getSubject()
    {
        return $this->subject;
    }

    /**
     * {@inheritdoc}
     */
    public function getName()
    {
        return $this->getSubject();
    }

    /**
     * Get whether or not this news article is
     *
     * @return bool
     */
    public function isDraft()
    {
        return $this->is_draft;
    }

    /**
     * {@inheritdoc}
     */
    public static function getParamName()
    {
        return "article";
    }

    /**
     * {@inheritdoc}
     */
    public static function getRouteName($action = 'show')
    {
        return "news_$action";
    }

    /**
     * Update the "draft" status of a post
     *
     * @param bool $draft
     *
     * @return static
     */
    public function setDraft($draft)
    {
        return $this->updateProperty($this->is_draft, 'is_draft', $draft);
    }

    /**
     * Update the content of a post
     *
     * @param string $content The new content of the post
     *
     * @return self
     */
    public function updateContent($content)
    {
        return $this->updateProperty($this->content, 'content', $content);
    }

    /**
     * Update the last edit timestamp
     * @return self
     */
    public function updateEditTimestamp()
    {
        return $this->updateProperty($this->updated, 'updated', TimeDate::now());
    }

    /**
     * Update the editor of the post
     *
     * @param  int  $editorID The ID of the editor
     * @return self
     */
    public function updateLastEditor($editorID)
    {
        return $this->updateProperty($this->editor, 'editor', $editorID);
    }

    /**
     * Update the category of the post
     *
     * @param  int  $categoryID The ID of the category
     * @return self
     */
    public function updateCategory($categoryID)
    {
        return $this->updateProperty($this->category, 'category', $categoryID);
    }

    /**
     * Update the status of a post
     *
     * @param  string $status The new status of a post
     * @return self
     */
    public function updateStatus($status = 'published')
    {
        @trigger_error('The `status` column of the News article has been deprecated. Use `is_draft` or `is_deleted`', E_USER_DEPRECATED);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}

        return $this->updateProperty($this->status, 'status', $status);
    }

    /**
     * Update the subject of a post
     *
     * @param  string $subject The new subject of a post
     * @return self
     */
    public function updateSubject($subject)
    {
        return $this->updateProperty($this->subject, 'subject', $subject);
    }

    /**
     * Add a new news article
     *
     * @param string $subject    The subject of the article
     * @param string $content    The content of the article
     * @param int    $authorID   The ID of the author
     * @param int    $categoryId The ID of the category this article will be published under
     * @param bool   $is_draft   Whether or not the added news item should be stored as a draft
     *
     * @return News An object representing the article that was just created or false if the article was not created
     */
    public static function addNews($subject, $content, $authorID, $categoryId = 1, $is_draft = false)
    {
        return self::create([
            'category' => $categoryId,
            'subject'  => $subject,
            'content'  => $content,
            'author'   => $authorID,
            'editor'   => $authorID,
            'is_draft' => $is_draft,
        ], ['created', 'updated']);
    }

    /**
     * Get all the news entries in the database that aren't disabled or deleted
     *
     * @param int  $start     The offset used when fetching matches, i.e. the starting point
     * @param int  $limit     The amount of matches to be retrieved
     * @param bool $getDrafts Whether or not to fetch drafts
     *
     * @throws Exception When a database is not configured in BZiON
     *
     * @return News[] An array of news objects
     */
    public static function getNews($start = 0, $limit = 5, $getDrafts = false)

    {
        $qb = self::getQueryBuilder()
            ->limit($limit)
            ->offset($start)
            ->orderBy('created', 'DESC')
            ->active()
        ;

        if ($getDrafts) {
            $qb->orWhere('is_draft', '=', true);
        }

        return $qb->getModels(true);
    }

    /**
     * Get a query builder for news
     *
     * @throws Exception
     *
     * @return QueryBuilderFlex
     */
    public static function getQueryBuilder()
    {
        return QueryBuilderFlex::createForModel(News::class)
<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}
            ->setNameColumn('subject')
        ;
    }
}


1			<?php
2			/**
3			* This file contains functionality relating to the news articles admins can post
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 news article
11			* @package BZiON\Models
12			*/
13			class News extends UrlModel implements NamedModel
14			{
15			/**
16			* The category of the article
17			* @var int
18			*/
19			protected $category;
20
21			/**
22			* The subject of the news article
23			* @var string
24			*/
25			protected $subject;
26
27			/**
28			* The content of the news article
29			* @var string
30			*/
31			protected $content;
32
33			/**
34			* The creation date of the news article
35			* @var TimeDate
36			*/
37			protected $created;
38
39			/**
40			* The date the news article was last updated
41			* @var TimeDate
42			*/
43			protected $updated;
44
45			/**
46			* The ID of the author of the news article
47			* @var int
48			*/
49			protected $author;
50
51			/**
52			* The ID of the last person to edit the news article
53			* @var int
54			*/
55			protected $editor;
56
57			/** @var bool Whether or not the News item is a draft */
58			protected $is_draft;
59
60			const DELETED_COLUMN = 'is_deleted';
61			const TABLE = "news";
62
63			const CREATE_PERMISSION = Permission::CREATE_NEWS;
64			const EDIT_PERMISSION = Permission::EDIT_NEWS;
65			const SOFT_DELETE_PERMISSION = Permission::SOFT_DELETE_NEWS;
66			const HARD_DELETE_PERMISSION = Permission::HARD_DELETE_NEWS;
67
68			/**
69			* {@inheritdoc}
70			*/
71			protected function assignResult($news)
72			{
73			$this->category = $news['category'];
74			$this->subject = $news['subject'];
75			$this->content = $news['content'];
76	2		$this->created = TimeDate::fromMysql($news['created']);
77			$this->updated = TimeDate::fromMysql($news['updated']);
78	2		$this->author = $news['author'];
79	2		$this->editor = $news['editor'];
80	2		$this->is_draft = $news['is_draft'];
81	2		$this->is_deleted = $news['is_deleted'];
82	2		}
83	2
84	2		/**
85	2		* Get the author of the news article
86	2		* @return Player The author of the post
87			*/
88			public function getAuthor()
89			{
90			return Player::get($this->author);
91			}
92	1
93			/**
94	1		* Get the user ID of the author who wrote this article
95			* @return int The author ID
96			*/
97			public function getAuthorID()
98			{
99			return $this->author;
100			}
101
102			/**
103			* Get the category of the news article
104			* @return NewsCategory The category of the post
105			*/
106			public function getCategory()
107			{
108			return NewsCategory::get($this->category);
109			}
110
111			/**
112			* Get the database ID from the category the article belongs into
113			* @return int The category ID
114			*/
115			public function getCategoryID()
116			{
117			return $this->category;
118			}
119
120			/**
121			* Get the content of the article
122			* @return string The raw content of the article
123			*/
124			public function getContent()
125			{
126			return $this->content;
127			}
128
129			/**
130			* Get the time when the article was submitted
131			*
132			* @return TimeDate The article's creation time
133			*/
134			public function getCreated()
135			{
136			return $this->created->copy();
137			}
138	1
139			/**
140	1		* Get the time when the article was last updated
141			*
142			* @return TimeDate The article's last update time
143			*/
144			public function getLastEdit()
145			{
146			return $this->updated->copy();
147			}
148
149			/**
150			* Get the last editor of the post
151			* @return Player A Player object of the last editor
152			*/
153			public function getLastEditor()
154			{
155			return Player::get($this->editor);
156			}
157
158			/**
159			* Get the ID of the person who last edited the article
160			* @return int The ID of the last editor
161			*/
162			public function getLastEditorID()
163			{
164			return $this->editor;
165			}
166
167			/**
168			* Get the subject of the news article
169			* @return string
170			*/
171			public function getSubject()
172			{
173			return $this->subject;
174			}
175	1
176			/**
177	1		* {@inheritdoc}
178			*/
179			public function getName()
180			{
181			return $this->getSubject();
182			}
183	1
184			/**
185	1		* Get whether or not this news article is
186			*
187			* @return bool
188			*/
189			public function isDraft()
190			{
191	1		return $this->is_draft;
192			}
193	1
194			/**
195			* {@inheritdoc}
196			*/
197			public static function getParamName()
198			{
199	1		return "article";
200			}
201	1
202			/**
203			* {@inheritdoc}
204			*/
205			public static function getRouteName($action = 'show')
206			{
207			return "news_$action";
208			}
209
210			/**
211			* Update the "draft" status of a post
212			*
213			* @param bool $draft
214			*
215			* @return static
216			*/
217			public function setDraft($draft)
218			{
219			return $this->updateProperty($this->is_draft, 'is_draft', $draft);
220			}
221
222			/**
223			* Update the content of a post
224			*
225			* @param string $content The new content of the post
226			*
227			* @return self
228			*/
229			public function updateContent($content)
230			{
231			return $this->updateProperty($this->content, 'content', $content);
232			}
233
234			/**
235			* Update the last edit timestamp
236			* @return self
237			*/
238			public function updateEditTimestamp()
239			{
240			return $this->updateProperty($this->updated, 'updated', TimeDate::now());
241			}
242
243			/**
244			* Update the editor of the post
245			*
246			* @param int $editorID The ID of the editor
247			* @return self
248			*/
249			public function updateLastEditor($editorID)
250			{
251			return $this->updateProperty($this->editor, 'editor', $editorID);
252			}
253
254			/**
255			* Update the category of the post
256			*
257			* @param int $categoryID The ID of the category
258			* @return self
259			*/
260			public function updateCategory($categoryID)
261			{
262			return $this->updateProperty($this->category, 'category', $categoryID);
263			}
264
265			/**
266			* Update the status of a post
267			*
268			* @param string $status The new status of a post
269			* @return self
270			*/
271			public function updateStatus($status = 'published')
272	1		{
273			@trigger_error('The `status` column of the News article has been deprecated. Use `is_draft` or `is_deleted`', E_USER_DEPRECATED);
			0 ignored issues – show Security Best Practice introduced 2018-02-03 04:54 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
274	1
275			return $this->updateProperty($this->status, 'status', $status);
276			}
277
278			/**
279			* Update the subject of a post
280			*
281			* @param string $subject The new subject of a post
282			* @return self
283			*/
284			public function updateSubject($subject)
285			{
286			return $this->updateProperty($this->subject, 'subject', $subject);
287			}
288	2
289			/**
290	2		* Add a new news article
291	2		*
292	2		* @param string $subject The subject of the article
293	2		* @param string $content The content of the article
294	2		* @param int $authorID The ID of the author
295	2		* @param int $categoryId The ID of the category this article will be published under
296	2		* @param bool $is_draft Whether or not the added news item should be stored as a draft
297	2		*
298			* @return News An object representing the article that was just created or false if the article was not created
299			*/
300			public static function addNews($subject, $content, $authorID, $categoryId = 1, $is_draft = false)
301			{
302			return self::create([
303			'category' => $categoryId,
304			'subject' => $subject,
305			'content' => $content,
306			'author' => $authorID,
307			'editor' => $authorID,
308			'is_draft' => $is_draft,
309	1		], ['created', 'updated']);
310			}
311	1
312			/**
313	1		* Get all the news entries in the database that aren't disabled or deleted
314	1		*
315			* @param int $start The offset used when fetching matches, i.e. the starting point
316			* @param int $limit The amount of matches to be retrieved
317	1		* @param bool $getDrafts Whether or not to fetch drafts
318	1		*
319	1		* @throws Exception When a database is not configured in BZiON
320	1		*
321			* @return News[] An array of news objects
322			*/
323		View Code Duplication	public static function getNews($start = 0, $limit = 5, $getDrafts = false)
			0 ignored issues – show Duplication introduced 2018-02-05 07:31 UTC by Report Bug Copy Issue Report 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...
324			{
325			$qb = self::getQueryBuilder()
326			->limit($limit)
327			->offset($start)
328			->orderBy('created', 'DESC')
329			->active()
330			;
331
332			if ($getDrafts) {
333			$qb->orWhere('is_draft', '=', true);
334			}
335
336			return $qb->getModels(true);
337			}
338
339			/**
340			* Get a query builder for news
341			*
342			* @throws Exception
343			*
344			* @return QueryBuilderFlex
345			*/
346			public static function getQueryBuilder()
347			{
348			return QueryBuilderFlex::createForModel(News::class)
			0 ignored issues – show Coding Style introduced 2018-02-03 04:54 UTC by Report Bug Copy Issue Report As per coding style, `self` should be used for accessing local static members. This check looks for accesses to local static members using the fully qualified name instead of `self::`. <?php class Certificate { const TRIPLEDES_CBC = 'ASDFGHJKL'; private $key; public function __construct() { $this->key = Certificate::TRIPLEDES_CBC; } } While this is perfectly valid, the fully qualified name of `Certificate::TRIPLEDES_CBC` could just as well be replaced by `self::TRIPLEDES_CBC`. Referencing local members with `self::` assured the access will still work when the class is renamed, makes it perfectly clear that the member is in fact local and will usually be shorter. Loading history...
349			->setNameColumn('subject')
350			;
351			}
352			}
353

allejo / bzion

Pull Request — master (#186)

News::getName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like