PostingHelper::renderThread() - Code Metrics - Inspection of "Fixes category order of select input in posting fo..." - Schlaefer/Saito - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 39cce9...b6db21 )

by Schlaefer

created 2019-09-01 07:23 UTC

PostingHelper::renderThread() A

↳ Parent: PostingHelper

Complexity

Conditions	5
Paths	5

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
nc	5
nop	2
dl	0
loc	36
rs	9.0328
c	0
b	0
f	0

<?php

declare(strict_types=1);

/**
 * Saito - The Threaded Web Forum
 *
 * @copyright Copyright (c) the Saito Project Developers
 * @link https://github.com/Schlaefer/Saito
 * @license http://opensource.org/licenses/MIT
 */

namespace App\View\Helper;

use App\View\Helper\TimeHHelper;
use Cake\Core\Configure;
use Cake\View\Helper\FormHelper;
use Cake\View\Helper\HtmlHelper;
use Saito\Event\SaitoEventManager;
use Saito\Posting\Basic\BasicPostingInterface;
use Saito\Posting\PostingInterface;
use Saito\Thread\Renderer;

/**
 * Class PostingHelper
 *
 * @property FormHelper $Form
 * @property HtmlHelper $Html
 * @property TimeHHelper $TimeH
 * @package App\View\Helper
 */
class PostingHelper extends AppHelper
{
    public $helpers = ['Form', 'Html', 'TimeH'];

    /**
     * @var array perf-cheat for renderers
     */
    protected $_renderers = [];

    /**
     * @var SaitoEventManager
     */
    protected $_SEM;

    /**
     * get paginated index
     *
     * @param int $tid tid
     * @param null|string $lastAction last action
     * @return string
     */
    public function getPaginatedIndexPageId(int $tid, ?string $lastAction = null): string
    {
        $params = [];
        if ($lastAction !== 'add') {
            $session = $this->getView()->getRequest()->getSession();
            if ($session->read('paginator.lastPage')) {
                $params[] = 'page=' . $session->read('paginator.lastPage');
            }
        }
        $params[] = 'jump=' . $tid;

        return '/?' . implode('&', $params);
    }

    /**
     * Get fast link for posting.
     *
     * @param BasicPostingInterface $posting posting
     * @param array $options options
     * @return string HTML
     */
    public function getFastLink(BasicPostingInterface $posting, array $options = [])
    {
        $options += ['class' => ''];
        $id = $posting->get('id');
        $webroot = $this->getView()->getRequest()->getAttribute('webroot');
        $url = "{$webroot}entries/view/{$id}";
        $link = "<a href=\"{$url}\" class=\"{$options['class']}\">" . $this->getSubject($posting) . '</a>';

        return $link;
    }

    /**
     * Render view counter
     *
     * @param BasicPostingInterface $posting posting
     *
     * @return string
     */
    public function views(BasicPostingInterface $posting)
    {
        return __('views_headline') . ': ' . $posting->get('views');
    }

    /**
     * renders a posting tree as thread
     *
     * @param PostingInterface $tree passed as reference to share CU-decorator "up"
     * @param array $options options
     *    - 'renderer' [thread]|mix
     * @return string
     * @internal param CurrentUser $CurrentUser current user
     */
    public function renderThread(PostingInterface $tree, array $options = [])
    {
        $options += [
            'lineCache' => $this->_View->get('LineCache'),
            'maxThreadDepthIndent' => (int)Configure::read(
                'Saito.Settings.thread_depth_indent'
            ),
            'renderer' => 'thread',
            'rootWrap' => false
        ];
        $renderer = $options['renderer'];
        unset($options['renderer']);

        if (isset($this->_renderers[$renderer])) {
            $renderer = $this->_renderers[$renderer];
        } else {
            $name = $renderer;
            switch ($name) {
                case 'mix':
                    $renderer = new Renderer\MixHtmlRenderer($this);
                    break;
                case 'thread':
                    $renderer = new Renderer\ThreadHtmlRenderer($this);
                    break;
                case (is_string($renderer)):
                    $renderer = new $renderer($this);
                    break;
                default:
                    $renderer = new Renderer\ThreadHtmlRenderer($this);
            }
            $this->_renderers[$name] = $renderer;
        }
        $renderer->setOptions($options);

        return $renderer->render($tree);
    }

    /**
     * Get badges
     *
     * @param PostingInterface $entry posting
     * @return string
     */
    public function getBadges(PostingInterface $entry)
    {
        $out = '';
        if ($entry->isPinned()) {
            $out .= '<i class="fa fa-thumb-tack" title="' . __('fixed') . '"></i> ';
        }
        // anchor for inserting solve-icon via FE-JS
        $out .= '<span class="solves ' . $entry->get('id') . '">';
        if ($entry->get('solves')) {
            $out .= $this->solvedBadge();
        }
        $out .= '</span>';

        $additionalBadges = $this->getSaitoEventManager()->dispatch(
            'Request.Saito.View.Posting.badges',
            ['posting' => $entry->toArray()]
        );
        if ($additionalBadges) {
            $out .= implode('', $additionalBadges);
        }

        return $out;
    }

    /**
     * Get solved badge
     *
     * @return string
     */
    public function solvedBadge()
    {
        return '<i class="fa fa-badge-solves solves-isSolved" title="' .
        __('Helpful entry') . '"></i>';
    }

    /**
     * This function may be called serveral hundred times on the front page.
     * Don't make ist slow, benchmark!
     *
     * @param BasicPostingInterface $posting posting
     * @return string
     */
    public function getSubject(BasicPostingInterface $posting)
    {
        return \h($posting->get('subject')) . ($posting->isNt() ? ' n/t' : '');
    }

    /**
     * Gets SaitoEventManager
     *
     * @return SaitoEventManager
     */
    private function getSaitoEventManager(): SaitoEventManager
    {
        if ($this->_SEM === null) {
            $this->_SEM = SaitoEventManager::getInstance();
        }

        return $this->_SEM;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/**
6			* Saito - The Threaded Web Forum
7			*
8			* @copyright Copyright (c) the Saito Project Developers
9			* @link https://github.com/Schlaefer/Saito
10			* @license http://opensource.org/licenses/MIT
11			*/
12
13			namespace App\View\Helper;
14
15			use App\View\Helper\TimeHHelper;
16			use Cake\Core\Configure;
17			use Cake\View\Helper\FormHelper;
18			use Cake\View\Helper\HtmlHelper;
19			use Saito\Event\SaitoEventManager;
20			use Saito\Posting\Basic\BasicPostingInterface;
21			use Saito\Posting\PostingInterface;
22			use Saito\Thread\Renderer;
23
24			/**
25			* Class PostingHelper
26			*
27			* @property FormHelper $Form
28			* @property HtmlHelper $Html
29			* @property TimeHHelper $TimeH
30			* @package App\View\Helper
31			*/
32			class PostingHelper extends AppHelper
33			{
34			public $helpers = ['Form', 'Html', 'TimeH'];
35
36			/**
37			* @var array perf-cheat for renderers
38			*/
39			protected $_renderers = [];
40
41			/**
42			* @var SaitoEventManager
43			*/
44			protected $_SEM;
45
46			/**
47			* get paginated index
48			*
49			* @param int $tid tid
50			* @param null\|string $lastAction last action
51			* @return string
52			*/
53			public function getPaginatedIndexPageId(int $tid, ?string $lastAction = null): string
54			{
55			$params = [];
56			if ($lastAction !== 'add') {
57			$session = $this->getView()->getRequest()->getSession();
58			if ($session->read('paginator.lastPage')) {
59			$params[] = 'page=' . $session->read('paginator.lastPage');
60			}
61			}
62			$params[] = 'jump=' . $tid;
63
64			return '/?' . implode('&', $params);
65			}
66
67			/**
68			* Get fast link for posting.
69			*
70			* @param BasicPostingInterface $posting posting
71			* @param array $options options
72			* @return string HTML
73			*/
74			public function getFastLink(BasicPostingInterface $posting, array $options = [])
75			{
76			$options += ['class' => ''];
77			$id = $posting->get('id');
78			$webroot = $this->getView()->getRequest()->getAttribute('webroot');
79			$url = "{$webroot}entries/view/{$id}";
80			$link = "<a href=\"{$url}\" class=\"{$options['class']}\">" . $this->getSubject($posting) . '</a>';
81
82			return $link;
83			}
84
85			/**
86			* Render view counter
87			*
88			* @param BasicPostingInterface $posting posting
89			*
90			* @return string
91			*/
92			public function views(BasicPostingInterface $posting)
93			{
94			return __('views_headline') . ': ' . $posting->get('views');
95			}
96
97			/**
98			* renders a posting tree as thread
99			*
100			* @param PostingInterface $tree passed as reference to share CU-decorator "up"
101			* @param array $options options
102			* - 'renderer' [thread]\|mix
103			* @return string
104			* @internal param CurrentUser $CurrentUser current user
105			*/
106			public function renderThread(PostingInterface $tree, array $options = [])
107			{
108			$options += [
109			'lineCache' => $this->_View->get('LineCache'),
110			'maxThreadDepthIndent' => (int)Configure::read(
111			'Saito.Settings.thread_depth_indent'
112			),
113			'renderer' => 'thread',
114			'rootWrap' => false
115			];
116			$renderer = $options['renderer'];
117			unset($options['renderer']);
118
119			if (isset($this->_renderers[$renderer])) {
120			$renderer = $this->_renderers[$renderer];
121			} else {
122			$name = $renderer;
123			switch ($name) {
124			case 'mix':
125			$renderer = new Renderer\MixHtmlRenderer($this);
126			break;
127			case 'thread':
128			$renderer = new Renderer\ThreadHtmlRenderer($this);
129			break;
130			case (is_string($renderer)):
131			$renderer = new $renderer($this);
132			break;
133			default:
134			$renderer = new Renderer\ThreadHtmlRenderer($this);
135			}
136			$this->_renderers[$name] = $renderer;
137			}
138			$renderer->setOptions($options);
139
140			return $renderer->render($tree);
141			}
142
143			/**
144			* Get badges
145			*
146			* @param PostingInterface $entry posting
147			* @return string
148			*/
149			public function getBadges(PostingInterface $entry)
150			{
151			$out = '';
152			if ($entry->isPinned()) {
153			$out .= '<i class="fa fa-thumb-tack" title="' . __('fixed') . '"></i> ';
154			}
155			// anchor for inserting solve-icon via FE-JS
156			$out .= '<span class="solves ' . $entry->get('id') . '">';
157			if ($entry->get('solves')) {
158			$out .= $this->solvedBadge();
159			}
160			$out .= '</span>';
161
162			$additionalBadges = $this->getSaitoEventManager()->dispatch(
163			'Request.Saito.View.Posting.badges',
164			['posting' => $entry->toArray()]
165			);
166			if ($additionalBadges) {
167			$out .= implode('', $additionalBadges);
168			}
169
170			return $out;
171			}
172
173			/**
174			* Get solved badge
175			*
176			* @return string
177			*/
178			public function solvedBadge()
179			{
180			return '<i class="fa fa-badge-solves solves-isSolved" title="' .
181			__('Helpful entry') . '"></i>';
182			}
183
184			/**
185			* This function may be called serveral hundred times on the front page.
186			* Don't make ist slow, benchmark!
187			*
188			* @param BasicPostingInterface $posting posting
189			* @return string
190			*/
191			public function getSubject(BasicPostingInterface $posting)
192			{
193			return \h($posting->get('subject')) . ($posting->isNt() ? ' n/t' : '');
194			}
195
196			/**
197			* Gets SaitoEventManager
198			*
199			* @return SaitoEventManager
200			*/
201			private function getSaitoEventManager(): SaitoEventManager
202			{
203			if ($this->_SEM === null) {
204			$this->_SEM = SaitoEventManager::getInstance();
205			}
206
207			return $this->_SEM;
208			}
209			}
210

Schlaefer / Saito

Push — develop ( 39cce9...b6db21 )

PostingHelper::renderThread() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like