Mailto::__invoke() - Code Metrics - Inspection of "Merge branch 'feature/updateToZf3'" - heiglandreas/OrgHeiglMailproxy - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3f69b2...0cfd6f )

by Andreas

created 2017-02-22 06:50 UTC

Mailto::__invoke() B

↳ Parent: Mailto

Complexity

Conditions	4
Paths	5

Size

Total Lines	26
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	26
rs	8.5806
cc	4
eloc	14
nc	5
nop	3

<?php
/**
 * Copyright (c) 2011-2012 Andreas Heigl<[email protected]>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 * @category  MailProxy
 * @package   OrgHeiglMailproxy
 * @author    Andreas Heigl<[email protected]>
 * @copyright 2011-2012 Andreas Heigl
 * @license   http://www.opesource.org/licenses/mit-license.php MIT-License
 * @version   0.0
 * @since     06.03.2012
 * @link      http://github.com/heiglandreas/mailproxyModule
 */
namespace Org_Heigl\Mailproxy\View\Helper;

use Zend\View\Helper\AbstractHtmlElement as HtmlElement;

/**
 * A view helper taht generates a mailto-link with an obfuscated eMail-address
 *
 * The mail-address will be reversed and via RightToLeft-Display is visible the
 * "normal" way. clicking the link will call the ProxyController and redirect to
 * a mailto: url which will open the users Mail-Client
 *
 * @author    Andreas Heigl<[email protected]>
 * @copyright Andreas Heigl
 * @license   http://www.opesource.org/licenses/mit-license.php MIT-License
 * @version   0.0
 * @since     06.03.2012
 * @link      http://github.com/heiglandreas/OrgHeiglMailproxy
 */
class Mailto extends HtmlElement
{
    /**
     * The class to use for marking this element
     *
     * var string $class
     */
    private $mailtoclass = 'orgHeiglMailProxy';
    /**
     * create a link to the mailproxy-url
     *
     * @param string $address  The Mail-address to proxy to
     * @param string $linktext The optional link text. $address will be used if
     * omited
     * @param array  $params   Optional parameters
     *
     * @return void
     */
    public function __invoke($address, $linktext = null, $params = array())
    {
        $url = $this->getView()->url('mailproxy', ['id' => strrev($address)]);
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.
    }
}
        $this->getView()->headStyle()->appendStyle('.' . $this->mailtoclass . '{
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.
    }
}
    direction: rtl;
    unicode-bidi: bidi-override;

}');

        if (null === $linktext) {
            $linktext = strrev($address);
            $classes = array();
            if (isset($params['class'])) {
                $classes = $params['class'];
                $classes = explode(' ', $classes);
            }
            if (! in_array($this->mailtoclass, $classes)) {
                $classes[] = $this->mailtoclass;
            }
            $params['class'] = implode(' ', $classes);
        }

        $xhtml = '<a href="' . $url . '"' . $this->htmlAttribs($params) . '>' . $linktext . '</a>';

        return $xhtml;
    }
}


Push — master ( 3f69b2...0cfd6f )

Mailto::__invoke() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1			<?php
2			/**
3			* Copyright (c) 2011-2012 Andreas Heigl<[email protected]>
4			*
5			* Permission is hereby granted, free of charge, to any person obtaining a copy
6			* of this software and associated documentation files (the "Software"), to deal
7			* in the Software without restriction, including without limitation the rights
8			* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9			* copies of the Software, and to permit persons to whom the Software is
10			* furnished to do so, subject to the following conditions:
11			*
12			* The above copyright notice and this permission notice shall be included in
13			* all copies or substantial portions of the Software.
14			*
15			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20			* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21			* THE SOFTWARE.
22			*
23			* @category MailProxy
24			* @package OrgHeiglMailproxy
25			* @author Andreas Heigl<[email protected]>
26			* @copyright 2011-2012 Andreas Heigl
27			* @license http://www.opesource.org/licenses/mit-license.php MIT-License
28			* @version 0.0
29			* @since 06.03.2012
30			* @link http://github.com/heiglandreas/mailproxyModule
31			*/
32			namespace Org_Heigl\Mailproxy\View\Helper;
33
34			use Zend\View\Helper\AbstractHtmlElement as HtmlElement;
35
36			/**
37			* A view helper taht generates a mailto-link with an obfuscated eMail-address
38			*
39			* The mail-address will be reversed and via RightToLeft-Display is visible the
40			* "normal" way. clicking the link will call the ProxyController and redirect to
41			* a mailto: url which will open the users Mail-Client
42			*
43			* @author Andreas Heigl<[email protected]>
44			* @copyright Andreas Heigl
45			* @license http://www.opesource.org/licenses/mit-license.php MIT-License
46			* @version 0.0
47			* @since 06.03.2012
48			* @link http://github.com/heiglandreas/OrgHeiglMailproxy
49			*/
50			class Mailto extends HtmlElement
51			{
52			/**
53			* The class to use for marking this element
54			*
55			* var string $class
56			*/
57			private $mailtoclass = 'orgHeiglMailProxy';
58			/**
59			* create a link to the mailproxy-url
60			*
61			* @param string $address The Mail-address to proxy to
62			* @param string $linktext The optional link text. $address will be used if
63			* omited
64			* @param array $params Optional parameters
65			*
66			* @return void
67			*/
68			public function __invoke($address, $linktext = null, $params = array())
69			{
70			$url = $this->getView()->url('mailproxy', ['id' => strrev($address)]);
			0 ignored issues – show Bug introduced 2017-02-21 07:09 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\View\Renderer\RendererInterface` as the method `url()` does only exist in the following implementations of said interface: `Zend\View\Renderer\PhpRenderer`. 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...
71			$this->getView()->headStyle()->appendStyle('.' . $this->mailtoclass . '{
			0 ignored issues – show Bug introduced 2017-02-21 07:09 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\View\Renderer\RendererInterface` as the method `headStyle()` does only exist in the following implementations of said interface: `Zend\View\Renderer\PhpRenderer`. 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...
72			direction: rtl;
73			unicode-bidi: bidi-override;
74
75			}');
76
77			if (null === $linktext) {
78			$linktext = strrev($address);
79			$classes = array();
80			if (isset($params['class'])) {
81			$classes = $params['class'];
82			$classes = explode(' ', $classes);
83			}
84			if (! in_array($this->mailtoclass, $classes)) {
85			$classes[] = $this->mailtoclass;
86			}
87			$params['class'] = implode(' ', $classes);
88			}
89
90			$xhtml = '<a href="' . $url . '"' . $this->htmlAttribs($params) . '>' . $linktext . '</a>';
91
92			return $xhtml;
93			}
94			}
95

heiglandreas / OrgHeiglMailproxy

Push — master ( 3f69b2...0cfd6f )

Mailto::__invoke() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like