Page::isHomePage() - 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-10 23:08 UTC

Page::isHomePage() A

↳ Parent: Page

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 custom pages that admins can great
 *
 * @package    BZiON\Models
 * @license    https://github.com/allejo/bzion/blob/master/LICENSE.md GNU General Public License Version 3
 */

/**
 * A custom page
 * @package    BZiON\Models
 */
class Page extends AliasModel
{
    /**
     * The content of the page
     * @var string
     */
    protected $content;

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

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

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

    protected $is_draft;
    protected $is_unlisted;

    const DEFAULT_STATUS = 'live';

    const DELETED_COLUMN = 'is_deleted';
    const TABLE = 'pages';

    const CREATE_PERMISSION = Permission::CREATE_PAGE;
    const EDIT_PERMISSION = Permission::EDIT_PAGE;
    const SOFT_DELETE_PERMISSION = Permission::SOFT_DELETE_PAGE;
    const HARD_DELETE_PERMISSION = Permission::HARD_DELETE_PAGE;

    /**
     * {@inheritdoc}
     */
    protected function assignResult($page)
    {
        $this->name = $page['name'];
        $this->alias = $page['alias'];
        $this->author = $page['author'];
        $this->is_unlisted = $page['is_unlisted'];
        $this->is_draft = $page['is_draft'];
        $this->is_deleted = $page['is_deleted'];
    }

    /**
     * {@inheritdoc}
     */
    protected function assignLazyResult($page)
    {
        $this->content = $page['content'];
        $this->created = TimeDate::fromMysql($page['created']);
        $this->updated = TimeDate::fromMysql($page['updated']);
    }

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

        return $this->content;
    }

    /**
     * Get the page's submission time
     * @return TimeDate
     */
    public function getCreated()
    {
        $this->lazyLoad();

        return $this->created->copy();
    }

    /**
     * Get the time when the page was last updated
     * @return TimeDate
     */
    public function getUpdated()
    {
        $this->lazyLoad();

        return $this->updated->copy();
    }

    /**
     * Get the user who created the page
     * @return Player The page's author
     */
    public function getAuthor()
    {
        return Player::get($this->author);
    }

    /**
     * Get whether or not this Page is a draft.
     *
     * @since 0.11.0
     *
     * @return bool
     */
    public function isDraft()
    {
        return (bool)$this->is_draft;
    }

    /**
     * Get whether or not this Page was unlisted.
     *
     * An unlisted page will not appear in the secondary navigation.
     *
     * @since 0.11.0
     *
     * @return bool
     */
    public function isUnlisted()
    {
        return (bool)$this->is_unlisted;
    }

    /**
     * Set the content of the page
     *
     * @param  string $content
     *
     * @return static
     */
    public function setContent($content)
    {
        return $this->updateProperty($this->content, "content", $content);
    }

    /**
     * Set the draft status for this page.
     *
     * @param bool $draft
     *
     * @return static
     */
    public function setDraft($draft)
    {
        return $this->updateProperty($this->is_draft, 'is_draft', $draft);
    }

    /**
     * Set the unlisted status for this page.
     *
     * @param bool $unlisted
     *
     * @return static
     */
    public function setUnlisted($unlisted)
    {
        return $this->updateProperty($this->is_unlisted, 'is_unlisted', $unlisted);
    }

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

    /**
     * Create a new Page
     *
     * @param string $title       The title of the page
     * @param string $content     The content of page
     * @param int    $authorID    The ID of the author
     * @param bool   $is_draft    Whether or not the page should be saved as a draft
     * @param bool   $is_unlisted Whether or not the page should be unlisted
     *
     * @since 0.11.0 The former enum $status parameter has been changed to the boolean $is_draft. The $is_unlisted
     *               argument has been added.
     *
     * @return Page An object representing the page that was just created
     */
    public static function addPage($title, $content, $authorID, $is_draft = false, $is_unlisted = false)
    {
        return self::create([
            'name'    => $title,
            'alias'   => self::generateAlias($title),
            'content' => $content,
            'author'  => $authorID,
            'is_draft' => (bool)$is_draft,
            'is_unlisted' => (bool)$is_unlisted,
        ], ['created', 'updated']);
    }

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

    /**
     * {@inheritdoc}
     */
    protected static function getDisallowedAliases()
    {
        return array(
            "admin", "bans", "index", "login", "logout", "maps", "matches",
            "messages", "news", "notifications", "pages", "players", "servers",
            "teams", "visits"
        );
    }

    /**
     * {@inheritdoc}
     */
    public static function getActiveStatuses()
    {
        return array('live', 'revision');
    }

    /**
     * {@inheritdoc}
     */
    public static function getEagerColumns($prefix = null)
    {
        $columns = [
            'id',
            'parent_id',
            'name',
            'alias',
            'author',
            'home',
            'status',
        ];

        return self::formatColumns($prefix, $columns);

    }

    /**
     * {@inheritdoc}
     */
    public static function getLazyColumns()
    {
        return 'content,created,updated';
    }

    /**
     * {@inheritdoc}
     */
    public static function getQueryBuilder()
    {
        return QueryBuilderFlex::createForModel(Page::class)
<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

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

    /**
     * {@inheritdoc}
     */
    public static function getActiveModels(QueryBuilderFlex &$qb)
    {
        $qb
            ->whereNot(self::DELETED_COLUMN, '=', self::DELETED_VALUE)
            ->whereNot('is_draft', '=', true)
        ;

        return true;
    }

    /**
     * {@inheritdoc}
     */
    public static function getEagerColumnsList()
    {
        return [
            'id',
            'name',
            'alias',
            'author',
            'is_draft',
            'is_deleted',
            'is_unlisted',
        ];
    }

    /**
     * Get the home page
     * @deprecated
     * @return Page
     */
    public static function getHomePage()
    {
        return self::get(self::fetchIdFrom(1, "home"));
    }
}


1		<?php
2		/**
3		* This file contains functionality relating to the custom pages that admins can great
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 custom page
11		* @package BZiON\Models
12		*/
13		class Page extends AliasModel
14		{
15		/**
16		* The content of the page
17		* @var string
18		*/
19		protected $content;
20
21		/**
22		* The creation date of the page
23		* @var TimeDate
24		*/
25		protected $created;
26
27		/**
28		* The date the page was last updated
29		* @var TimeDate
30		*/
31		protected $updated;
32
33		/**
34		* The ID of the author of the page
35		* @var int
36		*/
37		protected $author;
38
39		protected $is_draft;
40		protected $is_unlisted;
41
42		const DEFAULT_STATUS = 'live';
43
44		const DELETED_COLUMN = 'is_deleted';
45		const TABLE = 'pages';
46
47		const CREATE_PERMISSION = Permission::CREATE_PAGE;
48		const EDIT_PERMISSION = Permission::EDIT_PAGE;
49		const SOFT_DELETE_PERMISSION = Permission::SOFT_DELETE_PAGE;
50		const HARD_DELETE_PERMISSION = Permission::HARD_DELETE_PAGE;
51
52		/**
53		* {@inheritdoc}
54		*/
55		protected function assignResult($page)
56		{
57		$this->name = $page['name'];
58		$this->alias = $page['alias'];
59		$this->author = $page['author'];
60		$this->is_unlisted = $page['is_unlisted'];
61		$this->is_draft = $page['is_draft'];
62		$this->is_deleted = $page['is_deleted'];
63		}
64	1
65		/**
66	1	* {@inheritdoc}
67	1	*/
68	1	protected function assignLazyResult($page)
69	1	{
70	1	$this->content = $page['content'];
71	1	$this->created = TimeDate::fromMysql($page['created']);
72		$this->updated = TimeDate::fromMysql($page['updated']);
73		}
74
75		/**
76		* Get the raw content of the page
77		* @return string
78		*/
79		public function getContent()
80		{
81		$this->lazyLoad();
82
83		return $this->content;
84		}
85
86		/**
87		* Get the page's submission time
88		* @return TimeDate
89		*/
90		public function getCreated()
91		{
92		$this->lazyLoad();
93
94		return $this->created->copy();
95		}
96
97		/**
98		* Get the time when the page was last updated
99		* @return TimeDate
100		*/
101		public function getUpdated()
102		{
103		$this->lazyLoad();
104
105		return $this->updated->copy();
106		}
107
108		/**
109		* Get the user who created the page
110		* @return Player The page's author
111		*/
112		public function getAuthor()
113		{
114		return Player::get($this->author);
115		}
116
117		/**
118		* Get whether or not this Page is a draft.
119		*
120		* @since 0.11.0
121		*
122		* @return bool
123		*/
124		public function isDraft()
125		{
126		return (bool)$this->is_draft;
127		}
128
129	1	/**
130		* Get whether or not this Page was unlisted.
131	1	*
132		* An unlisted page will not appear in the secondary navigation.
133		*
134		* @since 0.11.0
135		*
136		* @return bool
137		*/
138	1	public function isUnlisted()
139		{
140	1	return (bool)$this->is_unlisted;
141		}
142
143		/**
144		* Set the content of the page
145		*
146		* @param string $content
147		*
148		* @return static
149		*/
150		public function setContent($content)
151		{
152		return $this->updateProperty($this->content, "content", $content);
153		}
154
155		/**
156		* Set the draft status for this page.
157		*
158		* @param bool $draft
159		*
160		* @return static
161		*/
162		public function setDraft($draft)
163		{
164		return $this->updateProperty($this->is_draft, 'is_draft', $draft);
165		}
166
167		/**
168		* Set the unlisted status for this page.
169		*
170		* @param bool $unlisted
171		*
172		* @return static
173		*/
174		public function setUnlisted($unlisted)
175		{
176		return $this->updateProperty($this->is_unlisted, 'is_unlisted', $unlisted);
177		}
178
179		/**
180		* Update the last edit timestamp
181		* @return self
182		*/
183		public function updateEditTimestamp()
184	1	{
185		return $this->updateProperty($this->updated, "updated", TimeDate::now());
186	1	}
187	1
188	1	/**
189	1	* Create a new Page
190	1	*
191	1	* @param string $title The title of the page
192	1	* @param string $content The content of page
193	1	* @param int $authorID The ID of the author
194		* @param bool $is_draft Whether or not the page should be saved as a draft
195		* @param bool $is_unlisted Whether or not the page should be unlisted
196		*
197		* @since 0.11.0 The former enum $status parameter has been changed to the boolean $is_draft. The $is_unlisted
198		* argument has been added.
199	1	*
200		* @return Page An object representing the page that was just created
201	1	*/
202		public static function addPage($title, $content, $authorID, $is_draft = false, $is_unlisted = false)
203		{
204		return self::create([
205		'name' => $title,
206		'alias' => self::generateAlias($title),
207	1	'content' => $content,
208		'author' => $authorID,
209		'is_draft' => (bool)$is_draft,
210	1	'is_unlisted' => (bool)$is_unlisted,
211		], ['created', 'updated']);
212		}
213
214		/**
215		* {@inheritdoc}
216		*/
217		public static function getRouteName($action = 'show')
218		{
219	1	return "custom_page_$action";
220		}
221	1
222		/**
223		* {@inheritdoc}
224		*/
225		protected static function getDisallowedAliases()
226		{
227	1	return array(
228		"admin", "bans", "index", "login", "logout", "maps", "matches",
229		"messages", "news", "notifications", "pages", "players", "servers",
230	1	"teams", "visits"
231		);
232		}
233
234		/**
235		* {@inheritdoc}
236		*/
237		public static function getActiveStatuses()
238		{
239	1	return array('live', 'revision');
240		}
241
242		/**
243		* {@inheritdoc}
244		*/
245		public static function getEagerColumns($prefix = null)
246		{
247		$columns = [
248		'id',
249		'parent_id',
250		'name',
251		'alias',
252		'author',
253		'home',
254	1	'status',
255		];
256	1
257	1	return self::formatColumns($prefix, $columns);
		0 ignored issues – show Deprecated Code introduced 2018-02-08 15:41 UTC by Report Bug Copy Issue Report The method `BaseModel::formatColumns()` has been deprecated with message: 0.10.2 This function has been removed and is no longer required with the new query builder This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
258		}
259
260		/**
261		* {@inheritdoc}
262		*/
263		public static function getLazyColumns()
264		{
265		return 'content,created,updated';
266		}
267
268		/**
269		* {@inheritdoc}
270		*/
271		public static function getQueryBuilder()
272		{
273		return QueryBuilderFlex::createForModel(Page::class)
		0 ignored issues – show Coding Style introduced 2018-02-08 09:22 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...
274		->setNameColumn('name')
275		;
276		}
277
278		/**
279		* {@inheritdoc}
280		*/
281		public static function getActiveModels(QueryBuilderFlex &$qb)
282		{
283		$qb
284		->whereNot(self::DELETED_COLUMN, '=', self::DELETED_VALUE)
285		->whereNot('is_draft', '=', true)
286		;
287
288		return true;
289		}
290
291		/**
292		* {@inheritdoc}
293		*/
294		public static function getEagerColumnsList()
295		{
296		return [
297		'id',
298		'name',
299		'alias',
300		'author',
301		'is_draft',
302		'is_deleted',
303		'is_unlisted',
304		];
305		}
306
307		/**
308		* Get the home page
309		* @deprecated
310		* @return Page
311		*/
312		public static function getHomePage()
313		{
314		return self::get(self::fetchIdFrom(1, "home"));
315		}
316		}
317

allejo / bzion

Pull Request — master (#186)

Page::isHomePage() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like