PostingHelper::urlToMix() - Code Metrics - Inspection of "Layout changes #367 #370" - Schlaefer/Saito - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — develop ( 6506e6...8fe651 )

by Schlaefer
created 2020-03-14 07:35 UTC
PostingHelper::urlToMix() A

↳ Parent: PostingHelper
Complexity

Conditions	2
Paths	2
Size

Total Lines	8
Code Lines	5
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	2
eloc	5
nc	2
nop	2
dl	0
loc	8
rs	10
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[] = 'page=' . /** @scrutinizer ignore-type */ $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(
            'saito.core.posting.view.badges.request',
            ['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' : '');
    }

    /**
     * Generate URL to mix view from Posting
     *
     * @param PostingInterface $posting Posting to generate URL for
     * @param bool $jump Jump to posting in mix view
     * @return string
     */
    public function urlToMix(PostingInterface $posting, bool $jump = true): string
    {
        $tid = $posting->get('tid');
        $webroot = $this->getView()->getRequest()->getAttribute('webroot');
        $url = "${webroot}entries/mix/${tid}";
        $url .= $jump ? '#' . $posting->get('id') : '';

        return $url;
    }

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

        return $this->_SEM;
    }
}

Schlaefer / Saito

Push — develop ( 6506e6...8fe651 )

PostingHelper::urlToMix() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
