XoopsModules\Mylinks\Providers\Heartrails

Complexity

Total Complexity

18

Size/Duplication

Total Lines	140
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	getProviderName()	0	3	1
A	setShotSize()	0	14	5
A	setProviderPrivateKey()	0	3	1
A	__construct()	0	2	1
A	getShotSize()	0	3	1
A	getProviderUrl()	0	6	1
A	setAttribution()	0	3	1
A	setSiteUrl()	0	4	1
A	setProviderPublicKey()	0	3	1
A	getProviderPublicKey()	0	3	1
A	getSiteUrl()	0	3	1
A	getProviderPrivateKey()	0	3	1
A	getAttribution()	0	8	2

<?php

namespace XoopsModules\Mylinks\Providers;

/*
 * 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://www.zyspec.com ZySpec Incorporated}
 * @license   ::    {@link https://www.gnu.org/licenses/gpl-2.0.html GNU Public License}
 * @package   ::    mylinks
 * @subpackage:: class
 * @since     ::      3.11
 * @author    ::     zyspec <owner@zyspec.com>
 */

use XoopsModules\Mylinks;

/**
 * Class MylinksHeartrails
 */
class Heartrails implements Mylinks\ThumbPlugin
{
    private   $image_width   = 0;
    private   $image_height  = 0;
    protected $image_ratio   = 1.33;  // (4:3)
    private   $site_url      = null;
    private   $key           = null;

The private property $key is not used, and could be removed.

    private   $attribution   = '';
    private   $provider_url  = 'http://capture.heartrails.com';
    private   $provider_name = 'Heartrails';

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

    /**
     * @return string
     */
    public function getProviderUrl()
    {
        $query       = '/' . $this->image_width . 'x' . $this->image_height . '/cool?' . $this->getSiteUrl();
        $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)) {
                if (array_key_exists('width', $sz)) {
                    $this->image_width = (int)$sz['width'];
                    if (array_key_exists('height', $sz)) {
                        $this->image_height = (int)$sz['height'];
                    } else {
                        $this->image_height = (int)($this->image_width / $this->image_ratio);
                    }
                } else {
                    $this->image_width  = (int)$sz;
                    $this->image_height = (int)($sz / $this->image_ratio);
                }
            }
        }
    }

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

    /**
     * @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

Are you sure the doc-type for parameter $attr is correct as it would always require null to be passed?

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

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

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

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

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

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

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