Dynamic\ShortURL\Model\ShortURL

Complexity

Total Complexity

19

Size/Duplication

Total Lines	213
Duplicated Lines	0 %

Test Coverage

Coverage

86.27%

Importance

Changes	3
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getCMSFields()	0	41	1
A	getLinkChanged()	0	16	6
A	onBeforeWrite()	0	38	6
A	getToken()	0	3	1
A	getLongURL()	0	11	1
A	validate()	0	17	4

<?php

namespace Dynamic\ShortURL\Model;

use PHPLicengine\Api\Api;
use PHPLicengine\Service\Bitlink;
use SilverStripe\Core\Config\Config;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\ReadonlyField;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\ValidationResult;

class ShortURL extends DataObject
{
    /**
     * @var string
     */
    private static $singular_name = 'Short URL';

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

    /**
     * @var string
     */
    private static $plural_name = 'Short URLs';

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

    /**
     * @var
     */
    private $bitly_token;

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

    /**
     * @var array
     */
    private static $db = [

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

        'Title' => 'Varchar(255)',
        'URL' => 'Varchar(255)',
        'CampaignSource' => 'Varchar(255)',
        'CampaignMedium' => 'Varchar(255)',
        'CampaignName' => 'Varchar(255)',
        'CampaignTerm' => 'Varchar(255)',
        'CampaignContent' => 'Varchar(255)',
        'ShortURL' => 'Varchar(255)',
    ];

    /**
     * @var array
     */
    private static $summary_fields = [

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

        'Title',
        'URL',
        'ShortURL',
    ];

    /**
     * @var array
     */
    private static $searchable_fields = [

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

        'Title',
        'URL',
        'CampaignSource',
        'CampaignMedium',
        'CampaignName',
        'CampaignTerm',
        'CampaignContent',
        'ShortURL',
    ];

    /**
     * @var string
     */
    private static $table_name = 'ShortURL';

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

    /**
     * @return FieldList
     */
    public function getCMSFields()
    {
        $fields = parent::getCMSFields();

        $fields->dataFieldByName('URL')
            ->setDescription('URL to shorten and tag');

        $fields->dataFieldByName('CampaignSource')
            ->setDescription(
                'Use to identify a search engine, newsletter name, or other source. Example: google'
            );

        $fields->dataFieldByName('CampaignMedium')
            ->setDescription(
                'Use utm_medium to identify a medium such as email or cost-per- click. Example: cpc'
            );

        $fields->dataFieldByName('CampaignName')
            ->setDescription(
                'Used for keyword analysis. Use utm_campaign to identify a specific product promotion or
                strategic campaign. Example: utm_campaign=spring_sale'
            );

        $fields->dataFieldByName('CampaignTerm')
            ->setDescription(
                'Used for paid search. Use utm_term to note the keywords for this ad. Example: running+shoes'
            );

        $fields->dataFieldByName('CampaignContent')
            ->setDescription(
                'Used for A/B testing and content-targeted ads. Use utm_content to differentiate ads or links
                that point to the same URL. Examples: logolink or textlink'
            );

        $fields->addFieldToTab('Root.Main', ReadonlyField::create('LongURL', 'Long URL', $this->getLongURL()));

        $short = $fields->dataFieldByName('ShortURL');
        $short = $short->performReadonlyTransformation();
        $fields->addFieldToTab('Root.Main', $short);

        return $fields;
    }

    /**
     * @return ValidationResult
     */
    public function validate()
    {
        $result = parent::validate();

        if (!$this->Title) {
            $result->addError('A Title is required before you can save');
        }

        if (!$this->URL) {

The property URL does not exist on Dynamic\ShortURL\Model\ShortURL. Since you implemented __get, consider adding a @property annotation.

            $result->addError('A URL is required before you can save');
        }

        if (!$this->CampaignSource) {

The property CampaignSource does not exist on Dynamic\ShortURL\Model\ShortURL. Since you implemented __get, consider adding a @property annotation.

            $result->addError('A Campaign Source is required before you can save');
        }

        return $result;
    }

    /**
     * @return mixed
     */
    public function getToken()
    {
        return Config::inst()->get(ShortURL::class, 'bitly_token');
    }

    /**
     * @return string
     */
    public function getLongURL()
    {
        $vars = [
            'utm_source' => $this->CampaignSource,

The property CampaignSource does not exist on Dynamic\ShortURL\Model\ShortURL. Since you implemented __get, consider adding a @property annotation.

            'utm_medium' => $this->CampaignMedium,

The property CampaignMedium does not exist on Dynamic\ShortURL\Model\ShortURL. Since you implemented __get, consider adding a @property annotation.

            'utm_campaign' => $this->CampaignName,

The property CampaignName does not exist on Dynamic\ShortURL\Model\ShortURL. Since you implemented __get, consider adding a @property annotation.

            'utm_term' => $this->CampaignTerm,

The property CampaignTerm does not exist on Dynamic\ShortURL\Model\ShortURL. Since you implemented __get, consider adding a @property annotation.

            'utm_content' => $this->CampaignContent,

The property CampaignContent does not exist on Dynamic\ShortURL\Model\ShortURL. Since you implemented __get, consider adding a @property annotation.

        ];
        $LongURL = $this->URL . '?' . http_build_query($vars);

The property URL does not exist on Dynamic\ShortURL\Model\ShortURL. Since you implemented __get, consider adding a @property annotation.

        return $LongURL;
    }

    /**
     * @return bool
     */
    public function getLinkChanged()
    {
        $isChanged = false;

        if (
            $this->isChanged('URL', self::CHANGE_VALUE) ||
            $this->isChanged('CampaignMedium', self::CHANGE_VALUE) ||
            $this->isChanged('CampaignName', self::CHANGE_VALUE) ||
            $this->isChanged('CampaignTerm', self::CHANGE_VALUE) ||
            $this->isChanged('CampaignContent', self::CHANGE_VALUE)
        ) {
            $isChanged = true;
        }

        $this->extend('updateIsLinkChanged', $isChanged);
        return $isChanged;
    }

    /**
     *
     */
    public function onBeforeWrite()
    {
        // do not call api if link is not changed
        if (!$this->getLinkChanged()) {
            return parent::onBeforeWrite();

Are you sure the usage of parent::onBeforeWrite() targeting SilverStripe\ORM\DataObject::onBeforeWrite() seems to always return null.

        }

        if ($token = $this->getToken()) {
            $api = new Api($token);
            $bitlink = new Bitlink($api);

            $result = $bitlink->createBitlink([
                'long_url' => $this->getLongURL()
            ]);

            // if cURL error occurs.
            if ($api->isCurlError()) {
                throw new \Exception($api->getCurlErrno().': '.$api->getCurlError());

            } else {
                // if Bitly response contains error message.
                if ($result->isError()) {
                    throw new \Exception($result->getDescription());

                } else {

                    // if Bitly response is 200 or 201
                    if ($result->isSuccess()) {
                        $this->ShortURL = $result->getResponseArray()['link'];

The property ShortURL does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

                    } else {
                        throw new \Exception($result->getResponse());
                    }
                }
            }
        }

        parent::onBeforeWrite();
    }
}