Sort::sort() - Code Metrics - Inspection of "Update deps" - PowerKiKi/mqueue - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ca1336...ce2897 )

by Adrien

created 2016-08-08 10:12 UTC

Sort::sort() A

↳ Parent: Sort

Complexity

Conditions	4
Paths	8

Size

Total Lines	16
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	4.0218

Importance

Changes	3
Bugs	1	Features	0

Metric	Value
cc	4
eloc	9
c	3
b	1
f	0
nc	8
nop	5
dl	0
loc	16
ccs	8
cts	9
cp	0.8889
crap	4.0218
rs	9.2

<?php

namespace mQueue\View\Helper;

use Zend_View_Helper_Abstract;

class Sort extends Zend_View_Helper_Abstract
{
    /**
     * Return an HTML links to be able to sort (will typically be in table header)
     * @param string $label
     * @param string $column
     * @param string $selectedSortKey
     * @param string $selectedSortOrder
     * @param array $additionalParameters

     * @return string
     */
    public function sort($label, $column, $selectedSortKey, $selectedSortOrder, array $additionalParameters = null)

    {
        if (is_null($additionalParameters)) {
            $additionalParameters = [];
        }

        $orders = ['desc' => 'asc', 'asc' => 'desc'];
        if (!in_array($selectedSortOrder, $orders)) {
            $selectedSortOrder = reset($orders);
        }

        $url = $this->view->urlParams(array_merge($additionalParameters, ['sort' => $column, 'sortOrder' => $orders[$selectedSortOrder]]));

        $result = '<a class="sort ' . ($column == $selectedSortKey ? $selectedSortOrder : '') . '" title="' . $this->view->escape($this->view->translate('Sort by "%s"', [$label])) . '" href="' . $url . '">' . $this->view->escape($label) . '</a>';
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        return $result;
    }
}


1		<?php
2
3		namespace mQueue\View\Helper;
4
5		use Zend_View_Helper_Abstract;
6
7		class Sort extends Zend_View_Helper_Abstract
8		{
9		/**
10		* Return an HTML links to be able to sort (will typically be in table header)
11		* @param string $label
12		* @param string $column
13		* @param string $selectedSortKey
14		* @param string $selectedSortOrder
15		* @param array $additionalParameters
		0 ignored issues – show Documentation introduced 2016-03-14 20:04 UTC by Report Bug Copy Issue Report Should the type for parameter `$additionalParameters` not be `null\|array`? Also, consider making the array more specific, something like `array<String>`, or `String[]`. This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. In addition it looks for parameters that have the generic type `array` and suggests a stricter type like `array<String>`. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
16		* @return string
17		*/
18	1	public function sort($label, $column, $selectedSortKey, $selectedSortOrder, array $additionalParameters = null)
		0 ignored issues – show Coding Style Best Practice introduced 2016-03-14 20:04 UTC by Report Bug Copy Issue Report Please use `__construct()` instead of a PHP4-style constructor that is named after the class. Loading history...
19		{
20	1	if (is_null($additionalParameters)) {
21		$additionalParameters = [];
22		}
23
24	1	$orders = ['desc' => 'asc', 'asc' => 'desc'];
25	1	if (!in_array($selectedSortOrder, $orders)) {
26	1	$selectedSortOrder = reset($orders);
27		}
28
29	1	$url = $this->view->urlParams(array_merge($additionalParameters, ['sort' => $column, 'sortOrder' => $orders[$selectedSortOrder]]));
		1 ignored issue – show Bug introduced 2016-03-14 20:04 UTC by Report Bug Copy Issue Report The method `urlParams()` does not seem to exist on `object<Zend_View_Interface>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
30	1	$result = '<a class="sort ' . ($column == $selectedSortKey ? $selectedSortOrder : '') . '" title="' . $this->view->escape($this->view->translate('Sort by "%s"', [$label])) . '" href="' . $url . '">' . $this->view->escape($label) . '</a>';
		1 ignored issue – show Bug introduced 2016-03-14 20:04 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend_View_Interface` as the method `translate()` does only exist in the following implementations of said interface: `Zend_View`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
31
32	1	return $result;
33		}
34		}
35

PowerKiKi / mqueue

Push — master ( ca1336...ce2897 )

Sort::sort() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like