PageRevisions::getRevisions() - Code Metrics - Inspection of "Hierarchical class Ui\(Revisions,Diff)" - splitbrain/dokuwiki - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#3361)

unknown

created 2021-01-02 07:45 UTC

PageRevisions::getRevisions() B

↳ Parent: PageRevisions

Complexity

Conditions	8
Paths	17

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	8
nc	17
nop	2
dl	0
loc	51
rs	7.8246
c	0
b	0
f	0

How to fix Long Method

<?php

namespace dokuwiki\Ui;

use dokuwiki\ChangeLog\PageChangeLog;
use dokuwiki\Form\Form;

/**
 * DokuWiki PageRevisions Interface
 *
 * @package dokuwiki\Ui
 */
class PageRevisions extends Revisions
{
    /** 
     * PageRevisions Ui constructor
     *
     * @param string $id  id of page
     */
    public function __construct($id)
    {
        global $INFO;
        if (!$id) $id = $INFO['id'];
        $this->item = 'page';
        parent::__construct($id);
    }

    /** @inheritdoc */
    protected function setChangeLog()
    {
        $this->changelog = new PageChangeLog($this->id);

    }

    /**
     * Display list of old revisions of the page
     *
     * @author Andreas Gohr <[email protected]>
     * @author Ben Coburn <[email protected]>
     * @author Kate Arzamastseva <[email protected]>
     * @author Satoshi Sahara <[email protected]>
     *
     * @param int $first  skip the first n changelog lines
     * @return void
     */
    public function show($first = 0)
    {
        global $lang, $REV;

        // get revisions, and set correct pagenation parameters (first, hasNext)
        if ($first === null) $first = 0;
        $hasNext = false;
        $revisions = $this->getRevisions($first, $hasNext);

        // print intro
        print p_locale_xhtml('revisions');

        // create the form
        $form = new Form([
                'id' => 'page__revisions',
                'class' => 'changes',
        ]);
        $form->addTagOpen('div')->addClass('no');

        // start listing
        $form->addTagOpen('ul');
        foreach ($revisions as $info) {
            $rev = $info['date'];
            $class = ($info['type'] === DOKU_CHANGE_TYPE_MINOR_EDIT) ? 'minor' : '';
            $form->addTagOpen('li')->addClass($class);
            $form->addTagOpen('div')->addClass('li');

            if (isset($info['current'])) {
                $form->addCheckbox('rev2[]')->val('current');
            } elseif ($rev == $REV) {
                $form->addCheckbox('rev2[]')->val($rev)->attr('checked','checked');
            } elseif (page_exists($this->id, $rev)) {
                $form->addCheckbox('rev2[]')->val($rev);
            } else {
                $form->addCheckbox('')->val($rev)->attr('disabled','disabled');
            }
            $form->addHTML(' ');

            $objRevInfo = $this->getObjRevInfo($info);
            $html = implode(' ', [
                $objRevInfo->editDate(),          // edit date and time
                $objRevInfo->difflink(),          // link to diffview icon
                $objRevInfo->itemName(),          // name of page or media
                $objRevInfo->editSummary(),       // edit summary
                $objRevInfo->editor(),            // editor info
                $objRevInfo->sizechange(),        // size change indicator
                $objRevInfo->currentIndicator(),  // current indicator (only when k=1)
            ]);
            $form->addHTML($html);
            $form->addTagClose('div');
            $form->addTagClose('li');
        }
        $form->addTagClose('ul');  // end of revision list

        // show button for diff view
        $form->addButton('do[diff]', $lang['diff2'])->attr('type', 'submit');

        $form->addTagClose('div'); // close div class=no

        print $form->toHTML('Revisions');

        // provide navigation for pagenated revision list (of pages and/or media files)
        print $this->navigation($first, $hasNext, function ($n) {
            return array('do' => 'revisions', 'first' => $n);
        });
    }

    /**
     * Get revisions, and set correct pagenation parameters (first, hasNext)
     *
     * @param int  $first
     * @param bool $hasNext
     * @return array  revisions to be shown in a pagenated list
     * @see also https://www.dokuwiki.org/devel:changelog
     */
    protected function getRevisions(&$first, &$hasNext)
    {
        global $INFO, $conf;

        if ($this->id != $INFO['id']) {
            return parent::getRevisions($first, $hasNext);
        }

        $changelog =& $this->changelog;

        $revisions = [];

        /* we need to get one additional log entry to be able to
         * decide if this is the last page or is there another one.
         * see also Ui\Recent::getRecents()
         */
        $revlist = $changelog->getRevisions($first, $conf['recent'] +1);
        if (count($revlist) == 0 && $first != 0) {
            $first = 0;
            $revlist = $changelog->getRevisions($first, $conf['recent'] +1);
        }
        $exists = $INFO['exists'];
        if ($first == 0 && $exists) {
            // add current page as revision[0]
            $revisions[] = array(
                'date' => $INFO['lastmod'],
                'ip'   => null,
                'type' => $INFO['meta']['last_change']['type'],
                'id'   => $INFO['id'],
                'user' => $INFO['editor'],
                'sum'  => $INFO['sum'],
                'extra' => null,
                'sizechange' => $INFO['meta']['last_change']['sizechange'],
                'item' => $this->item,
                'current' => true,
            );
        }

        // decide if this is the last page or is there another one
        $hasNext = false;
        if (count($revlist) > $conf['recent']) {
            $hasNext = true;
            array_pop($revlist); // remove one additional log entry
        }

        // append each revison info array to the revisions
        foreach ($revlist as $rev) {
            $revisions[] = $changelog->getRevisionInfo($rev) + array('item' => $this->item);
        }
        return $revisions;
    }

}


1			<?php
2
3			namespace dokuwiki\Ui;
4
5			use dokuwiki\ChangeLog\PageChangeLog;
6			use dokuwiki\Form\Form;
7
8			/**
9			* DokuWiki PageRevisions Interface
10			*
11			* @package dokuwiki\Ui
12			*/
13			class PageRevisions extends Revisions
14			{
15			/**
16			* PageRevisions Ui constructor
17			*
18			* @param string $id id of page
19			*/
20			public function __construct($id)
21			{
22			global $INFO;
23			if (!$id) $id = $INFO['id'];
24			$this->item = 'page';
25			parent::__construct($id);
26			}
27
28			/** @inheritdoc */
29			protected function setChangeLog()
30			{
31			$this->changelog = new PageChangeLog($this->id);
			0 ignored issues – show Documentation Bug introduced 2020-12-31 16:38 UTC by Report Bug Copy Issue Report It seems like `new \dokuwiki\ChangeLog\PageChangeLog($this->id)` of type `object<dokuwiki\ChangeLog\PageChangeLog>` is incompatible with the declared type `object<dokuwiki\Ui\ChangeLog>` of property `$changelog`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
32			}
33
34			/**
35			* Display list of old revisions of the page
36			*
37			* @author Andreas Gohr <[email protected]>
38			* @author Ben Coburn <[email protected]>
39			* @author Kate Arzamastseva <[email protected]>
40			* @author Satoshi Sahara <[email protected]>
41			*
42			* @param int $first skip the first n changelog lines
43			* @return void
44			*/
45			public function show($first = 0)
46			{
47			global $lang, $REV;
48
49			// get revisions, and set correct pagenation parameters (first, hasNext)
50			if ($first === null) $first = 0;
51			$hasNext = false;
52			$revisions = $this->getRevisions($first, $hasNext);
53
54			// print intro
55			print p_locale_xhtml('revisions');
56
57			// create the form
58			$form = new Form([
59			'id' => 'page__revisions',
60			'class' => 'changes',
61			]);
62			$form->addTagOpen('div')->addClass('no');
63
64			// start listing
65			$form->addTagOpen('ul');
66			foreach ($revisions as $info) {
67			$rev = $info['date'];
68			$class = ($info['type'] === DOKU_CHANGE_TYPE_MINOR_EDIT) ? 'minor' : '';
69			$form->addTagOpen('li')->addClass($class);
70			$form->addTagOpen('div')->addClass('li');
71
72			if (isset($info['current'])) {
73			$form->addCheckbox('rev2[]')->val('current');
74			} elseif ($rev == $REV) {
75			$form->addCheckbox('rev2[]')->val($rev)->attr('checked','checked');
76			} elseif (page_exists($this->id, $rev)) {
77			$form->addCheckbox('rev2[]')->val($rev);
78			} else {
79			$form->addCheckbox('')->val($rev)->attr('disabled','disabled');
80			}
81			$form->addHTML(' ');
82
83			$objRevInfo = $this->getObjRevInfo($info);
84			$html = implode(' ', [
85			$objRevInfo->editDate(), // edit date and time
86			$objRevInfo->difflink(), // link to diffview icon
87			$objRevInfo->itemName(), // name of page or media
88			$objRevInfo->editSummary(), // edit summary
89			$objRevInfo->editor(), // editor info
90			$objRevInfo->sizechange(), // size change indicator
91			$objRevInfo->currentIndicator(), // current indicator (only when k=1)
92			]);
93			$form->addHTML($html);
94			$form->addTagClose('div');
95			$form->addTagClose('li');
96			}
97			$form->addTagClose('ul'); // end of revision list
98
99			// show button for diff view
100			$form->addButton('do[diff]', $lang['diff2'])->attr('type', 'submit');
101
102			$form->addTagClose('div'); // close div class=no
103
104			print $form->toHTML('Revisions');
105
106			// provide navigation for pagenated revision list (of pages and/or media files)
107			print $this->navigation($first, $hasNext, function ($n) {
108			return array('do' => 'revisions', 'first' => $n);
109			});
110			}
111
112			/**
113			* Get revisions, and set correct pagenation parameters (first, hasNext)
114			*
115			* @param int $first
116			* @param bool $hasNext
117			* @return array revisions to be shown in a pagenated list
118			* @see also https://www.dokuwiki.org/devel:changelog
119			*/
120			protected function getRevisions(&$first, &$hasNext)
121			{
122			global $INFO, $conf;
123
124			if ($this->id != $INFO['id']) {
125			return parent::getRevisions($first, $hasNext);
126			}
127
128			$changelog =& $this->changelog;
129
130			$revisions = [];
131
132			/* we need to get one additional log entry to be able to
133			* decide if this is the last page or is there another one.
134			* see also Ui\Recent::getRecents()
135			*/
136			$revlist = $changelog->getRevisions($first, $conf['recent'] +1);
137			if (count($revlist) == 0 && $first != 0) {
138			$first = 0;
139			$revlist = $changelog->getRevisions($first, $conf['recent'] +1);
140			}
141			$exists = $INFO['exists'];
142			if ($first == 0 && $exists) {
143			// add current page as revision[0]
144			$revisions[] = array(
145			'date' => $INFO['lastmod'],
146			'ip' => null,
147			'type' => $INFO['meta']['last_change']['type'],
148			'id' => $INFO['id'],
149			'user' => $INFO['editor'],
150			'sum' => $INFO['sum'],
151			'extra' => null,
152			'sizechange' => $INFO['meta']['last_change']['sizechange'],
153			'item' => $this->item,
154			'current' => true,
155			);
156			}
157
158			// decide if this is the last page or is there another one
159			$hasNext = false;
160			if (count($revlist) > $conf['recent']) {
161			$hasNext = true;
162			array_pop($revlist); // remove one additional log entry
163			}
164
165			// append each revison info array to the revisions
166			foreach ($revlist as $rev) {
167			$revisions[] = $changelog->getRevisionInfo($rev) + array('item' => $this->item);
168			}
169			return $revisions;
170			}
171
172			}
173

splitbrain / dokuwiki

Pull Request — master (#3361)

PageRevisions::getRevisions() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like