MylinksThumbalizr::getProviderName() - Code Metrics - Inspection of "updates" - XoopsModules25x/mylinks - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#8)

by Michael

created 2017-05-25 06:58 UTC

MylinksThumbalizr::getProviderName() A

↳ Parent: MylinksThumbalizr

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

/*
 * You may not change or alter any portion of this comment or credits
 * of supporting developers from this source code or any supporting source code
 * which is considered copyrighted (c) material of the original comment or credit authors.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * to use the provider:
 * $shot = new MylinksThumbshots();
 * $shot->setProviderPrivateKey(my_key);
 * $shot->setShotSize(array('width'=>120));
 * $shot->setSiteUrl("http://site_to_capture");
 * $mylinks_shotprovider = $shot->getProviderUrl();
 *
 * Then in the template use something like:
 *  <img src='<{$mylinks_shotprovider}>' target='_blank' alt='' style='margin: 3px 7px;'>
 *  and at the bottom of the page show the attribution
 *  echo $shot->getAttribution();
 */

/**
 * MyLinks category.php
 *
 * Xoops mylinks - a multicategory links module
 *
 * @copyright ::  {@link http://xoops.org/ XOOPS Project}
 * @copyright ::  {@link http://www.zyspec.com ZySpec Incorporated}
 * @license   ::    {@link http://www.gnu.org/licenses/gpl-2.0.html GNU Public License}
 * @package   ::    mylinks
 * @subpackage:: class
 * @author    ::     zyspec <[email protected]>
 */
require_once XOOPS_ROOT_PATH . '/modules/mylinks/class/thumbplugin.interface.php';

/**
 * Class MylinksThumbalizr
 */
class MylinksThumbalizr implements MylinksThumbPlugin
namespace YourVendor;

class YourClass { }
{
    private $image_width   = 0;
    private $site_url      = null;
    private $key           = null;
    private $attribution   = "<a href=\"http://www.thumbalizr.com\" target=\"_blank\" title=\"Thumbnail Screenshots by Thumbalizr\">Thumbnail Screenshots by Thumbalizr</a>";
    private $provider_url  = 'http://api.thumbalizr.com';
    private $provider_name = 'Thumbalizr';

    /**
     * MylinksThumbalizr constructor.
     */
    public function __construct()
    {
    }

    /**
     * @return string
     */
    public function getProviderUrl()
    {
        $query_string = array(
            'url'      => $this->site_url,
            'width'    => $this->image_width,
            'encoding' => 'jpg',
            'mode'     => 'screen'
        );
        $api_key      = $this->getProviderPublicKey();
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
        if (!empty($api_key)) {
            $query_string['api_key'] = $api_key;
        }
        $query       = http_build_query($query_string);
        $query       = empty($query) ? '' : '/?' . $query;
        $providerUrl = $this->provider_url . $query;

        return $providerUrl;
    }

    /**
     * @return string
     */
    public function getProviderName()
    {
        return $this->provider_name;
    }

    /**
     * @param $sz
     * @return mixed|void
     */
    public function setShotSize($sz)
    {
        if (isset($sz)) {
            if (is_array($sz) && array_key_exists('width', $sz)) {
                $this->image_width = (int)$sz['width'];
            } else {
                $this->image_width = (int)$sz;
            }
        }
    }

    /**
     * @return array
     */
    public function getShotSize()
    {
        return array('width' => $this->image_width, 'height' => 0);
    }

    /**
     * @param $url
     * @return mixed|void
     */
    public function setSiteUrl($url)
    {
        //@todo: sanitize url;
        $this->site_url = formatURL($url);
    }

    /**
     * @return string
     */
    public function getSiteUrl()
    {
        return urlencode($this->site_url);
    }

    /**
     * @param null $attr
     */
    public function setAttribution($attr = null)
    {
        $this->attribution = $attr;
    }

    /**
     * @param int $allowhtml
     * @return string
     */
    public function getAttribution($allowhtml = 0)
    {
        if ($allowhtml) {
            return $this->attribution;
        } else {
            $myts = MyTextSanitizer::getInstance();

            return $myts->htmlSpecialChars($this->attribution);
        }
    }

    /**
     * @param $key
     * @return mixed|void
     */
    public function setProviderPublicKey($key)
    {
        $this->key = $key;
    }

    /**
     * @return null
     */
    public function getProviderPublicKey()
    {
        return $this->key;
    }

    /**
     * @param $key
     * @return bool
     */
    public function setProviderPrivateKey($key)
    {
        return false;
    }

    /**
     * @return bool
     */
    public function getProviderPrivateKey()
    {
        return false;
    }
}


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-04-26 04:17 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 40 and the first side effect is on line 35. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2			/*
3			* You may not change or alter any portion of this comment or credits
4			* of supporting developers from this source code or any supporting source code
5			* which is considered copyrighted (c) material of the original comment or credit authors.
6			* This program is distributed in the hope that it will be useful,
7			* but WITHOUT ANY WARRANTY; without even the implied warranty of
8			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
9			*
10			* to use the provider:
11			* $shot = new MylinksThumbshots();
12			* $shot->setProviderPrivateKey(my_key);
13			* $shot->setShotSize(array('width'=>120));
14			* $shot->setSiteUrl("http://site_to_capture");
15			* $mylinks_shotprovider = $shot->getProviderUrl();
16			*
17			* Then in the template use something like:
18			* <img src='<{$mylinks_shotprovider}>' target='_blank' alt='' style='margin: 3px 7px;'>
19			* and at the bottom of the page show the attribution
20			* echo $shot->getAttribution();
21			*/
22
23			/**
24			* MyLinks category.php
25			*
26			* Xoops mylinks - a multicategory links module
27			*
28			* @copyright :: {@link http://xoops.org/ XOOPS Project}
29			* @copyright :: {@link http://www.zyspec.com ZySpec Incorporated}
30			* @license :: {@link http://www.gnu.org/licenses/gpl-2.0.html GNU Public License}
31			* @package :: mylinks
32			* @subpackage:: class
33			* @author :: zyspec <[email protected]>
34			*/
35			require_once XOOPS_ROOT_PATH . '/modules/mylinks/class/thumbplugin.interface.php';
36
37			/**
38			* Class MylinksThumbalizr
39			*/
40			class MylinksThumbalizr implements MylinksThumbPlugin
			0 ignored issues – show Coding Style Compatibility introduced 2016-04-26 04:17 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
41			{
42			private $image_width = 0;
43			private $site_url = null;
44			private $key = null;
45			private $attribution = "<a href=\"http://www.thumbalizr.com\" target=\"_blank\" title=\"Thumbnail Screenshots by Thumbalizr\">Thumbnail Screenshots by Thumbalizr</a>";
46			private $provider_url = 'http://api.thumbalizr.com';
47			private $provider_name = 'Thumbalizr';
48
49			/**
50			* MylinksThumbalizr constructor.
51			*/
52			public function __construct()
53			{
54			}
55
56			/**
57			* @return string
58			*/
59			public function getProviderUrl()
60			{
61			$query_string = array(
62			'url' => $this->site_url,
63			'width' => $this->image_width,
64			'encoding' => 'jpg',
65			'mode' => 'screen'
66			);
67			$api_key = $this->getProviderPublicKey();
			0 ignored issues – show Bug introduced 2017-05-25 07:01 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$api_key` is correct as `$this->getProviderPublicKey()` (which targets `MylinksThumbalizr::getProviderPublicKey()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
68			if (!empty($api_key)) {
69			$query_string['api_key'] = $api_key;
70			}
71			$query = http_build_query($query_string);
72			$query = empty($query) ? '' : '/?' . $query;
73			$providerUrl = $this->provider_url . $query;
74
75			return $providerUrl;
76			}
77
78			/**
79			* @return string
80			*/
81			public function getProviderName()
82			{
83			return $this->provider_name;
84			}
85
86			/**
87			* @param $sz
88			* @return mixed\|void
89			*/
90			public function setShotSize($sz)
91			{
92			if (isset($sz)) {
93			if (is_array($sz) && array_key_exists('width', $sz)) {
94			$this->image_width = (int)$sz['width'];
95			} else {
96			$this->image_width = (int)$sz;
97			}
98			}
99			}
100
101			/**
102			* @return array
103			*/
104			public function getShotSize()
105			{
106			return array('width' => $this->image_width, 'height' => 0);
107			}
108
109			/**
110			* @param $url
111			* @return mixed\|void
112			*/
113			public function setSiteUrl($url)
114			{
115			//@todo: sanitize url;
116			$this->site_url = formatURL($url);
117			}
118
119			/**
120			* @return string
121			*/
122			public function getSiteUrl()
123			{
124			return urlencode($this->site_url);
125			}
126
127			/**
128			* @param null $attr
129			*/
130			public function setAttribution($attr = null)
131			{
132			$this->attribution = $attr;
133			}
134
135			/**
136			* @param int $allowhtml
137			* @return string
138			*/
139			public function getAttribution($allowhtml = 0)
140			{
141			if ($allowhtml) {
142			return $this->attribution;
143			} else {
144			$myts = MyTextSanitizer::getInstance();
145
146			return $myts->htmlSpecialChars($this->attribution);
147			}
148			}
149
150			/**
151			* @param $key
152			* @return mixed\|void
153			*/
154			public function setProviderPublicKey($key)
155			{
156			$this->key = $key;
157			}
158
159			/**
160			* @return null
161			*/
162			public function getProviderPublicKey()
163			{
164			return $this->key;
165			}
166
167			/**
168			* @param $key
169			* @return bool
170			*/
171			public function setProviderPrivateKey($key)
172			{
173			return false;
174			}
175
176			/**
177			* @return bool
178			*/
179			public function getProviderPrivateKey()
180			{
181			return false;
182			}
183			}
184

XoopsModules25x / mylinks

Pull Request — master (#8)

MylinksThumbalizr::getProviderName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like