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-05-09 04:26 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
{
    /* @var PageChangeLog */
    protected $changelog;

    /** 
     * PageRevisions Ui constructor
     *
     * @param string $id  id of page
     */
    public function __construct($id = null)
    {
        global $INFO;
        if (!isset($id)) $id = $INFO['id'];
        $this->item = 'page';
        parent::__construct($id);
    }

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

    /** @inheritdoc */
    protected function itemFN($id, $rev = '')
    {
        return wikiFN($id, $rev);
    }

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

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